axlsx 1.3.1 → 1.3.2

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

@@ -5,18 +5,7 @@ module Axlsx
   # @see README for examples
   class Table
 
-
-    # The reference to the table data
-    # @return [String]
-    attr_reader :ref
-
-    # The name of the table.
-    # @return [String]
-    attr_reader :name
-
-    # The style for the table.
-    # @return [TableStyle]
-    attr_reader :style
+    include Axlsx::OptionsParser
 
     # Creates a new Table object
     # @param [String] ref The reference to the table data like 'A1:G24'.
@@ -30,12 +19,22 @@ module Axlsx
       @sheet.workbook.tables << self
       @table_style_info = TableStyleInfo.new(options[:style_info]) if options[:style_info]
       @name = "Table#{index+1}"
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
+      parse_options options
       yield self if block_given?
     end
 
+    # The reference to the table data
+    # @return [String]
+    attr_reader :ref
+
+    # The name of the table.
+    # @return [String]
+    attr_reader :name
+
+    # The style for the table.
+    # @return [TableStyle]
+    attr_reader :style
+
     # The index of this chart in the workbooks charts collection
     # @return [Integer]
     def index
@@ -63,7 +62,7 @@ module Axlsx
         @name = v
       end
     end
-    
+
     # TableStyleInfo for the table. 
     # initialization can be fed via the :style_info option
     def table_style_info
@@ -83,8 +82,7 @@ module Axlsx
         str << '<tableColumn id ="' << (index+1).to_s << '" name="' << cell.value << '"/>'
       end
       str << '</tableColumns>'
-      #TODO implement tableStyleInfo
-      table_style_info.to_xml_string(str) # '<tableStyleInfo showFirstColumn="0" showLastColumn="0" showRowStripes="1" showColumnStripes="0" name="TableStyleMedium9" />'
+      table_style_info.to_xml_string(str)
       str << '</table>'
     end
 

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

@@ -3,10 +3,9 @@ module Axlsx
   # The table style info class manages style attributes for defined tables in
   # a worksheet
   class TableStyleInfo
-
-    # boolean attributes for this object
-    BOOLEAN_ATTRIBUTES = %w(show_first_column show_last_column show_row_stripes show_column_stripes)
-
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+    include Axlsx::Accessors
     # creates a new TableStyleInfo instance
     # @param [Hash] options
     # @option [Boolean] show_first_column indicates if the first column should
@@ -22,32 +21,18 @@ module Axlsx
     def initialize(options = {})
       initialize_defaults
       @name = 'TableStyleMedium9'
-      options.each do |k, v|
-        send("#{k}=", v) if respond_to? "#{k}="
-      end
+      parse_options options
     end
 
