censive 0.6 → 0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fd3e9feff7e7610f300de0896977b7403ad161178c1f4cd28ef9c5248f8b9d1
-  data.tar.gz: 8ac7307f60706052caafa0f1b6c1a28dd4385d33275dfa73af69e29b29471897
+  metadata.gz: 6419efcdc9274ea8bcf7b8527001e33f8bdfea348dfd911686cab36984d507da
+  data.tar.gz: 3b59aead54517fd64d7ece3eaa6f459e301e1e48f1ae34772a7128c61fb739f2
 SHA512:
-  metadata.gz: ccc3de3e28e7fe7463acd86423f8391cad49238363ea4631727202639815fac10554a1bd388450d07422578ac04840d0b37c464dd56e3f600e7f4b732c6b4fee
-  data.tar.gz: 5304136792442e52d339bd9c86db318104773665b041c5d62ed18e74b1d50dcb0fe1b135ae6e9accffccb883aef34b05bc1f6d0b1681826faf9334d18ed0624e
+  metadata.gz: 7910c09e76a81ed27870ea52fb6c8aea0316ed213c53a026d98adc64f93349477e6acab0a93b88c6f184ce1d317634ecdca9290d50bff9b117b98bedd3ac7b86
+  data.tar.gz: 358ab985947d486b5f486b1f7e9c1f591e3b8e906b9eab59a4ed151e5f5d9652c211f2d2a4ee36f0543227e2ae5e33ba57f1e4c178f6f7e72e05c14d7b46895f

data/README.md

@@ -1,6 +1,6 @@
 # censive
 
-A quick and lightweight CVS handling library for Ruby
+A quick and lightweight CSV handling library for Ruby
 
 ## Writing CSV
 

data/censive.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name        = "censive"
-  s.version     = "0.6"
+  s.version     = "0.8"
   s.author      = "Steve Shreeve"
   s.email       = "steve.shreeve@gmail.com"
-  s.summary     = "A quick and lightweight CVS handling library for Ruby"
-  s.description = "A quick and lightweight CVS handling library for Ruby"
+  s.summary     = "A quick and lightweight CSV handling library for Ruby"
+  s.description = "A quick and lightweight CSV handling library for Ruby"
   s.homepage    = "https://github.com/shreeve/censive"
   s.license     = "MIT"
   s.files       = `git ls-files`.split("\n") - %w[.gitignore]

data/lib/censive.rb

@@ -5,6 +5,8 @@
 #
 # Author: Steve Shreeve (steve.shreeve@gmail.com)
 #   Date: Jan 30, 2023
+#
+# Thanks: Crystal's CSV library, see https://crystal-lang.org/api/1.7.2/CSV.html
 # ==============================================================================
 # The goals are:
 #
@@ -15,10 +17,7 @@
 #
 # 1. Option to support IO streaming
 # 2. Option to strip whitespace
-# 3. Option to change output line endings
-# 4. Option to force quotes in output
-# 5. Option to allow reading excel CSV (="Text" for cells)
-# 6. Confirm file encodings such as UTF-8, UTF-16, etc.
+# 3. Confirm file encodings such as UTF-8, UTF-16, etc.
 #
 # NOTE: Only getch and scan_until advance strscan's position
 # ==============================================================================
@@ -36,81 +35,98 @@ class Censive < StringScanner
   def initialize(str=nil,
     sep:   ','     , # column separator character
     quote: '"'     , # quote character
-    out:   nil     , # output IO/file
-    mode:  :compact, # export mode: compact or full
+
     drop:  false   , # enable to drop trailing separators
-    eol:   "\n"      # desired line endings for exports
+    eol:   "\n"    , # desired line endings for exports
+    excel: false   , # allow ,="0123" style columns
+    mode:  :compact, # export mode: compact or full
+    out:   nil     , # output IO/file
+    relax: false   , # relax parsing of quotes
+
+    **opts           # grab bag
   )
     super(str || '')
     reset
 
-    @sep   = sep  .freeze
-    @quote = quote.freeze
-    @out   = out
-    @mode  = mode
-    @drop  = drop
-    @eol   = eol.freeze
-
-    @es    = ""   .freeze
-    @cr    = "\r" .freeze
-    @lf    = "\n" .freeze
-    @esc   = (@quote * 2).freeze
+    @sep    = sep  .freeze
+    @quote  = quote.freeze
+
+    @drop   = drop
+    @eol    = eol.freeze
+    @mode   = mode
+    @out    = out
+    @relax  = relax
+
+    @es     = ""   .freeze
+    @cr     = "\r" .freeze
+    @lf     = "\n" .freeze
+    @eq     = "="  .freeze
+    @esc    = (@quote * 2).freeze
+
+    @tokens = [@sep,@quote,@cr,@lf,@es,nil]
+    @tokens << @eq if excel # See http://bit.ly/3Y7jIvc
   end
 
   def reset(str=nil)
     self.string = str if str
     super()
-    @char  = string[pos]
-    @flag  = nil
+    @char = peek(1)
+    @flag = nil
 
-    @rows  = nil
-    @cols  = @cells = 0
+    @rows = nil
+    @cols = @cells = 0
   end
 
   # ==[ Lexer ]==
 
   def next_char
     getch
-    @char = string[pos]
+    @char = peek(1)
   end
 
   def next_token
     case @flag
