fastsheet 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8b5ef4384484b745caf3afdc796b13da37d0cc90
+  data.tar.gz: 937da15e4c7b6e54afa9e796aa9bcc2cf62b4f43
+SHA512:
+  metadata.gz: 6d1a36996c4c748b94458e418bce9debf74b49ac3542e7524723aafdc0d87202167a18d3a7ecf2fa0506c76bd1f80f8fcb8d68c9c36377ca12411cb52b4cf58a
+  data.tar.gz: b0b9e65519ac28273acb53fc3edb69ec5068c23d48d960c39e6ff34cf37b7b399b8ccc53c173860d1d41dd30d3fb863bbf0dcc04aa008c6d33f829de40b96602

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/*.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/target/
+/**/*.so
+/*.gem
+/**/*.log

data/Cargo.toml

@@ -0,0 +1,16 @@
+[package]
+name = "fastsheet"
+version = "0.1.0"
+
+[package.metadata.thermite]
+github_releases = true
+github_release_type = "latest"
+
+[lib]
+name = "fastsheet"
+crate-type = ["cdylib"]
+
+[dependencies]
+ruru = "0.9.3"
+lazy_static = "0.2.1"
+calamine = "0.11.8"

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Dmitry Koval
+
+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,73 @@
+# Fastsheet
+
+Fastest ruby gem for reading Excel documents.
+
+Benchmark:
+```shell
+$ bin/benchmark
+Benchmark reading row №2991 from `./first_file.xlsx` 15 times...
+┌───────────┬───────────┐
+│   Reader  │ Real Time │
+├───────────┼───────────┤
+│    Roo    │ 161.3275  │
+├───────────┼───────────┤
+│ Fastsheet │  4.3765   │
+└───────────┴───────────┘
+Fastsheet is 37 times faster
+
+$ bin/benchmark
+Benchmark reading row №7146 from `./second_file.xlsx` 15 times...
+┌───────────┬───────────┐
+│   Reader  │ Real Time │
+├───────────┼───────────┤
+│    Roo    │ 897.4474  │
+├───────────┼───────────┤
+│ Fastsheet │  19.0869  │
+└───────────┴───────────┘
+Fastsheet is 47 times faster
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fastsheet'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fastsheet
+
+## Usage
+
+This lib returns sheet as array of arrays, so you are free to use it however you want:
+
+```ruby
+require 'fastsheet'
+
+sheet = Xlsx.new('path/to/sheet.xlsx')
+
+ # get all rows
+sheet.rows
+```
+
+That's all API for now :smile: . Feel free to [open an issue](http://github.com/dkkoval/fastsheet/issues) if you need more.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/dkkoval/fastsheet.
+
+## 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,11 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/clean'
+require 'rake/testtask'
+require 'bundler/setup'
+require 'thermite/tasks'
+
+Thermite::Tasks.new
+
+task default: 'thermite:build'

data/bin/benchmark

@@ -0,0 +1,59 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'benchmark'
+require 'tty-spinner'
+require 'tty-table'
+
+require 'fastsheet'
+require 'roo'
+
+FILE = './second_file.xlsx'.freeze
+ROW = rand 9000
+N = 15
+
+options = {
+  hide_cursor: true,
+  format: :dots,
+  interval: 20,
+  clear: true
+}
+
+puts "Benchmark reading row №#{ROW} from `#{FILE}` #{N} times..."
+
+roo_time = Benchmark.measure('Roo') do
+  spinner = TTY::Spinner.new('[:spinner] :progress', options)
+  spinner.auto_spin
+  N.times do |i|
+    spinner.update(progress: "Roo: #{i + 1}/#{N} sheets opened ...")
+    Roo::Excelx.new(FILE).sheet(0).row(ROW)
+  end
+  spinner.stop
+end
+
+fastsheet_time = Benchmark.measure('Fastsheet') do
+  spinner = TTY::Spinner.new('[:spinner] :progress', options)
+  spinner.auto_spin
+  N.times do |i|
+    spinner.update(progress: "Fastsheet: #{i + 1}/#{N} sheets opened ...")
+    Xlsx.new(FILE).rows[ROW]
+  end
+  spinner.stop
+end
+
+table = TTY::Table.new(header: ['Reader', 'Real Time'])
+
+table << ['Roo', roo_time.real.round(4)]
+table << ['Fastsheet', fastsheet_time.real.round(4)]
+
+renderer = TTY::Table::Renderer::Unicode.new(table)
+
+renderer.alignments       = %i[center center]
+renderer.padding          = [0, 1, 0, 1]
+renderer.border.separator = :each_row
+
+puts renderer.render
+
+puts "Fastsheet is #{(roo_time.real / fastsheet_time.real).round} times faster"

