caxlsx 3.2.0 → 3.4.0

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

@@ -1,145 +1,142 @@
-# encoding: UTF-8
-module Axlsx
-
-  # The Col class defines column attributes for columns in sheets.
-  class Col
-
-    # Maximum column width limit in MS Excel is 255 characters
-    # https://support.microsoft.com/en-us/office/excel-specifications-and-limits-1672b34d-7043-467e-8e27-269d656771c3
-    MAX_WIDTH = 255
-
-    include Axlsx::OptionsParser
-    include Axlsx::SerializedAttributes
-    # Create a new Col objects
-    # @param min First column affected by this 'column info' record.
-    # @param max Last column affected by this 'column info' record.
-    # @option options [Boolean] collapsed see Col#collapsed
-    # @option options [Boolean] hidden see Col#hidden
-    # @option options [Boolean] outlineLevel see Col#outlineLevel
-    # @option options [Boolean] phonetic see Col#phonetic
-    # @option options [Integer] style see Col#style
-    # @option options [Numeric] width see Col#width
-    def initialize(min, max, options={})
-      Axlsx.validate_unsigned_int(max)
-      Axlsx.validate_unsigned_int(min)
-      @min = min
-      @max = max
-      parse_options options
-    end
-
-    serializable_attributes :collapsed, :hidden, :outline_level, :phonetic, :style, :width, :min, :max, :best_fit, :custom_width
-
-    # First column affected by this 'column info' record.
-    # @return [Integer]
-    attr_reader :min
-
-    # Last column affected by this 'column info' record.
-    # @return [Integer]
-    attr_reader :max
-
-    # Flag indicating if the specified column(s) is set to 'best fit'. 'Best fit' is set to true under these conditions:
-    # The column width has never been manually set by the user, AND The column width is not the default width
-    # 'Best fit' means that when numbers are typed into a cell contained in a 'best fit' column, the column width should
-    #  automatically resize to display the number. [Note: In best fit cases, column width must not be made smaller, only larger. end note]
-    # @return [Boolean]
-    attr_reader :best_fit
-    alias :bestFit :best_fit
-
-    # Flag indicating if the outlining of the affected column(s) is in the collapsed state.
-    # @return [Boolean]
-    attr_reader :collapsed
-
-    # Flag indicating if the affected column(s) are hidden on this worksheet.
-    # @return [Boolean]
-    attr_reader :hidden
-
-    # Outline level of affected column(s). Range is 0 to 7.
-    # @return [Integer]
-    attr_reader :outline_level
-    alias :outlineLevel :outline_level
-
-    # Flag indicating if the phonetic information should be displayed by default for the affected column(s) of the worksheet.
-    # @return [Boolean]
-    attr_reader :phonetic
-
-    # Default style for the affected column(s). Affects cells not yet allocated in the column(s). In other words, this style applies to new columns.
-    # @return [Integer]
-    attr_reader :style
-
-    # The width of the column
-    # @return [Numeric]
-    attr_reader :width
-
-    # @return [Boolean]
-    attr_reader :custom_width
-    alias :customWidth :custom_width
-
-    # @see Col#collapsed
-    def collapsed=(v)
-      Axlsx.validate_boolean(v)
-      @collapsed = v
-    end
-
-    # @see Col#hidden
-    def hidden=(v)
-      Axlsx.validate_boolean(v)
-      @hidden = v
-    end
-
-    # @see Col#outline
-    def outline_level=(v)
-      Axlsx.validate_unsigned_numeric(v)
-      raise ArgumentError, 'outlineLevel must be between 0 and 7' unless 0 <= v && v <= 7
-      @outline_level = v
-    end
-    alias :outlineLevel= :outline_level=
-
-    # @see Col#phonetic
-    def phonetic=(v)
-      Axlsx.validate_boolean(v)
-      @phonetic = v
-    end
-
-    # @see Col#style
-    def style=(v)
-      Axlsx.validate_unsigned_int(v)
-      @style = v
-    end
-
-   # @see Col#width
-    def width=(v)
-      # Removing this validation make a 10% difference in performance
-      # as it is called EVERY TIME A CELL IS ADDED - the proper solution
-      # is to only set this if a calculated value is greated than the
-      # current @width value.
-      # TODO!!!
-      #Axlsx.validate_unsigned_numeric(v) unless v == nil
-      @custom_width = @best_fit = v != nil
-      @width = v.nil? ? v : [v, MAX_WIDTH].min
-    end
-
-    # updates the width for this col based on the cells autowidth and
-    # an optionally specified fixed width
-    # @param [Cell] cell The cell to use in updating this col's width
-    # @param [Integer] fixed_width If this is specified the width is set
-    # to this value and the cell's attributes are ignored.
-    # @param [Boolean] use_autowidth If this is false, the cell's
-    # autowidth value will be ignored.
-    def update_width(cell, fixed_width = nil, use_autowidth = true)
-      if fixed_width.is_a? Numeric
-        self.width = fixed_width
-      elsif use_autowidth
-        cell_width = cell.autowidth
-        self.width = cell_width unless (width || 0) > (cell_width || 0)
-      end
-    end
-
-    # Serialize this columns data to an xml string
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      serialized_tag('col', str)
-    end
-
-  end
-end
+module Axlsx
+  # The Col class defines column attributes for columns in sheets.
+  class Col
+    # Maximum column width limit in MS Excel is 255 characters
+    # https://support.microsoft.com/en-us/office/excel-specifications-and-limits-1672b34d-7043-467e-8e27-269d656771c3
+    MAX_WIDTH = 255
+
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+    # Create a new Col objects
+    # @param min First column affected by this 'column info' record.
+    # @param max Last column affected by this 'column info' record.
+    # @option options [Boolean] collapsed see Col#collapsed
+    # @option options [Boolean] hidden see Col#hidden
+    # @option options [Boolean] outlineLevel see Col#outlineLevel
+    # @option options [Boolean] phonetic see Col#phonetic
+    # @option options [Integer] style see Col#style
+    # @option options [Numeric] width see Col#width
+    def initialize(min, max, options = {})
+      Axlsx.validate_unsigned_int(max)
+      Axlsx.validate_unsigned_int(min)
+      @min = min
+      @max = max
+      parse_options options
+    end
+
+    serializable_attributes :collapsed, :hidden, :outline_level, :phonetic, :style, :width, :min, :max, :best_fit, :custom_width
+
+    # First column affected by this 'column info' record.
+    # @return [Integer]
+    attr_reader :min
+
+    # Last column affected by this 'column info' record.
+    # @return [Integer]
+    attr_reader :max
+
+    # Flag indicating if the specified column(s) is set to 'best fit'. 'Best fit' is set to true under these conditions:
+    # The column width has never been manually set by the user, AND The column width is not the default width
+    # 'Best fit' means that when numbers are typed into a cell contained in a 'best fit' column, the column width should
+    #  automatically resize to display the number. [Note: In best fit cases, column width must not be made smaller, only larger. end note]
+    # @return [Boolean]
+    attr_reader :best_fit
+    alias :bestFit :best_fit
+
+    # Flag indicating if the outlining of the affected column(s) is in the collapsed state.
+    # @return [Boolean]
+    attr_reader :collapsed
+
+    # Flag indicating if the affected column(s) are hidden on this worksheet.
+    # @return [Boolean]
+    attr_reader :hidden
+
+    # Outline level of affected column(s). Range is 0 to 7.
+    # @return [Integer]
+    attr_reader :outline_level
+    alias :outlineLevel :outline_level
+
+    # Flag indicating if the phonetic information should be displayed by default for the affected column(s) of the worksheet.
+    # @return [Boolean]
+    attr_reader :phonetic
+
+    # Default style for the affected column(s). Affects cells not yet allocated in the column(s). In other words, this style applies to new columns.
+    # @return [Integer]
+    attr_reader :style
+
+    # The width of the column
+    # @return [Numeric]
+    attr_reader :width
+
+    # @return [Boolean]
+    attr_reader :custom_width
+    alias :customWidth :custom_width
+
+    # @see Col#collapsed
+    def collapsed=(v)
+      Axlsx.validate_boolean(v)
+      @collapsed = v
+    end
+
+    # @see Col#hidden
+    def hidden=(v)
+      Axlsx.validate_boolean(v)
+      @hidden = v
+    end
+
+    # @see Col#outline
+    def outline_level=(v)
+      Axlsx.validate_unsigned_numeric(v)
+      raise ArgumentError, 'outlineLevel must be between 0 and 7' unless 0 <= v && v <= 7
+
+      @outline_level = v
+    end
+    alias :outlineLevel= :outline_level=
+
+    # @see Col#phonetic
+    def phonetic=(v)
+      Axlsx.validate_boolean(v)
+      @phonetic = v
+    end
+
+    # @see Col#style
+    def style=(v)
+      Axlsx.validate_unsigned_int(v)
+      @style = v
+    end
+
+    # @see Col#width
+    def width=(v)
+      # Removing this validation make a 10% difference in performance
+      # as it is called EVERY TIME A CELL IS ADDED - the proper solution
+      # is to only set this if a calculated value is greated than the
+      # current @width value.
+      # TODO!!!
+      # Axlsx.validate_unsigned_numeric(v) unless v == nil
+      @custom_width = @best_fit = v != nil
+      @width = v.nil? ? v : [v, MAX_WIDTH].min
+    end
+
+    # updates the width for this col based on the cells autowidth and
+    # an optionally specified fixed width
+    # @param [Cell] cell The cell to use in updating this col's width
+    # @param [Integer] fixed_width If this is specified the width is set
+    # to this value and the cell's attributes are ignored.
+    # @param [Boolean] use_autowidth If this is false, the cell's
+    # autowidth value will be ignored.
+    def update_width(cell, fixed_width = nil, use_autowidth = true)
+      if fixed_width.is_a? Numeric
+        self.width = fixed_width
+      elsif use_autowidth
+        cell_width = cell.autowidth
+        self.width = cell_width unless (width || 0) > (cell_width || 0)
+      end
+    end
+
+    # Serialize this columns data to an xml string
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      serialized_tag('col', str)
+    end
+  end
+end

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

