axlsx 1.0.16 → 1.0.17

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

@@ -1,4 +1,4 @@
-# -*- coding: utf-8 -*-
+# encoding: UTF-8
 module Axlsx
   # A cell in a worksheet. 
   # Cell stores inforamation requried to serialize a single worksheet cell to xml. You must provde the Row that the cell belongs to and the cells value. The data type will automatically be determed if you do not specify the :type option. The default style will be applied if you do not supply the :style option. Changing the cell's type will recast the value to the type specified. Altering the cell's value via the property accessor will also automatically cast the provided value to the cell's type.
@@ -23,6 +23,14 @@ module Axlsx
   # @see Worksheet#add_row
   class Cell
 
+
+    # An array of available inline styes.
+    INLINE_STYLES = ['value', 'type', 'font_name', 'charset', 
+                         '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] 
     # @see Axlsx::Styles
@@ -186,6 +194,24 @@ module Axlsx
       @value = cast_value(value)
     end
 
+    # The Shared Strings Table index for this cell
+    # @return [Integer]
+    attr_reader :ssti
+    
+    # equality comparison to test value, type and inline style attributes
+    # this is how we work out if the cell needs to be added or already exists in the shared strings table
+    def shareable(v)
+
+      #using reject becase 1.8.7 select returns an array...
+      v_hash = v.instance_values.reject { |k, v| !INLINE_STYLES.include?(k) }
+      self_hash = self.instance_values.reject { |k, v| !INLINE_STYLES.include?(k) }
+      # required as color is an object, and the comparison will fail even though both use the same color.
+      v_hash['color'] = v_hash['color'].instance_values if v_hash['color']
+      self_hash['color'] = self_hash['color'].instance_values if self_hash['color']
+
+      v_hash == self_hash
+    end
+
     # @return [Integer] The index of the cell in the containing row.
     def index
       @row.cells.index(self)
@@ -231,14 +257,42 @@ module Axlsx
       self.row.worksheet.merge_cells "#{self.r}:#{range_end}" unless range_end.nil?
     end              
 
+    # builds an xml text run based on this cells attributes. This is extracted from to_xml so that shared strings can use it.
+    # @param [Nokogiri::XML::Builder] xml The document builder instance this output will be added to.
+    # @return [String] the xml for this cell's text run
+    def run_xml(xml)
+      if (self.instance_values.keys & INLINE_STYLES).size > 0
+        xml.r {
+          xml.rPr {
+            xml.rFont(:val=>@font_name) if @font_name
+            xml.charset(:val=>@charset) if @charset
+            xml.family(:val=>@family) if @family
+            xml.b(:val=>@b) if @b
+            xml.i(:val=>@i) if @i
+            xml.strike(:val=>@strike) if @strike
+            xml.outline(:val=>@outline) if @outline
+            xml.shadow(:val=>@shadow) if @shadow
+            xml.condense(:val=>@condense) if @condense
+            xml.extend(:val=>@extend) if @extend
+            @color.to_xml(xml) if @color
+            xml.sz(:val=>@sz) if @sz
+            xml.u(:val=>@u) if @u
+            # :baseline, :subscript, :superscript
+            xml.vertAlign(:val=>@vertAlign) if @verAlign
+            # :none, major, :minor
+            xml.scheme(:val=>@scheme) if @scheme
+          }
+          xml.t @value.to_s
+        }
+      else
+        xml.t @value.to_s
+      end        
+    end
+
     # Serializes the cell
     # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
     # @return [String] xml text for the cell
-    # @note
-    #   Shared Strings are not used in this library. All values are set directly in the each sheet.
-    def to_xml(xml)
-      
-      # however nokogiri does a nice 'force_encoding' which we shall remove!
+    def to_xml(xml)      
       if @type == :string 
         #parse formula
         if @value.start_with?('=')
@@ -246,41 +300,20 @@ module Axlsx
             xml.f @value.to_s.gsub('=', '')
           }
         else