-    when @es then @flag = nil; [@cr,@lf,nil].include?(@char) and return @es
+    when @es then @flag = nil; [@cr,@lf,@es,nil].include?(@char) and return @es
     when @cr then @flag = nil; next_char == @lf and next_char
     when @lf then @flag = nil; next_char
     end if @flag
 
-    if [@sep,@quote,@cr,@lf,nil].include?(@char)
+    if @tokens.include?(@char)
       case @char
-      when @quote # consume_quoted_cell
+      when @quote, @eq # consume quoted cell
+        @char == @eq and next_char # excel mode: allows ,="012",
         match = ""
         while true
           getch # consume the quote (optimized by not calling next_char)
           match << (scan_until(/(?=#{@quote})/o) or bomb "unclosed quote")
           case next_char
-          when @sep        then @flag = @es; next_char; break
-          when @quote      then match << @quote
-          when @cr,@lf,nil then break
-          else bomb "unexpected character after quote"
+          when @sep            then @flag = @es; next_char; break
+          when @quote          then match << @quote
+          when @cr,@lf,@es,nil then break
+          else
+            if @relax
+              match << @quote + @char
+            else
+              bomb "invalid character after quote"
+            end
           end
         end
         match
-      when @sep then @flag = @es; next_char; @es
-      when @cr  then @flag = @cr; nil
-      when @lf  then @flag = @lf; nil
-      when nil  then nil
+      when @sep    then @flag = @es; next_char; @es
+      when @cr     then @flag = @cr; nil
+      when @lf     then @flag = @lf; nil
+      when @es,nil then              nil
       end
-    else # consume_unquoted_cell
+    else # consume unquoted cell
       match = scan_until(/(?=#{@sep}|#{@cr}|#{@lf}|\z)/o) or bomb "unexpected character"
-      @char = string[pos]
+      @char = peek(1)
       @char == @sep and @flag = @es and next_char
       match
     end
   end
 
   def bomb(msg)
-    abort "#{File.basename($0)}: #{msg} at character #{pos} near '#{string[pos-4,7]}'"
+    abort "\n#{File.basename($0)}: #{msg} at character #{pos} near '#{string[pos-4,7]}'"
   end
 
   # ==[ Parser ]==
@@ -135,7 +151,7 @@ class Censive < StringScanner
 
   # ==[ Helpers ]==
 
-  # grok returns 2 (seps and quotes), 1 (seps only), 0 (neither)
+  # grok returns: 2 for seps and quotes, 1 for seps only, and 0 for neither
   def grok(str)
     if pos = str.index(/(#{@quote})|#{@sep}/o)
       $1 ? 2 : str.index(/#{@quote}/o, pos) ? 2 : 1
@@ -147,6 +163,9 @@ class Censive < StringScanner
   def <<(row)
     @out or return super
 
+    # drop trailing seps, if specified
+    row.pop while row.last.empty? if @drop
+
     # most compact export format
     s,q = @sep, @quote
     out = case @mode
@@ -167,9 +186,6 @@ class Censive < StringScanner
       row.map {|col| "#{q}#{col.gsub(q, @esc)}#{q}" }
     end.join(s)
 
-    # drop trailing seps, if specified
-    out.gsub!(/#{s}+\z/,'') if @drop
-
     # write output, using desired line endings
     @out << out + @eol
   end
@@ -188,31 +204,29 @@ class Censive < StringScanner
   end
 end
 
-# ==[ Playground... ]==
+__END__
 
-data = File.read('1.csv')
-
-Censive.writer('out.csv', sep: ',', quote: "'") do |out|
-  Censive.new(data).each do |row|
-    out << row
-  end
-end
+# ==[ Playground... ]==
 
-#
-# ARGV << "z.csv" if ARGV.empty?
-#
-# case 1
-# when 1
-#   path = ARGV.first
-#   data = File.read(path)
-# when 2
-#   data = DATA.gets("\n\n").rstrip
-# end
-#
 # STDOUT.sync = true
 #
-# csv = Censive.new(data)
+# data = File.read('1.csv')
 #
-# data.size > 1e6 ? csv.parse : csv.parse.each {|cols| p cols }
+# Censive.writer('out.csv') do |out|
+#   Censive.new(data, relax: true, excel: true).each do |row|
+#     out << row
+#   end
+# end
 #
-# csv.stats
+# __END__
+
+ARGV << "z.csv" if ARGV.empty?
+
+path = ARGV.first
+data = File.read(path)
+
+csv = Censive.new(data)
+
+data.size > 1e6 ? csv.parse : csv.parse.each {|cols| p cols }
+
+csv.stats

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: censive
 version: !ruby/object:Gem::Version
-  version: '0.6'
+  version: '0.8'
 platform: ruby
 authors:
 - Steve Shreeve
@@ -10,7 +10,7 @@ bindir: bin
 cert_chain: []
 date: 2023-01-31 00:00:00.000000000 Z
 dependencies: []
-description: A quick and lightweight CVS handling library for Ruby
+description: A quick and lightweight CSV handling library for Ruby
 email: steve.shreeve@gmail.com
 executables: []
 extensions: []
@@ -43,5 +43,5 @@ requirements: []
 rubygems_version: 3.4.5
 signing_key:
 specification_version: 4
-summary: A quick and lightweight CVS handling library for Ruby
+summary: A quick and lightweight CSV handling library for Ruby
 test_files: []