axlsx 1.3.1 → 1.3.2

data/lib/axlsx/util/simple_typed_list.rb

@@ -43,16 +43,16 @@ module Axlsx
     def to_ary
       @list
     end
-   
+
     alias :to_a :to_ary
-    
+
     # Unlock the list
     # @return [self]
     def unlock
       @locked_at = nil
       self
     end
-    
+
     # join operator
     # @param [Array] v the array to join
     # @raise [ArgumentError] if any of the values being joined are not
@@ -62,7 +62,7 @@ module Axlsx
       v.each do |item| 
         DataTypeValidator.validate "SimpleTypedList.+", @allowed_types, item
         @list << item 
-      end 
+      end
     end
 
     # Concat operator
@@ -107,6 +107,18 @@ module Axlsx
       v
     end
 
+    # inserts an item at the index specfied
+    # @param [Integer] index
+    # @param [Any] v
+    # @raise [ArgumentError] if the index is protected by locking
+    # @raise [ArgumentError] if the index is not one of the allowed types
+    def insert(index, v)
+      DataTypeValidator.validate "SimpleTypedList.<<", @allowed_types, v
+      raise ArgumentError, "Item is protected and cannot be changed" if protected? index
+      @list.insert(index, v)
+      v
+    end
+
     # determines if the index is protected
     # @param [Integer] index
     def protected? index

data/lib/axlsx/version.rb

@@ -1,5 +1,5 @@
 module Axlsx
 
   # The current version
-  VERSION = "1.3.1"
+  VERSION = "1.3.2"
 end

data/lib/axlsx/workbook/defined_name.rb

@@ -49,12 +49,15 @@ module Axlsx
   # @example
   #     For clarification: LOG10 is always a cell reference, LOG10() is always formula, LOGO1000 can be a defined name that overrides a cell reference.
   class DefinedName
+    include Axlsx::SerializedAttributes
+    include Axlsx::OptionsParser
+    include Axlsx::Accessors
     # creates a new DefinedName.
     # @param [String] formula - the formula the defined name references
     # @param [Hash] options - A hash of key/value pairs that will be mapped to this instances attributes.
-    # 
+    #
     # @option [String] name - Specifies the name that appears in the user interface for the defined name.
-    #                         This attribute is required. 
+    #                         This attribute is required.
     #                         The following built-in names are defined in this SpreadsheetML specification:
     #                         Print
     #                           _xlnm.Print_Area: this defined name specifies the workbook's print area.
@@ -96,10 +99,9 @@ module Axlsx
     #                                        version of the workbook that is published to or rendered on a Web or application server.
     def initialize(formula, options={})
       @formula = formula
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
+      parse_options options
     end
+
     attr_reader :local_sheet_id
 
     # The local sheet index (0-based)
@@ -109,64 +111,17 @@ module Axlsx
       @local_sheet_id = value
     end
 
-    # string attributes that will be added when this class is evaluated
-    STRING_ATTRIBUTES = [:short_cut_key, :status_bar, :help, :description, :custom_menu, :comment]
-
-    # boolean attributes that will be added when this class is evaluated
-    BOOLEAN_ATTRIBUTES = [:workbook_parameter, :publish_to_server, :xlm, :vb_proceedure, :function, :hidden] 
-
-    # Dynamically create string attribute accessors
-    STRING_ATTRIBUTES.each do |attr|
-      class_eval %{
-        # The #{attr} attribute reader
-        # @return [String]
-        attr_reader :#{attr}
-
-        # The #{attr} writer
-        # @param [String] value The value to assign to #{attr}
-        # @return [String]
-        def #{attr}=(value)
-          Axlsx::validate_string(value)
-          @#{attr}= value
-        end
-      }
-    end
-
-    # Dynamically create boolean attribute accessors
-    BOOLEAN_ATTRIBUTES.each do |attr|
-      class_eval %{
-      # The #{attr} attribute reader
-      # @return [Boolean]
-      attr_reader :#{attr}
+    string_attr_accessor :short_cut_key, :status_bar, :help, :description, :custom_menu, :comment, :name, :formula
 
-      # The #{attr} writer
-      # @param [Boolean] value The value to assign to #{attr}
-      # @return [Boolean]
-      def #{attr}=(value)
-        Axlsx::validate_boolean(value)
-        @#{attr} = value
-      end
-      }
-    end
-   
-    attr_reader :name
-    # The name of this defined name. Please refer to the class documentation for more information
-    def name=(value)
-      Axlsx::RestrictionValidator.validate 'DefinedName.name', %w(_xlnm.Print_Area _xlnm.Print_Titles _xlnm.Criteria _xlnm._FilterDatabase _xlnm.Extract _xlnm.Consolidate_Area _xlnm.Database _xlnm.Sheet_Title), value
-      @name = value
-    end
+    boolean_attr_accessor :workbook_parameter, :publish_to_server, :xlm, :vb_proceedure, :function, :hidden
 
-    # The formula this defined name references
-    attr_reader :formula
+    serializable_attributes :short_cut_key, :status_bar, :help, :description, :custom_menu, :comment,
+      :workbook_parameter, :publish_to_server, :xlm, :vb_proceedure, :function, :hidden, :name, :local_sheet_id
 
     def to_xml_string(str='')
       raise ArgumentError, 'you must specify the name for this defined name. Please read the documentation for Axlsx::DefinedName for more details' unless name 
-      str << '<definedName'
-      instance_values.each do |name, value| 
-        unless name == 'formula'
-          str << ' ' << Axlsx::camel(name, false) << "='#{value}'"
-        end
-      end
+      str << '<definedName '
+      serialized_attributes str
       str << '>' << @formula
       str << '</definedName>'
     end

data/lib/axlsx/workbook/workbook.rb

@@ -11,6 +11,7 @@ require 'axlsx/workbook/worksheet/page_set_up_pr.rb'
 require 'axlsx/workbook/worksheet/page_setup.rb'
 require 'axlsx/workbook/worksheet/print_options.rb'
 require 'axlsx/workbook/worksheet/cfvo.rb'
+require 'axlsx/workbook/worksheet/cfvos.rb'
 require 'axlsx/workbook/worksheet/color_scale.rb'
 require 'axlsx/workbook/worksheet/data_bar.rb'
 require 'axlsx/workbook/worksheet/icon_set.rb'
@@ -152,6 +153,14 @@ require 'axlsx/workbook/worksheet/selection.rb'
     @@date1904 = false
 
 
+    # A quick helper to retrive a worksheet by name
+    # @param [String] name The name of the sheet you are looking for
+    # @return [Worksheet] The sheet found, or nil
+    def sheet_by_name(name)
+      index = @worksheets.index { |sheet| sheet.name == name }
+      @worksheets[index] if index
+    end
+
     # lets come back to this later when we are ready for parsing.
     #def self.parse entry
     #  io = entry.get_input_stream
@@ -160,7 +169,7 @@ require 'axlsx/workbook/worksheet/selection.rb'
     #  w.parse_string :date1904, "//xmlns:workbookPr/@date1904"
     #  w
     #end
-
+    
     # Creates a new Workbook
     # The recomended way to work with workbooks is via Package#workbook
     # @option options [Boolean] date1904. If this is not specified, date1904 is set to false. Office 2011 for Mac defaults to false.
@@ -206,6 +215,23 @@ require 'axlsx/workbook/worksheet/selection.rb'
     # see @use_autowidth
     def use_autowidth=(v=true) Axlsx::validate_boolean v; @use_autowidth = v; end
 
