First try of the data validation feature.

4 files changed, 251 insertions, 0 deletions

diff --git a/examples/data_validations.rb b/examples/data_validations.rb
new file mode 100644
index 00000000..84677066
--- /dev/null
+++ b/examples/data_validations.rb
@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby -w -s
+# -*- coding: utf-8 -*-
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'axlsx'
+
+p = Axlsx::Package.new
+p.workbook.add_worksheet do |ws| 
+  data_validation_1 = { :type => :whole, :formula1 => '4', :formula2 => '10'}
+
+  ws.add_data_validation("A1", data_validation_1)
+end
+p.serialize 'data_validations.xlsx'
diff --git a/lib/axlsx/util/validators.rb b/lib/axlsx/util/validators.rb
index 2f43a121..f1ba5ae7 100644
--- a/lib/axlsx/util/validators.rb
+++ b/lib/axlsx/util/validators.rb
@@ -217,4 +217,25 @@ module Axlsx
     RestrictionValidator.validate :table_element_type, [:wholeTable, :headerRow, :totalRow, :firstColumn, :lastColumn, :firstRowStripe, :secondRowStripe, :firstColumnStripe, :secondColumnStripe, :firstHeaderCell, :lastHeaderCell, :firstTotalCell, :lastTotalCell, :firstSubtotalColumn, :secondSubtotalColumn, :thirdSubtotalColumn, :firstSubtotalRow, :secondSubtotalRow, :thirdSubtotalRow, :blankRow, :firstColumnSubheading, :secondColumnSubheading, :thirdColumnSubheading, :firstRowSubheading, :secondRowSubheading, :thirdRowSubheading, :pageFieldLabels, :pageFieldValues], v
   end
 
+  # Requires that the value is a valid data_validation_error_style
+  # :information, :stop, :warning
+  # @param [Any] v The value validated
+  def self.validate_data_validation_error_style(v)
+    RestrictionValidator.validate :validate_data_validation_error_style, [:informatiom, :stop, :warning]
+  end
+  
+  # Requires that the value is valid data validation operator.
+  # valid operators must be one of lessThan, lessThanOrEqual, equal,
+  # notEqual, greaterThanOrEqual, greaterThan, between, notBetween
+  # @param [Any] v The value validated
+  def self.validate_data_validation_operator(v)
+    RestrictionValidator.validate :data_validation_operator, [:lessThan, :lessThanOrEqual, :equal, :notEqual, :greaterThanOrEqual, :greaterThan, :between, :notBetween], v
+  end
+  
+  # Requires that the value is valid data validation type.
+  # valid types must be one of custom, data, decimal, list, none, textLength, time, whole
+  # @param [Any] v The value validated
+  def self.validate_data_validation_type(v)
+    RestrictionValidator.validate :data_validation_type, [:custom, :data, :decimal, :list, :none, :textLength, :time, :whole], v
+  end
 end
diff --git a/lib/axlsx/workbook/worksheet/data_validation.rb b/lib/axlsx/workbook/worksheet/data_validation.rb
new file mode 100644
index 00000000..715a7114
--- /dev/null
+++ b/lib/axlsx/workbook/worksheet/data_validation.rb
@@ -0,0 +1,200 @@
+module Axlsx
+  # Data validation allows the validation of cell data
+  #
+  # @note The recommended way to manage data validations is via Worksheet#add_data_validation
+  # @see Worksheet#add_data_validation
+  class DataValidation
+    
+    # instance values that must be serialized as their own elements - e.g. not attributes.
+    CHILD_ELEMENTS = [:formula1, :formula2]
+    
+    # Formula1
+    # @return [String]
+    # @default nil
+    attr_reader :formula1
+    
+    # Formula2
+    # @return [String]
+    # @default nil
+    attr_reader :formula2
+    
+    # Allow Blank
+    # A boolean value indicating whether the data validation allows the use of empty or blank
+    # entries. 1 means empty entries are OK and do not violate the validation constraints.
+    # The possible values for this attribute are defined by the W3C XML Schema boolean
+    # datatype.
+    # @return [Boolean]
+    # @default true
+    attr_reader :allowBlank
+    
+    # Error Message
+    # Message text of error alert.
+    # @return [String]
+    # @default nil
+    attr_reader :error
+    
+    # Error Style (ST_DataValidationErrorStyle)
+    # The style of error alert used for this data validation.
+    # Options are:
+    #  * information: This data validation error style uses an information icon in the error alert.
+    #  * stop: This data validation error style uses a stop icon in the error alert.
+    #  * warning: This data validation error style uses a warning icon in the error alert.
+    # @return [Symbol]
+    # @default :stop
+    attr_reader :errorStyle
+    
+    # Error Title
+    # Title bar text of error alert.
+    # @return [String]
+    # @default nil
+    attr_reader :errorTitle
+    
+    # Operator (ST_DataValidationOperator)
+    # The relational operator used with this data validation.
+    # Options are:
+    #  * between: Data validation which checks if a value is between two other values.
+    #  * equal: Data validation which checks if a value is equal to a specified value.
+    #  * greater_than: Data validation which checks if a value is greater than a specified value.
+    #  * greater_than_or_equal: Data validation which checks if a value is greater than or equal to a specified value.
+    #  * less_than: Data validation which checks if a value is less than a specified value.
+    #  * less_than_or_equal: Data validation which checks if a value is less than or equal to a specified value.
+    #  * not_between: Data validation which checks if a value is not between two other values.
+    #  * not_equal: Data validation which checks if a value is not equal to a specified value.
+    # @return [Symbol]
+    # @default nil
+    attr_reader :operator
+    
+    # Input prompt
+    # Message text of input prompt.
+    # @return [String]
+    # @default nil
+    attr_reader :prompt
+    
+    # Prompt title
+    # Title bar text of input prompt.
+    # @return [String]
+    # @default nil
+    attr_reader :promptTitle
+    
+    # Show drop down
+    # A boolean value indicating whether to display a dropdown combo box for a list type data
+    # validation.
+    # @return [Boolean]
+    # @default false
+    attr_reader :showDropDown
+    
+    # Show error message
+    # A boolean value indicating whether to display the error alert message when an invalid
+    # value has been entered, according to the criteria specified.
+    # @return [Boolean]
+    # @default false
+    attr_reader :showErrorMessage
+    
+    # Show input message
+    # A boolean value indicating whether to display the input prompt message.
+    # @return [Boolean]
+    # @default false
+    attr_reader :showInputMessage
+    
+    # Range over which data validation is applied, in "A1:B2" format
+    # @return [String]
+    # @default nil
+    attr_reader :sqref
+    
+    # The type (ST_DataValidationType) of data validation.
+    # Options are:
+    #  * custom: Data validation which uses a custom formula to check the cell value.
+    #  * date: Data validation which checks for date values satisfying the given condition.
+    #  * decimal: Data validation which checks for decimal values satisfying the given condition.
+    #  * list: Data validation which checks for a value matching one of list of values.
+    #  * none: No data validation.
+    #  * textLength: Data validation which checks for text values, whose length satisfies the given condition.
+    #  * time: Data validation which checks for time values satisfying the given condition.
+    #  * whole: Data validation which checks for whole number values satisfying the given condition.
+    # @return [Symbol]
+    # @default none
+    attr_reader :type
+    
+    # Creates a new {DataValidation} object
+    # @option options [String] formula1
+    # @option options [String] formula2
+    # @option options [Boolean] allowBlank - A boolean value indicating whether the data validation allows the use of empty or blank entries.
+    # @option options [String] error - Message text of error alert.
+    # @option options [Symbol] errorStyle - The style of error alert used for this data validation.
+    # @option options [String] errorTitle - itle bar text of error alert.
+    # @option options [Symbol] operator - The relational operator used with this data validation.
+    # @option options [String] prompt - Message text of input prompt.
+    # @option options [String] promptTitle - Title bar text of input prompt.
+    # @option options [Boolean] showDropDown - A boolean value indicating whether to display a dropdown combo box for a list type data validation
+    # @option options [Boolean] showErrorMessage - A boolean value indicating whether to display the error alert message when an invalid value has been entered, according to the criteria specified.
+    # @option options [Boolean] showInputMessage - A boolean value indicating whether to display the input prompt message.
+    # @option options [String] sqref - Range over which data validation is applied, in "A1:B2" format.
+    # @option options [Symbol] type - The type of data validation.
+    def initialize(options={})
+      # defaults
+      @formula1 = @formula2 = @error = @errorTitle = @operator = @prompt = @promptTitle = @sqref = nil
+      @allowBlank = true
+      @showDropDown = @showErrorMessage = @showInputMessage = false
+      @type = :none
+      @errorStyle = :stop
+      
+      options.each do |o|
+        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
+      end
+    end
+    
+    # @see formula1
+    def formula1=(v); Axlsx::validate_string(v); @formula1 = v end
+    
+    # @see formula2
+    def formula2=(v); Axlsx::validate_string(v); @formula2 = v end 
+    
+    # @see allowBlank
+    def allowBlank=(v); Axlsx::validate_boolean(v); @allowBlank = v end
+    
+    # @see error
+    def error=(v); Axlsx::validate_string(v); @error = v end
+    
+    # @see errorStyle
+    def errorStyle=(v); Axlsx::validate_data_validation_errorStyle(v); @errorStyle = v end
+    
+    # @see errorTitle
+    def errorTitle=(v); Axlsx::validate_string(v); @errorTitle = v end
+    
+    # @see operator
+    def operator=(v); Axlsx::validate_data_validation_operator(v); @operator = v end
+    
+    # @see prompt
+    def prompt=(v); Axlsx::validate_string(v); @prompt = v end
+    
+    # @see promptTitle
+    def promptTitle=(v); Axlsx::validate_string(v); @promptTitle = v end
+    
+    # @see showDropDown
+    def showDropDown=(v); Axlsx::validate_boolean(v); @showDropDown = v end
+    
+    # @see showErrorMessage
+    def showErrorMessage=(v); Axlsx::validate_boolean(v); @showErrorMessage = v end
+    
+    # @see showInputMessage
+    def showInputMessage=(v); Axlsx::validate_boolean(v); @showInputMessage = v end
+        
+    # @see sqref
+    def sqref=(v); Axlsx::validate_string(v); @sqref = v end
+    
+    # @see type
+    def type=(v); Axlsx::validate_data_validation_type(v); @type = v end
+    
+    # Serializes the data validation
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<dataValidation '
+      str << instance_values.map { |key, value| '' << key << '="' << value.to_s << '"' unless CHILD_ELEMENTS.include?(key.to_sym) }.join(' ')
+      str << '>'
+      str << '<formula1>' << self.formula1 << '</formula1>' if @formula1
+      str << '<formula2>' << self.formula2 << '</formula2>' if @formula2
+      str << '</dataValidation>'
+    end
+  end
+end
diff --git a/lib/axlsx/workbook/worksheet/worksheet.rb b/lib/axlsx/workbook/worksheet/worksheet.rb
index bffd8c49..9af87e26 100644
--- a/lib/axlsx/workbook/worksheet/worksheet.rb
+++ b/lib/axlsx/workbook/worksheet/worksheet.rb
@@ -164,6 +164,7 @@ module Axlsx
       @merged_cells = []
       @auto_fit_data = []
       @conditional_formattings = []
+      @data_validations = []
       @comments = Comments.new(self)
       @selected = false
       @show_gridlines = true
@@ -202,6 +203,19 @@ module Axlsx
       cf.add_rules rules
       @conditional_formattings << cf
     end
+    
+    # Add data validation to this worksheet.
+    #
+    # @param
+    # @example
+    #
+    # @see
+    # @see
+    def add_data_validation(cells, data_validation)
+      dv = DataValidation.new(data_validation)
+      data_validation.sqref = cells
+      @data_validations << data_validation
+    end
 
     # Creates merge information for this worksheet.
     # Cells can be merged by calling the merge_cells method on a worksheet.
@@ -504,6 +518,10 @@ module Axlsx
      @conditional_formattings.each do |cf|
        str.concat cf.to_xml_string
      end
+     
+     @data_validations.each do |df|
+       str.concat df.to_xml_string
+     end
      str + '</worksheet>'
     end