csv-utils 0.1.4 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9680eb915003bdf0ea797d2aa736ce5069c4cbbf2f5cfe9f6b0c504701b178cd
-  data.tar.gz: 211e3c84c56aa414fa57ca9b6b15e227f3f4089b2e9bf0a8a4e4d19def5d1a81
+  metadata.gz: '083044bd714b955ff9d5f6a44cf6d4cb3344cf7f649b105d81a94b3ddb1c9425'
+  data.tar.gz: 5fa1cd9acacf10c275a23176e36722e189f8e6d8a85e1bfc7faf18eb45a1ca31
 SHA512:
-  metadata.gz: ebb5a02c8ad2f63c512fe9b0e03e3dadc00d6fe09c96260e4da28a2986efc7bc6d9414d7e03893df39bf9a83f3d25a92da7b6e81a47225fd466d9bf9acb09cc0
-  data.tar.gz: 470637ff20a19c7674604a0afca3654f41c9d8bed496af1198e2dc0fe6c8aa5e9ccacf32e27d9c3cacba0e77914b585463a3644beff9d4eec54e0aaf18ebb9a1
+  metadata.gz: de36fb6c80a68b33c92f3c943a665c419ac1287f5b4b2901c1a60f45964d4b13c2199f53e8dd779b2947d6c86439fa1b1b781cc5ba2225656b2d8b50f690e4cc
+  data.tar.gz: 0a6b5a9301f2386c2ad5bf3009ca77f949a92510ebb606844a1e6bf9fcc573f524966e68d1d8cec7db9778be3c93fb58a006fee9008e531c53a2c5391af6c0c3

data/.ruby-gemset

@@ -0,0 +1 @@
+csv-utils

data/.ruby-version

@@ -0,0 +1 @@
+2.6.3

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source 'http://rubygems.org'
+
+gem 'inheritance-helper'
+
+group :development do
+  gem 'rake'
+  gem 'rubocop'
+end
+
+group :spec do
+  gem 'rspec'
+  gem 'simplecov'
+end

data/Gemfile.lock

@@ -0,0 +1,57 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ast (2.4.1)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    inheritance-helper (0.1.5)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.86.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    ruby-progressbar (1.10.1)
+    simplecov (0.18.5)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  inheritance-helper
+  rake
+  rspec
+  rubocop
+  simplecov
+
+BUNDLED WITH
+   1.17.3

data/bin/csv-change-eol

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+
+require 'csv'
+
+def bold_string(str)
+  "\033[1m#{str}\033[0m"
+end
+  
+USAGE = "Usage: #{bold_string('csv-change-eol')} <csv_file> <end of line character sequence in hex>"
+
+def exit_on_error(msg)
+  $stderr.print <<STR
+Error: #{bold_string(msg)}
+
+#{USAGE}
+
+  End of line example: '7C5E7C0A' is '|^|\\n'
+   - 0A is new line
+   - 0D is carriage return
+
+  Goto: #{bold_string('http://www.asciitable.com/')} for help with the character sequence
+
+STR
+  exit 1
+end
+
+csv_file = ARGV.shift || exit_on_error('no csv file specified')
+eol_sequence = ARGV.shift || exit_on_error('no EOL character sequence specified')
+
+exit_on_error("file #{csv_file} not found") unless File.exist?(csv_file)
+exit_on_error("not a HEX sequece (#{eol_sequence})") unless eol_sequence =~ /\A[0-9a-f]+\z/i
+exit_on_error("incorrect number of characters in (#{eol_sequence}), should be even") unless eol_sequence.size.even?
+
+eol_sequence = [eol_sequence].pack('H*')
+
+
+escaped_csv_file =
+  if csv_file =~ /\.csv$/i
+    csv_file.sub(/(\.csv)$/i, '.escaped-eol\1')
+  else
+    csv_file + '.escaped-eol'
+  end
+
+
+File.open(escaped_csv_file, 'wb') do |out|
+  CSV.foreach(csv_file) do |row|
+    line = row.to_csv
+    line.rstrip!
+    line.concat(eol_sequence)
+    out.write line
+  end
+end
+
+puts escaped_csv_file

