caxlsx 3.2.0 → 3.4.0

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

@@ -1,64 +1,65 @@
-module Axlsx
-
-  # This class manages the dimensions for a worksheet.
-  # 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
-      @@default_first ||= 'A1'
-    end
-
-    # the default value for the last cell in the dimension
-    # @return [String]
-    def self.default_last
-      @@default_last ||= 'AA200'
-    end
-
-    # Creates a new dimension object
-    # @param[Worksheet] worksheet - the worksheet this dimension applies
-    # to.
-    def initialize(worksheet)
-      raise ArgumentError, "you must provide a worksheet" unless worksheet.is_a?(Worksheet)
-      @worksheet = worksheet
-    end
-
-    attr_reader :worksheet
-
-    # the full refernece for this dimension
-    # @return [String]
-    def sqref
-      "#{first_cell_reference}:#{last_cell_reference}"
-    end 
-
-    # serialize the object
-    # @return [String]
-    def to_xml_string(str = '')
-      return if worksheet.rows.empty?
-      str << "<dimension ref=\"%s\"></dimension>" % sqref
-    end
-
-    # The first cell in the dimension
-    # @return [String]
-    def first_cell_reference
-      dimension_reference(worksheet.rows.first.first, Dimension.default_first)
-    end
-
-    # the last cell in the dimension
-    # @return [String]
-    def last_cell_reference
-      dimension_reference(worksheet.rows.last.last, Dimension.default_last)
-    end
-
-    private
-
-    # Returns the reference of a cell or the default specified
-    # @return [String]
-    def dimension_reference(cell, default)
-      return default unless cell.respond_to?(:r)
-      cell.r
-    end
-  end
-end
+module Axlsx
+  # This class manages the dimensions for a worksheet.
+  # 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
+      @@default_first ||= 'A1'
+    end
+
+    # the default value for the last cell in the dimension
+    # @return [String]
+    def self.default_last
+      @@default_last ||= 'AA200'
+    end
+
+    # Creates a new dimension object
+    # @param[Worksheet] worksheet - the worksheet this dimension applies
+    # to.
+    def initialize(worksheet)
+      raise ArgumentError, "you must provide a worksheet" unless worksheet.is_a?(Worksheet)
+
+      @worksheet = worksheet
+    end
+
+    attr_reader :worksheet
+
+    # the full refernece for this dimension
+    # @return [String]
+    def sqref
+      "#{first_cell_reference}:#{last_cell_reference}"
+    end
+
+    # serialize the object
+    # @return [String]
+    def to_xml_string(str = '')
+      return if worksheet.rows.empty?
+
+      str << "<dimension ref=\"%s\"></dimension>" % sqref
+    end
+
+    # The first cell in the dimension
+    # @return [String]
+    def first_cell_reference
+      dimension_reference(worksheet.rows.first.first, Dimension.default_first)
+    end
+
+    # the last cell in the dimension
+    # @return [String]
+    def last_cell_reference
+      dimension_reference(worksheet.rows.last.last, Dimension.default_last)
+    end
+
+    private
+
+    # Returns the reference of a cell or the default specified
+    # @return [String]
+    def dimension_reference(cell, default)
+      return default unless cell.respond_to?(:r)
+
+      cell.r
+    end
+  end
+end

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

@@ -1,52 +1,51 @@
-module Axlsx
-  # Header/Footer options for printing a worksheet. All settings are optional.
-  #
-  # Headers and footers are generated using a string which is a combination
-  # of plain text and control characters. A fairly comprehensive list of control
-  # characters can be found here:
-  # https://github.com/randym/axlsx/blob/master/notes_on_header_footer.md
-  #     
-  # @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
-
-    # Creates a new HeaderFooter object
-    # @option options [String] odd_header The content for headers on odd numbered pages.
-    # @option options [String] odd_footer The content for footers on odd numbered pages.
-    # @option options [String] even_header The content for headers on even numbered pages.
-    # @option options [String] even_footer The content for footers on even numbered pages.
-    # @option options [String] first_header The content for headers on the first page.
-    # @option options [String] first_footer The content for footers on the first page.
-    # @option options [Boolean] different_odd_even Setting this to true will show different headers/footers on odd and even pages. When false, the odd headers/footers are used on each page. (Default: false)
-    # @option options [Boolean] different_first If true, will use the first header/footer on page 1. Otherwise, the odd header/footer is used.
-    def initialize(options = {})
-      parse_options options
-    end
-
-    serializable_attributes :different_odd_even, :different_first
-    serializable_element_attributes :odd_header, :odd_footer, :even_header, :even_footer, :first_header, :first_footer
-    string_attr_accessor :odd_header, :odd_footer, :even_header, :even_footer, :first_header, :first_footer
-    boolean_attr_accessor :different_odd_even, :different_first
-
-    # Set some or all header/footers at once.
-    # @param [Hash] options The header/footer options to set (possible keys are :odd_header, :odd_footer, :even_header, :even_footer, :first_header, :first_footer, :different_odd_even, and :different_first).
-    def set(options)
-      parse_options options
-    end
-
-    # Serializes the header/footer object.
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      serialized_tag('headerFooter', str) do
-        serialized_element_attributes(str) do |value|
-          value = ::CGI.escapeHTML(value)
-        end
-      end
-    end
-  end
-end
+module Axlsx
+  # Header/Footer options for printing a worksheet. All settings are optional.
+  #
+  # Headers and footers are generated using a string which is a combination
+  # of plain text and control characters. A fairly comprehensive list of control
+  # characters can be found here:
+  # https://github.com/randym/axlsx/blob/master/notes_on_header_footer.md
+  #     
+  # @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
+
+    # Creates a new HeaderFooter object
+    # @option options [String] odd_header The content for headers on odd numbered pages.
+    # @option options [String] odd_footer The content for footers on odd numbered pages.
+    # @option options [String] even_header The content for headers on even numbered pages.
+    # @option options [String] even_footer The content for footers on even numbered pages.
+    # @option options [String] first_header The content for headers on the first page.
+    # @option options [String] first_footer The content for footers on the first page.
+    # @option options [Boolean] different_odd_even Setting this to true will show different headers/footers on odd and even pages. When false, the odd headers/footers are used on each page. (Default: false)
+    # @option options [Boolean] different_first If true, will use the first header/footer on page 1. Otherwise, the odd header/footer is used.
+    def initialize(options = {})
+      parse_options options
+    end
+
+    serializable_attributes :different_odd_even, :different_first
+    serializable_element_attributes :odd_header, :odd_footer, :even_header, :even_footer, :first_header, :first_footer
+    string_attr_accessor :odd_header, :odd_footer, :even_header, :even_footer, :first_header, :first_footer
+    boolean_attr_accessor :different_odd_even, :different_first
+
+    # Set some or all header/footers at once.
+    # @param [Hash] options The header/footer options to set (possible keys are :odd_header, :odd_footer, :even_header, :even_footer, :first_header, :first_footer, :different_odd_even, and :different_first).
+    def set(options)
+      parse_options options
+    end
+
+    # Serializes the header/footer object.
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      serialized_tag('headerFooter', str) do
+        serialized_element_attributes(str) do |value|
+          value = ::CGI.escapeHTML(value)
+        end
+      end
+    end
+  end
+end

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

