csv2hash 0.6.7 → 0.6.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 332e1760a8872c909fea63cc52a8701580ab1c50
-  data.tar.gz: 5c40139eef7283dbb3505b2557c539a4a9fb16c0
+  metadata.gz: 7c09804fb3f85eacdc90cbfa95ccee0acc8a4fb8
+  data.tar.gz: d29ac384ef4275b13e087fd0eb504eba2f93d337
 SHA512:
-  metadata.gz: d468a06d1114d8b16f283ea2f06ce08774cfa769eb761e4bb8c6a1f2f78431461c59f31d2ab4c79900ab500546c7c2666bc11a9ea0597ad8550a76c31bf01e8e
-  data.tar.gz: c6e8e3297d875cd2fda25ae025282df0a233170c3543c3d110280e30c8e4d7aedda4e0008941a258473aa5bc844547383b171169205b691ee65008f685a6a1fd
+  metadata.gz: f2b07b5cfcb24197dec4195873a285f353974960ba29deee2a805da2ee45ce5c8a09838ec04b49fab4e6683672226b46587808ffdaacf066b3c6770f139451e1
+  data.tar.gz: 5f2fda3e1d08e971ad39ad05bcfbf094f29d1d2e5ca9a86a42cf413d5c7eb502a2ce08bdcfca25c0f1afa5ccd31fe4410bea0cc190ff53fec83e1b7bc319dc54

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### VERSION 0.6.8
+
+* bug fix
+  * fix typo on generator
+  
 ### VERSION 0.6.7
 
 * enhancements

data/Gemfile

@@ -5,7 +5,7 @@ gemspec
 group :test do
   gem 'coveralls', require: false
   gem 'pry'
-  # gem 'rails'
+  gem 'generator_spec'
 end
 
 group :doc do

data/Gemfile.lock

@@ -1,18 +1,28 @@
 PATH
   remote: .
   specs:
-    csv2hash (0.6.7)
+    csv2hash (0.6.8)
       activesupport (~> 4.1)
 
 GEM
   remote: http://rubygems.org/
   specs:
+    actionpack (4.1.6)
+      actionview (= 4.1.6)
+      activesupport (= 4.1.6)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.6)
+      activesupport (= 4.1.6)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
     activesupport (4.1.6)
       i18n (~> 0.6, >= 0.6.9)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
       thread_safe (~> 0.1)
       tzinfo (~> 1.1)
+    builder (3.2.2)
     coderay (1.1.0)
     coveralls (0.7.1)
       multi_json (~> 1.3)
@@ -22,6 +32,10 @@ GEM
       thor
     diff-lcs (1.2.5)
     docile (1.1.5)
+    erubis (2.7.0)
+    generator_spec (0.9.2)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
     i18n (0.6.11)
     inch (0.4.10)
       pry
@@ -33,13 +47,21 @@ GEM
     json (1.8.1)
     method_source (0.8.2)
     mime-types (2.3)
-    minitest (5.4.1)
+    minitest (5.4.2)
     multi_json (1.10.1)
     netrc (0.7.7)
     pry (0.10.1)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    railties (4.1.6)
+      actionpack (= 4.1.6)
+      activesupport (= 4.1.6)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
     rake (10.3.2)
     rest-client (1.7.2)
       mime-types (>= 1.16, < 3.0)
@@ -83,6 +105,7 @@ DEPENDENCIES
   bundler (~> 1.6)
   coveralls
   csv2hash!
+  generator_spec
   inch
   its (~> 0.2)
   pry

data/README.md

@@ -1,5 +1,7 @@
 # Csv2Hash
 
