caxlsx 3.3.0 → 4.0.0

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

@@ -1,4 +1,5 @@
-# encoding: UTF-8
+# frozen_string_literal: true
+
 module Axlsx
   # Data validation allows the validation of cell data
   #
@@ -23,7 +24,7 @@ module Axlsx
     # @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={})
+    def initialize(options = {})
       # defaults
       @formula1 = @formula2 = @error = @errorTitle = @operator = @prompt = @promptTitle = @sqref = nil
       @allowBlank = @showErrorMessage = true
@@ -176,92 +177,92 @@ module Axlsx
     # default none
     attr_reader :type
 
-
     # @see formula1
-    def formula1=(v); Axlsx::validate_string(v); @formula1 = v end
+    def formula1=(v); Axlsx.validate_string(v); @formula1 = v end
 
     # @see formula2
-    def formula2=(v); Axlsx::validate_string(v); @formula2 = v end
+    def formula2=(v); Axlsx.validate_string(v); @formula2 = v end
 
     # @see allowBlank
-    def allowBlank=(v); Axlsx::validate_boolean(v); @allowBlank = v end
+    def allowBlank=(v); Axlsx.validate_boolean(v); @allowBlank = v end
 
     # @see error
-    def error=(v); Axlsx::validate_string(v); @error = v end
+    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
+    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
+    def errorTitle=(v); Axlsx.validate_string(v); @errorTitle = v end
 
     # @see operator
-    def operator=(v); Axlsx::validate_data_validation_operator(v); @operator = v end
+    def operator=(v); Axlsx.validate_data_validation_operator(v); @operator = v end
 
     # @see prompt
-    def prompt=(v); Axlsx::validate_string(v); @prompt = v end
+    def prompt=(v); Axlsx.validate_string(v); @prompt = v end
 
     # @see promptTitle
-    def promptTitle=(v); Axlsx::validate_string(v); @promptTitle = v end
+    def promptTitle=(v); Axlsx.validate_string(v); @promptTitle = v end
 
     # @see showDropDown
     def showDropDown=(v)
       warn 'The `showDropDown` has an inverted logic, false shows the dropdown list! You should use `hideDropDown` instead.'
-      Axlsx::validate_boolean(v)
+      Axlsx.validate_boolean(v)
       @showDropDown = v
     end
 
     # @see hideDropDown
     def hideDropDown=(v)
-      Axlsx::validate_boolean(v)
+      Axlsx.validate_boolean(v)
       # It's just an alias for the showDropDown attribute, hideDropDown should set the value of the original showDropDown.
       @showDropDown = v
     end
 
     # @see showErrorMessage
-    def showErrorMessage=(v); Axlsx::validate_boolean(v); @showErrorMessage = v end
+    def showErrorMessage=(v); Axlsx.validate_boolean(v); @showErrorMessage = v end
 
     # @see showInputMessage
-    def showInputMessage=(v); Axlsx::validate_boolean(v); @showInputMessage = v end
+    def showInputMessage=(v); Axlsx.validate_boolean(v); @showInputMessage = v end
 
     # @see sqref
-    def sqref=(v); Axlsx::validate_string(v); @sqref = v end
+    def sqref=(v); Axlsx.validate_string(v); @sqref = v end
 
     # @see type
-    def type=(v); Axlsx::validate_data_validation_type(v); @type = v end
+    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 = '')
+    def to_xml_string(str = +'')
       valid_attributes = get_valid_attributes
+      h = Axlsx.instance_values_for(self).select { |key, _| valid_attributes.include?(key.to_sym) && !CHILD_ELEMENTS.include?(key.to_sym) }
 
       str << '<dataValidation '
-      str << Axlsx.instance_values_for(self).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(' ')
+      h.each_with_index do |key_value, index|
+        str << ' ' unless index.zero?
+        str << key_value.first << '="' << Axlsx.booleanize(key_value.last).to_s << '"'
+      end
       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 << '<formula1>' << formula1 << '</formula1>' if formula1 && valid_attributes.include?(:formula1)
+      str << '<formula2>' << formula2 << '</formula2>' if formula2 && valid_attributes.include?(:formula2)
       str << '</dataValidation>'
     end
 
-  private
+    private
+
     def get_valid_attributes
