creeker 2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c4c47c4c2ab4eab11da48520d2fff4aa20ef18ef
+  data.tar.gz: 45a5fc20d28267e258d818edd306c5bd8724a071
+SHA512:
+  metadata.gz: af24552f0fa299657a56991061c966e13fdbcb45a8398370e4c9e9dc6ef211c9e928b9711360b8d410b1edd3ef98eac25f8c47759a0947362ee2dfb315b3fa5a
+  data.tar.gz: e2916b4131c6b2646b0e994ae245b5597fe16c389a24472725deaa78f10d61bda6cd6cbce011484b2fecee212af8383a9974b65e1229240e47bb401dbf51dbf1

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2017 Ramtin Vaziri
+
+MIT License
+
+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,117 @@
+# Creeker - Stream parser for large Excel (xlsx and xlsm) files.
+
+Creeker is a Ruby gem that provides a fast, simple and efficient method of parsing large Excel (xlsx and xlsm) files.
+
+
+## Installation
+
+Creeker can be used from the command line or as part of a Ruby web framework. To install the gem using terminal, run the following command:
+
+```
+gem install creeker
+```
+
+To use it in Rails, add this line to your Gemfile:
+
+```ruby
+gem 'creeker'
+```
+
+## Basic Usage
+Creeker can simply parse an Excel file by looping through the rows enumerator:
+
+```ruby
+require 'creeker'
+creeker = Creeker::Book.new 'spec/fixtures/sample.xlsx'
+sheet = creeker.sheets[0]
+
+sheet.rows.each do |row|
+  puts row # => {"A1"=>"Content 1", "B1"=>nil, C1"=>nil, "D1"=>"Content 3"}
+end
+
+sheet.rows_with_meta_data.each do |row|
+  puts row # => {"collapsed"=>"false", "customFormat"=>"false", "customHeight"=>"true", "hidden"=>"false", "ht"=>"12.1", "outlineLevel"=>"0", "r"=>"1", "cells"=>{"A1"=>"Content 1", "B1"=>nil, C1"=>nil, "D1"=>"Content 3"}}
+end
+
+sheet.state   # => 'visible'
+sheet.name    # => 'Sheet1'
+sheet.rid     # => 'rId2'
+```
+
+## Filename considerations
+By default, Creeker will ensure that the file extension is either *.xlsx or *.xlsm, but this check can be circumvented as needed:
+
+```ruby
+path = 'sample-as-zip.zip'
+Creeker::Book.new path, :check_file_extension => false
+```
+
+By default, the Rails [file_field_tag](http://api.rubyonrails.org/classes/ActionView/Helpers/FormTagHelper.html#method-i-file_field_tag) uploads to a temporary location and stores the original filename with the StringIO object. (See [this section](http://guides.rubyonrails.org/form_helpers.html#uploading-files) of the Rails Guides for more information.)
+
+Creeker can parse this directly without the need for file upload gems such as Carrierwave or Paperclip by passing the original filename as an option:
+
+```ruby
+# Import endpoint in Rails controller
+def import
+  file = params[:file]
+  Creeker::Book.new file.path, check_file_extension: false
+end
+```
+
+## Parsing images
+Creeker does not parse images by default. If you want to parse the images,
+use `with_images` method before iterating over rows to preload images information. If you don't call this method, Creeker will not return images anywhere.
+
+Cells with images will be an array of Pathname objects.
+If an image is spread across multiple cells, same Pathname object will be returned for each cell.
+
+```ruby
+sheet.with_images.rows.each do |row|
+  puts row # => {"A1"=>[#<Pathname:/var/folders/ck/l64nmm3d4k75pvxr03ndk1tm0000gn/T/creeker__drawing20161101-53599-274q0vimage1.jpeg>], "B2"=>"Fluffy"}
+end
+```
+
+Images for a specific cell can be obtained with images_at method:
+
+```ruby
+puts sheet.images_at('A1') # => [#<Pathname:/var/folders/ck/l64nmm3d4k75pvxr03ndk1tm0000gn/T/creeker__drawing20161101-53599-274q0vimage1.jpeg>]
+
+# no images in a cell
+puts sheet.images_at('C1') # => nil
+```
+
+Creeker will most likely return nil for a cell with images if there is no other text cell in that row - you can use *images_at* method for retrieving images in that cell.
+
+## Remote files
+
+```ruby
+remote_url = 'http://dev-builds.libreoffice.org/tmp/test.xlsx'
+Creeker::Book.new remote_url, remote: true
+```
+
+## Contributing
+
+Contributions are welcomed. You can fork a repository, add your code changes to the forked branch, ensure all existing unit tests pass, create new unit tests which cover your new changes and finally create a pull request.
+
+After forking and then cloning the repository locally, install the Bundler and then use it
+to install the development gem dependencies:
+
+```
+gem install bundler
+bundle install
+```
+
+Once this is complete, you should be able to run the test suite:
+
+```
+rake
+```
+
+## Bug Reporting
+
+Please use the [Issues](https://github.com/huntcode/creeker/issues) page to report bugs or suggest new enhancements.
+
+
+## License
+
+Creeker has been published under [MIT License](https://github.com/huntcode/creeker/blob/master/LICENSE.txt)

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task :default => :spec

data/lib/creeker.rb

@@ -0,0 +1,14 @@
+require 'creeker/version'
+require 'creeker/book'
+require 'creeker/styles/constants'
+require 'creeker/styles/style_types'
+require 'creeker/styles/converter'
+require 'creeker/utils'
+require 'creeker/styles'
+require 'creeker/drawing'
+require 'creeker/sheet'
+require 'creeker/shared_strings'
+
+module Creeker
+  # Your code goes here...
+end

data/lib/creeker/book.rb

@@ -0,0 +1,84 @@
+require 'zip/filesystem'
+require 'nokogiri'
+require 'date'
+require 'httparty'
+
+module Creeker
+
+  class Creeker::Book
+
+    attr_reader :files,
+                :sheets,
+                :shared_strings
+
+    DATE_1900 = Date.new(1899, 12, 30).freeze
+    DATE_1904 = Date.new(1904, 1, 1).freeze
+
+    def initialize path, options = {}
+      check_file_extension = options.fetch(:check_file_extension, true)
+      if check_file_extension
+        extension = File.extname(options[:original_filename] || path).downcase
+        raise 'Not a valid file format.' unless (['.xlsx', '.xlsm'].include? extension)
+      end
+      if options[:remote]
+        zipfile = Tempfile.new("file")
+        zipfile.binmode
+        zipfile.write(HTTParty.get(path).body)
+        zipfile.close
+        path = zipfile.path
+      end
+
+      @files = Zip::File.open(path)
+      @shared_strings = SharedStrings.new(self, options[:multi_thread])
+    end
+
+    def sheets
+      doc = @files.file.open "xl/workbook.xml"
+      xml = Nokogiri::XML::Document.parse doc
+      namespaces = xml.namespaces
+
+      cssPrefix = ''
+      namespaces.each do |namespace|
+        if namespace[1] == 'http://schemas.openxmlformats.org/spreadsheetml/2006/main' && namespace[0] != 'xmlns' then
+          cssPrefix = namespace[0].split(':')[1]+'|'
+        end
+      end
+
+      rels_doc = @files.file.open "xl/_rels/workbook.xml.rels"
+      rels = Nokogiri::XML::Document.parse(rels_doc).css("Relationship")
+      @sheets = xml.css(cssPrefix+'sheet').map do |sheet|
+        sheetfile = rels.find { |el| sheet.attr("r:id") == el.attr("Id") }.attr("Target")
+        Sheet.new(self, sheet.attr("name"), sheet.attr("sheetid"),  sheet.attr("state"), sheet.attr("visible"), sheet.attr("r:id"), sheetfile)
+      end
+    end
+
+    def style_types
+      @style_types ||= Creeker::Styles.new(self).style_types
+    end
+
+    def close
+      @files.close
+    end
+
+    def base_date
+      @base_date ||=
+      begin
+        # Default to 1900 (minus one day due to excel quirk) but use 1904 if
+        # it's set in the Workbook's workbookPr
+        # http://msdn.microsoft.com/en-us/library/ff530155(v=office.12).aspx
+        result = DATE_1900 # default
+
+        doc = @files.file.open "xl/workbook.xml"
+        xml = Nokogiri::XML::Document.parse doc
+        xml.css('workbookPr[date1904]').each do |workbookPr|
+          if workbookPr['date1904'] =~ /true|1/i
+            result = DATE_1904
+            break
+          end
+        end
+
+        result
+      end
+    end
+  end
+end

data/lib/creeker/drawing.rb

@@ -0,0 +1,109 @@
+require 'pathname'
+
+module Creeker
+  class Creeker::Drawing
+    include Creeker::Utils
+
+    COLUMNS = ('A'..'AZ').to_a
+
+    def initialize(book, drawing_filepath)
+      @book = book
+      @drawing_filepath = drawing_filepath
+      @drawings = []
+      @drawings_rels = []
+      @images_pathnames = Hash.new { |hash, key| hash[key] = [] }
+
+      if file_exist?(@drawing_filepath)
+        load_drawings_and_rels
+        load_images_pathnames_by_cells if has_images?
+      end
+    end
+
+    ##
+    # Returns false if there are no images in the drawing file or the drawing file does not exist, true otherwise.
+    def has_images?
+      @has_images ||= !@drawings.empty?
+    end
+
+    ##
+    # Extracts images from excel to tmpdir for a cell, if the images are not already extracted (multiple calls or same image file in multiple cells).
+    # Returns array of images as Pathname objects or nil.
+    def images_at(cell_name)
+      coordinate = calc_coordinate(cell_name)
+      pathnames_at_coordinate = @images_pathnames[coordinate]
+      return if pathnames_at_coordinate.empty?
+
+      pathnames_at_coordinate.map do |image_pathname|
+        if image_pathname.exist?
+          image_pathname
+        else
+          excel_image_path = "xl/media#{image_pathname.to_path.split(tmpdir).last}"
+          IO.copy_stream(@book.files.file.open(excel_image_path), image_pathname.to_path)
+          image_pathname
+         end
+      end
+    end
+
+    private
+
+    ##
+    # Transforms cell name to [row, col], e.g. A1 => [0, 0], B3 => [1, 2]
+    # Rows and cols start with 0.
+    def calc_coordinate(cell_name)
+      col = COLUMNS.index(cell_name.slice /[A-Z]+/)
+      row = (cell_name.slice /\d+/).to_i - 1 # rows in drawings start with 0
+      [row, col]
+    end
+
+    ##
+    # Creates/loads temporary directory for extracting images from excel
+    def tmpdir
+      @tmpdir ||= ::Dir.mktmpdir('creeker__drawing')
+    end
+
+    ##
+    # Parses drawing and drawing's relationships xmls.
+    # Drawing xml contains relationships ID's and coordinates (row, col).
+    # Drawing relationships xml contains images' locations.
+    def load_drawings_and_rels
+      @drawings = parse_xml(@drawing_filepath).css('xdr|twoCellAnchor')
+      drawing_rels_filepath = expand_to_rels_path(@drawing_filepath)
+      @drawings_rels = parse_xml(drawing_rels_filepath).css('Relationships')
+    end
+
+    ##
+    # Iterates through the drawings and saves images' paths as Pathname objects to a hash with [row, col] keys.
+    # As multiple images can be located in a single cell, hash values are array of Pathname objects.
+    # One image can be spread across multiple cells (defined with from-row/to-row/from-col/to-col attributes) - same Pathname object is associated to each row-col combination for the range.
+    def load_images_pathnames_by_cells
+      image_selector = 'xdr:pic/xdr:blipFill/a:blip'.freeze
+      row_from_selector = 'xdr:from/xdr:row'.freeze
+      row_to_selector = 'xdr:to/xdr:row'.freeze
+      col_from_selector = 'xdr:from/xdr:col'.freeze
+      col_to_selector = 'xdr:to/xdr:col'.freeze
+
+      @drawings.xpath('//xdr:twoCellAnchor').each do |drawing|
+        embed = drawing.xpath(image_selector).first.attributes['embed']
+        next if embed.nil?
+
+        rid = embed.value
+        path = Pathname.new("#{tmpdir}/#{extract_drawing_path(rid).slice(/[^\/]*$/)}")
+
+        row_from = drawing.xpath(row_from_selector).text.to_i
+        col_from = drawing.xpath(col_from_selector).text.to_i
+        row_to = drawing.xpath(row_to_selector).text.to_i
+        col_to = drawing.xpath(col_to_selector).text.to_i
+
+        (col_from..col_to).each do |col|
+          (row_from..row_to).each do |row|
+            @images_pathnames[[row, col]].push(path)
+          end
+        end
+      end
+    end
+
+    def extract_drawing_path(rid)
+      @drawings_rels.css("Relationship[@Id=#{rid}]").first.attributes['Target'].value
+    end
+  end
+end

data/lib/creeker/shared_strings.rb

@@ -0,0 +1,78 @@
+require 'zip/filesystem'
+require 'nokogiri'
+
+module Creeker
+
+  class Creeker::SharedStrings
+
+    attr_reader :book, :dictionary
+
+    def initialize book, multi_thread = false
+      @book = book
+      @multi_thread = multi_thread
+      parse_shared_shared_strings
+    end
+
+    def parse_shared_shared_strings
+      path = "xl/sharedStrings.xml"
+      if @book.files.file.exist?(path)
+        doc = @book.files.file.open path
+        xml = Nokogiri::XML::Document.parse doc
+        parse_shared_string_from_document(xml)
+      end
+    end
+
+    def parse_shared_string_from_document(xml)
+      @dictionary = self.class.parse_shared_string_from_document(xml)
+    end
+
+    def self.parse_shared_string_from_document(xml)
+      dictionary = Hash.new
+      # (1..10).each do |i|
+      #   thread = Thread.new do
+      #     xml.css('si').first(i * 10000).each_with_index do |si, idx|
+      #       text_nodes = si.css('t')
+      #       if text_nodes.count == 1 # plain text node
+      #         dictionary[idx] = text_nodes.first.content
+      #       else # rich text nodes with text fragments
+      #         dictionary[idx] = text_nodes.map(&:content).join('')
+      #       end
+      #     end
+      #   end
+
+      #   sleep 1*i
+      #   GC.start
+      # end
+
+      # Creeker::Book.new(Upload.last.document.path)
+      if @multi_thread
+        xml.css('si').to_a.in_groups_of(10000).each do |group|
+          thread = Thread.new do
+            group.each_with_index do |si, idx|
+              text_nodes = si.css('t')
+              if text_nodes.count == 1 # plain text node
+                dictionary[idx] = text_nodes.first.content
+              else # rich text nodes with text fragments
+                dictionary[idx] = text_nodes.map(&:content).join('')
+              end
+            end
+          end
+
+          # sleep 5
+          GC.start
+        end
+      else
+        xml.css('si').first(20).each_with_index do |si, idx|
+          text_nodes = si.css('t')
+          if text_nodes.count == 1 # plain text node
+            dictionary[idx] = text_nodes.first.content
+          else # rich text nodes with text fragments
+            dictionary[idx] = text_nodes.map(&:content).join('')
+          end
+        end
+      end
+      dictionary
+    end
+
+  end
+end

data/lib/creeker/sheet.rb

@@ -0,0 +1,164 @@
+require 'zip/filesystem'
+require 'nokogiri'
+
+module Creeker
+  class Creeker::Sheet
+    include Creeker::Utils
+
+    attr_reader :book,
+                :name,
+                :sheetid,
+                :state,
+                :visible,
+                :rid,
+                :index
+
+
+    def initialize book, name, sheetid, state, visible, rid, sheetfile
+      @book = book
+      @name = name
+      @sheetid = sheetid
+      @visible = visible
+      @rid = rid
+      @state = state
+      @sheetfile = sheetfile
+      @images_present = false
+    end
+
+    ##
+    # Preloads images info (coordinates and paths) from related drawing.xml and drawing rels.
+    # Must be called before #rows method if you want to have images included.
+    # Returns self so you can chain the calls (sheet.with_images.rows).
+    def with_images
+      @drawingfile = extract_drawing_filepath
+      if @drawingfile
+        @drawing = Creeker::Drawing.new(@book, @drawingfile.sub('..', 'xl'))
+        @images_present = @drawing.has_images?
+      end
+      self
+    end
+
+    ##
+    # Extracts images for a cell to a temporary folder.
+    # Returns array of Pathnames for the cell.
+    # Returns nil if images asre not found for the cell or images were not preloaded with #with_images.
+    def images_at(cell)
+      @drawing.images_at(cell) if @images_present
+    end
+
+    ##
+    # Provides an Enumerator that returns a hash representing each row.
+    # The key of the hash is the Cell id and the value is the value of the cell.
+    def rows
+      rows_generator
+    end
+
+    ##
+    # Provides an Enumerator that returns a hash representing each row.
+    # The hash contains meta data of the row and a 'cells' embended hash which contains the cell contents.
+    def rows_with_meta_data
+      rows_generator true
+    end
+
+    private
+
+    ##
+    # Returns a hash per row that includes the cell ids and values.
+    # Empty cells will be also included in the hash with a nil value.
+    def rows_generator include_meta_data=false
+      path = if @sheetfile.start_with? "/xl/" or @sheetfile.start_with? "xl/" then @sheetfile else "xl/#{@sheetfile}" end
+      if @book.files.file.exist?(path)
+        # SAX parsing, Each element in the stream comes through as two events:
+        # one to open the element and one to close it.
+        opener = Nokogiri::XML::Reader::TYPE_ELEMENT
+        closer = Nokogiri::XML::Reader::TYPE_END_ELEMENT
+        Enumerator.new do |y|
+          row, cells, cell = nil, {}, nil
+          cell_type  = nil
+          cell_style_idx = nil
+          @book.files.file.open(path) do |xml|
+            Nokogiri::XML::Reader.from_io(xml).each do |node|
+              if (node.name.eql? 'row') and (node.node_type.eql? opener)
+                row = node.attributes
+                row['cells'] = Hash.new
+                cells = Hash.new
+                y << (include_meta_data ? row : cells) if node.self_closing?
+              elsif (node.name.eql? 'row') and (node.node_type.eql? closer)
+                processed_cells = fill_in_empty_cells(cells, row['r'], cell)
+
+                if @images_present
+                  processed_cells.each do |cell_name, cell_value|
+                    next unless cell_value.nil?
+                    processed_cells[cell_name] = images_at(cell_name)
+                  end
+                end
+
+                row['cells'] = processed_cells
+                y << (include_meta_data ? row : processed_cells)
+              elsif (node.name.eql? 'c') and (node.node_type.eql? opener)
+                cell_type      = node.attributes['t']
+                cell_style_idx = node.attributes['s']
+                cell           = node.attributes['r']
+              elsif (node.name.eql? 'v') and (node.node_type.eql? opener)
+                unless cell.nil?
+                  cells[cell] = convert(node.inner_xml, cell_type, cell_style_idx)
+                end
+              elsif (node.name.eql? 't') and (node.node_type.eql? opener)
+                unless cell.nil?
+                  cells[cell] = convert(node.inner_xml, cell_type, cell_style_idx)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+
+    def convert(value, type, style_idx)
+      style = @book.style_types[style_idx.to_i]
+      Creeker::Styles::Converter.call(value, type, style, converter_options)
+    end
+
+    def converter_options
+      @converter_options ||= {
+        shared_strings: @book.shared_strings.dictionary,
+        base_date: @book.base_date
+      }
+    end
+
+    ##
+    # The unzipped XML file does not contain any node for empty cells.
+    # Empty cells are being padded in using this function
+    def fill_in_empty_cells(cells, row_number, last_col)
+      new_cells = Hash.new
+
+      unless cells.empty?
+        last_col = last_col.gsub(row_number, '')
+
+        ("A"..last_col).to_a.each do |column|
+          id = "#{column}#{row_number}"
+          new_cells[id] = cells[id]
+        end
+      end
+
+      new_cells
+    end
+
+    ##
+    # Find drawing filepath for the current sheet.
+    # Sheet xml contains drawing relationship ID.
+    # Sheet relationships xml contains drawing file's location.
+    def extract_drawing_filepath
+      # Read drawing relationship ID from the sheet.
+      sheet_filepath = "xl/#{@sheetfile}"
+      drawing = parse_xml(sheet_filepath).css('drawing').first
+      return if drawing.nil?
+
+      drawing_rid = drawing.attributes['id'].value
+
+      # Read sheet rels to find drawing file's location.
+      sheet_rels_filepath = expand_to_rels_path(sheet_filepath)
+      parse_xml(sheet_rels_filepath).css("Relationship[@Id='#{drawing_rid}']").first.attributes['Target'].value
+    end
+  end
+end

data/lib/creeker/styles.rb

@@ -0,0 +1,27 @@
+module Creeker
+  class Styles
+    attr_accessor :book
+    def initialize(book)
+      @book = book
+    end
+
+    def path
+      "xl/styles.xml"
+    end
+
+    def styles_xml
+      @styles_xml ||= begin
+        if @book.files.file.exist?(path)
+          doc = @book.files.file.open path
+          Nokogiri::XML::Document.parse doc
+        end
+      end
+    end
+
+    def style_types
+      @style_types ||= begin
+        Creeker::Styles::StyleTypes.new(styles_xml).call
+      end
+    end
+  end
+end

data/lib/creeker/styles/constants.rb

@@ -0,0 +1,41 @@
+module Creeker
+  class Styles
+    module Constants
+      # Map of non-custom numFmtId to casting symbol
+      NumFmtMap = {
+        0  => :string,         # General
+        1  => :fixnum,         # 0
+        2  => :float,          # 0.00
+        3  => :fixnum,         # #,##0
+        4  => :float,          # #,##0.00
+        5  => :unsupported,    # $#,##0_);($#,##0)
+        6  => :unsupported,    # $#,##0_);[Red]($#,##0)
+        7  => :unsupported,    # $#,##0.00_);($#,##0.00)
+        8  => :unsupported,    # $#,##0.00_);[Red]($#,##0.00)
+        9  => :percentage,     # 0%
+        10 => :percentage,     # 0.00%
+        11 => :bignum,         # 0.00E+00
+        12 => :unsupported,    # # ?/?
+        13 => :unsupported,    # # ??/??
+        14 => :date,           # mm-dd-yy
+        15 => :date,           # d-mmm-yy
+        16 => :date,           # d-mmm
+        17 => :date,           # mmm-yy
+        18 => :time,           # h:mm AM/PM
+        19 => :time,           # h:mm:ss AM/PM
+        20 => :time,           # h:mm
+        21 => :time,           # h:mm:ss
+        22 => :date_time,      # m/d/yy h:mm
+        37 => :unsupported,    # #,##0 ;(#,##0)
+        38 => :unsupported,    # #,##0 ;[Red](#,##0)
+        39 => :unsupported,    # #,##0.00;(#,##0.00)
+        40 => :unsupported,    # #,##0.00;[Red](#,##0.00)
+        45 => :time,           # mm:ss
+        46 => :time,           # [h]:mm:ss
+        47 => :time,           # mmss.0
+        48 => :bignum,         # ##0.0E+0
+        49 => :unsupported     # @
+      }
+    end
+  end
+end

data/lib/creeker/styles/converter.rb

@@ -0,0 +1,101 @@
+require 'set'
+
+module Creeker
+  class Styles
+    class Converter
+      include Creeker::Styles::Constants
+      ##
+      # The heart of typecasting. The ruby type is determined either explicitly
+      # from the cell xml or implicitly from the cell style, and this
+      # method expects that work to have been done already. This, then,
+      # takes the type we determined it to be and casts the cell value
+      # to that type.
+      #
+      # types:
+      # - s: shared string (see #shared_string)
+      # - n: number (cast to a float)
+      # - b: boolean
+      # - str: string
+      # - inlineStr: string
+      # - ruby symbol: for when type has been determined by style
+      #
+      # options:
+      # - shared_strings: needed for 's' (shared string) type
+      # - base_date: from what date to begin, see method #base_date
+
+      DATE_TYPES = [:date, :time, :date_time].to_set
+      def self.call(value, type, style, options = {})
+        return nil if value.nil? || value.empty?
+
+        # Sometimes the type is dictated by the style alone
+        if type.nil? || (type == 'n' && DATE_TYPES.include?(style))
+          type = style
+        end
+
+        case type
+
+        ##
+        # There are few built-in types
+        ##
+
+        when 's' # shared string
+          options[:shared_strings][value.to_i]
+        when 'n' # number
+          value.to_f
+        when 'b'
+          value.to_i == 1
+        when 'str'
+          value
+        when 'inlineStr'
+          value
+
+        ##
+        # Type can also be determined by a style,
+        # detected earlier and cast here by its standardized symbol
+        ##
+
+        when :string, :unsupported
+          value
+        when :fixnum
+          value.to_i
+        when :float, :percentage
+          value.to_f
+        when :date, :time, :date_time
+          convert_date(value, options)
+        when :bignum
+          convert_bignum(value)
+
+        ## Nothing matched
+        else
+          value
+        end
+      end
+
+      # the trickiest. note that  all these formats can vary on
+      # whether they actually contain a date, time, or datetime.
+      def self.convert_date(value, options)
+        value                        = value.to_f
+        days_since_date_system_start = value.to_i
+        fraction_of_24               = value - days_since_date_system_start
+
+        # http://stackoverflow.com/questions/10559767/how-to-convert-ms-excel-date-from-float-to-date-format-in-ruby
+        date = options.fetch(:base_date, Date.new(1899, 12, 30)) + days_since_date_system_start
+
+        if fraction_of_24 > 0 # there is a time associated
+          seconds = (fraction_of_24 * 86400).round
+          return Time.utc(date.year, date.month, date.day) + seconds
+        else
+          return date
+        end
+      end
+
+      def self.convert_bignum(value)
+        if defined?(BigDecimal)
+          BigDecimal.new(value)
+        else
+          value.to_f
+        end
+      end
+    end
+  end
+end

data/lib/creeker/styles/style_types.rb

@@ -0,0 +1,85 @@
+# https://github.com/hmcgowan/roo/blob/master/lib/roo/excelx.rb
+# https://github.com/woahdae/simple_xlsx_reader/blob/master/lib/simple_xlsx_reader.rb#L231
+module Creeker
+  class Styles
+    class StyleTypes
+      include Creeker::Styles::Constants
+      attr_accessor :styles_xml_doc
+      def initialize(styles_xml_doc)
+        @styles_xml_doc = styles_xml_doc
+      end
+
+      # Excel doesn't record types for some cells, only its display style, so
+      # we have to back out the type from that style.
+      #
+      # Some of these styles can be determined from a known set (see NumFmtMap),
+      # while others are 'custom' and we have to make a best guess.
+      #
+      # This is the array of types corresponding to the styles a spreadsheet
+      # uses, and includes both the known style types and the custom styles.
+      #
+      # Note that the xml sheet cells that use this don't reference the
+      # numFmtId, but instead the array index of a style in the stored list of
+      # only the styles used in the spreadsheet (which can be either known or
+      # custom). Hence this style types array, rather than a map of numFmtId to
+      # type.
+      def call
+        @style_types ||= begin
+          styles_xml_doc.css('styleSheet cellXfs xf').map do |xstyle|
+            a = num_fmt_id(xstyle)
+            style_type_by_num_fmt_id( a )
+          end
+        end
+      end
+
+      #returns the numFmtId value if it's available
+      def num_fmt_id(xstyle)
+        return nil unless xstyle.attributes['numFmtId']
+        xstyle.attributes['numFmtId'].value
+      end
+
+      # Finds the type we think a style is; For example, fmtId 14 is a date
+      # style, so this would return :date.
+      #
+      # Note, custom styles usually (are supposed to?) have a numFmtId >= 164,
+      # but in practice can sometimes be simply out of the usual "Any Language"
+      # id range that goes up to 49. For example, I have seen a numFmtId of
+      # 59 specified as a date. In Thai, 59 is a number format, so this seems
+      # like a bad idea, but we try to be flexible and just go with it.
+      def style_type_by_num_fmt_id(id)
+        return nil unless id
+        id = id.to_i
+        NumFmtMap[id] || custom_style_types[id]
+      end
+
+      # Map of (numFmtId >= 164) (custom styles) to our best guess at the type
+      # ex. {164 => :date_time}
+      def custom_style_types
+        @custom_style_types ||= begin
+          styles_xml_doc.css('styleSheet numFmts numFmt').inject({}) do |acc, xstyle|
+            index      = xstyle.attributes['numFmtId'].value.to_i
+            value      = xstyle.attributes['formatCode'].value
+            acc[index] = determine_custom_style_type(value)
+            acc
+          end
+        end
+      end
+
+      # This is the least deterministic part of reading xlsx files. Due to
+      # custom styles, you can't know for sure when a date is a date other than
+      # looking at its format and gessing. It's not impossible to guess right,
+      # though.
+      #
+      # http://stackoverflow.com/questions/4948998/determining-if-an-xlsx-cell-is-date-formatted-for-excel-2007-spreadsheets
+      def determine_custom_style_type(string)
+        return :float if string[0] == '_'
+        return :float if string[0] == ' 0'
+
+        # Looks for one of ymdhis outside of meta-stuff like [Red]
+        return :date_time if string =~ /(^|\])[^\[]*[ymdhis]/i
+
+        return :unsupported
+      end
+    end
+  end
+end

data/lib/creeker/utils.rb

@@ -0,0 +1,16 @@
+module Creeker
+  module Utils
+    def expand_to_rels_path(filepath)
+      filepath.sub(/(\/[^\/]+$)/, '/_rels\1.rels')
+    end
+
+    def file_exist?(path)
+      @book.files.file.exist?(path)
+    end
+
+    def parse_xml(xml_path)
+      doc = @book.files.file.open(xml_path)
+      Nokogiri::XML::Document.parse(doc)
+    end
+  end
+end

data/lib/creeker/version.rb

@@ -0,0 +1,3 @@
+module Creeker
+  VERSION = "2.1"
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: creeker
+version: !ruby/object:Gem::Version
+  version: '2.1'
+platform: ruby
+authors:
+- huntcode
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.5
+description: A Ruby gem that streams and parses large Excel(xlsx and xlsm) files fast
+  and efficiently. Based on Creek gem, but with Multi-threading and Garbage Collection
+email:
+- vivektripathi_cse@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/creeker.rb
+- lib/creeker/book.rb
+- lib/creeker/drawing.rb
+- lib/creeker/shared_strings.rb
+- lib/creeker/sheet.rb
+- lib/creeker/styles.rb
+- lib/creeker/styles/constants.rb
+- lib/creeker/styles/converter.rb
+- lib/creeker/styles/style_types.rb
+- lib/creeker/utils.rb
+- lib/creeker/version.rb
+homepage: https://github.com/huntcode/creeker
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: A Ruby gem for parsing large Excel(xlsx and xlsm) files.
+test_files: []