+[![Gem Version](https://badge.fury.io/rb/csv2hash.svg)](http://badge.fury.io/rb/csv2hash)
+
 [![Code Climate](https://codeclimate.com/github/FinalCAD/csv2hash.png)](https://codeclimate.com/github/FinalCAD/csv2hash)
 
 [![Dependency Status](https://gemnasium.com/FinalCAD/csv2hash.png)](https://gemnasium.com/FinalCAD/csv2hash)
@@ -10,6 +12,43 @@
 
 It is a DSL to validate and map a CSV to a Ruby Hash.
 
+# Summary
+
+* [Csv2Hash](#csv2hash)
+* [Summary](#summary)
+  * [Installation](#installation)
+  * [Usage](#usage)
+    * [Invoke parser](#invoke-parser)
+    * [Parser options](#parser-options)
+  	* [Definition DSL](#definition-dsl)
+    * [Definition Rules](#definition-rules)
+    * [Default rules values](#default-rules-values)
+    * [define where your data are expected](#define-where-your-data-are-expected)
+  * [Samples](#samples)
+    * [[MAPPING] Validation of cells with defined precision](#mapping-validation-of-cells-with-defined-precision)
+    * [Auto discover position feature](#auto-discover-position-feature)
+    * [[COLLECTION] Validation of a collection (Regular CSV)](#collection-validation-of-a-collection-regular-csv)
+    * [Structure validation rules](#structure-validation-rules)
+    * [CSV Headers](#csv-headers)
+    * [Parser and configuration](#parser-and-configuration)
+    * [Response](#response)
+  * [Exception or Not !](#exception-or-not-)
+    * [On **BREAK_ON_FAILURE MODE**](#on-break_on_failure-mode)
+    * [On **CSV MODE**](#on-csv-mode)
+    * [Errors Format](#errors-format)
+      * [Sample](#sample)
+        * [Csv data](#csv-data)
+        * [Rule](#rule)
+        * [Error](#error)
+  * [Personal Validator Rule](#personal-validator-rule)
+* [Config file](#config-file)
+  * [YamlLoader](#yamlloader)
+* [Type conversion](#type-conversion)
+* [Changes](#changes)
+* [Upgrading](#upgrading)
+* [Yard doc](#yard-doc)
+* [Contributing](#contributing)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -28,7 +67,25 @@ Or install it yourself as:
 
 Parsing is based on rules, you should defined rule for each cells
 
-### DSL
+### Invoke parser
+
+```
+Csv2hash::Main.new(:<definition_name>, file_path_or_data, options).parse
+```
+
+```
+Csv2hash::Main.new(:<definition_name>, options) do
+  file_path_or_data
+end.parse
+```
+
+### Parser options
+
+List of options :
+
+* `ignore_blank_line: :boolean` # i think is pretty straightforward to understand
+
+### Definition DSL
 
 ```
 Csv2hash::Main.generate_definition :name do
@@ -43,7 +100,7 @@ end
 Csv2hash::Main[:name] # Access anywhere
 ```
 
-### Rules
+### Definition Rules
 
 You should declared a definition of your CSV file, and then define for each cell what you would expect.
 
@@ -85,7 +142,7 @@ It produces :
 value of answering is not supported, please use one of [yes, no]
 ```
 
-### Default values
+### Default rules values
 
 Only position is required:
 
@@ -101,7 +158,7 @@ All remaining keys are optionals:
 * allow_blank: false
 * extra_validator: nil
 
-## Define where your data is expected
+### Define where your data are expected
 
 **IMPORTANT!** Position means [Y, X], where Y is rows, X columns
 
@@ -109,24 +166,6 @@ A definition should be provided. There are 2 types of definitions:
 * search for data at a precise position in the table: `y,x`
 * or search for data in a column of rows, where all the rows are the same: `x` (column index)
 
-## Invoke
-
-```
-Csv2hash::Main.new(:<definition_name>, file_path_or_data, options).parse
-```
-
-```
-Csv2hash::Main.new(:<definition_name>, options) do
-  file_path_or_data
-end.parse
-```
-
-### Options
-
-List of options :
-
-* ignore_blank_line: :boolean # i think is pretty straightforward to understand
-
 ## Samples
 
 ### [MAPPING] Validation of cells with defined precision
@@ -171,7 +210,7 @@ class MyParser
 end
 ```
 
-### Auto discover position
+### Auto discover position feature
 
 This is a special feature for finding the Y index of row where you data start. For instance you have this following data :
 
@@ -376,9 +415,9 @@ errors is a Array of Hash
 { y: 1, x: 0, message: 'message', key: 'key', value: '' }
 ```
 
-## Sample
+#### Sample
 
-### Csv data
+##### Csv data
 
 ```
 | Fields      | Person Informations  |
@@ -386,13 +425,13 @@ errors is a Array of Hash
 | Nickname    |        nil           |
 ```
 
-### Rule
+##### Rule
 
 ```
 cell position: [1,1], key: 'nickname', allow_blank: false
 ```
 
-### Error
+##### Error
 
 ```
 { y: 1, x: 1, message: 'undefined nikcname on [0, 0]', key: 'nickname', value: nil }
@@ -516,6 +555,15 @@ rails generate csh2hash:install
 
 If you want add your specific conversion
 
+```
+Csv2hash.configure do |conf|
+  # conf.convert = false # default: false
+  # conf.true_values  = ['yes','y','t'] # default: ['yes','y','t']
+  # conf.false_values = ['no','n','f']  # default: ['no','n','f']
+  # conf.nil_values   = ['nil','null']  # default: ['nil','null']
+end
+```
+
 # Changes
 
 please refere to [CHANGELOG.md](https://github.com/FinalCAD/csv2hash/blob/master/CHANGELOG.md) doc

data/UPGRADE.md

@@ -1,5 +1,9 @@
 # Upgrading
 
+# Upgrading from 0.6.7 to 0.6.8
+
+nothing
+
 # Upgrading from 0.6.6 to 0.6.7
 
 nothing

data/lib/csv2hash/version.rb

@@ -1,3 +1,3 @@
 module Csv2hash
-  VERSION = '0.6.7'
+  VERSION = '0.6.8'
 end

data/lib/generators/csv2hash/install/install_generator.rb

@@ -1,10 +1,10 @@
 module Csv2hash
-  module Generator
+  module Generators
     class InstallGenerator < Rails::Generators::Base
       source_root File.expand_path('../templates', __FILE__)
 
       desc <<DESC
-description:
+description :
     copy csv2hash configuration to an initializer.
 DESC
       def create_configuration

data/spec/lib/generators/csv2hash/install_generator_spec.rb

@@ -0,0 +1,36 @@
+require 'rails/generators'
+require 'generator_spec'
+
+# Generators are not automatically loaded by Rails
+require_relative '../../../../lib/generators/csv2hash/install/install_generator'
+
+module Csv2hash
+  module Generators
+    describe InstallGenerator do
+      # Tell the generator where to put its output (what it thinks of as Rails.root)
+      destination File.expand_path('../../../../tmp', __FILE__)
+
+      before do
+        prepare_destination
+        run_generator
+      end
+
+      after do
+        FileUtils.rm_rf destination_root
+      end
+
+      specify do
+        expect(destination_root).to have_structure do
+          no_file 'csv2hash.rb'
+          directory 'config' do
+            directory 'initializers' do
+              file 'csv2hash.rb' do
+                contains 'Csv2hash.configure'
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: csv2hash
 version: !ruby/object:Gem::Version
-  version: 0.6.7
+  version: 0.6.8
 platform: ruby
 authors:
 - Joel AZEMAR
@@ -157,9 +157,9 @@ files:
 - spec/csv2hash/validator_spec.rb
 - spec/csv2hash/yaml_loader_spec.rb
 - spec/csv2hash_spec.rb
-- spec/generators/csv2hash/install_generator_spec.rb
 - spec/generators_helper.rb
 - spec/lib/extra_validators/downcase_validator.rb
+- spec/lib/generators/csv2hash/install_generator_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/joel/csv2hash
 licenses:
@@ -181,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: Mapping a CSV to a Ruby Hash
@@ -198,8 +198,8 @@ test_files:
 - spec/csv2hash/validator_spec.rb
 - spec/csv2hash/yaml_loader_spec.rb
 - spec/csv2hash_spec.rb
-- spec/generators/csv2hash/install_generator_spec.rb
 - spec/generators_helper.rb
 - spec/lib/extra_validators/downcase_validator.rb
+- spec/lib/generators/csv2hash/install_generator_spec.rb
 - spec/spec_helper.rb
 has_rdoc: 

data/spec/generators/csv2hash/install_generator_spec.rb

@@ -1,32 +0,0 @@
-# require 'generators_helper'
-#
-# # Generators are not automatically loaded by Rails
-# require 'generators/csv2hash/install_generator'
-#
-# describe Csv2hash::Generators::InstallGenerator do
-#   # Tell the generator where to put its output (what it thinks of as Rails.root)
-#   destination File.expand_path('../../../tmp', __FILE__)
-#   teardown :cleanup_destination_root
-#
-#   before {
-#     prepare_destination
-#   }
-#
-#   def cleanup_destination_root
-#     FileUtils.rm_rf destination_root
-#   end
-#
-#   describe '...' do
-#     before { run_generator }
-#
-#     describe 'config/initializers/csv2hash.rb' do
-#       subject { file('config/initializers/csv2hash.rb') }
-#       it { should exist }
-#       it { should contain "Csv2hash.configure do |config|"}
-#       # it { should contain "# conf.convert = false" }
-#       # it { should contain "# conf.true_values  = ['yes','y','t']" }
-#       # it { should contain "# conf.false_values = ['no','n','f']" }
-#       # it { should contain "# conf.nil_values   = ['nil','null']" }
-#     end
-#   end
-# end