csv2hash 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ab8b867d5257761c23fb310ad45eab25d5eebe9
-  data.tar.gz: ffec55a91cb1ccd853e641b65f965cc0a51c0350
+  metadata.gz: 712c36523387610b2faba0dfb934e772a281ee19
+  data.tar.gz: 9275f05691e92eda1e32f08395bae382282515fd
 SHA512:
-  metadata.gz: 801f045f211e3dffaafad4c27dffd922132b40be5bc98b2013fafa676f7c3a7584bfad7f5c39ce96dc34a7ace3033cfd54f5505812d61e58ba0c20b6b956228c
-  data.tar.gz: d446c104f67af25a884fabfa3784b2baaaeaf559de8cb8d901c55acef7762966a4aa1ff80b637cfbda25e18c75bcc725b29fd3a1b97212ef9d3b7719ae628b78
+  metadata.gz: f37e0262f38b234f2b0b092f8e9f9a048e43e91dbd732d27e83911097989956567cc9482547ed868bdaf3240d5f149f55024b8721d2d5c5b24365a610ab239c6
+  data.tar.gz: 5d0bf911880893b7af380c61b9339bd6820a82b862bc2af4214e1453ca1abe7013b85a837a467d1ca8f491c6f0fad7bdc86bca74382e627d20bc8faa189b204b

data/.coveralls.yml

@@ -1 +1 @@
-repo_token: N3Ql9kjuVUDMaof2gKqn1TiNXt4bYfRUw
+service_name: travis-ci

data/.travis.yml

@@ -1,3 +1,4 @@
 language: ruby
 rvm:
-  - 2.0.0
+  - 2.1.2
+script: bundle exec rspec spec

data/Gemfile

@@ -3,7 +3,6 @@ source 'http://rubygems.org'
 gemspec
 
 group :test do
-  gem 'guard'
-  gem 'guard-rspec'
   gem 'coveralls', require: false
-end
+  gem 'pry'
+end

data/Gemfile.lock

@@ -1,70 +1,56 @@
 PATH
   remote: .
   specs:
-    csv2hash (0.2.1)
+    csv2hash (0.3.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    celluloid (0.15.2)
-      timers (~> 1.1.0)
     coderay (1.1.0)
-    coveralls (0.7.0)
+    coveralls (0.7.1)
       multi_json (~> 1.3)
       rest-client
       simplecov (>= 0.7)
       term-ansicolor
       thor
     diff-lcs (1.2.5)
-    docile (1.1.1)
-    ffi (1.9.3)
-    formatador (0.2.4)
-    guard (2.2.4)
-      formatador (>= 0.2.4)
-      listen (~> 2.1)
-      lumberjack (~> 1.0)
-      pry (>= 0.9.12)
-      thor (>= 0.18.1)
-    guard-rspec (4.0.4)
-      guard (>= 2.1.1)
-      rspec (~> 2.14)
-    listen (2.2.0)
-      celluloid (>= 0.15.2)
-      rb-fsevent (>= 0.9.3)
-      rb-inotify (>= 0.9)
-    lumberjack (1.0.4)
+    docile (1.1.5)
+    its (0.2.0)
+      rspec-core
     method_source (0.8.2)
-    mime-types (2.0)
-    multi_json (1.8.2)
-    pry (0.9.12.4)
-      coderay (~> 1.0)
-      method_source (~> 0.8)
+    mime-types (2.3)
+    multi_json (1.10.1)
+    netrc (0.7.7)
+    pry (0.10.0)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
       slop (~> 3.4)
-    rake (10.1.0)
-    rb-fsevent (0.9.3)
-    rb-inotify (0.9.2)
-      ffi (>= 0.5.0)
-    rest-client (1.6.7)
-      mime-types (>= 1.16)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.7)
-    rspec-expectations (2.14.4)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.4)
-    simplecov (0.8.2)
+    rake (10.3.2)
+    rest-client (1.7.2)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.4)
+    simplecov (0.9.0)
       docile (~> 1.1.0)
       multi_json
       simplecov-html (~> 0.8.0)
     simplecov-html (0.8.0)
-    slop (3.4.7)
-    term-ansicolor (1.2.2)
-      tins (~> 0.8)
-    thor (0.18.1)
-    timers (1.1.0)
-    tins (0.13.1)
+    slop (3.5.0)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    thor (0.19.1)
+    tins (1.3.2)
 
 PLATFORMS
   ruby
