censive 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6f156186b0612f198563d23cd09fa0cf65d823a92b031bd71a3e22335163b73
-  data.tar.gz: 6ac6ba05c9ee8cb52d1a3c5573dde803144651c7b4a2f3af9d83596d7365bf1c
+  metadata.gz: 8f5885eeeeab9f57546128e03407fbb1546137c3dfe19edc1a8dc8e08c95ad50
+  data.tar.gz: ed4b2f1ac55b826534c5bf9d854feca86cd2b4ef3cca9a2fab9e1993f3b2d6a4
 SHA512:
-  metadata.gz: a078837538b6693a92586ebc997e0c7564952509991997215f7e0994d5ebaf29fdde4732feb72a2f418c4d2927115f23e1a7948e9f98a071438bff4c7fa8d255
-  data.tar.gz: 3c28503ad4dc72fbcc0140d61e5d94d6ae44d9deb70842b40bd23406438f7de6b3a2557a39271f463ed1acf93f968e5543b8481d2b02b458a04a3389fa7f6e1f
+  metadata.gz: bf304f19bcabdbff428cfbc021807228291eded005c30bb3578bf2530f97dfb73b7fd08f684f39cb2eb5bd159c24ecedc8d6d8a768dd3dba50c3462ff87dc597
+  data.tar.gz: 02fddd62e35fd145ed34d34524c038b3397508eb8bfc81ce66dad2cfd4b4ea4bea931f1685f1f8ae81cdaac027740c5ef73f422c80c566974121ceaa3ed4bb87

data/lib/censive.rb

@@ -4,14 +4,14 @@
 # censive - A quick and lightweight CSV handling library for Ruby
 #
 # Author: Steve Shreeve (steve.shreeve@gmail.com)
-#   Date: June 16, 2023
+#   Date: June 28, 2023
 #
 # https://crystal-lang.org/api/1.7.2/CSV.html (Crystal's CSV library)
 # https://github.com/ruby/strscan/blob/master/ext/strscan/strscan.c
 #
-# Thanks to Sutou Kouhei (kou) for his excellent advice on using scan
+# Thanks to Sutou Kouhei (kou) for his excellent advice on using scan better
 # ============================================================================
-# GOALS:
+# HIGHLIGHTS:
 # 1. Faster than Ruby's default CSV library
 # 2. Lightweight code with streamlined and optimized logic
 # 3. Support most non-compliant CSV variations (@excel, @relax, etc)
@@ -29,15 +29,15 @@ require "stringio"
 require "strscan"
 
 class Censive < StringScanner
-  VERSION="1.0.5"
+  VERSION="1.1.0"
 
   attr :encoding, :out, :rows
 
-  def self.parse(...)
-    new(...).parse
+  def self.read(...)
+    new(...).read
   end
 
-  def self.writer(obj=nil, **opts, &code)
+  def self.write(obj=nil, **opts, &code)
     case obj
     when String
       if block_given?
@@ -48,7 +48,7 @@ class Censive < StringScanner
     when StringIO, IO, nil
       new(out: obj, **opts, &code)
     else
-      abort "#{File.basename($0)}: invalid #{obj.class} object in writer"
+      abort "#{File.basename($0)}: #{self}.write can't use #{obj.class} objects"
     end
   end
 
@@ -124,9 +124,9 @@ class Censive < StringScanner
     super()
   end
 
-  # ==[ Parser ]==
+  # ==[ Reader ]==
 
-  def parse
+  def read
     @rows = []
     while row = next_row
       @rows << row
@@ -189,28 +189,19 @@ class Censive < StringScanner
   end
 
   def each
-    @rows or parse
+    @rows or read
     @rows.each {|row| yield row }
   end
 
-  def to_csv(*args, **opts, &code)
+  # ==[ Writer ]==
+
+  def write(*args, **opts, &code)
     if args.empty? && opts.empty?
       block_given? ? each(&code) : each {|row| @out << row }
     elsif block_given?
-      Censive.writer(*args, **opts, &code)
-    else
-      Censive.writer(*args, **opts) {|csv| each {|row| csv << row }}
-    end
-  end
-
-  # ==[ Helpers ]==
-
-  # returns 2 (must be quoted and escaped), 1 (must be quoted), 0 (neither)
-  def grok(str)
-    if idx = str&.index(@escapes)
-      $1 ? 2 : str.index(@quote, idx) ? 2 : 1
+      Censive.write(*args, **opts, &code)
     else
-      0
+      Censive.write(*args, **opts) {|csv| each {|row| csv << row }}
     end
   end
 
@@ -223,7 +214,7 @@ class Censive < StringScanner
     s,q = @sep, @quote
     out = case @mode
     when :compact
-      case @excel ? 2 : grok(row.join)
+      case @excel ? 2 : quote_type(row.join)
       when 0
         row
       when 1
@@ -233,7 +224,7 @@ class Censive < StringScanner
       else
         row.map do |col|
           @excel && col =~ @leadzero ? "=#{q}#{col}#{q}" :
-          case grok(col)
+          case quote_type(col)
           when 0 then col
           when 1 then "#{q}#{col}#{q}"
           else        "#{q}#{col.gsub(q, @esc)}#{q}"
@@ -253,6 +244,21 @@ class Censive < StringScanner
     @out << out + @rowsep
   end
 
+  # ==[ Helpers ]==
+
+  def bomb(msg)
+    abort "\n#{File.basename($0)}: #{msg} at character #{pos} near '#{string[pos-4,7]}'"
+  end
+
+  # returns 2 (must be quoted and escaped), 1 (must be quoted), 0 (neither)
+  def quote_type(str)
+    if idx = str&.index(@escapes)
+      $1 ? 2 : str.index(@quote, idx) ? 2 : 1
+    else
+      0
+    end
+  end
+
   def stats
     wide = string.size.to_s.size
     puts "%#{wide}d rows"    % @rows.size
@@ -261,9 +267,6 @@ class Censive < StringScanner
     puts "%#{wide}d bytes"   % string.size
   end
 
-  def bomb(msg)
-    abort "\n#{File.basename($0)}: #{msg} at character #{pos} near '#{string[pos-4,7]}'"
-  end
 end
 
 if __FILE__ == $0
@@ -281,7 +284,7 @@ if __FILE__ == $0
   # out = csv.export
   # puts out.out
 
-  puts Censive.parse(str, excel: true, relax: true).to_csv
+  puts Censive.read(str, excel: true, relax: true).write
 end
 
 __END__

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: censive
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - Steve Shreeve
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-27 00:00:00.000000000 Z
+date: 2023-06-28 00:00:00.000000000 Z
 dependencies: []
 description: A quick and lightweight CSV handling library for Ruby
 email: steve.shreeve@gmail.com