-          #parse standard string
-          #xml.c(:r => r, :t=>:inlineStr, :s=>style) {
-          #  xml.is { xml.t @value.to_s } 
-          #}
-          #parse styled string
-          xml.c(:r => r, :s=>style, :t => :inlineStr) {
-            xml.is {
-              xml.r {
-                xml.rPr {
-                  xml.rFont(:val=>@font_name) if @font_name
-                  xml.charset(:val=>@charset) if @charset
-                  xml.family(:val=>@family) if @family
-                  xml.b(:val=>@b) if @b
-                  xml.i(:val=>@i) if @i
-                  xml.strike(:val=>@strike) if @strike
-                  xml.outline(:val=>@outline) if @outline
-                  xml.shadow(:val=>@shadow) if @shadow
-                  xml.condense(:val=>@condense) if @condense
-                  xml.extend(:val=>@extend) if @extend
-                  @color.to_xml(xml) if @color
-                  xml.sz(:val=>@sz) if @sz
-                  xml.u(:val=>@u) if @u
-                  # :baseline, :subscript, :superscript
-                  xml.vertAlign(:val=>@vertAlign) if @verAlign
-                  # :none, major, :minor
-                  xml.scheme(:val=>@scheme) if @scheme
-                }
-                xml.t @value.to_s
+          #parse shared
+          if @ssti
+            xml.c(:r => r, :s=>style, :t => :s) { xml.v ssti }
+          else
+            #parse inline string
+            xml.c(:r => r, :s=>style, :t => :inlineStr) {
+              xml.is {
+                run_xml(xml)
               }
             }
-          }
+          end
         end
       elsif @type == :time
         # Using hardcoded offsets here as some operating systems will not except a 'negative' offset from the ruby epoc.
-        # (1970)
         epoc1900 = -2209021200 #Time.local(1900, 1, 1) 
         epoc1904 = -2082877200 #Time.local(1904, 1, 1) 
         epoc = Workbook.date1904 ? epoc1904 : epoc1900
@@ -291,9 +324,14 @@ module Axlsx
       end
     end
 
-
     private 
 
+    # @see ssti
+    def ssti=(v) 
+      Axlsx::validate_unsigned_int(v)
+      @ssti = v
+    end
+
     # assigns the owning row for this cell.
     def row=(v) DataTypeValidator.validate "Cell.row", Row, v; @row=v end
     

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

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module Axlsx
   # A Row is a single row in a worksheet.
   # @note The recommended way to manage rows and cells is to use Worksheet#add_row
@@ -12,6 +13,20 @@ module Axlsx
     # @return [SimpleTypedList]
     attr_reader :cells
 
+    # TODO  18.3.1.73
+    # collapsed
+    # customFormat
+    # customHeight
+    # hidden
+    # ht (height)
+    # outlineLevel
+    # ph
+    # s (style)
+    # spans
+    # thickTop
+    # thickBottom
+
+
     # Creates a new row. New Cell objects are created based on the values, types and style options.
     # A new cell is created for each item in the values array. style and types options are applied as follows:
     #   If the types option is defined and is a symbol it is applied to all the cells created.

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

@@ -1,4 +1,4 @@
-# -*- coding: utf-8 -*-
+# encoding: UTF-8
 module Axlsx
   
   # The Worksheet class represents a worksheet in the workbook. 
@@ -51,6 +51,12 @@ module Axlsx
       @merged_cells = []
     end
 
+    # convinience method to access all cells in this worksheet
+    # @return [Array] cells
+    def cells
+      rows.flatten
+    end
+
     # Creates merge information for this worksheet. 
     # Cells can be merged by calling the merge_cells method on a worksheet.
     # @example This would merge the three cells C1..E1    #  
@@ -70,6 +76,14 @@ module Axlsx
     end
 
 
+    # The demensions of a worksheet. This is not actually a required element by the spec, 
+    # but at least a few other document readers expect this for conversion
+    # @return [String] the A1:B2 style reference for the first and last row column intersection in the workbook
+    def dimension
+      "#{rows.first.cells.first.r}:#{rows.last.cells.last.r}"
+    end
+
+
     # Returns the cell or cells defined using excel style A1:B3 references.
     # @param [String] cell_def the string defining the cell or range of cells
     # @return [Cell, Array]
@@ -203,7 +217,22 @@ module Axlsx
         end
       end
     end
-    
+
+    # This is a helper method that Lets you specify a fixed width for multiple columns in a worksheet in one go.    
+    # Axlsx is sparse, so if you have not set data for a column, you cannot set the width.
+    # Setting a fixed column width to nil will revert the behaviour back to calculating the width for you.
+    # @example This would set the first and third column widhts but leave the second column in autofit state.
+    #      ws.column_widths 7.2, nil, 3
+    # @note For updating only a single column it is probably easier to just set ws.auto_fit_data[col_index][:fixed] directly
+    # @param [Integer|Float|Fixnum|nil] values 
+    def column_widths(*args)
+      args.each_with_index do |value, index|
+        raise ArgumentError, "Invalid column specification" unless index < @auto_fit_data.size
+        Axlsx::validate_unsigned_numeric(value) unless value == nil
+        @auto_fit_data[index][:fixed] = value
+      end
+    end
+
     # Adds a chart to this worksheets drawing. This is the recommended way to create charts for your worksheet. This method wraps the complexity of dealing with ooxml drawing, anchors, markers graphic frames chart objects and all the other dirty details. 
     # @param [Class] chart_type
     # @option options [Array] start_at
@@ -238,6 +267,7 @@ module Axlsx
       builder = Nokogiri::XML::Builder.new(:encoding => ENCODING) do |xml|
         xml.worksheet(:xmlns => XML_NS, 
                       :'xmlns:r' => XML_NS_R) {
+          xml.dimension :ref=>dimension unless rows.size == 0
           if @auto_fit_data.size > 0
             xml.cols {
               @auto_fit_data.each_with_index do |col, index|
@@ -288,7 +318,7 @@ module Axlsx
         # ignore formula - there is no way for us to know the result
         next if item.value.is_a?(String) && item.value.start_with?('=')
 
-        col = @auto_fit_data[index] || {:longest=>"", :sz=>sz} 
+        col = @auto_fit_data[index] || {:longest=>"", :sz=>sz, :fixed=>nil} 
         cell_xf = cellXfs[item.style]
         font = fonts[cell_xf.fontId || 0]
         sz = item.sz || font.sz || fonts[0].sz
@@ -307,6 +337,8 @@ module Axlsx
     # @return [Float]
     # @param [Hash] A hash of auto_fit_data 
     def auto_width(col)
+      return col[:fixed] unless col[:fixed] == nil
+
       mdw_count, font_scale, mdw = 0, col[:sz]/11.0, 6.0
       mdw_count = col[:longest].scan(/./mu).reduce(0) do | count, char |
         count +=1 if @magick_draw.get_type_metrics(char).max_advance >= mdw

data/test/content_type/tc_content_type.rb

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 require 'test/unit'
 require 'axlsx.rb'
 

data/test/content_type/tc_default.rb

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 require 'test/unit'
 require 'axlsx.rb'
 

data/test/content_type/tc_override.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 require 'test/unit'
 require 'axlsx.rb'
 

data/test/tc_package.rb

@@ -21,6 +21,13 @@ class TestPackage < Test::Unit::TestCase
     assert_raise(NoMethodError) {@package.app = nil }
   end
 
+  def test_use_shared_strings
+    assert_equal(@package.use_shared_strings, nil)
+    assert_raise(ArgumentError) {@package.use_shared_strings 9}
+    assert_nothing_raised {@package.use_shared_strings = true}
+    assert_equal(@package.use_shared_strings, @package.workbook.use_shared_strings)
+  end
+
   def test_default_objects_are_created
     assert(@package.instance_values["app"].is_a?(Axlsx::App), 'App object not created')
     assert(@package.instance_values["core"].is_a?(Axlsx::Core), 'Core object not created')
@@ -69,10 +76,34 @@ class TestPackage < Test::Unit::TestCase
 
     #no mystery parts
     assert_equal(p.size, 12)
+    
+  end
 
+  def test_shared_strings_requires_part
+    @package.use_shared_strings = true
+    p = @package.send(:parts)
+    assert_equal(p.select{ |part| part[:entry] =~/xl\/sharedStrings.xml/}.size, 1, "shared strings table missing")
   end
   
   def test_workbook_is_a_workbook
     assert @package.workbook.is_a? Axlsx::Workbook
   end
+
+  def test_base_content_types
+    ct = @package.send(:base_content_types)
+    assert(ct.select { |c| c.ContentType == Axlsx::RELS_CT }.size == 1, "rels content type missing")
+    assert(ct.select { |c| c.ContentType == Axlsx::XML_CT }.size == 1, "xml content type missing")
+    assert(ct.select { |c| c.ContentType == Axlsx::APP_CT }.size == 1, "app content type missing")
+    assert(ct.select { |c| c.ContentType == Axlsx::CORE_CT }.size == 1, "core content type missing")
+    assert(ct.select { |c| c.ContentType == Axlsx::STYLES_CT }.size == 1, "styles content type missing")
+    assert(ct.select { |c| c.ContentType == Axlsx::WORKBOOK_CT }.size == 1, "workbook content type missing")
+    assert(ct.size == 6)
+  end
+
+  def test_content_type_added_with_shared_strings
+    @package.use_shared_strings = true
+    ct = @package.send(:content_types)
+    assert(ct.select { |ct| ct.ContentType == Axlsx::SHARED_STRINGS_CT }.size == 1)
+  end
+
 end

data/test/workbook/tc_shared_strings_table.rb

@@ -0,0 +1,39 @@
+require 'test/unit'
+require 'axlsx.rb'
+
+class TestSharedStringsTable < Test::Unit::TestCase
+
+  def setup    
+    @p = Axlsx::Package.new :use_shared_strings=>true
+    ws = @p.workbook.add_worksheet
+    ws.add_row ['a', 1, 'b']
+    ws.add_row ['b', 1, 'c']
+    ws.add_row ['c', 1, 'd']    
+  end
+
+  def test_workbook_has_shared_strings
+    assert(@p.workbook.shared_strings.is_a?(Axlsx::SharedStringsTable), "shared string table was not created")
+  end
+
+  def test_count
+    sst = @p.workbook.shared_strings
+    assert_equal(sst.count, 6)
+  end
+
+  def test_unique_count
+    sst = @p.workbook.shared_strings
+    assert_equal(sst.unique_count, 4)
+  end
+
+  def test_valid_document    
+    schema = Nokogiri::XML::Schema(File.open(Axlsx::SML_XSD))
+    doc = Nokogiri::XML(@p.workbook.shared_strings.to_xml)
+    errors = []
+    schema.validate(doc).each do |error|
+      puts error.message
+      errors << error
+    end
+    assert_equal(errors.size, 0, "sharedStirngs.xml Invalid" + errors.map{ |e| e.message }.to_s)
+  end
+
+end

data/test/workbook/tc_shared_strings_table.rb~

@@ -0,0 +1,8 @@
+require 'test/unit'
+require 'axlsx.rb'
+
+class TestSharedStringsTable < Test::Unit::TestCase
+  def setup    
+    p = Axlsx::Package.new
+    @wb = p.workbook    
+  end

data/test/workbook/tc_workbook.rb

@@ -18,6 +18,12 @@ class TestWorkbook < Test::Unit::TestCase
     assert_equal(Axlsx::Workbook.date1904, @wb.date1904)
   end
 
+  def test_shared_strings
+    assert_equal(@wb.use_shared_strings, nil)
+    assert_raise(ArgumentError) {@wb.use_shared_strings = 'bpb'}
+    assert_nothing_raised {@wb.use_shared_strings = :true}
+  end
+
   def test_add_worksheet
     assert(@wb.worksheets.empty?, "worbook has no worksheets by default")
     ws = @wb.add_worksheet(:name=>"bob")
@@ -30,6 +36,8 @@ class TestWorkbook < Test::Unit::TestCase
     assert(@wb.relationships.size == 1)
     @wb.add_worksheet
     assert(@wb.relationships.size == 2)
+    @wb.use_shared_strings = true
+    assert(@wb.relationships.size == 3)
   end
 
   def test_to_xml

data/test/workbook/worksheet/tc_cell.rb

@@ -18,6 +18,7 @@ class TestCell < Test::Unit::TestCase
     assert_equal(@c.value, 1.0, "type option is applied and value is casted")
   end
 
+
   def test_style_date_data
     c = Axlsx::Cell.new(@c.row, Time.now)
     assert_equal(Axlsx::STYLE_DATE, c.style)
@@ -191,4 +192,16 @@ class TestCell < Test::Unit::TestCase
     assert_equal(@c.row.worksheet.merged_cells.last, "A1:C1")    
   end
 
+  def test_equality
+      c2 = @row.add_cell 1, :type=>:float, :style=>1
+      assert(c2.shareable(@c))
+      c3 = @row.add_cell 2, :type=>:float, :style=>1
+      c4 = @row.add_cell 1, :type=>:float, :style=>1, :color => "#FFFFFFFF"
+      assert_equal(c4.shareable(c2) ,false)
+      c5 = @row.add_cell 1, :type=>:float, :style=>1, :color => "#FFFFFFFF"
+      assert(c5.shareable(c4))
+
+  end
+
+
 end

data/test/workbook/worksheet/tc_worksheet.rb

@@ -28,7 +28,13 @@ class TestWorksheet < Test::Unit::TestCase
   def test_index
     assert_equal(@ws.index, @ws.workbook.worksheets.index(@ws))
   end
-  
+
+  def test_dimension
+    @ws.add_row [1, 2, 3]
+    @ws.add_row [4, 5, 6]
+    assert_equal @ws.dimension, "A1:C2"
+  end
+
   def test_referencing
     @ws.add_row [1, 2, 3]
     @ws.add_row [4, 5, 6]
@@ -130,20 +136,31 @@ class TestWorksheet < Test::Unit::TestCase
     @ws.add_row ["chasing windmills", "penut"], :style=>small
     assert(@ws.auto_fit_data.size == 2, "a data item for each column")
 
-    assert_equal(@ws.auto_fit_data[0], {:sz=>2,:longest=>"chasing windmills"}, "adding a row updates auto_fit_data if the product of the string length and font is greater for the column")
+    assert_equal(@ws.auto_fit_data[0], {:sz => 2, :longest => "chasing windmills", :fixed=>nil}, "adding a row updates auto_fit_data if the product of the string length and font is greater for the column")
 
 
     @ws.add_row ["mule"], :style=>big
-    assert_equal(@ws.auto_fit_data[0], {:sz=>10,:longest=>"mule"}, "adding a row updates auto_fit_data if the product of the string length and font is greater for the column")
+    assert_equal(@ws.auto_fit_data[0], {:sz=>10,:longest=>"mule", :fixed=>nil}, "adding a row updates auto_fit_data if the product of the string length and font is greater for the column")
   end
 
   def test_auto_width
     assert(@ws.send(:auto_width, {:sz=>11, :longest=>"fisheries"}) > @ws.send(:auto_width, {:sz=>11, :longest=>"fish"}), "longer strings get a longer auto_width at the same font size")
 
     assert(@ws.send(:auto_width, {:sz=>11, :longest=>"fish"}) < @ws.send(:auto_width, {:sz=>12, :longest=>"fish"}), "larger fonts produce longer with with same string")
+    assert_equal(@ws.send(:auto_width, {:sz=>11, :longest => "This is a really long string", :fixed=>0.2}), 0.2, "fixed rules!")
+  end
 
+  def test_set_column_width
+    @ws.add_row ["chasing windmills", "penut"]
+    assert_equal(@ws.auto_fit_data[0][:fixed], nil, 'no fixed by default')
+    @ws.column_widths nil, 0.5
+    assert_equal(@ws.auto_fit_data[1][:fixed], 0.5, 'eat my width')
+    assert_raise(ArgumentError, 'reject invalid columns') { @ws.column_widths 2, 7, nil }
+    assert_raise(ArgumentError, 'only accept unsigned ints') { @ws.column_widths 2, 7, -1 }
+    assert_raise(ArgumentError, 'only accept Integer, Float or Fixnum') { @ws.column_widths 2, 7, "-1" }
   end
 
+
   def test_merge_cells
     assert(@ws.merged_cells.is_a?(Array))
     assert_equal(@ws.merged_cells.size, 0)