rscsv 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7abdc4faa83ed5581cff993c3dcf4e19d8ed9c7f
+  data.tar.gz: d3e5dfe0f089ed0213ff940427e3054ecc36371d
+SHA512:
+  metadata.gz: 8cfe748a3ba4395a6b5f078b39e34ba88adfa2d5b5b43b3156aad7b3f4cba9f8900ef5de7a79a3fe04897a31bc8cc4db90170f111ee602ae14a4ef7538a58396
+  data.tar.gz: 53b9a16030dfe87fd98dbd5ad91a8cef028d35528081571f52044ddefecbf3ca698d263ec4ed437a7b6285d16b3e4cd9958f19d2e96a909da3ff52582227b6df

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/target/
+*.bundle
+*.so
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,11 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+  - 2.3.3
+before_install:
+  - gem install bundler -v 1.14.6
+  - if [ ! -e "$HOME/.cargo/bin" ]; then curl https://sh.rustup.rs -sSf | sh -s -- --default-toolchain stable -y; fi
+  - export PATH="$HOME/.cargo/bin:$PATH"
+  - rustup default stable
+  - rustc --version

data/Cargo.lock

@@ -0,0 +1,80 @@
+[root]
+name = "rscsv"
+version = "0.1.0"
+dependencies = [
+ "csv 0.15.0 (registry+https://github.com/rust-lang/crates.io-index)",
+ "helix 0.6.0 (registry+https://github.com/rust-lang/crates.io-index)",
+]
+
+[[package]]
+name = "byteorder"
+version = "1.0.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+
+[[package]]
+name = "cslice"
+version = "0.3.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+
+[[package]]
+name = "cstr-macro"
+version = "0.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+
+[[package]]
+name = "csv"
+version = "0.15.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+dependencies = [
+ "byteorder 1.0.0 (registry+https://github.com/rust-lang/crates.io-index)",
+ "memchr 1.0.1 (registry+https://github.com/rust-lang/crates.io-index)",
+ "rustc-serialize 0.3.24 (registry+https://github.com/rust-lang/crates.io-index)",
+]
+
+[[package]]
+name = "helix"
+version = "0.6.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+dependencies = [
+ "cslice 0.3.0 (registry+https://github.com/rust-lang/crates.io-index)",
+ "cstr-macro 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)",
+ "libc 0.2.22 (registry+https://github.com/rust-lang/crates.io-index)",
+ "libcruby-sys 0.6.0 (registry+https://github.com/rust-lang/crates.io-index)",
+]
+
+[[package]]
+name = "libc"
+version = "0.2.22"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+
+[[package]]
+name = "libcruby-sys"
+version = "0.6.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+dependencies = [
+ "libc 0.2.22 (registry+https://github.com/rust-lang/crates.io-index)",
+]
+
+[[package]]
+name = "memchr"
+version = "1.0.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+dependencies = [
+ "libc 0.2.22 (registry+https://github.com/rust-lang/crates.io-index)",
+]
+
+[[package]]
+name = "rustc-serialize"
+version = "0.3.24"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+
+[metadata]
+"checksum byteorder 1.0.0 (registry+https://github.com/rust-lang/crates.io-index)" = "c40977b0ee6b9885c9013cd41d9feffdd22deb3bb4dc3a71d901cc7a77de18c8"
+"checksum cslice 0.3.0 (registry+https://github.com/rust-lang/crates.io-index)" = "0f8cb7306107e4b10e64994de6d3274bd08996a7c1322a27b86482392f96be0a"
+"checksum cstr-macro 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)" = "db53fddba18cdd35477a7213a3ef6acfbfa333c31b42ce019e544c4a1420a06f"
+"checksum csv 0.15.0 (registry+https://github.com/rust-lang/crates.io-index)" = "7ef22b37c7a51c564a365892c012dc0271221fdcc64c69b19ba4d6fa8bd96d9c"
+"checksum helix 0.6.0 (registry+https://github.com/rust-lang/crates.io-index)" = "4b3d0b8579a68e79a629d9c2f4717dbf5e2b467a7d7afb38c737d573d46331ac"
+"checksum libc 0.2.22 (registry+https://github.com/rust-lang/crates.io-index)" = "babb8281da88cba992fa1f4ddec7d63ed96280a1a53ec9b919fd37b53d71e502"
+"checksum libcruby-sys 0.6.0 (registry+https://github.com/rust-lang/crates.io-index)" = "3bf276325da1f1b20cd68108b33c02dfcad26ff4f4d7fdac4cd2a5aac8f04ae5"
+"checksum memchr 1.0.1 (registry+https://github.com/rust-lang/crates.io-index)" = "1dbccc0e46f1ea47b9f17e6d67c5a96bd27030519c519c9c91327e31275a47b4"
+"checksum rustc-serialize 0.3.24 (registry+https://github.com/rust-lang/crates.io-index)" = "dcf128d1287d2ea9d80910b5f1120d0b8eede3fbf1abe91c40d39ea7d51e6fda"

