csv2hash 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4090ad5c8ae287a7993eaa7dd625fb7afbd3e550
-  data.tar.gz: 005e9fade78e3197a82bc90e22239447b678544a
+  metadata.gz: 8e9db6b93dc1699a3757bb2e9d813285c58e5f4b
+  data.tar.gz: aa03c5a3d6679ac7b1598052dbe8cb38a9ea88ae
 SHA512:
-  metadata.gz: 6451cd53411bbcb95227fba3a24d3022b89e2d739564065a4d4de9aba9b9de341940a21f5437f4700991c011d5cba85ac4e924e4707d0c0bd6baca793c6680d6
-  data.tar.gz: 70e8675bf35dfa087805d02ac8cd370e1ab8598f8e5763b901b37a578ca7571b3029657fcdf9c8abffaf83c54d6bea5baa6bce595b105f4fe9e1a067f0841a16
+  metadata.gz: d3aa7cdba3548a4bca5e185ee550fbf3812b0912fd5f0a47b4db131a3245a4e736bfb89a93dbd259118cdd37b405a6958fdf4a58d6e07b1ceab208d69436d232
+  data.tar.gz: 9485aca4d1047db6566e07b8dd87282c505fe4db9ad5d7cd4db6f5b8097819b50aeeea0c381a2beca64ec1e096938713a04f674c973d80a5995fbd5dc49f9d4a

data/Gemfile.lock

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

data/README.md

@@ -120,7 +120,7 @@ Precise position validation sample:
 		end
 
 		def definition
-			Csv2Hash::Definition.new(rules, type = Csv2Hash::Definition::MAPPING, 1)
+			Csv2Hash::Definition.new(rules, type = Csv2Hash::Definition::MAPPING, header_size: 1)
 		end
 
 	end
@@ -159,11 +159,45 @@ Collection validation sample:
 		end
 
 		def definition
-			Csv2Hash::Definition.new(rules, type = Csv2Hash::Definition::MAPPING, 1)
+			Csv2Hash::Definition.new(rules, type = Csv2Hash::Definition::COLLECTION, header_size: 1)
 		end
 
 	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.
+Current validations are: MinColumn, MaxColumn
+
+class MyParser
+
+	attr_accessor :file_path
+
+	def initialize file_path
+		@file_path = file_path
+	end
+
+	def data
+		@data_wrapper ||= Csv2hash.new(definition, file_path).parse
+	end
+
+	private
+
+	def rules
+		[].tap do |mapping|
+			mapping << { position: 0, key: 'nickname'   }
+			mapping << { position: 1, key: 'first_name' }
+			mapping << { position: 2, key: 'last_name'  }
+		end
+	end
+
+  def definition
+	  Csv2Hash::Definition.new(rules, type = Csv2Hash::Definition::COLLECTION, structure_rules: {'MinColumn' => 2, 'MaxColumn' => 3})
+  end
+end
+
+
 ### CSV Headers
 
 You can define the number of rows to skip in the header of the CSV.
@@ -275,9 +309,22 @@ Csv data
 	[ [ 'Foo' ] ]
 
 
-### Limitations
+### 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 :
+
+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)
+```
 
-* Don't manage number of column you expected on collection mode
+If no configuration is passed, header_size defaults remains to 0
 
 ## Contributing
 

data/ReleaseNotes.md

@@ -1,3 +1,8 @@
+VERSION 0.2
+
+* The signature of Definition#new
+* Add checking of number of columns
+
 VERSION 0.1
 
 * Add csv errors mode

data/csv2hash.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |spec|
 
   spec.name        = 'csv2hash'
-  spec.version     = '0.1.1'
+  spec.version     = '0.2.0'
   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/definition.rb

@@ -6,10 +6,11 @@ class Csv2hash
 
     TYPES = [MAPPING, COLLECTION]
 
-    attr_accessor :rules, :type, :header_size
+    attr_accessor :rules, :type, :header_size, :structure_rules
 
-    def initialize rules, type, header_size=0
-      self.rules, self.type, self.header_size = rules, type, header_size
+    def initialize rules, type, options = {}
+      self.rules, self.type = rules, type
+      self.header_size, self.structure_rules = options.fetch(:header_size) { 0 }, options.fetch(:structure_rules) { {} }
     end
 
     def validate!
@@ -17,6 +18,7 @@ class Csv2hash
         raise "not suitable type, please use '#{MAPPING}' or '#{COLLECTION}'"
       end
       raise 'rules must be an Array of rules' unless rules.class == Array
+      raise 'structure rules must be a Hash of rules' unless structure_rules.class == Hash
     end
 
     def default!

data/lib/csv2hash/structure_validator/max_columns.rb

@@ -0,0 +1,18 @@
+module Csv2hash::StructureValidator
+  class MaxColumns
+
+    include Csv2hash::StructureValidator::Validator
+
+    def initialize max_size
+      @max_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}"
+    end
+  end
+end

data/lib/csv2hash/structure_validator/min_columns.rb

@@ -0,0 +1,18 @@
+module Csv2hash::StructureValidator
+  class MinColumns
+
+    include Csv2hash::StructureValidator::Validator
+
+    def initialize min_size
+      @min_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}"
+    end
+  end
+end

data/lib/csv2hash/structure_validator.rb

@@ -0,0 +1,27 @@
+module Csv2hash::StructureValidator
+  class ValidationError < StandardError ; end
+
+  def validate_structure!
+    definition.structure_rules.each do |rule, options|
+      begin
+        rule_instance(rule, options).validate! data_source
+      rescue => e
+        self.errors << e.message
+        raise if exception_mode
+      end
+    end
+
+    def rule_instance rule, options
+      Csv2hash::StructureValidator.const_get(rule).new(options)
+    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?
+      end
+      true
+    end
+  end
+end

data/lib/csv2hash/version.rb

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

data/lib/csv2hash.rb

@@ -3,6 +3,9 @@ require 'csv2hash/definition'
 require 'csv2hash/validator'
 require 'csv2hash/validator/mapping'
 require 'csv2hash/validator/collection'
+require 'csv2hash/structure_validator'
+require 'csv2hash/structure_validator/max_columns'
+require 'csv2hash/structure_validator/min_columns'
 require 'csv2hash/parser'
 require 'csv2hash/parser/mapping'
 require 'csv2hash/parser/collection'
@@ -15,6 +18,8 @@ require 'csv'
 
 class Csv2hash
 
+  include Csv2hash::StructureValidator
+
   attr_accessor :definition, :file_path, :data, :notifier, :exception_mode, :errors, :ignore_blank_line
 
   def initialize definition, file_path, exception_mode=true, data_source=nil, ignore_blank_line=false
@@ -26,6 +31,7 @@ class Csv2hash
     self.notifier = Notifier.new
     self.ignore_blank_line = ignore_blank_line
     init_plugins
+
   end
 
   def init_plugins
@@ -42,6 +48,7 @@ class Csv2hash
 
     definition.validate!
     definition.default!
+    validate_structure!
     validate_data!
 
     Csv2hash::DataWrapper.new.tap do |response|

data/spec/csv2hash/definition_spec.rb

@@ -2,10 +2,11 @@ require 'spec_helper'
 
 describe Csv2hash::Definition do
 
+  let(:valid_rules) { [ { position: [0,0], key: 'name' } ] }
   context 'regular context' do
     subject do
       Csv2hash::Definition.new(
-        [ { position: [0,0], key: 'name' } ],
+        valid_rules,
         Csv2hash::Definition::MAPPING
       )
     end
@@ -36,6 +37,15 @@ describe Csv2hash::Definition do
         expect { subject.validate! }.to raise_error 'rules must be an Array of rules'
       end
     end
+
+    context 'structure rules failling validation' do
+      subject do
+        Csv2hash::Definition.new valid_rules, Csv2hash::Definition::MAPPING, { structure_rules: 'invalid structure rule' }
+      end
+      it 'should throw exception' do
+        expect { subject.validate! }.to raise_error 'structure rules must be a Hash of rules'
+      end
+    end
   end
 
   describe '#default!' do

data/spec/csv2hash/structure_validator_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+describe Csv2hash::StructureValidator do
+
+  let(:rules) { [ { position: [0,0], key: 'name' } ] }
+  let(:options) { {} }
+  let(:definition) do
+    Csv2hash::Definition.new(rules, Csv2hash::Definition::MAPPING, options).tap do |definition|
+      definition.validate!
+      definition.default!
+    end
+  end
+
+  subject do
+    Csv2hash.new(definition, 'file_path', true, data_source)
+  end
+
+  context '#MaxColumns'  do
+    let(:options){ { structure_rules: { 'MaxColumns' => 2 } } }
+
+    context 'valid data' do
+      let(:data_source) do
+        [
+          [ 'John', 'Doe' ]
+        ]
+      end
+      it { expect { subject.validate_structure! }.to_not raise_error }
+    end
+
+    context 'invalid data' do
+      let(:data_source) do
+        [
+          [ 'John', 'Doe' ],
+          [ 'Jane', 'Doe', 'extra field' ]
+        ]
+      end
+      it { expect { subject.validate_structure! }.to raise_error 'Too many columns (max. 2) on line 1' }
+    end
+  end
+
+  context '#MinColumns'  do
+    let(:options){ { structure_rules: { 'MinColumns' => 2 } } }
+
+    context 'valid data' do
+      let(:data_source) do
+        [
+          [ 'John', 'Doe', 'foo' ]
+        ]
+      end
+      it { expect { subject.validate_structure! }.to_not raise_error }
+    end
+
+    context 'invalid data' do
+      let(:data_source) do
+        [
+          [ 'John' ],
+          [ 'Jane', 'Doe' ]
+        ]
+      end
+      it { expect { subject.validate_structure! }.to raise_error 'Not enough columns (min. 2) on line 0' }
+    end
+  end
+
+end

data/spec/csv2hash/validator/collection_spec.rb

@@ -1,9 +1,9 @@
 require 'spec_helper'
 
 describe Csv2hash::Validator::Collection do
-
+  let(:options) { {} }
   let(:definition) do
-    Csv2hash::Definition.new([ { position: 0, key: 'name' } ], Csv2hash::Definition::COLLECTION).tap do |definition|
+    Csv2hash::Definition.new([ { position: 0, key: 'name' } ], Csv2hash::Definition::COLLECTION, options).tap do |definition|
       definition.validate!
       definition.default!
     end
@@ -17,7 +17,7 @@ describe Csv2hash::Validator::Collection do
     let(:data_source) { [ [ 'John Doe' ] ]}
     it { expect { subject.validate_data! }.to_not raise_error }
     context 'with header' do
-      before { subject.definition.header_size = 1 }
+      let(:options) { { header_size: 1 } }
       let(:data_source) { [ [ 'Name' ], [ 'John Doe' ] ]}
       it { expect { subject.validate_data! }.to_not raise_error }
     end
@@ -37,7 +37,7 @@ describe Csv2hash::Validator::Collection do
     let(:data_source) { [ [ ] ] }
     it { expect { subject.validate_data! }.to raise_error('undefined name on [0, 0]') }
     context 'with header' do
-      before { subject.definition.header_size = 1 }
+      let(:options) { { header_size: 1 } }
       let(:data_source) { [ [ 'Name' ], [ ] ]}
       it { expect { subject.validate_data! }.to raise_error('undefined name on [1, 0]') }
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: csv2hash
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Joel AZEMAR
@@ -83,6 +83,9 @@ files:
 - lib/csv2hash/parser.rb
 - lib/csv2hash/parser/collection.rb
 - lib/csv2hash/parser/mapping.rb
+- lib/csv2hash/structure_validator.rb
+- lib/csv2hash/structure_validator/max_columns.rb
+- lib/csv2hash/structure_validator/min_columns.rb
 - lib/csv2hash/validator.rb
 - lib/csv2hash/validator/collection.rb
 - lib/csv2hash/validator/mapping.rb
@@ -91,6 +94,7 @@ files:
 - spec/csv2hash/parser/collection_spec.rb
 - spec/csv2hash/parser/mapping_spec.rb
 - spec/csv2hash/parser_spec.rb
+- spec/csv2hash/structure_validator_spec.rb
 - spec/csv2hash/validator/collection_spec.rb
 - spec/csv2hash/validator/mapping_spec.rb
 - spec/csv2hash/validator_spec.rb
@@ -125,6 +129,7 @@ test_files:
 - spec/csv2hash/parser/collection_spec.rb
 - spec/csv2hash/parser/mapping_spec.rb
 - spec/csv2hash/parser_spec.rb
+- spec/csv2hash/structure_validator_spec.rb
 - spec/csv2hash/validator/collection_spec.rb
 - spec/csv2hash/validator/mapping_spec.rb
 - spec/csv2hash/validator_spec.rb