wtf_csv 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 94b4fdd4e3201ed522d4867b95a5d93d4327b00e
-  data.tar.gz: 6782a9fe9282463989816d7532dbd6f5862412bd
+  metadata.gz: a45b42eec0958f8aad1ee1bf538d3962e9fea3e1
+  data.tar.gz: aaf58a2d7f69f7439940685068e5ac121ad51a59
 SHA512:
-  metadata.gz: d28528baac8f1d4dec98c5085a363595ad6930710d28d46f64dda87398b3ec872149c0bab36a8f0fe761953d751e00097632b5a62e23b5e7553127c26715b8a8
-  data.tar.gz: 77ab306c01fc249efe80b2f27976475da2c111348d490257ec2a2188ae5404b2f2bcb320ff3f36a0f5b6e071523055becaac752212015d055e460ecb3a4d825b
+  metadata.gz: 87e0bc2762ccf9f5161f82bd3db7339fe851afc78e64ad07a8020c70068b42f1c8ac31bdec80d0083daaf3498131862ac679f7731a503b576109e95b42dd3f80
+  data.tar.gz: c37b98ab992b82c716936d8ce14e98d2cae900f23888523bb073472e1bf1fae20c8e0acf5090ff91d1edff59c0be2850669d33c9d1833b839cabcefc87ead635

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+bundler_args: --without development
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - 2.1.3
+  - 2.2.2
+  - jruby
+  - ruby-head
+  - jruby-head
+  - rbx
+branches:
+  only:
+    - master

data/Gemfile

@@ -1,3 +1,8 @@
 source 'https://rubygems.org'
-  # required gems in .gemspec
+
+gem "rake"
+group :test do
+  gem "rspec"
+end
+  
 gemspec

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    wtf_csv (0.0.0)
-      smarter_csv
+    wtf_csv (1.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.2.5)
+    rake (10.4.2)
     rspec (3.3.0)
       rspec-core (~> 3.3.0)
       rspec-expectations (~> 3.3.0)
@@ -21,11 +21,14 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.3.0)
     rspec-support (3.3.0)
