workbook 0.4.6.0 → 0.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2d0754f13283c6f5a93dcff9faab6fd3ab404c26
-  data.tar.gz: 5c63815a99a9105a4f0eca1a23d0d3f5e67380cd
+  metadata.gz: 5d3acc182ee042e589c65b4ddfc3be95015d96fa
+  data.tar.gz: d23f5bd2cac3dccfb863997fb5e6ea8ced3e70a7
 SHA512:
-  metadata.gz: 89e115237295547d0e68b4a9dcaf0e49d8790079d7b92a9e7f3b51b120bafd3cd4cbd73f09a3e326b22acafd85d5f59ed1e7661aa160ff1747acad830787c517
-  data.tar.gz: 28b2cecfcf40c8667fb72d1c3850289a4631e845285ef6b9d3b6eea326383607db38e67c7b1042d12776cc6307493317d6912ffe4436eef9d7d573e00c2afa31
+  metadata.gz: 8b81415ada844fae07c02d146e4d2a9cbd1898ec0e64a8781ef40fc5c4cb8edbbddba6a83fda301f15666fceae5716c38e198f8769adc238cf4a8822e7aea919
+  data.tar.gz: eebcd14f3191d8c26654d16b2e71f31863504b773da470d1ab11a5960c021631e614c2a036795eda7138c1d3b38d6c6314fed7c21705ed0dc5d0a512d373e655

data/.gitignore

@@ -10,3 +10,4 @@ empty.png
 minus.png
 plus.png
 profile.*
+untitled document.xlsx*

data/README.md

@@ -1,4 +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)
 
 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:
 
@@ -89,18 +90,6 @@ Another typical use case is exporting a list of ActiveRecord-objects to xls (it
                                     # in the endresult
     b.write("recent_orders.xls")    # write it!
 
-
-  <!-- Feature *to implement*:
-
-Feature *to implement*, get a single column:
-
-    t[:b]
-	# returns [<Workbook::Cel @value=2>,<Workbook::Cel @value=4>,<Workbook::Cel @value=6>]
-
-On my wishlist: In the future I hope to return the cell value directly, without the intermediate Workbook::Cell class in between.
-
-	-->
-
 ## Utilities
 
 ### Sorting
@@ -115,13 +104,15 @@ To some extent, sort_by works, it doesn't, however, adhere to the header setting
 
     t.sort_by {|r| r[:b]}
 
-### Comparing tables
+### Comparing tables or entire workbooks
 
 Simply call on a Workbook::Table
 
 	t1.diff t2
 
-And a new book with a new sheet/table will be returned containing the differences between the two tables.
+And a new book with a new table will be returned containing the differences between the two tables.
+
+Alternatively you can run the same command on workbooks, which will compare sheet by sheet and return a new Workbook
 
 ## Writing
 
@@ -132,12 +123,20 @@ Currently writing is limited to the following formats. Templating support is sti
     t.(write_)to_csv          # returns a csv-string (called on tables)
     b.(write_)to_html         # returns a clean html-page with all tables; unformatted, format-names are used in the classes
     t.(write_)to_json         # returns the values of a table in json
+    t.(write_)to_xlsx         # returns/writes using RubyXL to XLS (unstable, work in progress)
 
 In case you want to display a formatted table in HTML, some conversion is offered to convert text/background properties to css-entities. Internally the hash storing style elements tries to map to CSS where possible.
 
 ## Compatibility
 
-Workbook should be compatible with ruby 1.8.7, 1.9.3, 2.0.0 (jruby 1.8 mode works as well, but currently there are some issues with jruby 1.9 and encoding). 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).
+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).
+
+## Future
+
+* Column support, e.g. t[:b] could then return Workbook::Column<[<Workbook::Cel @value=2>,<Workbook::Cel @value=4>,<Workbook::Cel @value=6>]>
+* In the future I hope to return the cell value as inheriting from the original value's class, so you don't have to call #value as often.
+* xlsx support definitly needs to be improved. Especially template based support.
 
 ## Alternatives
 

data/lib/workbook.rb

@@ -1,18 +1,29 @@
 # -*- encoding : utf-8 -*-
 $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'
-require 'workbook/template'
-require 'workbook/version'
-require 'workbook/column'
+require_relative 'workbook/modules/cache'
+require_relative 'workbook/book'
+require_relative 'workbook/sheet'
+require_relative 'workbook/table'
+require_relative 'workbook/nil_value'
+require_relative 'workbook/row'
+require_relative 'workbook/cell'
+require_relative 'workbook/format'
+require_relative 'workbook/template'
+require_relative 'workbook/version'
+require_relative 'workbook/column'
 
 module Workbook
   class << self
-
+    def caching_enabled?
+      @@caching_enabled ||= true
+    end
+    # Disable caching globally (wherever applicable)
+    def disable_caching!
+      @@caching_enabled = false
+    end
+    # Enable caching globally (wherever applicable)
+    def enable_caching!
+      @@caching_enabled = true
+    end
   end
 end

data/lib/workbook/book.rb

@@ -1,5 +1,6 @@
 # -*- encoding : utf-8 -*-
 require 'workbook/writers/xls_writer'
+require 'workbook/writers/xlsx_writer'
 require 'workbook/writers/html_writer'
 require 'workbook/readers/xls_reader'
 require 'workbook/readers/xls_shared'
@@ -7,28 +8,36 @@ require 'workbook/readers/xlsx_reader'
 require 'workbook/readers/ods_reader'
 require 'workbook/readers/csv_reader'
 require 'workbook/readers/txt_reader'
+require 'workbook/readers/txt_reader'
+require 'workbook/modules/diff_sort'
 
 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)
+
   class Book < Array
+
+
     include Workbook::Readers::XlsShared
     include Workbook::Writers::XlsWriter
+    include Workbook::Writers::XlsxWriter
     include Workbook::Writers::HtmlWriter
     include Workbook::Readers::XlsReader
     include Workbook::Readers::OdsReader
     include Workbook::Readers::XlsxReader
     include Workbook::Readers::CsvReader
     include Workbook::Readers::TxtReader
+    include Workbook::Modules::BookDiffSort
 
     # @param [Workbook::Sheet, Array] sheet    create a new workbook based on an existing sheet, or initialize a sheet based on the array
     # @return [Workbook::Book]
     def initialize sheet=Workbook::Sheet.new([], self, options={})
       if sheet.is_a? Workbook::Sheet
-        push sheet
+        self.push sheet
       else
-        push Workbook::Sheet.new(sheet, self, options)
+        self.push Workbook::Sheet.new(sheet, self, options)
       end
     end
 
@@ -59,8 +68,19 @@ module Workbook
     # @param [Workbook::Sheet] sheet
     def push sheet=Workbook::Sheet.new
       super(sheet)
+      sheet.book=(self)
+    end
+
+    # << (like in array) a sheet to the workbook (parameter is optional, default is a new sheet)
+    #
+    # @param [Workbook::Sheet] sheet
+    def << sheet=Workbook::Sheet.new
+      sheet = Workbook::Sheet.new(sheet) unless sheet.is_a? Workbook::Sheet
+      super(sheet)
+      sheet.book=(self)
     end
 
+
     # Sheet returns the first sheet of a workbook, or an empty one.
     #
     # @return [Workbook::Sheet] The first sheet, and creates an empty one if one doesn't exists
@@ -145,35 +165,13 @@ module Workbook
       return text
     end
 
-    # @param [String] filename   The full filename, or path
+    # @param [String, File] filename   The full filename, or path
     #
     # @return [String] The file extension
     def file_extension(filename)
       File.extname(filename).gsub('.','').downcase if filename
     end
 