+    # inserts a worksheet into this workbook at the position specified.
+    # It the index specified is out of range, the worksheet will be added to the end of the 
+    # worksheets collection
+    # @return [Worksheet]
+    # @param index The zero based position to insert the newly created worksheet
+    # @param [Hash] options Options to pass into the worksheed during initialization.
+    # @option options [String] name The name of the worksheet
+    # @option options [Hash] page_margins The page margins for the worksheet
+    def insert_worksheet(index=0, options={})
+      worksheet = Worksheet.new(self, options)
+      @worksheets.delete_at(@worksheets.size - 1)
+      @worksheets.insert(index, worksheet)
+      yield worksheet if block_given?
+      worksheet
+    end
+
+    #
     # Adds a worksheet to this workbook
     # @return [Worksheet]
     # @option options [String] name The name of the worksheet.

data/lib/axlsx/workbook/worksheet/auto_filter/filter_column.rb

@@ -5,8 +5,8 @@ module Axlsx
   # then there is no corresponding filterColumn collection expressed for that column.
   class FilterColumn
 
-    # Allowed filters
-    FILTERS =  [:filters] #, :top10, :custom_filters, :dynamic_filters, :color_filters, :icon_filters]
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
 
     # Creates a new FilterColumn object
     # @note This class yeilds its filter object as that is where the vast majority of processing will be done
@@ -19,17 +19,20 @@ module Axlsx
       RestrictionValidator.validate 'FilterColumn.filter', FILTERS, filter_type
       #Axlsx::validate_unsigned_int(col_id)
       self.col_id = col_id
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
+      parse_options options
       @filter = Axlsx.const_get(Axlsx.camel(filter_type)).new(options)
       yield @filter if block_given?
     end
 
+    serializable_attributes :col_id, :hidden_button, :show_button
+
+    # Allowed filters
+    FILTERS =  [:filters] #, :top10, :custom_filters, :dynamic_filters, :color_filters, :icon_filters]
+
     # Zero-based index indicating the AutoFilter column to which this filter information applies.
     # @return [Integer]
     attr_reader :col_id
-    
+
     # The actual filter being dealt with here
     # This could be any one of the allowed filter types
     attr_reader :filter
@@ -42,7 +45,7 @@ module Axlsx
       @show_button ||= true
     end
 
-     # Flag indicating whether the AutoFilter button for this column is hidden.
+    # Flag indicating whether the AutoFilter button for this column is hidden.
     # @return [Boolean]
     def hidden_button
       @hidden_button ||= false
@@ -62,7 +65,7 @@ module Axlsx
     # @param [Array] row A row from a worksheet that needs to be
     # filtered.
     def apply(row, offset)
-       row.hidden = @filter.apply(row.cells[offset+col_id.to_i])
+      row.hidden = @filter.apply(row.cells[offset+col_id.to_i])
     end
     # @param [Boolean] hidden Flag indicating whether the AutoFilter button for this column is hidden.
     # @return [Boolean]
@@ -87,16 +90,5 @@ module Axlsx
       @filter.to_xml_string(str)
       str << "</filterColumn>"
     end
-
-    private
-
-    def serialized_attributes(str='')
-      instance_values.each do |key, value|
-        if %(show_button hidden_button col_id).include? key.to_s
-        str << "#{Axlsx.camel(key, false)}='#{value}' "
-        end
-      end
-      str
-    end
   end
 end

data/lib/axlsx/workbook/worksheet/auto_filter/filters.rb

@@ -3,9 +3,8 @@ module Axlsx
   # When multiple values are chosen to filter by, or when a group of date values are chosen to filter by, 
   # this object groups those criteria together.
   class Filters
-
-    # Allowed calendar types
-    CALENDAR_TYPES = %w(gregorian gregorianUs gregorianMeFrench gregorianArabic hijri hebrew taiwan japan thai korea saka gregorianXlitEnglish gregorianXlitFrench none)
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
 
     # Creates a new Filters object
     # @param [Hash] options Options used to set this objects attributes and
@@ -18,11 +17,14 @@ module Axlsx
     # @example
     #   ws.auto_filter.add_column(0, :filters, :blank => true, :calendar_type => 'japan', :filter_items => [100, 'a'])
     def initialize(options={})
