read_xls 0.1.0

data/lib/read_xls/record_handler.rb

@@ -0,0 +1,262 @@
+module ReadXls
+  module RecordHandler
+    RecordHandlerNotFound = Class.new(StandardError)
+
+    ARRAY                = 0x0221
+    BLANK                = 0x0201
+    SHRFMLA              = 0x00bc
+    MMS_ADD_DELETE       = 0x00C1
+    BOF                  = 0x0809
+    BOF_2                = 0x09
+    BOF_3                = 0x209
+    BOF_4                = 0x409
+    BOOLERR              = 0x0205
+    BOUNDSHEET           = 0x0085
+    CODEPAGE             = 0x0042
+    COLINFO              = 0x007d
+    CONTINUE             = 0x003c
+    DATESYSTEM           = 0x0022
+    DBCELL               = 0x00d7
+    DIMENSIONS           = 0x0200
+    EOF                  = 0x000a
+    FONT                 = 0x0031
+    FORMAT               = 0x041e
+    FORMULA              = 0x0006
+    HLINK                = 0x01b8
+    PROT4REVPASS         = 0x01bc
+    LABEL                = 0x0204
+    LABELSST             = 0x00fd
+    INTERFACEHDR         = 0x00e1
+    INTERFACEEND         = 0x00e2
+    MERGEDCELLS          = 0x00e5
+    MULBLANK             = 0x00be
+    MULRK                = 0x00bd
+    NUMBER               = 0x0203
+    RK                   = 0x027e
+    ROW                  = 0x0208
+    SST                  = 0x00fc
+    STRING               = 0x0207
+    RSTRING              = 0x00d6
+    STYLE                = 0x0293
+    STYLEEXT             = 0x0892
+    XF                   = 0x00e0
+    XFCRC                = 0x087c
+    XFEXT                = 0x087d
+    SHAREDFMLA           = 0x04bc
+    EXTSST               = 0x00ff
+    INDEX                = 0x020b
+    UNCALCED             = 0x005e
+    CALCCOUNT            = 0x000c
+    CALCMODE             = 0x000d
+    PRECISION            = 0x000e
+    REFMODE              = 0x000f
+    DELTA                = 0x0010
+    ITERATION            = 0x0011
+    SAVERECALC           = 0x005f
+    PROTECT              = 0x0012
+    WINDOWPROT           = 0x0019
+    OBJECTPROT           = 0x0063
+    SCENPROTECT          = 0x00dd
+    PASSWORD             = 0x0013
+    WRITEPROT            = 0x0086
+    FILEPASS             = 0x002f
+    WRITEACCESS          = 0x005c
+    FILESHARING          = 0x005b
+    SUPBOOK              = 0x01ae
+    PROT4REV             = 0x01af
+    EXTERNNAME           = 0x0223
+    XCT                  = 0x0059
+    CRN                  = 0x005a
+    EXTERNSHEET          = 0x0017
+    NAME                 = 0x0218
+    WINDOW1              = 0x003d
+    BACKUP               = 0x0040
+    COUNTRY              = 0x008c
+    HIDEOBJ              = 0x008d
+    PALETTE              = 0x0092
+    FNGROUPCNT           = 0x009c
+    BOOKBOOL             = 0x00da
+    TABID                = 0x013d
+    USESELFS             = 0x0160
+    DSF                  = 0x0161
+    REFRESHALL           = 0x01b7
+    WINDOW2              = 0x023e
+    SCL                  = 0x00a0
+    PANE                 = 0x0041
+    SELECTION            = 0x001d
+    HPAGEBREAKS          = 0x001b
+    VPAGEBREAKS          = 0x001a
+    HEADER               = 0x0014
+    FOOTER               = 0x0015
+    HEADERFOOTER         = 0x089c
+    HCENTER              = 0x0083
+    VCENTER              = 0x0084
+    LEFTMARGIN           = 0x0026
+    RIGHTMARGIN          = 0x0027
+    TOPMARGIN            = 0x0028
+    BOTTOMMARGIN         = 0x0029
+    PAGESETUP            = 0x00a1
+    PRINTHEADERS         = 0x002a
+    PRINTGRIDLNS         = 0x002b
+    GRIDSET              = 0x0082
+    GUTS                 = 0x0080
+    DEFROWHEIGHT         = 0x0225
+    WSBOOL               = 0x0081
+    DEFCOLWIDTH          = 0x0055
+    SORT                 = 0x0090
+    NOTE                 = 0x001c
+    OBJ                  = 0x005d
+    TXO                  = 0x0016
+    TABLESTYLES          = 0x088e
+    AUTOFILTER12         = 0x087e
+    MTRSETTINGS          = 0x089a
+    FORCEFULLCALCULATION = 0x08a3
+    RECALCID             = 0x01c1
+    THEME                = 0x0896
+    PLV                  = 0x088b
+    FEATHEADR            = 0x0867
+    FEATHEADR11          = 0x0871
+    FEATINFO             = 0x086d
+    PLS                  = 0x004d
+    EXCEL9FILE           = 0x01c0
+    BOOKEXT              = 0x0863
+    COMPRESSPICTURES     = 0x089b
+    COMPAT12             = 0x088c
+    UNKNOWN1             = 0x105c
+    UNKNOWN2             = 0x08d6
+    UNKNOWN3             = 0x00ef
+
+    MAPPINGS = {
+      BOF                  => Bof,
+      ROW                  => Row,
+      BOUNDSHEET           => Boundsheet,
+      BOOLERR              => Boolerr,
+      SST                  => Sst,
+      LABELSST             => LabelSst,
+      MULRK                => MulRk,
+      BLANK                => Blank,
+      XF                   => Xf,
+      RK                   => Rk,
+      FORMAT               => Format,
+      NUMBER               => Number,
+      FORMULA              => Formula,
+      STRING               => String,
+
+      DBCELL               => Skip,
+      INDEX                => Skip,
+      CALCMODE             => Skip,
+      INTERFACEHDR         => Skip,
+      MMS_ADD_DELETE       => Skip,
+      INTERFACEEND         => Skip,
+      WRITEACCESS          => Skip,
+      CODEPAGE             => Skip,
+      DSF                  => Skip,
+      TABID                => Skip,
+      FNGROUPCNT           => Skip,
+      WINDOWPROT           => Skip,
+      PROTECT              => Skip,
+      PASSWORD             => Skip,
+      FILEPASS             => Skip,
+      PROT4REV             => Skip,
+      PROT4REVPASS         => Skip,
+      WINDOW1              => Skip,
+      BACKUP               => Skip,
+      HIDEOBJ              => Skip,
+      DATESYSTEM           => Skip,
+      PRECISION            => Skip,
+      REFRESHALL           => Skip,
+      BOOKBOOL             => Skip,
+      FONT                 => Skip,
+      XFCRC                => Skip,
+      XFEXT                => Skip,
+      STYLE                => Skip,
+      STYLEEXT             => Skip,
+      TABLESTYLES          => Skip,
+      AUTOFILTER12         => Skip,
+      PALETTE              => Skip,
+      USESELFS             => Skip,
+      MTRSETTINGS          => Skip,
+      FORCEFULLCALCULATION => Skip,
+      COUNTRY              => Skip,
+      RECALCID             => Skip,
+      EXTSST               => Skip,
+      THEME                => Skip,
+      CALCCOUNT            => Skip,
+      REFMODE              => Skip,
+      ITERATION            => Skip,
+      DELTA                => Skip,
+      SAVERECALC           => Skip,
+      PRINTHEADERS         => Skip,
+      PRINTGRIDLNS         => Skip,
+      GRIDSET              => Skip,
+      GUTS                 => Skip,
+      DEFROWHEIGHT         => Skip,
+      WSBOOL               => Skip,
+      HEADER               => Skip,
+      FOOTER               => Skip,
+      HPAGEBREAKS          => Skip,
+      VPAGEBREAKS          => Skip,
+      HCENTER              => Skip,
+      VCENTER              => Skip,
+      LEFTMARGIN           => Skip,
+      RIGHTMARGIN          => Skip,
+      TOPMARGIN            => Skip,
+      BOTTOMMARGIN         => Skip,
+      PAGESETUP            => Skip,
+      DEFCOLWIDTH          => Skip,
+      DIMENSIONS           => Skip,
+      WINDOW2              => Skip,
+      PLV                  => Skip,
+      FEATHEADR            => Skip,
+      FEATHEADR11          => Skip,
+      FEATINFO             => Skip,
+      SELECTION            => Skip,
+      PLS                  => Skip,
+      COLINFO              => Skip,
+      EXCEL9FILE           => Skip,
+      HEADERFOOTER         => Skip,
+      BOOKEXT              => Skip,
+      COMPRESSPICTURES     => Skip,
+      COMPAT12             => Skip,
+      UNKNOWN1             => Skip,
+      UNKNOWN2             => Skip,
+      UNKNOWN3             => Skip,
+      MULBLANK             => Skip,
+
+      ARRAY                => NotImplemented,
+      SHRFMLA              => NotImplemented,
+      BOF_2                => NotImplemented,
+      BOF_3                => NotImplemented,
+      BOF_4                => NotImplemented,
+      CONTINUE             => NotImplemented,
+      EOF                  => NotImplemented,
+      HLINK                => NotImplemented,
+      LABEL                => NotImplemented,
+      MERGEDCELLS          => NotImplemented,
+      RSTRING              => NotImplemented,
+      SHAREDFMLA           => NotImplemented,
+      UNCALCED             => NotImplemented,
+      OBJECTPROT           => NotImplemented,
+      SCENPROTECT          => NotImplemented,
+      WRITEPROT            => NotImplemented,
+      FILESHARING          => NotImplemented,
+      SUPBOOK              => NotImplemented,
+      EXTERNNAME           => NotImplemented,
+      XCT                  => NotImplemented,
+      CRN                  => NotImplemented,
+      EXTERNSHEET          => NotImplemented,
+      NAME                 => NotImplemented,
+      SCL                  => NotImplemented,
+      PANE                 => NotImplemented,
+      SORT                 => NotImplemented,
+      NOTE                 => NotImplemented,
+      OBJ                  => NotImplemented,
+      TXO                  => NotImplemented
+    }
+
+    def self.call(record_number, builder, biff, record_data)
+      record_handler = MAPPINGS[record_number] || raise(RecordHandlerNotFound, "couldn't find record handler for #{record_number.to_s(16)}")
+      record_handler.call(record_number.to_s(16), builder, biff, record_data)
+    end
+  end
+end

