bonio-axlsx 2.2.1

data/lib/axlsx/workbook/worksheet/conditional_formattings.rb

@@ -0,0 +1,25 @@
+module Axlsx
+
+  # A simple, self serializing class for storing conditional formattings
+  class ConditionalFormattings < SimpleTypedList
+
+    # creates a new Tables object
+    def initialize(worksheet)
+      raise ArgumentError, "you must provide a worksheet" unless worksheet.is_a?(Worksheet)
+      super ConditionalFormatting
+      @worksheet = worksheet
+    end
+
+    # The worksheet that owns this collection of tables
+    # @return [Worksheet]
+    attr_reader :worksheet
+
+    # serialize the conditional formattings
+    def to_xml_string(str = "")
+      return if empty?
+      each { |item| item.to_xml_string(str) }
+    end
+  end
+
+end
+

data/lib/axlsx/workbook/worksheet/data_bar.rb

@@ -0,0 +1,129 @@
+module Axlsx
+  # Conditional Format Rule data bar object
+  # Describes a data bar conditional formatting rule.
+
+  # @note The recommended way to manage these rules is via Worksheet#add_conditional_formatting
+  # @see Worksheet#add_conditional_formatting
+  # @see ConditionalFormattingRule#initialize
+  class DataBar
+
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+
+    class << self
+      # This differs from ColorScale. There must be exactly two cfvos one color
+      def default_cfvos
+        [{:type => :min, :val => "0"},
+         {:type => :max, :val => "0"}]
+      end
+    end
+
+    # Creates a new data bar conditional formatting object
+    # @param [Hash] options
+    # @option options [Integer] minLength
+    # @option options [Integer] maxLength
+    # @option options [Boolean] showValue
+    # @option options [String] color - the rbg value used to color the bars
+    # @param [Array] cfvos hashes defining the gradient interpolation points for this formatting.
+    def initialize(options = {}, *cfvos)
+      @min_length = 10
+      @max_length = 90
+      @show_value = true
+      parse_options options
+      initialize_cfvos(cfvos)
+      yield self if block_given?
+    end
+
+    serializable_attributes :min_length, :max_length, :show_value
+
+    # instance values that must be serialized as their own elements - e.g. not attributes.
+    CHILD_ELEMENTS = [:value_objects, :color]
+
+    # minLength attribute
+    # The minimum length of the data bar, as a percentage of the cell width.
+    # The default value is 10
+    # @return [Integer]
+    attr_reader :min_length
+    alias :minLength :min_length
+
+    # maxLength attribute
+    # The maximum length of the data bar, as a percentage of the cell width.
+    # The default value is 90
+    # @return [Integer]
+    attr_reader :max_length
+    alias :maxLength :max_length
+
+    # maxLength attribute
+    # Indicates whether to show the values of the cells on which this data bar is applied.
+    # The default value is true
+    # @return [Boolean]
+    attr_reader :show_value
+    alias :showValue :show_value
+
+    # A simple typed list of cfvos
+    # @return [SimpleTypedList]
+    # @see Cfvo
+    def value_objects
+      @value_objects ||= Cfvos.new
+    end
+
+    # color
+    # the color object used in the data bar formatting
+    # @return [Color]
+    def color
+      @color ||= Color.new :rgb => "FF0000FF"
+    end
+
+    # @see minLength
+    def min_length=(v)
+      Axlsx.validate_unsigned_int(v)
+      @min_length = v
+    end
+    alias :minLength= :min_length=
+
+      # @see maxLength
+      def max_length=(v)
+        Axlsx.validate_unsigned_int(v)
+        @max_length = v
+      end
+    alias :maxLength= :max_length=
+
+      # @see showValue
+      def show_value=(v)
+        Axlsx.validate_boolean(v)
+        @show_value = v
+      end
+    alias :showValue= :show_value=
+
+      # Sets the color for the data bars.
+      # @param [Color|String] v The color object, or rgb string value to apply
+      def color=(v)
+        @color = v if v.is_a? Color
+        self.color.rgb = v if v.is_a? String
+        @color
+      end
+
+    # Serialize this object to an xml string
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str="")
+      serialized_tag('dataBar', str) do
+        value_objects.to_xml_string(str)
+        self.color.to_xml_string(str)
+      end
+    end
+
+    private
+
+    def initialize_cfvos(cfvos)
+      self.class.default_cfvos.each_with_index.map do |default, index|
+        if index < cfvos.size
+          value_objects << Cfvo.new(default.merge(cfvos[index]))
+        else
+          value_objects << Cfvo.new(default)
+        end
+      end
+    end
+
+  end
+end

data/lib/axlsx/workbook/worksheet/data_validation.rb

@@ -0,0 +1,246 @@
+# encoding: UTF-8
+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
+    include Axlsx::OptionsParser
+
+    # 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 = @showErrorMessage = true
+      @showDropDown = @showInputMessage = false
+      @type = :none
+      @errorStyle = :stop
+      parse_options options
+    end
+
+    # instance values that must be serialized as their own elements - e.g. not attributes.
+    CHILD_ELEMENTS = [:formula1, :formula2].freeze
+
+    # Formula1
+    # Available for type whole, decimal, date, time, textLength, list, custom
+    # @see type
+    # @return [String]
+    # default nil
+    attr_reader :formula1
+
+    # Formula2
+    # Available for type whole, decimal, date, time, textLength
+    # @see type
+    # @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.
+    # Available for type whole, decimal, date, time, textLength, list, custom
+    # @see type
+    # @return [Boolean]
+    # default true
+    attr_reader :allowBlank
+
+    # Error Message
+    # Message text of error alert.
+    # Available for type whole, decimal, date, time, textLength, list, custom
+    # @see type
+    # @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.
+    # Available for type whole, decimal, date, time, textLength, list, custom
+    # @see type
+    # @return [Symbol]
+    # default :stop
+    attr_reader :errorStyle
+
+    # Error Title
+    # Title bar text of error alert.
+    # Available for type whole, decimal, date, time, textLength, list, custom
+    # @see type
+    # @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.
+    # Available for type whole, decimal, date, time, textLength
+    # @see type
+    # @return [Symbol]
+    # default nil
+    attr_reader :operator
+
+    # Input prompt
+    # Message text of input prompt.
+    # Available for type whole, decimal, date, time, textLength, list, custom
+    # @see type
+    # @return [String]
+    # default nil
+    attr_reader :prompt
+
+    # Prompt title
+    # Title bar text of input prompt.
+    # Available for type whole, decimal, date, time, textLength, list, custom
+    # @see type
+    # @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. Be careful: false shows the dropdown list!
+    # Available for type list
+    # @see type
+    # @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.
+    # Available for type whole, decimal, date, time, textLength, list, custom
+    # @see type
+    # @return [Boolean]
+    # default false
+    attr_reader :showErrorMessage
+
+    # Show input message
+    # A boolean value indicating whether to display the input prompt message.
+    # Available for type whole, decimal, date, time, textLength, list, custom
+    # @see type
+    # @return [Boolean]
+    # default false
+    attr_reader :showInputMessage
+
+    # Range over which data validation is applied, in "A1:B2" format
+    # Available for type whole, decimal, date, time, textLength, list, custom
+    # @see type
+    # @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
+
+
+    # @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_error_style(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 = '')
+      valid_attributes = get_valid_attributes
+
+      str << '<dataValidation '
+      str << instance_values.map do |key, value| 
+        '' << key << '="' << Axlsx.booleanize(value).to_s << '"' if (valid_attributes.include?(key.to_sym) && !CHILD_ELEMENTS.include?(key.to_sym)) 
+      end.join(' ')
+      str << '>'
+      str << ('<formula1>' << self.formula1 << '</formula1>') if @formula1 and valid_attributes.include?(:formula1)
+      str << ('<formula2>' << self.formula2 << '</formula2>') if @formula2 and valid_attributes.include?(:formula2)
+      str << '</dataValidation>'
+    end
+
+  private
+    def get_valid_attributes
+      attributes = [:allowBlank, :error, :errorStyle, :errorTitle, :prompt, :promptTitle, :showErrorMessage, :showInputMessage, :sqref, :type ]
+
+      if [:whole, :decimal, :data, :time, :textLength].include?(@type)
+        attributes << [:operator, :formula1]
+        attributes << [:formula2] if [:between, :notBetween].include?(@operator)
+      elsif @type == :list
+        attributes << [:showDropDown, :formula1]
+      elsif @type == :custom
+        attributes << [:formula1]
+      else
+        attributes = []
+      end
+
+      attributes.flatten!
+    end
+  end
+end

data/lib/axlsx/workbook/worksheet/data_validations.rb

@@ -0,0 +1,28 @@
+module Axlsx
+
+  # A simple, self serializing class for storing conditional formattings
+  class DataValidations < SimpleTypedList
+
+    # creates a new Tables object
+    def initialize(worksheet)
+      raise ArgumentError, "you must provide a worksheet" unless worksheet.is_a?(Worksheet)
+      super DataValidation
+      @worksheet = worksheet
+    end
+
+    # The worksheet that owns this collection of tables
+    # @return [Worksheet]
+    attr_reader :worksheet
+
+    # serialize the conditional formattings
+    def to_xml_string(str = "")
+      return if empty?
+      str << "<dataValidations count='#{size}'>"
+      each { |item| item.to_xml_string(str) }
+      str << '</dataValidations>'
+    end
+  end
+
+end
+
+

data/lib/axlsx/workbook/worksheet/date_time_converter.rb

@@ -0,0 +1,30 @@
+# encoding: UTF-8
+require "date"
+
+module Axlsx
+  # The DateTimeConverter class converts both data and time types to their apprpriate excel serializations
+  class DateTimeConverter
+
+    # The date_to_serial method converts Date objects to the equivelant excel serialized forms
+    # @param [Date] date the date to be serialized
+    # @return [Numeric]
+    def self.date_to_serial(date)
+      epoch = Axlsx::Workbook::date1904 ? Date.new(1904) : Date.new(1899, 12, 30)
+      offset_date = date.respond_to?(:utc_offset) ? date + date.utc_offset.seconds : date
+      (offset_date - epoch).to_f
+    end
+
+    # The time_to_serial methond converts a Time object its excel serialized form.
+    # @param [Time] time the time to be serialized
+    # @return [Numeric]
+    def self.time_to_serial(time)
+      # Using hardcoded offsets here as some operating systems will not except
+      # a 'negative' offset from the ruby epoch.
+      epoch1900 = -2209161600.0 # Time.utc(1899, 12, 30).to_i
+      epoch1904 = -2082844800.0 # Time.utc(1904, 1, 1).to_i
+      seconds_per_day = 86400.0 # 60*60*24
+      epoch = Axlsx::Workbook::date1904 ? epoch1904 : epoch1900
+      (time.utc_offset + time.to_f - epoch)/seconds_per_day
+    end
+  end
+end