data/bin/csv-readline

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+require 'optparse'
+
 BYTE_ORDER_MARKS = {
   "\xEF\xBB\xBF".force_encoding('ASCII-8BIT') => 'UTF-8',
   "\xFE\xFF".force_encoding('ASCII-8BIT') => 'UTF-16',
@@ -25,11 +27,12 @@ def csv_parse_line(line)
   last_comma_pos = -1
   column = 1
 
-  while pos = line.index(/([",])/, pos + 1)
+  while pos = line.index(/([",\n])/, pos + 1)
     case line[pos]
     when '"'
       if opened_quote
         if line[pos+1] == ',' ||
+           line[pos+1] == "\r" ||
            line[pos+1] == "\n" ||
            line[pos+1].nil?
           opened_quote = false
@@ -61,7 +64,8 @@ def csv_parse_line(line)
           opened_quote = true
         end
       end
-    when ','
+    when ',',
+         "\n"
       if ! opened_quote
         column += 1
         columns << [line[last_comma_pos + 1, pos - last_comma_pos - 1], :ok]
@@ -94,6 +98,22 @@ def parse_csv_row(file, lineno, number_of_lines)
   csv_parse_line(str)
 end
 
+options = {
+  all_columns: false
+}
+OptionParser.new do |opts|
+  opts.banner = 'Usage: ' + File.basename(__FILE__) + ' [options] <csv file> <line number> [<number of lines>]'
+
+  opts.on('-h', '--help', 'Prints this help') do
+    puts opts
+    exit
+  end
+
+  opts.on('-a', '--all', 'Display all columns') do
+    options[:all_columns] = true
+  end
+end.parse!
+
 file = File.open(ARGV[0], 'rb')
 lineno = ARGV[1].to_i
 number_of_lines = (ARGV[2] || 1).to_i
@@ -108,7 +128,7 @@ file.close
 cnt = 0
 data.each do |k, (v, status)|
   cnt += 1
-  next if empty_column?(v)
+  next if !options[:all_columns] && empty_column?(v)
   if status == :ok
     puts sprintf('  %-3d %s: %s', cnt, k, v)
   else

data/csv-utils.gemspec

@@ -2,7 +2,8 @@
 
 Gem::Specification.new do |s|
   s.name        = 'csv-utils'
-  s.version     = '0.1.4'
+  s.version     = '0.2.1'
+  s.licenses    = ['MIT']
   s.summary     = 'CSV Utils'
   s.description = 'Tools for debugging malformed CSV files'
   s.authors     = ['Doug Youch']
@@ -11,4 +12,6 @@ Gem::Specification.new do |s|
   s.files       = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   s.bindir      = 'bin'
   s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+
+  s.add_runtime_dependency 'inheritance-helper'
 end

data/lib/csv-utils.rb

@@ -0,0 +1,9 @@
+require 'csv'
+
+# Collection of tools for working with CSV files.
+module CSVUtils
+  autoload :CSVExtender, 'csv_utils/csv_extender'
+  autoload :CSVOptions, 'csv_utils/csv_options'
+  autoload :CSVReport, 'csv_utils/csv_report'
+  autoload :CSVRow, 'csv_utils/csv_row'
+end

data/lib/csv_utils/csv_extender.rb

@@ -0,0 +1,76 @@
+# Utility class for appending data to a csv file.
+class CSVUtils::CSVExtender
+  attr_reader :csv_file,
+              :new_csv_file,
+              :csv_options
+
+  def initialize(csv_file, new_csv_file, csv_options = {})
+    @csv_file = csv_file
+    @new_csv_file = new_csv_file
+    @csv_options = csv_options
+  end
+
+  def append(additional_headers)
+    process(additional_headers) do |current_headers|
+      while (row = src.shift)
+        additional_columns = yield row, current_headers
+        dest << (row + additional_columns)
+      end
+    end
+  end
+
+  def append_in_batches(additional_headers, batch_size = 1_000)
+    process(additional_headers) do |current_headers|
+      batch = []
+
+      process_batch_proc = Proc.new do
+        additional_rows = yield batch, current_headers
+
+        batch.each_with_index do |row, idx|
+          dest << (row + additional_rows[idx])
+        end
+
+        batch = []
+      end
+
+      while (row = src.shift)
+        batch << row
+
+        process_batch_proc.call if batch.size >= batch_size
+      end
+
+      process_batch_proc.call if batch.size > 0
+    end
+  end
+
+  def process(additional_headers)
+    current_headers = append_headers(additional_headers)
+
+    yield current_headers
+
+    close
+  end
+
+  def src
+    @src ||= CSV.open(csv_file, 'rb', csv_options)
+  end
+
+  def dest
+    @dest ||= CSV.open(new_csv_file, 'wb', csv_options)
+  end
+
+  def close
+    src.close
+    dest.close
+  end
+
+  private
+
+  def append_headers(additional_headers)
+    return nil unless additional_headers
+
+    current_headers = src.shift
+    dest << (current_headers + additional_headers)
+    current_headers
+  end
+end

data/lib/csv_utils/csv_options.rb

@@ -0,0 +1,87 @@
+# Auto detect a csv files options
+module CSVUtils
+  class CSVOptions
+
+    # this list is from https://en.wikipedia.org/wiki/Byte_order_mark
+    BYTE_ORDER_MARKS = {
+      "\xEF\xBB\xBF".force_encoding('ASCII-8BIT') => 'UTF-8',
+      "\xFE\xFF".force_encoding('ASCII-8BIT') => 'UTF-16',
+      "\xFF\xFE".force_encoding('ASCII-8BIT') => 'UTF-16',
+      "\x00\x00\xFE\xFF".force_encoding('ASCII-8BIT') => 'UTF-32',
+      "\xFF\xFE\x00\x00".force_encoding('ASCII-8BIT') => 'UTF-32'
+    }
+
+    COL_SEPARATORS = [
+      "\x02",
+      "\t",
+      '|',
+      ','
+    ]
+
+    ROW_SEPARATORS = [
+      "\r\n",
+      "\n",
+      "\r"
+    ]
+
+    attr_reader :columns,
+                :byte_order_mark,
+                :encoding,
+                :col_separator,
+                :row_separator
+    
+
+    def initialize(io)
+      line =
+        if io.is_a?(String)
+          File.open(io, 'rb', &:readline)
+        else
+          io.readline
+        end
+
+      @col_separator = auto_detect_col_sep(line)
+      @row_separator = auto_detect_row_sep(line)
+      @byte_order_mark = get_byte_order_mark(line)
+      @encoding = get_character_encoding(@byte_order_mark)
+      @columns = get_number_of_columns(line) if @col_separator
+    end
+
+    def valid?
+      return false if @col_separator.nil? || @row_separator.nil?
+
+      true
+    end
+
+    def auto_detect_col_sep(line)
+      COL_SEPARATORS.detect { |sep| line.include?(sep) }
+    end
+
+    def auto_detect_row_sep(line)
+      ROW_SEPARATORS.detect { |sep| line.include?(sep) }
+    end
+
+    def get_headers(line)
+      headers = line.split(col_separator)
+      headers[0] = strip_byte_order_marks(headers[0])
+      headers
+    end
+
+    def get_number_of_columns(line)
+      get_headers(line).size
+    end
+
+    def get_byte_order_mark(line)
+      BYTE_ORDER_MARKS.keys.detect do |bom|
+        line =~ /\A#{bom}/
+      end
+    end
+
+    def get_character_encoding(bom)
+      BYTE_ORDER_MARKS[bom] || 'UTF-8'
+    end
+
+    def strip_byte_order_marks(header)
+      @byte_order_marks ? header.sub(@byte_order_marks, '') : header
+    end
+  end
+end

data/lib/csv_utils/csv_report.rb

@@ -0,0 +1,40 @@
+# Builds a csv file from csv rows
+module CSVUtils
+  class CSVReport
+    attr_reader :csv,
+                :must_close
+
+    def initialize(csv, csv_options = {}, &block)
+      @csv =
+        if csv.is_a?(String)
+          @must_close = true
+          mode = csv_options.delete(:mode) || 'wb'
+          CSV.open(csv, mode, csv_options)
+        else
+          @must_close = false
+          csv
+        end
+
+      generate(&block) if block
+    end
+
+    def generate
+      yield self
+      @csv.close if @must_close
+    end
+
+    def append(csv_row)
+      @csv <<
+        if csv_row.is_a?(Array)
+          csv_row
+        else
+          csv_row.to_a
+        end
+    end
+    alias << append
+
+    def add_headers(csv_row)
+      append(csv_row.is_a?(Array) ? csv_row : csv_row.csv_headers)
+    end
+  end
+end

data/lib/csv_utils/csv_row.rb

@@ -0,0 +1,51 @@
+require 'inheritance-helper'
+
+module CSVUtils
+  module CSVRow
+    def self.included(base)
+      base.extend InheritanceHelper::Methods
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def csv_columns
+        {}
+      end
+
+      def csv_column(header, options = {}, &block)
+        options[:header] ||= header.to_s
+
+        if block
+          options[:proc] = block
+        elsif options[:proc].nil?
+          options[:method] ||= header
+        end
+
+        add_value_to_class_method(:csv_columns, header => options)
+      end
+    end
+
+    def csv_headers
+      self.class.csv_columns.values.map { |column_options| csv_column_header(column_options) }
+    end
+
+    def csv_row
+      self.class.csv_columns.values.map { |column_options| csv_column_value(column_options) }
+    end
+    alias_method :to_a, :csv_row
+
+    private
+
+    def csv_column_header(column_options)
+      column_options[:header]
+    end
+
+    def csv_column_value(column_options)
+      if column_options[:proc]
+        instance_eval(&column_options[:proc])
+      else
+        send(column_options[:method])
+      end
+    end
+  end
+end

data/script/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH << File.expand_path('../lib', __dir__)
+require 'csv-utils'
+require 'irb'
+IRB.start(__FILE__)

metadata

@@ -1,33 +1,60 @@
 --- !ruby/object:Gem::Specification
 name: csv-utils
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.1
 platform: ruby
 authors:
 - Doug Youch
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-05-14 00:00:00.000000000 Z
-dependencies: []
+date: 2020-07-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: inheritance-helper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Tools for debugging malformed CSV files
 email: dougyouch@gmail.com
 executables:
+- csv-change-eol
 - csv-find-error
 - csv-readline
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
+- bin/csv-change-eol
 - bin/csv-find-error
 - bin/csv-readline
 - csv-utils.gemspec
+- lib/csv-utils.rb
+- lib/csv_utils/csv_extender.rb
+- lib/csv_utils/csv_options.rb
+- lib/csv_utils/csv_report.rb
+- lib/csv_utils/csv_row.rb
+- script/console
 homepage: https://github.com/dougyouch/csv-utils
-licenses: []
+licenses:
+- MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -42,8 +69,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
 summary: CSV Utils
 test_files: []