honey_format 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 220883bb92b35808697b428d346d1f171d2d06d47d4a9ed79404b824a7e65781
-  data.tar.gz: 9260762827e1fa50c1669696edfbc625a9e94ffc04773db81f27d6c8d9e7dd88
+  metadata.gz: 6d236d3a0eeee26825fc307504a6e65c66dbd30c5cbc8b4d190f5af391e73fc0
+  data.tar.gz: e5989adcda923101ccff44d34b15adffe7db4cbd1cabdfad3229dace94076c6b
 SHA512:
-  metadata.gz: 245594826d582fdbbe02fb303a004197849f9ae17b184ecd4d57e833f98b220e28543bd3aaa1706221b9196b548d7adbd2b73f38ce96e24685f361645d86e307
-  data.tar.gz: 3c907de2398718ae946aeb3984991b9273b359e667004c331e86a359e513c38e2d09836c52fba230a2a98e47cdb3e93a5e964b7583c48e6d43ce739018806bd8
+  metadata.gz: 5fa617674f689a27707c15a6a9d307181a8bda8662da9f40e5a3a689821c1269ca34762c4609511a7265cf75c04e551c1e1de8d5e2d0825826ff6a422aa77398
+  data.tar.gz: de36bd4aa3bd05e3e9f99d703b0ffe4674f894edaa85aecc3b51114f434dcdf9d6ea3b23c9b3b2b0c0c5319d63849c49532d46bcccb044ebc4190c77c9212eeb

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# v0.12.0
+
+* Add `--[no-]only-header` option to CLI
+* _[Bugfix]_: Handle missing --columns argument in CLI
+
 # v0.11.0
 
 * Add CLI: `honey_format` executable

data/README.md

@@ -8,6 +8,7 @@ Convert CSV to an array of objects with with ease.
 - Convert column values with custom row builder
 - Convert header column names
 - Customize what columns and rows are included in CSV output
+- [CLI](#cli)
 - Has no dependencies other than Ruby stdlib
 - Supports Ruby >= 2.3
 
@@ -185,6 +186,18 @@ You can see all [available errors here](https://www.rubydoc.info/gems/honey_form
 
 If you want to see more usage examples check out the `spec/` directory.
 
+## CLI
+
+```
+Usage: honey_format [file.csv] [options]
+        --csv=input.csv              CSV file
+        --columns=id,name            Select columns.
+        --output=output.csv          CSV output (STDOUT otherwise)
+        --delimiter=,                CSV delimiter (default: ,)
+    -h, --help                       How to use
+        --version                    Show version
+```
+
 ## Benchmark
 
 _Note_: This gem, adds some overhead to parsing a CSV string. I've included some benchmarks below, your mileage may vary..

data/bin/benchmark

@@ -4,16 +4,72 @@ require 'honey_format'
 
 require 'benchmark/ips'
 require 'csv'
+require 'optparse'
 
-path = ARGV.first || fail(ArgumentError, '<path_to_csv> argument must be provided')
-csv = File.read(path)
+input_path = nil
+benchmark_time = 30
+benchmark_warmup = 5
+lines_multipliers = [1]
 
-Benchmark.ips do |x|
-  x.time = 30
-  x.warmup = 5
+OptionParser.new do |parser|
+  parser.banner = "Usage: bin/benchmark [file.csv] [options]"
+  parser.default_argv = ARGV
 
-  x.report('stdlib CSV')       { CSV.parse(csv) }
-  x.report('HoneyFormat::CSV') { HoneyFormat::CSV.new(csv).rows }
+  parser.on("--csv=file1.csv", String, "CSV file(s)") do |value|
+    input_path = value
+  end
 
-  x.compare!
+  parser.on("--lines-multipliers=[1,10,50]", Array, "Multiply the rows in the CSV file (default: 1)") do |value|
+    lines_multipliers = value.map do |v|
+      Integer(v).tap do |int|
+        unless int >= 1
+          raise(ArgumentError, '--lines-multiplier must be 1 or greater')
+        end
+      end
+    end
+  end
+
+  parser.on("--time=[30]", String, "Benchmark time (default: 30)") do |value|
+    benchmark_time = Integer(value)
+  end
+
+  parser.on("--warmup=[30]", String, "Benchmark warmup (default: 30)") do |value|
+    benchmark_warmup = Integer(value)
+  end
+
+  parser.on("-h", "--help", "How to use") do
+    puts parser
+    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 = File.read(input_path)
+
+lines_multipliers.each do |lines_multiplier|
+  if lines_multiplier > 1
+    orignial_csv_lines = csv.lines
+    rows = orignial_csv_lines[1..-1] * lines_multiplier
+    csv = orignial_csv_lines.first + rows.join
+  end
+
+  line_count = csv.lines.length
+
+  puts "== [START] Benchmark for #{line_count} lines =="
+  Benchmark.ips do |x|
+    x.time = benchmark_time
+    x.warmup = benchmark_warmup
+
+    x.report('stdlib CSV no options')  { CSV.parse(csv) }
+    x.report('stdlib CSV with header') { CSV.parse(csv, headers: true) }
+    x.report('HoneyFormat::CSV')       { HoneyFormat::CSV.new(csv).rows }
+
+    x.compare!
+  end
+  puts "== [END] Benchmark for #{line_count} lines =="
 end

data/exe/honey_format

@@ -9,6 +9,7 @@ input_path = ARGV.first
 columns = nil
 output_path = nil
 delimiter = ','
+header_only = false
 
 require 'optparse'
 
@@ -20,6 +21,10 @@ OptionParser.new do |parser|
     input_path = value
   end
 
+  parser.on("--[no-]only-header=[output.csv]", "Print only the header") do |value|
+    header_only = value
+  end
+
   parser.on("--columns=id,name", Array, "Select columns.") do |value|
     columns = value
   end
@@ -50,7 +55,12 @@ OptionParser.new do |parser|
 end.parse!
 
 csv = HoneyFormat::CSV.new(File.read(input_path), delimiter: delimiter)
-csv_string = csv.to_csv(columns: columns.map(&:to_sym))
+if header_only
+  puts csv.columns.join(',')
+  exit
+end
+
+csv_string = csv.to_csv(columns: columns&.map(&:to_sym))
 if output_path
   File.write(output_path, csv_string)
 else

data/lib/honey_format/csv.rb

@@ -6,6 +6,7 @@ require 'honey_format/header'
 module HoneyFormat
   # Represents CSV.
   class CSV
+    # Instantiate CSV.
     # @return [CSV] a new instance of CSV.
     # @param [String] csv the CSV string
     # @param [String] delimiter the CSV delimiter

data/lib/honey_format/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honey_format
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Jacob Burenstam
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-09 00:00:00.000000000 Z
+date: 2018-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler