honey_format 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f11a451917cde22eb1749f01e42e12d4bfc3314f0dd42692f27100c452557ab
-  data.tar.gz: 4ad3a5e3be4a82e26fb3715c50011b5f7cc26069ac74058763cc4d097d1f7f0d
+  metadata.gz: 6ec17df72ebcb22be2365a454c19632f6ee22becc155a525bf66a010f7eec4b2
+  data.tar.gz: b05efbc59d1af2da443fd4c3e72cf573d9fd43b292b644336299411e705a77e3
 SHA512:
-  metadata.gz: 63090f5e515480669c3dc2a74882e4fc4aba303eb7f2f0e71fbeb67a7f9ccf9f5b0cf592a07af8890e79da2f682ce9f6622be672a141219e1471d559f1ac9223
-  data.tar.gz: 9439ebcfc40892fb57ac3cdca5f74f6c2ac58e0972b5200a6678194376c5063b4cc1083fde94f68c42c302fd720124c6ff3878cbd6b5d5546e92d38c0d4fcc87
+  metadata.gz: b802e64d2033b5ea9881b30142e88f9d326e7d89416deadd7aa3c2f49c6da3f5b7a03fda057a802a9cebff28c72d5c75cfe48e9fa3a93e68ac808beb480b3d42
+  data.tar.gz: 71682b5a17dae461bbdabece49219e76be07241494b3606849ec5e7198bcf9e6f8e470a0e5a857ff879d5cc48ea796214a93d3ac0793cffb3feb29842e15486e

data/.gitignore

@@ -8,4 +8,5 @@
 /spec/reports/
 /tmp/
 benchmark.csv
+benchmark*.csv
 .byebug_history

data/.travis.yml

@@ -3,4 +3,5 @@ rvm:
   - 2.3.0
   - 2.4.0
   - 2.5.0
+  - 2.6.0-preview1
 before_install: gem install bundler -v 1.16.1

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# v0.6.0
+
+* Add `CSV#to_csv` ([PR#2](https://github.com/buren/honey_format/pull/2))
+* `csv#rows` returns an instance of `Rows` instead of `Array`
+
+# v0.3.0 - v0.5.0
+
+* Add CSV `row_builder` option
+* ...
+
 # v0.2.0
 
 * More explicit exception classes

data/README.md

@@ -49,13 +49,22 @@ user.id         # => "1"
 user.username   # => "buren"
 ```
 
+Custom row builder
 ```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)
+upcase_builder = ->(o) { o.is_a?(String) ? o.upcase : o  }
+csv = HoneyFormat::CSV.new(csv_string, row_builder: upcase_builder)
 csv.rows # => [#<struct id="1", username="BUREN">]
 ```
 
+Output CSV
+```ruby
+csv_string = "Id, Username\n 1, buren"
+csv = HoneyFormat::CSV.new(csv_string)
+csv.rows.each { |row| row.id = nil }
+csv.to_csv # => "Id, Username\n,buren\n"
+```
+
 Validate CSV header
 ```ruby
 csv_string = "Id, Username\n 1, buren"
@@ -95,33 +104,25 @@ If you want to see more usage examples check out the `spec/` directory.
 
 _Note_: This gem, adds some overhead to parsing a CSV string. I've included some benchmarks below, your mileage may vary..
 
-Benchmarks, using the `benchmark-ips` gem, CSV with 11 columns in MBP 2013 OSX 10.10.
-
-124KB (~1000 lines )
+You can run the benchmarks yourself:
 
 ```
-Calculating -------------------------------------
-          stdlib CSV     6.000  i/100ms
-    HoneyFormat::CSV     5.000  i/100ms
--------------------------------------------------
-          stdlib CSV     64.236  (± 4.7%) i/s -    642.000
-    HoneyFormat::CSV     52.762  (± 5.7%) i/s -    530.000
-
-Comparison:
-          stdlib CSV:       64.2 i/s
-    HoneyFormat::CSV:       52.8 i/s - 1.22x slower
+$ bin/benchmark file.csv
 ```
 
-20MB (~180k lines)
+204KB (1k lines)
 
 ```
-Comparison:
-          stdlib CSV:        0.3 i/s
-    HoneyFormat::CSV:        0.3 i/s - 1.26x slower
+      stdlib CSV:   48.9 i/s
+HoneyFormat::CSV:   34.5 i/s - 1.41x  slower
 ```
 
-See `bin/benchmark` for details.
-Run benchmark: `bin/benchmark`.
+19MB (100k lines)
+
+```
+      stdlib CSV:   0.4 i/s
+HoneyFormat::CSV:   0.3 i/s - 1.41x  slower
+```
 
 ## Development
 

data/bin/benchmark

@@ -5,12 +5,12 @@ require 'honey_format'
 require 'benchmark/ips'
 require 'csv'
 
-# Assumes that you have a file "benchmark.csv" in your current directory
-csv = File.read('benchmark-20mb.csv')
+path = ARGV.first || fail(ArgumentError, '<path_to_csv> argument must be provided')
+csv = File.read(path)
 
 Benchmark.ips do |x|
-  x.time = 10
-  x.warmup = 2
+  x.time = 30
+  x.warmup = 5
 
   x.report('stdlib CSV')       { CSV.parse(csv) }
   x.report('HoneyFormat::CSV') { HoneyFormat::CSV.new(csv).rows }

data/honey_format.gemspec

@@ -23,4 +23,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'benchmark-ips'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'byebug'
 end

data/lib/honey_format/convert_header_value.rb

@@ -1,5 +1,7 @@
 module HoneyFormat
+  # Header column converter
   module ConvertHeaderValue
+    # Replace map
     REPLACE_MAP = [
       [/ \(/, '('],
       [/ \[/, '['],

data/lib/honey_format/csv.rb

@@ -17,9 +17,9 @@ module HoneyFormat
     # @raise [UnknownCSVHeaderColumnError] raised when column is not in valid list.
     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
+      header_row = header || csv.shift
+      @header = Header.new(header_row, valid: valid_columns, converter: header_converter)
+      @rows = Rows.new(csv, columns, builder: row_builder)
     end
 
     # @return [Array] of strings for sanitized header.
@@ -35,12 +35,17 @@ 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, builder: @row_builder).to_a
+      @rows
     end
 
     # @yield [row] block to receive the row.
     def each_row
       rows.each { |row| yield(row) }
     end
+
+    # @return [String] CSV-string representation.
+    def to_csv
+      header.to_csv + @rows.to_csv
+    end
   end
 end

data/lib/honey_format/header.rb

@@ -23,5 +23,10 @@ module HoneyFormat
     def columns
       @columns.to_a
     end
+
+    # @return [String] CSV-string representation.
+    def to_csv
+      columns.to_csv
+    end
   end
 end

data/lib/honey_format/row.rb

@@ -1,15 +1,12 @@
+require 'honey_format/row_builder'
+
 module HoneyFormat
   # Holds data for a single row.
   class Row
-    class RowBuilder < Struct
-      def self.call(row)
-        new(*row)
-      end
-    end
-
     # Returns a new instance of Row.
     # @return [Row] a new instance of Row.
     # @param [Array] columns an array of symbols.
+    # @param builder [#call, #to_csv] optional row builder
     # @raise [EmptyColumnsError] raised when there are no columns.
     # @example Create new row
     #     Row.new!([:id])

data/lib/honey_format/row_builder.rb

@@ -0,0 +1,21 @@
+module HoneyFormat
+  # Default row builder
+  class RowBuilder < Struct
+    # @return [Struct] returns an instantiated Struct representing a row
+    def self.call(row)
+      new(*row)
+    end
+
+    # @return [String] CSV-string representation.
+    def to_csv
+      members.map do |column_name|
+        column = public_send(column_name)
+        if column.respond_to?(:to_csv)
+          column.to_csv
+        else
+          column.to_s
+        end
+      end.join(',') + "\n"
+    end
+  end
+end

data/lib/honey_format/rows.rb

@@ -3,6 +3,8 @@ require 'honey_format/row'
 module HoneyFormat
   # Represents rows.
   class Rows
+    include Enumerable
+
     # Returns array of cleaned strings.
     # @return [Rows] new instance of Rows.
     # @param [Array] rows the array of rows.
@@ -11,12 +13,25 @@ module HoneyFormat
       @rows = prepare_rows(Row.new(columns, builder: builder), rows)
     end
 
+    # @yield [row] The given block will be passed every row.
+    # @yieldparam [Row] a row in the CSV file.
+    # @return [Enumerator]
+    #   If no block is given, an enumerator object will be returned.
+    def each(&block)
+      @rows.each(&block)
+    end
+
     # Returns rows as array.
     # @return [Array] of rows.
     def to_a
       @rows
     end
 
+    # @return [String] CSV-string representation.
+    def to_csv
+      to_a.map(&:to_csv).join
+    end
+
     private
 
     def prepare_rows(builder, rows)

data/lib/honey_format/version.rb

@@ -1,4 +1,4 @@
 module HoneyFormat
   # Gem version
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honey_format
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Jacob Burenstam
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-04 00:00:00.000000000 Z
+date: 2018-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: Convert CSV to an array of objects with with ease. Create objects for
   each row with methods matching the column names. No dependencies other than Ruby
   stdlib.
@@ -109,6 +123,7 @@ files:
 - lib/honey_format/exceptions.rb
 - lib/honey_format/header.rb
 - lib/honey_format/row.rb
+- lib/honey_format/row_builder.rb
 - lib/honey_format/rows.rb
 - lib/honey_format/sanitize.rb
 - lib/honey_format/version.rb