osv 0.3.10 → 0.3.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aed16dbfb14e6caebceb388104731091a5354394cd174804982dbce8f4b95963
-  data.tar.gz: 232497c8ec55ab15559f126c4bc90c6bcd0dd4296efadcbf23d07d6a24c7969d
+  metadata.gz: 593a3c94b6ec0366399485444f4d5d6c45b04393cad30686e04b43f289b93d88
+  data.tar.gz: 9ae3ce1ff2655d65c726680a412336e853f3fa0328756b5dea69186b2c82654b
 SHA512:
-  metadata.gz: 36e1bab13ede785e2f41f0a56b37a2ff7448deff182b614c71e15ccd16799abe94f1f7db63034cd1c04195666c85a12fa0284dde75753b16e05e8767e9c87b18
-  data.tar.gz: '0990fee8e41dd9eb046d6b3733770adb4ef9825165bb0a012b32dac03ddd9d8f2107860d75ef05437aa8d820d42d16c8148642fd3faab326dcab8007731bcf61'
+  metadata.gz: a24c9b58b291d934ae6526e88baddebd768ad4ad431bfab8353b84d4e9f284e954aa2dd80b11138c041613702d56927f3fc4819b9fdcda2a22b5a590ba5459fa
+  data.tar.gz: 0a85ef04fc18b4ef680d669c4fb06310b0cd3a0eb2c6c3c5a0a9161bc5af8b8851bf7ca3c1cb08f3fc6fa2d96449e112b86d0bc47871cbd10cae5ebd332edfb4

data/README.md

@@ -30,38 +30,68 @@ gem install osv
 
 ## Usage
 
-### Basic Usage with Hash Output
-
-Each row is returned as a hash where the keys are the column headers:
+### Reading CSV Files
 
 ```ruby
 require 'osv'
 
-# Read from a file
-OSV.for_each("path/to/file.csv") do |row|
-  # row is a Hash like {"name" => "John", "age" => "25"}
-  puts row["name"]
+# Basic usage - each row as a hash
+OSV.for_each("data.csv") do |row|
+  puts row["name"]  # => "John"
+  puts row["age"]   # => "25"
 end
 
-# Without a block, returns an Enumerator
-rows = OSV.for_each("path/to/file.csv")
+# Return an enumerator instead of using a block
+rows = OSV.for_each("data.csv")
 rows.each { |row| puts row["name"] }
-```
 
-### Array Output Mode
+# 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
+```
 
-If you prefer working with arrays instead of hashes, use `for_each_compat`:
+### Input Sources
 
 ```ruby
-OSV.for_each("path/to/file.csv", result_type: :array) do |row|
-  # row is an Array like ["John", "25"]
-  puts row[0]
-end
+# 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"] }
 ```
 
-### Options
+### Configuration Options
 
-Both methods support the following 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)
+  flexible_default: nil, # Default value for missing fields. If unset, we ignore missing fields.
+                         # Implicitly enables flexible mode if set.
+  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)
+)
+```
+
+#### Available Options
 
 - `has_headers`: Boolean indicating if the first row contains headers (default: true)
 - `col_sep`: String specifying the field separator (default: ",")
@@ -69,35 +99,13 @@ Both methods support the following options:
 - `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
+- `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)
 - `flexible_default`: String specifying the default value for missing fields. Implicitly enables flexible mode if set. (default: `nil`)
 - `trim`: String specifying the trim mode ("all" or "headers" or "fields" or :all or :headers or :fields)
 
-### Input Sources
-
-OSV supports reading from:
-
-- File paths (as strings)
-- IO objects
-  - Important caveat: the IO object must respond to `rb_io_descriptor` with a file descriptor.
-- StringIO objects
-  - Note: when you do this, the string is read (in full) into a Rust string, and we parse it there.
-
-```ruby
-# From file path
-OSV.for_each("path/to/file.csv") { |row| puts row["name"] }
-
-# From IO object
-File.open("path/to/file.csv") do |file|
-  OSV.for_each(file) { |row| puts row["name"] }
-end
-
-# From StringIO
-data = StringIO.new("name,age\nJohn,25")
-OSV.for_each(data) { |row| puts row["name"] }
-```
+When `has_headers` is false, hash keys will be generated as `"c0"`, `"c1"`, etc.
 
 ## Requirements
 

data/Rakefile

@@ -23,6 +23,7 @@ end
 
 task :release do
   sh "bundle exec rake test"
-  sh "gem build osv.gemspec"
-  sh "gem push osv-#{OSV::VERSION}.gem"
+  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

@@ -1,3 +1,3 @@
 module OSV
-  VERSION = "0.3.10"
+  VERSION = "0.3.11"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: osv
 version: !ruby/object:Gem::Version
-  version: 0.3.10
+  version: 0.3.11
 platform: ruby
 authors:
 - Nathan Jaremko
@@ -69,7 +69,7 @@ files:
 - lib/osv/version.rb
 homepage: https://github.com/njaremko/osv
 licenses:
-- NONE
+- MIT
 metadata:
   homepage_uri: https://github.com/njaremko/osv
   source_code_uri: https://github.com/njaremko/osv