workbook 0.2.0 → 0.2.1

data/lib/workbook/template.rb

@@ -1,26 +1,23 @@
 require 'workbook/modules/raw_objects_storage'
 
 module Workbook
-	class Template
+  # Workbook::Template is a container for different Workbook::Format's and the storage of raw template data that isn't really supported by Workbook, but should survive a typical read/write cyclus.
+  class Template
     include Workbook::Modules::RawObjectsStorage
     
+    # Initialize Workbook::Template
     def initialize 
       @formats = {}
       @has_header = true
     end
     
+    # Whether the template has a predefined header (headers are used )
     def has_header?
       @has_header
     end
-    
-    def has_header= boolean
-      if format.is_a? TrueClass or format.is_a? FalseClass
-        @has_header = boolean
-      else
-        raise ArgumentError, "format should be a boolean, true of false"
-      end  
-    end
       
+    # Add a Workbook::Format to the template
+    # @param [Workbook::Format] format (of a cell) to add to the template
     def add_format format
       if format.is_a? Workbook::Format
         @formats[format.name]=format
@@ -29,10 +26,16 @@ module Workbook
       end      
     end
     
+    # Return the list of associated formats
+    # @return [Hash] A keyed-hash of named formats
     def formats
       @formats
     end
     
+    # Create or find a format by name
+    # @return [Workbook::Format] The new or found format
+    # @param [String] name of the format (e.g. whatever you want, in diff names such as 'destroyed', 'updated' and 'created' are being used)
+    # @param [Symbol] variant can also be a strftime formatting string (e.g. "%Y-%m-%d")
     def create_or_find_format_by name, variant=:default
       fs = @formats[name]
       fs = @formats[name] = {} if fs.nil?
@@ -46,7 +49,5 @@ module Workbook
       end
       return @formats[name][variant]
     end
-    
-    
 	end
 end

data/lib/workbook/writers/xls_writer.rb

@@ -3,79 +3,10 @@ require 'spreadsheet'
 module Workbook
   module Writers
     module XlsWriter
-      # TODO: find better way to dupe
-      XLS_COLORS = {:xls_color_1=>'#000000',
-                    :xls_color_2=>'#FFFFFF',
-                    :xls_color_3=>'#FF0000',
-                    :xls_color_4=>'#00FF00',
-                    :xls_color_5=>'#0000FF',
-                    :xls_color_6=>'#FFFF00',
-                    :xls_color_7=>'#FF00FF',
-                    :xls_color_8=>'#00FFFF',
-                    :xls_color_9=>'#800000',
-                    :xls_color_10=>'#008000',
-                    :xls_color_11=>'#000080',
-                    :xls_color_12=>'#808000',
-                    :xls_color_13=>'#800080',
-                    :xls_color_14=>'#008080',
-                    :xls_color_15=>'#C0C0C0',
-                    :xls_color_16=>'#808080',
-                    :xls_color_17=>'#9999FF',
-                    :xls_color_18=>'#993366',
-                    :xls_color_19=>'#FFFFCC',
-                    :xls_color_20=>'#CCFFFF',
-                    :xls_color_21=>'#660066',
-                    :xls_color_22=>'#FF8080',
-                    :xls_color_23=>'#0066CC',
-                    :xls_color_24=>'#CCCCFF',
-                    :xls_color_25=>'#000080',
-                    :xls_color_26=>'#FF00FF',
-                    :xls_color_27=>'#FFFF00',
-                    :xls_color_28=>'#00FFFF',
-                    :xls_color_29=>'#800080',
-                    :xls_color_30=>'#800000',
-                    :xls_color_31=>'#008080',
-                    :xls_color_32=>'#0000FF',
-                    :xls_color_33=>'#00CCFF',
-                    :xls_color_34=>'#CCFFFF',
-                    :xls_color_35=>'#CCFFCC',
-                    :xls_color_36=>'#FFFF99',
-                    :xls_color_37=>'#99CCFF',
-                    :xls_color_38=>'#FF99CC',
-                    :xls_color_39=>'#CC99FF',
-                    :xls_color_40=>'#FFCC99',
-                    :xls_color_41=>'#3366FF',
-                    :xls_color_42=>'#33CCCC',
-                    :xls_color_43=>'#99CC00',
-                    :xls_color_44=>'#FFCC00',
-                    :xls_color_45=>'#FF9900',
-                    :xls_color_46=>'#FF6600',
-                    :xls_color_47=>'#666699',
-                    :xls_color_48=>'#969696',
-                    :xls_color_49=>'#003366',
-                    :xls_color_50=>'#339966',
-                    :xls_color_51=>'#003300',
-                    :xls_color_52=>'#333300',
-                    :xls_color_53=>'#993300',
-                    :xls_color_54=>'#993366',
-                    :xls_color_55=>'#333399',
-                    :xls_color_56=>'#333333',
-                    :black=>'#000000',
-                    :white=>'#FFFFFF',
-                    :red=>'#FF0000',
-                    :green=>'#00FF00',
-                    :blue=>'#0000FF',
-                    :yellow=>'#FFFF00',
-                    :magenta=>'#FF00FF',
-                    :cyan=>'#00FFFF',
-                    :border=>'#FFFFFF',
-                    :text=>'#000000',
-                    :lime=>'#00f94c'
-      }
-      
+
       # Generates an Spreadsheet (from the spreadsheet gem) in order to build an XlS
       # 
