workbook 0.4.7 → 0.4.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d3acc182ee042e589c65b4ddfc3be95015d96fa
-  data.tar.gz: d23f5bd2cac3dccfb863997fb5e6ea8ced3e70a7
+  metadata.gz: d9cf45e1ff6addbcf502334bf786df43a7c7714a
+  data.tar.gz: 6f219b42f0c6b17f8ed9ac32c57b3032efe74f12
 SHA512:
-  metadata.gz: 8b81415ada844fae07c02d146e4d2a9cbd1898ec0e64a8781ef40fc5c4cb8edbbddba6a83fda301f15666fceae5716c38e198f8769adc238cf4a8822e7aea919
-  data.tar.gz: eebcd14f3191d8c26654d16b2e71f31863504b773da470d1ab11a5960c021631e614c2a036795eda7138c1d3b38d6c6314fed7c21705ed0dc5d0a512d373e655
+  metadata.gz: 8ca18e838d71e6bee71a343728f9d0e7cd5843511e7e2e13c9d5a6432e2ecad2d78dc37913d87b4744f86f4ab46e386449fbf2f9488a143329514704c1221726
+  data.tar.gz: db7378ab0541f0f6ecdc0fa66f707f5c58e908da0086d57eac010d8b4057534ac4cb7c3d809520a6702ada150a3f88c141913b4e5bbdf9096d7e3d21db733faa

data/README.md

@@ -1,5 +1,5 @@
 # Workbook
