osv 0.4.4-x86_64-linux-musl

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d6747117ae8fbacec9229ff9c3d6f96e4c08ae32635f65b929e109c9fe66c197
+  data.tar.gz: 843891956c678a14900935ab4de46e72d2b87e99a979162757613b3c8bd5650b
+SHA512:
+  metadata.gz: 9409486c47ccc16741964f0c2e9f2b41bbd6c7cd62b653d4146608723c603d96f082a00836204dea4b32cb490096021fb401c63de6e81151fdde29b500a04df4
+  data.tar.gz: d83e41f6c247a8dbe80eaf5a25ff7aec69bcadc1b309556082fe14b1c9a75c4ffa86c64bf33ea159a2475a839dc2e12863552131b37202c90de73560438abcbb

data/Gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+
+gem "rb_sys", "~> 0.9.56"
+gem "rake"
+
+# Use local version of osv
+gemspec
+
+group :development, :test do
+  gem "csv"
+  gem "minitest", "~> 5.0"
+  gem "benchmark-ips", "~> 2.12"
+  gem "fastcsv", "~> 0.0.7"
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Nathan Jaremko
+
+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,176 @@
+# OSV
+
+[![Gem Version](https://badge.fury.io/rb/osv.svg)](https://badge.fury.io/rb/osv)
+
+OSV is a high-performance CSV parser for Ruby, implemented in Rust. It wraps BurntSushi's excellent [csv-rs](https://github.com/BurntSushi/rust-csv) crate.
+
+It provides a simple interface for reading CSV files with support for both hash-based and array-based row formats.
+
+The array-based mode is faster than the hash-based mode, so if you don't need the hash keys, use the array-based mode.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'osv'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it directly:
+
+```bash
+gem install osv
+```
+
+## Usage
+
+### Reading CSV Files
+
+```ruby
+require 'osv'
+
+# Basic usage - each row as a hash
+OSV.for_each("data.csv") do |row|
+  puts row["name"]  # => "John"
+  puts row["age"]   # => "25"
+end
+
+# Return an enumerator instead of using a block
+rows = OSV.for_each("data.csv")
+rows.each { |row| puts row["name"] }
+
+# High-performance array mode
+OSV.for_each("data.csv", result_type: :array) do |row|
+  puts row[0]  # First column
+  puts row[1]  # Second column
+end
+```
+
+### Input Sources
+
+```ruby
+# From a file path
+OSV.for_each("data.csv") { |row| puts row["name"] }
+
+# From a file path
+OSV.for_each("data.csv.gz") { |row| puts row["name"] }
+
+# From an IO object
+File.open("data.csv") { |file| OSV.for_each(file) { |row| puts row["name"] } }
+
+# From a string
+data = StringIO.new("name,age\nJohn,25")
+OSV.for_each(data) { |row| puts row["name"] }
+```
+
+### Configuration Options
+
+```ruby
+OSV.for_each("data.csv",
+  # Input formatting
+  has_headers: true,     # First row contains headers (default: true)
+  col_sep: ",",          # Column separator (default: ",")
+  quote_char: '"',       # Quote character (default: '"')
+
+  # Output formatting
+  result_type: :hash,    # :hash or :array (hash is default)
+  nil_string: nil,       # String to interpret as nil when parsing (default: nil)
+
+  # Parsing behavior
+  flexible: false,       # Allow varying number of fields (default: false)
+  trim: :all,            # Whether to trim whitespace. Options are :all, :headers, or :fields (default: nil)
+  buffer_size: 1024,     # Number of rows to buffer in memory (default: 1024)
+  ignore_null_bytes: false, # Boolean specifying if null bytes should be ignored (default: false)
+  lossy: false,             # Boolean specifying if invalid UTF-8 characters should be replaced with a replacement character (default: false)
+)
+```
+
+#### Available Options
+
+- `has_headers`: Boolean indicating if the first row contains headers (default: true)
+- `col_sep`: String specifying the field separator (default: ",")
+- `quote_char`: String specifying the quote character (default: "\"")
+- `nil_string`: String that should be interpreted as nil
+  - by default, empty strings are interpreted as empty strings
+  - if you want to interpret empty strings as nil, set this to an empty string
+- `buffer_size`: Integer specifying the number of rows to buffer in memory (default: 1024)
+- `result_type`: String specifying the output format ("hash" or "array" or :hash or :array)
+- `flexible`: Boolean specifying if the parser should be flexible (default: false)
+- `trim`: String specifying the trim mode ("all" or "headers" or "fields" or :all or :headers or :fields)
+- `ignore_null_bytes`: Boolean specifying if null bytes should be ignored (default: false)
+- `lossy`: Boolean specifying if invalid UTF-8 characters should be replaced with a replacement character (default: false)
+
+When `has_headers` is false, hash keys will be generated as `"c0"`, `"c1"`, etc.
+
+## Requirements
+
+- Ruby >= 3.1.0
+- Rust toolchain (for installation from source)
+
+## Performance
+
+This library is faster than the standard Ruby CSV library. It's also faster than any other CSV gem I've been able to find.
+
+Here's some unscientific benchmarks. You can find the code in the [benchmark/comparison_benchmark.rb](benchmark/comparison_benchmark.rb) file.
+
+### 1,000,000 records
+
+```
+🏃 Running benchmarks...
+Benchmarking with 3000001 lines of data
+
+ruby 3.3.6 (2024-11-05 revision 75015d4c1f) +YJIT [arm64-darwin24]
+Warming up --------------------------------------
+      CSV - StringIO     1.000 i/100ms
+  FastCSV - StringIO     1.000 i/100ms
+      OSV - StringIO     1.000 i/100ms
+   CSV - Hash output     1.000 i/100ms
+   OSV - Hash output     1.000 i/100ms
+  CSV - Array output     1.000 i/100ms
+  OSV - Array output     1.000 i/100ms
+FastCSV - Array output
+                         1.000 i/100ms
+OSV - Direct Open Array output
+                         1.000 i/100ms
+       OSV - Gzipped     1.000 i/100ms
+OSV - Gzipped Direct     1.000 i/100ms
+   FastCSV - Gzipped     1.000 i/100ms
+       CSV - Gzipped     1.000 i/100ms
+Calculating -------------------------------------
+      CSV - StringIO      0.083 (± 0.0%) i/s    (12.06 s/i) -      3.000 in  36.304469s
+  FastCSV - StringIO      0.335 (± 0.0%) i/s     (2.98 s/i) -     10.000 in  31.019521s
+      OSV - StringIO      0.705 (± 0.0%) i/s     (1.42 s/i) -     21.000 in  30.629511s
+   CSV - Hash output      0.060 (± 0.0%) i/s    (16.74 s/i) -      2.000 in  33.475977s
+   OSV - Hash output      0.434 (± 0.0%) i/s     (2.30 s/i) -     13.000 in  30.071679s
+  CSV - Array output      0.063 (± 0.0%) i/s    (15.88 s/i) -      2.000 in  32.229906s
+  OSV - Array output      0.406 (± 0.0%) i/s     (2.47 s/i) -     12.000 in  31.072600s
+FastCSV - Array output
+                          0.321 (± 0.0%) i/s     (3.11 s/i) -     10.000 in  31.458966s
+OSV - Direct Open Array output
+                          0.686 (± 0.0%) i/s     (1.46 s/i) -     21.000 in  30.639715s
+       OSV - Gzipped      0.524 (± 0.0%) i/s     (1.91 s/i) -     16.000 in  30.695259s
+OSV - Gzipped Direct      0.519 (± 0.0%) i/s     (1.93 s/i) -     16.000 in  30.830005s
+   FastCSV - Gzipped      0.313 (± 0.0%) i/s     (3.20 s/i) -     10.000 in  32.031002s
+       CSV - Gzipped      0.057 (± 0.0%) i/s    (17.55 s/i) -      2.000 in  35.107808s
+
+Comparison:
+      OSV - StringIO          : 0.7 i/s
+OSV - Direct Open Array output: 0.7 i/s - 1.03x  slower
+       OSV - Gzipped          : 0.5 i/s - 1.34x  slower
+OSV - Gzipped Direct          : 0.5 i/s - 1.36x  slower
+   OSV - Hash output          : 0.4 i/s - 1.62x  slower
+  OSV - Array output          : 0.4 i/s - 1.74x  slower
+  FastCSV - StringIO          : 0.3 i/s - 2.10x  slower
+FastCSV - Array output        : 0.3 i/s - 2.20x  slower
+   FastCSV - Gzipped          : 0.3 i/s - 2.26x  slower
+      CSV - StringIO          : 0.1 i/s - 8.50x  slower
+  CSV - Array output          : 0.1 i/s - 11.20x  slower
+   CSV - Hash output          : 0.1 i/s - 11.80x  slower
+       CSV - Gzipped          : 0.1 i/s - 12.37x  slower
+```

data/Rakefile

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "rake/testtask"
+require "rb_sys/extensiontask"
+
+task default: :test
+
+GEMSPEC = Gem::Specification.load("osv.gemspec")
+
+platforms = [
+  "x86_64-linux",
+  "x86_64-linux-musl",
+  "aarch64-linux",
+  "aarch64-linux-musl",
+  "x86_64-darwin",
+  "arm64-darwin"
+]
+
+RbSys::ExtensionTask.new("osv", GEMSPEC) do |ext|
+  ext.lib_dir = "lib/osv"
+  ext.ext_dir = "ext/osv"
+  ext.cross_compile = true
+  ext.cross_platform = platforms
+  ext.cross_compiling do |spec|
+    spec.dependencies.reject! { |dep| dep.name == "rb_sys" }
+    spec.files.reject! { |file| File.fnmatch?("ext/*", file, File::FNM_EXTGLOB) }
+  end
+end
+
+Rake::TestTask.new do |t|
+  t.deps << :compile
+  t.test_files = FileList[File.expand_path("test/*_test.rb", __dir__)]
+  t.libs << "lib"
+  t.libs << "test"
+end
+
+task :release do
+  sh "bundle exec rake test"
+  sh "mkdir -p pkg"
+  sh "gem build osv.gemspec -o pkg/osv-#{OSV::VERSION}.gem"
+  sh "gem push pkg/osv-#{OSV::VERSION}.gem"
+end

data/lib/osv/version.rb

@@ -0,0 +1,3 @@
+module OSV
+  VERSION = "0.4.4"
+end

data/lib/osv.rb

@@ -0,0 +1,10 @@
+require_relative "osv/version"
+
+begin
+  require "osv/#{RUBY_VERSION.to_f}/osv"
+rescue LoadError
+  require "osv/osv"
+end
+
+module OSV
+end

data/lib/osv.rbi

@@ -0,0 +1,56 @@
+# typed: strict
+
+module OSV
+  # Options:
+  #   - `has_headers`: Boolean indicating if the first row contains headers
+  #                    (default: true)
+  #   - `col_sep`: String specifying the field separator
+  #                (default: ",")
+  #   - `quote_char`: String specifying the quote character
+  #                   (default: "\"")
+  #   - `nil_string`: String that should be interpreted as nil
+  #                   By default, empty strings are interpreted as empty strings.
+  #                   If you want to interpret empty strings as nil, set this to
+  #                   an empty string.
+  #   - `buffer_size`: Integer specifying the read buffer size
+  #   - `result_type`: String specifying the output format
+  #                    ("hash" or "array" or :hash or :array)
+  #   - `flexible`: Boolean specifying if the parser should be flexible
+  #                 (default: false)
+  #   - `trim`: String specifying the trim mode
+  #             ("all" or "headers" or "fields" or :all or :headers or :fields)
+  #             (default: `nil`)
+  #   - `ignore_null_bytes`: Boolean specifying if null bytes should be ignored
+  #                         (default: false)
+  #   - `lossy`: Boolean specifying if invalid UTF-8 characters should be replaced with a replacement character
+  sig do
+    params(
+      input: T.any(String, StringIO, IO),
+      has_headers: T.nilable(T::Boolean),
+      col_sep: T.nilable(String),
+      quote_char: T.nilable(String),
+      nil_string: T.nilable(String),
+      buffer_size: T.nilable(Integer),
+      result_type: T.nilable(T.any(String, Symbol)),
+      flexible: T.nilable(T::Boolean),
+      ignore_null_bytes: T.nilable(T::Boolean),
+      trim: T.nilable(T.any(String, Symbol)),
+      blk: T.nilable(T.proc.params(row: T.any(T::Hash[String, T.nilable(String)], T::Array[T.nilable(String)])).void)
+    ).returns(T.any(Enumerator, T.untyped))
+  end
+  def self.for_each(
+    input,
+    has_headers: true,
+    col_sep: nil,
+    quote_char: nil,
+    nil_string: nil,
+    buffer_size: nil,
+    result_type: nil,
+    flexible: nil,
+    ignore_null_bytes: nil,
+    trim: nil,
+    lossy: nil,
+    &blk
+  )
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: osv
+version: !ruby/object:Gem::Version
+  version: 0.4.4
+platform: x86_64-linux-musl
+authors:
+- Nathan Jaremko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2025-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+description: |2
+      OSV is a high-performance CSV parser for Ruby, implemented in Rust.
+      It wraps BurntSushi's csv-rs crate to provide fast CSV parsing with support for both hash-based and array-based row formats.
+      Features include: Flexible input sources (file paths, gzipped files, IO objects, strings),
+      configurable parsing options (headers, separators, quote chars), support for both hash and array output formats,
+      whitespace trimming options, strict or flexible parsing modes, and is significantly faster than Ruby's standard CSV library.
+email:
+- nathan@jaremko.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/osv.rb
+- lib/osv.rbi
+- lib/osv/3.2/osv.so
+- lib/osv/3.3/osv.so
+- lib/osv/3.4/osv.so
+- lib/osv/version.rb
+homepage: https://github.com/njaremko/osv
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/njaremko/osv
+  source_code_uri: https://github.com/njaremko/osv
+  readme_uri: https://github.com/njaremko/osv/blob/main/README.md
+  changelog_uri: https://github.com/njaremko/osv/blob/main/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/osv
+  funding_uri: https://github.com/sponsors/njaremko
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: 3.5.dev
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.23
+signing_key: 
+specification_version: 4
+summary: CSV parser for Ruby
+test_files: []