-      # @params [Hash] A hash with options (unused so far)
+      # @param [Hash] options A hash with options (unused so far)
       # @return [Spreadsheet] A Spreadsheet object, ready for writing or more lower level operations
       def to_xls options={}
         book = init_spreadsheet_template
@@ -86,7 +17,7 @@ module Workbook
             xls_sheet.row(ri).height= r.format[:height] if r.format
             r.each_with_index do |c, ci|
               if c
-                if r.header?
+                if r.first?
                   xls_sheet.columns[ci] ||= Spreadsheet::Column.new(ci,nil)
                   xls_sheet.columns[ci].width= c.format[:width]
                 end
@@ -99,6 +30,10 @@ module Workbook
         book
       end
       
+      # Generates an Spreadsheet (from the spreadsheet gem) in order to build an XlS
+      # 
+      # @param [Workbook::Format, Hash] f A Workbook::Format or hash with format-options (:font_weight, :rotation, :background_color, :number_format, :text_direction, :color, :font_family)
+      # @return [Spreadsheet::Format] A Spreadsheet format-object, ready for writing or more lower level operations
       def format_to_xls_format f
         xlsfmt = nil
         unless f.is_a? Workbook::Format
@@ -120,23 +55,30 @@ module Workbook
         return xlsfmt
       end
       
+      # Attempt to convert html-hex color value to xls color number
+      #
+      # @param [String] hex color
+      # @return [String] xls color
       def html_color_to_xls_color hex
-        XLS_COLORS.each do |k,v|
+        Workbook::Readers::XlsShared::XLS_COLORS.each do |k,v|
           return k if (v == hex or (hex and hex != "" and k == hex.to_sym))
         end
         return nil
       end
       
+      # Converts standard (ruby/C++/unix/...) strftime formatting to MS's formatting
+      # 
+      # @param [String, nil] numberformat (nil returns nil)
+      # @return [String, nil]
       def strftime_to_ms_format numberformat
         return nil if numberformat.nil?
-        numberformat.gsub('%Y','yyyy').gsub('%A','dddd').gsub('%B','mmmm').gsub('%a','ddd').gsub('%b','mmm').gsub('%y','yy').gsub('%d','dd').gsub('%m','mm').gsub('%y','y').gsub('%y','%%y').gsub('%e','d')
+        return numberformat.gsub('%Y','yyyy').gsub('%A','dddd').gsub('%B','mmmm').gsub('%a','ddd').gsub('%b','mmm').gsub('%y','yy').gsub('%d','dd').gsub('%m','mm').gsub('%y','y').gsub('%y','%%y').gsub('%e','d')
       end
       
       # Write the current workbook to Microsoft Excel format (using the spreadsheet gem)
       #
