xsv 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9a277b15ef0d08bd690fad89ee2fde1d0e884d62aacd4f6ee1dc61863939ed17
+  data.tar.gz: 7f2b8583392bef4741108c843700e1f8f52dec66fc4ec3f046c5725e0ebd63ff
+SHA512:
+  metadata.gz: 0a5d416c0c18876aef6473c8b6f181048ec04f892edd4eff6e8d02728bbb6fcf4251048abca8d80f6af342d4e266ba6167f0b5046b31b95c70866c0abe273dd4
+  data.tar.gz: 5d331bb4501e262fbd17391b949ba28678224fb738601c79c514f1eae9274286c38f75ab7b824e235d12fae6f20c8e11df5b002638191af783ec9b45ef2cc535

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 1.17.2

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    xsv (0.1.0)
+      nokogiri (~> 1.10.8)
+      rubyzip (~> 2.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    mini_portile2 (2.4.0)
+    minitest (5.14.0)
+    nokogiri (1.10.8)
+      mini_portile2 (~> 2.4.0)
+    rake (10.5.0)
+    rubyzip (2.2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  xsv!
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Martijn Storck
+
+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,51 @@
+# Xsv .xlsx reader
+
+Xsv is a very basic parser for Excel files in the .xlsx format that strives to
+provide feature parity with common CSV readers and nothing more. This should
+allow for fast parsing of large worksheets with minimal RAM and CPU consumption.
+
+Xsv stands for 'Excel Separated Values' because Excel just gets in the way.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'xsv'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install xsv
+
+## Usage
+
+```ruby
+x = Xsv::File.new("sheet.xlsx")
+
+x.sheets[0].each_row(read_headers: true) do |row|
+  row # => { "header1" => "value1", "header2", "value2" }
+end
+j
+x.sheets[0].each_row do |row|
+  row # => ["header1", "header2"]
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/[USERNAME]/xsv.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "xsv"
+
+# 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(__FILE__)

data/bin/setup

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

data/lib/xsv/file.rb

@@ -0,0 +1,43 @@
+require 'nokogiri'
+require 'zip'
+
+module Xsv
+  class File
+
+    attr_reader :sheets, :shared_strings
+
+    def initialize(file)
+      @zip = Zip::File.open(file)
+      @sheets = []
+      fetch_shared_strings
+      fetch_sheets
+    end
+
+    def inspect
+      "#<#{self.class.name}:#{self.object_id}>"
+    end
+
+    private
+
+    def fetch_shared_strings
+      stream = @zip.glob("xl/sharedStrings.xml").first.get_input_stream
+      xml = Nokogiri::XML(stream)
+      expected_count = xml.css("sst").first["uniqueCount"].to_i
+      @shared_strings = xml.css("sst si t").map(&:inner_text)
+
+      if @shared_strings.count != expected_count
+        raise Xsv::Error, "Mismatch in shared strings count! #{expected_count} <> #{@shared_strings.count}"
+      end
+
+      stream.close
+    end
+
+    def fetch_sheets
+      @zip.glob("xl/worksheets/sheet*.xml").sort do |entry|
+        entry.name.scan(/\d+/).first.to_i
+      end.each do |entry|
+        @sheets << Xsv::Sheet.new(self, Nokogiri::XML(entry.get_input_stream))
+      end
+    end
+  end
+end

data/lib/xsv/sheet.rb

@@ -0,0 +1,58 @@
+module Xsv
+  class Sheet
+    attr_reader :xml
+
+    def initialize(sheet, xml)
+      @sheet = sheet
+      @xml = xml
+      @headers = []
+    end
+
+    def each_row(read_headers: false)
+      if read_headers
+        @headers = parse_row(@xml.css("sheetData row").first)
+      end
+
+      @xml.css("sheetData row").each do |row_xml|
+        yield(parse_row(row_xml))
+      end
+
+      true
+    end
+
+    private
+
+    def parse_row(xml)
+      if @headers.any?
+        row = {}
+      else
+        row = []
+      end
+
+      xml.css("c").each_with_index do |c_xml, i|
+        next if @headers.any? && i == 0
+
+        value = case c_xml["t"]
+          when "s"
+            @sheet.shared_strings[c_xml.css("v").inner_text.to_i]
+          when "str"
+            c_xml.css("v").inner_text
+          when "e" # N/A
+            nil
+          when nil
+            c_xml.css("v").inner_text.to_i
+          else
+            raise Xsv::Error, "Encountered unknown column type #{c_xml["t"]}"
+          end
+
+        if @headers.any?
+          row[@headers[i]] = value
+        else
+          row << value
+        end
+      end
+
+      row
+    end
+  end
+end

data/lib/xsv/version.rb

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

data/lib/xsv.rb

@@ -0,0 +1,7 @@
+require "xsv/file"
+require "xsv/sheet"
+require "xsv/version"
+
+module Xsv
+  class Error < StandardError; end
+end

data/xsv.gemspec

@@ -0,0 +1,40 @@
+
+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.summary       = "Minimal xlsx parser that provides nothing a CSV parser wouldn't"
+  spec.homepage      = "https://github.com/martijn/xsv"
+  spec.license       = "MIT"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/martijn/xsv"
+    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."
+  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
+    `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.require_paths = ["lib"]
+
+  spec.add_dependency "rubyzip", "~> 2.2.0"
+  spec.add_dependency "nokogiri", "~> 1.10.8"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: xsv
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Martijn Storck
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-02-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.8
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- martijn@storck.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/xsv.rb
+- lib/xsv/file.rb
+- lib/xsv/sheet.rb
+- lib/xsv/version.rb
+- xsv.gemspec
+homepage: https://github.com/martijn/xsv
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/martijn/xsv
+  source_code_uri: https://github.com/martijn/xsv
+  changelog_uri: https://github.com/martijn/xsv/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Minimal xlsx parser that provides nothing a CSV parser wouldn't
+test_files: []