-    # Create an instance from a file, using open.
-    #
-    # @param [String] filename of the document
-    # @param [String] extension of the document (not required). The parser used is based on the extension of the file, this option allows you to override the default.
-    # @return [Workbook::Book] A new instance, based on the filename
-    def self.open filename, extension=nil
-      wb = self.new
-      wb.open filename, extension
-      return wb
-    end
-
-    # Create an instance from the given stream or string, which should be in CSV or TXT format
-    #
-    # @param [StringIO] stringio_or_string StringIO stream or String object, with data in CSV or TXT format
-    # @param [Symbol] filetype (currently only :csv or :txt), indicating the format of the first parameter
-    # @return [Workbook::Book] A new instance
-    def self.read(stringio_or_string, filetype)
-      wb = self.new
-      wb.read(stringio_or_string, filetype)
-      wb
-    end
-
     # Load the CSV data contained in the given StringIO or String object
     #
     # @param [StringIO] stringio_or_string StringIO stream or String object, with data in CSV format
@@ -195,5 +193,29 @@ module Workbook
       s
     end
 
+    class << self
+      # Create an instance from a file, using open.
+      #
+      # @param [String] filename of the document
+      # @param [String] extension of the document (not required). The parser used is based on the extension of the file, this option allows you to override the default.
+      # @return [Workbook::Book] A new instance, based on the filename
+      def open filename, extension=nil
+        wb = self.new
+        wb.open filename, extension
+        return wb
+      end
+
+      # Create an instance from the given stream or string, which should be in CSV or TXT format
+      #
+      # @param [StringIO] stringio_or_string StringIO stream or String object, with data in CSV or TXT format
+      # @param [Symbol] filetype (currently only :csv or :txt), indicating the format of the first parameter
+      # @return [Workbook::Book] A new instance
+      def read(stringio_or_string, filetype)
+        wb = self.new
+        wb.read(stringio_or_string, filetype)
+        wb
+      end
+
+    end
   end
 end

data/lib/workbook/cell.rb

@@ -9,7 +9,7 @@ module Workbook
     attr_accessor :formula
 
     # Note that these types are sorted by 'importance'
-    VALID_TYPES = [Numeric,String,Time,Date,TrueClass,FalseClass,NilClass,Workbook::NilValue]
+    VALID_TYPES = [Numeric,String,Time,Date,TrueClass,FalseClass,NilClass,Workbook::NilValue,Symbol]
 
     # Evaluates a value for class-validity
     #
@@ -24,24 +24,20 @@ module Workbook
     # @param [Numeric,String,Time,Date,TrueClass,FalseClass,NilClass] value a valid value
     # @param [Hash] options a reference to :format (Workbook::Format) can be specified
     def initialize value=nil, options={}
-      if valid_value? value
-        self.format = options[:format]
-        @value = value
-        @to_sym = nil
-      else
-        raise ArgumentError, "value should be of a primitive type, e.g. a string, or an integer, not a #{value.class} (is_a? [TrueClass,FalseClass,Date,Time,Numeric,String, NilClass])"
-      end
+      self.format = options[:format]
+      self.value = value
+      @to_sym = nil
     end
 
     # Change the current value
     #
-    # @param [Numeric,String,Time,Date,TrueClass,FalseClass,NilClass] value a valid value
+    # @param [Numeric,String,Time,Date,TrueClass,FalseClass,NilClass,Symbol] value a valid value
     def value= value
       if valid_value? value
         @value = value
         @to_sym = nil
       else
-        raise ArgumentError, "value should be of a primitive type, e.g. a string, or an integer, not a #{value.class} (is_a? [TrueClass,FalseClass,Date,Time,Numeric,String, NilClass])"
+        raise ArgumentError, "value should be of a primitive type, e.g. a string, or an integer, not a #{value.class} (is_a? [TrueClass,FalseClass,Date,Time,Numeric,String, NilClass, Symbol])"
       end
     end
 
@@ -97,25 +93,21 @@ module Workbook
     #     <Workbook::Cell value="yet another value">.to_sym # returns :yet_another_value
     def to_sym
       return @to_sym if @to_sym