data/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'fastsheet'
+
+require 'pry'
+Pry.start

data/fastsheet.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fastsheet/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fastsheet'
+  spec.version       = Fastsheet::VERSION
+  spec.authors       = ['Dmitry Koval']
+  spec.email         = ['dkoval@heliostech.fr']
+
+  spec.summary       = 'Fast XLSX reader'
+  spec.description   = 'Fastest ruby gem for reading Excel documents.'
+
+  spec.homepage      = 'https://github.com/dkkoval/fastsheet'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'bin'
+  spec.require_paths = ['lib']
+  spec.extensions << 'Rakefile'
+
+  spec.add_runtime_dependency 'thermite', '~> 0.12.1'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'pry', '~> 0.10.4'
+
+  # for pretty benchmark
+  spec.add_development_dependency 'tty-spinner', '~> 0.7.0'
+  spec.add_development_dependency 'tty-table', '~> 0.8.0'
+end

data/lib/fastsheet.rb

@@ -0,0 +1,5 @@
+require 'fastsheet/xlsx'
+require 'libfastsheet'
+
+module Fastsheet
+end

data/lib/fastsheet/version.rb

@@ -0,0 +1,3 @@
+module Fastsheet
+  VERSION = '0.0.6'
+end

data/lib/fastsheet/xlsx.rb

@@ -0,0 +1,4 @@
+module Fastsheet
+  class Xlsx
+  end
+end

data/src/lib.rs

@@ -0,0 +1,74 @@
+#[macro_use] extern crate ruru;
+#[macro_use] extern crate lazy_static;
+
+extern crate calamine;
+
+use ruru::{Array, Class, RString, Float, Fixnum, Boolean, Object, AnyObject, NilClass};
+
+use calamine::{Sheets, DataType};
+
+pub struct Reader {
+    file: String,
+    rows: Array
+}
+
+impl Reader {
+    fn new(file: String) -> Self {
+        let mut this = Reader {
+            file: file,
+            rows: Array::new()
+        };
+
+        let sheet = Sheets::open(&this.file).unwrap().worksheet_range_by_index(0).unwrap();
+
+        for row in sheet.rows() {
+            let mut new_row = Array::with_capacity(sheet.width());
+
+            for (_, c) in row.iter().enumerate() {
+                match *c {
+                    DataType::Error(_)      => new_row.push(NilClass::new()),
+                    DataType::String(ref s) => new_row.push(RString::new(s)),
+                    DataType::Empty         => new_row.push(NilClass::new()),
+                    DataType::Float(ref f)  => new_row.push(Float::new(*f)),
+                    DataType::Int(ref i)    => new_row.push(Fixnum::new(*i)),
+                    DataType::Bool(ref b)   => new_row.push(Boolean::new(*b))
+                };
+            }
+
+            this.rows.push(new_row);
+        }
+        this
+    }
+
+    fn get_rows(&self) -> AnyObject {
+        self.rows.to_any_object()
+    }
+}
+
+wrappable_struct!(Reader, ReaderWrapper, READER_WRAPPER);
+
+class!(Xlsx);
+
+methods!(
+    Xlsx,
+    itself,
+
+    fn ruby_xlsx_new(file: RString) -> AnyObject {
+        let xlsx_reader = Reader::new(file.unwrap().to_string());
+
+        Class::from_existing("Xlsx").wrap_data(xlsx_reader, &*READER_WRAPPER)
+    }
+
+    fn ruby_xlsx_rows() -> AnyObject {
+        itself.get_data(&*READER_WRAPPER).get_rows()
+    }
+);
+
+#[no_mangle]
+#[allow(non_snake_case)]
+pub extern fn Init_libfastsheet() {
+    Class::new("Xlsx", None).define(|itself| {
+        itself.def_self("new", ruby_xlsx_new);
+        itself.def("rows", ruby_xlsx_rows)
+    });
+}

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: fastsheet
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+platform: ruby
+authors:
+- Dmitry Koval
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thermite
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+- !ruby/object:Gem::Dependency
+  name: tty-spinner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: tty-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+description: Fastest ruby gem for reading Excel documents.
+email:
+- dkoval@heliostech.fr
+executables: []
+extensions:
+- Rakefile
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Cargo.toml
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/benchmark
+- bin/console
+- fastsheet.gemspec
+- lib/fastsheet.rb
+- lib/fastsheet/version.rb
+- lib/fastsheet/xlsx.rb
+- src/lib.rs
+homepage: https://github.com/dkkoval/fastsheet
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Fast XLSX reader
+test_files: []