array_hasher 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a45f205da83f60a92f9437f226b17d374923bf2
-  data.tar.gz: 7ffc5736b6950a7043c82e6667fa188d1771f711
+  metadata.gz: a911e20523c7d6e32acd5b9b7966c42fac7a4162
+  data.tar.gz: 0d368a949b832854f4fcf251d352e6f74bd03985
 SHA512:
-  metadata.gz: ab368697c968a84ca599e0a8b1e1f646ecb2486dfdba7807b5049015e5dfa89e53bcd1c959ad3cb614f13c2232588159aeb18dfc12b743124e13dfe852d61cc7
-  data.tar.gz: f95939e348360dc4a3fdff59d6a3246651d369bdfc0f42b674e2771de7985642743f936d12c49628602a54faa4366f9d8dd6d3f2ed83d8a49e9673fd2332288e
+  metadata.gz: 6569caa11bc8414f3e37cca4fcbf28a6322de6c5da967a7ea6e45715213fe8aee9a45540c873e0cf4e0bed79729a88e7e2c5b73e8a901d3790cad009c9ffa710
+  data.tar.gz: 7fbb2f6f968265a22ea30ebe188fbd5237d19bb353248851352aa8eeb8bb5c73ef425584f8e3ebcaec60211d7155c43bd64eac5a6dc1952fbacff8441978b832

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    array_hasher (0.1.3)
+    array_hasher (0.1.4)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,8 +1,8 @@
-# ArrayHasher
+ArrayHasher
 
 [![Gem Version](https://badge.fury.io/rb/array_hasher.svg)](https://badge.fury.io/rb/array_hasher)
 
-[![Build Status](https://travis-ci.org/xiejiangzhi/arrah_hasher.svg?branch=master)](https://travis-ci.org/xiejiangzhi/arrah_hasher)
+[![Build Status](https://travis-ci.org/xiejiangzhi/array_hasher.svg?branch=master)](https://travis-ci.org/xiejiangzhi/array_hasher)
 
 Format Array data to a hash with your definition. it also can parse the CSV file with definition of title.
 
@@ -27,32 +27,49 @@ Or install it yourself as:
 
 ### Format array
 
+New a formatter
+
 ```
 require 'array_hasher'
 
 f = ArrayHasher.new_formatter([
-  [:a, :int], [:b, :float], [:c, proc {|v| v.split(',') }], [:d, nil, range: 3..-1]
+  # [hash_key, data_type]
+  [:a, :int],
+  [:b, :float],
+  [:c, proc {|v| v.split(',') }],
+  [:d, nil, range: 3..-1]
 ])
+```
+
+Array to hash by formatter
+
+```
 f.parse(['number: 123', '$ 123.1', 'a,b,c', 'd1', 'd2', 'd3'])
 # => {a: 123, b: 123.1, c: ['a', 'b', 'c'], d: ['d1', 'd2', 'd3']}
+```
+
+Define your data type
 
+```
 f.define_type(:my_arr) {|v| v.split(',').map(&:to_i) }
 f.cols[2] = [:c, :my_arr]
 f.parse(['number: 123', '$ 123.1', '1,2,3', 'd1', 'd2', 'd3'])
 # => {a: 123, b: 123.1, c: [1, 2, 3], d: ['d1', 'd2', 'd3']}
 ```
 
-### Parse format from a array of string
+### Format CSV
 
-```
-format = ArrayHasher.parse_formatter(['name:string', 'price:float', 'attrs:arr:{range: 2..-1}'])
-# => [[:name, :string], [:price, :float], [:attrs, :arr, range: 2..-1]]
-ArrayHasher.new_formatter(format)
-```
+For a CSV file, add a defination to csv first line, `hash_key:data_type:options`
+If a column's `hash_key` is empty, we will ignore this column
+If a column's `data_type` is empty, :string will be use.
+`options` is a JSON of hash, it is optional.
 
-### Format CSV
+For examples
 
-CSV file
+* `name`: equal to `name:string`
+* ` `, `:`, `:string`: this column will be ignore
+* `tags::{"range": [2,3]}`: we'll put `line[2...(2+3)]` to the `tags` key
+* `name:undefined_type`: if you give a undefined type, and you didn't define it in your code, its type is `string`
 
 ```
 name:bookname,price:float,"tags::{""range"": [2, 3]}",,
@@ -62,7 +79,11 @@ My book,USD 4.3,C,123,
 Your book,1.2,Hehe,Haha,666
 ```
 
+Define our data type and parser 
+
 ```
+# `bookname` type was used in that CSV file
+# We can define this type, it will tell parser how to parse data of bookname
 ext_types = {bookname: proc {|v| "<#{v}>" }}
 ArrayHasher.csv_each('path/to/test.csv', ext_types) do |line|
   puts line
@@ -72,7 +93,25 @@ end
 # {:name=>"<World>", :price=>3.2, :tags=>["B", "C", "What’s this?"]}
 # {:name=>"<My book>", :price=>4.3, :tags=>["C", "123", nil]}
 # {:name=>"<Your book>", :price=>1.2, :tags=>["Hehe", "Haha", "666"]}
+
+ArrayHasher.csv_each('path/to/test.csv', ext_types) # <Enumerator: xxx>
+```
+
+### Put multiple columns to one key.
+
 ```
+# We can append a `range` option as third arguments
+# `range` also can be used in CSV title
+format = ArrayHasher.parse_formatter([
+  'name:string',
+  'price:float',
+  'attrs:arr:{"range": [2, 100]}'
+])
+# => [[:name, :string], [:price, :float], [:attrs, :arr, range: 2..-1]]
+
+ArrayHasher.new_formatter(format)
+```
+
 
 ### Examples
   
@@ -84,7 +123,7 @@ See [Here](./examples)
 * `float` # convert string to float
 * `string`: # to_s
 * `time` # Time.parse(string)
-* `Proc` # format the value with your proc
+* `Proc` # format the value with your proc. we can define a Proc in our code only.
 
 
 ## Development

data/examples/csv.rb

@@ -1,9 +1,14 @@
 require 'bundler/setup'
 require 'array_hasher'
 
+puts "Undefined data type 'bookname'"
+ArrayHasher.csv_each(File.expand_path('../test.csv', __FILE__)) do |line|
+  puts line
+end
+
+puts "\nDefined 'bookname' wrap with <>"
 ext_types = {bookname: proc {|v| "<#{v}>" }}
 ArrayHasher.csv_each(File.expand_path('../test.csv', __FILE__), ext_types) do |line|
   puts line
 end
 
-

data/lib/array_hasher.rb

@@ -27,7 +27,11 @@ module ArrayHasher
       csv = CSV.open(path)
       formatter = new_formatter(parse_format(csv.gets))
       formatter.types.merge!(ext_types)
-      csv.each { |line| block.call(formatter.parse(line)) }
+      if block
+        csv.each { |line| block.call(formatter.parse(line)) }
+      else
+        Enumerator.new { |y| csv.each { |line| y << formatter.parse(line) } }
+      end
     end
   end
 end

data/lib/array_hasher/version.rb

@@ -1,3 +1,3 @@
 module ArrayHasher
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: array_hasher
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - jiangzhi.xie
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-20 00:00:00.000000000 Z
+date: 2018-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler