csv2hash 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 712c36523387610b2faba0dfb934e772a281ee19
-  data.tar.gz: 9275f05691e92eda1e32f08395bae382282515fd
+  metadata.gz: 388884c9854027a36c9f704d77f8cd31d2fe8aba
+  data.tar.gz: ffb86ac1d924c8cb6041aec965c42edf19b1226d
 SHA512:
-  metadata.gz: f37e0262f38b234f2b0b092f8e9f9a048e43e91dbd732d27e83911097989956567cc9482547ed868bdaf3240d5f149f55024b8721d2d5c5b24365a610ab239c6
-  data.tar.gz: 5d0bf911880893b7af380c61b9339bd6820a82b862bc2af4214e1453ca1abe7013b85a837a467d1ca8f491c6f0fad7bdc86bca74382e627d20bc8faa189b204b
+  metadata.gz: fa1f10d91cb064ae715673074dc4bfd8e095c79cee29efa8cee1db95556a2ac909bd7f3337024c8121f5972fe87d9911a3a921566195859862b5d0f4c832880b
+  data.tar.gz: 710c7f822206b531de694f316ab2f2a5d0c76afe83a0d44f92816054f519b20e9fd32d70b5da0865481c6770f0f2319519e52203c5fc8d0ada551abd565ebf15

data/Gemfile.lock

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

data/README.md

@@ -227,10 +227,10 @@ You can define the number of rows to skip in the header of the CSV.
 Pasrer can take several parameters like that:
 
 ```
-	definition, file_path_or_data, exception_mode=true, ignore_blank_line=false
+	definition, file_path_or_data, ignore_blank_line=false
 ```
 
-in file_path_or_data attribubte you can pass directly an Array of data (Array with 2 dimensions) really useful for testing, if you don't care about blank lines in your CSV you can ignore them.
+in file_path_or_data attribute you can pass directly an Array of data (Array with 2 dimensions) really useful for testing, if you don't care about blank lines in your CSV you can ignore them.
 
 ### Response
 
@@ -253,16 +253,20 @@ data or errors are Array, but errors can be formatted on csv format with .to_csv
 
 ## Exception or Not !
 
-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.
+You can choose into 2 different modes of parsing, either **break_on_failure 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
+### On **BREAK_ON_FAILURE MODE**
 
-`.parse()` return `data_wrapper` if `.parse()` is invalid, you can code your own behavior:
+You need call ```.parse()``` with bang ```!```
+
+### On **CSV MODE**
+
+You need call `.parse()` return `data_wrapper` if `.parse()` is invalid, you can code your own behavior:
 
 in your code
 
 ```
-	parser = Csv2hash::Main.new(definition, file_path_or_data, exception_mode=true, ignore_blank_line=false).new
+	parser = Csv2hash::Main.new(definition, file_path_or_data, ignore_blank_line=false).new
 	response = parser.parse
 	return response if response.valid?
 	# Whatever
@@ -348,6 +352,25 @@ Csv data
 ```
 	[ [ 'Foo' ] ]
 ```
+# Upgrading from 0.3 to 0.4
+
+Signature of ```Csv2hash::Main#new``` has changed too
+
+Prior to 0.3 :
+
+```
+  Csv2Hash::Main.new(definition, file_path_or_data, break_on_failure=true, ignore_blank_line=false)
+```
+
+call ```.parse!``` for same result
+
+Starting from 0.3 :
+
+```
+  Csv2Hash::Main.new(definition, file_path_or_data, ignore_blank_line=false)
+```
+
+call ```.parse``` for same result
 
 # Upgrading from 0.2 to 0.3
 
@@ -357,13 +380,13 @@ Signature of ```Csv2hash::Main#new``` has changed too
 Prior to 0.3 :
 
 ```
-  Csv2Hash.new(definition, file_path, exception_mode=true, data_source=nil, ignore_blank_line=false)
+  Csv2Hash.new(definition, file_path, break_on_failure=true, data_source=nil, ignore_blank_line=false)
 ```
 
 Starting from 0.3 :
 
 ```
-  Csv2Hash::Main.new(definition, file_path_or_data, exception_mode=true, ignore_blank_line=false)
+  Csv2Hash::Main.new(definition, file_path_or_data, break_on_failure=true, ignore_blank_line=false)
 ```
 
 # Upgrading from 0.1 to 0.2

data/ReleaseNotes.md

@@ -1,3 +1,11 @@
+### VERSION 0.4.0
+
+* backwards incompatible changes
+  * The signature of Csv2hash::Main#new has changed.
+
+* refactoring
+  * remove params ``` break_on_failure ``` to benefit of ``` Csv2hash::Main#parse! ``` of ``` Csv2hash::Main#parse ```
+
 ### VERSION 0.3.0
 
 * backwards incompatible changes

data/lib/csv2hash/structure_validator.rb

@@ -9,7 +9,7 @@ module Csv2hash::StructureValidator
         rule_instance(rule, options).validate! data_source
       rescue => e
         self.errors << { y: nil, x: nil, message: e.message, key: nil }
-        raise if exception_mode
+        raise if break_on_failure
       end
     end
   end

data/lib/csv2hash/validator.rb

@@ -8,7 +8,7 @@ module Csv2hash
           validate_cell (_y||y), x, rule
         rescue => e
           self.errors << { y: (_y||y), x: x, message: e.message, key: rule.fetch(:key) }
-          raise if exception_mode
+          raise if break_on_failure
         end
       end
     end

data/lib/csv2hash/version.rb

@@ -1,3 +1,3 @@
 module Csv2hash
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/lib/csv2hash.rb

@@ -24,13 +24,13 @@ module Csv2hash
   class Main
     include Csv2hash::StructureValidator
 
-    attr_accessor :definition, :file_path_or_data, :data, :notifier, :exception_mode, :errors, :ignore_blank_line
+    attr_accessor :definition, :file_path_or_data, :data, :notifier, :break_on_failure, :errors, :ignore_blank_line
 
-    def initialize definition, file_path_or_data, exception_mode=true, ignore_blank_line=false
+    def initialize definition, file_path_or_data, ignore_blank_line=false
       self.definition, self.file_path_or_data = definition, file_path_or_data
       @data_source = data_source
       dynamic_lib_loading 'Parser'
-      self.exception_mode, self.errors = exception_mode, []
+      self.break_on_failure, self.errors = false, []
       dynamic_lib_loading 'Validator'
       self.notifier = Notifier.new
       self.ignore_blank_line = ignore_blank_line
@@ -47,6 +47,13 @@ module Csv2hash
       rescue; end
     end
 
+    def parse!
+      self.break_on_failure = true
+      parse
+    ensure
+      self.break_on_failure = false
+    end
+
     def parse
       load_data_source
 

data/spec/csv2hash/parser/collection_spec.rb

@@ -9,7 +9,7 @@ describe Csv2hash::Parser::Collection do
   let(:data_source) { [ [ 'John Doe' ], [ 'Jane Doe' ] ] }
 
   subject do
-    Csv2hash::Main.new(definition, data_source, exception_mode=false, ignore_blank_line=false)
+    Csv2hash::Main.new(definition, data_source, ignore_blank_line=false)
   end
 
   context 'regular way' do

data/spec/csv2hash/parser/mapping_spec.rb

@@ -9,7 +9,7 @@ describe Csv2hash::Parser::Mapping do
   let(:data_source) { [ [ 'John Doe' ] ] }
 
   subject do
-    Csv2hash::Main.new(definition, data_source, exception_mode=false, ignore_blank_line=false)
+    Csv2hash::Main.new(definition, data_source, ignore_blank_line=false)
   end
 
   context 'regular way' do

data/spec/csv2hash/structure_validator_spec.rb

@@ -4,7 +4,6 @@ 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!
@@ -13,12 +12,11 @@ describe Csv2hash::StructureValidator do
   end
 
   subject do
-    Csv2hash::Main.new(definition, data_source, exception_mode, ignore_blank_line=false)
+    Csv2hash::Main.new(definition, data_source, ignore_blank_line=false)
   end
 
   context 'the csv with errors' do
     let(:options){ { structure_rules: { 'MaxColumns' => 2 } } }
-    let(:exception_mode) { false }
     before { subject.parse }
     let(:data_source) do
       [
@@ -37,6 +35,10 @@ describe Csv2hash::StructureValidator do
   context '#MaxColumns'  do
     let(:options){ { structure_rules: { 'MaxColumns' => 2 } } }
 
+    before do
+      allow(subject).to receive(:break_on_failure) { true }
+    end
+
     context 'valid data' do
       let(:data_source) do
         [
@@ -60,6 +62,10 @@ describe Csv2hash::StructureValidator do
   context '#MinColumns'  do
     let(:options){ { structure_rules: { 'MinColumns' => 2 } } }
 
+    before do
+      allow(subject).to receive(:break_on_failure) { true }
+    end
+
     context 'valid data' do
       let(:data_source) do
         [

data/spec/csv2hash/validator/collection_spec.rb

@@ -10,11 +10,16 @@ describe Csv2hash::Validator::Collection do
   end
 
   subject do
-    Csv2hash::Main.new(definition, data_source, exception_mode=true, ignore_blank_line=false)
+    Csv2hash::Main.new(definition, data_source, ignore_blank_line=false)
+  end
+
+  before do
+    allow(subject).to receive(:break_on_failure) { true }
   end
 
   context 'with valid data' do
     let(:data_source) { [ [ 'John Doe' ] ]}
+
     it { expect { subject.validate_data! }.to_not raise_error }
     context 'with header' do
       let(:options) { { header_size: 1 } }
@@ -28,7 +33,7 @@ describe Csv2hash::Validator::Collection do
     before { subject.ignore_blank_line = true }
     it { expect { subject.validate_data! }.to_not raise_error }
     context 'csv mode' do
-      before { subject.exception_mode = false }
+      before { subject.break_on_failure = false }
       its(:errors) { should be_empty }
     end
   end
@@ -45,7 +50,11 @@ describe Csv2hash::Validator::Collection do
 
   context 'wihtout exception' do
     let(:data_source) { [ [ ] ]}
-    before { subject.exception_mode = false }
+    
+    before do
+      allow(subject).to receive(:break_on_failure) { false }
+    end
+
     it { expect(subject.parse.errors.to_csv).to eql ",\"undefined name on [0, 0]\"\n" }
 
     context 'errors should be filled' do

data/spec/csv2hash/validator/mapping_spec.rb

@@ -10,7 +10,11 @@ describe Csv2hash::Validator::Mapping do
   end
 
   subject do
-    Csv2hash::Main.new(definition, data_source, exception_mode=true, ignore_blank_line=false)
+    Csv2hash::Main.new(definition, data_source, ignore_blank_line=false)
+  end
+
+  before do
+    allow(subject).to receive(:break_on_failure) { true }
   end
 
   context 'with valid data' do
@@ -25,7 +29,11 @@ describe Csv2hash::Validator::Mapping do
 
   context 'wihtout exception' do
     let(:data_source) { [ [ ] ] }
-    before { subject.exception_mode = false }
+
+    before do
+      allow(subject).to receive(:break_on_failure) { false }
+    end
+
     it { expect(subject.parse.errors.to_csv).to eql ",\"undefined name on [0, 0]\"\n" }
 
     context 'errors should be filled' do

metadata

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