workbook 0.4.6.0 → 0.4.7

data/lib/workbook/modules/raw_objects_storage.rb

@@ -11,8 +11,7 @@ module Workbook
 
       # Returns true if there is a template for a certain class, otherwise false
       def has_raw_for? raw_object_class
-        raws.each { |tc,t| return true if tc == raw_object_class}
-        return false
+        available_raws.include? raw_object_class
       end
 
       # Returns raw data stored for a type of raw object (if available)
@@ -27,6 +26,12 @@ module Workbook
         @raws = {}
       end
 
+      # Lists the classes for which raws are available
+      # @return Array<Object> array with the classes available
+      def available_raws
+        raws.keys
+      end
+
       # Return all raw data references
       def raws
         @raws = {} unless defined? @raws

data/lib/workbook/readers/ods_reader.rb

@@ -10,7 +10,7 @@ module Workbook
         file_obj = file_obj.path if file_obj.is_a? File
         content = ""
         styles = ""
-        Zip::ZipFile.open(file_obj) do |zipfile|
+        Zip::File.open(file_obj) do |zipfile|
           zipfile.entries.each do |file|
             styles = zipfile.read(file.name) if file.name == "styles.xml"
             content = zipfile.read(file.name) if file.name == "content.xml"

data/lib/workbook/readers/xls_reader.rb

@@ -1,9 +1,12 @@
 # -*- encoding : utf-8 -*-
 require 'spreadsheet'
+require 'workbook/readers/xls_shared'
+
 
 module Workbook
   module Readers
     module XlsReader
+      include Workbook::Readers::XlsShared
 
       def load_xls file_obj
         begin
@@ -27,63 +30,66 @@ module Workbook
         number_of_worksheets = xls_spreadsheet.worksheets.count
         (0..number_of_worksheets-1).each do |si|
           xls_sheet = xls_spreadsheet.worksheets[si]
-          begin
-            number_of_rows = xls_spreadsheet.worksheets[si].count
-            s = create_or_open_sheet_at(si)
-            (0..number_of_rows-1).each do |ri|
-              xls_row = xls_sheet.row(ri)
-              r = s.table.create_or_open_row_at(ri)
-              col_widths = xls_sheet.columns.collect{|c| c.width if c}
-              xls_row.each_with_index do |xls_cell,ci|
+          if [:visible, :hidden, nil].include? xls_sheet.visibility # don't read :strong_hidden sheets, symmetrical to the writer
+            begin
+              number_of_rows = xls_sheet.count
+              s = create_or_open_sheet_at(si)
+              s.name = xls_sheet.name
+              (0..number_of_rows-1).each do |ri|
+                xls_row = xls_sheet.row(ri)
+                r = s.table.create_or_open_row_at(ri)
+                col_widths = xls_sheet.columns.collect{|c| c.width if c}
+                xls_row.each_with_index do |xls_cell,ci|
 
-                begin
-                  r[ci] = Workbook::Cell.new xls_cell
-                  r[ci].parse!
-                rescue ArgumentError => e
-                  if e.message.match('not a Spreadsheet::Formula')
-                    v = xls_cell.value
-                    if v.class == Float and xls_row.format(ci).date?
-                      xls_row[ci] = v
-                      v = xls_row.datetime(ci)
-                    end
-                    if v.is_a? Spreadsheet::Excel::Error
-                      v = "----!"
+                  begin
+                    r[ci] = Workbook::Cell.new xls_cell
+                    r[ci].parse!
+                  rescue ArgumentError => e
+                    if e.message.match('not a Spreadsheet::Formula')
+                      v = xls_cell.value
+                      if v.class == Float and xls_row.format(ci).date?
+                        xls_row[ci] = v
+                        v = xls_row.datetime(ci)
+                      end
+                      if v.is_a? Spreadsheet::Excel::Error
+                        v = "----!"
+                      end
+                      r[ci] = Workbook::Cell.new v
+                    elsif e.message.match('not a Spreadsheet::Link')
+                      r[ci] = Workbook::Cell.new xls_cell.to_s
+                    elsif e.message.match('not a Spreadsheet::Link')
+                      r[ci] = Workbook::Cell.new xls_cell.to_s
+                    elsif e.message.match('not a Spreadsheet::Excel::Error')
+                      r[ci] = "._."
+                    else
+                      r[ci] = "._."  # raise e (we're going to be silent for now)
                     end