-[![Code Climate](https://codeclimate.com/github/murb/workbook.png)](https://codeclimate.com/github/murb/workbook) [![Build Status](https://travis-ci.org/murb/workbook.png?branch=master)](https://travis-ci.org/murb/workbook)
+[![Code Climate](https://codeclimate.com/github/murb/workbook.png)](https://codeclimate.com/github/murb/workbook) [![Build Status](https://travis-ci.org/murb/workbook.svg?branch=master)](https://travis-ci.org/murb/workbook) [![Gem Version](https://badge.fury.io/rb/workbook.svg)](http://badge.fury.io/rb/workbook)
 
 Goal of this gem is to make working with workbooks (spreadsheets) as programmer friendly as possible. Not reinventing a totally new DSL or all kinds of new methodnames, but just borrowing from known concepts such as hashes and arrays (much like (Faster)CSV does)). Workbook is a gem that mimicks a typical spreadsheet, a bundle of sheets, bundled in a *workbook*. A sheet may contain one or more tables (which might the multi table sheets of Apple Numbers or Excel ranges). Basically:
 
@@ -130,7 +130,7 @@ In case you want to display a formatted table in HTML, some conversion is offere
 ## Compatibility
 
 Workbook is automatically tested for ruby 1.9, 2.0 and 2.1. Most of it works with 1.8.7 and jruby but not all tests give equal results.
-Check [Travis for Workbook's current build status](https://travis-ci.org/murb/workbook) [![Build Status](https://travis-ci.org/murb/workbook.png?branch=master)](https://travis-ci.org/murb/workbook).
+Check [Travis for Workbook's current build status](https://travis-ci.org/murb/workbook) [![Build Status](https://travis-ci.org/murb/workbook.svg?branch=master)](https://travis-ci.org/murb/workbook).
 
 ## Future
 

data/lib/workbook/book.rb

@@ -15,7 +15,21 @@ module Workbook
   # The Book class is the container of sheets. It can be inialized by either the standard initalizer or the open method. The
   # Book class can also keep a reference to a template class, storing shared formatting options.
   #
-  SUPPORTED_MIME_TYPES = %w(application/zip text/plain application/x-ariadne-download application/vnd.ms-excel application/excel application/vnd.ms-office text/csv text/tab-separated-values application/x-ms-excel application/vnd.openxmlformats-officedocument.spreadsheetml.sheet application/vnd.oasis.opendocument.spreadsheet application/x-vnd.oasis.opendocument.spreadsheet)
+  SUPPORTED_MIME_TYPES = [
+    "application/zip",
+    "text/plain",
+    "application/x-ariadne-download",
+    "application/vnd.ms-excel",
+    "application/excel",
+    "application/vnd.ms-office",
+    "text/csv",
+    "text/tab-separated-values",
+    "application/x-ms-excel",
+    "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
+    "application/vnd.oasis.opendocument.spreadsheet",
+    "application/x-vnd.oasis.opendocument.spreadsheet",
+    "CDF V2 Document, No summary info"
+  ]
 
   class Book < Array
 

data/lib/workbook/column.rb

@@ -3,9 +3,10 @@ module Workbook
 
   # Column helps us to store general properties of a column, and lets us easily perform operations on values within a column
   class Column
-    attr_accessor :limit #character limit
+    attr_accessor :limit, :table #character limit
 
-    def initialize(options={})
+    def initialize(table=nil, options={})
+      self.table = table
       options.each{ |k,v| self.public_send("#{k}=",v) }
     end
 
@@ -14,6 +15,11 @@ module Workbook
       @column_type
     end
 
+    def table= t
+      raise(ArgumentError, "value should be nil or Workbook::Table") unless [NilClass,Workbook::Table].include? t.class
+      @table = t
+    end
+
     def column_type= column_type
       if [:primary_key, :string, :text, :integer, :float, :decimal, :datetime, :date, :binary, :boolean].include? column_type
         @column_type = column_type

data/lib/workbook/readers/xls_shared.rb

@@ -2,6 +2,11 @@
 module Workbook
   module Readers
     module XlsShared
+
+      # Converts standard (ruby/C++/unix/...) strftime formatting to MS's formatting
+      #
+      # @param [String, nil] numberformat (nil returns nil)
+      # @return [String, nil]
       def ms_formatting_to_strftime ms_nr_format
         if ms_nr_format
           ms_nr_format = ms_nr_format.to_s.downcase

data/lib/workbook/row.rb

@@ -14,13 +14,12 @@ module Workbook
     # @param [Workbook::Table] table a row normally belongs to a table, reference it here
     # @param [Hash] options  Supprted options: parse_cells_on_batch_creation (parse cell values during row-initalization, default: false), cell_parse_options (default {}, see Workbook::Modules::TypeParser)
     def initialize cells=[], table=nil, options={}
-      options=options ? {:parse_cells_on_batch_creation=>false,:cell_parse_options=>{}}.merge(options) : {}
+      options=options ? {:parse_cells_on_batch_creation=>false,:cell_parse_options=>{},:clone_cells=>false}.merge(options) : {}
       cells = [] if cells==nil
       self.table= table
       cells.each do |c|
-        if c.is_a? Workbook::Cell
-          c = c
-        else
+        c = c.clone if options[:clone_cells]
+        unless c.is_a? Workbook::Cell
           c = Workbook::Cell.new(c)
           c.parse!(options[:cell_parse_options]) if options[:parse_cells_on_batch_creation]
         end
@@ -258,7 +257,7 @@ module Workbook
     #
     # @return [Workbook::Row] a cloned copy of self with cells
     def clone
-      Workbook::Row.new(to_a.collect{|c| c.clone})
+      Workbook::Row.new(self, nil, {:clone_cells=>true})
     end
 
     # remove all the trailing nil-cells (returning a trimmed clone)

data/lib/workbook/sheet.rb

@@ -41,7 +41,6 @@ module Workbook
     # Set the first table of this sheet with a table or array of cells/values
     # @param [Workbook::Table, Array<Array>] table   The new first table of this sheet
     # @param [Hash] options                          are forwarded to Workbook::Table.new
-
     # @return [Workbook::Table] the first table of this sheet
     def table= table, options={}
       if table.is_a? Workbook::Table

data/lib/workbook/table.rb

@@ -15,15 +15,17 @@ module Workbook
 
     attr_accessor :sheet
     attr_accessor :name
+    attr_accessor :columns
 
     def initialize row_cel_values=[], sheet=nil, options={}
       row_cel_values = [] if row_cel_values == nil
-      row_cel_values.each do |r|
+      row_cel_values.each_with_index do |r,ri|
         if r.is_a? Workbook::Row
           r.table = self
         else
           r = Workbook::Row.new(r,self, options)
         end
+        define_columns_with_row(r) if ri == 0
       end
       self.sheet = sheet
       # Column data is considered as a 'row' with 'cells' that contain 'formatting'
@@ -54,6 +56,12 @@ module Workbook
       @header = h
     end
 
+    def define_columns_with_row(r)
+      self.columns = r.collect do |column|
+        Workbook::Column.new self, {}
+      end
+    end
+
     # Generates a new row, with optionally predefined cell-values, that is already connected to this table.
     def new_row cell_values=[]
       r = Workbook::Row.new(cell_values,self)
@@ -148,10 +156,10 @@ module Workbook
     # @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])
+        match = index_or_string.match(/([A-Z]+)([0-9]*)/i)
+        col_index = alpha_index_to_number_index(match[1])
         row_index = match[2].to_i - 1
-        return self[row_index][cell_index]
+        return self[row_index][col_index]
       elsif index_or_string.is_a? Range
         collection = to_a[index_or_string].collect{|a| a.clone}
         return Workbook::Table.new collection

data/lib/workbook/version.rb

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

data/lib/workbook/writers/html_writer.rb

@@ -10,7 +10,6 @@ module Workbook
       # @param [Hash] options A hash with options
       # @return [String] A String containing the HTML code
       def to_html options={}
-        options = {:style_with_inline_css=>false}.merge(options)
         builder = Nokogiri::XML::Builder.new do |doc|
           doc.html {
             doc.body {
@@ -56,13 +55,9 @@ module Workbook
               if header
                 doc.tr do
                   header.each do |cell|
-                    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 != ""
-                    td_options = td_options.merge({:colspan=>cell.colspan}) if cell.colspan
-                    td_options = td_options.merge({:rowspan=>cell.rowspan}) if cell.rowspan
+                    th_options = build_cell_options cell, options
                     unless cell.value.class == Workbook::NilValue
-                      doc.th(td_options) do
+                      doc.th(th_options) do
                         doc.text cell.value
                       end
                     end
@@ -75,11 +70,7 @@ module Workbook
                 unless row.header?
                   doc.tr do
                     row.each do |cell|
-                      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 != ""
-                      td_options = td_options.merge({:colspan=>cell.colspan}) if cell.colspan
-                      td_options = td_options.merge({:rowspan=>cell.rowspan}) if cell.rowspan
+                      td_options = build_cell_options cell, options
                       unless cell.value.class == Workbook::NilValue
                         doc.td(td_options) do
                           doc.text cell.value
@@ -94,6 +85,15 @@ module Workbook
         end
         return builder.doc.to_xhtml
       end
+      private
+      def build_cell_options cell, options={}
+        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 != ""
+        td_options = td_options.merge({:colspan=>cell.colspan}) if cell.colspan
+        td_options = td_options.merge({:rowspan=>cell.rowspan}) if cell.rowspan
+        return td_options
+      end
     end
   end
 end

data/lib/workbook/writers/xls_writer.rb

@@ -30,25 +30,33 @@ module Workbook
           end
           (xls_sheet.last_row_index + 1 - s.table.count).times do |time|
             row_to_remove = s.table.count+time
-            xls_sheet.row(row_to_remove).each_with_index do |c, ci|
-              xls_sheet.row(row_to_remove)[ci]=nil
-            end
-
-            xls_sheet.delete_row(row_to_remove)
-            xls_sheet.row_updated(row_to_remove, xls_sheet.row(row_to_remove))
+            remove_row(xls_sheet,row_to_remove)
           end
           xls_sheet.updated_from(s.table.count)
           xls_sheet.dimensions
 
         end
-        # kind of a hack, delting by popping from xls worksheet results in Excel-errors (not LibreOffice)
+        # kind of a hack, deleting by popping from xls worksheet results in errors in MS Excel (not LibreOffice)
         # book.worksheets.pop(book.worksheets.count - self.count) if book.worksheets and book.worksheets.count > self.count
-        book.worksheets.each_with_index do |sheet, si|
-          sheet.visibility = self[si] ? :visible : :strong_hidden
+        book.worksheets.each_with_index do |xls_sheet, si|
+          if self[si]
+            xls_sheet.visibility = :visible
+          else
+            xls_sheet.visibility = :strong_hidden
+            #also make sure all data is removed, in case someone finds out about this 'trick'
+            xls_sheet.name = "RemovedSheet#{si}"
+            (xls_sheet.last_row_index + 1).times do |row_index|
+              remove_row(xls_sheet,row_index)
+            end
+          end
         end
+        # even after removing the worksheet's content... which solved some incompatibilities, but not for popping worksheets
+        # book.worksheets.pop(book.worksheets.count - self.count) if book.worksheets and book.worksheets.count > self.count
         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)
@@ -97,27 +105,6 @@ module Workbook
         end
       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
-        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?
-        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] filename
@@ -150,6 +137,16 @@ module Workbook
           return t
         end
       end
+
+      private
+
+      def remove_row(xls_sheet,row_index)
+        xls_sheet.row(row_index).each_with_index do |c, ci|
+          xls_sheet.row(row_index)[ci]=nil
+        end
+        xls_sheet.delete_row(row_index)
+        xls_sheet.row_updated(row_index, xls_sheet.row(row_index))
+      end
     end
   end
 end

data/test/test_column.rb

@@ -6,10 +6,19 @@ class TestColumn < Test::Unit::TestCase
   def test_init
     c = Workbook::Column.new
     assert_equal(Workbook::Column, c.class)
-    c = Workbook::Column.new({:limit=>20,:default=>"asdf", :column_type=>:boolean})
+    c = Workbook::Column.new(nil, {:limit=>20,:default=>"asdf", :column_type=>:boolean})
+    c = Workbook::Column.new(Workbook::Table.new, {:limit=>20,:default=>"asdf", :column_type=>:boolean})
     assert_equal(20, c.limit)
     assert_equal(Workbook::Cell.new("asdf"), c.default)
     assert_equal(:boolean, c.column_type)
-    assert_raise(ArgumentError) { Workbook::Column.new({:limit=>20,:default=>"asdf", :column_type=>:bodfolean}) }
+    assert_raise(ArgumentError) { Workbook::Column.new(true) }
+    assert_raise(ArgumentError) { Workbook::Column.new(nil, {:limit=>20,:default=>"asdf", :column_type=>:bodfolean}) }
+  end
+
+  def test_table
+    c = Workbook::Column.new
+    c.table = Workbook::Table.new
+    assert_equal(Workbook::Table.new, c.table)
+    assert_raise(ArgumentError) { c.table = false }
   end
 end

data/test/test_readers_xlsx_reader.rb

@@ -29,7 +29,6 @@ module Readers
       assert_equal(nil,w.ms_formatting_to_strftime(nil));
       assert_equal(nil,w.ms_formatting_to_strftime(""));
     end
-
     # def test_monkey_patched_ruby_xl_is_date_format?
     #   w = RubyXL::Workbook.new
     #   assert_equal(false, w.is_date_format?(nil))

data/test/test_table.rb

@@ -186,4 +186,6 @@ class TestTable< Test::Unit::TestCase
     # puts [first_few_lines,last_few_lines].join(" vs ")
     assert_equal(true, first_few_lines*1.10 > last_few_lines) # 10% slower is acceptable
   end
+
+
 end

data/workbook.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
   s.authors     = ["Maarten Brouwers"]
   s.add_development_dependency 'ruby-prof', '~> 0.14'
   s.add_dependency('rubyzip', '~>1')
-  s.add_dependency('spreadsheet', '~> 0.7')
+  s.add_dependency('spreadsheet', '~> 1.0')
   s.add_dependency('fastercsv') if RUBY_VERSION < "1.9"
   s.add_dependency("rchardet", "~> 1.3")
   s.add_dependency("rake", '~> 10.0')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: workbook
 version: !ruby/object:Gem::Version
-  version: 0.4.7
+  version: 0.4.8
 platform: ruby
 authors:
 - Maarten Brouwers
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rchardet
   requirement: !ruby/object:Gem::Requirement
@@ -250,6 +250,7 @@ files:
 - test/artifacts/excel_different_types.xls
 - test/artifacts/excel_different_types.xlsx
 - test/artifacts/failing_import1.xls
+- test/artifacts/heavy.xlsx
 - test/artifacts/native_xlsx.xlsx
 - test/artifacts/sheet_with_combined_cells.ods
 - test/artifacts/sheetduplication.xls
@@ -305,7 +306,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: workbook
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Workbook is a datastructure to contain books of tables (an anlogy used in
@@ -325,6 +326,7 @@ test_files:
 - test/artifacts/excel_different_types.xls
 - test/artifacts/excel_different_types.xlsx
 - test/artifacts/failing_import1.xls
+- test/artifacts/heavy.xlsx
 - test/artifacts/native_xlsx.xlsx
 - test/artifacts/sheet_with_combined_cells.ods
 - test/artifacts/sheetduplication.xls
@@ -359,4 +361,3 @@ test_files:
 - test/test_writers_json_writer.rb
 - test/test_writers_xls_writer.rb
 - test/test_writers_xlsx_writer.rb
-has_rdoc: