csv2hash 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 12502614a6a2f8d3243b4b35152bc6dc33cc3f60
-  data.tar.gz: 235432257ee6d4e907aaa900f5090fc284fc80db
+  metadata.gz: 4017d9fec070fb90dc8c400f67f3c78b9fc6f536
+  data.tar.gz: 36ec66a10def761fff7f091aaf61160a8ad4b852
 SHA512:
-  metadata.gz: 5f597444c037b909413309e3570374c074a18e96463c40c1c7979cd5aeec5f96f6203ade714959c4ca930341e90d4b67a39f2b3718f02c57e85cf4882b6594d5
-  data.tar.gz: e9488827e829ecdc086791c8beadc0afcf5dd868327fbf0c78a479f963d19608a50e581d6974366dacbac9fed4ce289741c8c9971098dddbf90f7e374e0f8bb2
+  metadata.gz: 9e77b7043aff1425609cd7844ade388db5dda784a7d6fa1da3ea90d773af69327ea94e9efecb2e796e63e995c850c22e59228fda689a6ba694133a66decd1fb1
+  data.tar.gz: a54b994cc833b8381d38a4623b96b8a2f630ccd1228990320cf6645e401162ad6fcbe45fed6906c3eac79daeda149e4fc391192f1b19e9168e5f33aa178b508e

data/{ReleaseNotes.md → CHANGELOG.md}

@@ -1,3 +1,8 @@
+### VERSION 0.6.1
+
+* deprecations
+  * Structure validation rules, MinColumn, MaxColumn are replaced by :min_columns, :max_columns
+
 ### VERSION 0.6.0
 
 * backwards incompatible changes

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    csv2hash (0.6.0)
+    csv2hash (0.6.1)
       activesupport (~> 4.1)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activesupport (4.1.4)
+    activesupport (4.1.5)
       i18n (~> 0.6, >= 0.6.9)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
@@ -28,10 +28,10 @@ GEM
     json (1.8.1)
     method_source (0.8.2)
     mime-types (2.3)
-    minitest (5.4.0)
+    minitest (5.4.1)
     multi_json (1.10.1)
     netrc (0.7.7)
-    pry (0.10.0)
+    pry (0.10.1)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
@@ -56,13 +56,13 @@ GEM
       multi_json
       simplecov-html (~> 0.8.0)
     simplecov-html (0.8.0)
-    slop (3.5.0)
+    slop (3.6.0)
     term-ansicolor (1.3.0)
       tins (~> 1.0)
     thor (0.19.1)
     thread_safe (0.3.4)
     tins (1.3.2)
-    tzinfo (1.2.1)
+    tzinfo (1.2.2)
       thread_safe (~> 0.1)
 
 PLATFORMS

data/README.md

@@ -26,24 +26,26 @@ Or install it yourself as:
 
 ## Usage
 
-Parsing is based on rules, you must defined rules of parsing
+Parsing is based on rules, you should defined rule for each cells
 
 ### DSL
 
-Csv2hash::Main.generate_definition :name do
-  set_type { Definition::MAPPING }
-  set_header_size { 2 } # 0 by default
-  set_structure_rules {{ 'MaxColumns' => 2 }}
-  mapping do
-    cell position: [0,0], key: 'gender'
-    cell position: [1,0], key: 'name'
+```
+  Csv2hash::Main.generate_definition :name do
+    set_type { Definition::MAPPING }
+    set_header_size { 2 } # 0 by default
+    set_structure_rules {{ 'MaxColumns' => 2 }}
+    mapping do
+      cell position: [0,0], key: 'gender'
+      cell position: [1,0], key: 'name'
+    end
   end
-end
-Csv2hash::Main[:name] # Access anywhere
+  Csv2hash::Main[:name] # Access anywhere
+```
 
 ### Rules
 
-You should declared a definition for you CSV, and then define for each cell what you would expect.
+You should declared a definition of your CSV file, and then define for each cell what you would expect.
 
 Example :
 