-    smarter_csv (1.1.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  rake
   rspec
   wtf_csv!
+
+BUNDLED WITH
+   1.10.6

data/README.md

@@ -1,13 +1,46 @@
-# wtf_csv
-Ruby gem to detect formatting issues in a CSV
+# WtfCSV
+
+[![Build Status](https://secure.travis-ci.org/gremerritt/wtf_csv.png?branch=master)](http://travis-ci.org/gremerritt/wtf_csv)
+
+`wtf_csv` is a Ruby Gem to detect formatting issues in a CSV
+
+### Motivation
 
 The CSV file format is meant to be an easy way to transport data. Anyone who has had to maintain an import process, however, knows that it's easy to mess up. Usually the entire landscape looks like this:
   1. An importer expects CSV files to be provided in some specific format
   2. The files are given in a different format
   3. The import fails; or even worse, the import succeeds but the data is mangled
-  4. Some poor souls must dig through the CSV file to figure out what happened. Usually issues are related to bad cell quoting, inconsistent column counts, etc.
+  4. Some poor soul must dig through the CSV file to figure out what happened. Usually issues are related to bad cell quoting, inconsistent column counts, etc.
   
-This gem seeks to make this process less terrible by providing a way to easily surface common formatting issues on a CSV file.
+This gem seeks to make this process less terrible by providing a way to easily surface common formatting issues in a CSV file.
+
+## Documentation
+
+`WtfCSV.scan` will return a hash with four keys: `:quote_errors`, `:encoding_errors`, `:column_errors`, and `:length_errors`. Each key's value will be an array of the issues that were found including information about the issue, in the format described below.
+
+### :quote_errors
+`[<line number>, <column_number>, <text of the improperly quoted field>]`
+
+### :encoding_errors
+`[<line number>, <column number>]`
+
+### :column_errors
+This array will always be empty if the `:check_col_count` is set to `false`
+
+If `WtfCSV.scan` was able to determine how many columns should be in each row, either by using the `:col_threshold` option or because the `:num_cols` option was set, the format will be:
+
+`[<line number>, <number of columns in the line>, <number of columns that should be in the line>]`
+
+If `WtfCSV.scan` wasn't able to determine how many columns should be in each row (because an adequate number of columns weren't above the `:col_threshold` percentage) the format will be:
+
+`[<number of columns>, <number of rows that have this number of columns>]`
+
+### :length_errors
+This array will always be empty unless the `:max_chars_in_field` option is being used
+
+`[<line number>, <column number>, <field length>]`
+
+## Configuration
 
 `WtfCSV.scan` has the following options:
 ```
@@ -16,7 +49,6 @@ This gem seeks to make this process less terrible by providing a way to easily s
 |---------------------------------|----------|--------------------------------------------------------------------------------------|
 | :col_sep                        |   ','    | Column separator                                                                     |
 | :row_sep                        | $/ ,"\n" | Row separator - defaults to system's $/ , which defaults to "\n"                     |
-|                                 |          | This can also be set to :auto, but will process the whole cvs file first  (slow!)    |
 | :quote_char                     |   '"'    | Quotation character                                                                  |
 | :escape_char                    |   '\'    | Character to escape quotes                                                           |
 |---------------------------------|----------|--------------------------------------------------------------------------------------|
@@ -41,4 +73,28 @@ This gem seeks to make this process less terrible by providing a way to easily s
 |---------------------------------|----------|--------------------------------------------------------------------------------------|
 ```
 
-If you happen upon this, know that this is in development - though should be very stable at this point. Soon this will be available on https://rubygems.org, where you'll be able to install with `gem install wtf_csv` or putting `require 'wtf_csv'` in your gemfile. Until then, feel free to install from source and bundle it into a gem yourself - just give credit where it is due.
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'wtf_csv'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wtf_csv
+
+## Bugs and Feature Requests
+
+Please [open an Issue on GitHub](https://github.com/gremerritt/wtf_csv/issues) with any bugs or feature requests. Thanks!
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b new-feature`)
+3. Commit your changes (`git commit -am 'adds a new feature'`)
+4. Push to the branch (`git push origin new-feature`)
+5. Create new Pull Request

data/lib/wtf_csv.rb

@@ -1,3 +1,2 @@
 require "wtf_csv/wtf_csv.rb"
-require "wtf_csv/version.rb"
-require 'smarter_csv'
+require "wtf_csv/version.rb"

data/lib/wtf_csv/version.rb

@@ -1,3 +1,3 @@
 module WtfCSV
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/wtf_csv/wtf_csv.rb

@@ -18,11 +18,6 @@ module WtfCSV
     f = File.open(file, "r:#{options[:file_encoding]}")
     trgt_line_count = `wc -l "#{file}"`.strip.split(' ')[0].to_i if block_given?
     
-    if options[:row_sep] == :auto
-      options[:row_sep] = SmarterCSV.guess_line_ending(f, options)
-      f.rewind
-    end
-    
     # credit to tilo, author of smarter_csv, on how to loop over lines without reading whole file into memory
     old_row_sep = $/
     $/ = options[:row_sep]
@@ -197,10 +192,10 @@ module WtfCSV
       end
     end
 
-    return {quote_errors: quote_errors,
-            encoding_errors: encoding_errors,
-            column_errors: column_errors,
-            length_errors: length_errors}
+    return {:quote_errors => quote_errors,
+            :encoding_errors => encoding_errors,
+            :column_errors => column_errors,
+            :length_errors => length_errors}
     
   end
 end

data/wtf_csv.gemspec

@@ -14,8 +14,5 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.licenses      = ['MIT']
   
-  s.add_runtime_dependency 'smarter_csv'
   s.add_development_dependency 'rspec'
-  
-  s.requirements << 'smarter_csv'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wtf_csv
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Greg Merritt
@@ -10,20 +10,6 @@ bindir: bin
 cert_chain: []
 date: 2015-09-11 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: smarter_csv
-  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'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -48,6 +34,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -90,8 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-requirements:
-- smarter_csv
+requirements: []
 rubyforge_project: 
 rubygems_version: 2.0.3
 signing_key: