honey_format 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5d7c212e16b346e58a80617576ff6c39b1938885b8a66ad7a91c1b7654897cf
-  data.tar.gz: e70bee6d2a69eb8624a35d69300c0e0f02772e88f0237a94f64fa6a13d0c409f
+  metadata.gz: 220883bb92b35808697b428d346d1f171d2d06d47d4a9ed79404b824a7e65781
+  data.tar.gz: 9260762827e1fa50c1669696edfbc625a9e94ffc04773db81f27d6c8d9e7dd88
 SHA512:
-  metadata.gz: 7a0af309f8e7f31f725cd9b3d391ee27c4ebf858d31498f39dad99e78cf55ebcd8541a347fb2937fa51a52a0b43405b611943f52dda8040a9124ada30f3a2b54
-  data.tar.gz: 9c6a89db6da810c78dfe2c74b0fb1ea175b4e62392226bd84e92c53ce5529049190e5c99cdb518dc358f5a98d4385fc3554add7407d2f5c809e3966631ffc467
+  metadata.gz: 245594826d582fdbbe02fb303a004197849f9ae17b184ecd4d57e833f98b220e28543bd3aaa1706221b9196b548d7adbd2b73f38ce96e24685f361645d86e307
+  data.tar.gz: 3c907de2398718ae946aeb3984991b9273b359e667004c331e86a359e513c38e2d09836c52fba230a2a98e47cdb3e93a5e964b7583c48e6d43ce739018806bd8

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# v0.11.0
+
+* Add CLI: `honey_format` executable
+* Swap `RowBuilder` <> `Row` class names [[#PR12](https://github.com/buren/honey_format/pull/12)]
+
 # v0.10.0
 
 * Add support for filtering what rows are included in `#to_csv` [[#PR11](https://github.com/buren/honey_format/pull/11)]

data/README.md

@@ -1,8 +1,19 @@
-# HoneyFormat [![Build Status](https://travis-ci.org/buren/honey_format.svg)](https://travis-ci.org/buren/honey_format) [![Code Climate](https://codeclimate.com/github/buren/honey_format/badges/gpa.svg)](https://codeclimate.com/github/buren/honey_format) ![Docs badge](https://inch-ci.org/github/buren/honey_format.svg?branch=master)
+# HoneyFormat [![Build Status](https://travis-ci.org/buren/honey_format.svg)](https://travis-ci.org/buren/honey_format) [![Code Climate](https://codeclimate.com/github/buren/honey_format/badges/gpa.svg)](https://codeclimate.com/github/buren/honey_format) [![Inline docs](http://inch-ci.org/github/buren/honey_format.svg)](http://inch-ci.org/github/buren/honey_format)
 
 Convert CSV to an array of objects with with ease.
 
-Perfect for small files of test data or small import scripts.
+## Features
+
+- Proper objects for CSV header and rows
+- Convert column values with custom row builder
+- Convert header column names
+- Customize what columns and rows are included in CSV output
+- Has no dependencies other than Ruby stdlib
+- Supports Ruby >= 2.3
+
+## Examples
+
+See [examples/](https://github.com/buren/honey_format/tree/master/examples) for more examples.
 
 ```ruby
 csv_string = "Id,Username\n1,buren"
@@ -13,8 +24,6 @@ user.id         # => "1"
 user.username   # => "buren"
 ```
 
-:information_source: Supports Ruby >= 2.3, has no dependencies other than Ruby stdlib.
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -164,10 +173,10 @@ Errors
 begin
   HoneyFormat::CSV.new(csv_string)
 rescue HoneyFormat::HeaderError => e
-  puts 'there is a problem with the header'
+  puts 'there was a problem with the header'
   raise(e)
 rescue HoneyFormat::RowError => e
-  puts 'there is a problem with a row'
+  puts 'there was a problem with a row'
   raise(e)
 end
 ```
@@ -193,13 +202,14 @@ $ bin/benchmark file.csv
 HoneyFormat::CSV:       49.6 i/s - 1.05x  slower
 ```
 
-19MB (100k lines)
+2MB (10k lines)
 
 ```
-      stdlib CSV:        0.4 i/s
-HoneyFormat::CSV:        0.4 i/s - 1.11x  slower
+      stdlib CSV:        4.6 i/s
+HoneyFormat::CSV:        4.2 i/s - 1.08x  slower
 ```
 
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/exe/honey_format

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+
+# for dev purposes
+require 'bundler/setup' if ENV['HONEY_FORMAT_GEM_DEV']
+require 'honey_format'
+
+input_path = ARGV.first
+
+columns = nil
+output_path = nil
+delimiter = ','
+
+require 'optparse'
+
+OptionParser.new do |parser|
+  parser.banner = "Usage: honey_format [file.csv] [options]"
+  parser.default_argv = ARGV
+
+  parser.on("--csv=input.csv", String, "CSV file") do |value|
+    input_path = value
+  end
+
+  parser.on("--columns=id,name", Array, "Select columns.") do |value|
+    columns = value
+  end
+
+  parser.on("--output=output.csv", String, "CSV output (STDOUT otherwise)") do |value|
+    output_path = value
+  end
+
+  parser.on("--delimiter=,", String, "CSV delimiter (default: ,)") do |value|
+    delimiter = value
+  end
+
+  parser.on("-h", "--help", "How to use") do
+    puts parser
+    exit
+  end
+
+  parser.on_tail('--version', 'Show version') do
+    puts "HoneyFormat version #{HoneyFormat::VERSION}"
+    exit
+  end
+
+  # No argument, shows at tail. This will print an options summary.
+  parser.on_tail("-h", "--help", "Show this message") do
+    puts parser
+    exit
+  end
+end.parse!
+
+csv = HoneyFormat::CSV.new(File.read(input_path), delimiter: delimiter)
+csv_string = csv.to_csv(columns: columns.map(&:to_sym))
+if output_path
+  File.write(output_path, csv_string)
+else
+  puts csv_string
+end

data/honey_format.gemspec

@@ -14,7 +14,8 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/buren/honey_format'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|examples)/}) }
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 

data/lib/honey_format/header.rb

@@ -87,17 +87,27 @@ module HoneyFormat
       end
     end
 
+    # Convert the column value
+    # @param [Object] column the CSV header column value
+    # @param [Integer] index the CSV header column index
+    # @return [Object] the converted object
     def convert_column(column, index)
       return @converter.call(column) if converter_arity == 1
       @converter.call(column, index)
     end
 
+    # Returns the converter#call method arity
+    # @return [Integer] the converter#call method arity
     def converter_arity
       # procs and lambdas respond to #arity
       return @converter.arity if @converter.respond_to?(:arity)
       @converter.method(:call).arity
     end
 
+    # Raises an error if header column is unknown
+    # @param [Object] column the CSV header column
+    # @param [Array<Symbol, String>] valid CSV columns
+    # @raise [Errors::UnknownHeaderColumnError]
     def maybe_raise_unknown_column!(column, valid)
       return if valid.empty?
       return if valid.include?(column)
@@ -106,6 +116,9 @@ module HoneyFormat
       raise(Errors::UnknownHeaderColumnError, err_msg)
     end
 
+    # Raises an error if header column is missing/empty
+    # @param [Object] column the CSV header column
+    # @raise [Errors::MissingHeaderColumnError]
     def maybe_raise_missing_column!(column)
       return if column && !column.empty?
 

data/lib/honey_format/row.rb

@@ -1,49 +1,39 @@
-require 'honey_format/row_builder'
-
 module HoneyFormat
-  # Holds data for a single row.
-  class Row
-    # 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 [RowError] super class of errors raised when there is a row error.
-    # @raise [EmptyRowColumnsError] raised when there are no columns.
-    # @raise [InvalidRowLengthError] raised when row has more columns than header columns.
-    # @example Create new row
-    #     Row.new!([:id])
-    def initialize(columns, builder: nil)
-      if columns.empty?
-        err_msg = 'Expected array with at least one element, but was empty.'
-        raise(Errors::EmptyRowColumnsError, err_msg)
-      end
+  # Default row builder
+  class Row < Struct
+    # Create a row
+    # @return [Struct] returns an instantiated Struct representing a row
+    # @example
+    #   row_klass = Row.new(:id, :username)
+    #   row = row_klass.call('1', 'buren')
+    #   # => #<struct id="1", username="buren">
+    def self.call(row)
+      new(*row)
+    end
+
+    # Represent row as CSV
+    # @param columns [Array<Symbol>, Set<Symbol>, NilClass] the columns to output, nil means all columns (default: nil)
+    # @return [String] CSV-string representation.
+    def to_csv(columns: nil)
+      attributes = members
+      attributes = columns & attributes if columns
 
-      @row_builder = RowBuilder.new(*columns)
-      @builder = builder
-      @columns = columns
+      row = attributes.map { |column| to_csv_value(column) }
+
+      ::CSV.generate_line(row)
     end
 
-    # Returns a Struct.
-    # @return [Object] a new instance of built row.
-    # @param row [Array] the row array.
-    # @raise [InvalidRowLengthError] raised when there are more row elements longer than columns
-    # @example Build new row
-    #     r = Row.new([:id])
-    #     r.build(['1']).id #=> '1'
-    def build(row)
-      built_row = @row_builder.call(row)
-      return built_row unless @builder
-      @builder.call(built_row)
-    rescue ArgumentError => e
-      raise unless e.message == 'struct size differs'
+    private
+
+    # Returns the column in CSV format
+    # @param [Symbol] column name
+    # @return [String] column value as CSV string
+    def to_csv_value(column)
+      value = public_send(column)
+      return if value.nil?
+      return value.to_csv if value.respond_to?(:to_csv)
 
-      err_msg = [
-        "Row length #{row.length}",
-        "column length #{@columns.length}",
-        "row: #{row.inspect}",
-        "orignal message: '#{e.message}'"
-      ].join(', ')
-      raise(Errors::InvalidRowLengthError, err_msg)
+      value.to_s
     end
   end
 end

data/lib/honey_format/row_builder.rb

@@ -1,28 +1,58 @@
+require 'honey_format/row'
+
 module HoneyFormat
-  # Default row builder
-  class RowBuilder < Struct
-    # Create a row
-    # @return [Struct] returns an instantiated Struct representing a row
-    def self.call(row)
-      new(*row)
-    end
+  # Holds data for a single row.
+  class RowBuilder
+    # Returns a new instance of RowBuilder.
+    # @return [RowBuilder] a new instance of RowBuilder.
+    # @param [Array<Symbol>] columns an array of symbols.
+    # @param builder [#call, #to_csv] optional row builder
+    # @raise [RowError] super class of errors raised when there is a row error.
+    # @raise [EmptyRowColumnsError] raised when there are no columns.
+    # @raise [InvalidRowLengthError] raised when row has more columns than header columns.
+    # @example Create new row
+    #     RowBuilder.new!([:id])
+    def initialize(columns, builder: nil)
+      if columns.empty?
+        err_msg = 'Expected array with at least one element, but was empty.'
+        raise(Errors::EmptyRowColumnsError, err_msg)
+      end
 
-    # Represent row as CSV
-    # @param columns [Array<Symbol>, Set<Symbol>, NilClass] the columns to output, nil means all columns (default: nil)
-    # @return [String] CSV-string representation.
-    def to_csv(columns: nil)
-      attributes = members
-      attributes = columns & attributes if columns
+      @row_klass = Row.new(*columns)
+      @builder = builder
+      @columns = columns
+    end
 
-      row = attributes.map do |column_name|
-        column = public_send(column_name)
-        next column.to_csv if column.respond_to?(:to_csv)
-        next if column.nil?
+    # Returns a Struct.
+    # @return [Row, Object] a new instance of built row.
+    # @param row [Array] the row array.
+    # @raise [InvalidRowLengthError] raised when there are more row elements longer than columns
+    # @example Build new row
+    #     r = RowBuilder.new([:id])
+    #     r.build(['1']).id #=> '1'
+    def build(row)
+      row = @row_klass.call(row)
+      return row unless @builder
+      @builder.call(row)
+    rescue ArgumentError => e
+      raise unless e.message == 'struct size differs'
+      raise_invalid_row_length!(e, row)
+    end
 
-        column.to_s
-      end
+    private
 
-      ::CSV.generate_line(row)
+    # Raises invalid row length error
+    # @param [StandardError] e the raised error
+    # @param [Object] row
+    # @raise [Errors::InvalidRowLengthError]
+    def raise_invalid_row_length!(e, row)
+      err_msg = [
+        "Row length #{row.length}",
+        "column length #{@columns.length}",
+        "row: #{row.inspect}",
+        "orignal message: '#{e.message}'"
+      ].join(', ')
+      raise(Errors::InvalidRowLengthError, err_msg)
     end
   end
 end

data/lib/honey_format/rows.rb

@@ -1,5 +1,5 @@
 require 'set'
-require 'honey_format/row'
+require 'honey_format/row_builder'
 
 module HoneyFormat
   # Represents rows.
@@ -14,7 +14,8 @@ module HoneyFormat
     # @raise [EmptyRowColumnsError] raised when there are no columns.
     # @raise [InvalidRowLengthError] raised when row has more columns than header columns.
     def initialize(rows, columns, builder: nil)
-      @rows = prepare_rows(Row.new(columns, builder: builder), rows)
+      builder = RowBuilder.new(columns, builder: builder)
+      @rows = prepare_rows(builder, rows)
     end
 
     # @yield [row] The given block will be passed for every row.

data/lib/honey_format/version.rb

@@ -1,4 +1,4 @@
 module HoneyFormat
   # Gem version
-  VERSION = '0.10.0'
+  VERSION = '0.11.0'
 end

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: honey_format
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Jacob Burenstam
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
 date: 2018-06-09 00:00:00.000000000 Z
 dependencies:
@@ -99,7 +99,8 @@ description: Convert CSV to an array of objects with with ease. Create objects f
   stdlib.
 email:
 - burenstam@gmail.com
-executables: []
+executables:
+- honey_format
 extensions: []
 extra_rdoc_files: []
 files:
@@ -115,6 +116,7 @@ files:
 - bin/benchmark
 - bin/console
 - bin/setup
+- exe/honey_format
 - honey_format.gemspec
 - lib/honey_format.rb
 - lib/honey_format/convert_header_value.rb