csv2hash 0.6.2 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0cff06b049e0b90d0627bced7665e5212667a128
-  data.tar.gz: 6aaf21e5a862915914813ee0d65495b04f041fc1
+  metadata.gz: 763bd19e8a4c55292deba925bca3266d50ce44af
+  data.tar.gz: e0fe38ce2de6f34abaf8b7f3fb8ce51b54e73a60
 SHA512:
-  metadata.gz: 1951755e2eda195942d6abaacaff5b2bf859a3e46e5f36160640dc3035ff1f9e81e903f991fb81e8b8cc29b3d4046766183b8f983fe244e774b05e1381c8d934
-  data.tar.gz: f7ab7b90d43cbec0a3379ec8461b9a41f45c3152d90c3e8106bd01275a53d98ed81b68cdf0bd3581ada17e97d4c75febf98491aebeb23fbaf5036ad766023772
+  metadata.gz: 59071b838f3d2409999aa0b606312f2bdbacf9f4f4dd347698978fdd9e3f80a8f10be3ce0d1bd228e628df92bf90ee3cf58ef2df7b2ba5c0fb5216f85b5c4ff0
+  data.tar.gz: cbcb3eb38554c9c4299eaef053ef0b53e3734adbf75ba8d1506e4d75ff6fbebc59d995d3ea608922ce9ee4a500dfa7b9ef98e2d79099b3ecda6f0528b89ef41c

data/.gitignore

@@ -3,8 +3,5 @@
 private.notes
 *.gem
 bundler/
-
-
-coverage/.last_run.json
-
-coverage/.resultset.json
+doc/
+coverage/

data/.yardoc/checksums

@@ -0,0 +1,25 @@
+lib/csv2hash.rb c17e63884b6cd284a96802d3ac15cb7d6246868b
+lib/csv2hash/cell.rb 71edefa202ba574ddfffb1b202f25e2a3d23f56a
+lib/csv2hash/parser.rb c9718cc9fc80ae36b3f360b064f0dbff1d16f0a3
+lib/csv2hash/version.rb ba10692f082f4c0a90e5a89db1ba60993d9fdf8c
+lib/csv2hash/discover.rb 21d7f1e795c954fadfee4394471af2c75acd1e5c
+lib/csv2hash/notifier.rb 2614b982ed1383e083f3d1ef86d02cd46ea7d507
+lib/csv2hash/registry.rb 1c17677d3721f927bb6884ef3cbf1ab11d12384c
+lib/csv2hash/csv_array.rb d44c8702ba6b24c557804f1607de552a9e447ab1
+lib/csv2hash/validator.rb 6f68b643f84f9391e05d8db6f8d310d606a5bc9d
+lib/csv2hash/definition.rb a2dd447310f8b0400ddb612c662e92d0ad005560
+lib/csv2hash/expectation.rb c2f1247ea999c76fb1e62887451b5deba8c072f9
+lib/csv2hash/data_wrapper.rb 5ebee4e51e99b870c7f39f0082ced26127e8c7db
+lib/csv2hash/adapters/base.rb bfb6ac778a0cc1530f797f7c98b1df3074af4936
+lib/csv2hash/parser/mapping.rb 1c15e5212ccc276b68cfbd372c703e3689316922
+lib/csv2hash/extra_validator.rb 2de7155cd880f1229eb4ede2d5ffdf241e89fd51
+lib/csv2hash/parser/collection.rb 1752470202bb3787b447ff0dd5409ade0265d1c1
+lib/csv2hash/adapters/abstract.rb d4d51b22334c7fea27e8e708f8686b680ea8acac
+lib/csv2hash/validator/mapping.rb 22e880c814d8e5d3185af00bc0d66c6f651879b7
+lib/csv2hash/structure_validator.rb 8b1f27a2cbe9cdb0f9a8d6e5f40d6ebc8467f919
+lib/csv2hash/adapters/csv_adapter.rb 6a83d23e366a5210558adf665d8fa997bcf087fa
+lib/csv2hash/validator/collection.rb 309bc2ad5a2e687159a1f4854d99efe3ef2903fe
+lib/csv2hash/adapters/memory_adapter.rb 04db65527e1ba8f50a6237c1de6f682124ae1cee
+lib/csv2hash/structure_validator/max_columns.rb 64e7804a43253eb31c44a5f3ecf52c23ac7bdfc2
+lib/csv2hash/structure_validator/min_columns.rb f56c22be1b946e1e2fa8a6108495c6aa126dcb2f
+lib/csv2hash/structure_validator/deprecation.rb c19df994b3defcd795a5f3eb638525bc60f47ad0

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+### VERSION 0.6.3
+
+* refactoring
+  * The Main constructor can be take in first arg a definition itself or simply the path of yaml file definition or just symbol of name of definition (when it have already loaded)
+
+* feature
+  * add yml loader
+
 ### VERSION 0.6.2
 
 * feature

data/Gemfile