-      options.each do |key, value|
-        self.send("#{key}=", value) if self.respond_to? "#{key}="
-      end
+      parse_options options
     end
 
+    serializable_attributes :blank, :calendar_type
+
+    # Allowed calendar types
+    CALENDAR_TYPES = %w(gregorian gregorianUs gregorianMeFrench gregorianArabic hijri hebrew taiwan japan thai korea saka gregorianXlitEnglish gregorianXlitFrench none)
+
     # Flag indicating whether to filter by blank.
     # @return [Boolean]
     attr_reader :blank
@@ -45,7 +47,7 @@ module Axlsx
       end
       true
     end
-      
+
     # The filter values in this filters object
     def filter_items
       @filter_items ||= []
@@ -100,17 +102,6 @@ module Axlsx
       end
     end
 
-    private
-
-    def serialized_attributes(str='')
-      instance_values.each do |key, value|
-        if %(blank claendar_type).include? key.to_s
-        str << "#{Axlsx.camel(key, false)}='#{value}' "
-        end
-      end
-      str
-    end
-
     # This class expresses a filter criteria value.
     class Filter
 
@@ -140,9 +131,8 @@ module Axlsx
     # subsequent dates, even when formatted or represented by other calendar
     # types, can be correctly compared for the purposes of filtering.
     class DateGroupItem
-
-      # Allowed date time groupings
-      DATE_TIME_GROUPING = %w(year month day hour minute second)
+      include Axlsx::OptionsParser
+include Axlsx::SerializedAttributes
 
       # Creates a new DateGroupItem
       # @param [Hash] options A hash of options to use when
@@ -158,11 +148,14 @@ module Axlsx
       def initialize(options={})
         raise ArgumentError,  "You must specify a year for date time grouping" unless options[:year]
         raise ArgumentError, "You must specify a date_time_grouping when creating a DateGroupItem for auto filter" unless options[:date_time_grouping]
-        options.each do |key, value|
-          self.send("#{key}=", value) if self.respond_to?("#{key}=")
-        end
+        parse_options options
       end
 
+      serializable_attributes :date_time_grouping, :year, :month, :day, :hour, :minute, :second
+
+      # Allowed date time groupings
+      DATE_TIME_GROUPING = %w(year month day hour minute second)
+
       # Grouping level
       # This must be one of year, month, day, hour, minute or second.
       # @return [String]
@@ -224,8 +217,8 @@ module Axlsx
       # The minute value for the date group item
       # This must be between 0 and 59
       def minute=(value)
-         RangeValidator.validate "DateGroupItem.minute", 0, 59, value
-         @minute = value
+        RangeValidator.validate "DateGroupItem.minute", 0, 59, value
+        @minute = value
       end
 
       # The second value for the date group item
@@ -245,7 +238,7 @@ module Axlsx
       # @param [String] str The string object this serialization will be concatenated to.
       def to_xml_string(str = '')
         str << '<dateGroupItem '
-        instance_values.each { |key, value| str << "#{key}='#{value.to_s}' " }
+        serialized_attributes str
         str << '/>'
       end
     end

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

@@ -8,6 +8,38 @@ module Axlsx
   # @see Worksheet#add_row
   class Cell
 