-    # Dynamically create accessors for boolean attriubtes
-    BOOLEAN_ATTRIBUTES.each do |attr|
-      class_eval %{
-      # The #{attr} attribute reader
-      # @return [Boolean]
-      attr_reader :#{attr} 
-
-      # 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
+    # boolean attributes for this object
+    boolean_attr_accessor :show_first_column, :show_last_column, :show_row_stripes, :show_column_stripes
+    serializable_attributes :show_first_column, :show_last_column, :show_row_stripes, :show_column_stripes,
+      :name
 
     # Initialize all the values to false as Excel requires them to
     # explicitly be disabled or all will show.
     def initialize_defaults
-      BOOLEAN_ATTRIBUTES.each do |attr|
+      %w(show_first_column show_last_column show_row_stripes show_column_stripes).each do |attr|
         self.send("#{attr}=", 0)
       end
     end
@@ -59,9 +44,7 @@ module Axlsx
     # @param [String] str the string to contact this objects serialization to.
     def to_xml_string(str = '')
       str << '<tableStyleInfo '
-      instance_values.each do |key, value|
-        str << Axlsx::camel(key, false) << "='#{value}' "
-      end
+      serialized_attributes str
       str << '/>'
     end
   end

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

@@ -3,6 +3,7 @@ module Axlsx
 
   # The Worksheet class represents a worksheet in the workbook.
   class Worksheet
+    include Axlsx::OptionsParser
 
     # definition of characters which are less than the maximum width of 0-9 in the default font for use in String#count.
     # This is used for autowidth calculations
@@ -24,9 +25,7 @@ module Axlsx
       @sheet_protection = nil
 
       initialize_page_options(options)
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
+      parse_options options
     end
 
     # Initalizes page margin, setup and print options
@@ -238,7 +237,7 @@ module Axlsx
     # Indicates if gridlines should be shown in the sheet.
     # This is true by default.
     # @return [Boolean]
-    # @deprecated Use {SheetView#show_grid_lines=} instead.
+    # @deprecated Use SheetView#show_grid_lines= instead.
     def show_gridlines=(v)
       warn('axlsx::DEPRECIATED: Worksheet#show_gridlines= has been depreciated. This value can be set over SheetView#show_grid_lines=.')
       Axlsx::validate_boolean v
@@ -247,7 +246,7 @@ module Axlsx
 
     # @see selected
     # @return [Boolean]
-    # @deprecated Use {SheetView#tab_selected=} instead.
+    # @deprecated Use SheetView#tab_selected= instead.
     def selected=(v)
       warn('axlsx::DEPRECIATED: Worksheet#selected= has been depreciated. This value can be set over SheetView#tab_selected=.')
       Axlsx::validate_boolean v
@@ -256,7 +255,7 @@ module Axlsx
 
     # Indicates if the worksheet should show gridlines or not
     # @return Boolean
-    # @deprecated Use {SheetView#show_grid_lines} instead.
+    # @deprecated Use SheetView#show_grid_lines instead.
     def show_gridlines
       warn('axlsx::DEPRECIATED: Worksheet#show_gridlines has been depreciated. This value can get over SheetView#show_grid_lines.')
       sheet_view.show_grid_lines
@@ -266,7 +265,7 @@ module Axlsx
     # It is possible to have more than one worksheet selected, however it might cause issues
     # in some older versions of excel when using copy and paste.
     # @return Boolean
-    # @deprecated Use {SheetView#tab_selected} instead.
+    # @deprecated Use SheetView#tab_selected instead.
     def selected
       warn('axlsx::DEPRECIATED: Worksheet#selected has been depreciated. This value can get over SheetView#tab_selected.')
       sheet_view.tab_selected

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

@@ -10,7 +10,7 @@ module Axlsx
     # @param [Worksheet] worksheet
     def initialize(worksheet)
       raise ArgumentError, 'you must provide a worksheet' unless worksheet.is_a?(Worksheet)
-      @worksheet = worksheet      
+      @worksheet = worksheet
       @drawing = nil
     end
 

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

@@ -3,6 +3,9 @@ module Axlsx
   # A worksheet hyperlink object. Note that this is not the same as a drawing hyperlink object.
   class WorksheetHyperlink
 
+    include Axlsx::OptionsParser
+    include Axlsx::Accessors
+    include Axlsx::SerializedAttributes
     # Creates a new hyperlink object.
     # @note the preferred way to add hyperlinks to your worksheet is the Worksheet#add_hyperlink method
     # @param [Worksheet] worksheet the Worksheet that owns this hyperlink
@@ -16,14 +19,13 @@ module Axlsx
       DataTypeValidator.validate "Hyperlink.worksheet", [Worksheet], worksheet
       @worksheet = worksheet
       @target = :external
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
+      parse_options options
       yield self if block_given?
     end
 
-    # String attributes for this object
-    STRING_ATTRIBUTES = %w(display location tooltip)
+    string_attr_accessor :display, :location, :tooltip
+
+    serializable_attributes :display, :tooltip, :ref
 
     #Cell location of hyperlink on worksheet.
     # @return [String]
@@ -39,29 +41,11 @@ module Axlsx
     # @param [String|Cell] cell_reference The string reference or cell that defines where this hyperlink shows in the worksheet.
     def ref=(cell_reference)
       cell_reference = cell_reference.r if cell_reference.is_a?(Cell)
-
       Axlsx::validate_string cell_reference
       @ref = cell_reference
     end
 
-    # 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
-
-    # The relationship required by this hyperlink when the taget is :external
+       # The relationship required by this hyperlink when the taget is :external
     # @return [Relationship]
     def relationship
       return unless @target == :external
@@ -80,7 +64,7 @@ module Axlsx
     # @return [String]
     def to_xml_string(str='')
       str << '<hyperlink '
-      serialization_values.map { |key, value| str << key.to_s << '="' << value.to_s << '" ' }
+      serialized_attributes str, location_or_id
       str << '/>'
     end
 
@@ -88,14 +72,8 @@ module Axlsx
     # location should only be specified for non-external targets.
     # r:id should only be specified for external targets.
     # @return [Hash]
-    def serialization_values
-      h = instance_values.reject { |key, value| !%w(display ref tooltip).include?(key) }
-      if @target == :external
-        h['r:id'] = id
-      else
-        h['location'] = location
-      end
-      h
+    def location_or_id
+      @target == :external ?  { :"r:id" => id } : { :location => location }
     end
   end
 end

data/test/content_type/tc_default.rb

@@ -3,14 +3,6 @@ require 'tc_helper.rb'
 
 class TestDefault < Test::Unit::TestCase
 
-  def test_initialization_requires_Extension_and_ContentType
-    assert_raise(ArgumentError, "raises argument error if Extension and/or ContentType are not specified") { Axlsx::Default.new }
-    assert_raise(ArgumentError, "raises argument error if Extension and/or ContentType are not specified") { Axlsx::Default.new :Extension=>"xml" }
-    assert_raise(ArgumentError, "raises argument error if Extension and/or ContentType are not specified") { Axlsx::Default.new :ContentType=>"asdf" }
-
-    assert_nothing_raised {Axlsx::Default.new :Extension=>"foo", :ContentType=>Axlsx::XML_CT}
-
-  end
   def test_content_type_restriction
     assert_raise(ArgumentError, "raises argument error if invlalid ContentType is") { Axlsx::Default.new :ContentType=>"asdf" }
   end
@@ -20,8 +12,5 @@ class TestDefault < Test::Unit::TestCase
     doc = Nokogiri::XML(type.to_xml_string)
     assert_equal(doc.xpath("Default[@ContentType='#{Axlsx::XML_CT}']").size, 1)
     assert_equal(doc.xpath("Default[@Extension='xml']").size, 1)
-
   end
-
-
 end

data/test/content_type/tc_override.rb

@@ -1,16 +1,6 @@
-# -*- coding: utf-8 -*-
 require 'tc_helper.rb'
-
 class TestOverride < Test::Unit::TestCase
 
-  def test_initialization_requires_Extension_and_ContentType
-    err = "requires PartName and ContentType options"
-    assert_raise(ArgumentError, err) { Axlsx::Override.new }
-    assert_raise(ArgumentError, err) { Axlsx::Override.new :PartName=>"xml" }
-    assert_raise(ArgumentError, err) { Axlsx::Override.new :ContentType=>"asdf" }
-    assert_nothing_raised {Axlsx::Override.new :PartName=>"foo", :ContentType=>Axlsx::CHART_CT}
-  end
-
   def test_content_type_restriction
     assert_raise(ArgumentError, "requires known content type") { Axlsx::Override.new :ContentType=>"asdf" }
   end
@@ -20,8 +10,5 @@ class TestOverride < Test::Unit::TestCase
     doc = Nokogiri::XML(type.to_xml_string)
     assert_equal(doc.xpath("Override[@ContentType='#{Axlsx::CHART_CT}']").size, 1)
     assert_equal(doc.xpath("Override[@PartName='somechart.xml']").size, 1)
-
   end
-
-
 end

data/test/drawing/tc_d_lbls.rb

@@ -4,19 +4,29 @@ class TestDLbls < Test::Unit::TestCase
 
   def setup
     @d_lbls = Axlsx::DLbls.new(Axlsx::Pie3DChart)
+    @boolean_attributes =[:show_legend_key, 
+                          :show_val, 
+                          :show_cat_name, 
+                          :show_ser_name, 
+                          :show_percent, 
+                          :show_bubble_size, 
+                          :show_leader_lines]
   end
 
   def test_initialization
     assert_equal(:bestFit, @d_lbls.d_lbl_pos)
-    Axlsx::DLbls::BOOLEAN_ATTRIBUTES.each do |attr|
+    @boolean_attributes.each do |attr|
       assert_equal(false, @d_lbls.send(attr))
     end
   end
 
   def test_initialization_with_optoins
-    options_hash = Hash[*[Axlsx::DLbls::BOOLEAN_ATTRIBUTES.map { |name| [name, true] }] ]
+    
+    options_hash = Hash[*[@boolean_attributes.map { |name| [name, true] }] ]
+
     d_lbls = Axlsx::DLbls.new(Axlsx::Pie3DChart, options_hash.merge( { :d_lbl_pos => :t }))
-    Axlsx::DLbls::BOOLEAN_ATTRIBUTES.each do |attr|
+   
+    @boolean_attributes.each do |attr|
       assert_equal(true, d_lbls.send(attr), "boolean attributes set by options")
     end
     assert_equal(:t, d_lbls.d_lbl_pos, "d_lbl_pos set by options")
@@ -27,7 +37,7 @@ class TestDLbls < Test::Unit::TestCase
   end
 
   def test_boolean_attributes
-    Axlsx::DLbls::BOOLEAN_ATTRIBUTES.each do |attr|
+    @boolean_attributes.each do |attr|
       assert_raise(ArgumentError, "rejects non boolean value for #{attr}") { @d_lbls.send("#{attr}=", :foo) }
       assert_nothing_raised("accepts boolean value for #{attr}") { @d_lbls.send("#{attr}=", true) }
       assert_nothing_raised("accepts boolean value for #{attr}") { @d_lbls.send("#{attr}=", false) }

data/test/tc_axlsx.rb

@@ -14,8 +14,26 @@ class TestAxlsx < Test::Unit::TestCase
     }
   end
 
