honey_format 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0c2df26f96e590dfd9c65b15c99b9cb17227c02b434e09acd5afc0477b4e5ba
-  data.tar.gz: 59acd72d13e5474e22b47f35beb6961de6a38c7104b1a6f73bfb85f99d301a75
+  metadata.gz: a39f797b080a1d5ff641f7f477cdfe2d181cf599e0ab3e05a3e1d69e21ebb94b
+  data.tar.gz: 2701ce31bf31e19229d11d6ff6f817de24c9d24165d27904c30cd8bc7f6b9752
 SHA512:
-  metadata.gz: 549b7fd83a6d787d0d5aef97fbec94a33fb6fbca040e2523d7a30724c2e56b81669f71d8464eac6ab428ef4552e4ca4bb614b4d2046aa0bd6d2d527b3a1a17b1
-  data.tar.gz: 6889ec68257b31887b4e804766c281b0547f93d8feb8720214670d79cf2636f40920633181ce7597d66e7ae381bac34dc32e1f449bccac19be73eab24c29b539
+  metadata.gz: cedc41b03b37daa7199cd11d6f2b4fd72599ae31adac8c7379c3dd396f364215cf5eff2376d09c975482ae44491aa74d7042e3c90b4bfb36ddc156a51b32c372
+  data.tar.gz: 45ec386f47253fd4a1e5c6e86cd99f7e381abe93be65fb4fc766fb2b3fdc29f84c4037209af68cf75ad1fbc10621d539b04976bc8e579eac9398fc8251755b2e

data/README.md

@@ -43,31 +43,35 @@ csv = HoneyFormat::CSV.new(csv_string)
 csv.header # => ["Id", "Username"]
 csv.column # => [:id, :username]
 
-include HoneyFormat
-# If included you can use the HoneyCSV shorthand
-csv = HoneyCSV.new(csv_string)
 rows = csv.rows # => [#<struct id="1", username="buren">]
 user = rows.first
 user.id         # => "1"
 user.username   # => "buren"
 ```
 
+```ruby
+csv_string = "Id, Username\n 1, buren"
+uppercase_strings = ->(o) { o.is_a?(String) ? o.upcase : o  }
+csv = HoneyFormat::CSV.new(csv_string, row_builder: uppercase_strings)
+csv.rows # => [#<struct id="1", username="BUREN">]
+```
+
 Validate CSV header
 ```ruby
 csv_string = "Id, Username\n 1, buren"
 # Invalid
-HoneyCSV.new(csv_string, valid_columns: [:something, :username])
+HoneyFormat::CSV.new(csv_string, valid_columns: [:something, :username])
 # => #<HoneyFormat::MissingCSVHeaderColumnError: key :id ("Id") not in [:something, :username]>
 
 # Valid
-csv = HoneyCSV.new(csv_string, valid_columns: [:id, :username])
+csv = HoneyFormat::CSV.new(csv_string, valid_columns: [:id, :username])
 csv.rows.first.username # => "buren"
 ```
 
 Define header
 ```ruby
 csv_string = "1, buren"
-csv = HoneyCSV.new(csv_string, header: ['Id', 'Username'])
+csv = HoneyFormat::CSV.new(csv_string, header: ['Id', 'Username'])
 csv.rows.first.username # => "buren"
 ```
 
@@ -75,13 +79,13 @@ If your header contains special chars and/or chars that can't be part of Ruby me
 things get a little awkward..
 ```ruby
 csv_string = "ÅÄÖ\nSwedish characters"
-user = HoneyCSV.new(csv_string).rows.first
+user = HoneyFormat::CSV.new(csv_string).rows.first
 # Note that these chars aren't "downcased",
 # "ÅÄÖ".downcase # => "ÅÄÖ"
 user.ÅÄÖ # => "Swedish characters"
 
 csv_string = "First-Name\nJacob"
-user = HoneyCSV.new(csv_string).rows.first
+user = HoneyFormat::CSV.new(csv_string).rows.first
 user.public_send(:"first-name") # => "Jacob"
 ```
 

data/lib/honey_format/csv.rb

@@ -11,13 +11,15 @@ module HoneyFormat
     # @param [String] csv string.
     # @param [Array] valid_columns valid array of symbols representing valid columns.
     # @param [Array] header optional argument for CSV header
+    # @param [#call] row_builder will be called for each parsed row
     # @raise [MissingCSVHeaderError] raised when header is missing (empty or nil).
     # @raise [MissingCSVHeaderColumnError] raised when header column is missing.
     # @raise [UnknownCSVHeaderColumnError] raised when column is not in valid list.
-    def initialize(csv, delimiter: ',', header: nil, valid_columns: :all, header_converter: ConvertHeaderValue)
+    def initialize(csv, delimiter: ',', header: nil, valid_columns: :all, header_converter: ConvertHeaderValue, row_builder: nil)
       csv = ::CSV.parse(csv, col_sep: delimiter)
       @csv_body = csv
       @header = Header.new(header || csv.shift, valid: valid_columns, converter: header_converter)
+      @row_builder = row_builder
     end
 
     # @return [Array] of strings for sanitized header.
@@ -33,7 +35,7 @@ module HoneyFormat
     # @return [Array] of rows.
     # @raise [InvalidRowLengthError] raised when there are more row elements longer than columns
     def rows
-      @rows ||= Rows.new(@csv_body, columns).to_a
+      @rows ||= Rows.new(@csv_body, columns, builder: @row_builder).to_a
     end
 
     # @yield [row] block to receive the row.

data/lib/honey_format/row.rb

@@ -7,10 +7,11 @@ module HoneyFormat
     # @raise [EmptyColumnsError] raised when there are no columns.
     # @example Create new row
     #     Row.new!([:id])
-    def initialize(columns)
+    def initialize(columns, builder: nil)
       validate_columns!(columns)
       @klass = Struct.new(*columns)
       @columns = columns
+      @builder = builder
     end
 
     # Returns a Struct.
@@ -21,7 +22,7 @@ module HoneyFormat
     #     r = Row.new!([:id])
     #     r.build(['1']).id #=> '1'
     def build(row)
-      @klass.new(*row)
+      @klass.new(*row).tap { |o| @builder && @builder.call(o) }
     rescue ArgumentError, 'struct size differs'
       fail_for_struct_size_diff!(row)
     end

data/lib/honey_format/rows.rb

@@ -7,8 +7,8 @@ module HoneyFormat
     # @return [Rows] new instance of Rows.
     # @param [Array] rows the array of rows.
     # @param [Array] columns the array of column symbols.
-    def initialize(rows, columns)
-      @rows = prepare_rows(Row.new(columns), rows)
+    def initialize(rows, columns, builder: nil)
+      @rows = prepare_rows(Row.new(columns, builder: builder), rows)
     end
 
     # Returns rows as array.
@@ -22,9 +22,9 @@ module HoneyFormat
     def prepare_rows(builder, rows)
       built_rows = []
       rows.each do |row|
-        unless row.first.nil? # The Ruby CSV library returns empty lines as [nil], ignore them..
-          built_rows << builder.build(Sanitize.array!(row))
-        end
+        # ignore empty rows - the Ruby CSV library can return empty lines as [nil]
+        next if row.empty? || row.nil? || row == [nil]
+        built_rows << builder.build(Sanitize.array!(row))
       end
       built_rows
     end

data/lib/honey_format/version.rb

@@ -1,4 +1,4 @@
 module HoneyFormat
   # Gem version
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honey_format
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Jacob Burenstam
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-27 00:00:00.000000000 Z
+date: 2018-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler