read_xls 0.1.0

data/lib/read_xls/record_handler/not_implemented.rb

@@ -0,0 +1,11 @@
+module ReadXls
+  module RecordHandler
+    class NotImplemented < ::ReadXls::RecordHandler::Base
+      RecordHandlerNotImplementedError = Class.new(StandardError)
+
+      def call
+        raise RecordHandlerNotImplementedError, "there is no implementation for #{record_number}"
+      end
+    end
+  end
+end

data/lib/read_xls/record_handler/number.rb

@@ -0,0 +1,18 @@
+module ReadXls
+  module RecordHandler
+    class Number < ::ReadXls::RecordHandler::Base
+      def call
+        row, column, xf_index = record_data.byteslice(0, 6).unpack("v3")
+        number                = record_data.byteslice(6, 8).unpack("E").first
+
+        number_column = ::ReadXls::Evaluator::Number.new(builder, number, xf_index)
+
+        builder.add_column_to_row(
+          row,
+          column,
+          number_column
+        )
+      end
+    end
+  end
+end

data/lib/read_xls/record_handler/rk.rb

@@ -0,0 +1,23 @@
+module ReadXls
+  module RecordHandler
+    class Rk < ::ReadXls::RecordHandler::Base
+      def call
+        row, column, xf_index = record_data
+                                  .byteslice(0, 6)
+                                  .unpack("v3")
+        rk_bits               = record_data
+                                  .byteslice(6, 4)
+                                  .unpack("V")
+                                  .first
+
+        rk_column = ::ReadXls::Evaluator::RkNumber.new(builder, rk_bits, xf_index)
+
+        builder.add_column_to_row(
+          row,
+          column,
+          rk_column
+        )
+      end
+    end
+  end
+end

data/lib/read_xls/record_handler/row.rb

@@ -0,0 +1,10 @@
+module ReadXls
+  module RecordHandler
+    class Row < ::ReadXls::RecordHandler::Base
+      def call
+        row_number, first_col, last_col = record_data.unpack("v3")
+        builder.add_row(row_number, ::ReadXls::Evaluator::Row.new(row_number, first_col, last_col))
+      end
+    end
+  end
+end

data/lib/read_xls/record_handler/skip.rb

@@ -0,0 +1,8 @@
+module ReadXls
+  module RecordHandler
+    class Skip < ::ReadXls::RecordHandler::Base
+      def call(*)
+      end
+    end
+  end
+end

data/lib/read_xls/record_handler/sst.rb

@@ -0,0 +1,36 @@
+module ReadXls
+  module RecordHandler
+    class Sst < ::ReadXls::RecordHandler::Base
+      F_HIGH_BYTE         = 0x01
+      STRING_BEGIN_OFFSET = 3
+      DATA_OFFSET         = 8
+      STRING_COUNT_OFFSET = 4
+
+      def call
+        string_count    = record_data
+                            .byteslice(STRING_COUNT_OFFSET, 4)
+                            .unpack("V")
+                            .first
+
+        string_data     = record_data.byteslice(DATA_OFFSET..-1)
+        string_position = 0
+
+        strings = string_count.times.map do |i|
+          char_count, grbit = string_data
+                                .byteslice(string_position, STRING_BEGIN_OFFSET)
+                                .unpack("vC")
+
+          char_byte_size = (grbit & F_HIGH_BYTE) == 0 ? 1 : 2
+          string_begin   = string_position + STRING_BEGIN_OFFSET
+          string_length  = char_count * char_byte_size
+
+          string_position = string_begin + string_length
+
+          string_data.byteslice(string_begin, string_length)
+        end
+
+        builder.sst = ::ReadXls::Workbook::SharedStringTable.new(strings.uniq)
+      end
+    end
+  end
+end

data/lib/read_xls/record_handler/string.rb

@@ -0,0 +1,13 @@
+module ReadXls
+  module RecordHandler
+    class String < ::ReadXls::RecordHandler::Base
+      def call
+        char_length, grbit = record_data.byteslice(0, 3).unpack("vC")
+        char_byte_size     = grbit == 0 ? 1 : 2
+
+        string = record_data.byteslice(3, char_byte_size * char_length)
+        builder.add_formula_string(string)
+      end
+    end
+  end
+end