@@ -6,3 +6,9 @@ group :test do
   gem 'coveralls', require: false
   gem 'pry'
 end
+
+group :doc do
+  gem 'yard-tomdoc'
+  gem 'yard'
+  gem 'inch', require: false # https://github.com/rrrene/inch
+end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    csv2hash (0.6.2)
+    csv2hash (0.6.3)
       activesupport (~> 4.1)
 
 GEM
@@ -23,6 +23,11 @@ GEM
     diff-lcs (1.2.5)
     docile (1.1.5)
     i18n (0.6.11)
+    inch (0.4.10)
+      pry
+      sparkr (>= 0.2.0)
+      term-ansicolor
+      yard (~> 0.8.7)
     its (0.2.0)
       rspec-core
     json (1.8.1)
@@ -57,13 +62,19 @@ GEM
       simplecov-html (~> 0.8.0)
     simplecov-html (0.8.0)
     slop (3.6.0)
+    sparkr (0.4.1)
     term-ansicolor (1.3.0)
       tins (~> 1.0)
     thor (0.19.1)
     thread_safe (0.3.4)
     tins (1.3.2)
+    tomparse (0.4.2)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
+    yard (0.8.7.4)
+    yard-tomdoc (0.7.1)
+      tomparse (>= 0.4.0)
+      yard
 
 PLATFORMS
   ruby
@@ -72,7 +83,10 @@ DEPENDENCIES
   bundler (~> 1.6)
   coveralls
   csv2hash!
+  inch
   its (~> 0.2)
   pry
   rake (~> 10.3)
   rspec (~> 3.0)
+  yard
+  yard-tomdoc

data/README.md

@@ -34,7 +34,7 @@ Parsing is based on rules, you should defined rule for each cells
   Csv2hash::Main.generate_definition :name do
     set_type { Definition::MAPPING }
     set_header_size { 2 } # 0 by default
-    set_structure_rules {{ 'MaxColumns' => 2 }}
+    set_structure_rules {{ max_columns: 2 }}
     mapping do
       cell position: [0,0], key: 'gender'
       cell position: [1,0], key: 'name'
@@ -115,11 +115,13 @@ A definition should be provided. There are 2 types of definitions:
 
 Consider the following CSV:
 
+```
 | Fields      | Person Informations  | Optional |
 |-------------|----------------------|----------|
 | Nickname    |        jo            |    no    |
 | First Name  |        John          |    yes   |
 | Last Name   |        Doe           |    yes   |
+```
 
 Precise position validation sample:
 
@@ -133,7 +135,7 @@ Precise position validation sample:
 		end
 
 		def data
-			@data_wrapper ||= Csv2hash::Main.new(Csv2hash::Main[:<definition_name>], file_path_or_data).parse
+			@data_wrapper ||= Csv2hash::Main.new(:<definition_name>, file_path_or_data).parse
 		end
 
 		private
@@ -157,6 +159,7 @@ Precise position validation sample:
 
 This is a special feature for finding the Y index of row where you data start. For instance you have this following data :
 
+```
 |---------------|---------------|------|-----|
 | Nickname      | jo            |      |     |
 | First Name    | John          |      |     |
@@ -168,6 +171,7 @@ This is a special feature for finding the Y index of row where you data start. F
 |               | Personal info | Age  | 26  |
 |               | Sex           | Male |     |
 |               |               |      |     |
+```
 
 You want extract `Employment` information and `Personal info` but we do not know if extra information will not come and break our index. This feature can be useful is this case.
 
@@ -187,10 +191,12 @@ became
 
 Consider the following CSV:
 
+```
 | Nickname | First Name | Last Name |
 |----------|------------|-----------|
 |   jo     |    John    |    Doe    |
 |   ja     |    Jane    |    Doe    |
+```
 
 Collection validation sample:
 
@@ -204,7 +210,7 @@ Collection validation sample:
 		end
 
 		def data
-			@data_wrapper ||= Csv2hash::Main.new(Csv2hash::Main[:<definition_name>], file_path_or_data).parse
+			@data_wrapper ||= Csv2hash::Main.new(:<definition_name>, file_path_or_data).parse
 		end
 
 		private
@@ -244,7 +250,7 @@ Current validations are: :min_columns, :max_columns
   	end
 
   	def data
-  		@data_wrapper ||= Csv2hash::Main.new(Csv2hash::Main[:<definition_name>], file_path_or_data).parse
+  		@data_wrapper ||= Csv2hash::Main.new(:<definition_name>, file_path_or_data).parse
   	end
 
   	private
@@ -361,9 +367,11 @@ errors is a Array of Hash
 
 ### Csv data
 
+```
 | Fields      | Person Informations  |
 |-------------|----------------------|
 | Nickname    |        nil           |
+```
 
 ### Rule
 