-      attributes = [:allowBlank, :error, :errorStyle, :errorTitle, :prompt, :promptTitle, :showErrorMessage, :showInputMessage, :sqref, :type ]
+      attributes = [:allowBlank, :error, :errorStyle, :errorTitle, :prompt, :promptTitle, :showErrorMessage, :showInputMessage, :sqref, :type]
 
       if [:whole, :decimal, :data, :time, :date, :textLength].include?(@type)
-        attributes << [:operator, :formula1]
-        attributes << [:formula2] if [:between, :notBetween].include?(@operator)
+        attributes << :operator << :formula1
+        attributes << :formula2 if [:between, :notBetween].include?(@operator)
       elsif @type == :list
-        attributes << [:showDropDown, :formula1]
+        attributes << :showDropDown << :formula1
       elsif @type == :custom
-        attributes << [:formula1]
-      else
-        attributes = []
+        attributes << :formula1
       end
 
-      attributes.flatten!
+      attributes
     end
   end
 end

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

@@ -1,11 +1,12 @@
-module Axlsx
+# frozen_string_literal: true
 
+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
@@ -15,14 +16,12 @@ module Axlsx
     attr_reader :worksheet
 
     # serialize the conditional formattings
-    def to_xml_string(str = "")
+    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

@@ -1,20 +1,20 @@
-# encoding: UTF-8
+# frozen_string_literal: true
+
 require "date"
 
 module Axlsx
-  # The DateTimeConverter class converts both data and time types to their apprpriate excel serializations
+  # 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
+    # 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)
+      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.
+    # 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)
@@ -23,8 +23,8 @@ module Axlsx
       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
+      epoch = Axlsx::Workbook.date1904 ? epoch1904 : epoch1900
+      (time.utc_offset + time.to_f - epoch) / seconds_per_day
     end
   end
 end

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

@@ -1,10 +1,10 @@
-module Axlsx
+# frozen_string_literal: true
 
+module Axlsx
   # This class manages the dimensions for a worksheet.
-  # While this node is optional in the specification some readers like 
+  # While this node is optional in the specification some readers like
   # LibraOffice require this node to render the sheet
   class Dimension
-
     # the default value for the first cell in the dimension
     # @return [String]
     def self.default_first
@@ -22,6 +22,7 @@ module Axlsx
     # to.
     def initialize(worksheet)
       raise ArgumentError, "you must provide a worksheet" unless worksheet.is_a?(Worksheet)
+
       @worksheet = worksheet
     end
 
@@ -31,13 +32,14 @@ module Axlsx
     # @return [String]
     def sqref
       "#{first_cell_reference}:#{last_cell_reference}"
-    end 
+    end
 
     # serialize the object
     # @return [String]
-    def to_xml_string(str = '')
+    def to_xml_string(str = +'')
       return if worksheet.rows.empty?
-      str << "<dimension ref=\"%s\"></dimension>" % sqref
+
+      str << '<dimension ref="' << sqref << '"></dimension>'
     end
 
     # The first cell in the dimension
@@ -58,6 +60,7 @@ module Axlsx
     # @return [String]
     def dimension_reference(cell, default)
       return default unless cell.respond_to?(:r)
+
       cell.r
     end
   end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Axlsx
   # Header/Footer options for printing a worksheet. All settings are optional.
   #
@@ -9,7 +11,6 @@ module Axlsx
   # @note The recommended way of managing header/footers is via Worksheet#header_footer
   # @see Worksheet#initialize
   class HeaderFooter
-
     include Axlsx::OptionsParser
     include Axlsx::SerializedAttributes
     include Axlsx::Accessors
@@ -41,10 +42,10 @@ module Axlsx
     # Serializes the header/footer object.
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '')
+    def to_xml_string(str = +'')
       serialized_tag('headerFooter', str) do
         serialized_element_attributes(str) do |value|
-          value = ::CGI.escapeHTML(value)
+          ::CGI.escapeHTML(value)
         end
       end
     end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Axlsx
   # Conditional Format Rule icon sets
   # Describes an icon set conditional formatting rule.
@@ -6,7 +8,6 @@ module Axlsx
   # @see Worksheet#add_conditional_formatting
   # @see ConditionalFormattingRule#initialize
   class IconSet
-
     include Axlsx::OptionsParser
     include Axlsx::SerializedAttributes
 
@@ -19,8 +20,10 @@ module Axlsx
       @percent = @showValue = true
       @reverse = false
       @iconSet = "3TrafficLights1"
-      initialize_value_objects
+      @interpolationPoints = [0, 33, 67]
+
       parse_options options
+
       yield self if block_given?
     end
 
@@ -33,7 +36,7 @@ module Axlsx
     attr_reader :iconSet
 
     # Indicates whether the thresholds indicate percentile values, instead of number values.
-    # The default falue is true
+    # The default value is true
     # @return [Boolean]
     attr_reader :percent
 
@@ -47,8 +50,20 @@ module Axlsx
     # @return [Boolean]
     attr_reader :showValue
 
-      # @see iconSet
-    def iconSet=(v); Axlsx::validate_icon_set(v); @iconSet = v end
+    # Sets the values of the interpolation points in the scale.
+    # The default value is [0, 33, 67]
+    # @return [Integer]
+    attr_reader :interpolationPoints
+
+    # @see iconSet
+    def iconSet=(v); Axlsx.validate_icon_set(v); @iconSet = v end
+
+    # @see interpolationPoints
+    def interpolationPoints=(v)
+      v.each { |point| Axlsx.validate_int(point) }
+      @value_objects = nil
+      @interpolationPoints = v
+    end
 
     # @see showValue
     def showValue=(v); Axlsx.validate_boolean(v); @showValue = v end
@@ -62,7 +77,9 @@ module Axlsx
     # Serialize this object to an xml string
     # @param [String] str
     # @return [String]
-    def to_xml_string(str="")
+    def to_xml_string(str = +'')
+      initialize_value_objects if @value_objects.nil?
+
       serialized_tag('iconSet', str) do
         @value_objects.each { |cfvo| cfvo.to_xml_string(str) }
       end
@@ -71,10 +88,9 @@ module Axlsx
     private
 
     # Initalize the simple typed list of value objects
-    # I am keeping this private for now as I am not sure what impact changes to the required two cfvo objects will do.
     def initialize_value_objects
       @value_objects = SimpleTypedList.new Cfvo
-      @value_objects.concat [Cfvo.new(:type => :percent, :val => 0), Cfvo.new(:type => :percent, :val => 33), Cfvo.new(:type => :percent, :val => 67)]
+      @interpolationPoints.each { |point| @value_objects << Cfvo.new(type: :percent, val: point) }
       @value_objects.lock
     end
   end

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

@@ -1,34 +1,34 @@
-module Axlsx
+# frozen_string_literal: true
 
+module Axlsx
   # A simple list of merged cells
   class MergedCells < SimpleTypedList
-
     # creates a new MergedCells object
     # @param [Worksheet] worksheet
     def initialize(worksheet)
       raise ArgumentError, 'you must provide a worksheet' unless worksheet.is_a?(Worksheet)
+
       super String
     end
 
     # adds cells to the merged cells collection
-    # @param [Array||String] cells The cells to add to the merged cells
+    # @param [Array|String] cells The cells to add to the merged cells
     # collection. This can be an array of actual cells or a string style
     # range like 'A1:C1'
     def add(cells)
       self << if cells.is_a?(String)
-                 cells
-               elsif cells.is_a?(Array)
-                 Axlsx::cell_range(cells, false)
-               elsif cells.is_a?(Row)
-                 Axlsx::cell_range(cells, false)
-               end
+                cells
+              elsif cells.is_a?(Array)
+                Axlsx.cell_range(cells, false)
+              end
     end
 
     # serialize the object
     # @param [String] str
     # @return [String]
-    def to_xml_string(str = '')
+    def to_xml_string(str = +'')
       return if empty?
+
       str << "<mergeCells count='#{size}'>"
       each { |merged_cell| str << "<mergeCell ref='#{merged_cell}'></mergeCell>" }
       str << '</mergeCells>'

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

@@ -1,5 +1,6 @@
-module Axlsx
+# frozen_string_literal: true
 
+module Axlsx
   # The OutlinePr class manages serialization of a worksheet's outlinePr element, which provides various
   # options to control outlining.
   class OutlinePr
@@ -26,8 +27,10 @@ module Axlsx
     # Serialize the object
     # @param [String] str serialized output will be appended to this object if provided.
     # @return [String]
