spreadsheet 0.6.0

data/lib/spreadsheet/excel.rb

@@ -0,0 +1,75 @@
+require 'spreadsheet'
+
+warn <<-EOS
+[DEPRECATED] By requiring 'spreadsheet/excel' you are loading a Compatibility
+             layer which provides a drop-in replacement for Spreadsheet::Excel
+             versions <= 0.3.5.1. This code will be removed in Spreadsheet
+             version 1.0.0
+EOS
+##
+# Spreadsheet::Excel Compatibility Layer.
+# Drop-in replacement for Spreadsheet::Excel version <= 0.3.5.1
+module Spreadsheet
+  module Excel
+    class ExcelCompatibleWorkbook < Workbook
+      def initialize file_path, *args
+        super *args
+        @file_path = file_path
+      end
+      def close
+        write @file_path
+      end
+    end
+    def Excel.new file_path
+      ExcelCompatibleWorkbook.new file_path
+    end
+    class Workbook
+      def add_worksheet name
+        if name.is_a? String
+          create_worksheet :name => name
+        else
+          super
+        end
+      end
+    end
+  end
+  class Worksheet
+    def write row, col, data=nil, format=nil
+      if data.is_a? Array
+        write_row row, col, data, format
+      else
+        row = row(row)
+        row[col] = data
+        row.set_format col, format
+      end
+    end
+    def write_column row, col, data=nil, format=nil
+      if data.is_a? Array
+        data.each do |token|
+          if token.is_a? Array
+            write_row row, col, token, format
+          else
+            write row, col, token, format
+          end
+          row += 1
+        end
+      else
+        write row, col, data, format
+      end
+    end
+    def write_row row, col, data=nil, format=nil
+      if data.is_a? Array
+        data.each do |token|
+          if token.is_a? Array
+            write_column row, col, token, format
+          else
+            write row, col, token, format
+          end
+          col += 1
+        end
+      else
+        write row, col, data, format
+      end
+    end
+  end
+end

data/lib/spreadsheet/excel/error.rb

@@ -0,0 +1,26 @@
+module Spreadsheet
+  module Excel
+##
+# This class encapsulates Excel Error-Codes
+class Error
+  attr_reader :code
+  ERROR_VALUES = {
+    0x00 => '#NULL!',  # Intersection of two cell ranges is empty
+    0x07 => '#DIV/0!', # Division by zero
+    0x0F => '#VALUE!', # Wrong type of operand
+    0x17 => '#REF!',   # Illegal or deleted cell reference
+    0x1D => '#NAME?',  # Wrong function or range name
+    0x24 => '#NUM!',   # Value range overflow
+    0x2A => '#N/A!',   # Argument or function not available
+  }
+  def initialize code
+    @code = code
+  end
+  ##
+  # The String value Excel associates with an Error code
+  def value
+    ERROR_VALUES.fetch @code, '#UNKNOWN'
+  end
+end
+  end
+end

data/lib/spreadsheet/excel/internals.rb