data/lib/read_xls/record_handler/xf.rb

@@ -0,0 +1,19 @@
+module ReadXls
+  module RecordHandler
+    class Xf < ::ReadXls::RecordHandler::Base
+      def call
+        format_index = record_data
+                         .byteslice(2, 2)
+                         .unpack("v")
+                         .first
+
+        builder.add_extended_format(
+          ::ReadXls::Evaluator::ExtendedFormat.new(
+            :builder      => builder,
+            :format_index => format_index
+          )
+        )
+      end
+    end
+  end
+end

data/lib/read_xls/spreadsheet.rb

@@ -0,0 +1,60 @@
+module ReadXls
+  class Spreadsheet
+    ParsingFailedError = Class.new(StandardError)
+    BYTE_LENGTH        = 2
+
+    attr_accessor :biff, :position, :workbook
+
+    def self.parse(xls_file_path)
+      new(
+        Ole::Storage.open(xls_file_path, "rb+")
+      )
+    end
+
+    def initialize(ole)
+      self.position = 0
+      self.biff     = ole.file.read("Workbook")
+      self.workbook = parse_workbook
+    ensure
+      ole.close
+    end
+
+    def sheets
+      workbook.worksheets
+    end
+
+    def parse_workbook
+      workbook_builder = WorkbookBuilder.new(biff)
+
+      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,
+          workbook_builder,
+          biff,
+          record_data
+        )
+      end
+
+      workbook_builder.build
+    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

data/lib/read_xls/type/extended_format.rb

@@ -0,0 +1,25 @@
+module ReadXls
+  module Type
+    class ExtendedFormat
+      attr_accessor :format_string
+
+      FORMAT_MATCHERS = {
+        /[YMDymd]/ => :date
+      }
+
+      def initialize(options)
+        self.format_string = options.fetch(:format_string)
+      end
+
+      def format_type
+        matched_types = FORMAT_MATCHERS.select { |matcher, _| format_string =~ matcher }
+
+        if matched_types.length > 1
+          raise "got more than one match, expected only one matched format type"
+        end
+
+        matched_types.values.first
+      end
+    end
+  end
+end

data/lib/read_xls/version.rb

@@ -0,0 +1,3 @@
+module ReadXls
+  VERSION = "0.1.0"
+end

data/lib/read_xls/workbook.rb

@@ -0,0 +1,11 @@
+module ReadXls
+  class Workbook
+    attr_accessor :worksheets, :formats, :extended_formats
+
+    def initialize
+      self.worksheets       = []
+      self.formats          = []
+      self.extended_formats = []
+    end
+  end
+end

data/lib/read_xls/workbook/shared_string_table.rb

@@ -0,0 +1,15 @@
+module ReadXls
+  class Workbook
+    class SharedStringTable
+      attr_accessor :strings
+
+      def initialize(strings)
+        self.strings = strings
+      end
+
+      def index(i)
+        strings[i]
+      end
+    end
+  end
+end

data/lib/read_xls/workbook/worksheet.rb

@@ -0,0 +1,11 @@
+module ReadXls
+  class Workbook
+    class Worksheet
+      attr_accessor :rows
+
+      def initialize(options)
+        self.rows = options.fetch(:rows)
+      end
+    end
+  end
+end

data/lib/read_xls/workbook/worksheet_builder.rb