@@ -1,35 +1,34 @@
-module Axlsx
-
-  # A collection of Brake objects.
-  # Please do not use this class directly. Instead use 
-  # Worksheet#add_break
-  class ColBreaks < SimpleTypedList
-
-    # Instantiates a new list restricted to Break types
-    def initialize
-      super Break
-    end
-
-    # A column break specific helper for adding a break.
-    # @param [Hash] options A list of options to pass into the Break object
-    # The max and man options are fixed, however any other valid option for 
-    # Break will be passed to the created break object.
-    # @see Break
-    def add_break(options)
-      self << Break.new(options.merge(:max => 1048575, :man => true))
-      last
-    end
-
-    # Serialize the collection to xml
-    # @param [String] str The string to append this lists xml to.
-    # <colBreaks count="1" manualBreakCount="1">
-    # <brk id="3" max="1048575" man="1"/>
-    # </colBreaks>
-    def to_xml_string(str='')
-      return if empty?
-      str << ('<colBreaks count="' << size.to_s << '" manualBreakCount="' << size.to_s << '">')
-      each { |brk| brk.to_xml_string(str) }
-      str << '</colBreaks>'
-    end
-  end
-end
+module Axlsx
+  # A collection of Brake objects.
+  # Please do not use this class directly. Instead use
+  # Worksheet#add_break
+  class ColBreaks < SimpleTypedList
+    # Instantiates a new list restricted to Break types
+    def initialize
+      super Break
+    end
+
+    # A column break specific helper for adding a break.
+    # @param [Hash] options A list of options to pass into the Break object
+    # The max and man options are fixed, however any other valid option for
+    # Break will be passed to the created break object.
+    # @see Break
+    def add_break(options)
+      self << Break.new(options.merge(:max => 1048575, :man => true))
+      last
+    end
+
+    # Serialize the collection to xml
+    # @param [String] str The string to append this lists xml to.
+    # <colBreaks count="1" manualBreakCount="1">
+    # <brk id="3" max="1048575" man="1"/>
+    # </colBreaks>
+    def to_xml_string(str = '')
+      return if empty?
+
+      str << ('<colBreaks count="' << size.to_s << '" manualBreakCount="' << size.to_s << '">')
+      each { |brk| brk.to_xml_string(str) }
+      str << '</colBreaks>'
+    end
+  end
+end

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