data/lib/read_xls/record_handler/base.rb

@@ -0,0 +1,19 @@
+module ReadXls
+  module RecordHandler
+    class Base
+      attr_accessor :record_number, :builder, :biff, :record_data
+
+      def self.call(record_number, builder, biff, record_data)
+        new(record_number, builder, biff, record_data).call
+      end
+
+      def initialize(record_number, builder, biff, record_data)
+        self.record_number =record_number
+        self.builder       = builder
+        self.biff          = biff
+        self.record_data   = record_data
+      end
+    end
+  end
+end
+

data/lib/read_xls/record_handler/blank.rb

@@ -0,0 +1,11 @@
+module ReadXls
+  module RecordHandler
+    class Blank < ::ReadXls::RecordHandler::Base
+      def call
+        row, column = record_data[0, 4].unpack("v2")
+
+        builder.add_column_to_row(row, column, ::ReadXls::Evaluator::Blank.new)
+      end
+    end
+  end
+end

data/lib/read_xls/record_handler/bof.rb

@@ -0,0 +1,9 @@
+module ReadXls
+  module RecordHandler
+    class Bof < ::ReadXls::RecordHandler::Base
+      def call
+
+      end
+    end
+  end
+end

data/lib/read_xls/record_handler/boolerr.rb

@@ -0,0 +1,11 @@
+module ReadXls
+  module RecordHandler
+    class Boolerr < ::ReadXls::RecordHandler::Base
+      def call
+        row, column, _, value, _ = record_data.unpack("v3C2")
+
+        builder.add_column_to_row(row, column, ::ReadXls::Evaluator::Boolean.new(value))
+      end
+    end
+  end
+end

data/lib/read_xls/record_handler/boundsheet.rb

@@ -0,0 +1,45 @@
+module ReadXls
+  module RecordHandler
+    class Boundsheet < ::ReadXls::RecordHandler::Base
+      BYTE_LENGTH = 2
+
+      attr_accessor :position
+
+      def call
+        worksheet_builder = ::ReadXls::Workbook::WorksheetBuilder.new
+        offset            = record_data.unpack("v").first
+        self.position     = offset
+
+        loop do
+          record_number = read_byte
+          break if record_number == ::ReadXls::RecordHandler::EOF
+
+          record_length = read_byte
+          record_data   = read_data(record_length)
+
+          ::ReadXls::RecordHandler.call(
+            record_number,
+            worksheet_builder,
+            biff,
+            record_data
+          )
+        end
+
+        builder.add_worksheet_builder(worksheet_builder)
+      end
+
+      def read_data(bytes)
+        val           = biff[position, bytes]
+        self.position += bytes
+        val
+      end
+
+
+      def read_byte
+        val           = biff[position, BYTE_LENGTH].unpack("v")
+        self.position += BYTE_LENGTH
+        val.first || raise(ParsingFailedError, "expected to get value, got nil")
+      end
+    end
+  end
+end

data/lib/read_xls/record_handler/format.rb

