xsv 0.3.11 → 0.3.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 601dc989cf2bdf62aa50002b0293a387df53bf20022fd16fb2f8885c344e9013
-  data.tar.gz: 6afb26f05ad129280b823540cb3d0e957ab88ea01b877d1758d8c2b376d2d69a
+  metadata.gz: 3ab67d9fe191b18a010c3526e270f7a528189b8a8ad4496ff5cc8100497c8dfd
+  data.tar.gz: 3f7aec9bad6532dda901764d7c80342ab0763370bf0475d9159cc42730a8405e
 SHA512:
-  metadata.gz: 1e946848856a07d1b95fa22f9f97b22fa4bc9fcb7d6b5985b9ff7a9e2ec4e8dc42f74964ec6c2872f22c80773c7f5ca2188e857af32f1f51345d7feebf77047c
-  data.tar.gz: f1ff12b091a4fcd8172064ea6f215011bc43e95bd5dcec586d189b72eb0ef0662eaf48b85ac7794ba82a27d824d61459025ed676a4e7b729be7e71f957cc48bd
+  metadata.gz: 740bb30608da907db4ea9697587dd6da4c2cfc9032fa7196eb1dccfe1912ea77387a0545bb81980f0031f71b746cb6a7c1628aef4f1f35c2697fd68dac80379f
+  data.tar.gz: 288c520bf0b01a3ebb6463dba02bb63ed43eb9fa033ee5e19f1891411cc0c6554415f18455d07d94b45d4c8a56469a00e20d85794357eb48cf5106821458aee5

data/.travis.yml

@@ -4,8 +4,7 @@ language: ruby
 cache: bundler
 rvm:
   - 2.5.8
-  - 2.6.5
-  - 2.7.0
+  - 2.7.1
 env:
   - "rubyzip=1.3.0"
   - "rubyzip=2.2.0"

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Xsv Changelog
 
+## 0.3.16 2020-06-03
+
+- Support complex numbers (#16)
+
+## 0.3.15 2020-06-02
+
+- Fix issue with workbooks that don't contain shared strings (#15)
+
+## 0.3.14 2020-05-22
+
+- Allow opening workbooks from Tempfile and anything that responds to #read
+
+- Preserve whitespace in text cells
+
+## 0.3.13 2020-05-12
+
+- Add Sheet#hidden?
+
+- Clean up code; get rid of some deprecation warnings
+
+## 0.3.12 - 2020-04-15
+
+- Accessing worksheets by name (texpert)
+
 ## 0.3.11 - 2020-04-03
 
 - Backward compatibility with Ruby 2.5 (texpert)

data/Gemfile

@@ -1,6 +1,6 @@
 source "https://rubygems.org"
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in xsv.gemspec
 gemspec

data/README.md

@@ -83,6 +83,22 @@ columns with the same name!
 `Xsv::Sheet` implements `Enumerable` so you can call methods like `#first`,
 `#filter`/`#select` and `#map` on it.
 
+The sheets could be accessed by index or by name:
+
+```ruby
+x = Xsv::Workbook.open("sheet.xlsx")
+
+sheet = x.sheets[0] # gets sheet by index
+
+sheet = x.sheets_by_name('Name').first # gets sheet by name
+```
+
+To get all the workbook's sheets names:
+
+```ruby
+sheet_names = x.sheets.map(&:name)
+```
+
 ### Assumptions
 
 Since Xsv treats worksheets like csv files it makes certain assumptions about your
@@ -107,6 +123,14 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 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).
 