@@ -1,81 +1,80 @@
-module Axlsx
-  # Conditional Format Rule icon sets
-  # Describes an icon set 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 IconSet
-
-    include Axlsx::OptionsParser
-    include Axlsx::SerializedAttributes
-
-    # Creates a new icon set object
-    # @option options [String] iconSet
-    # @option options [Boolean] reverse
-    # @option options [Boolean] percent
-    # @option options [Boolean] showValue
-    def initialize(options = {})
-      @percent = @showValue = true
-      @reverse = false
-      @iconSet = "3TrafficLights1"
-      initialize_value_objects
-      parse_options options
-      yield self if block_given?
-    end
-
-    serializable_attributes :iconSet, :percent, :reverse, :showValue
-
-    # The icon set to display.
-    # Allowed values are: 3Arrows, 3ArrowsGray, 3Flags, 3TrafficLights1, 3TrafficLights2, 3Signs, 3Symbols, 3Symbols2, 4Arrows, 4ArrowsGray, 4RedToBlack, 4Rating, 4TrafficLights, 5Arrows, 5ArrowsGray, 5Rating, 5Quarters
-    # The default value is 3TrafficLights1
-    # @return [String]
-    attr_reader :iconSet
-
-    # Indicates whether the thresholds indicate percentile values, instead of number values.
-    # The default falue is true
-    # @return [Boolean]
-    attr_reader :percent
-
-    # If true, reverses the default order of the icons in this icon set.maxLength attribute
-    # The default value is false
-    # @return [Boolean]
-    attr_reader :reverse
-
-    # 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 :showValue
-
-      # @see iconSet
-    def iconSet=(v); Axlsx::validate_icon_set(v); @iconSet = v end
-
-    # @see showValue
-    def showValue=(v); Axlsx.validate_boolean(v); @showValue = v end
-
-    # @see percent
-    def percent=(v); Axlsx.validate_boolean(v); @percent = v end
-
-    # @see reverse
-    def reverse=(v); Axlsx.validate_boolean(v); @reverse = v end
-
-    # Serialize this object to an xml string
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str="")
-      serialized_tag('iconSet', str) do
-        @value_objects.each { |cfvo| cfvo.to_xml_string(str) }
-      end
-    end
-
-    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)]
-      @value_objects.lock
-    end
-  end
-end
+module Axlsx
+  # Conditional Format Rule icon sets
+  # Describes an icon set 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 IconSet
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+
+    # Creates a new icon set object
+    # @option options [String] iconSet
+    # @option options [Boolean] reverse
+    # @option options [Boolean] percent
+    # @option options [Boolean] showValue
+    def initialize(options = {})
+      @percent = @showValue = true
+      @reverse = false
+      @iconSet = "3TrafficLights1"
+      initialize_value_objects
+      parse_options options
+      yield self if block_given?
+    end
+
+    serializable_attributes :iconSet, :percent, :reverse, :showValue
+
+    # The icon set to display.
+    # Allowed values are: 3Arrows, 3ArrowsGray, 3Flags, 3TrafficLights1, 3TrafficLights2, 3Signs, 3Symbols, 3Symbols2, 4Arrows, 4ArrowsGray, 4RedToBlack, 4Rating, 4TrafficLights, 5Arrows, 5ArrowsGray, 5Rating, 5Quarters
+    # The default value is 3TrafficLights1
+    # @return [String]
+    attr_reader :iconSet
+
+    # Indicates whether the thresholds indicate percentile values, instead of number values.
+    # The default falue is true
+    # @return [Boolean]
+    attr_reader :percent
+
+    # If true, reverses the default order of the icons in this icon set.maxLength attribute
+    # The default value is false
+    # @return [Boolean]
+    attr_reader :reverse
+
+    # 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 :showValue
+
+    # @see iconSet
+    def iconSet=(v); Axlsx::validate_icon_set(v); @iconSet = v end
+
+    # @see showValue
+    def showValue=(v); Axlsx.validate_boolean(v); @showValue = v end
+
+    # @see percent
+    def percent=(v); Axlsx.validate_boolean(v); @percent = v end
+
+    # @see reverse
+    def reverse=(v); Axlsx.validate_boolean(v); @reverse = v end
+
+    # Serialize this object to an xml string
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = "")
+      serialized_tag('iconSet', str) do
+        @value_objects.each { |cfvo| cfvo.to_xml_string(str) }
+      end
+    end
+
+    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)]
+      @value_objects.lock
+    end
+  end
+end

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

@@ -1,37 +1,37 @@
-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
-    # 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
-    end
-
-    # serialize the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      return if empty?
-      str << "<mergeCells count='#{size}'>"
-      each { |merged_cell| str << "<mergeCell ref='#{merged_cell}'></mergeCell>" }
-      str << '</mergeCells>'
-    end
-  end
-end
+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
+    # 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
+    end
+
+    # serialize the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      return if empty?
+
+      str << "<mergeCells count='#{size}'>"
+      each { |merged_cell| str << "<mergeCell ref='#{merged_cell}'></mergeCell>" }
+      str << '</mergeCells>'
+    end
+  end
+end

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

@@ -1,33 +1,32 @@
-module Axlsx
-
-  # The OutlinePr class manages serialization of a worksheet's outlinePr element, which provides various
-  # options to control outlining.
-  class OutlinePr
-    include Axlsx::OptionsParser
-    include Axlsx::Accessors
-    include Axlsx::SerializedAttributes
-
-    serializable_attributes :summary_below,
-                            :summary_right,
-                            :apply_styles
-
-    # These attributes are all boolean so I'm doing a bit of a hand
-    # waving magic show to set up the attriubte accessors
-    boolean_attr_accessor :summary_below,
-                          :summary_right,
-                          :apply_styles
-
-    # Creates a new OutlinePr object
-    # @param [Hash] options used to create the outline_pr
-    def initialize(options = {})
-      parse_options options
-    end
-
-    # 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} />"
-    end
-  end
-end
+module Axlsx
+  # The OutlinePr class manages serialization of a worksheet's outlinePr element, which provides various
+  # options to control outlining.
+  class OutlinePr
+    include Axlsx::OptionsParser
+    include Axlsx::Accessors
+    include Axlsx::SerializedAttributes
+
+    serializable_attributes :summary_below,
+                            :summary_right,
+                            :apply_styles
+
+    # These attributes are all boolean so I'm doing a bit of a hand
+    # waving magic show to set up the attriubte accessors
+    boolean_attr_accessor :summary_below,
+                          :summary_right,
+                          :apply_styles
+
+    # Creates a new OutlinePr object
+    # @param [Hash] options used to create the outline_pr
+    def initialize(options = {})
+      parse_options options
+    end
+
+    # 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} />"
+    end
+  end
+end