xsv 0.3.12 → 0.3.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36eeca38d2791f71dafba9b1ae6308e63b3554efd98e2949448c4715863b7616
-  data.tar.gz: cf90d5ff1def79ee8b17877523a5e8233b7c5253801c98eb0e725724a6e3f48d
+  metadata.gz: e04167014a265ca3a3551f185b1a37849cae430bda9fa5cd60f7a302643c3722
+  data.tar.gz: 9aced295617b61bb29b6d8c5d087722f73176dc555490fb231a0c5ba05472349
 SHA512:
-  metadata.gz: cc203883d561d86a51eb35c11f4c4547929605387a43d38c16eb48f975a2da1ea332c7cbb4aab21e4760424ceb015de2e4d50aeeddd9bf595ccd3bf1f363ac63
-  data.tar.gz: b91d7d210c6894c17bfbb2b40dd0c243f2c5228f35c780f8e5d8afba9367303d2df1897ae734bec636f8eab615cda7188d63e63b270b3f543fafc39d91d1aa7e
+  metadata.gz: fb97e738cffac1e980a1cfedbd2ed3def2f66d72f78384623be80ccf89cb838bb571a369f10277c066eeb1bf1fb10c19feb542cedc1cb4ffd6463550a459e81c
+  data.tar.gz: 20c758923b7ed3efd3b847ca74bbe6f5683a7f97f2facca0fedd1ca75011b8fab00caab3b44cd909357d9fed5b50808fecadb06b439b463988a5cdd59f88d374

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.17 2020-07-03
+
+- Fix parsing of empty worksheets (#17)
+
+## 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)

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

@@ -123,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

@@ -8,7 +8,7 @@ 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/sheets_ids_handler"
 require "xsv/styles_handler"
 require "xsv/version"
 require "xsv/workbook"
@@ -19,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

@@ -17,6 +17,7 @@ module Xsv
 
     def initialize(&block)
       @block = block
+      @relationship = {}
     end
 
     def start_element(name)
@@ -25,8 +26,8 @@ module Xsv
 
     def attr(name, value)
       case name
-        when :Id, :Type, :Target
-          @relationship[name] = value
+      when :Id, :Type, :Target
+        @relationship[name] = value
       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

@@ -39,6 +39,7 @@ module Xsv
       @headers = []
       @mode = :array
       @row_skip = 0
+      @hidden = ids[:state] == "hidden"
 
       @last_row, @column_count = SheetBoundsHandler.get_bounds(@io, @workbook)
     end
@@ -48,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
@@ -106,7 +112,7 @@ module Xsv
       elsif @mode == :hash
         @mode = :array
         headers.tap { @mode = :hash }
-      end
+      end || []
     end
 
     def empty_row

data/lib/xsv/sheets_ids_handler.rb

@@ -17,10 +17,14 @@ module Xsv
 
     def initialize(&block)
       @block = block
+      @parsing = false
     end
 
     def start_element(name)
-      return @parsing = true if name == :sheets
+      if name == :sheets
+        @parsing = true
+        return
+      end
 
       return unless name == :sheet
 
@@ -31,15 +35,18 @@ module Xsv
       return unless @parsing
 
       case name
-        when :name, :sheetId
-          @sheet_ids[name] = value
-        when :'r:id'
-          @sheet_ids[:r_id] = value
+      when :name, :sheetId, :state
+        @sheet_ids[name] = value
+      when :'r:id'
+        @sheet_ids[:r_id] = value
       end
     end
 
     def end_element(name)
-      return @parsing = false if name == :sheets
+      if name == :sheets
+        @parsing = false
+        return
+      end
 
       return unless name == :sheet
 

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.12"
+  VERSION = "0.3.17"
 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
@@ -75,7 +75,10 @@ module Xsv
     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
@@ -91,7 +94,7 @@ 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|
-        rel = @relationships.detect { |r| entry.name.end_with?(r[:Target]) && r[:Type].end_with?('worksheet') }
+        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

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.12
+  version: 0.3.17
 platform: ruby
 authors:
 - Martijn Storck
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-15 00:00:00.000000000 Z
+date: 2020-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -117,7 +117,6 @@ files:
 - 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