-      #mb_chars.normalize(:kd).
       v = nil
       if value
         ends_with_exclamationmark = (value[-1] == '!')
         ends_with_questionmark = (value[-1] == '?')
         v = value.to_s.downcase
-        v = v.strip.gsub(/[\(\)\.\?\,\!\=\$]/,'').
-        gsub(/\&/,'en').
-        gsub(/\+/,'_plus_').
-        gsub(/\s/, "_").
-        gsub('–_','').
-        gsub('-_','').
-        gsub('+_','').
-        gsub('/_','_').
-        gsub('/','_').
-        gsub('__','_').
-        gsub('-','')
-
-        accents = {
+
+        replacements = {
+          [/[\(\)\.\?\,\!\=\$\:]/,] => '',
+          [/\&/] => 'amp',
+          [/\+/] => '_plus_',
+          [/\s/,'/_','/',"\\"] => '_',
+          ['–_','-_','+_','-'] => '',
+          ['__']=>'_',
+          ['>']=>'gt',
+          ['<']=>'lt',
           ['á','à','â','ä','ã','å'] => 'a',
           ['Ã','Ä','Â','À','�?','Å'] => 'A',
           ['é','è','ê','ë'] => 'e',
@@ -133,9 +125,11 @@ module Workbook
           ['ž','ź'] => 'z',
           ['Ž','Ź'] => 'Z',
           ['ñ'] => 'n',
-          ['Ñ'] => 'N'
+          ['Ñ'] => 'N',
+          ['#'] => 'hash',
+          ['*'] => 'asterisk'
         }
-        accents.each do |ac,rep|
+        replacements.each do |ac,rep|
           ac.each do |s|
             v = v.gsub(s, rep)
           end

data/lib/workbook/generatetypes.rb

@@ -0,0 +1,14 @@
+["Numeric","String","Time","Date","TrueClass","FalseClass","NilClass"].each do |type|
+  f = File.open(File.join(File.dirname(__FILE__),"types","#{type}.rb"),'w+')
+  puts f.inspect
+  doc="require 'workbook/cell'
+
+module Workbook
+  module Types
+    class #{type} < #{type}
+      include Workbook::Cell
+    end
+  end
+end"
+f.write(doc)
+end

data/lib/workbook/modules/cache.rb

@@ -0,0 +1,52 @@
+# -*- encoding : utf-8 -*-
+module Workbook
+  module Modules
+    # Adds simple caching
+    module Cache
+      attr_accessor :debug_cache
+
+      # Caching enabled?
+      # @return [Boolean]
+      def caching_enabled?
+        Workbook.caching_enabled?
+      end
+
+      # Return valid cache time, if caching is enabled, otherwise calls #invalidate_cache!
+      # @return [Time] Timestamp after which cache is valid
+      def cache_valid_from
+        if caching_enabled?
+          @cache_valid_from ||= Time.now
+        else
+          invalidate_cache!
+        end
+        @cache_valid_from
+      end
+
+      # Invalidate all caches on this instance, and reset
+      # @return [Time] Timestamp after which cache is valid (=current time, hence everything stored before is invalid)
+      def invalidate_cache!
+        @cache_valid_from = Time.now
+      end
+
+      # Check if currently stored key is available and still valid
+      # @return [Boolean]
+      def valid_cache_key?(key, expires=nil)
+        cache_valid_from
+        rv = (@cache[key] and (@cache[key][:inserted_at] > cache_valid_from) and (expires.nil? or @cache[key][:inserted_at] < expires)) ? true : false
+        rv
+      end
+      def fetch_cache(key, expires=nil)
+        @cache ||= {}
+        if valid_cache_key?(key, expires)
+          return @cache[key][:value]
+        else
+          @cache[key] = {
+            value: yield,
+            inserted_at: Time.now
+          }
+        end
+        return @cache[key][:value]
+      end
+    end
+  end
+end

data/lib/workbook/modules/{table_diff_sort.rb → diff_sort.rb}

@@ -1,11 +1,57 @@
 # -*- encoding : utf-8 -*-
 module Workbook
   module Modules
+    # Adds essential diffing and comparing support, as well as diffing entire books
+    module BookDiffSort
+      module ClassMethods
+        # Return template table to write the diff result in; in case non exists a default is generated.
+        #
+        # @return [Workbook::Table] the empty table, linked to a book
+        def new_diff_template
+            diffbook = Workbook::Book.new
+            template = diffbook.template
+            f = template.create_or_find_format_by 'destroyed'
+            f[:background_color]=:red
+            f = template.create_or_find_format_by 'updated'
+            f[:background_color]=:yellow
+            f = template.create_or_find_format_by 'created'
+            f[:background_color]=:lime
+            f = template.create_or_find_format_by 'header'
+            f[:rotation] = 72
+            f[:font_weight] = :bold
+            f[:height] = 80
+            diffbook
+        end
+      end
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      # Diff an entire workbook against another, sheet by sheet
+      #
+      # @param [Workbook::Book] to_workbook to compare against
+      # @return [Workbook::Book] workbook with compared result
+      def diff to_workbook, options={:sort=>true,:ignore_headers=>false}
+        diff_template = Workbook::Book.new_diff_template
+        self.each_with_index do |from_sheet, sheet_index|
+          to_sheet = to_workbook[sheet_index]
+          if to_sheet
+            from_table = from_sheet.table
+            to_table = to_sheet.table
+            diff_table_template = diff_template.create_or_open_sheet_at(sheet_index).table
+            from_table.diff_template = diff_table_template
+            from_table.diff(to_table, options)
+          end
+        end
+        return diff_template #the template has been filled in the meanwhile, not to use as a template anymore... :)
+      end
+    end
+
     # Adds diffing and sorting functions
     module TableDiffSort
       # create an overview of the differences between itself with another 'previous' table, returns a book with a single sheet and table (containing the diffs)
       #
-      # @return [Workbook::Book] (note should and will become Workbook::Table as diffing occurs on table level...)
+      # @return [Workbook::Table] the return result
       def diff other, options={:sort=>true,:ignore_headers=>false}
 
         aligned = align(other, options)
@@ -45,7 +91,6 @@ module Workbook
               f = diff_template.template.create_or_find_format_by 'updated'
               dcell.format = f
             end
-
             row[ci]=dcell
           end
         end
@@ -56,26 +101,29 @@ module Workbook
         diff_table
       end
 
+      # Return template table to write the diff result in; in case non exists a default is generated.
+      #
+      # @return [Workbook::Table] the empty table, linked to a book
       def diff_template
         return @diff_template if @diff_template
-        diffbook = Workbook::Book.new
+        diffbook = Workbook::Book.new_diff_template
         difftable = diffbook.sheet.table
-        template = diffbook.template
-        f = template.create_or_find_format_by 'destroyed'
-        f[:background_color]=:red
-        f = template.create_or_find_format_by 'updated'
-        f[:background_color]=:yellow
-        f = template.create_or_find_format_by 'created'
-        f[:background_color]=:lime
-        f = template.create_or_find_format_by 'header'
-        f[:rotation] = 72
-        f[:font_weight] = :bold
-        f[:height] = 80
-        @diff_template = diffbook
-        return difftable
+        @diff_template ||= difftable
+      end
+
+      # Set the template table to write the diff result in; in case non exists a default is generated. Make sure that
+      # the following formats exists: destroyed, updated, created and header.
+      #
+      # @param [Workbook::Table] table to diff inside
+      # @return [Workbook::Table] the passed table
+      def diff_template= table
+        @diff_template= table
       end
 
       # aligns itself with another table, used by diff
+      #
+      # @param [Workbook::Table] other table to align with
+      # @param [Hash] options default to: `{:sort=>true,:ignore_headers=>false}`
       def align other, options={:sort=>true,:ignore_headers=>false}
 
         options = {:sort=>true,:ignore_headers=>false}.merge(options)