-      # @param [String] the filename
-      # @param [Hash] options, see #to_xls 
-      
+      # @param [String] filename
+      # @param [Hash] options   see #to_xls 
       def write_to_xls filename="#{title}.xls", options={}
         if to_xls(options).write(filename)
           return filename

data/test/test_modules_table_diff_sort.rb

@@ -51,13 +51,13 @@ module Modules
       assert_equal("a,b,c,d\n1,2,3,4\n\n3,2,3,4\n5,2,3,4\n",align_result[:other].to_csv)
       assert_equal("a,b,c,d\n1,2,3,4\n2,2,3,4\n\n5,2,3,4\n",align_result[:self].to_csv)
       
-      tself = Workbook::Book.new([['a','b','c','d'],[1,2,3,4],[1,3,3,4],[3,2,3,4],[5,2,3,4]]).sheet.table
-      tother = Workbook::Book.new([['a','b','c','d'],[1,2,3,4],[2,2,3,4],[5,2,3,4]]).sheet.table
+      tself =  Workbook::Book.new([['a','b','c','d'],[1,2,3,4],[1,3,3,4],          [3,2,3,4],[5,2,3,4]]).sheet.table
+      tother = Workbook::Book.new([['a','b','c','d'],[1,2,3,4],          [2,2,3,4],          [5,2,3,4]]).sheet.table
       align_result = tself.align tother
       assert_equal("a,b,c,d\n1,2,3,4\n1,3,3,4\n\n3,2,3,4\n5,2,3,4\n",align_result[:self].to_csv)
       assert_equal("a,b,c,d\n1,2,3,4\n\n2,2,3,4\n\n5,2,3,4\n",align_result[:other].to_csv)
-      tself = Workbook::Book.new([['a','b','c','d'],[1,2,3,4],[3,2,3,4],[5,2,3,4]]).sheet.table
-      tother = Workbook::Book.new([['a','b','c','d'],[1,2,3,4],[1,2,3,4],[1,2,3,4],[2,2,3,4],[5,2,3,4]]).sheet.table
+      tself = Workbook::Book.new( [['a','b','c','d'],[1,2,3,4],                              [3,2,3,4],[5,2,3,4]]).sheet.table
+      tother = Workbook::Book.new([['a','b','c','d'],[1,2,3,4],[1,2,3,4],[1,2,3,4],[2,2,3,4],          [5,2,3,4]]).sheet.table
       align_result = tself.align tother
       assert_equal("a,b,c,d\n1,2,3,4\n\n\n\n3,2,3,4\n5,2,3,4\n",align_result[:self].to_csv)
       assert_equal("a,b,c,d\n1,2,3,4\n1,2,3,4\n1,2,3,4\n2,2,3,4\n\n5,2,3,4\n",align_result[:other].to_csv)
@@ -74,6 +74,19 @@ module Modules
           
     end
     
+    def test_with_nil_header
+      a = Workbook::Book.new([['a','b',nil],[1,2,3]])
+      b = Workbook::Book.new([['a','b','c'],[1,2,3]])
+      c = a.sheet.table.diff b.sheet.table
+      assert_equal("a,b,(was: c)\n1,2,(was: 3)\n",c.to_csv)
+    end
+    
+    # def test_diff_file
+    #   a = Workbook::Book.open('test/artifacts/private_a_0.xls')
+    #   b = Workbook::Book.open('test/artifacts/private_a_0.xls')
+    #   y a.sheet.table.diff b.sheet.table
+    # end
+    
     # def test_sort_by
     #   b = Workbook::Book.new [['a','b','c','d'],[1,2,3,4],[4,2,3,3],[3,2,3,2]]
     #   y b.sheet.table.sort_by{|r| r[:d]}