@@ -0,0 +1,20 @@
+module ReadXls
+  module RecordHandler
+    class Format < ::ReadXls::RecordHandler::Base
+      F_HIGH_BYTE         = 0x01
+
+      def call
+        index, char_count, grbit = record_data
+                                     .byteslice(0, 5)
+                                     .unpack("v2C")
+
+        char_byte_size = (grbit & F_HIGH_BYTE) == 0 ? 1 : 2
+
+        string_length = char_count * char_byte_size
+        format_string = record_data.byteslice(5, string_length)
+
+        builder.add_format(index, format_string)
+      end
+    end
+  end
+end

data/lib/read_xls/record_handler/formula.rb

@@ -0,0 +1,17 @@
+module ReadXls
+  module RecordHandler
+    class Formula < ::ReadXls::RecordHandler::Base
+      def call
+        row, column, xf_index = record_data.byteslice(0, 6).unpack("v3")
+        result_test           = record_data.byteslice(12, 2).unpack("v").first
+        number_bytes          = record_data.byteslice(6, 8)
+
+        builder.add_column_to_row(
+          row,
+          column,
+          ::ReadXls::Evaluator::Formula.new(builder, result_test, number_bytes)
+        )
+      end
+    end
+  end
+end

data/lib/read_xls/record_handler/label_sst.rb

@@ -0,0 +1,15 @@
+module ReadXls
+  module RecordHandler
+    class LabelSst < ::ReadXls::RecordHandler::Base
+      SST_INDEX_OFFSET = 6
+      SST_INDEX_SIZE   = 4
+
+      def call
+        row, column = record_data.byteslice(0, 4).unpack("v2")
+        sst_index   = record_data.byteslice(SST_INDEX_OFFSET, SST_INDEX_SIZE).unpack("V").first
+
+        builder.add_column_to_row(row, column, ::ReadXls::Evaluator::SstString.new(sst_index, builder))
+      end
+    end
+  end
+end

data/lib/read_xls/record_handler/mul_rk.rb

@@ -0,0 +1,30 @@
+module ReadXls
+  module RecordHandler
+    class MulRk < ::ReadXls::RecordHandler::Base
+      RKREC_SIZE     = 6
+      RK_DATA_OFFSET = 4
+
+      def call
+        row, column_offset = record_data
+                               .byteslice(0, 4)
+                               .unpack("v2")
+        last_column        = record_data[-2, 2].unpack("v").first
+        number_of_columns  = last_column - column_offset + 1
+        rk_data            = record_data[RK_DATA_OFFSET..-3]
+
+        number_of_columns.times.each do |column_index|
+          rk_rec            = rk_data[(column_index * RKREC_SIZE), RKREC_SIZE]
+          ix_index, rk_bits = rk_rec.byteslice(0, RKREC_SIZE).unpack("vV")
+
+          rk_column = ::ReadXls::Evaluator::RkNumber.new(builder, rk_bits, ix_index)
+
+          builder.add_column_to_row(
+            row,
+            column_index + column_offset,
+            rk_column
+          )
+        end
+      end
+    end
+  end
+end