@@ -1,110 +1,108 @@
-module Axlsx
-  # Conditional Format Rule color scale object
-  # Describes a gradated color scale in this 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 ColorScale
-
-    class << self
-
-      # These are the default conditional formatting value objects
-      # that define a two tone color gradient.
-      def default_cfvos
-        [{:type => :min, :val => 0, :color => 'FFFF7128'},
-         {:type => :max, :val => 0, :color => 'FFFFEF9C'}]
-      end
-
-      # A builder for two tone color gradient
-      # @example
-      #   # this creates a two tone color scale
-      #   color_scale = Axlsx::ColorScale.two_tone
-      # @see examples/example.rb conditional formatting examples.
-      def two_tone
-        self.new
-      end
-
-      # A builder for three tone color gradient
-      # @example
-      #   #this creates a three tone color scale
-      #   color_scale = Axlsx::ColorScale.three_tone 
-      # @see examples/example.rb conditional formatting examples.
-      def three_tone
-        self.new({:type => :min, :val => 0, :color => 'FFF8696B'},
-                 {:type => :percent, :val => '50', :color => 'FFFFEB84'},
-                 {:type => :max, :val => 0, :color => 'FF63BE7B'})
-      end
-    end
-    # A simple typed list of cfvos
-    # @return [SimpleTypedList]
-    # @see Cfvo
-    def value_objects
-      @value_objects ||= Cfvos.new
-    end
-
-    # A simple types list of colors
-    # @return [SimpleTypedList]
-    # @see Color
-    def colors
-      @colors ||= SimpleTypedList.new Color
-    end
-
-    # creates a new ColorScale object.
-    # @see Cfvo
-    # @see Color
-    # @example
-    #     color_scale = Axlsx::ColorScale.new({:type => :num, :val => 0.55, :color => 'fff7696c'})
-    def initialize(*cfvos)
-      initialize_default_cfvos(cfvos)
-      yield self if block_given?
-    end
-
-    # adds a new cfvo / color pair to the color scale and returns a hash containing
-    # a reference to the newly created cfvo and color objects so you can alter the default properties.
-    # @return [Hash] a hash with :cfvo and :color keys referencing the newly added objects.
-    # @param [Hash] options options for the new cfvo and color objects
-    # @option [Symbol] type The type of cfvo you to add
-    # @option [Any] val The value of the cfvo to add
-    # @option [String] The rgb color for the cfvo
-    def add(options={})
-      value_objects << Cfvo.new(:type => options[:type] || :min, :val => options[:val] || 0)
-      colors << Color.new(:rgb => options[:color] || "FF000000")
-      {:cfvo => value_objects.last, :color => colors.last}
-    end
-
-
-    # removes the cfvo and color pair at the index specified.
-    # @param [Integer] index The index of the cfvo and color object to delete
-    # @note you cannot remove the first two cfvo and color pairs
-    def delete_at(index=2)
-      value_objects.delete_at index
-      colors.delete_at index
-    end
-
-    # Serialize this color_scale object data to an xml string
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      str << '<colorScale>'
-      value_objects.to_xml_string(str)
-      colors.each { |color| color.to_xml_string(str) }
-      str << '</colorScale>'
-    end
-
-    private
-    # There has got to be cleaner way of merging these arrays.
-    def initialize_default_cfvos(user_cfvos)
-      defaults = self.class.default_cfvos
-      user_cfvos.each_with_index do |cfvo, index|
-        if index < defaults.size
-          cfvo = defaults[index].merge(cfvo)
-        end
-        add cfvo
-      end
-      while colors.size < defaults.size
-        add defaults[colors.size - 1]
-      end
-    end
-  end
-end
+module Axlsx
+  # Conditional Format Rule color scale object
+  # Describes a gradated color scale in this 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 ColorScale
+    class << self
+      # These are the default conditional formatting value objects
+      # that define a two tone color gradient.
+      def default_cfvos
+        [{ :type => :min, :val => 0, :color => 'FFFF7128' },
+         { :type => :max, :val => 0, :color => 'FFFFEF9C' }]
+      end
+
+      # A builder for two tone color gradient
+      # @example
+      #   # this creates a two tone color scale
+      #   color_scale = Axlsx::ColorScale.two_tone
+      # @see examples/example.rb conditional formatting examples.
+      def two_tone
+        self.new
+      end
+
+      # A builder for three tone color gradient
+      # @example
+      #   #this creates a three tone color scale
+      #   color_scale = Axlsx::ColorScale.three_tone
+      # @see examples/example.rb conditional formatting examples.
+      def three_tone
+        self.new({ :type => :min, :val => 0, :color => 'FFF8696B' },
+                 { :type => :percent, :val => '50', :color => 'FFFFEB84' },
+                 { :type => :max, :val => 0, :color => 'FF63BE7B' })
+      end
+    end
+    # A simple typed list of cfvos
+    # @return [SimpleTypedList]
+    # @see Cfvo
+    def value_objects
+      @value_objects ||= Cfvos.new
+    end
+
+    # A simple types list of colors
+    # @return [SimpleTypedList]
+    # @see Color
+    def colors
+      @colors ||= SimpleTypedList.new Color
+    end
+
+    # creates a new ColorScale object.
+    # @see Cfvo
+    # @see Color
+    # @example
+    #     color_scale = Axlsx::ColorScale.new({:type => :num, :val => 0.55, :color => 'fff7696c'})
+    def initialize(*cfvos)
+      initialize_default_cfvos(cfvos)
+      yield self if block_given?
+    end
+
+    # adds a new cfvo / color pair to the color scale and returns a hash containing
+    # a reference to the newly created cfvo and color objects so you can alter the default properties.
+    # @return [Hash] a hash with :cfvo and :color keys referencing the newly added objects.
+    # @param [Hash] options options for the new cfvo and color objects
+    # @option [Symbol] type The type of cfvo you to add
+    # @option [Any] val The value of the cfvo to add
+    # @option [String] The rgb color for the cfvo
+    def add(options = {})
+      value_objects << Cfvo.new(:type => options[:type] || :min, :val => options[:val] || 0)
+      colors << Color.new(:rgb => options[:color] || "FF000000")
+      { :cfvo => value_objects.last, :color => colors.last }
+    end
+
+    # removes the cfvo and color pair at the index specified.
+    # @param [Integer] index The index of the cfvo and color object to delete
+    # @note you cannot remove the first two cfvo and color pairs
+    def delete_at(index = 2)
+      value_objects.delete_at index
+      colors.delete_at index
+    end
+
+    # Serialize this color_scale object data to an xml string
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<colorScale>'
+      value_objects.to_xml_string(str)
+      colors.each { |color| color.to_xml_string(str) }
+      str << '</colorScale>'
+    end
+
+    private
+
+    # There has got to be cleaner way of merging these arrays.
+    def initialize_default_cfvos(user_cfvos)
+      defaults = self.class.default_cfvos
+      user_cfvos.each_with_index do |cfvo, index|
+        if index < defaults.size
+          cfvo = defaults[index].merge(cfvo)
+        end
+        add cfvo
+      end
+      while colors.size < defaults.size
+        add defaults[colors.size - 1]
+      end
+    end
+  end
+end

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

@@ -1,23 +1,23 @@
-module Axlsx
-
-  # The cols class manages the col object used to manage column widths.
-  # This is where the magic happens with autowidth
-  class Cols < SimpleTypedList
-
-    def initialize(worksheet)
-      raise ArgumentError, "you must provide a worksheet" unless worksheet.is_a?(Worksheet)
-      super Col
-      @worksheet = worksheet
-    end
-
-    # Serialize the Cols object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-     return if empty?
-     str << '<cols>'
-     each { |item| item.to_xml_string(str) }
-     str << '</cols>'
-    end
-  end
-end
+module Axlsx
+  # The cols class manages the col object used to manage column widths.
+  # This is where the magic happens with autowidth
+  class Cols < SimpleTypedList
+    def initialize(worksheet)
+      raise ArgumentError, "you must provide a worksheet" unless worksheet.is_a?(Worksheet)
+
+      super Col
+      @worksheet = worksheet
+    end
+
+    # Serialize the Cols object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      return if empty?
+
+      str << '<cols>'
+      each { |item| item.to_xml_string(str) }
+      str << '</cols>'
+    end
+  end
+end