workbook 0.4.9 → 0.4.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4b33014d1a79259654ae669373a886007f494f5
-  data.tar.gz: 6385dfbbe2965a2d4b59aa597ad9875040aa5226
+  metadata.gz: ca5f6da9acf713dbf71a56c795e93c951d0838d3
+  data.tar.gz: a2252dd8e37faaae531689cb2d7de383d3771994
 SHA512:
-  metadata.gz: e2f9ee0754579c29154b399ab4e868bc1a784b71f8cb61487606210ee3fb2b948b72d1182576071945e14574b7b99b087ef36f927d577a2add013546f280991f
-  data.tar.gz: 5797ba6fa5d14e6259a6a33ab45d1b228afae3eb9c99a8a2633856821978846f3e93f6e98173a085ee00bdf66b8ffff00b9f5411510f2aca981fede53ba1a3bc
+  metadata.gz: be613dc8479a2a1d4106b214004cf1274fa9784b4a43cca0ee3fd0e942211a12662abc2b7acf56346ce517fefcabecd51a942db2d48159de2bb7b3e540d8589e
+  data.tar.gz: d331c6f871214606845fdb3377db3b65265794154b5b9ad66f1a242ee74cc97f119aee2a8e6f558a1e34fb65697f291039486ff56bfef2038d2b2ca03e840a8c

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 rvm:
-  - 1.9.3
   - 2.0.0
   - 2.1.0
+  - 2.2.0
 #  - jruby-19mode

data/README.md