@@ -404,6 +412,20 @@ Csv data
 	[ [ 'Foo' ] ]
 ```
 
+# Config file
+
+You can defined rules into a yaml file
+
+```
+name: 'example'
+mapping: 'mapping'
+header_size: 2
+structure_rules: { max_columns: 20 }
+rules:
+  - { position: [1,1], key: 'first_name' }
+  - { position: [2,1], key: 'first_name' }
+```
+
 # Changes
 
 please refere to [CHANGELOG.md](https://github.com/FinalCAD/csv2hash/blob/master/CHANGELOG.md) doc
@@ -412,6 +434,12 @@ please refere to [CHANGELOG.md](https://github.com/FinalCAD/csv2hash/blob/master
 
 please refere to [UPGRADE.md](https://github.com/FinalCAD/csv2hash/blob/master/UPGRADE.md) doc
 
+# Yard doc
+
+```
+bundle exec yard --plugin tomdoc
+```
+
 ## Contributing
 
 1. Fork it

data/UPGRADE.md

@@ -1,5 +1,7 @@
 # Upgrading
 
+# Upgrading from 0.6.2 to 0.6.3
+
 # Upgrading from 0.6.1 to 0.6.2
 
 nothing

data/bin/generate_doc

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+bundle exec yard --plugin tomdoc && open doc/index.html

data/config/example.csv

@@ -0,0 +1,10 @@
+Nickname,jo,,,
+FirstName,John,,,
+LastName,Doe,,,
+,,,,
+Employment,CEO,,,
+Post,Doe,,,
+,,,,
+,Personal info,Age,26,
+,Sex,Mal,,
+,,,,

data/config/rules.yml

@@ -0,0 +1,7 @@
+name: 'example'
+mapping: 'mapping'
+header_size: 2
+structure_rules: { max_columns: 20 }
+rules:
+  - { position: [1,1], key: 'first_name' }
+  - { position: [2,1], key: 'first_name' }

data/doc/Cell.html

@@ -0,0 +1,282 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Class: Cell
+  
+    &mdash; Documentation by YARD 0.8.7.4
+  
+</title>
+
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '';
+  framesUrl = "frames.html#!Cell.html";
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+  
+    <a href="_index.html">Index (C)</a> &raquo;
+    
+    
+    <span class="title">Cell</span>
+  
+
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+      <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+      Class List
+    </a>
+  
+    <a class="full_list_link" id="method_list_link"
+        href="method_list.html">
+      Method List
+    </a>
+  
+    <a class="full_list_link" id="file_list_link"
+        href="file_list.html">
+      File List
+    </a>
+  
+</div>
+      <div class="clear"></div>
+    </div>
+
+    <iframe id="search_frame"></iframe>
+
+    <div id="content"><h1>Class: Cell
+  
+  
+  
+</h1>
+
+<dl class="box">
+  
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName">Object</span>
+      
+        <ul class="fullTree">
+          <li>Object</li>
+          
+            <li class="next">Cell</li>
+          
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      
+      </dd>
+    
+  
+  
+    
+  
+    
+  
+  
+  
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/csv2hash/cell.rb</dd>
+  
+</dl>
+<div class="clear"></div>
+
+
+
+
+
+  <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
+  <ul class="summary">
+    
+      <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#rules-instance_method" title="#rules (instance method)">- (Object) <strong>rules</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+    
+    
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the value of attribute rules.</p>
+</div></span>
+  
+</li>
+
+    
+  </ul>
+
+
+
+
+  
+    <h2>
+      Instance Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#initialize-instance_method" title="#initialize (instance method)">- (Cell) <strong>initialize</strong>(*args) </a>
+    
+
+    
+  </span>
+  
+  
+    <span class="note title constructor">constructor</span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>A new instance of Cell.</p>
+</div></span>
+  
+</li>
+
+      
+    </ul>
+  
+
+<div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+  
+    <div class="method_details first">
+  <h3 class="signature first" id="initialize-instance_method">
+  
+    - (<tt><span class='object_link'><a href="" title="Cell (class)">Cell</a></span></tt>) <strong>initialize</strong>(*args) 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Returns a new instance of Cell</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+7
+8
+9</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/csv2hash/cell.rb', line 7</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span>
+  <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_rules'>rules</span> <span class='op'>=</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_extract_options!'>extract_options!</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  
+</div>
+
+  <div id="instance_attr_details" class="attr_details">
+    <h2>Instance Attribute Details</h2>
+    
+      
+      <span id="rules=-instance_method"></span>
+      <div class="method_details first">
+  <h3 class="signature first" id="rules-instance_method">
+  
+    - (<tt>Object</tt>) <strong>rules</strong> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Returns the value of attribute rules</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+5
+6
+7</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/csv2hash/cell.rb', line 5</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_rules'>rules</span>
+  <span class='ivar'>@rules</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+
+</div>
+
+    <div id="footer">
+  Generated on Fri Aug 29 17:12:26 2014 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.4 (ruby-2.1.2).
+</div>
+
+  </body>
+</html>