+    include Axlsx::OptionsParser
+
+    # @param [Row] row The row this cell belongs to.
+    # @param [Any] value The value associated with this cell.
+    # @option options [Symbol] type The intended data type for this cell. If not specified the data type will be determined internally based on the vlue provided.
+    # @option options [Integer] style The index of the cellXfs item to be applied to this cell. If not specified, the default style (0) will be applied.
+    # @option options [String] font_name
+    # @option options [Integer] charset
+    # @option options [String] family
+    # @option options [Boolean] b
+    # @option options [Boolean] i
+    # @option options [Boolean] strike
+    # @option options [Boolean] outline
+    # @option options [Boolean] shadow
+    # @option options [Boolean] condense
+    # @option options [Boolean] extend
+    # @option options [Boolean] u
+    # @option options [Symbol] vertAlign must be one of :baseline, :subscript, :superscript
+    # @option options [Integer] sz
+    # @option options [String] color an 8 letter rgb specification
+    # @option options [Symbol] scheme must be one of :none, major, :minor
+    def initialize(row, value="", options={})
+      self.row=row
+      @value = @font_name = @charset = @family = @b = @i = @strike = @outline = @shadow = nil
+      @condense = @u = @vertAlign = @sz = @color = @scheme = @extend = @ssti = nil
+      @styles = row.worksheet.workbook.styles
+      @row.cells << self
+      parse_options options
+      @style ||= 0
+      @type ||= cell_type_from_value(value)
+      @value = cast_value(value)
+    end
 
     # An array of available inline styes.
     # TODO change this to a hash where each key defines attr name and validator (and any info the validator requires)
@@ -16,9 +48,9 @@ module Axlsx
     # set_attr method that kicks the suplied validator and updates the instance_variable
     # for the key
     INLINE_STYLES = ['value', 'type', 'font_name', 'charset',
-                         'family', 'b', 'i', 'strike','outline',
-                         'shadow', 'condense', 'extend', 'u',
-                         'vertAlign', 'sz', 'color', 'scheme']
+                     'family', 'b', 'i', 'strike','outline',
+                     'shadow', 'condense', 'extend', 'u',
+                     'vertAlign', 'sz', 'color', 'scheme']
 
     # The index of the cellXfs item to be applied to this cell.
     # @return [Integer]
@@ -174,39 +206,6 @@ module Axlsx
       set_run_style nil, :scheme, v
     end
 
-    # @param [Row] row The row this cell belongs to.
-    # @param [Any] value The value associated with this cell.
-    # @option options [Symbol] type The intended data type for this cell. If not specified the data type will be determined internally based on the vlue provided.
-    # @option options [Integer] style The index of the cellXfs item to be applied to this cell. If not specified, the default style (0) will be applied.
-    # @option options [String] font_name
-    # @option options [Integer] charset
-    # @option options [String] family
-    # @option options [Boolean] b
-    # @option options [Boolean] i
-    # @option options [Boolean] strike
-    # @option options [Boolean] outline
-    # @option options [Boolean] shadow
-    # @option options [Boolean] condense
-    # @option options [Boolean] extend
-    # @option options [Boolean] u
-    # @option options [Symbol] vertAlign must be one of :baseline, :subscript, :superscript
-    # @option options [Integer] sz
-    # @option options [String] color an 8 letter rgb specification
-    # @option options [Symbol] scheme must be one of :none, major, :minor
-    def initialize(row, value="", options={})
-      self.row=row
-      @value = @font_name = @charset = @family = @b = @i = @strike = @outline = @shadow = nil
-      @condense = @u = @vertAlign = @sz = @color = @scheme = @extend = @ssti = nil
-      @styles = row.worksheet.workbook.styles
-      @row.cells << self
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
-      @style ||= 0
-      @type ||= cell_type_from_value(value)
-      @value = cast_value(value)
-    end
-
     # The Shared Strings Table index for this cell
     # @return [Integer]
     attr_reader :ssti
@@ -346,9 +345,9 @@ module Axlsx
     # the cell itself. Yes, it is a bit of a hack, but it is much better than using
     # imagemagick and loading metrics for every character.
     def font_size
-        font = @styles.fonts[@styles.cellXfs[style].fontId] || @styles.fonts[0]
-        size_from_styles = (font.b || b) ? font.sz * 1.5 : font.sz
-        sz || size_from_styles
+      font = @styles.fonts[@styles.cellXfs[style].fontId] || @styles.fonts[0]
+      size_from_styles = (font.b || b) ? font.sz * 1.5 : font.sz
+      sz || size_from_styles
     end
 
     # Utility method for setting inline style attributes