@@ -144,7 +144,7 @@ The [ruby toolbox lists plenty of alternatives](https://www.ruby-toolbox.com/sea
 
 ## License
 
-This code MIT (but see below) (c) murb / Maarten Brouwers, 2011-2013
+This code MIT (but see below) © murb / Maarten Brouwers, 2011-2015
 
 Workbook uses the following gems:
 
@@ -152,7 +152,6 @@ Workbook uses the following gems:
 * [ruby-ole](http://code.google.com/p/ruby-ole/) Used in the Spreadsheet Gem (Copyright © 2007-2010 Charles Lowe; MIT)
 * [FasterCSV](http://fastercsv.rubyforge.org/) Used for reading CSV (comma separated text) and TXT (tab separated text) files (Copyright © James Edward Gray II; GPL2 & Ruby License)
 * [rchardet](http://rubyforge.org/projects/rchardet) Used for detecting encoding in CSV and TXT importers (Copyright © JMHodges; LGPL)
-* [RubyXL](https://github.com/gilt/rubyXL) Used for reading the newer .xlsx files (Copyright © 2011 Vivek Bhagwat; MIT-Licensed)
-* [Nokogiri](http://nokogiri.org/) Used for reading ODS documents (Copyright © 2008 - 2012 Aaron Patterson, Mike Dalessio, Charles Nutter, Sergio Arbeo, Patrick Mahoney, Yoko Harada; MIT Licensed)
-
-
+* [roo](https://github.com/roo-rb/roo) Temporarily used for reading the newer .xlsx files (without formatting) (Copyright © 2008-2014 Thomas Preymesser, Ben Woosley, MIT License)
+* [axslx](https://github.com/randym/axlsx) Used for writing the newer .xlsx files (with formatting) (Copyright © 2011, 2012 Randy Morgan, MIT License)
+* [Nokogiri](http://nokogiri.org/) Used for reading ODS documents (Copyright © 2008 - 2012 Aaron Patterson, Mike Dalessio, Charles Nutter, Sergio Arbeo, Patrick Mahoney, Yoko Harada; MIT Licensed)

data/lib/workbook.rb

@@ -1,6 +1,8 @@
 # -*- encoding : utf-8 -*-
 $KCODE="u" if RUBY_VERSION < "1.9"
 require_relative 'workbook/modules/cache'
+require_relative 'workbook/modules/cell'
+require_relative 'workbook/types/date'
 require_relative 'workbook/book'
 require_relative 'workbook/sheet'
 require_relative 'workbook/table'

data/lib/workbook/cell.rb

@@ -1,218 +1,9 @@
 # -*- encoding : utf-8 -*-
 
-require 'workbook/modules/type_parser'
+require 'workbook/modules/cell'
 
 module Workbook
   class Cell
-    include Workbook::Modules::TypeParser
-
-    attr_accessor :formula
-
-    # Note that these types are sorted by 'importance'
-    VALID_TYPES = [Numeric,String,Time,Date,TrueClass,FalseClass,NilClass,Workbook::NilValue,Symbol]
-
-    # Evaluates a value for class-validity
-    #
-    # @param [Numeric,String,Time,Date,TrueClass,FalseClass,NilClass,Object] value the value to evaluate
-    # @return [Boolean] returns true when the value is a valid cell value
-    def valid_value? value
-      valid_type = false
-      VALID_TYPES.each {|t| return true if value.is_a? t}
-      valid_type
-    end
-
-    # @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={}
-      self.format = options[:format]
-      self.value = value
-      @to_sym = nil
-    end
-
-    # Change the current 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, Symbol])"
-      end
-    end
-
-    # Returns the current value
-    #
-    # @return [Numeric,String,Time,Date,TrueClass,FalseClass,NilClass] a valid value
-    def value
-      @value
-    end
-
-    # Change the current format
-    #
-    # @param [Workbook::Format, Hash] f set the formatting properties of this Cell
-    def format= f
-      if f.is_a? Workbook::Format
-        @format = f
-      elsif f.is_a? Hash
-        @format = Workbook::Format.new(f)
-      elsif f.class == NilClass
-        @format = Workbook::Format.new
-      end
-    end
-
-    # Returns current format
-    #
-    # @returns [Workbook::Format] the current format
-    def format
-      @format ||= Workbook::Format.new
-    end
-
-    # Tests for equality based on its value (formatting is irrelevant)
-    #
-    # @param [Workbook::Cell] other cell to compare against
-    # @return [Boolean]
-    def ==(other)
-      if other.is_a? Cell
-        other.value == self.value
-      else
-        other == self.value
-      end
-    end
-
-    # returns true when the value of the cell is nil.
-    # @return [Boolean]
-    def nil?
-      return value.nil?
-    end
-
-    # returns a symbol representation of the cell's value
-    # @return [Symbol] a symbol representation
-    # @example
-    #
-    #     <Workbook::Cell value="yet another value">.to_sym # returns :yet_another_value
-    def to_sym
-      return @to_sym if @to_sym
-      v = nil
-      if value
-        ends_with_exclamationmark = (value[-1] == '!')
-        ends_with_questionmark = (value[-1] == '?')
-        v = value.to_s.downcase
-
-        replacements = {
-          [/[\(\)\.\?\,\!\=\$\:]/,] => '',
-          [/\&/] => 'amp',
-          [/\+/] => '_plus_',
-          [/\s/,'/_','/',"\\"] => '_',
-          ['–_','-_','+_','-'] => '',
-          ['__']=>'_',
-          ['>']=>'gt',
-          ['<']=>'lt',
-          ['á','à','â','ä','ã','å'] => 'a',
-          ['Ã','Ä','Â','À','�?','Å'] => 'A',
-          ['é','è','ê','ë'] => 'e',
-          ['Ë','É','È','Ê'] => 'E',
-          ['í','ì','î','ï'] => 'i',
-          ['�?','Î','Ì','�?'] => 'I',
-          ['ó','ò','ô','ö','õ'] => 'o',
-          ['Õ','Ö','Ô','Ò','Ó'] => 'O',
-          ['ú','ù','û','ü'] => 'u',
-          ['Ú','Û','Ù','Ü'] => 'U',
-          ['ç'] => 'c',
-          ['Ç'] => 'C',
-          ['š', 'ś'] => 's',
-          ['Š', 'Ś'] => 'S',
-          ['ž','ź'] => 'z',
-          ['Ž','Ź'] => 'Z',
-          ['ñ'] => 'n',
-          ['Ñ'] => 'N',
-          ['#'] => 'hash',
-          ['*'] => 'asterisk'
-        }
-        replacements.each do |ac,rep|
-          ac.each do |s|
-            v = v.gsub(s, rep)
-          end
-        end
-        if RUBY_VERSION < '1.9'
-          v = v.gsub(/[^\x00-\x7F]/n,'')
-        else
-          # See String#encode
-          encoding_options = {:invalid => :replace, :undef => :replace, :replace => ''}
-          v = v.encode(Encoding.find('ASCII'), encoding_options)
-        end
-        v = "#{v}!" if ends_with_exclamationmark
-        v = "#{v}?" if ends_with_questionmark
-        v = v.downcase.to_sym
-      end
-      @to_sym = v
-      return @to_sym
-    end
-
-    # Compare
-    # @param [Workbook::Cell] other cell to compare against (based on value), can compare different value-types using #compare_on_class
-    # @returns [Fixnum] -1, 0, 1
-    def <=> other
-      rv = nil
-      begin
-        rv = self.value <=> other.value
-      rescue NoMethodError
-        rv = compare_on_class other
-      end
-      if rv == nil
-        rv = compare_on_class other
-      end
-      return rv
-
-    end
-
-    # Compare on class level
-    #
-    # @param [Workbook::Cell] other cell to compare against
-    def compare_on_class other
-      other_value = nil
-      other_value = other.value if other
-      self_value = importance_of_class self.value
-      other_value = importance_of_class other_value
-      self_value <=> other_value
-    end
-
-    # Returns the importance of a value's class
-    #
-    # @param value a potential value for a cell
-    def importance_of_class value
-      VALID_TYPES.each_with_index do |c,i|
-        return i if value.is_a? c
-      end
-      return nil
-    end
-
-    def inspect
-      "<Workbook::Cell @value=#{value}>"
-    end
-
-    # convert value to string, and in case of a Date or Time value, apply formatting
-    # @return [String]
-    def to_s
-      if (value.is_a? Date or value.is_a? Time) and format[:number_format]
-        value.strftime(format[:number_format])
-      else
-        value.to_s
-      end
-    end
-
-    def colspan= c
-      @colspan = c
-    end
-    def rowspan= r
-      @rowspan = r
-    end
-
-    def colspan
-      @colspan.to_i if defined?(@colspan) and @colspan.to_i > 1
-    end
-    def rowspan
-      @rowspan.to_i if defined?(@rowspan) and @rowspan.to_i > 1
-    end
+     include Workbook::Modules::Cell
   end
 end

data/lib/workbook/column.rb

@@ -12,7 +12,25 @@ module Workbook
 
     # Returns column type, either :primary_key, :string, :text, :integer, :float, :decimal, :datetime, :date, :binary, :boolean
     def column_type
-      @column_type
+      return @column_type if @column_type
+      ind = self.index
+      table[1..500].each do |row|
+        if row[ind] and row[ind].cell_type
+          cel_column_type = row[ind].cell_type
+          if cel_column_type == @column_type or @column_type.nil?
+            @column_type = cel_column_type
+          else
+            @column_type = :string
+          end
+        end
+      end
+      return @column_type
+    end
+
+    # Returns index of the column within the table's columns-set
+    # @return [Integer, NilClass]
+    def index
+      table.columns.index self
     end
 
     def table= t
@@ -29,6 +47,18 @@ module Workbook
       end
     end
 
+    def head_value
+      begin
+        table.header[index].value
+      rescue
+        return "!noheader!"
+      end
+    end
+
+    def inspect
+      "<Workbook::Column index=#{index}, header=#{head_value}>"
+    end
+
     #default cell
     def default
       return @default

data/lib/workbook/modules/cell.rb

@@ -0,0 +1,279 @@
+# -*- encoding : utf-8 -*-
+require 'workbook/modules/type_parser'
+require 'workbook/nil_value'
+
+module Workbook
+  module Modules
+    module Cell
+      include Workbook::Modules::TypeParser
+
+
+
+      # Note that these types are sorted by 'importance'
+      VALID_TYPES = [Numeric,String,Time,Date,TrueClass,FalseClass,NilClass,Workbook::NilValue,Symbol]
+
+      # Evaluates a value for class-validity
+      #
+      # @param [Numeric,String,Time,Date,TrueClass,FalseClass,NilClass,Object] value the value to evaluate
+      # @return [Boolean] returns true when the value is a valid cell value
+      def valid_value? value
+        valid_type = false
+        VALID_TYPES.each {|t| return true if value.is_a? t}
+        valid_type
+      end
+
+      def formula
+        @formula
+      end
+
+      def formula= f
+        @formula = f
+      end
+
+      def row
+        @row
+      end
+
+      def row= r
+        @row= r
+      end
+
+      # @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={}
+        self.format = options[:format] if options[:format]
+        self.row = options[:row]
+        self.value = value
+        @to_sym = nil
+      end
+
+      # Change the current 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, Symbol])"
+        end
+      end
+
+      # Returns column type, either :primary_key, :string, :text, :integer, :float, :decimal, :datetime, :date, :binary, :boolean
+      #
+      # @return [Symbol] the type of cell, compatible with Workbook::Column'types
+      def cell_type
+        tp = case value.class.to_s
+        when "String" then :string
+        when "FalseClass" then :boolean
+        when "TrueClass" then :boolean
+        when 'Time' then :time
+        when "Date" then :date
+        when "DateTime" then :datetime
+        when "Float" then :float
+        when "Integer" then :integer
+        when "Numeric" then :integer
+        when "Fixnum" then :integer
+        when "Symbol" then :string
+        end
+      end
+
+
+      # Returns the current value
+      #
+      # @return [Numeric,String,Time,Date,TrueClass,FalseClass,NilClass] a valid value
+      def value
+        @value
+      end
+
+      # Returns the sheet its at.
+      #
+      # @return [Workbook::Table]
+      def table
+        row.table if row
+      end
+
+      # Quick assessor to the book's template, if it exists
+      #
+      # @return [Workbook::Template]
+      def template
+        row.template if row
+      end
+
+      # Change the current format
+      #
+      # @param [Workbook::Format, Hash] f set the formatting properties of this Cell
+      def format= f
+        if f.is_a? Workbook::Format
+          @workbook_format = f
+        elsif f.is_a? Hash
+          @workbook_format = Workbook::Format.new(f)
+        elsif f.class == NilClass
+          @workbook_format = Workbook::Format.new
+        end
+      end
+
+      # Returns current format
+      #
+      # @returns [Workbook::Format] the current format
+      def format
+        # return @workbook_format if @workbook_format
+        if row and template and row.header? and !@workbook_format
+          @workbook_format = template.create_or_find_format_by(:header)
+        else
+          @workbook_format ||= Workbook::Format.new
+        end
+        @workbook_format
+      end
+
+      # Tests for equality based on its value (formatting is irrelevant)
+      #
+      # @param [Workbook::Cell] other cell to compare against
+      # @return [Boolean]
+      def ==(other)
+        if other.is_a? Cell
+          other.value == self.value
+        else
+          other == self.value
+        end
+      end
+
+      # returns true when the value of the cell is nil.
+      # @return [Boolean]
+      def nil?
+        return value.nil?
+      end
+
+      # returns a symbol representation of the cell's value
+      # @return [Symbol] a symbol representation
+      # @example
+      #
+      #     <Workbook::Cell value="yet another value">.to_sym # returns :yet_another_value
+      def to_sym
+        return @to_sym if @to_sym
+        v = nil
+        if value
+          ends_with_exclamationmark = (value[-1] == '!')
+          ends_with_questionmark = (value[-1] == '?')
+          v = value.to_s.downcase
+
+          replacements = {
+            [/[\(\)\.\?\,\!\=\$\:]/,] => '',
+            [/\&/] => 'amp',
+            [/\+/] => '_plus_',
+            [/\s/,'/_','/',"\\"] => '_',
+            ['–_','-_','+_','-'] => '',
+            ['__']=>'_',
+            ['>']=>'gt',
+            ['<']=>'lt',
+            ['á','à','â','ä','ã','å'] => 'a',
+            ['Ã','Ä','Â','À','�?','Å'] => 'A',
+            ['é','è','ê','ë'] => 'e',
+            ['Ë','É','È','Ê'] => 'E',
+            ['í','ì','î','ï'] => 'i',
+            ['�?','Î','Ì','�?'] => 'I',
+            ['ó','ò','ô','ö','õ'] => 'o',
+            ['Õ','Ö','Ô','Ò','Ó'] => 'O',
+            ['ú','ù','û','ü'] => 'u',
+            ['Ú','Û','Ù','Ü'] => 'U',
+            ['ç'] => 'c',
+            ['Ç'] => 'C',
+            ['š', 'ś'] => 's',
+            ['Š', 'Ś'] => 'S',
+            ['ž','ź'] => 'z',
+            ['Ž','Ź'] => 'Z',
+            ['ñ'] => 'n',
+            ['Ñ'] => 'N',
+            ['#'] => 'hash',
+            ['*'] => 'asterisk'
+          }
+          replacements.each do |ac,rep|
+            ac.each do |s|
+              v = v.gsub(s, rep)
+            end
+          end
+          if RUBY_VERSION < '1.9'
+            v = v.gsub(/[^\x00-\x7F]/n,'')
+          else
+            # See String#encode
+            encoding_options = {:invalid => :replace, :undef => :replace, :replace => ''}
+            v = v.encode(Encoding.find('ASCII'), encoding_options)
+          end
+          v = "#{v}!" if ends_with_exclamationmark
+          v = "#{v}?" if ends_with_questionmark
+          v = v.downcase.to_sym
+        end
+        @to_sym = v
+        return @to_sym
+      end
+
+      # Compare
+      # @param [Workbook::Cell] other cell to compare against (based on value), can compare different value-types using #compare_on_class
+      # @returns [Fixnum] -1, 0, 1
+      def <=> other
+        rv = nil
+        begin
+          rv = self.value <=> other.value
+        rescue NoMethodError
+          rv = compare_on_class other
+        end
+        if rv == nil
+          rv = compare_on_class other
+        end
+        return rv
+
+      end
+
+      # Compare on class level
+      #
+      # @param [Workbook::Cell] other cell to compare against
+      def compare_on_class other
+        other_value = nil
+        other_value = other.value if other
+        self_value = importance_of_class self.value
+        other_value = importance_of_class other_value
+        self_value <=> other_value
+      end
+
+      # Returns the importance of a value's class
+      #
+      # @param value a potential value for a cell
+      def importance_of_class value
+        VALID_TYPES.each_with_index do |c,i|
+          return i if value.is_a? c
+        end
+        return nil
+      end
+
+      def inspect
+        "<Workbook::Cell @value=#{value}>"
+      end
+
+      # convert value to string, and in case of a Date or Time value, apply formatting
+      # @return [String]
+      def to_s
+        if (self.is_a? Date or self.is_a? Time) and format[:number_format]
+          value.strftime(format[:number_format])
+        elsif (self.class == Workbook::Cell)
+          value.to_s
+        else
+          super
+        end
+      end
+
+      def colspan= c
+        @colspan = c
+      end
+      def rowspan= r
+        @rowspan = r
+      end
+
+      def colspan
+        @colspan.to_i if defined?(@colspan) and @colspan.to_i > 1
+      end
+      def rowspan
+        @rowspan.to_i if defined?(@rowspan) and @rowspan.to_i > 1
+      end
+    end
+  end
+end