-                    r[ci] = Workbook::Cell.new v
-                  elsif e.message.match('not a Spreadsheet::Link')
-                    r[ci] = Workbook::Cell.new xls_cell.to_s
-                  elsif e.message.match('not a Spreadsheet::Link')
-                    r[ci] = Workbook::Cell.new xls_cell.to_s
-                  elsif e.message.match('not a Spreadsheet::Excel::Error')
-                    r[ci] = "._."
-                  else
-                    r[ci] = "._."  # raise e (we're going to be silent for now)
                   end
-                end
-                xls_format = xls_row.format(ci)
-                col_width = nil
+                  xls_format = xls_row.format(ci)
+                  col_width = nil
 
-                if ri == 0
-                  col_width = col_widths[ci]
-                end
-                f = template.create_or_find_format_by "object_id_#{xls_format.object_id}",col_width
-                f[:width]= col_width
-                f[:rotation] = xls_format.rotation if xls_format.rotation
-                f[:background_color] = xls_color_to_html_hex(xls_format.pattern_fg_color)
-                f[:number_format] = ms_formatting_to_strftime(xls_format.number_format)
-                f[:text_direction] = xls_format.text_direction
-                f[:font_family] = "#{xls_format.font.name}, #{xls_format.font.family}"
-                f[:font_weight] = xls_format.font.weight
-                f[:color] = xls_color_to_html_hex(xls_format.font.color)
+                  if ri == 0
+                    col_width = col_widths[ci]
+                  end
+                  f = template.create_or_find_format_by "object_id_#{xls_format.object_id}",col_width
+                  f[:width]= col_width
+                  f[:rotation] = xls_format.rotation if xls_format.rotation
+                  f[:background_color] = xls_color_to_html_hex(xls_format.pattern_fg_color)
+                  f[:number_format] = ms_formatting_to_strftime(xls_format.number_format)
+                  f[:text_direction] = xls_format.text_direction
+                  f[:font_family] = "#{xls_format.font.name}, #{xls_format.font.family}"
+                  f[:font_weight] = xls_format.font.weight
+                  f[:color] = xls_color_to_html_hex(xls_format.font.color)
 
-                f.add_raw xls_format
+                  f.add_raw xls_format
 
-                r[ci].format = f
+                  r[ci].format = f
+                end
               end
+            rescue TypeError
+              puts "WARNING: Failed at worksheet (#{si})... ignored"
+              #ignore SpreadsheetGem can be buggy...
             end
-          rescue TypeError
-            puts "WARNING: Failed at worksheet (#{si})... ignored"
-            #ignore SpreadsheetGem can be buggy...
           end
         end
       end
@@ -92,12 +98,6 @@ module Workbook
       def xls_color_to_html_hex color_sym
         Workbook::Book::XLS_COLORS[color_sym] ? Workbook::Book::XLS_COLORS[color_sym] : "#000000"
       end
-
-      def ms_formatting_to_strftime ms_nr_format
-        ms_nr_format = ms_nr_format.downcase
-        return nil if ms_nr_format == 'general'
-        ms_nr_format.gsub('yyyy','%Y').gsub('dddd','%A').gsub('mmmm','%B').gsub('ddd','%a').gsub('mmm','%b').gsub('yy','%y').gsub('dd','%d').gsub('mm','%m').gsub('y','%y').gsub('%%y','%y').gsub('d','%e').gsub('%%e','%d').gsub('m','%m').gsub('%%m','%m').gsub(';@','').gsub('\\','')
-      end
     end
   end
 end

data/lib/workbook/readers/xls_shared.rb

@@ -2,6 +2,53 @@
 module Workbook
   module Readers
     module XlsShared