data/Cargo.toml

@@ -0,0 +1,12 @@
+[package]
+name = "rscsv"
+version = "0.1.0"
+authors = ["Ville Lautanala <lautis@gmail.com>"]
+
+[lib]
+
+crate-type = ["cdylib"]
+
+[dependencies]
+helix = "0.6.0"
+csv = "0.15.0"

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rscsv.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Ville Lautanala
+
+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,27 @@
+# Rscsv
+
+Fast CSV using Rust extensions. Currently writing CSV is implemented.
+
+[![Build Status](https://travis-ci.org/lautis/rscsv.svg?branch=master)](https://travis-ci.org/lautis/rscsv)
+
+## Installation
+
+This gem requires Rust (~> 1.17) and Cargo to be installed. With those
+requirements fulfilled, rscsv can be installed like any other gem:
+
+```
+gem install rscsv
+```
+
+## Usage
+
+```ruby
+require 'rscsv'
+
+Rscsv::Writer.generate_lines([['1', '2', '3'], ['3', '4', '5']])
+# => 1,2,3\n4,5,6\n
+Rscsv::Writer.generate_line(['1', '2', '3'])
+# => 1,2,3\n
+```
+
+This is 3x faster than using native Ruby `CSV.generate`.

data/Rakefile

@@ -0,0 +1,27 @@
+require 'bundler/gem_tasks'
+require 'bundler/setup'
+require 'rspec/core/rake_task'
+require 'helix_runtime/build_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+helix_tasks = HelixRuntime::BuildTask.new('rscsv')
+
+# Monkey-patch project name as directory name varies during installation
+module HelixRuntime
+  class Project
+    def name
+      'rscsv'
+    end
+  end
+end
+
+namespace :helix do
+  desc 'Build rscsv'
+  task build: ['helix:pre_build', 'helix:check_path'] do
+    helix_tasks.project.build
+  end
+end
+
+task :spec => :build
+task :default => :spec

data/bin/benchmark

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.dirname(__FILE__) + '/../lib'
+
+require 'benchmark/ips'
+require 'securerandom'
+require 'rscsv'
+require 'csv'
+
+rows = (0...1000).map do
+  (0...10).map { SecureRandom.hex }
+end
+
+Benchmark.ips do |x|
+  x.report('Ruby CSV') do |times|
+    times.times do
+      CSV.generate do |csv|
+        rows.each { |row| csv << row }
+      end
+    end
+  end
+
+  x.report('rscsv') do |times|
+    times.times { Rscsv::Writer.generate_lines(rows) }
+  end
+
+  x.compare!
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rscsv"
+
+# 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/ext/Makefile

@@ -0,0 +1,6 @@
+all:
+	rake helix:build
+clean:
+	rm -rf ../target
+
+install: ;

data/ext/extconf.rb

@@ -0,0 +1,5 @@
+if !system('cargo --version') || !system('rustc --version')
+  raise 'You have to install Rust with Cargo (https://www.rust-lang.org/)'
+end
+
+require 'rake'

data/lib/rscsv.rb

@@ -0,0 +1,7 @@
+require 'helix_runtime'
+require 'rscsv/native'
+require 'rscsv/version'
+
+module Rscsv
+  Writer = RscsvWriter
+end

data/lib/rscsv/version.rb

@@ -0,0 +1,3 @@
+module Rscsv
+  VERSION = '0.1.0'.freeze
+end

data/rscsv.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rscsv/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'rscsv'
+  spec.version = Rscsv::VERSION
+  spec.authors = ['Ville Lautanala']
+  spec.email = ['lautis@gmail.com']
+
+  spec.summary = 'Rust-powered CSV'
+  spec.description = 'Fast CSV using Rust extensions.' \
+    'Currently only writes CSV.'
+  spec.homepage = 'https://github.com/lautis/rscsv'
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |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.extensions = Dir['ext/extconf.rb']
+
+  spec.add_dependency 'helix_runtime', '~> 0.6.0'
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'benchmark-ips', '~> 2.7'
+end

data/src/lib.rs

@@ -0,0 +1,86 @@
+#[macro_use]
+extern crate helix;
+extern crate csv;
+
+use helix::sys;
+use helix::sys::VALUE;
+use helix::{UncheckedValue, CheckResult, CheckedValue, ToRust};
+
+struct VecWrap<T>(Vec<T>);
+
+impl<T> UncheckedValue<VecWrap<T>> for VALUE
+    where VALUE: UncheckedValue<T>
+{
+    fn to_checked(self) -> CheckResult<VecWrap<T>> {
+        if unsafe { sys::RB_TYPE_P(self, sys::T_ARRAY) } {
+            let len = unsafe { sys::RARRAY_LEN(self) };
+            let ptr = unsafe { sys::RARRAY_PTR(self) };
+            for i in 0..len {
+                let val = unsafe { *ptr.offset(i) };
+                if let Err(error) = val.to_checked() {
+                    return Err(format!("Failed to convert value for Vec<T>: {}", error));
+                }
+            }
+            Ok(unsafe { CheckedValue::<VecWrap<T>>::new(self) })
+        } else {
+            let val = unsafe { CheckedValue::<String>::new(sys::rb_inspect(self)) };
+            Err(format!("No implicit conversion of {} into Vec<String>",
+                        val.to_rust()))
+        }
+    }
+}
+
+impl ToRust<VecWrap<String>> for CheckedValue<VecWrap<String>>
+    where VALUE: UncheckedValue<String>,
+          CheckedValue<String>: ToRust<String>
+{
+    fn to_rust(self) -> VecWrap<String> {
+        let len = unsafe { sys::RARRAY_LEN(self.inner) };
+        let ptr = unsafe { sys::RARRAY_PTR(self.inner) };
+        let mut vec: Vec<String> = Vec::with_capacity(len as usize);
+        for i in 0..len {
+            let val = unsafe { *ptr.offset(i) };
+            let checked = val.to_checked().unwrap();
+            vec.push(checked.to_rust());
+        }
+        return VecWrap(vec);
+    }
+}
+
+impl ToRust<VecWrap<VecWrap<String>>> for CheckedValue<VecWrap<VecWrap<String>>>
+    where VALUE: UncheckedValue<VecWrap<String>>,
+          CheckedValue<VecWrap<String>>: ToRust<VecWrap<String>>
+{
+    fn to_rust(self) -> VecWrap<VecWrap<String>> {
+        let len = unsafe { sys::RARRAY_LEN(self.inner) };
+        let ptr = unsafe { sys::RARRAY_PTR(self.inner) };
+        let mut vec: Vec<VecWrap<String>> = Vec::with_capacity(len as usize);
+        for i in 0..len {
+            let val = unsafe { *ptr.offset(i) };
+            let checked = val.to_checked().unwrap();
+            vec.push(checked.to_rust());
+        }
+        return VecWrap(vec);
+    }
+}
+
+ruby! {
+    class RscsvWriter {
+        def generate_line(row: VecWrap<String>) -> String {
+            let mut writer = csv::Writer::from_memory();
+            writer.write(row.0.into_iter()).unwrap();
+            return writer.into_string();
+        }
+
+        def generate_lines(rows: VecWrap<VecWrap<String>>) -> String {
+            let mut writer = csv::Writer::from_memory();
+            let vec = rows.0;
+
+            for row in vec {
+                writer.write(row.0.into_iter()).unwrap();
+            }
+
+            return writer.into_string();
+        }
+    }
+}

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: rscsv
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ville Lautanala
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: helix_runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+description: Fast CSV using Rust extensions.Currently only writes CSV.
+email:
+- lautis@gmail.com
+executables: []
+extensions:
+- ext/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Cargo.lock
+- Cargo.toml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/benchmark
+- bin/console
+- bin/setup
+- ext/Makefile
+- ext/extconf.rb
+- lib/rscsv.rb
+- lib/rscsv/version.rb
+- rscsv.gemspec
+- src/lib.rs
+homepage: https://github.com/lautis/rscsv
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Rust-powered CSV
+test_files: []