-  def test_cell_range
-    #To do
+  def test_cell_range_empty_if_no_cell
+    assert_equal(Axlsx.cell_range([]), "")
+  end
+
+  def test_cell_range_relative
+    p = Axlsx::Package.new
+    ws = p.workbook.add_worksheet
+    row = ws.add_row
+    c1 = row.add_cell
+    c2 = row.add_cell
+    assert_equal(Axlsx.cell_range([c2, c1], false), "A1:B1")
+  end
+
+  def test_cell_range_absolute
+    p = Axlsx::Package.new
+    ws = p.workbook.add_worksheet :name => "Sheet <'>\" 1"
+    row = ws.add_row
+    c1 = row.add_cell
+    c2 = row.add_cell
+    assert_equal(Axlsx.cell_range([c2, c1], true), "'Sheet &lt;''&gt;&quot; 1'!$A$1:$B$1")
   end
 
   def test_name_to_indices

data/test/workbook/tc_defined_name.rb

@@ -10,14 +10,14 @@ class TestDefinedNames < Test::Unit::TestCase
   end
   
   def test_string_attributes
-    Axlsx::DefinedName::STRING_ATTRIBUTES.each do |attr|
+    %w(short_cut_key status_bar help description custom_menu comment).each do |attr|
       assert_raise(ArgumentError, 'only strings allowed in string attributes') { @dn.send("#{attr}=", 1) }
       assert_nothing_raised { @dn.send("#{attr}=", '_xlnm.Sheet_Title') }
     end
   end
 
   def test_boolean_attributes