@@ -0,0 +1,322 @@
+require 'date'
+
+module Spreadsheet
+  module Excel
+##
+# Binary Formats and other configurations internal to Excel. This Module is
+# likely to shrink as Support for older Versions of Excel grows and more Binary
+# formats are moved away from here for disambiguation.
+# If you need to work with constants defined in this module and are confused by
+# names like SEDOC_ROLOC, try reading them backwards. (The reason for this weird
+# naming convention is that according to my ri, Ruby 1.9 renames Hash#index to
+# Hash#key without backward compatibility. Since I did not want to pepper my code
+# with RUBY_VERSION-checks, I settled on this strategy to make the transition to
+# Ruby 1.9 as simple as possible.
+module Internals
+  EIGHT_BYTE_DOUBLE = [0.1].pack('E').size == 8 ? 'E' : 'e'
+  CODEPAGES = {
+    367 => "ASCII",
+    437 => "IBM437", #(US)
+    720 => "IBM720", #(OEM Arabic)
+    737 => "IBM737", #(Greek)
+    775 => "IBM775", #(Baltic)
+    850 => "IBM850", #(Latin I)
+    852 => "IBM852", #(Latin II (Central European))
+    855 => "IBM855", #(Cyrillic)
+    857 => "IBM857", #(Turkish)
+    858 => "IBM858", #(Multilingual Latin I with Euro)
+    860 => "IBM860", #(Portuguese)
+    861 => "IBM861", #(Icelandic)
+    862 => "IBM862", #(Hebrew)
+    863 => "IBM863", #(Canadian (French))
+    864 => "IBM864", #(Arabic)
+    865 => "IBM865", #(Nordic)
+    866 => "IBM866", #(Cyrillic (Russian))
+    869 => "IBM869", #(Greek (Modern))
+    874 => "WINDOWS-874", #(Thai)
+    932 => "WINDOWS-932", #(Japanese Shift-JIS)
+    936 => "WINDOWS-936", #(Chinese Simplified GBK)
+    949 => "WINDOWS-949", #(Korean (Wansung))
+    950 => "WINDOWS-950", #(Chinese Traditional BIG5)
+    1200 => "UTF-16LE", #(BIFF8)
+    1250 => "WINDOWS-1250", #(Latin II) (Central European)
+    1251 => "WINDOWS-1251", #(Cyrillic)
+    1252 => "WINDOWS-1252", #(Latin I) (BIFF4-BIFF7)
+    1253 => "WINDOWS-1253", #(Greek)
+    1254 => "WINDOWS-1254", #(Turkish)
+    1255 => "WINDOWS-1255", #(Hebrew)
+    1256 => "WINDOWS-1256", #(Arabic)
+    1257 => "WINDOWS-1257", #(Baltic)
+    1258 => "WINDOWS-1258", #(Vietnamese)
+    1361 => "WINDOWS-1361", #(Korean (Johab))
+    10000 => "MACINTOSH",
+    32768 => "MACINTOSH",
+    32769 => "WINDOWS-1252", #(Latin I) (BIFF2-BIFF3)
+  }
+  SEGAPEDOC = CODEPAGES.invert
+  COLOR_CODES = {
+    0x0000 => :builtin_black,
+    0x0001 => :builtin_white,
+    0x0002 => :builtin_red,
+    0x0003 => :builtin_green,
+    0x0004 => :builtin_blue,
+    0x0005 => :builtin_yellow,
+    0x0006 => :builtin_magenta,
+    0x0007 => :builtin_cyan,
+    0x0008 => :black,
+    0x0009 => :white,
+    0x000a => :red,
+    0x000b => :lime,
+    0x000c => :blue,
+    0x000d => :yellow,
+    0x000e => :magenta,
+    0x000f => :cyan,
+    0x0010 => :brown,
+    0x0011 => :green,
+    0x0012 => :navy,
+    0x0016 => :silver,
+    0x0017 => :gray,
+    0x001d => :orange,
+    0x0024 => :purple,
+    0x0040 => :border,
+    0x0041 => :pattern_bg,
+    0x0043 => :dialog_bg,
+    0x004d => :chart_text,
+    0x004e => :chart_bg,
+    0x004f => :chart_border,
+    0x0050 => :tooltip_bg,
+    0x0051 => :tooltip_text,
+    0x7fff => :text,
+  }
+  SEDOC_ROLOC = COLOR_CODES.invert.update( :aqua    => 0x000f,
+                                           :fuchsia => 0x000e,
+                                           :grey    => 0x0017 )
+  BINARY_FORMATS = {
+    :blank      => 'v3',
+    :boolerr    => 'v3C2',
+    :font       => 'v5C3x',
+    :labelsst   => 'v3V',
+    :number     => "v3#{EIGHT_BYTE_DOUBLE}",
+    :rk         => 'v3V',
+    :row        => 'v5Cv',
+    :xf         => 'v3C4V2v',
+  }
+  # From BIFF5 on, the built-in number formats will be omitted. The built-in
+  # formats are dependent on the current regional settings of the operating
+  # system. The following table shows which number formats are used by
+  # default in a US-English environment. All indexes from 0 to 163 are
+  # reserved for built-in formats.
+  BUILTIN_FORMATS = { # TODO: locale support
+     0 => 'General',
+     1 => '0',
+     2 => '0.00',
+     3 => '#,##0',
+     4 => '#,##0.00',
+     5 => '"$"#,##0_);("$"#,##0)',
+     6 => '"$"#,##0_);[Red]("$"#,##0)',
+     7 => '"$"#,##0.00_);("$"#,##0.00)',
+     8 => '"$"#,##0.00_);[Red]("$"#,##0.00)',
+     9 => '0%',
+    10 => '0.00%',
+    11 => '0.00E+00',
+    12 => '# ?/?',
+    13 => '# ??/??',
+    14 => 'M/D/YY',
+    15 => 'D-MMM-YY',
+    16 => 'D-MMM',
+    17 => 'MMM-YY',
+    18 => 'h:mm AM/PM',
+    19 => 'h:mm:ss AM/PM',
+    20 => 'h:mm',
+    21 => 'h:mm:ss',
+    22 => 'M/D/YY h:mm',
+    37 => '_(#,##0_);(#,##0)',
+    38 => '_(#,##0_);[Red](#,##0)',
+    39 => '_(#,##0.00_);(#,##0.00)',
+    40 => '_(#,##0.00_);[Red](#,##0.00)',
+    41 => '_("$"* #,##0_);_("$"* (#,##0);_("$"* "-"_);_(@_)',
+    42 => '_(* #,##0_);_(* (#,##0);_(* "-"_);_(@_)',
+    43 => '_("$"* #,##0.00_);_("$"* (#,##0.00);_("$"* "-"??_);_(@_)',
+    44 => '_(* #,##0.00_);_(* (#,##0.00);_(* "-"??_);_(@_)',
+    45 => 'mm:ss',
+    46 => '[h]:mm:ss',
+    47 => 'mm:ss.0',
+    48 => '##0.0E+0',
+    49 => '@',
+  }
+  BUILTIN_STYLES = {
+    0x00 => 'Normal',
+    0x01 => 'RowLevel_lv',
+    0x02 => 'ColLevel_lv',
+    0x03 => 'Comma',
+    0x04 => 'Currency',
+    0x05 => 'Percent',
+    0x06 => 'Comma',
+    0x07 => 'Currency',
+    0x08 => 'Hyperlink',
+    0x09 => 'Followed Hyperlink',
+  }
+  ESCAPEMENT_TYPES = {
+    0x0001 => :superscript,
+    0x0002 => :subscript,
+  }
+  SEPYT_TNEMEPACSE = ESCAPEMENT_TYPES.invert
+  FONT_ENCODINGS = {
+    0x01 => :default,
+    0x02 => :symbol,
+    0x4d => :apple_roman,
+    0x80 => :shift_jis,
+    0x81 => :korean_hangul,
+    0x82 => :korean_johab,
+    0x86 => :chinese_simplified,
+    0x88 => :chinese_traditional,
+    0xa1 => :greek,
+    0xa2 => :turkish,
+    0xa3 => :vietnamese,
+    0xb1 => :hebrew,
+    0xb2 => :arabic,
+    0xba => :baltic,
+    0xcc => :cyrillic,
+    0xde => :thai,
+    0xee => :latin2,
+    0xff => :oem_latin1,
+  }
+  SGNIDOCNE_TNOF = FONT_ENCODINGS.invert
+  FONT_FAMILIES = {
+    0x01 => :roman,
+    0x02 => :swiss,
+    0x03 => :modern,
+    0x04 => :script,
+    0x05 => :decorative,
+  }
+  SEILIMAF_TNOF = FONT_FAMILIES.invert
+  FONT_WEIGHTS = {
+    :bold   => 700,
+    :normal => 400,
+  }
+  LEAP_ERROR = Date.new 1900, 2, 28
+  OPCODES = {
+    :blank        => 0x0201,
+    :boolerr      => 0x0205,
+    :boundsheet   => 0x0085,
+    :codepage     => 0x0042,
+    :continue     => 0x003c,
+    :datemode     => 0x0022,
+    :dbcell       => 0x0a0b,
+    :dimensions   => 0x0200,
+    :eof          => 0x000a,
+    :extsst       => 0x00ff,
+    :font         => 0x0031,
+    :format       => 0x041e,
+    :formula      => 0x0006,
+    :index        => 0x020b,
+    :label        => 0x0204,
+    :labelsst     => 0x00fd,
+    :mulblank     => 0x00be,
+    :mulrk        => 0x00bd,
+    :number       => 0x0203,
+    :rk           => 0x027e,
+    :row          => 0x0208,
+    :rstring      => 0x00d6,
+    :sst          => 0x00fc,
+    :string       => 0x0207,
+    :style        => 0x0293,
+    :uncalced     => 0x005e,
+    :xf           => 0x00e0,
+    ########################## Unhandled Opcodes ################################
+    ########################## ○  Calculation Settings Block ➜ 5.3
+    :calccount    => 0x000c, # ○  CALCCOUNT ➜ 6.14
+    :calcmode     => 0x000d, # ○  CALCMODE ➜ 6.15
+    :precision    => 0x000e, # ○  PRECISION ➜ 6.74 (moved to Workbook Globals
+                             #                      Substream in BIFF5-BIFF8)
+    :refmode      => 0x000f, # ○  REFMODE ➜ 6.80
+    :delta        => 0x0010, # ○  DELTA ➜ 6.30
+    :iteration    => 0x0011, # ○  ITERATION ➜ 6.57
+    :saverecalc   => 0x005f, # ○  SAVERECALC ➜ 6.85 (BIFF3-BIFF8 only)
+    ########################## ○  Workbook Protection Block ➜ 5.18
+    :protect      => 0x0012, # ○  PROTECT
+                             #    Worksheet contents: 1 = protected (➜ 6.77)
+    :windowprot   => 0x0019, # ○  WINDOWPROTECT Window settings: 1 = protected
+                             #                  (BIFF4W only, ➜ 6.110)
+    :objectprot   => 0x0063, # ○  OBJECTPROTECT
+                             #    Embedded objects: 1 = protected (➜ 6.69)
+    :scenprotect  => 0x00dd, # ○  SCENPROTECT
+                             #    Scenarios: 1 = protected (BIFF5-BIFF8, ➜ 6.86)
+    :password     => 0x0013, # ○  PASSWORD Hash value of the password;
+                             #             0   = no password (➜ 6.72)
+    ########################## ○  File Protection Block ➜ 5.19
+    :writeprot    => 0x0086, # ○  WRITEPROT File is write protected
+                             #    (BIFF3-BIFF8, ➜ 6.112), password in FILESHARING
+    :filepass     => 0x002f, # ○  FILEPASS File is read/write-protected,
+                             #             encryption information (➜ 6.41)
+    :writeaccess  => 0x005c, # ○  WRITEACCESS User name (BIFF3-BIFF8, ➜ 6.111)
+    :filesharing  => 0x005b, # ○  FILESHARING File sharing options
+                             #    (BIFF3-BIFF8, ➜ 6.42)
+    ########################## ○  Link Table ➜ 5.10.3
+                             # ●● SUPBOOK Block(s)
+                             #    Settings for a referenced document
+    :supbook      => 0x01ae, #    ●  SUPBOOK ➜ 6.100
+    :externname   => 0x0223, #    ○○ EXTERNNAME ➜ 6.38
+    :xct          => 0x0059, #    ○○ ●  XCT ➜ 6.114
+    :crn          => 0x005a, #       ●● CRN ➜ 6.24
+    :externsheet  => 0x0017, # ●  EXTERNSHEET ➜ 6.39
+    :name         => 0x0218, # ○○ NAME ➜ 6.66
+    ##########################
+    :window1      => 0x003d, # ●  WINDOW1 ➜ 6.108 (has information on
+                             #              which Spreadsheet is 'active')
+    :backup       => 0x0040, # ○  BACKUP ➜ 6.5
+    :country      => 0x008c, # ○  COUNTRY (Make writeable?) ➜ 6.23
+    :hideobj      => 0x008d, # ○  HIDEOBJ ➜ 6.52
+    :palette      => 0x0092, # ○  PALETTE ➜ 6.70
+    :fngroupcnt   => 0x009c, # ○  FNGROUPCOUNT
+    :bookbool     => 0x00da, # ○  BOOKBOOL ➜ 6.9
+    :tabid        => 0x013d, # ○  TABID
+    :useselfs     => 0x0160, # ○  USESELFS (Natural Language Formulas) ➜ 6.105
+    :dsf          => 0x0161, # ○  DSF (Double Stream File) ➜ 6.32
+    :refreshall   => 0x01b7, # ○  REFRESHALL
+    ########################## ○  Page Settings Block ➜ 5.4
+    :hpagebreaks  => 0x001b, # ○  HORIZONTALPAGEBREAKS ➜ 6.54
+    :vpagebreaks  => 0x001a, # ○  VERTICALPAGEBREAKS ➜ 6.107
+    :header       => 0x0014, # ○  HEADER ➜ 6.51
+    :footer       => 0x0015, # ○  FOOTER ➜ 6.44
+    :hcenter      => 0x0083, # ○  HCENTER ➜ 6.50 (BIFF3-BIFF8 only)
+    :vcenter      => 0x0084, # ○  VCENTER ➜ 6.106 (BIFF3-BIFF8 only)
+    :leftmargin   => 0x0026, # ○  LEFTMARGIN ➜ 6.62
+    :rightmargin  => 0x0027, # ○  RIGHTMARGIN ➜ 6.81
+    :topmargin    => 0x0028, # ○  TOPMARGIN ➜ 6.103
+    :bottommargin => 0x0029, # ○  BOTTOMMARGIN ➜ 6.11
+                             # ○  PLS (opcode unknown)
+    :setup        => 0x00a1, # ○  SETUP ➜ 6.89 (BIFF4-BIFF8 only)
+    :bitmap       => 0x00e9, # ○  BITMAP ➜ 6.6 (Background-Bitmap, BIFF8 only)
+    ##########################
+    :printheaders => 0x002a, # ○  PRINTHEADERS ➜ 6.76
+    :printgridlns => 0x002b, # ○  PRINTGRIDLINES ➜ 6.75
+    :gridset      => 0x0082, # ○  GRIDSET ➜ 6.48
+    :guts         => 0x0080, # ○  GUTS ➜ 6.49
+    :defrowheight => 0x0225, # ○  DEFAULTROWHEIGHT ➜ 6.28
+    :wsbool       => 0x0081, # ○  WSBOOL ➜ 6.113
+    :defcolwidth  => 0x0055, # ○  DEFCOLWIDTH ➜ 6.29
+    :colinfo      => 0x007d, # ○○ COLINFO ➜ 6.18
+    :sort         => 0x0090, # ○  SORT ➜ 6.95
+  }
+=begin ## unknown opcodes
+0x00bf, 0x00c0, 0x00c1, 0x00e1, 0x00e2, 0x00eb, 0x01af, 0x01bc
+=end
+  SEDOCPO = OPCODES.invert
+  TWIPS = 20
+  UNDERLINE_TYPES = {
+    0x0001 => :single,
+    0x0002 => :double,
+    0x0021 => :single_accounting,
+    0x0022 => :double_accounting,
+  }
+  SEPYT_ENILREDNU = UNDERLINE_TYPES.invert
+  def binfmt key
+    BINARY_FORMATS[key]
+  end
+  def opcode key
+    OPCODES[key]
+  end
+end
+  end
+end

data/lib/spreadsheet/excel/internals/biff5.rb

@@ -0,0 +1,17 @@
+module Spreadsheet
+  module Excel
+    module Internals
+##
+# Binary Formats and other configurations internal to Biff5. This Module is
+# likely to be expanded as Support for older Versions of Excel grows.
+module Biff5
+  BINARY_FORMATS = {
+    :dimensions => 'v5',
+  }
+  def binfmt key # :nodoc:
+    BINARY_FORMATS.fetch key do super end
+  end
+end
+    end
+  end
+end

data/lib/spreadsheet/excel/internals/biff8.rb

@@ -0,0 +1,19 @@
+module Spreadsheet
+  module Excel
+    module Internals
+##
+# Binary Formats and other configurations internal to Biff8. This Module is
+# likely to be expanded as Support for older Versions of Excel grows and more
+# Binary formats are moved here for disambiguation.
+module Biff8
+  BINARY_FORMATS = {
+    :bof        => 'v4V2',
+    :dimensions => 'V2v2x2',
+  }
+  def binfmt key # :nodoc:
+    BINARY_FORMATS.fetch key do super end
+  end
+end
+    end
+  end
+end