workbook 0.4 → 0.4.1

data/README.md

@@ -29,19 +29,19 @@ or
 Calling
 
     s = b.sheet
-	t = s.table
+    t = s.table
 	
 will give you an the first Sheet and Table (if one doesn't exist it is created on the fly).
 
 You can initialize with simple 2-d array like this:
 
     b = Workbook::Book.new [['a','b'],[1,2],[3,4],[5,6]]
-	t = s.sheet.table
+    t = s.sheet.table
 	
 Subsequently you look up values in the table like this:
 
     t[1][:b] 
-	# returns <Workbook::Cel @value=2>
+    # returns <Workbook::Cel @value=2>
 
 which is equivalent to
 
@@ -51,6 +51,10 @@ Of course you'll be able to write a new value back to it. If you just enter a va
 
     t[1][:b] = 5
     
+Alternatively (more spreadsheet like) you can read cells like this (writing to be supported, not implemented yet)
+    
+    t['A2']
+    
 If you want to use an existing file as a template (which you can create in Excel to create nice looking templates), 
 simply clone the row, and add it back:
 
@@ -70,10 +74,9 @@ simply clone the row, and add it back:
                                # in the endresult
     b.write("result.xls")   # write it!
     
-<!-- Feature *to implement*: 
 
-	t['A2']
-	# returns <Workbook::Cel @value=1>
+
+  <!-- Feature *to implement*: 
 	
 Feature *to implement*, get a single column:
 

data/lib/workbook.rb

@@ -3,6 +3,7 @@ $KCODE="u" if RUBY_VERSION < "1.9"
 require 'workbook/book'
 require 'workbook/sheet'
 require 'workbook/table'
+require 'workbook/nil_value'
 require 'workbook/row'
 require 'workbook/cell'
 require 'workbook/format'

data/lib/workbook/cell.rb

@@ -9,9 +9,11 @@ module Workbook
     attr_accessor :value
     attr_accessor :format
     attr_accessor :formula
+    attr_accessor :colspan
+    attr_accessor :rowspan
     
     # Note that these types are sorted by 'importance'
-    VALID_TYPES = [Numeric,String,Time,Date,TrueClass,FalseClass,NilClass]
+    VALID_TYPES = [Numeric,String,Time,Date,TrueClass,FalseClass,NilClass,Workbook::NilValue]
     
     # Evaluates a value for class-validity
     #
@@ -170,5 +172,11 @@ module Workbook
       end
     end
     
+    def colspan
+      @colspan.to_i if @colspan.to_i > 1
+    end
+    def rowspan
+      @rowspan.to_i if @rowspan.to_i > 1
+    end
   end
 end

data/lib/workbook/format.rb

@@ -7,7 +7,6 @@ module Workbook
     include Workbook::Modules::RawObjectsStorage
     alias_method :merge_hash, :merge
     alias_method :merge_hash!, :merge!
-    
     attr_accessor :name, :parent
     
     # Initialize

data/lib/workbook/nil_value.rb

@@ -0,0 +1,33 @@
+module Workbook
+  
+  # Used in cases col or rowspans are used
+  class NilValue
+    attr_accessor :reason #:covered
+    
+    # initialize this special nilvalue with a reason
+    # @params [String] reason (currently only :covered, in case this cell is coverd because an adjecant cell spans over it)
+    def initialize reason
+      self.reason= reason
+    end
+    
+    # returns the value of itself (nil)
+    # @return [NilClass] nil
+    def value
+      nil
+    end
+    
+    def <=> v
+      value <=> v
+    end
+    
+    # set the reason why this value is nil
+    def reason= reason
+      if reason == :covered
+        @reason = reason
+      else
+        raise "invalid reason given"
+      end
+    end
+    
+  end
+end

data/lib/workbook/readers/ods_reader.rb

@@ -3,7 +3,6 @@
 module Workbook
   module Readers
     module OdsReader
-      
       # reads self with and ods-type content.xml
       # @param [String,File] file_obj a file or file reference
       # @return [Workbook::Book] self
@@ -53,6 +52,8 @@ module Workbook
       # @param [Nokogiri::XML::Document] ods_spreadsheet nokogirified content.xml
       # @return [Workbook::Book] self
       def parse_ods ods_spreadsheet=template.raws[Nokogiri::XML::Document], options={}
+        require 'cgi'
+        
         options = {:additional_type_parsing=>false}.merge options
         # styles
         #puts ods_spreadsheet
@@ -63,26 +64,41 @@ module Workbook
           s = self.create_or_open_sheet_at(sheetindex)
           sheet.xpath("table:table").each_with_index do |table,tableindex|
             t = s.create_or_open_table_at(tableindex)
+            t.name = table.xpath("@table:name").to_s
+            columns = table.xpath("table:table-column").count
             table.xpath("table:table-row").each_with_index do |row,rowindex|
-              row = row.xpath("table:table-cell").collect do |cell|
+              cells = row.xpath("table:table-cell|table:covered-table-cell")
+              r = Workbook::Row.new
+              columns.times do |column_index|
+                cell = cells[column_index]
                 c = Workbook::Cell.new()
-                cell_style_name = cell.xpath('@table:style-name').to_s
-                c.format = self.template.formats[cell_style_name]
-                valuetype = cell.xpath('@office:value-type').to_s
-                value = cell.xpath("text:p//text()").to_s
-                value = value == "" ? nil : value
-                case valuetype
-                when 'float'
-                  value = cell.xpath("@office:value").to_s.to_f
-                when 'integer'
-                  value = cell.xpath("@office:value").to_s.to_i
-                when 'date'
-                  value = DateTime.parse(cell.xpath("@office:date-value").to_s)
-                end           
+                value = nil
+                if cell
+                  if cell.name == "covered-table-cell"
+                    value = Workbook::NilValue.new(:covered)
+                  else
+                    cell_style_name = cell.xpath('@table:style-name').to_s
+                    c.format = self.template.formats[cell_style_name]
+                    valuetype = cell.xpath('@office:value-type').to_s
+                    c.colspan= cell.xpath('@table:number-columns-spanned').to_s
+                    c.rowspan= cell.xpath('@table:number-rows-spanned').to_s
+
+                    value = CGI.unescapeHTML(cell.xpath("text:p//text()").to_s)
+                    value = (value == "") ? nil : value
+                    case valuetype
+                    when 'float'
+                      value = cell.xpath("@office:value").to_s.to_f
+                    when 'integer'
+                      value = cell.xpath("@office:value").to_s.to_i
+                    when 'date'
+                      value = DateTime.parse(cell.xpath("@office:date-value").to_s)
+                    end    
+                  end
+                end
                 c.value = value
-                c
+                r << c
               end
-              t << Workbook::Row.new(row)
+              t << r
             end
           end
         end

data/lib/workbook/table.rb

@@ -9,6 +9,7 @@ module Workbook
     include Workbook::Modules::TableDiffSort
     include Workbook::Writers::CsvTableWriter
     attr_accessor :sheet
+    attr_accessor :name
     attr_accessor :header
     
     def initialize row_cel_values=[], sheet=nil, options={}
@@ -113,5 +114,38 @@ module Workbook
       return c
     end
     
+    # Overrides normal Array's []-function with support for symbols that identify a column based on the header-values
+    #
+    # @example Lookup using fixnum or header value encoded as symbol
+    #   table[0] #=> <Row [a,2,3,4]> (first row)
+    #   table["A1"] #=> <Cell value="a"> (first cell of first row)
+    #
+    # @param [Fixnum, String] index_or_string to reference to either the row, or the cell
+    # @return [Workbook::Row, Workbook::Cell, nil]
+    def [](index_or_string)
+      if index_or_string.is_a? String
+        match = index_or_string.upcase.match(/([A-Z]*)([0-9]*)/)
+        cell_index = alpha_index_to_number_index(match[1])
+        row_index = match[2].to_i - 1
+        return self[row_index][cell_index]
+      else 
+        if index_or_string
+          return to_a[index_or_string]
+        end
+      end
+    end
+    
+    # Helps to convert from e.g. "AA" to 26
+    # @param [String] string that typically identifies a column
+    # @return [Integer]
+    def alpha_index_to_number_index string
+      string.upcase!
+      sum = 0
+      string.chars.each_with_index do | char, char_index| 
+        sum = sum * 26 + char.ord-64
+      end
+      return sum-1
+    end
+    
   end
 end

data/lib/workbook/version.rb

@@ -1,4 +1,4 @@
 # -*- encoding : utf-8 -*-
 module Workbook
-  VERSION = '0.4'
+  VERSION = '0.4.1'
 end

data/lib/workbook/writers/html_writer.rb

@@ -19,6 +19,9 @@ module Workbook
                   doc.text sheet.name
                 }
                 sheet.each{|table|
+                  doc.h2 {
+                    doc.text table.name
+                  }
                   doc.table {
                     table.each{|row|
                       doc.tr {
@@ -26,9 +29,13 @@ module Workbook
                           classnames = cell.format.all_names.join(" ").strip
                           td_options = classnames != "" ? {:class=>classnames} : {}
                           td_options = td_options.merge({:style=>cell.format.to_css}) if options[:style_with_inline_css] and cell.format.to_css != ""
-                          doc.td(td_options) {
-                            doc.text cell.value
-                          }
+                          td_options = td_options.merge({:colspan=>cell.colspan}) if cell.colspan
+                          td_options = td_options.merge({:rowspan=>cell.rowspan}) if cell.rowspan
+                          unless cell.value.class == Workbook::NilValue
+                            doc.td(td_options) {
+                              doc.text cell.value
+                            }
+                          end
                         }
                       }
                     }

data/test/test_cell.rb

@@ -80,4 +80,26 @@ class TestCell < Test::Unit::TestCase
     c = Workbook::Cell.new nil
     assert_equal(true,c.nil?)
   end
+  
+  def test_colspan_rowspan
+    c = Workbook::Cell.new
+    c.colspan = 1
+    c.rowspan = 1
+    assert_equal(nil,c.colspan)
+    assert_equal(nil,c.rowspan)
+    c.colspan = nil
+    c.rowspan = ""
+    assert_equal(nil,c.colspan)
+    assert_equal(nil,c.rowspan)   
+    c.colspan = 3
+    c.rowspan = "4"
+    assert_equal(3,c.colspan)
+    c.rowspan = 0
+    assert_equal(nil,c.rowspan)  
+    assert_equal(3,c.colspan)
+    c.colspan = 0
+    c.rowspan = 3
+    assert_equal(3,c.rowspan)  
+    assert_equal(nil,c.colspan)    
+  end
 end

data/test/test_readers_ods_reader.rb

@@ -6,7 +6,7 @@ module Readers
       
       w = Workbook::Book.new
       w.open 'test/artifacts/book_with_tabs_and_colours.ods'
-      assert_equal([:a, :b, :c, :d, :e],w.sheet.table.header.to_symbols[0..4])
+      assert_equal([:a, :b, :c, :d, :e],w.sheet.table.header.to_symbols)
       assert_equal(90588,w.sheet.table[2][:b].value)
     end
 
@@ -26,7 +26,7 @@ module Readers
       w.open 'test/artifacts/complex_types.ods'
       assert_equal(Date.new(2011,11,15), w.sheet.table[2][3].value)
       assert_equal("http://murb.nl", w.sheet.table[3][2].value)
-      assert_equal("sadfasdfsd", w.sheet.table[4][2].value)
+      assert_equal("Sadfasdfsd > 2", w.sheet.table[4][2].value)
       assert_equal(1.2, w.sheet.table[3][1].value)
     end
     
@@ -46,6 +46,18 @@ module Readers
       assert_equal(42000,w.sheet.table[3][:b].value)
       assert_equal(nil,w.sheet.table[2][:c].value)
     end
-    
+    def test_sheet_with_combined_cells
+      w = Workbook::Book.new
+      w.open("test/artifacts/sheet_with_combined_cells.ods")
+      t = w.sheet.table
+      assert_equal("14 90589",t[1][:a].value)
+      assert_equal(Workbook::NilValue,t[1][:b].value.class)
+      assert_equal(:covered,t[1][:b].value.reason)
+      assert_equal(2,t[1][:a].colspan)
+      assert_equal(nil,t[1][:c].colspan)
+      assert_equal(2,t["D3"].rowspan)
+      assert_equal(2,t["D5"].rowspan)
+      assert_equal(2,t["D5"].colspan)
+    end    
   end
 end

data/test/test_table.rb

@@ -60,6 +60,12 @@ class TestTable< Test::Unit::TestCase
     assert_equal(t.sheet, s)
   end
   
+  def test_name
+    t = Workbook::Table.new
+    t.name = "test naam"
+    assert_equal("test naam", t.name)
+  end
+  
   def test_delete_all
     w = Workbook::Book.new [["a","b"],[1,2],[3,4]]
     t = w.sheet.table
@@ -88,5 +94,32 @@ class TestTable< Test::Unit::TestCase
     assert_equal(3,t[3][:a])
     assert_equal(5,t2[3][:a])
   end
+  
+  def test_spreadsheet_style_cell_addressing
+    w = Workbook::Book.new [[nil, nil],["a","b"],[1,2],[3,4]]
+    t = w.sheet.table
+    assert_equal(nil,t["A1"].value)
+    assert_equal(nil,t["B1"].value)
+    assert_equal("a",t["A2"].value)
+    assert_equal("b",t["B2"].value)
+    assert_equal(1,t["A3"].value)
+    assert_equal(2,t["B3"].value)
+    assert_equal(3,t["A4"].value)
+    assert_equal(4,t["B4"].value)
+    # t["B4"]="asdf"
+    # assert_equal("asdf",t["B4"].value)
+    
+  end
 
+  def test_alpha_index_to_number_index
+     w = Workbook::Book.new
+     t = w.sheet.table
+     assert_equal(0,t.alpha_index_to_number_index("A"))
+     assert_equal(2,t.alpha_index_to_number_index("C"))
+     assert_equal(25,t.alpha_index_to_number_index("Z"))
+     assert_equal(26,t.alpha_index_to_number_index("AA"))
+     assert_equal(27,t.alpha_index_to_number_index("AB"))
+     assert_equal(51,t.alpha_index_to_number_index("AZ"))
+     assert_equal(52,t.alpha_index_to_number_index("BA"))
+  end
 end

data/test/test_writers_html_writer.rb

@@ -33,5 +33,21 @@ module Writers
       match = html.match(/<td style="background: #f00">a<\/td>/) ? true : false
       assert_equal(true, match)
     end
+    def test_sheet_and_table_names
+      b = Workbook::Book.new([['a','b'],[1,2],[3,4]])
+      b.sheet.name = "Sheet name"
+      b.sheet.table.name = "Table name"
+      html = b.to_html
+      assert_equal(true, (html.match(/<h1>Sheet name<\/h1>/) ? true : false) )
+      assert_equal(true, (html.match(/<h2>Table name<\/h2>/) ? true : false) )
+    end
+    def test_col_and_rowspans
+      w = Workbook::Book.new
+      w.open("test/artifacts/sheet_with_combined_cells.ods")
+      html = w.to_html
+      assert_equal(true, (html.match(/rowspan="2">15 nov 11 15 nov 11/) ? true : false) )
+      assert_equal(true, (html.match(/colspan="2" rowspan="2">13 mrt 12 15 mrt 12 13 mrt 12 15 mrt 12/) ? true : false) )
+      assert_equal(true, (html.match(/colspan="2">14 90589/) ? true : false) )
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: workbook
 version: !ruby/object:Gem::Version
-  version: '0.4'
+  version: 0.4.1
   prerelease: 
 platform: ruby
 authors:
@@ -174,6 +174,7 @@ files:
 - lib/workbook/modules/raw_objects_storage.rb
 - lib/workbook/modules/table_diff_sort.rb
 - lib/workbook/modules/type_parser.rb
+- lib/workbook/nil_value.rb
 - lib/workbook/readers/csv_reader.rb
 - lib/workbook/readers/ods_reader.rb
 - lib/workbook/readers/txt_reader.rb
@@ -200,6 +201,7 @@ files:
 - test/artifacts/excel_different_types.xlsx
 - test/artifacts/failing_import1.xls
 - test/artifacts/native_xlsx.xlsx
+- test/artifacts/sheet_with_combined_cells.ods
 - test/artifacts/sheetduplication.xls
 - test/artifacts/simple_csv.csv
 - test/artifacts/simple_excel_csv.csv
@@ -265,6 +267,7 @@ test_files:
 - test/artifacts/excel_different_types.xlsx
 - test/artifacts/failing_import1.xls
 - test/artifacts/native_xlsx.xlsx
+- test/artifacts/sheet_with_combined_cells.ods
 - test/artifacts/sheetduplication.xls
 - test/artifacts/simple_csv.csv
 - test/artifacts/simple_excel_csv.csv