-   Axlsx::DefinedName::BOOLEAN_ATTRIBUTES.each do |attr|
+   %w(workbook_parameter publish_to_server xlm vb_proceedure function hidden).each do |attr|
       assert_raise(ArgumentError, 'only booleanish allowed in string attributes') { @dn.send("#{attr}=", 'foo') }
       assert_nothing_raised { @dn.send("#{attr}=", 1) }
     end

data/test/workbook/tc_workbook.rb

@@ -16,6 +16,13 @@ class TestWorkbook < Test::Unit::TestCase
     assert_equal(@wb.use_autowidth, false)
   end
 
+
+  def test_sheet_by_name_retrieval
+    @wb.add_worksheet(:name=>'foo')
+    @wb.add_worksheet(:name=>'bar')
+    assert_equal('foo', @wb.sheet_by_name('foo').name)
+    
+  end
   def test_date1904
     assert_equal(Axlsx::Workbook.date1904, @wb.date1904)
     @wb.date1904 = :false
@@ -42,6 +49,14 @@ class TestWorkbook < Test::Unit::TestCase
     assert_equal(@wb.worksheets.first, ws, "the worksheet returned is the worksheet added")
     assert_equal(ws.name, "bob", "name option gets passed to worksheet")
   end
+  
+  def test_insert_worksheet
+    @wb.add_worksheet(:name => 'A')
+    @wb.add_worksheet(:name => 'B')
+    ws3 = @wb.insert_worksheet(0, :name => 'C')
+    assert_equal(ws3.name, @wb.worksheets.first.name)
+  end
+
   def test_relationships
     #current relationship size is 1 due to style relation
     assert(@wb.relationships.size == 1)

data/test/workbook/worksheet/tc_col.rb

@@ -7,7 +7,7 @@ class TestCol < Test::Unit::TestCase
   end
 
   def test_initialize
-    options = { :width => 12, :collapsed => true, :hidden => true, :outlineLevel => 1, :phonetic => true, :style => 1} 
+    options = { :width => 12, :collapsed => true, :hidden => true, :outline_level => 1, :phonetic => true, :style => 1} 
 
     col = Axlsx::Col.new 0, 0, options
     options.each{ |key, value| assert_equal(col.send(key.to_sym), value) }
@@ -58,6 +58,16 @@ class TestCol < Test::Unit::TestCase
     assert_nothing_raised(ArgumentError, 'phonetic must be boolean(ish)') { @col.phonetic = true }
   end
 
+  def test_to_xml_string
+    @col.width = 100
+    doc = Nokogiri::XML(@col.to_xml_string)
+    assert_equal(1, doc.xpath("//col [@bestFit='#{@col.best_fit}']").size)
+    assert_equal(1, doc.xpath("//col [@max=#{@col.max}]").size)
+    assert_equal(1, doc.xpath("//col [@min=#{@col.min}]").size)
+    assert_equal(1, doc.xpath("//col [@width=#{@col.width}]").size)
+    assert_equal(1, doc.xpath("//col [@customWidth='#{@col.custom_width}']").size)
+  end
+
   def test_style
     assert_equal(@col.style, nil)
     @col.style = 1