-    def to_xml_string(str = '')
-      str << "<outlinePr #{serialized_attributes} />"
+    def to_xml_string(str = +'')
+      str << '<outlinePr '
+      serialized_attributes(str)
+      str << '/>'
     end
   end
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Axlsx
   # PageMargins specify the margins when printing a worksheet.
   #
@@ -9,7 +11,6 @@ module Axlsx
   # @see Worksheet#page_margins
   # @see Worksheet#initialize
   class PageMargins
-
     include Axlsx::OptionsParser
     include Axlsx::SerializedAttributes
 
@@ -20,7 +21,7 @@ module Axlsx
     # @option options [Numeric] top The top margin in inches
     # @option options [Numeric] header The header margin in inches
     # @option options [Numeric] footer The footer margin in inches
-    def initialize(options={})
+    def initialize(options = {})
       # Default values taken from MS Excel for Mac 2011
       @left = @right = DEFAULT_LEFT_RIGHT
       @top = @bottom = DEFAULT_TOP_BOTTOM
@@ -28,7 +29,10 @@ module Axlsx
       parse_options options
     end
 
-    serializable_attributes :left, :right, :bottom, :top, :header, :footer
+    # Possible margins to set
+    MARGIN_KEYS = [:left, :right, :top, :bottom, :header, :footer].freeze
+
+    serializable_attributes(*MARGIN_KEYS)
 
     # Default left and right margin (in inches)
     DEFAULT_LEFT_RIGHT = 0.75
@@ -64,33 +68,34 @@ module Axlsx
     attr_reader :footer
 
     # Set some or all margins at once.
-    # @param [Hash] margins the margins to set (possible keys are :left, :right, :top, :bottom, :header and :footer).
+    # @param [Hash] margins the margins to set. See {MARGIN_KEYS} for a list of possible keys.
     def set(margins)
       margins.select do |k, v|
-        next unless [:left, :right, :top, :bottom, :header, :footer].include? k
+        next unless MARGIN_KEYS.include? k
+
         send("#{k}=", v)
       end
     end
 
     # @see left
-    def left=(v); Axlsx::validate_unsigned_numeric(v); @left = v end
+    def left=(v); Axlsx.validate_unsigned_numeric(v); @left = v end
     # @see right
-    def right=(v); Axlsx::validate_unsigned_numeric(v); @right = v end
+    def right=(v); Axlsx.validate_unsigned_numeric(v); @right = v end
     # @see top
-    def top=(v); Axlsx::validate_unsigned_numeric(v); @top = v end
+    def top=(v); Axlsx.validate_unsigned_numeric(v); @top = v end
     # @see bottom
-    def bottom=(v); Axlsx::validate_unsigned_numeric(v); @bottom = v end
+    def bottom=(v); Axlsx.validate_unsigned_numeric(v); @bottom = v end
     # @see header
-    def header=(v); Axlsx::validate_unsigned_numeric(v); @header = v end
+    def header=(v); Axlsx.validate_unsigned_numeric(v); @header = v end
     # @see footer
-    def footer=(v); Axlsx::validate_unsigned_numeric(v); @footer = v end
+    def footer=(v); Axlsx.validate_unsigned_numeric(v); @footer = v end
 
     # Serializes the page margins element
     # @param [String] str
     # @return [String]
     # @note For compatibility, this is a noop unless custom margins have been specified.
     # @see #custom_margins_specified?
-    def to_xml_string(str = '')
+    def to_xml_string(str = +'')
       serialized_tag('pageMargins', str)
     end
   end

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

@@ -1,9 +1,9 @@
-module Axlsx
+# frozen_string_literal: true
 
+module Axlsx
   # Page setup properties of the worksheet
   # This class name is not a typo, its spec.
   class PageSetUpPr
-
     include Axlsx::OptionsParser
     include Axlsx::SerializedAttributes
 
@@ -37,8 +37,10 @@ module Axlsx
     end
 
     # serialize to xml
-    def to_xml_string(str='')
-      str << ('<pageSetUpPr ' << serialized_attributes << '/>')
+    def to_xml_string(str = +'')
+      str << '<pageSetUpPr '
+      serialized_attributes(str)
+      str << '/>'
     end
   end
 end