@@ -73,7 +59,7 @@ DEPENDENCIES
   bundler (~> 1.3)
   coveralls
   csv2hash!
-  guard
-  guard-rspec
+  its
+  pry
   rake
   rspec

data/README.md

@@ -1,13 +1,12 @@
 # Csv2Hash
 
-[![Code Climate](https://codeclimate.com/github/joel/csv2hash.png)](https://codeclimate.com/github/joel/csv2hash)
+[![Code Climate](https://codeclimate.com/github/FinalCAD/csv2hash.png)](https://codeclimate.com/github/FinalCAD/csv2hash)
 
-[![Dependency Status](https://gemnasium.com/joel/csv2hash.png)](https://gemnasium.com/joel/csv2hash)
+[![Dependency Status](https://gemnasium.com/FinalCAD/csv2hash.png)](https://gemnasium.com/FinalCAD/csv2hash)
 
-[![Build Status](https://travis-ci.org/joel/csv2hash.png?branch=master)](https://travis-ci.org/joel/csv2hash) (Travis CI)
-
-[![Coverage Status](https://coveralls.io/repos/joel/csv2hash/badge.png)](https://coveralls.io/r/joel/csv2hash)
+[![Build Status](https://travis-ci.org/FinalCAD/csv2hash.png?branch=master)](https://travis-ci.org/FinalCAD/csv2hash) (Travis CI)
 
+[![Coverage Status](https://coveralls.io/repos/FinalCAD/csv2hash/badge.png)](https://coveralls.io/r/FinalCAD/csv2hash)
 
 It is a DSL to validate and map a CSV to a Ruby Hash.
 
@@ -31,33 +30,45 @@ Parsing is based on rules, you must defined rules of parsing
 
 ### Rules
 
-You should declare a definition for you CSV, and then define for each cell what you would expect.
+You should declared a definition for you CSV, and then define for each cell what you would expect.
 
 Example :
 
 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] }
+```
 
 :type attribute has 'string' for default value, therefore you can just write this:
 
+```
 	{ name: 'aswering', values: ['yes', 'no'], position: [0,0] }
+```
 
 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 of values
 
+```
 	{ name: 'score', values: 0..5, position: [0,0] }
+```
 
 The message is parsed:
 
+```
 	{ ..., message: 'value of :name is not supported, please you one of :values' }
+```
 
 It produces :
 
+```
 	value of answering is not supported, please use one of [yes, no]
+```
 
 ### Default values
 
@@ -77,7 +88,7 @@ All remaining keys are optionals:
 
 ## Define where your data is expected
 
-**IMPORTANT!** Position mean [Y, X], where Y is rows, X columns
+**IMPORTANT!** Position means [Y, X], where Y is rows, X columns
 
 A definition should be provided. There are 2 types of definitions:
 * search for data at a precise position in the table: `y,x`
@@ -98,16 +109,17 @@ Consider the following CSV:
 
 Precise position validation sample:
 
+```
 	class MyParser
 
-		attr_accessor :file_path
+		attr_accessor :file_path_or_data
 
-		def initialize file_path
-			@file_path = file_path
+		def initialize file_path_or_data
+			@file_path_or_data = file_path_or_data
 		end
 
 		def data
-			@data_wrapper ||= Csv2hash.new(definition, file_path).parse
+			@data_wrapper ||= Csv2hash::Main.new(definition, file_path_or_data).parse
 		end
 
 		private
@@ -124,6 +136,7 @@ Precise position validation sample:
 		end
 
 	end
+```
 
 ### Validation of a collection (Regular CSV)
 
@@ -136,16 +149,17 @@ Consider the following CSV:
 
 Collection validation sample:
 
+```
 	class MyParser
 
-		attr_accessor :file_path
+		attr_accessor :file_path_or_data
 
-		def initialize file_path
-			@file_path = file_path
+		def initialize file_path_or_data
+			@file_path_or_data = file_path_or_data
 		end
 
 		def data
-			@data_wrapper ||= Csv2hash.new(definition, file_path).parse
+			@data_wrapper ||= Csv2hash::Main.new(definition, file_path_or_data).parse
 		end
 
 		private
@@ -163,68 +177,79 @@ Collection validation sample:
 		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
+```
+  class MyParser
 
-	attr_accessor :file_path
+  	attr_accessor :file_path_or_data
 
-	def initialize file_path
-		@file_path = file_path
-	end
+  	def initialize file_path_or_data
+  		@file_path_or_data = file_path_or_data
+  	end
 
-	def data
-		@data_wrapper ||= Csv2hash.new(definition, file_path).parse
-	end
+  	def data
+  		@data_wrapper ||= Csv2hash::Main.new(definition, file_path_or_data).parse
+  	end
 
-	private
+  	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 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: { 'MinColumns' => 2, 'MaxColumns' => 3 })
+    def definition
+  	  Csv2Hash::Definition.new(rules, type = Csv2Hash::Definition::COLLECTION,
+        structure_rules: { 'MinColumns' => 2, 'MaxColumns' => 3 })
+    end
   end
-end
-
+```
 
 ### CSV Headers
 
 You can define the number of rows to skip in the header of the CSV.
 
+```
 	Definition.new(rules, type, header_size: 0)
+```
 
 ### Parser and configuration
 
 Pasrer can take several parameters like that:
 
-	definition, file_path, exception_mode=true, data_source=nil, ignore_blank_line=false
+```
+	definition, file_path_or_data, exception_mode=true, 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 blank lines in your CSV you can ignore them.
+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.
 
 ### 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 :
 
+```
     response = parser.parse
     if response.valid?
 	    response.data
     else
 	    response.errors
     end
+```
 
 data or errors are Array, but errors can be formatted on csv format with .to_csv call
 
+```
 	response.errors.to_csv
+```
 
 ## Exception or Not !
 
@@ -236,13 +261,16 @@ You can choose into 2 different modes of parsing, either **exception mode** for
 
 in your code
 
-	parser = Csv2hash.new(definition, 'file_path').new
+```
+	parser = Csv2hash::Main.new(definition, file_path_or_data, exception_mode=true, ignore_blank_line=false).new
 	response = parser.parse
 	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:
 
+```
 	module Csv2hash
 		module Plugins
 			class Notifier
@@ -262,6 +290,7 @@ In the same time Csv2hash call **notify(response)** method when CSV parsing fail
 			end
 		end
 	end
+```
 
 Or other implementation
 
@@ -269,7 +298,9 @@ Or other implementation
 
 errors is a Array of Hash
 
+```
 	{ y: 1, x: 0, message: 'message', key: 'key', value: '' }
+```
 
 ## Sample
 
@@ -281,11 +312,15 @@ errors is a Array of Hash
 
 ### Rule
 
+```
 	{ position: [1,1], key: 'nickname', allow_blank: false }
+```
 
 ### Error
 
+```
 	{ y: 1, x: 1, message: 'undefined nikcname on [0, 0]', key: 'nickname', value: nil }
+```
 
 ## Personal Validator Rule
 
@@ -293,20 +328,43 @@ You can define your own Validator
 
 For downcase validation
 
+```
 	class DowncaseValidator < Csv2hash::ExtraValidator
 		def valid? value
 			!!(value.match /^[a-z]+$/)
 		end
 	end
+```
 
 in your rule
 
+```
 	{ position: [0,0], key: 'name', extra_validator: DowncaseValidator.new,
 		message: 'your data should be written in lowercase only.' }
+```
 
 Csv data
 
+```
 	[ [ 'Foo' ] ]
+```
+
+# 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, exception_mode=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)
+```
 
 # Upgrading from 0.1 to 0.2
 
@@ -319,6 +377,7 @@ Prior to 0.2 :
 ```
 
 Starting from 0.2 :
+
 ```
   Csv2Hash::Definition.new(rules, type = Csv2Hash::Definition::COLLECTION, header_size: 1)
 ```
@@ -331,4 +390,4 @@ If no configuration is passed, header_size defaults remains to 0
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+5. Create new Pull Request

data/ReleaseNotes.md

@@ -1,25 +1,42 @@
-VERSION 0.2.1
+### VERSION 0.3.0
 
-* Correct little bug on error mode.
+* backwards incompatible changes
+  * Csv2hash is module now, call Csv2hash::Main.new
+  * The signature of Csv2hash::Main#new has changed.
 
-VERSION 0.2
+* refactoring
+  * Use adapter to select source of data, either file.csv or Array of data, is more transparently, not impact signature of Csv2Hash constructor
 
-* The signature of Definition#new
-* Add checking of number of columns
+### VERSION 0.2.1
 
-VERSION 0.1
+* bug fix
+  * Correct little bug on error mode.
 
-* Add csv errors mode
-* Add Extra Validator
-* Add Notifier Plugin
-* Add Data Wrapper Response
-* Add possibility to pass directly data in constructor, for more testing
-* You can ignore blank line
+### VERSION 0.2
 
-VERSION 0.0.2
+* backwards incompatible changes
+  * The signature of Definition#new
 
-* Liitle enhancement
+* enhancements
+  * Add checking of number of columns
 
-VERSION 0.0.1
+* deprecations
 
-* Skeleton and first parsing
+### VERSION 0.1
+
+* enhancements
+  * Add csv errors mode
+  * Add Extra Validator
+  * Add Notifier Plugin
+  * Add Data Wrapper Response
+  * Add possibility to pass directly data in constructor, for more testing
+  * You can ignore blank line
+
+### VERSION 0.0.2
+
+* enhancements
+  * Liitle enhancement
+
+### VERSION 0.0.1
+
+* Skeleton and first parsing

data/csv2hash.gemspec

@@ -1,7 +1,8 @@
-Gem::Specification.new do |spec|
+require_relative 'lib/csv2hash/version'
 
+Gem::Specification.new do |spec|
   spec.name        = 'csv2hash'
-  spec.version     = '0.2.1'
+  spec.version     = Csv2hash::VERSION
   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}
@@ -19,6 +20,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
-
-  spec.required_ruby_version = '~> 2.0'
+  spec.add_development_dependency 'its'
+  spec.required_ruby_version = '~> 2.1'
 end

data/lib/csv2hash/adapters/abstract.rb

@@ -0,0 +1,11 @@
+module Csv2hash
+  module Adapter
+    class Abstract
+
+      def source
+        raise NotImplementedError
+      end
+
+    end
+  end
+end

data/lib/csv2hash/adapters/base.rb

@@ -0,0 +1,25 @@
+module Csv2hash
+  module Adapter
+    class Base
+
+      class UnsupportedAdapter < StandardError ; end
+
+      def self.create adapter_name, file_path_or_data
+        # binding.pry
+        load "csv2hash/adapters/#{adapter_name}_adapter.rb"
+        class_eval("Csv2hash::Adapter::#{klass_adapter(adapter_name)}").new file_path_or_data
+      end
+
+      private
+
+      def self.klass_adapter adapter_symbol
+        case adapter_symbol
+        when :memory then :MemoryAdapter
+        when :csv then :CsvAdapter
+        else raise UnsupportedAdapter.new
+        end
+      end
+
+    end
+  end
+end

data/lib/csv2hash/adapters/csv_adapter.rb

@@ -0,0 +1,21 @@
+require_relative 'abstract'
+
+require 'csv'
+
+module Csv2hash
+  module Adapter
+    class CsvAdapter < Abstract
+
+      attr_accessor :file_path
+
+      def initialize file_path
+        self.file_path = file_path
+      end
+
+      def source
+        CSV.read self.file_path
+      end
+
+    end
+  end
+end

data/lib/csv2hash/adapters/memory_adapter.rb

@@ -0,0 +1,19 @@
+require_relative 'abstract'
+
+module Csv2hash
+  module Adapter
+    class MemoryAdapter < Abstract
+
+      attr_accessor :data
+
+      def initialize data
+        self.data = data
+      end
+
+      def source
+        self.data
+      end
+
+    end
+  end
+end

data/lib/csv2hash/data_wrapper.rb

@@ -1,4 +1,4 @@
-class Csv2hash
+module Csv2hash
   class DataWrapper
 
     attr_accessor :data, :errors, :valid
@@ -10,4 +10,4 @@ class Csv2hash
 
     def valid?() valid ; end
   end
-end
+end

data/lib/csv2hash/definition.rb

@@ -1,8 +1,8 @@
-class Csv2hash
+module Csv2hash
   class Definition
 
-    MAPPING = 'mapping'
-    COLLECTION = 'collection'
+    MAPPING = 'mapping'.freeze
+    COLLECTION = 'collection'.freeze
 
     TYPES = [MAPPING, COLLECTION]
 

data/lib/csv2hash/extra_validator.rb

@@ -1,4 +1,4 @@
-class Csv2hash
+module Csv2hash
   class ExtraValidator
     def valid?(rule, value) raise 'method parse!() should be implemented in sub class'; end
   end

data/lib/csv2hash/notifier.rb

@@ -1,4 +1,4 @@
-class Csv2hash
+module Csv2hash
   class Notifier
     def notify response
       # puts 'Csv with errors'