csv2hash 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0f8f8219aff79abbf8d98c623d02d6e95929af47
+  data.tar.gz: 428d41f0b1a1c8490bb19aa78d0dbf4dbe61f487
+SHA512:
+  metadata.gz: 1b68da6acde6bace6121a0db5dfb4470827d6129f17f776a83157870c0f8f5977ad72bbead178782694d4ceeb0ae54d369a8152b2a6b11482bc4935e96c0db45
+  data.tar.gz: d492de227d7970cbbed83e984ae531d7fa4e5761a345320bbde6c58e93daa4aede871af4a5e7cb7bb0e27618c7d4286fe28b660eb5feb77410757a31c434c14c

data/.coveralls.yml

@@ -0,0 +1,2 @@
+service_name: travis-pro
+repo_token: N3Ql9kjuVUDMaof2gKqn1TiNXt4bYfRUw

data/.gitignore

@@ -0,0 +1,6 @@
+.ruby-gemset
+.ruby-version
+private.notes
+*.gem
+bundler/
+

data/.rspec

@@ -0,0 +1 @@
+--color --fail-fast

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,9 @@
+source 'http://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'coveralls', require: false
+end

data/Gemfile.lock

@@ -0,0 +1,79 @@
+PATH
+  remote: .
+  specs:
+    csv2hash (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    celluloid (0.15.2)
+      timers (~> 1.1.0)
+    coderay (1.1.0)
+    coveralls (0.7.0)
+      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)
+    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)
+      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)
+      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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  coveralls
+  csv2hash!
+  guard
+  guard-rspec
+  rake
+  rspec

