csv2hash 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e9db6b93dc1699a3757bb2e9d813285c58e5f4b
-  data.tar.gz: aa03c5a3d6679ac7b1598052dbe8cb38a9ea88ae
+  metadata.gz: 9ab8b867d5257761c23fb310ad45eab25d5eebe9
+  data.tar.gz: ffec55a91cb1ccd853e641b65f965cc0a51c0350
 SHA512:
-  metadata.gz: d3aa7cdba3548a4bca5e185ee550fbf3812b0912fd5f0a47b4db131a3245a4e736bfb89a93dbd259118cdd37b405a6958fdf4a58d6e07b1ceab208d69436d232
-  data.tar.gz: 9485aca4d1047db6566e07b8dd87282c505fe4db9ad5d7cd4db6f5b8097819b50aeeea0c381a2beca64ec1e096938713a04f674c973d80a5995fbd5dc49f9d4a
+  metadata.gz: 801f045f211e3dffaafad4c27dffd922132b40be5bc98b2013fafa676f7c3a7584bfad7f5c39ce96dc34a7ace3033cfd54f5505812d61e58ba0c20b6b956228c
+  data.tar.gz: d446c104f67af25a884fabfa3784b2baaaeaf559de8cb8d901c55acef7762966a4aa1ff80b637cfbda25e18c75bcc725b29fd3a1b97212ef9d3b7719ae628b78

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    csv2hash (0.2.0)
+    csv2hash (0.2.1)
 
 GEM
   remote: http://rubygems.org/

data/README.md

@@ -35,19 +35,19 @@ You should declare a definition for you CSV, and then define for each cell what
 
 Example :
 
-You want the cell located on first line, first column to be a string with its values to be 'yes' or 'no'. Then you can right the following validation rule :
+If you want the very first cell, located on the first line and on the first column to be a string with values are either 'yes' either 'no', you can write the following validation rule:
 
 	{ name: 'aswering', type: 'string', values: ['yes', 'no'], position: [0,0] }
 
-The type is 'string' by default, so can just write:
+:type attribute has 'string' for default value, therefore you can just write this:
 
 	{ name: 'aswering', values: ['yes', 'no'], position: [0,0] }
 
-You can define a message, default is 'undefined :key on :position'
+You can define you own message but default message is 'undefined :key on :position'
 
 	{ name: 'aswering', values: ['yes', 'no'], position: [0,0], message: 'this value is not supported' }
 
-You can also define Range
+You can also define Range of values
 
 	{ name: 'score', values: 0..5, position: [0,0] }
 
@@ -57,7 +57,7 @@ The message is parsed:
 
 It produces :
 
-	value of aswering is not supported, please you one of [yes, no]
+	value of answering is not supported, please use one of [yes, no]
 
 ### Default values
 
@@ -85,7 +85,7 @@ A definition should be provided. There are 2 types of definitions:
 
 ## Samples
 
-### Validation of a cell at a precise position
+### Validation of cells with defined precision
 
 Consider the following CSV:
 
@@ -125,7 +125,7 @@ Precise position validation sample:
 
 	end
 
-### Validation of a collection
+### Validation of a collection (Regular CSV)
 
 Consider the following CSV:
 
@@ -164,7 +164,6 @@ Collection validation sample:
 
 	end
 
-
 ### Structure validation rules
 
 You may want to validate some structure, like min or max number of columns, definition accepts structure_rules as a key for the third parameter.
@@ -193,7 +192,7 @@ class MyParser
 	end
 
   def definition
-	  Csv2Hash::Definition.new(rules, type = Csv2Hash::Definition::COLLECTION, structure_rules: {'MinColumn' => 2, 'MaxColumn' => 3})
+	  Csv2Hash::Definition.new(rules, type = Csv2Hash::Definition::COLLECTION, structure_rules: { 'MinColumns' => 2, 'MaxColumns' => 3 })
   end
 end
 
@@ -202,19 +201,19 @@ end
 
 You can define the number of rows to skip in the header of the CSV.
 
-	Definition.new(rules, type, header_size=0)
+	Definition.new(rules, type, header_size: 0)
 
 ### Parser and configuration
 
-Pasrer take severale parameters like that :
+Pasrer can take several parameters like that:
 
-	initialize definition, file_path, exception_mode=true, data_source=nil, ignore_blank_line=false
+	definition, file_path, exception_mode=true, data_source=nil, ignore_blank_line=false
 
-you can pass directly Array of data (Array at 2 dimensions) really useful for testing, if you don't care about line blank in your CSV you can ignore them.
+you can pass directly Array of data (Array at 2 dimensions) really useful for testing, if you don't care about blank lines in your CSV you can ignore them.
 
 ### Response
 
-The parser return values wrapper into DataWrapper Object, you can call .valid? method on this Object and grab either data or errors like that :
+The parser return values wrapper into DataWrapper Object, you can call ```.valid?``` method on this Object and grab either data or errors like that :
 
     response = parser.parse
     if response.valid?
@@ -229,11 +228,11 @@ data or errors are Array, but errors can be formatted on csv format with .to_csv
 
 ## Exception or Not !
 
-You can choice 2 modes of parsing, either **exception mode** for raise exception in first breaking rules or **csv mode** for get csv original data + errors throwing into added columns.
+You can choose into 2 different modes of parsing, either **exception mode** for raise exception in first breaking rules or **csv mode** for get csv original data + errors throwing into added columns.
 
 ### On **CSV MODE** you can choose different way for manage errors
 
-`.parse()` return `data_wrapper` if `.parse()` is invalid, you can code your own behavior like that :
+`.parse()` return `data_wrapper` if `.parse()` is invalid, you can code your own behavior:
 
 in your code
 
@@ -242,7 +241,7 @@ in your code
 	return response if response.valid?
 	# Whatever
 
-In the same time Csv2hash call **notify(response)** method when CSV parsing fail, you can add your own Notifier like that
+In the same time Csv2hash call **notify(response)** method when CSV parsing fail, you can add your own Notifier:
 
 	module Csv2hash
 		module Plugins
@@ -287,6 +286,7 @@ errors is a Array of Hash
 ### Error
 
 	{ y: 1, x: 1, message: 'undefined nikcname on [0, 0]', key: 'nickname', value: nil }
+
 ## Personal Validator Rule
 
 You can define your own Validator
@@ -302,16 +302,15 @@ For downcase validation
 in your rule
 
 	{ position: [0,0], key: 'name', extra_validator: DowncaseValidator.new,
-		message: 'your data should be writting in downcase only' }
+		message: 'your data should be written in lowercase only.' }
 
 Csv data
 
 	[ [ 'Foo' ] ]
 
+# Upgrading from 0.1 to 0.2
 
-### Upgrading from 0.1 to 0.2
-
-The signature of Definition#initialize changed, as last parameter is a configuration hash, while in versions prior to 0.2 it was an integer (header_size) consider upgrading your code :
+The signature of Definition#new has changed, the last parameter is a configuration hash, while in versions prior to 0.2 it was an integer (header_size) consider upgrading your code :
 
 Prior to 0.2 :
 

data/ReleaseNotes.md

@@ -1,3 +1,7 @@
+VERSION 0.2.1
+
+* Correct little bug on error mode.
+
 VERSION 0.2
 
 * The signature of Definition#new

data/csv2hash.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |spec|
 
   spec.name        = 'csv2hash'
-  spec.version     = '0.2.0'
+  spec.version     = '0.2.1'
   spec.date        = '2013-11-26'
   spec.summary     = %q{Mapping a CSV to a Ruby Hash}
   spec.description = %q{DSL to map a CSV to a Ruby Hash}

data/lib/csv2hash/structure_validator.rb

@@ -6,14 +6,14 @@ module Csv2hash::StructureValidator
       begin
         rule_instance(rule, options).validate! data_source
       rescue => e
-        self.errors << e.message
+        self.errors << { y: nil, x: nil, message: e.message, key: nil }
         raise if exception_mode
       end
     end
+  end
 
-    def rule_instance rule, options
-      Csv2hash::StructureValidator.const_get(rule).new(options)
-    end
+  def rule_instance rule, options
+    Csv2hash::StructureValidator.const_get(rule).new(options)
   end
 
   module Validator

data/lib/csv2hash/version.rb

@@ -1,3 +1,3 @@
 module Cvs2hash
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

data/spec/csv2hash/structure_validator_spec.rb

@@ -4,6 +4,7 @@ describe Csv2hash::StructureValidator do
 
   let(:rules) { [ { position: [0,0], key: 'name' } ] }
   let(:options) { {} }
+  let(:exception_mode) { true }
   let(:definition) do
     Csv2hash::Definition.new(rules, Csv2hash::Definition::MAPPING, options).tap do |definition|
       definition.validate!
@@ -12,9 +13,27 @@ describe Csv2hash::StructureValidator do
   end
 
   subject do
-    Csv2hash.new(definition, 'file_path', true, data_source)
+    Csv2hash.new(definition, 'file_path', exception_mode, data_source)
   end
 
+  context 'the csv with errors' do
+    let(:options){ { structure_rules: { 'MaxColumns' => 2 } } }
+    let(:exception_mode) { false }
+    before { subject.parse }
+    let(:data_source) do
+      [
+        [ 'John', 'Doe' ],
+        [ 'Jane', 'Doe', 'extra field' ]
+      ]
+    end
+
+    its(:csv_with_errors) { should be_kind_of CsvArray }
+    it "adds structure error in first cell" do
+      subject.csv_with_errors.first[:message].should eq 'Too many columns (max. 2) on line 1'
+    end
+  end
+
+
   context '#MaxColumns'  do
     let(:options){ { structure_rules: { 'MaxColumns' => 2 } } }
 

data/spec/csv2hash/validator_spec.rb

@@ -9,12 +9,6 @@ describe Csv2hash::Validator do
     end
   end
 
-  subject do
-    Csv2hash.new(definition, 'file_path').tap do |parser|
-      parser.instance_variable_set :@data_source, data_source
-    end
-  end
-
   describe '#message' do
     subject { Csv2hash.new double('definition', type: Csv2hash::Definition::COLLECTION), nil }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: csv2hash
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Joel AZEMAR