@@ -98,8 +111,8 @@ module Modules
       tother = bb.sheet.table
       diff_result = tself.diff tother
       assert_equal('a',diff_result.sheet.table.header[0].value)
-      assert_equal("a,b,c,d\n1,2,3,4\n3,2,3,4\n3,3 (was: 2),3,4\n4,2,3,4\n(was: 5),(was: 2),(was: 3),(was: 4)\n",diff_result.sheet.table.to_csv)
-      diff_result.write_to_xls
+      assert_equal("a,b,c,d\n1,2,3,4\n3,2,3,4\n3,3 (was: 2),3,4\n4,2,3,4\n(was: 5),(was: 2),(was: 3),(was: 4)\n",diff_result.to_csv)
+      diff_result.sheet.book.write_to_xls
     end
   end
 end

data/test/test_row.rb

@@ -46,9 +46,26 @@ class TestRow < Test::Unit::TestCase
     r2.table = t
     assert_equal(false, r2.header?)
     assert_equal(true, t.first.header?)
+    t.header = r2
+    assert_equal(true, r2.header?)
+    assert_equal(false, t.first.header?)
+    
     assert_equal(r1, t.first)    
   end 
   
+  def test_first?
+    t = Workbook::Table.new
+    r1 = Workbook::Row.new
+    r1.table = t
+    assert_equal(true, r1.first?)
+    r2 = Workbook::Row.new
+    r2.table = t
+    assert_equal(false, r2.first?)
+    assert_equal(true, t.first.first?)
+    
+    assert_equal(r1, t.first) 
+  end
+  
   def test_to_symbols
     r1 = Workbook::Row.new ["test", "asdf-asd", "asdf - asdf", "asdf2"]
     assert_equal([:test, :asdfasd, :asdf_asdf, :asdf2], r1.to_symbols)
@@ -111,4 +128,41 @@ class TestRow < Test::Unit::TestCase
     r1 = Workbook::Row.new  ["test", "asdf-asd"]
     assert_equal("test,asdf-asd\n",r1.to_csv)
   end
+
+  def test_clone
+    b = Workbook::Book.new
+    table = b.sheet.table
+    table << Workbook::Row.new(["a","b"])    
+    row = Workbook::Row.new(["1","2"]) 
+    table << row
+    table << row
+    row[1] = Workbook::Cell.new(3)
+    table << table[1].clone
+    table.last[1].value = 5
+    assert_equal("a,b\n1,3\n1,3\n1,5\n", table.to_csv)
+  end
+  
+  def test_clone_has_no_table
+    # actually not desired, but for now enforced.
+    b = Workbook::Book.new
+    table = b.sheet.table
+    table << Workbook::Row.new(["a","b"])    
+    table << Workbook::Row.new([1,2]) 
+    row = table[1].clone
+    assert_equal(nil,row[:a])
+    assert_equal(nil,row[:b])
+    assert_equal(1,row[0].value)
+    assert_equal(2,row[1].value)
+  end
+  
+  def test_row_hash_index_assignment
+    b = Workbook::Book.new
+    table = b.sheet.table
+    table << Workbook::Row.new(["a","b"])
+    row = Workbook::Row.new([],table)
+    row[1]= 12
+    assert_equal(12, table.last.last.value)
+    row[:b]= 15
+    assert_equal(15, table.last.last.value)
+  end
 end

data/test/test_sheet.rb

@@ -22,5 +22,13 @@ class TestWorkbook < Test::Unit::TestCase
     assert_equal(w.table,t)
     
   end
+  
+  def test_book
+    s = Workbook::Sheet.new
+    b = s.book
+    assert_equal(s.book, b)
+    assert_equal(s, b.sheet)
+    assert_equal(s.book.sheet, b.sheet.table.sheet)
+  end
  
 end

data/test/test_table.rb

@@ -34,10 +34,29 @@ class TestTable< Test::Unit::TestCase
     assert_equal(r, t.last)
     
     r << 2
-    
+
     assert_equal(t.last.empty?, false)
-    
-    
+  end
+  
+  def test_append_row
+    t = Workbook::Table.new
+    row = t.new_row(["a","b"])
+    assert_equal(row, t.header)
+    row = Workbook::Row.new([1,2])
+    assert_equal(nil, row.table)
+    t.push(row)
+    assert_equal(t, row.table)
+    row = Workbook::Row.new([3,4])
+    assert_equal(nil, row.table)
+    t << row 
+    assert_equal(t, row.table)
+  end
+  
+  def test_sheet
+    t = Workbook::Table.new
+    s = t.sheet
+    assert_equal(t, s.table)
+    assert_equal(t.sheet, s)
   end
 
 end

data/test/test_writers_xls_writer.rb

@@ -42,5 +42,8 @@ module Writers
       b.init_spreadsheet_template
       assert_equal(Spreadsheet::Worksheet,b.xls_sheet(100).class)
     end
+    def test_strftime_to_ms_format_nil
+      assert_equal(nil, Workbook::Book.new.strftime_to_ms_format(nil))
+    end
   end
 end

data/workbook.gemspec

@@ -5,7 +5,7 @@ require "workbook"
 Gem::Specification.new do |s|
   s.name        = 'workbook'
   s.rubyforge_project = 'workbook'
-  s.version     = '0.2.0'
+  s.version     = '0.2.1'
   s.date        = '2013-01-10'
   s.summary     = "Workbook is a datastructure to contain books of tables (an anlogy used in e.g. Excel)"
   s.description = "Workbook contains workbooks, as in a table, contains rows, contains cells, reads/writes excels and csv's and tab separated, and offers basic diffing and sorting capabilities."

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Maarten Brouwers
@@ -79,9 +79,52 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .yardoc/checksums
+- .yardoc/object_types
+- .yardoc/objects/root.dat
+- .yardoc/proxy_types
 - Gemfile
 - Gemfile.lock
+- README.md
 - Rakefile
+- doc/RubyXL.html
+- doc/RubyXL/Cell.html
+- doc/RubyXL/Workbook.html
+- doc/Workbook.html
+- doc/Workbook/Book.html
+- doc/Workbook/Cell.html
+- doc/Workbook/Format.html
+- doc/Workbook/Modules.html
+- doc/Workbook/Modules/RawObjectsStorage.html
+- doc/Workbook/Modules/TableDiffSort.html
+- doc/Workbook/Modules/TypeParser.html
+- doc/Workbook/Readers.html
+- doc/Workbook/Readers/CsvReader.html
+- doc/Workbook/Readers/TxtReader.html
+- doc/Workbook/Readers/XlsReader.html
+- doc/Workbook/Readers/XlsShared.html
+- doc/Workbook/Readers/XlsxReader.html
+- doc/Workbook/Row.html
+- doc/Workbook/Sheet.html
+- doc/Workbook/Table.html
+- doc/Workbook/Template.html
+- doc/Workbook/Writers.html
+- doc/Workbook/Writers/CsvTableWriter.html
+- doc/Workbook/Writers/XlsWriter.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
 - lib/workbook.rb
 - lib/workbook/book.rb
 - lib/workbook/cell.rb
@@ -92,6 +135,7 @@ files:
 - lib/workbook/readers/csv_reader.rb
 - lib/workbook/readers/txt_reader.rb
 - lib/workbook/readers/xls_reader.rb
+- lib/workbook/readers/xls_shared.rb
 - lib/workbook/readers/xlsx_reader.rb
 - lib/workbook/row.rb
 - lib/workbook/sheet.rb
@@ -99,7 +143,6 @@ files:
 - lib/workbook/template.rb
 - lib/workbook/writers/csv_table_writer.rb
 - lib/workbook/writers/xls_writer.rb
-- readme.markdown
 - test/artifacts/book_with_tabs_and_colours.xls
 - test/artifacts/book_with_tabs_and_colours.xlsx
 - test/artifacts/complex_types.xls