read_xls 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7e0b7f7a9fe0bc349e97f2bfebdd52f667d66b0d
+  data.tar.gz: d17fcbb0b353a085527b1c99e718541c973a7e3e
+SHA512:
+  metadata.gz: 077662dd44d4b1aaef8fc044977762a895cda469664ac310f2c425ec6b375b27f4fafcfa0b5bec8a5c6c0b4e66fcba618eb7a5ae1870f4e3cf04f90da4659155
+  data.tar.gz: 64d26284538dcafc6f09de637ba807068f1e490c6ef22021dd05e8dd8c4b1ac8be82a6c5ee4bf79dd075a4fb1602175a7b7347a5b57b73db6faf5662c2bc4335

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in read_xls.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 P2Binvestor
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+# ReadXls
+
+A gem for parsing XLS docs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "read_xls"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install read_xls
+
+## Usage
+
+Simply use the `parse` command to get back a spreadsheet with many sheets. Each spreadsheet contains
+a rows method which returns and array or arrays (rows x columns).
+
+```ruby
+spreadsheet = ::ReadXls.parse("path/to/spreadsheet.xls")
+
+spreadsheet.sheets.each do |sheet|
+  sheet.rows.each do |columns|
+    columns.each do |column|
+      puts column
+    end
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/p2bi/read_xls. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "read_xls"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/read_xls.rb

@@ -0,0 +1,49 @@
+require "read_xls/version"
+
+require "bigdecimal"
+require "ole/storage"
+
+require "read_xls/evaluator/boolean"
+require "read_xls/evaluator/blank"
+require "read_xls/evaluator/extended_format"
+require "read_xls/evaluator/format_number"
+require "read_xls/evaluator/formula"
+require "read_xls/evaluator/number"
+require "read_xls/evaluator/rk_number"
+require "read_xls/evaluator/row"
+require "read_xls/evaluator/sst_string"
+
+require "read_xls/type/extended_format"
+
+require "read_xls/workbook"
+require "read_xls/workbook_builder"
+require "read_xls/workbook/worksheet"
+require "read_xls/workbook/shared_string_table"
+require "read_xls/workbook/worksheet_builder"
+
+require "read_xls/record_handler/base"
+require "read_xls/record_handler/blank"
+require "read_xls/record_handler/bof"
+require "read_xls/record_handler/boolerr"
+require "read_xls/record_handler/boundsheet"
+require "read_xls/record_handler/format"
+require "read_xls/record_handler/formula"
+require "read_xls/record_handler/label_sst"
+require "read_xls/record_handler/mul_rk"
+require "read_xls/record_handler/number"
+require "read_xls/record_handler/not_implemented"
+require "read_xls/record_handler/row"
+require "read_xls/record_handler/rk"
+require "read_xls/record_handler/skip"
+require "read_xls/record_handler/sst"
+require "read_xls/record_handler/string"
+require "read_xls/record_handler/xf"
+require "read_xls/record_handler"
+
+require "read_xls/spreadsheet"
+
+module ReadXls
+  def self.parse(xls_path)
+    Spreadsheet.parse(xls_path)
+  end
+end

data/lib/read_xls/evaluator/blank.rb

@@ -0,0 +1,9 @@
+module ReadXls
+  module Evaluator
+    class Blank
+      def evaluate
+        nil
+      end
+    end
+  end
+end

data/lib/read_xls/evaluator/boolean.rb

@@ -0,0 +1,15 @@
+module ReadXls
+  module Evaluator
+    class Boolean
+      attr_accessor :value
+
+      def initialize(value)
+        self.value = value
+      end
+
+      def evaluate
+        value == 1
+      end
+    end
+  end
+end

data/lib/read_xls/evaluator/extended_format.rb

@@ -0,0 +1,20 @@
+module ReadXls
+  module Evaluator
+    class ExtendedFormat
+      attr_accessor :builder, :format_index
+
+      def initialize(options)
+        self.builder      = options.fetch(:builder)
+        self.format_index = options.fetch(:format_index)
+      end
+
+      def evaluate
+        format_string = builder.formats[format_index]
+
+        ::ReadXls::Type::ExtendedFormat.new(
+          :format_string => format_string
+        )
+      end
+    end
+  end
+end

data/lib/read_xls/evaluator/format_number.rb

@@ -0,0 +1,47 @@
+module ReadXls
+  module Evaluator
+    class FormatNumber
+      SECONDS_IN_DAY = 60 * 60 * 24
+
+      attr_accessor :number, :extended_format
+
+      def initialize(number, extended_format)
+        self.number          = BigDecimal.new(number.to_s)
+        self.extended_format = extended_format
+      end
+
+      def evaluate
+        return number unless extended_format
+
+        case extended_format.format_type
+          when :date
+            days_since_datemode = number.to_i
+            inner_day_fraction  = number.frac
+
+            date = build_date(days_since_datemode)
+
+            if inner_day_fraction == 0
+              date
+            else
+              build_time(date, inner_day_fraction)
+            end
+          else
+            number
+        end
+      end
+
+
+      private
+
+      def build_date(days_since_datemode)
+        Date.new(1899, 12, 30) + days_since_datemode
+      end
+
+
+      def build_time(date, inner_day_fraction)
+        time = Time.parse("#{date.year}-#{date.month}-#{date.day}T00:00:00Z")
+        time + (inner_day_fraction * SECONDS_IN_DAY).round(0)
+      end
+    end
+  end
+end

data/lib/read_xls/evaluator/formula.rb

@@ -0,0 +1,33 @@
+module ReadXls
+  module Evaluator
+    class Formula
+      attr_accessor :builder, :result_number, :result_bytes
+
+      def initialize(builder, result_test, result_bytes)
+        self.builder       = builder
+        self.result_number = result_test != 0xFFFF
+        self.result_bytes  = result_bytes
+      end
+
+      def evaluate
+        if result_number?
+          result_bytes.unpack("E").first
+        elsif result_string?
+          builder.next_formula_string!
+        elsif result_boolerr?
+          raise NotImplementedError
+        else
+          raise NotImplementedError, "can't figure out what type of formula this is"
+        end
+      end
+
+      def result_number?
+        result_number
+      end
+
+      def result_string?
+        !result_number? && result_bytes.byteslice(0, 1).unpack("C").first == 0
+      end
+    end
+  end
+end

data/lib/read_xls/evaluator/number.rb

@@ -0,0 +1,24 @@
+module ReadXls
+  module Evaluator
+    class Number
+      attr_accessor :builder, :number, :xf_index
+
+      def initialize(builder, number, xf_index)
+        self.builder  = builder
+        self.number   = number
+        self.xf_index = xf_index
+      end
+
+      def evaluate
+        FormatNumber.new(number, extended_format).evaluate
+      end
+
+
+      private
+
+      def extended_format
+        builder.extended_formats[xf_index]
+      end
+    end
+  end
+end

data/lib/read_xls/evaluator/rk_number.rb

@@ -0,0 +1,38 @@
+module ReadXls
+  module Evaluator
+    class RkNumber
+      attr_accessor :builder, :rk_bits, :xf_index
+
+      def initialize(builder, rk_bits, xf_index)
+        self.builder  = builder
+        self.rk_bits  = rk_bits
+        self.xf_index = xf_index
+      end
+
+      def evaluate
+        value = if (rk_bits & 0x02) == 0
+                  rk_bits_without_last_2            = (rk_bits & 0xfffffffc)
+                  float_in_64_bit_string_big_endian = (("%032b" % rk_bits_without_last_2) + "0"*32)
+                  [float_in_64_bit_string_big_endian].pack("B*").unpack("G").first
+                else
+                  rk_bits >> 2
+                end
+
+        value = if (rk_bits & 0x01) == 0
+                  value
+                else
+                  value / 100.0
+                end
+
+        FormatNumber.new(value, extended_format).evaluate
+      end
+
+
+      private
+
+      def extended_format
+        builder.extended_formats[xf_index]
+      end
+    end
+  end
+end

data/lib/read_xls/evaluator/row.rb

@@ -0,0 +1,26 @@
+module ReadXls
+  module Evaluator
+    class Row
+      attr_accessor :row_number, :first_col, :last_col, :columns
+
+      def initialize(row_number, first_col, last_col)
+        self.row_number = row_number
+        self.first_col  = first_col
+        self.last_col   = last_col
+        self.columns    = []
+      end
+
+      def add_column(column_index, value)
+        columns[column_index] = value
+      end
+
+      def evaluate
+        columns.each_with_index.each do |_, column_index|
+          columns[column_index] ||= ::ReadXls::Evaluator::Blank.new
+        end
+
+        columns.map(&:evaluate)
+      end
+    end
+  end
+end

data/lib/read_xls/evaluator/sst_string.rb

@@ -0,0 +1,16 @@
+module ReadXls
+  module Evaluator
+    class SstString
+      attr_accessor :sst_index, :builder
+
+      def initialize(sst_index, builder)
+        self.sst_index = sst_index
+        self.builder   = builder
+      end
+
+      def evaluate
+        builder.sst.index(sst_index)
+      end
+    end
+  end
+end