wjordan213-csvlint 0.2.8

data/LICENSE.md

@@ -0,0 +1,22 @@
+##Copyright (c) 2014 The Open Data Institute
+
+#MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,328 @@
+[![Build Status](http://img.shields.io/travis/theodi/csvlint.rb.svg)](https://travis-ci.org/theodi/csvlint.rb)
+[![Dependency Status](http://img.shields.io/gemnasium/theodi/csvlint.rb.svg)](https://gemnasium.com/theodi/csvlint.rb)
+[![Coverage Status](http://img.shields.io/coveralls/theodi/csvlint.rb.svg)](https://coveralls.io/r/theodi/csvlint.rb)
+[![License](http://img.shields.io/:license-mit-blue.svg)](http://theodi.mit-license.org)
+[![Badges](http://img.shields.io/:badges-5/5-ff6799.svg)](https://github.com/pikesley/badger)
+
+# CSV Lint
+
+A ruby gem to support validating CSV files to check their syntax and contents.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'csvlint'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install csvlint
+
+## Usage
+
+You can either use this gem within your own Ruby code, or as a standolone command line application
+
+## On the command line
+
+After installing the gem, you can validate a CSV on the command line like so:
+
+	csvlint myfile.csv
+
+You will then see the validation result, together with any warnings or errors e.g.
+
+```
+myfile.csv is INVALID
+1. blank_rows. Row: 3
+1. title_row.
+2. inconsistent_values. Column: 14
+```
+
+You can also optionally pass a schema file like so:
+
+	csvlint myfile.csv --schema=schema.json
+
+## In your own Ruby code
+
+Currently the gem supports retrieving a CSV accessible from a URL, File, or an IO-style object (e.g. StringIO)
+
+	require 'csvlint'
+
+	validator = Csvlint::Validator.new( "http://example.org/data.csv" )
+	validator = Csvlint::Validator.new( File.new("/path/to/my/data.csv" ))
+	validator = Csvlint::Validator.new( StringIO.new( my_data_in_a_string ) )
+
+When validating from a URL the range of errors and warnings is wider as the library will also check HTTP headers for
+best practices
+
+	#invoke the validation
+	validator.validate
+
+	#check validation status
+	validator.valid?
+
+	#access array of errors, each is an Csvlint::ErrorMessage object
+	validator.errors
+
+	#access array of warnings
+	validator.warnings
+
+	#access array of information messages
+	validator.info_messages
+
+	#get some information about the CSV file that was validated
+	validator.encoding
+	validator.content_type
+	validator.extension
+	validator.row_count
+
+	#retrieve HTTP headers from request
+	validator.headers
+
+## Controlling CSV Parsing
+
+The validator supports configuration of the [CSV Dialect](http://dataprotocols.org/csv-dialect/) used in a data file. This is specified by
+passing a dialect hash to the constructor:
+
+    dialect = {
+    	"header" => true,
+    	"delimiter" => ","
+    }
+	validator = Csvlint::Validator.new( "http://example.org/data.csv", dialect )
+
+The options should be a Hash that conforms to the [CSV Dialect](http://dataprotocols.org/csv-dialect/) JSON structure.
+
+While these options configure the parser to correctly process the file, the validator will still raise errors or warnings for CSV
+structure that it considers to be invalid, e.g. a missing header or different delimiters.
+
+Note that the parser will also check for a `header` parameter on the `Content-Type` header returned when fetching a remote CSV file. As
+specified in [RFC 4180](http://www.ietf.org/rfc/rfc4180.txt) the values for this can be `present` and `absent`, e.g:
+
+	Content-Type: text/csv; header=present
+
+## Error Reporting
+
+The validator provides feedback on a validation result using instances of `Csvlint::ErrorMessage`. Errors are divided into errors, warnings and information
+messages. A validation attempt is successful if there are no errors.
+
+Messages provide context including:
+
+* `category` has a symbol that indicates the category or error/warning: `:structure` (well-formedness issues), `:schema` (schema validation), `:context` (publishing metadata, e.g. content type)
+* `type` has a symbol that indicates the type of error or warning being reported
+* `row` holds the line number of the problem
+* `column` holds the column number of the issue
+* `content` holds the contents of the row that generated the error or warning
+
+## Errors
+
+The following types of error can be reported:
+
+* `:wrong_content_type` -- content type is not `text/csv`
+* `:ragged_rows` -- row has a different number of columns (than the first row in the file)
+* `:blank_rows` -- completely empty row, e.g. blank line or a line where all column values are empty
+* `:invalid_encoding` -- encoding error when parsing row, e.g. because of invalid characters
+* `:not_found` -- HTTP 404 error when retrieving the data
+* `:stray_quote` -- missing or stray quote
+* `:unclosed_quote` -- unclosed quoted field
+* `:whitespace` -- a quoted column has leading or trailing whitespace
+* `:line_breaks` -- line breaks were inconsistent or incorrectly specified
+
+## Warnings
+
+The following types of warning can be reported:
+
+* `:no_encoding` -- the `Content-Type` header returned in the HTTP request does not have a `charset` parameter
+* `:encoding` -- the character set is not UTF-8
+* `:no_content_type` -- file is being served without a `Content-Type` header
+* `:excel` -- no `Content-Type` header and the file extension is `.xls`
+* `:check_options` -- CSV file appears to contain only a single column
+* `:inconsistent_values` -- inconsistent values in the same column. Reported if <90% of values seem to have same data type (either numeric or alphanumeric including punctuation)
+* `:empty_column_name` -- a column in the CSV header has an empty name
+* `:duplicate_column_name` -- a column in the CSV header has a duplicate name
+* `:title_row` -- if there appears to be a title field in the first row of the CSV
+
+## Information Messages
+
+There are also information messages available:
+
+* `:nonrfc_line_breaks` -- uses non-CRLF line breaks, so doesn't conform to RFC4180.
+* `:assumed_header` -- the validator has assumed that a header is present
+
+## Schema Validation
+
+The library supports validating data against a schema. A schema configuration can be provided as a Hash or parsed from JSON. The structure currently
+follows JSON Table Schema with some extensions and rudinmentary [CSV on the Web Metadata](http://www.w3.org/TR/tabular-metadata/).
+
+An example JSON Table Schema schema file is:
+
+	{
+		"fields": [
+			{
+				"name": "id",
+				"constraints": {
+					"required": true,
+					"type": "http://www.w3.org/TR/xmlschema-2/#integer"
+				}
+			},
+			{
+				"name": "price",
+				"constraints": {
+					"required": true,
+					"minLength": 1 
+				}
+			},
+			{
+				"name": "postcode",
+				"constraints": {
+					"required": true,
+					"pattern": "[A-Z]{1,2}[0-9][0-9A-Z]? ?[0-9][A-Z]{2}"
+				}
+			}
+		]
+	}
+
+An equivalent CSV on the Web Metadata file is:
+
+	{
+		"@context": "http://www.w3.org/ns/csvw",
+		"url": "http://example.com/example1.csv",
+		"tableSchema": {
+			"columns": [
+				{
+					"name": "id",
+					"required": true,
+					"datatype": { "base": "integer" }
+				},
+				{
+					"name": "price",
+					"required": true,
+					"datatype": { "base": "string", "minLength": 1 }
+				},
+				{
+					"name": "postcode",
+					"required": true
+				}
+			]
+		}
+	}
+
+Parsing and validating with a schema (of either kind):
+
+	schema = Csvlint::Schema.load_from_json(uri)
+	validator = Csvlint::Validator.new( "http://example.org/data.csv", nil, schema )
+
+### CSV on the Web Validation Support
+
+This gem passes all the validation tests in the [official CSV on the Web test suite](http://w3c.github.io/csvw/tests/) (though there might still be errors or parts of the [CSV on the Web standard](http://www.w3.org/TR/tabular-metadata/) that aren't tested by that test suite).
+
+### JSON Table Schema Support
+
+Supported constraints:
+
+* `required` -- there must be a value for this field in every row
+* `unique` -- the values in every row should be unique
+* `minLength` -- minimum number of characters in the value
+* `maxLength` -- maximum number of characters in the value
+* `pattern` -- values must match the provided regular expression
+* `type` -- specifies an XML Schema data type. Values of the column must be a valid value for that type
+* `minimum` -- specify a minimum range for values, the value will be parsed as specified by `type`
+* `maximum` -- specify a maximum range for values, the value will be parsed as specified by `type`
+* `datePattern` -- specify a `strftime` compatible date pattern to be used when parsing date values and min/max constraints
+
+Supported data types (this is still a work in progress):
+
+* String -- `http://www.w3.org/2001/XMLSchema#string` (effectively a no-op)
+* Integer -- `http://www.w3.org/2001/XMLSchema#integer` or `http://www.w3.org/2001/XMLSchema#int`
+* Float -- `http://www.w3.org/2001/XMLSchema#float`
+* Double -- `http://www.w3.org/2001/XMLSchema#double`
+* URI -- `http://www.w3.org/2001/XMLSchema#anyURI`
+* Boolean -- `http://www.w3.org/2001/XMLSchema#boolean`
+* Non Positive Integer -- `http://www.w3.org/2001/XMLSchema#nonPositiveInteger`
+* Positive Integer -- `http://www.w3.org/2001/XMLSchema#positiveInteger`
+* Non Negative Integer -- `http://www.w3.org/2001/XMLSchema#nonNegativeInteger`
+* Negative Integer -- `http://www.w3.org/2001/XMLSchema#negativeInteger`
+* Date -- `http://www.w3.org/2001/XMLSchema#date`
+* Date Time -- `http://www.w3.org/2001/XMLSchema#dateTime`
+* Year -- `http://www.w3.org/2001/XMLSchema#gYear`
+* Year Month -- `http://www.w3.org/2001/XMLSchema#gYearMonth`
+* Time -- `http://www.w3.org/2001/XMLSchema#time`
+
+Use of an unknown data type will result in the column failing to validate.
+
+Schema validation provides some additional types of error and warning messages:
+
+* `:missing_value` (error) -- a column marked as `required` in the schema has no value
+* `:min_length` (error) -- a column with a `minLength` constraint has a value that is too short
+* `:max_length` (error) -- a column with a `maxLength` constraint has a value that is too long
+* `:pattern` (error) --  a column with a `pattern` constraint has a value that doesn't match the regular expression
+* `:malformed_header` (warning) -- the header in the CSV doesn't match the schema
+* `:missing_column` (warning) -- a row in the CSV file has a missing column, that is specified in the schema. This is a warning only, as it may be legitimate
+* `:extra_column` (warning) -- a row in the CSV file has extra column.
+* `:unique` (error) -- a column with a `unique` constraint contains non-unique values
+* `:below_minimum` (error) -- a column with a `minimum` constraint contains a value that is below the minimum
+* `:above_maximum` (error) -- a column with a `maximum` constraint contains a value that is above the maximum
+
+## Other validation options
+
+You can also provide an optional options hash as the fourth argument to Validator#new. Supported options are:
+
+* :limit_lines -- only check this number of lines of the CSV file. Good for a quick check on huge files.
+
+```
+options = {
+  limit_lines: 100
+}
+validator = Csvlint::Validator.new( "http://example.org/data.csv", nil, nil, options )
+```
+
+* :lambda -- Pass a block of code to be called when each line is validated, this will give you access to the `Validator` object. For example, this will return the current line number for every line validated:
+
+```
+options = {
+  lambda: ->(validator) { puts validator.current_line }
+}
+validator = Csvlint::Validator.new( "http://example.org/data.csv", nil, nil, options )
+=> 1
+2
+3
+4
+.....
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+### Testing
+
+The codebase includes both rspec and cucumber tests, which can be run together using:
+
+    $ rake
+
+or separately:
+
+    $ rake spec
+    $ rake features
+
+When the cucumber tests are first run, a script will create tests based on the latest version of the [CSV on the Web test suite](http://w3c.github.io/csvw/tests/), including creating a local cache of the test files. This requires an internet connection and some patience. Following that download, the tests will run locally; there's also a batch script:
+
+    $ bin/run-csvw-tests
+
+which will run the tests from the command line.
+
+If you need to refresh the CSV on the Web tests:
+
+    $ rm bin/run-csvw-tests
+    $ rm features/csvw_validation_tests.feature
+    $ rm -r features/fixtures/csvw
+
+and then run the cucumber tests again or:
+
+    $ ruby features/support/load_tests.rb

data/Rakefile

@@ -0,0 +1,17 @@
+require "bundler/gem_tasks"
+
+$:.unshift File.join( File.dirname(__FILE__), "lib")
+
+require 'rubygems'
+require 'cucumber'
+require 'cucumber/rake/task'
+require 'coveralls/rake/task'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+Coveralls::RakeTask.new
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format pretty"
+end
+
+task :default => [:spec, :features, 'coveralls:push']

data/bin/create_schema

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+$:.unshift File.join( File.dirname(__FILE__), "..", "lib")
+
+require 'csvlint'
+
+begin
+  puts ARGV[0]
+	csv = CSV.new( open(ARGV[0]) )
+	headers = csv.shift
+	
+	name = File.basename( ARGV[0] )
+	schema = {
+	  "title" => name,
+	  "description" => "Auto generated schema for #{name}",
+	  "fields" => []
+	}
+	
+	headers.each do |name|
+	  schema["fields"] << {
+	    "name" => name,
+	    "title" => "",
+	    "description" => "",
+	    "constraints" => {}
+	  }
+	end
+	
+	$stdout.puts JSON.pretty_generate(schema)
+rescue => e
+  puts e
+  puts e.backtrace
+	puts "Unable to parse CSV file"
+end

data/bin/csvlint

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+$:.unshift File.join( File.dirname(__FILE__), "..", "lib")
+
+require 'csvlint/cli'
+
+if ARGV == ["help"]
+  Csvlint::Cli.start(["help"])
+else
+  Csvlint::Cli.start(ARGV.unshift("validate"))
+end

data/features/check_format.feature

@@ -0,0 +1,46 @@
+Feature: Check inconsistent formatting
+
+  Scenario: Inconsistent formatting for integers
+    Given I have a CSV with the following content:
+    """
+"1","2","3"
+"Foo","5","6"
+"3","2","1"
+"3","2","1"
+    """
+    And it is stored at the url "http://example.com/example1.csv"
+    And I ask if there are warnings
+    Then there should be 1 warnings
+    And that warning should have the type "inconsistent_values"
+    And that warning should have the column "1"
+    
+  Scenario: Inconsistent formatting for alpha fields
+    Given I have a CSV with the following content:
+    """
+"Foo","Bar","Baz"
+"Biz","1","Baff"
+"Boff","Giff","Goff"
+"Boff","Giff","Goff"
+    """
+    And it is stored at the url "http://example.com/example1.csv"
+    And I ask if there are warnings
+    Then there should be 1 warnings
+    And that warning should have the type "inconsistent_values"
+    And that warning should have the column "2"
+
+  Scenario: Inconsistent formatting for alphanumeric fields
+    Given I have a CSV with the following content:
+    """
+"Foo 123","Bar","Baz"
+"1","Bar","Baff"
+"Boff 432423","Giff","Goff"
+"Boff444","Giff","Goff"
+    """
+    And it is stored at the url "http://example.com/example1.csv"
+    And I ask if there are warnings
+    Then there should be 1 warnings
+    And that warning should have the type "inconsistent_values"
+    And that warning should have the column "1"
+
+
+