@@ -0,0 +1,44 @@
+module ReadXls
+  class Workbook
+    class WorksheetBuilder
+      attr_accessor :rows, :formula_strings, :sst, :formats, :extended_formats
+
+      def initialize
+        self.rows            = []
+        self.formula_strings = []
+      end
+
+      def add_row(row_index, row)
+        rows[row_index] = row
+      end
+
+      def add_column_to_row(row_index, column_index, value)
+        row = rows[row_index] || raise("could not find row")
+        row.add_column(column_index, value)
+      end
+
+      def add_formula_string(string)
+        self.formula_strings.push(string)
+      end
+
+      def build
+        ::ReadXls::Workbook::Worksheet.new(:rows => build_rows)
+      end
+
+      def next_formula_string!
+        self.formula_strings.shift
+      end
+
+
+      private
+
+      def build_rows
+        rows.each_with_index.each do |_, row_index|
+          rows[row_index] ||= ::ReadXls::Evaluator::Row.new(row_index, 0, 0)
+        end
+
+        rows.map(&:evaluate)
+      end
+    end
+  end
+end

data/lib/read_xls/workbook_builder.rb

@@ -0,0 +1,96 @@
+module ReadXls
+  class WorkbookBuilder
+    attr_accessor :biff, :worksheet_builders, :sst, :formats, :extended_formats
+
+    def initialize(biff)
+      self.biff               = biff
+      self.worksheet_builders = []
+      self.formats            = default_formats
+      self.extended_formats   = []
+    end
+
+    def add_worksheet_builder(worksheet_builder)
+      self.worksheet_builders.push(worksheet_builder)
+    end
+
+    def add_format(format_index, format_string)
+      self.formats[format_index] = format_string
+    end
+
+    def add_extended_format(extended_format)
+      self.extended_formats.push(extended_format)
+    end
+
+    def build
+      workbook                  = ::ReadXls::Workbook.new
+      workbook.formats          = build_formats
+      workbook.extended_formats = build_extended_formats
+      workbook.worksheets       = build_worksheets
+      workbook
+    end
+
+
+    private
+
+    def build_formats
+      @_formats ||= formats.dup
+    end
+
+    def build_extended_formats
+      @_extended_formats ||= extended_formats.map(&:evaluate)
+    end
+
+    def build_worksheets
+      worksheet_builders.map do |worksheet_builder|
+        raise "no sst found!" if sst.nil?
+
+        worksheet_builder.sst              = sst
+        worksheet_builder.formats          = build_formats
+        worksheet_builder.extended_formats = build_extended_formats
+
+        worksheet_builder.build
+      end
+    end
+
+    def default_formats
+      [
+        "General",
+        "0",
+        "0.00",
+        "#,##0",
+        "#,##0.00",
+        "$#,##0_);($#,##0)",
+        "$#,##0_);[Red]($#,##0)",
+        "$#,##0.00_);($#,##0.00)",
+        "$#,##0.00_);[Red]($#,##0.00)",
+        "0%",
+        "0.00%",
+        "0.00E+00",
+        "# ?/?",
+        "# ??/??",
+        "M/D/YY",
+        "D-MMM-YY",
+        "D-MMM",
+        "MMM-YY",
+        "h:mm AM/PM",
+        "h:mm:ss AM/PM",
+        "h:mm",
+        "h:mm:ss",
+        "M/D/YY h:mm",
+        "_(#,##0_);(#,##0)",
+        "_(#,##0_);[Red](#,##0)",
+        "_(#,##0.00_);(#,##0.00)",
+        "_(#,##0.00_);[Red](#,##0.00)",
+        '_($* #,##0_);_($* (#,##0);_($* "-"_);_(@_)',
+        '_(* #,##0_);_(* (#,##0);_(* "-"_);_(@_)',
+        '_($* #,##0.00_);_($* (#,##0.00);_($* "-"??_);_(@_)',
+        '_(* #,##0.00_);_(* (#,##0.00);_(* "-"??_);_(@_)',
+        "mm:ss",
+        "[h]:mm:ss",
+        "mm:ss.0",
+        "##0.0E+0",
+        "@"
+      ]
+    end
+  end
+end

data/read_xls.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "read_xls/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "read_xls"
+  spec.version       = ReadXls::VERSION
+  spec.authors       = ["P2Binvestor"]
+  spec.email         = ["techadmin@p2bi.com"]
+
+  spec.summary       = "Parse XLS files."
+  spec.description   = ""
+  spec.homepage      = "http://github.com/p2bi/read_xls"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "ruby-ole"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end