@@ -53,7 +55,7 @@ If you want the very first cell, located on the first line and on the first colu
 	cell name: 'aswering', type: 'string', values: ['yes', 'no'], position: [0,0]
 ```
 
-:type attribute has 'string' for default value, therefore you can just write this:
+`:type` attribute has `String` for default value, therefore you can just write this:
 
 ```
 	cell name: 'aswering', values: ['yes', 'no'], position: [0,0]
@@ -109,7 +111,7 @@ A definition should be provided. There are 2 types of definitions:
 
 ## Samples
 
-### Validation of cells with defined precision
+### [MAPPING] Validation of cells with defined precision
 
 Consider the following CSV:
 
@@ -138,21 +140,21 @@ Precise position validation sample:
 		private
 
 		def definition
-      Main.generate_definition :my_defintion do
-        set_type { Definition::MAPPING }
-        set_header_size { 1 }
-          mapping do
-            cell position: [2,1], key: 'first_name'
-            cell position: [3,1], key: 'last_name'
-          end
-        end
-      end
+	      Main.generate_definition :my_defintion do
+	        set_type { Definition::MAPPING }
+	        set_header_size { 1 }
+	          mapping do
+	            cell position: [2,1], key: 'first_name'
+	            cell position: [3,1], key: 'last_name'
+	          end
+	        end
+	      end
 		end
 
 	end
 ```
 
-### Validation of a collection (Regular CSV)
+### [COLLECTION] Validation of a collection (Regular CSV)
 
 Consider the following CSV:
 
@@ -182,18 +184,18 @@ Collection validation sample:
 			Csv2Hash::Definition.new(rules, type = Csv2Hash::Definition::COLLECTION, header_size: 1)
 		end
 
-    def definition
-      Main.generate_definition :my_defintion do
-        set_type { Definition::COLLECTION }
-        set_header_size { 1 }
-          mapping do
-            cell position: 0, key: 'nickname'
-            cell position: 1, key: 'first_name'
-            cell position: 2, key: 'last_name'
-          end
-        end
-      end
-    end
+	    def definition
+	      Main.generate_definition :my_defintion do
+	        set_type { Definition::COLLECTION }
+	        set_header_size { 1 }
+	          mapping do
+	            cell position: 0, key: 'nickname'
+	            cell position: 1, key: 'first_name'
+	            cell position: 2, key: 'last_name'
+	          end
+	        end
+	      end
+	    end
 
 	end
 ```
@@ -201,7 +203,7 @@ Collection validation sample:
 ### 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.
-Current validations are: MinColumn, MaxColumn
+Current validations are: :min_columns, :max_columns
 
 ```
   class MyParser
@@ -222,7 +224,7 @@ Current validations are: MinColumn, MaxColumn
       Main.generate_definition :my_defintion do
         set_type { Definition::COLLECTION }
         set_header_size { 1 }
-        set_structure_rules {{ 'MinColumns' => 2, 'MaxColumns' => 3 }}
+        set_structure_rules {{ min_columns: 2, max_columns: 3 }}
           mapping do
             cell position: 0, key: 'nickname'
             cell position: 1, key: 'first_name'
@@ -250,18 +252,18 @@ Pasrer can take several parameters like that:
 	definition, file_path_or_data, ignore_blank_line: false
 ```
 
-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.
+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
 
-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?
 	    response.data
     else
-	    response.errors
+		response.errors
     end
 ```
 
@@ -273,7 +275,7 @@ 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 **break_on_failure 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 differents modes of parsing, either **break_on_failure mode** for throw an exception when rule fail or **csv mode** for get csv original data + errors throwing into added extra column.
 
 ### On **BREAK_ON_FAILURE MODE**
 
@@ -337,7 +339,7 @@ errors is a Array of Hash
 ### Rule
 
 ```
-	{ position: [1,1], key: 'nickname', allow_blank: false }
+	cell position: [1,1], key: 'nickname', allow_blank: false
 ```
 
 ### Error
@@ -373,100 +375,13 @@ Csv data
 	[ [ 'Foo' ] ]
 ```
 
-# Upgrading
-
-# Upgrading from 0.5 to 0.6
-
-Introduce DSL
-
-Prior to 0.6 :
-
-```
-  rules = [{ position: [0,0], key: 'name' }]
-  Csv2hash::Definition.new(rules, Definition::MAPPING, options={})
-
-```
+# Changes
 
-Starting from 0.6 :
+please refere to [CHANGELOG.md](https://github.com/FinalCAD/csv2hash/blob/master/CHANGELOG.md) doc
 
-```
-  Csv2hash::Main.generate_definition :foo do
-    set_type { Definition::MAPPING }
-    mapping { cell position: [0,0], key: 'name' }
-  end
-  Csv2hash::Main[:foo] # Access anywhere
-```
-
-# Upgrading from 0.4 to 0.5
-
-Signature of ```Csv2hash::Main#new``` has changed too
-
-Prior to 0.5 :
-
-```
-  Csv2Hash::Main.new(definition, file_path_or_data, ignore_blank_line=false)
-```
-
-Starting from 0.5 :
-
-```
-  Csv2Hash::Main.new(definition, file_path_or_data, ignore_blank_line: false)
-```
-
-# Upgrading from 0.3 to 0.4
-
-Signature of ```Csv2hash::Main#new``` has changed too
-
-Prior to 0.4 :
-
-```
-  Csv2Hash::Main.new(definition, file_path_or_data, break_on_failure=true, ignore_blank_line=false)
-```
-
-call ```.parse!``` for same result
-
-Starting from 0.4 :
-
-```
-  Csv2Hash::Main.new(definition, file_path_or_data, ignore_blank_line=false)
-```
-
-call ```.parse``` for same result
-
-# Upgrading from 0.2 to 0.3
-
-```Csv2hash``` become an ```Module```,  ```Csv2hash.new``` no longer works, please use ```Csv2hash::Main.new``` instead.
-Signature of ```Csv2hash::Main#new``` has changed too
-
-Prior to 0.3 :
-
-```
-  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, break_on_failure=true, ignore_blank_line=false)
-```
-
-# Upgrading from 0.1 to 0.2
-
-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 :
-
-```
-  Csv2Hash::Definition.new(rules, type = Csv2Hash::Definition::COLLECTION, 1)
-```
-
-Starting from 0.2 :
-
-```
-  Csv2Hash::Definition.new(rules, type = Csv2Hash::Definition::COLLECTION, header_size: 1)
-```
+# Upgrading
 
-If no configuration is passed, header_size defaults remains to 0
+please refere to [UPGRADE.md](https://github.com/FinalCAD/csv2hash/blob/master/UPGRADE.md) doc
 
 ## Contributing
 

data/UPGRADE.md

@@ -0,0 +1,94 @@
+# Upgrading
+
+# Upgrading from 0.5 to 0.6
+
+Introduce DSL
+
+Prior to 0.6 :
+
+```
+  rules = [{ position: [0,0], key: 'name' }]
+  Csv2hash::Definition.new(rules, Definition::MAPPING, options={})
+
+```
+
+Starting from 0.6 :
+
+```
+  Csv2hash::Main.generate_definition :foo do
+    set_type { Definition::MAPPING }
+    mapping { cell position: [0,0], key: 'name' }
+  end
+  Csv2hash::Main[:foo] # Access anywhere
+```
+
+# Upgrading from 0.4 to 0.5
+
+Signature of ```Csv2hash::Main#new``` has changed too
+
+Prior to 0.5 :
+
+```
+  Csv2Hash::Main.new(definition, file_path_or_data, ignore_blank_line=false)
+```
+
+Starting from 0.5 :
+
+```
+  Csv2Hash::Main.new(definition, file_path_or_data, ignore_blank_line: false)
+```
+
+# Upgrading from 0.3 to 0.4
+
+Signature of ```Csv2hash::Main#new``` has changed too
+
+Prior to 0.4 :
+
+```
+  Csv2Hash::Main.new(definition, file_path_or_data, break_on_failure=true, ignore_blank_line=false)
+```
+
+call ```.parse!``` for same result
+
+Starting from 0.4 :
+
+```
+  Csv2Hash::Main.new(definition, file_path_or_data, ignore_blank_line=false)
+```
+
+call ```.parse``` for same result
+
+# Upgrading from 0.2 to 0.3
+
+```Csv2hash``` become an ```Module```,  ```Csv2hash.new``` no longer works, please use ```Csv2hash::Main.new``` instead.
+Signature of ```Csv2hash::Main#new``` has changed too
+
+Prior to 0.3 :
+
+```
+  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, break_on_failure=true, ignore_blank_line=false)
+```
+
+# Upgrading from 0.1 to 0.2
+
+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 :
+
+```
+  Csv2Hash::Definition.new(rules, type = Csv2Hash::Definition::COLLECTION, 1)
+```
+
+Starting from 0.2 :
+
+```
+  Csv2Hash::Definition.new(rules, type = Csv2Hash::Definition::COLLECTION, header_size: 1)
+```
+
+If no configuration is passed, header_size defaults remains to 0

data/lib/csv2hash/structure_validator/deprecation.rb

@@ -0,0 +1,21 @@
+module Csv2hash
+  module StructureValidator
+    module Deprecation
+
+      OLD_MAX_COLUMN = 'MaxColumns'.freeze
+      OLD_MIN_COLUMN = 'MinColumns'.freeze
+      OLD_RULES_NAME = [ OLD_MIN_COLUMN, OLD_MAX_COLUMN ]
+      NEW_SYNTAX = { OLD_MIN_COLUMN => 'min_columns', OLD_MAX_COLUMN => 'max_columns' }
+
+      def check_params rule
+        if OLD_RULES_NAME.include? rule
+          warn "[DEPRECATION]: `#{rule}` is deprecated.  Please use `#{NEW_SYNTAX[rule]}` instead."
+          NEW_SYNTAX[rule]
+        else
+          rule.to_s
+        end
+      end
+
+    end
+  end
+end

data/lib/csv2hash/structure_validator/max_columns.rb

@@ -1,18 +1,20 @@
-module Csv2hash::StructureValidator
-  class MaxColumns
+module Csv2hash
+  module StructureValidator
+    class MaxColumns
 
-    include Csv2hash::StructureValidator::Validator
+      include Validator
 
-    def initialize max_size
-      @max_size = max_size
-    end
+      def initialize max_size
+        @max_size = max_size
+      end
 
-    def validate_line line
-      line.size > @max_size
-    end
+      def validate_line line
+        line.size > @max_size
+      end
 
-    def error_message line
-      "Too many columns (max. #{@max_size}) on line #{line}"
+      def error_message line
+        "Too many columns (max. #{@max_size}) on line #{line}"
+      end
     end
   end
-end
+end

data/lib/csv2hash/structure_validator/min_columns.rb

@@ -1,18 +1,20 @@
-module Csv2hash::StructureValidator
-  class MinColumns
+module Csv2hash
+  module StructureValidator
+    class MinColumns
 
-    include Csv2hash::StructureValidator::Validator
+      include Validator
 
-    def initialize min_size
-      @min_size = min_size
-    end
+      def initialize min_size
+        @min_size = min_size
+      end
 
-    def validate_line line
-      line.size < @min_size
-    end
+      def validate_line line
+        line.size < @min_size
+      end
 
-    def error_message line
-      "Not enough columns (min. #{@min_size}) on line #{line}"
+      def error_message line
+        "Not enough columns (min. #{@min_size}) on line #{line}"
+      end
     end
   end
-end
+end

data/lib/csv2hash/structure_validator.rb

@@ -1,31 +1,45 @@
-# require 'active_support/core_ext'
+require 'active_support/core_ext'
 
-module Csv2hash::StructureValidator
-  class ValidationError < StandardError ; end
+require_relative 'structure_validator/deprecation'
 
-  def validate_structure!
-    # binding.pry
-    definition.structure_rules.each do |rule, options|
-      begin
-        rule_instance(rule, options).validate! data_source
-      rescue => e
-        self.errors << { y: nil, x: nil, message: e.message, key: nil }
-        raise if break_on_failure
+module Csv2hash
+  module StructureValidator
+    include Deprecation
+
+    class ValidationError < StandardError ; end
+
+    MAX_COLUMN = 'max_columns'.freeze
+    MIN_COLUMN = 'min_columns'.freeze
+    RULES_NAME = [ MIN_COLUMN, MAX_COLUMN ]
+
+    def validate_structure!
+      definition.structure_rules.each do |rule, options|
+        begin
+          rule_instance(rule, options).validate! data_source
+        rescue => e
+          self.errors << { y: nil, x: nil, message: e.message, key: nil }
+          raise if break_on_failure
+        end
       end
     end
-  end
 
-  def rule_instance rule, options
-    Csv2hash::StructureValidator.const_get(rule).new(options)
-    # 'min_columns'.camelize.constantize.new
-  end
+    def rule_instance rule, options
+      _rule = check_params rule
+      begin
+        StructureValidator.const_get(_rule.camelize).new(options)
+      rescue NameError => e
+        raise "Structure rule #{rule} unknow, please use one of these #{RULES_NAME}"
+      end
+    end
 
-  module Validator
-    def validate! source
-      source.index { |line| validate_line line }.tap do |line|
-        raise Csv2hash::StructureValidator::ValidationError, error_message(line) unless line.nil?
+    module Validator
+      def validate! source
+        source.index { |line| validate_line line }.tap do |line|
+          raise ValidationError, error_message(line) unless line.nil?
+        end
+        true
       end
-      true
     end
+
   end
 end

data/lib/csv2hash/version.rb

@@ -1,3 +1,3 @@
 module Csv2hash
-  VERSION = '0.6.0'
+  VERSION = '0.6.1'
 end

data/spec/csv2hash/structure_validator_spec.rb

@@ -18,7 +18,7 @@ module Csv2hash
 
     context 'the csv with errors' do
       before do
-        allow(definition).to receive(:structure_rules) {{ 'MaxColumns' => 2 }}
+        allow(definition).to receive(:structure_rules) {{ max_columns: 2 }}
         subject.parse
       end
       let(:data_source) do
@@ -30,13 +30,14 @@ module Csv2hash
 
       its(:csv_with_errors) { should be_kind_of CsvArray }
       it "adds structure error in first cell" do
+
         expect(subject.csv_with_errors.first[:message]).to eq 'Too many columns (max. 2) on line 1'
       end
     end
 
     context '#MaxColumns'  do
       before do
-        allow(definition).to receive(:structure_rules) {{ 'MaxColumns' => 2 }}
+        allow(definition).to receive(:structure_rules) {{ max_columns: 2 }}
         allow(subject).to receive(:break_on_failure) { true }
       end
 
@@ -62,7 +63,7 @@ module Csv2hash
 
     context '#MinColumns'  do
       before do
-        allow(definition).to receive(:structure_rules) {{ 'MinColumns' => 2 }}
+        allow(definition).to receive(:structure_rules) {{ min_columns: 2 }}
         allow(subject).to receive(:break_on_failure) { true }
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: csv2hash
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Joel AZEMAR
@@ -92,12 +92,13 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
-- ReleaseNotes.md
+- UPGRADE.md
 - bin/launch_irb
 - bin/load_rvm
 - coverage/.resultset.json.lock
@@ -119,6 +120,7 @@ files:
 - lib/csv2hash/parser/mapping.rb
 - lib/csv2hash/registry.rb
 - lib/csv2hash/structure_validator.rb
+- lib/csv2hash/structure_validator/deprecation.rb
 - lib/csv2hash/structure_validator/max_columns.rb
 - lib/csv2hash/structure_validator/min_columns.rb
 - lib/csv2hash/validator.rb