honey_format 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 582322cb2da52ea080c388d8112159bf2f7923e3
-  data.tar.gz: e6854e04c23c2aa129753bf373c9417df4887627
+  metadata.gz: 3ba71ccfedf80d0f721f3b205a6eb8f247284704
+  data.tar.gz: e6091ac68245db3e1c1d0918e9aed66361b38a5e
 SHA512:
-  metadata.gz: 324f80c7fb803942428dfd051e55de92e687d83b7c6c5f351330f4eb159260f34fb6fb4a7b695d64c4ccdebd2a8e96aa90acb338f95645dd29b188a61dec09e0
-  data.tar.gz: 9d5e5f4724f1aca4f8676f1814d3034709d40c26f5266781d6ab7f62150f0bffaf797961090aebb7f579b950d8f8a25b1fae62526eecc43d73fbc82ba804a17f
+  metadata.gz: 918906a7bdfc3d6ef900794832a8359811ee69ea9c68ab8a563bc5199308db91637fa8610f7b265bc7ddbcad13a3f74b1e6f467df5247eb0ed2d022bd9ce1bf2
+  data.tar.gz: 4f46d54f77c109349131ea3c3db982e1671aa3597ea1383b3cd7b6176a64d72bb0650fe0b772fa3542883c38761589344c23fb510ec110e21ce15a80d7845819

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+benchmark.csv

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Jacob Burenstam
+Copyright (c) 2015 Jacob Burenstam Linder
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,7 +1,9 @@
-# HoneyFormat
+# 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)
 
 Convert CSV to object with one command.
 
+Perfect for small files of test data or small import scripts.
+
 ```ruby
 csv_string = "Id, Username\n 1, buren"
 csv = HoneyFormat::CSV.new(csv_string)
@@ -16,7 +18,7 @@ user.username   # => "buren"
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'honey-import'
+gem 'honey_format'
 ```
 
 And then execute:
@@ -26,7 +28,7 @@ $ bundle
 
 Or install it yourself as:
 ```
-$ gem install honey-import
+$ gem install honey_format
 ```
 
 ## Usage
@@ -64,7 +66,26 @@ csv = HoneyCSV.new(csv_string, header: ['Id', 'Username'])
 csv.rows.first.username # => "buren"
 ```
 
-_Note_: This gem, as you can imagine, adds some overhead to parsing a CSV string. Make sure to benchmark before using this for something performance sensitive.
+## Benchmark
+
+_Note_: This gem, adds some overhead to parsing a CSV string. I've included some benchmarks below, your mileage may vary..
+
+Benchmarks for a 21MB file with 10 columns (MBP 2013 OSX 10.10).
+
+```
+Calculating -------------------------------------
+          stdlib CSV     1.000  i/100ms
+    HoneyFormat::CSV     1.000  i/100ms
+-------------------------------------------------
+          stdlib CSV      0.317  (± 0.0%) i/s -      4.000  in  12.636647s
+    HoneyFormat::CSV      0.335  (± 0.0%) i/s -      4.000  in  12.061301s
+
+Comparison:
+    HoneyFormat::CSV:        0.3 i/s
+          stdlib CSV:        0.3 i/s - 1.06x slower
+```
+
+Run the benchmark as a regular ruby file: `ruby benchmark.rb`.
 
 ## Development
 
@@ -74,7 +95,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/buren/honey-import. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/buren/honey_format. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
 
 
 ## License

data/benchmark.rb

@@ -0,0 +1,17 @@
+require 'benchmark/ips'
+require 'csv'
+
+require 'bundler/setup'
+require 'honey_format'
+
+csv = File.read('benchmark.csv')
+
+Benchmark.ips do |x|
+  x.time = 10
+  x.warmup = 2
+
+  x.report("stdlib CSV") { CSV.parse(csv) }
+  x.report("HoneyFormat::CSV") { HoneyFormat::CSV.new(csv) }
+
+  x.compare!
+end

data/lib/honey_format/csv.rb

@@ -7,8 +7,8 @@ module HoneyFormat
   class CSV
     attr_reader :header, :columns
 
-    def initialize(csv, header: nil, valid_columns: :all)
-      csv = ::CSV.parse(csv)
+    def initialize(csv, delimiter: ',', header: nil, valid_columns: :all)
+      csv = ::CSV.parse(csv, col_sep: delimiter)
       @head = build_header(header || csv.shift)
       @csv_body = csv
       @columns = build_columns(@head, valid_columns)

data/lib/honey_format/version.rb

@@ -1,3 +1,3 @@
 module HoneyFormat
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honey_format
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jacob Burenstam
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-01 00:00:00.000000000 Z
+date: 2015-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -82,6 +82,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- benchmark.rb
 - bin/console
 - bin/setup
 - honey_format.gemspec