+## Performance and Benchmarks
+
+Xsv is faster and more memory efficient than other gems because of two things: it only _reads values_ from Excel files and it's based on a SAX-based parser instead of a DOM-based parser. If you want to read some background on this, check out my blog post on
+[Efficient XML parsing in Ruby](https://storck.io/posts/efficient-xml-parsing-in-ruby/).
+
+Jamie Schembri did a shootout of Xsv against various other Excel reading gems comparing parsing speed, memory usage and allocations.
+Check our his blog post: [Faster Excel parsing in Ruby](https://blog.schembri.me/post/faster-excel-parsing-in-ruby/).
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/martijn/xsv.

data/Rakefile

@@ -14,4 +14,3 @@ Rake::TestTask.new(:bench) do |t|
 end
 
 task :default => [:test, :bench]
-

data/lib/xsv.rb

@@ -3,10 +3,12 @@ require "date"
 require "ox"
 
 require "xsv/helpers"
+require "xsv/relationships_handler"
 require "xsv/shared_strings_parser"
 require "xsv/sheet"
 require "xsv/sheet_bounds_handler"
 require "xsv/sheet_rows_handler"
+require "xsv/sheets_ids_handler"
 require "xsv/styles_handler"
 require "xsv/version"
 require "xsv/workbook"
@@ -17,6 +19,7 @@ require "xsv/workbook"
 # deals with minimal formatting and cannot create or modify documents.
 module Xsv
   class Error < StandardError; end
+
   # An AssertionFailed error indicates an unexpected condition, meaning a bug
   # or misinterpreted .xlsx document
   class AssertionFailed < StandardError; end

data/lib/xsv/helpers.rb

@@ -39,7 +39,7 @@ module Xsv
 
     MINUTE = 60.freeze
     HOUR = 3600.freeze
-    A_CODEPOINT = 'A'.ord.freeze
+    A_CODEPOINT = "A".ord.freeze
     # The epoch for all dates in OOXML Spreadsheet documents
     EPOCH = Date.new(1899, 12, 30).freeze
 
@@ -53,7 +53,7 @@ module Xsv
 
     # Return a Date for the given Excel date value
     def parse_date(number)
-       EPOCH + number
+      EPOCH + number
     end
 
     # Return a time as a string for the given Excel time value
@@ -94,6 +94,8 @@ module Xsv
     def parse_number(string)
       if string.include? "."
         string.to_f
+      elsif string.include? "E"
+        Complex(string).to_f
       else
         string.to_i
       end

data/lib/xsv/relationships_handler.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+module Xsv
+  # RelationshipsHandler parses the "xl/_rels/workbook.xml.rels" file to get the existing relationships.
+  # This is used internally  when opening a workbook.
+  class RelationshipsHandler < Ox::Sax
+    def self.get_relations(io)
+      relations = []
+      handler = new do |relation|
+        relations << relation
+      end
+
+      Ox.sax_parse(handler, io.read)
+      return relations
+    end
+
+    # Ox::Sax implementation
+
+    def initialize(&block)
+      @block = block
+      @relationship = {}
+    end
+
+    def start_element(name)
+      @relationship = {} if name == :Relationship
+    end
+
+    def attr(name, value)
+      case name
+      when :Id, :Type, :Target
+        @relationship[name] = value
+      end
+    end
+
+    def end_element(name)
+      return unless name == :Relationship
+
+      @block.call(@relationship)
+    end
+  end
+end

data/lib/xsv/shared_strings_parser.rb

@@ -6,7 +6,7 @@ module Xsv
     def self.parse(io)
       strings = []
       handler = new { |s| strings << s }
-      Ox.sax_parse(handler, io.read)
+      Ox.sax_parse(handler, io.read, skip: :skip_none)
       return strings
     end
 

data/lib/xsv/sheet.rb

@@ -17,7 +17,7 @@ module Xsv
 
     # Returns the current mode. Call {#parse_headers!} to switch to `:hash` mode
     # @return [Symbol] `:hash` or `:array`
-    attr_reader :mode
+    attr_reader :id, :mode, :name
 
     # Set a number of rows to skip at the top of the sheet (header row offset).
     # For hash mode, do not skip the header row as this will be automatically
@@ -30,13 +30,16 @@ module Xsv
     # @param workbook [Workbook] The Workbook with shared data such as shared strings and styles
     # @param io [IO] A handle to an open worksheet XML file
     # @param size [Number] size of the XML file
-    def initialize(workbook, io, size)
+    def initialize(workbook, io, size, ids)
       @workbook = workbook
+      @id = ids[:sheetId].to_i
       @io = io
+      @name = ids[:name]
       @size = size
       @headers = []
       @mode = :array
       @row_skip = 0
+      @hidden = ids[:state] == "hidden"
 
       @last_row, @column_count = SheetBoundsHandler.get_bounds(@io, @workbook)
     end
@@ -46,6 +49,11 @@ module Xsv
       "#<#{self.class.name}:#{self.object_id}>"
     end
 
+    # Returns true if the worksheet is hidden
+    def hidden?
+      @hidden
+    end
+
     # Iterate over rows, returning either hashes or arrays based on the current mode.
     def each_row(&block)
       @io.rewind

data/lib/xsv/sheets_ids_handler.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+module Xsv
+  # SheetsIdsHandler interprets the relevant parts of workbook.xml
+  # This is used internally to get the sheets ids, relationship_ids, and names when opening a workbook.
+  class SheetsIdsHandler < Ox::Sax
+    def self.get_sheets_ids(io)
+      sheets_ids = []
+      handler = new do |sheet_ids|
+        sheets_ids << sheet_ids
+      end
+
+      Ox.sax_parse(handler, io.read)
+      return sheets_ids
+    end
+
+    # Ox::Sax implementation
+
+    def initialize(&block)
+      @block = block
+      @parsing = false
+    end
+
+    def start_element(name)
+      if name == :sheets
+        @parsing = true
+        return
+      end
+
+      return unless name == :sheet
+
+      @sheet_ids = {}
+    end
+
+    def attr(name, value)
+      return unless @parsing
+
+      case name
+      when :name, :sheetId, :state
+        @sheet_ids[name] = value
+      when :'r:id'
+        @sheet_ids[:r_id] = value
+      end
+    end
+
+    def end_element(name)
+      if name == :sheets
+        @parsing = false
+        return
+      end
+
+      return unless name == :sheet
+
+      @block.call(@sheet_ids)
+    end
+  end
+end

data/lib/xsv/styles_handler.rb

@@ -7,8 +7,8 @@ module Xsv
       @xfs = nil
       @numFmts = nil
       handler = new(numFmts) do |xfs, numFmts|
-         @xfs = xfs
-         @numFmts = numFmts
+        @xfs = xfs
+        @numFmts = numFmts
       end
 
       Ox.sax_parse(handler, io.read)

data/lib/xsv/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Xsv
-  VERSION = "0.3.11"
+  VERSION = "0.3.16"
 end

data/lib/xsv/workbook.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'zip'
+require "zip"
 
 module Xsv
   # An OOXML Spreadsheet document is called a Workbook. A Workbook consists of
@@ -15,11 +15,11 @@ module Xsv
     # Open the workbook of the given filename, string or buffer. For additional
     # options see {.initialize}
     def self.open(data, **kws)
-      if data.is_a?(IO)
+      if data.is_a?(IO) || data.respond_to?(:read) # is it a buffer?
         @workbook = self.new(Zip::File.open_buffer(data), **kws)
-      elsif data.start_with?("PK\x03\x04")
+      elsif data.start_with?("PK\x03\x04") # is it a string containing a filename?
         @workbook = self.new(Zip::File.open_buffer(data), **kws)
-      else
+      else # must be a filename
         @workbook = self.new(Zip::File.open(data), **kws)
       end
     end
@@ -41,6 +41,8 @@ module Xsv
 
       fetch_shared_strings
       fetch_styles
+      fetch_sheets_ids
+      fetch_relationships
       fetch_sheets
     end
 
@@ -56,15 +58,27 @@ module Xsv
       @sheets = nil
       @xfs = nil
       @numFmts = nil
+      @relationships = nil
       @shared_strings = nil
+      @sheets_ids = nil
 
       true
     end
 
+    # Returns an array of sheets for the case of same name sheets.
+    # @param [String] name
+    # @return [Array<Xsv::Sheet>]
+    def sheets_by_name(name)
+      @sheets.select { |s| s.name == name }
+    end
+
     private
 
     def fetch_shared_strings
-      stream = @zip.glob("xl/sharedStrings.xml").first.get_input_stream
+      handle = @zip.glob("xl/sharedStrings.xml").first
+      return if handle.nil?
+
+      stream = handle.get_input_stream
       @shared_strings = SharedStringsParser.parse(stream)
 
       stream.close
@@ -80,8 +94,24 @@ module Xsv
       @zip.glob("xl/worksheets/sheet*.xml").sort do |a, b|
         a.name[/\d+/].to_i <=> b.name[/\d+/].to_i
       end.each do |entry|
-        @sheets << Xsv::Sheet.new(self, entry.get_input_stream, entry.size)
+        rel = @relationships.detect { |r| entry.name.end_with?(r[:Target]) && r[:Type].end_with?("worksheet") }
+        sheet_ids = @sheets_ids.detect { |i| i[:r_id] == rel[:Id] }
+        @sheets << Xsv::Sheet.new(self, entry.get_input_stream, entry.size, sheet_ids)
       end
     end
+
+    def fetch_sheets_ids
+      stream = @zip.glob("xl/workbook.xml").first.get_input_stream
+      @sheets_ids = SheetsIdsHandler.get_sheets_ids(stream)
+
+      stream.close
+    end
+
+    def fetch_relationships
+      stream = @zip.glob("xl/_rels/workbook.xml.rels").first.get_input_stream
+      @relationships = RelationshipsHandler.get_relations(stream)
+
+      stream.close
+    end
   end
 end

data/xsv.gemspec

@@ -1,23 +1,22 @@
-
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "xsv/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "xsv"
-  spec.version       = Xsv::VERSION
-  spec.authors       = ["Martijn Storck"]
-  spec.email         = ["martijn@storck.io"]
+  spec.name = "xsv"
+  spec.version = Xsv::VERSION
+  spec.authors = ["Martijn Storck"]
+  spec.email = ["martijn@storck.io"]
 
-  spec.summary       = "A fast and lightweiggt xlsx parser that provides nothing a CSV parser wouldn't"
-  spec.description    = <<-EOF
+  spec.summary = "A fast and lightweiggt xlsx parser that provides nothing a CSV parser wouldn't"
+  spec.description = <<-EOF
                             Xsv is a fast, lightweight parser for Office Open XML spreadsheet files
                             (commonly known as Excel or .xlsx files). It strives to be minimal in the
                             sense that it provides nothing a CSV reader wouldn't, meaning it only
                             deals with minimal formatting and cannot create or modify documents.
                           EOF
-  spec.homepage      = "https://github.com/martijn/xsv"
-  spec.license       = "MIT"
+  spec.homepage = "https://github.com/martijn/xsv"
+  spec.license = "MIT"
 
   if spec.respond_to?(:metadata)
     spec.metadata["homepage_uri"] = spec.homepage
@@ -25,19 +24,19 @@ Gem::Specification.new do |spec|
     spec.metadata["changelog_uri"] = "https://github.com/martijn/xsv/CHANGELOG.md"
   else
     raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
+          "public gem pushes."
   end
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '~> 2.5'
+  spec.required_ruby_version = "~> 2.5"
 
   spec.add_dependency "rubyzip", ">= 1.3", "< 3"
   spec.add_dependency "ox", ">= 2.9"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xsv
 version: !ruby/object:Gem::Version
-  version: 0.3.11
+  version: 0.3.16
 platform: ruby
 authors:
 - Martijn Storck
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-03 00:00:00.000000000 Z
+date: 2020-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -108,14 +108,15 @@ files:
 - bin/setup
 - lib/xsv.rb
 - lib/xsv/helpers.rb
+- lib/xsv/relationships_handler.rb
 - lib/xsv/shared_strings_parser.rb
 - lib/xsv/sheet.rb
 - lib/xsv/sheet_bounds_handler.rb
 - lib/xsv/sheet_rows_handler.rb
+- lib/xsv/sheets_ids_handler.rb
 - lib/xsv/styles_handler.rb
 - lib/xsv/version.rb
 - lib/xsv/workbook.rb
-- test.sh
 - xsv.gemspec
 homepage: https://github.com/martijn/xsv
 licenses:

data/test.sh

@@ -1,3 +0,0 @@
-#!/bin/sh
-
-ruby -Ilib:test test/*_test.rb