data/Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec, cmd: 'rspec --color --fail-fast' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2013 Joël AZÉMAR https://github.com/joel, Joël AZÉMAR joel.azemar@gmail.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,73 @@
+# Csv2Hash
+
+[![Code Climate](https://codeclimate.com/github/joel/csv2hash.png)](https://codeclimate.com/github/joel/csv2hash)
+
+[![Dependency Status](https://gemnasium.com/joel/csv2hash.png)](https://gemnasium.com/joel/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)
+
+
+It's DSL for valided and map CSV to Ruby Hash
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'csv2hash'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install csv2hash
+
+## Usage
+
+You should be declare an definition for you CSV, for each cells you should define what you expect.
+
+Example :
+
+You want first cell parsed should be string with values are 'yes' or 'no' you must fill follow rule :
+
+	{ name: 'aswering', type: 'string', values: ['yes', 'no'], position: [0,0] }
+
+All keys as default value, so you can just define this rule :
+
+	{ name: 'aswering', values: ['yes', 'no'], position: [0,0] }
+
+You can define message, default is 'undefined :key on :position'
+
+	{ name: 'aswering', values: ['yes', 'no'], position: [0,0], message: 'this value is not supported' }
+
+if you insert key on you message they will be substituted
+
+	{ ..., message: 'value of :name is not supported, please you one of :values' }
+
+produce ':
+	value of aswering is not supported, please you one of [yes, no]'
+
+#### Default values
+
+* message:     'undefined :key on :position'
+* mappable:    true
+* type:        'string'
+* values:      nil
+* nested:      nil
+* allow_blank: false
+* position:    nil
+* maptype:     'cell'
+
+### Limitations
+
+
+## Contributing
+
+1. Fork it
+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

data/Rakefile

@@ -0,0 +1,29 @@
+begin
+  require 'bundler'
+  Bundler::GemHelper.install_tasks
+rescue Exception => e
+end
+
+require 'rake'
+require 'rspec'
+require 'rspec/core/rake_task'
+require 'csv2hash'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+RSpec::Core::RakeTask.new('spec:progress') do |spec|
+  spec.rspec_opts = %w(--format progress)
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = 'csv2hash #{csv2hash::VERSION}'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+task default: :spec

data/bin/load_rvm

@@ -0,0 +1 @@
+rvm use `cat .ruby-version`@`cat .ruby-gemset` --create

data/csv2hash.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |spec|
+
+  spec.name        = 'csv2hash'
+  spec.version     = '0.0.1'
+  spec.date        = '2013-11-26'
+  spec.summary     = %q{Mapping CSV to Ruby Hash}
+  spec.description = %q{DSL for CSV Ruby Hash mapping}
+  spec.authors     = ['Joel AZEMAR']
+  spec.email       = 'joel.azemar@gmail.com'
+  spec.files       = ['lib/csv2hash.rb']
+  spec.homepage    = 'https://github.com/joel/csv2hash'
+  spec.license     = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+
+  spec.required_ruby_version = '~> 2.0'
+end

data/lib/csv2hash/definition/mapping.rb

@@ -0,0 +1,7 @@
+class Definition::Mapping < Definition
+
+  def validate!
+    super
+  end
+
+end

data/lib/csv2hash/definition.rb

@@ -0,0 +1,44 @@
+class Definition
+
+  MAPPING = 'mapping'
+  COLLECTION = 'collection'
+
+  TYPES = [Definition::MAPPING, Definition::COLLECTION]
+
+  attr_accessor :type, :rules
+
+  def validate!
+    unless TYPES.include?(type)
+      raise "not suitable type, please use '#{Definition::MAPPING}' or '#{Definition::COLLECTION}'"
+    end
+    raise 'rules must be an Array of rules' unless rules.class == Array
+  end
+
+  def default!
+    rules.each do |rule|
+      default_position rule
+      rule.merge! message:     'undefined :key on :position' unless rule.has_key? :message
+      rule.merge! mappable:    true                          unless rule.has_key? :mappable
+      rule.merge! type:       'string'                       unless rule.has_key? :type
+      rule.merge! values:      nil                           unless rule.has_key? :values
+      rule.merge! nested:      nil                           unless rule.has_key? :nested
+      rule.merge! allow_blank: false                         unless rule.has_key? :allow_blank
+      rule.merge! position:    nil                           unless rule.has_key? :position
+      rule.merge! maptype:     'cell'                        unless rule.has_key? :maptype
+    end
+  end
+
+  private
+
+  def default_position rule
+    case type
+    when Definition::MAPPING
+      x, y = rule.fetch(:position, ['undefined', 'undefined'])
+      rule.merge! key: "key_#{x}_#{y}" unless rule.has_key? :key
+    when Definition::COLLECTION
+      y = rule.fetch :position
+      rule.merge! key: "key_#{y}" unless rule.has_key? :key
+    end
+  end
+
+end

data/lib/csv2hash/parser.rb

@@ -0,0 +1,24 @@
+module Parser
+
+  def fill!
+    @data = {}.tap do |data_computed|
+      data_computed[:data] ||= []
+      data_computed[:data] << {}.tap do |data_parsed|
+
+        definition.rules.each do |rule|
+          if rule.fetch :mappable
+            x, y = rule.fetch :position
+            if (nested = rule.fetch :nested)
+              data_parsed[nested] ||= {}
+              data_parsed[nested][rule.fetch(:key)] = data_source[x][y]
+            else
+              data_parsed[rule.fetch(:key)] = data_source[x][y]
+            end
+          end
+        end
+
+      end
+    end
+  end
+
+end

data/lib/csv2hash/validator.rb

@@ -0,0 +1,34 @@
+module Validator
+  
+  def validate_data!
+    definition.rules.each do |rule|
+      if (rule.fetch(:maptype) == 'cell')
+        x, y = rule.fetch :position
+        validate_rule x, y, rule
+      end
+    end
+  end
+
+  private
+
+  def validate_rule x, y, rule
+    begin
+      raise unless data_source[x]
+      unless rule.fetch :allow_blank
+        raise unless data_source[x][y]
+      end
+      if (values = rule.fetch :values)
+        raise unless values.include?(data_source[x][y])
+      end
+    rescue => e
+      raise message(rule)
+    end
+  end
+
+  def message rule
+    rule.fetch(:message).tap do |msg|
+      rule.each { |key, value| msg.gsub! ":#{key.to_s}", value.to_s }
+    end
+  end
+  
+end

data/lib/csv2hash/version.rb

@@ -0,0 +1,3 @@
+module Cvs2hash
+  VERSION = '0.0.1'
+end

data/lib/csv2hash.rb

@@ -0,0 +1,24 @@
+require 'csv2hash/version'
+require 'csv2hash/definition'
+require 'csv2hash/definition/mapping'
+require 'csv2hash/validator'
+require 'csv2hash/parser'
+
+class Csv2hash
+  include Validator
+  include Parser
+
+  attr_accessor :definition, :data_source, :data
+
+  def initialize definition, data_source
+    @definition, @data_source = definition, data_source
+  end
+
+  def parse
+    definition.validate!
+    definition.default!
+    validate_data!
+    fill!
+  end
+
+end

data/spec/csv2hash/definition_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe Definition do
+
+  context 'regular context' do
+    subject do
+      Definition.new.tap do |definition|
+        definition.type = Definition::MAPPING
+        definition.rules = begin
+          [
+            { position: [0,0], key: 'name' }
+          ]
+        end
+      end
+    end
+
+    it 'variable should be assigned' do
+      subject.type.should eql Definition::MAPPING
+      subject.rules.should eql [ { position: [0,0], key: 'name' } ]
+    end
+  end
+
+  describe '#validate!' do
+    context 'rules failling validation' do
+      subject do
+        Definition.new.tap do |definition|
+          definition.type = 'unsuitable_type'
+        end
+      end
+      it 'should throw exception' do
+        expect {
+          subject.validate!
+        }.to raise_error "not suitable type, please use '#{Definition::MAPPING}' or '#{Definition::COLLECTION}'"
+      end
+    end
+    context 'rules failling validation' do
+      subject do
+        Definition.new.tap do |definition|
+          definition.type = Definition::MAPPING
+          definition.rules = 'rules'
+        end
+      end
+      it 'should throw exception' do
+        expect { subject.validate! }.to raise_error 'rules must be an Array of rules'
+      end
+    end
+  end
+
+  describe '#default!' do
+    subject do
+      Definition.new.tap do |definition|
+        definition.type = Definition::MAPPING
+        definition.rules = begin
+          [
+            { position: [0,0], key: 'name' }
+          ]
+        end
+      end
+    end
+
+    before { subject.default! }
+
+    it 'missing key must be filled' do
+      subject.rules.should eql([{ position: [0, 0],
+        key: 'name',
+        message: 'undefined :key on :position',
+        mappable: true,
+        type: 'string',
+        values: nil,
+        nested: nil,
+        allow_blank: false,
+        maptype: 'cell' }])
+    end
+  end
+end
+
+
+
+

data/spec/csv2hash/parser_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Parser do
+
+  let(:definition) do
+    Definition.new.tap do |definition|
+      definition.type = Definition::MAPPING
+      definition.rules = [ { position: [0,0], key: 'name' } ]
+      definition.validate!
+      definition.default!
+    end
+  end
+
+  let(:data_source) { [ [ 'John Doe' ] ] }
+
+  subject { Csv2hash.new definition, data_source }
+
+  context 'regular way' do
+    it { expect { subject.parse }.to_not raise_error }
+    it {
+      subject.tap do |csv2hash|
+        csv2hash.parse
+      end.data.should eql({ data: [ { 'name' => 'John Doe' } ] })
+    }
+  end
+
+  context 'with nested' do
+    let(:data_source) { [ [ 'John Doe', 22 ] ] }
+    before do
+      definition.rules << { position: [0,1], key: 'age', nested: 'infos' }
+    end
+    it {
+      subject.tap { |c| c.parse }.data.should eql(
+        { data: [ { 'name' => 'John Doe', 'infos' => { 'age' => 22 } } ] }
+      )
+    }
+  end
+
+end

data/spec/csv2hash/validator_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe Validator do
+
+  let(:definition) do
+    Definition.new.tap do |definition|
+      definition.type = Definition::MAPPING
+      definition.rules = [ { position: [0,0], key: 'name' } ]
+      definition.validate!
+      definition.default!
+    end
+  end
+
+  subject do
+    Csv2hash.new definition, data_source
+  end
+
+  context 'with valid data' do
+    let(:data_source) { [ [ 'John Doe' ] ]}
+    it { expect { subject.validate_data! }.to_not raise_error }
+  end
+
+  context 'with invalid data' do
+    let(:data_source) { [ [ ] ]}
+    it { expect { subject.validate_data! }.to raise_error('undefined name on [0, 0]') }
+  end
+
+  describe '#message' do
+    subject { Csv2hash.new nil, nil }
+
+    context 'string value' do
+      let(:rule) { { foo: 'bar', message: ':foo are value of foo key' } }
+
+      it 'substitue value of key' do
+        subject.send(:message, rule).should eql 'bar are value of foo key'
+      end
+    end
+
+    context 'array value' do
+      let(:rule) { { foo: ['bar', 'zone'], message: ':foo are values of foo key' } }
+
+      it 'substitue value of key' do
+        subject.send(:message, rule).should eql '["bar", "zone"] are values of foo key'
+      end
+    end
+  end
+end

data/spec/csv2hash_spec.rb

@@ -0,0 +1,3 @@
+require 'spec_helper'
+
+describe Csv2hash

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'csv2hash'
+require 'bundler/setup'
+require 'coveralls'
+
+Coveralls.wear!
+
+RSpec.configure do |c|
+  c.run_all_when_everything_filtered = true
+end
+

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: csv2hash
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Joel AZEMAR
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: DSL for CSV Ruby Hash mapping
+email: joel.azemar@gmail.com
+executables:
+- load_rvm
+extensions: []
+extra_rdoc_files: []
+files:
+- .coveralls.yml
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/load_rvm
+- csv2hash.gemspec
+- lib/csv2hash.rb
+- lib/csv2hash/definition.rb
+- lib/csv2hash/definition/mapping.rb
+- lib/csv2hash/parser.rb
+- lib/csv2hash/validator.rb
+- lib/csv2hash/version.rb
+- spec/csv2hash/definition_spec.rb
+- spec/csv2hash/parser_spec.rb
+- spec/csv2hash/validator_spec.rb
+- spec/csv2hash_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/joel/csv2hash
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ~>
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Mapping CSV to Ruby Hash
+test_files:
+- spec/csv2hash/definition_spec.rb
+- spec/csv2hash/parser_spec.rb
+- spec/csv2hash/validator_spec.rb
+- spec/csv2hash_spec.rb
+- spec/spec_helper.rb