+      def ms_formatting_to_strftime ms_nr_format
+        if ms_nr_format
+          ms_nr_format = ms_nr_format.to_s.downcase
+          return nil if ms_nr_format == 'general' or ms_nr_format == ""
+          translation_table = {
+            'yyyy'=>'%Y',
+            'dddd'=>'%A',
+            'mmmm'=>'%B',
+            'ddd'=>'%a',
+            'mmm'=>'%b',
+            'yy'=>'%y',
+            'dd'=>'%d',
+            'mm'=>'%m',
+            'y'=>'%y',
+            '%%y'=>'%y',
+            'd'=>'%e',
+            '%%e'=>'%d',
+            'm'=>'%m',
+            '%%m'=>'%m',
+            ';@'=>'',
+            '\\'=>''
+          }
+          translation_table.each{|k,v| ms_nr_format.gsub!(k,v) }
+          ms_nr_format
+        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
+
       XLS_COLORS = {:xls_color_1=>'#000000',
         :xls_color_2=>'#FFFFFF',
         :xls_color_3=>'#FF0000',

data/lib/workbook/readers/xlsx_reader.rb

@@ -1,136 +1,19 @@
 # -*- encoding : utf-8 -*-
 require 'rubyXL'
+require 'workbook/readers/xls_shared'
 
-# Monkeypatching rubyXL, pull request submitted: https://github.com/gilt/rubyXL/pull/47
-module RubyXL
-  class Workbook
-
-    # Improves upon date format detection
-    def is_date_format?(num_fmt)
-      num_fmt = num_fmt.to_s
-      num_fmt.downcase!
-      skip_chars = ['$', '-', '+', '/', '(', ')', ':', ' ']
-      num_chars = ['0', '#', '?']
-      non_date_formats = ['0.00e+00', '##0.0e+0', 'general', '@']
-      date_chars = ['y','m','d','h','s']
-
-      state = 0
-      s = ''
-      num_fmt.split(//).each do |c|
-        if state == 0
-          if c == '"'
-            state = 1
-          elsif ['\\', '_', '*'].include?(c)
-            state = 2
-          elsif skip_chars.include?(c)
-            next
-          else
-            s << c
-          end
-        elsif state == 1
-          if c == '"'
-            state = 0
-          end
-        elsif state == 2
-          state = 0
-        end
-      end
-      s.gsub!(/\[[^\]]*\]/, '')
-      if non_date_formats.include?(s)
-        return false
-      end
-      separator = ';'
-      got_sep = 0
-      date_count = 0
-      num_count = 0
-      s.split(//).each do |c|
-        if date_chars.include?(c)
-          date_count += 1
-        elsif num_chars.include?(c)
-          num_count += 1
-        elsif c == separator
-          got_sep = 1
-        end
-      end
-      if date_count > 0 && num_count == 0
-        return true
-      elsif num_count > 0 && date_count == 0
-        return false
-      elsif date_count
-        # ambiguous result
-      elsif got_sep == 0
-        # constant result
-      end
-      return date_count > num_count
-    end
-  end
-end
-# end monkey patch submitted
-
-module RubyXL
-  class Workbook
-    def num_fmts_by_id
-      return @num_fmts_hash unless @num_fmts_hash.nil?
-      @num_fmts_hash={1=>{:attributes=>{:formatCode=>'0'}},
-        2=>{:attributes=>{:formatCode=>'0.00'}},
-        3=>{:attributes=>{:formatCode=>'#, ##0'}},
-        4=>{:attributes=>{:formatCode=>'#, ##0.00'}},
-        5=>{:attributes=>{:formatCode=>'$#, ##0_);($#, ##0)'}},
-        6=>{:attributes=>{:formatCode=>'$#, ##0_);[Red]($#, ##0)'}},
-        7=>{:attributes=>{:formatCode=>'$#, ##0.00_);($#, ##0.00)'}},
-        8=>{:attributes=>{:formatCode=>'$#, ##0.00_);[Red]($#, ##0.00)'}},
-        9=>{:attributes=>{:formatCode=>'0%'}},
-        10=>{:attributes=>{:formatCode=>'0.00%'}},
-        11=>{:attributes=>{:formatCode=>'0.00E+00'}},
-        12=>{:attributes=>{:formatCode=>'# ?/?'}},
-        13=>{:attributes=>{:formatCode=>'# ??/??'}},
-        14=>{:attributes=>{:formatCode=>'m/d/yyyy'}},
-        15=>{:attributes=>{:formatCode=>'d-mmm-yy'}},
-        16=>{:attributes=>{:formatCode=>'d-mmm'}},
-        17=>{:attributes=>{:formatCode=>'mmm-yy'}},
-        18=>{:attributes=>{:formatCode=>'h:mm AM/PM'}},
-        19=>{:attributes=>{:formatCode=>'h:mm:ss AM/PM'}},
-        20=>{:attributes=>{:formatCode=>'h:mm'}},
-        21=>{:attributes=>{:formatCode=>'h:mm:ss'}},
-        22=>{:attributes=>{:formatCode=>'m/d/yyyy h:mm'}},
-        37=>{:attributes=>{:formatCode=>'#, ##0_);(#, ##0)'}},
-        38=>{:attributes=>{:formatCode=>'#, ##0_);[Red](#, ##0)'}},
-        39=>{:attributes=>{:formatCode=>'#, ##0.00_);(#, ##0.00)'}},
-        40=>{:attributes=>{:formatCode=>'#, ##0.00_);[Red](#, ##0.00)'}},
-        45=>{:attributes=>{:formatCode=>'mm:ss'}},
-        46=>{:attributes=>{:formatCode=>'[h]:mm:ss'}},
-        47=>{:attributes=>{:formatCode=>'mm:ss.0'}},
-        48=>{:attributes=>{:formatCode=>'##0.0E+0'}},
-      49=>{:attributes=>{:formatCode=>'@'}}}
-      if num_fmts and num_fmts[:numFmt]
-        num_fmts[:numFmt].each do |num_fmt|
-          @num_fmts_hash[num_fmt[:attributes][:numFmtId]]=num_fmt
-        end
-      end
-      return @num_fmts_hash
-    end
-  end
-end
-
-# other monkey patch
-module RubyXL
-  class Cell
-    def number_format
-      if !@value.is_a?(String)
-        if @workbook.num_fmts_by_id
-          num_fmt_id = xf_id()[:numFmtId]
-          tmp_num_fmt = @workbook.num_fmts_by_id[num_fmt_id]
-          return (tmp_num_fmt &&tmp_num_fmt[:attributes] && tmp_num_fmt[:attributes][:formatCode]) ? tmp_num_fmt[:attributes][:formatCode] : nil
-        end
-      end
-    end
-  end
-end
-# end of monkey patch
 
 module Workbook
   module Readers
     module XlsxReader
+      include Workbook::Readers::XlsShared
+
+      # Load method for .xlsm files, an office open file format, hence compatible with .xlsx (it emphasizes that it contains macros)
+      #
+      # @param [String, File] file_obj   a string with a reference to the file to be written to
+      def load_xlsm file_obj
+        self.load_xlsx file_obj
+      end
       def load_xlsx file_obj
         file_obj = file_obj.path if file_obj.is_a? File
         sp = RubyXL::Parser.parse(file_obj)
@@ -149,43 +32,41 @@ module Workbook
           rescue
             # Column widths couldn't be read, no big deal...
           end
+
           worksheet.each_with_index do |row, ri|
-            r = s.table.create_or_open_row_at(ri)
+            if row
+              r = s.table.create_or_open_row_at(ri)
+              row.cells.each_with_index do |cell,ci|
+                if cell.nil?
+                  r[ci] = Workbook::Cell.new nil
+                else
+                  r[ci] = Workbook::Cell.new cell.value
+                  r[ci].parse!
+                  xls_format = cell.style_index
+                  col_width = nil
 
-            row.each_with_index do |cell,ci|
-              if cell.nil?
-                r[ci] = Workbook::Cell.new nil
-              else
-                r[ci] = Workbook::Cell.new cell.value
-                r[ci].parse!
-                xls_format = cell.style_index
-                col_width = nil
+                  if ri == 0
+                    col_width = col_widths[ci]
+                  end
+                  f = template.create_or_find_format_by "style_index_#{cell.style_index}", col_width
+                  f[:width]= col_width
+                  background_color = cell.fill_color
+                  background_color = (background_color.length == 8) ? background_color[2..8] : background_color #ignoring alpha for now.
+                  f[:background_color] = "##{background_color}"
 
-                if ri == 0
-                  col_width = col_widths[ci]
-                end
-                f = template.create_or_find_format_by "style_index_#{cell.style_index}", col_width
-                f[:width]= col_width
-                f[:background_color] = "##{cell.fill_color}"
-                f[:number_format] = ms_formatting_to_strftime(cell.number_format)
-                f[:font_family] = cell.font_name
-                f[:color] = "##{cell.font_color}"
+                  f[:number_format] = ms_formatting_to_strftime(cell.number_format)
+                  # f[:font_family] = cell.font_name
+                  # f[:color] = "##{cell.font_color}"
 
-                f.add_raw xls_format
+                  f.add_raw xls_format
 
-                r[ci].format = f
+                  r[ci].format = f
+                end
               end
             end
           end
         end
       end
-      def ms_formatting_to_strftime ms_nr_format
-        if ms_nr_format
-          ms_nr_format = ms_nr_format.to_s.downcase
-          return nil if ms_nr_format == 'general' or ms_nr_format == ""
-          ms_nr_format.gsub('yyyy','%Y').gsub('dddd','%A').gsub('mmmm','%B').gsub('ddd','%a').gsub('mmm','%b').gsub('yy','%y').gsub('dd','%d').gsub('mm','%m').gsub('y','%y').gsub('%%y','%y').gsub('d','%e').gsub('%%e','%d').gsub('m','%m').gsub('%%m','%m').gsub(';@','').gsub('\\','')
-        end
-      end
     end
   end
 end

data/lib/workbook/row.rb

@@ -1,6 +1,9 @@
 # -*- encoding : utf-8 -*-
+
 module Workbook
   class Row < Array
+    include Workbook::Modules::Cache
+
     alias_method :compare_without_header, :<=>
     attr_accessor :placeholder     # The placeholder attribute is used in compares (corresponds to newly created or removed lines (depending which side you're on)
     attr_accessor :format
@@ -57,13 +60,45 @@ module Workbook
       end
     end
 
+    # Add cell
+    # @param [Workbook::Cell, Numeric,String,Time,Date,TrueClass,FalseClass,NilClass] cell or value to add
+    def push(cell)
+      cell = Workbook::Cell.new(cell) unless cell.class == Workbook::Cell
+      super(cell)
+    end
+
+    # Add cell
+    # @param [Workbook::Cell, Numeric,String,Time,Date,TrueClass,FalseClass,NilClass] cell or value to add
+    def <<(cell)
+      cell = Workbook::Cell.new(cell) unless cell.class == Workbook::Cell
+      super(cell)
+    end
+
+    # plus
+    # @param [Workbook::Row, Array] row to add
+    # @return [Workbook::Row] a new row, not linked to the table
+    def +(row)
+      rv = super(row)
+      rv = Workbook::Row.new(rv) unless rv.class == Workbook::Row
+      return rv
+    end
+
+    # concat
+    # @param [Workbook::Row, Array] row to add
+    # @return [self] self
+    def concat(row)
+      row = Workbook::Row.new(row) unless row.class == Workbook::Row
+      super(row)
+    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
     #   row[1] #=> <Cell value="a">
     #   row[:a] #=> <Cell value="a">
     #
-    # @param [Fixnum, Symbol] index_or_hash
+    # @param [Fixnum, Symbol, String] index_or_hash that identifies the column (strings are converted to symbols)
     # @return [Workbook::Cell, nil]
     def [](index_or_hash)
       if index_or_hash.is_a? Symbol
@@ -73,6 +108,9 @@ module Workbook
         rescue NoMethodError
         end
         return rv
+      elsif index_or_hash.is_a? String
+        symbolized = Workbook::Cell.new(index_or_hash).to_sym
+        self[symbolized]
       else
         if index_or_hash
           return to_a[index_or_hash]
@@ -82,17 +120,20 @@ module Workbook
 
     # 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
+    # @example Lookup using fixnum or header value encoded as symbol (strings are converted to symbols)
     #   row[1] #=> <Cell value="a">
     #   row[:a] #=> <Cell value="a">
     #
-    # @param [Fixnum, Symbol] index_or_hash
+    # @param [Fixnum, Symbol, String] index_or_hash that identifies the column
     # @param [String, Fixnum, NilClass, Date, DateTime, Time, Float] value
     # @return [Workbook::Cell, nil]
     def []= (index_or_hash, value)
       index = index_or_hash
       if index_or_hash.is_a? Symbol
         index = table_header_keys.index(index_or_hash)
+      elsif index_or_hash.is_a? String
+        symbolized = Workbook::Cell.new(index_or_hash).to_sym
+        index = table_header_keys.index(symbolized)
       end
 
       value_celled = Workbook::Cell.new
@@ -144,7 +185,9 @@ module Workbook
     # Converts a row to an array of symbol representations of the row content, see also: Workbook::Cell#to_sym
     # @return [Array<Symbol>] returns row as an array of symbols
     def to_symbols
-      collect{|c| c.to_sym}
+      fetch_cache(:to_symbols){
+        collect{|c| c.to_sym}
+      }
     end
 
     # Converts the row to an array of Workbook::Cell's