bumblebee 1.2.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fc1683a1f73e0f3cfb12d5b718694519fb154d5201b35449730c9df7162a1aa
-  data.tar.gz: 3e73073d56e7996a848ee02c1b0d5082528f1c94d1bd5f1fb42b7dd20833e943
+  metadata.gz: b8295218b496c6f59aae9de01d637270c3d975f59d60b8c82b33ce8e8b7e6f8c
+  data.tar.gz: 25eb49fed0dc2c3fcaabf3450a118e45e7cd08bfe481377b9bfa5f4f0c29ba3b
 SHA512:
-  metadata.gz: e565c2a8660b28c41e46d5e018e7656393db90fa9b9627387d829ed1f311a590ab617750177b83a453ce099313a3020fdb53d92ff771124a50033be679d0d69b
-  data.tar.gz: 85813743f37ad1094be77b0a182521b6873dc65ba2cbe830c107a21d4e2276471a9b2509cfca80a8e4f478566b7f5da3064b5b78c484b6bce25278d0230c59ef
+  metadata.gz: 8ae9820932be10273e929b55cb04f16264e765988438539315e0d7259b125dda7691e22dfff8810b46518e6dd254c7177fd00f97bfd61e5a7961ce02991f15b4
+  data.tar.gz: aeaad7ac5781a2f3eee96187a0c9e08516a304133cb1253a542539cb553f12c486dbcf0fad4c739f91d088467ef9c555f4baf4e5bfa268012fca4a35011d1ace

data/.gitignore

@@ -1,3 +1,4 @@
 .DS_Store
 *.gem
 /tmp
+/coverage

data/.ruby-version

@@ -0,0 +1 @@
+2.6.0

data/.travis.yml

@@ -1,11 +1,20 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=a14b1cf423f3f72a1d6aaceff4959c25793586e8ec14695d5f378864b75d705d
 language: ruby
 rvm:
-# Build on the latest stable of all supported Rubies (https://www.ruby-lang.org/en/downloads/):
-- 2.3.8
-- 2.4.5
-- 2.5.3
-- 2.6.0
+  # Build on the latest stable of all supported Rubies (https://www.ruby-lang.org/en/downloads/):
+  - 2.3.8
+  - 2.4.5
+  - 2.5.3
+  - 2.6.0
 cache: bundler
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
 script:
-- bundle exec rubocop
-- bundle exec rspec
+  - bundle exec rubocop
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 2.0.0 (January 31, 2019)
+
+* Upgraded Rubocop
+* Updated README
+* Hooked up CodeClimate / Test Coverage
+* Changed internal implementation of Column#csv_to_object.  This is a breaking change that reverse's the flow of assignment: When a column is parsed and value is extracted, it will iterate over the to_object values one by one, chaining the previous value with the next.  Once it is complete, it assigns the value to the field.
+
 # 1.2.1 (January 22, 2019)
 
 * README enhancements.

data/Gemfile.lock

@@ -1,16 +1,18 @@
 PATH
   remote: .
   specs:
-    bumblebee (1.2.1)
+    bumblebee (2.0.0)
       acts_as_hashable (~> 1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    acts_as_hashable (1.0.3)
+    acts_as_hashable (1.0.4)
+    ansi (1.5.0)
     ast (2.4.0)
     coderay (1.1.2)
     diff-lcs (1.3)
+    docile (1.3.1)
     ffi (1.9.25)
     formatador (0.2.5)
     guard (2.15.0)
@@ -27,7 +29,9 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    jaro_winkler (1.5.1)
+    hirb (0.7.3)
+    jaro_winkler (1.5.2)
+    json (2.1.0)
     listen (3.1.5)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
@@ -38,8 +42,8 @@ GEM
     notiffany (0.1.1)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    parallel (1.12.1)
-    parser (2.5.3.0)
+    parallel (1.13.0)
+    parser (2.6.0.0)
       ast (~> 2.4.0)
     powerpack (0.1.2)
     pry (0.12.2)
@@ -62,19 +66,28 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
-    rubocop (0.59.2)
+    rubocop (0.63.1)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.5, != 2.5.1.1)
       powerpack (~> 0.1)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
+      unicode-display_width (~> 1.4.0)
     ruby-progressbar (1.10.0)
     ruby_dep (1.5.0)
     shellany (0.0.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-console (0.4.2)
+      ansi
+      hirb
+      simplecov
+    simplecov-html (0.10.2)
     thor (0.20.3)
-    unicode-display_width (1.4.0)
+    unicode-display_width (1.4.1)
 
 PLATFORMS
   ruby
@@ -83,7 +96,9 @@ DEPENDENCIES
   bumblebee!
   guard-rspec (~> 4.7)
   rspec (~> 3.8)
-  rubocop (~> 0.59)
+  rubocop (~> 0.63.1)
+  simplecov (~> 0.16.1)
+  simplecov-console (~> 0.4.2)
 
 BUNDLED WITH
    1.17.2

data/README.md

@@ -1,11 +1,9 @@
 # Bumblebee
 
-[![Build Status](https://travis-ci.org/bluemarblepayroll/bumblebee.svg?branch=master)](https://travis-ci.org/bluemarblepayroll/bumblebee)
+[![Gem Version](https://badge.fury.io/rb/bumblebee.svg)](https://badge.fury.io/rb/bumblebee) [![Build Status](https://travis-ci.org/bluemarblepayroll/bumblebee.svg?branch=master)](https://travis-ci.org/bluemarblepayroll/bumblebee) [![Maintainability](https://api.codeclimate.com/v1/badges/e56cf63628a6b12ad1aa/maintainability)](https://codeclimate.com/github/bluemarblepayroll/bumblebee/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/e56cf63628a6b12ad1aa/test_coverage)](https://codeclimate.com/github/bluemarblepayroll/bumblebee/test_coverage) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 Higher level languages, such as Ruby, make interacting with CSV (Comma Separated Values) files trivial. Even so, this library provides a very simple object/CSV mapper that allows you to fully interact with CSV's in a declarative way.  Locking in common patterns, even in higher level languages, is important in large codebases.  Using a library, such as this, will help ensure standardization around CSV interaction.
 
-However, there are situations where this level of abstraciton may not be appropriate.  For example, this library is not meant to be extremely performant given large files and/or datasets.  This library shines with CSV and/or data-sets of less than 100,000 records (approx).
-
 ## Installation
 
 To install through Rubygems:
@@ -136,7 +134,7 @@ csv = Bumblebee.generate_csv(columns, objects)
 
 The above columns config would work both ways, so if we received the CSV, we could parse it to an array of nested hashes.  Unfortunately, for now, we cannot do better than an array of nested hashes.
 
-### Custom Formatting
+### Custom To CSV Formatting
 
 You can also pass in functions that can do the value formatting.  For example:
 
@@ -166,6 +164,77 @@ columns = [
 
 would ensure the CSV has only upper-case `First Name` values.
 
+### Custom To Object Formatting
+
+You can also choose a custom method how the CSV's value is parsed just like you can customize how values are set for a CSV.  This helps function as an intermediate extractor/formatter/converter, in theory, should be able to give you alot more custom control over the parsing.
+
+A previous example above showed a custom nested object-to-csv flow.  This time, let's go csv-to-object with this dataset:
+
+ID # | First Name | Date of Birth | Phone #
+---- | ---------- | ------------- | ------------
+1    | Matt       | 1901-02-03    | 555-555-5555
+2    | Nick       | 1921-09-03    | 444-444-4444
+3    | Sam        | 1932-12-12    | 333-333-3333
+
+Using the following column config:
+
+````ruby
+columns = [
+  {
+    field: :id,
+    header: 'ID #',
+    to_object: ->(o) { o['ID #'].to_i }
+  },
+  {
+    field: :name,
+    header: 'First Name',
+    to_csv: %i[name first],
+    to_object: ->(o) { { first: o['First Name'] } }
+  },
+  { field: :demo,
+    header: 'Date of Birth',
+    to_csv: %i[demo dob],
+    to_object: ->(o) { { dob: o['Date of Birth'] } }
+  },
+  { field: :contact,
+    header: 'Phone #',
+    to_csv: %i[contact phone],
+    to_object: ->(o) { { phone: o['Phone #'] } }
+  }
+]
+````
+
+Executing the following:
+
+````ruby
+objects = Bumblebee.parse_csv(columns, data)
+````
+
+Would give us the following:
+
+````ruby
+objects = [
+  {
+    id: 1,
+    name: { first: 'Matt' },
+    demo: { dob: '1901-02-03' },
+    contact: { phone: '555-555-5555' }
+  },
+  {
+    id: 2,
+    name: { first: 'Nick' },
+    demo: { dob: '1921-09-03' },
+    contact: { phone: '444-444-4444' }
+  },
+  {
+    id: 3,
+    name: { first: 'Sam' },
+    demo: { dob: '1932-12-12' },
+    contact: { phone: '333-333-3333' }
+  }
+]
+````
+
 #### Further CSV Customization
 
 The two main methods:
@@ -214,12 +283,12 @@ Note: ensure you have proper authorization before trying to publish new versions
 After code changes have successfully gone through the Pull Request review process then the following steps should be followed for publishing new versions:
 
 1. Merge Pull Request into master
-2. Update [lib/bumblebee/version.rb](https://github.com/bluemarblepayroll/bumblebee/blob/master/lib/bumblebee/version.rb) [version number](https://semver.org/)
-3. Bundle
-4. Update CHANGELOG.md
-5. Commit & Push master to remote and ensure CI builds master successfully
+2. Update ```lib/bumblebee/version.rb``` using [semantic versioning](https://semver.org/)
+3. Install dependencies: ```bundle```
+4. Update ```CHANGELOG.md``` with release notes
+5. Commit & push master to remote and ensure CI builds master successfully
 6. Build the project locally: `gem build bumblebee`
-7. Publish package to NPM: `gem push bumblebee-X.gem` where X is the version to push
+7. Publish package to RubyGems: `gem push bumblebee-X.gem` where X is the version to push
 8. Tag master with new version: `git tag <version>`
 9. Push tags remotely: `git push origin --tags`
 

data/bumblebee.gemspec

@@ -26,5 +26,7 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency('guard-rspec', '~>4.7')
   s.add_development_dependency('rspec', '~> 3.8')
-  s.add_development_dependency('rubocop', '~> 0.59')
+  s.add_development_dependency('rubocop', '~>0.63.1')
+  s.add_development_dependency('simplecov', '~>0.16.1')
+  s.add_development_dependency('simplecov-console', '~>0.4.2')
 end

data/lib/bumblebee/column.rb

@@ -24,7 +24,7 @@ module Bumblebee
       @field      = field
       @header     = make_header(header || field)
       @to_csv     = Array(to_csv || field)
-      @to_object  = Array(to_object || field)
+      @to_object  = Array(to_object || @header)
     end
 
     # Take a object and convert to a value.
@@ -45,20 +45,14 @@ module Bumblebee
     def csv_to_object(csv_hash)
       return nil unless csv_hash
 
-      value   = csv_hash[header]
-      pointer = hash = {}
+      value = csv_hash
 
-      to_object[0..-2].each do |f|
-        if f.is_a?(Proc)
-          value = f.call(value)
-        else
-          pointer = pointer[f] = {}
-        end
+      to_object.each do |f|
+        value = single_extract(value, f)
       end
 
-      pointer[to_object[-1]] = value
-
-      hash
+      hash = {}
+      hash.tap { hash[field] = value }
     end
 
     private

data/lib/bumblebee/version.rb

@@ -8,5 +8,5 @@
 #
 
 module Bumblebee
-  VERSION = '1.2.1'
+  VERSION = '2.0.0'
 end

data/spec/bumblebee/bumblebee_spec.rb

@@ -8,7 +8,6 @@
 #
 
 require './spec/spec_helper'
-require 'stringio'
 
 describe ::Bumblebee do
   let(:columns) do
@@ -65,36 +64,84 @@ describe ::Bumblebee do
   end
 
   describe 'README examples' do
-    let(:columns) do
-      [
-        { field: :id },
-        { field: :name },
-        { field: :dob },
-        { field: :phone }
-      ]
+    describe 'the simple 1:1 parsing example' do
+      let(:data) { fixture('simple_readme_example.csv') }
+
+      let(:columns) do
+        [
+          { field: 'id' },
+          { field: 'name' },
+          { field: 'dob' },
+          { field: 'phone' }
+        ]
+      end
+
+      let(:output) do
+        [
+          { 'id' => '1', 'name' => 'Matt', 'dob' => '2/3/01',   'phone' => '555-555-5555' },
+          { 'id' => '2', 'name' => 'Nick', 'dob' => '9/3/21',   'phone' => '444-444-4444' },
+          { 'id' => '3', 'name' => 'Sam',  'dob' => '12/12/32', 'phone' => '333-333-3333' }
+        ]
+      end
+
+      specify 'works as advertised' do
+        expect(Bumblebee.parse_csv(columns, data)).to eq output
+      end
     end
 
-    let(:data) do
-      path = File.expand_path('fixtures/simple_readme_example.csv', __dir__)
-
-      # Excel adds a Byte Order Mark to the beginning of the file. Let Ruby
-      # know about this so that the first 'id' column is correctly parsed.
-      # More info about the Excel Byte Order Mark and Ruby is available at:
-      # https://estl.tech/of-ruby-and-hidden-csv-characters-ef482c679b35 .
-      file = File.open(path, 'r:bom|utf-8')
-      file.read
-    end
-
-    let(:output) do
-      [
-        { id: '1', name: 'Matt', dob: '2/3/01',   phone: '555-555-5555' },
-        { id: '2', name: 'Nick', dob: '9/3/21',   phone: '444-444-4444' },
-        { id: '3', name: 'Sam',  dob: '12/12/32', phone: '333-333-3333' }
-      ]
-    end
-
-    specify 'the simple 1:1 example works as advertised' do
-      expect(Bumblebee.parse_csv(columns, data)).to eq output
+    describe 'the custom parsing example' do
+      let(:data) { fixture('custom_readme_example.csv') }
+
+      let(:columns) do
+        [
+          {
+            field: :id,
+            header: 'ID #',
+            to_object: ->(o) { o['ID #'].to_i }
+          },
+          {
+            field: :name,
+            header: 'First Name',
+            to_csv: %i[name first],
+            to_object: ->(o) { { first: o['First Name'] } }
+          },
+          { field: :demo,
+            header: 'Date of Birth',
+            to_csv: %i[demo dob],
+            to_object: ->(o) { { dob: o['Date of Birth'] } } },
+          { field: :contact,
+            header: 'Phone #',
+            to_csv: %i[contact phone],
+            to_object: ->(o) { { phone: o['Phone #'] } } }
+        ]
+      end
+
+      let(:output) do
+        [
+          {
+            id: 1,
+            name: { first: 'Matt' },
+            demo: { dob: '1901-02-03' },
+            contact: { phone: '555-555-5555' }
+          },
+          {
+            id: 2,
+            name: { first: 'Nick' },
+            demo: { dob: '1921-09-03' },
+            contact: { phone: '444-444-4444' }
+          },
+          {
+            id: 3,
+            name: { first: 'Sam' },
+            demo: { dob: '1932-12-12' },
+            contact: { phone: '333-333-3333' }
+          }
+        ]
+      end
+
+      specify 'works as advertised' do
+        expect(Bumblebee.parse_csv(columns, data)).to eq output
+      end
     end
   end
 end

data/spec/bumblebee/column_spec.rb

@@ -24,7 +24,7 @@ describe ::Bumblebee::Column do
       name: 'Mattycakes',
       dob: '1921-01-02',
       pizza: 'Pepperoni',
-      license:  { id: '123456' }
+      license: { id: '123456' }
     }
   end
 
@@ -41,7 +41,7 @@ describe ::Bumblebee::Column do
       expect(column.field).to     eq(field)
       expect(column.header).to    eq(field.to_s)
       expect(column.to_csv).to    eq([field])
-      expect(column.to_object).to  eq([field])
+      expect(column.to_object).to  eq([field.to_s])
     end
 
     describe 'header computation' do
@@ -98,23 +98,49 @@ describe ::Bumblebee::Column do
       expect(column.csv_to_object(csv_row)).to eq(record)
     end
 
-    it 'should correctly extract the value using custom from_csv value' do
+    it 'should correctly extract the value using custom to_object value' do
       csv_row = {
-        'First Name' => 'Nathan'
+        'First' => 'Nathan'
       }
 
       record = {
-        'First' => 'Nathan'
+        'name' => 'Nathan'
       }
 
       column = ::Bumblebee::Column.new(
-        field:      'name',
-        header:     'First Name',
-        to_object:  'First'
+        field: 'name',
+        header: 'First Name',
+        to_object: 'First'
       )
 
       expect(column.csv_to_object(csv_row)).to eq(record)
     end
+
+    it 'should correctly extract the value using to_object with a proc' do
+      record = {
+        'name' => 'Nathan'
+      }
+
+      column = ::Bumblebee::Column.new(field: 'name', to_object: ->(o) { o['name'] })
+
+      expect(column.csv_to_object(record)).to eq(record)
+    end
+
+    it 'should correctly build up a nested hash' do
+      record = {
+        'name' => 'Nathan'
+      }
+
+      column = ::Bumblebee::Column.new(
+        field: :person,
+        to_object: [
+          'name',
+          ->(o) { { first: o } }
+        ]
+      )
+
+      expect(column.csv_to_object(record)).to eq(person: { first: record['name'] })
+    end
   end
 
   describe '#object_to_csv' do

data/spec/fixtures/custom_readme_example.csv

@@ -0,0 +1,4 @@
+ID #,First Name,Date of Birth,Phone #
+1,Matt,1901-02-03,555-555-5555
+2,Nick,1921-09-03,444-444-4444
+3,Sam,1932-12-12,333-333-3333

data/spec/spec_helper.rb

@@ -7,4 +7,25 @@
 # LICENSE file in the root directory of this source tree.
 #
 
+require 'stringio'
+
+require 'simplecov'
+require 'simplecov-console'
+SimpleCov.formatter = SimpleCov::Formatter::Console
+SimpleCov.start
+
 require './lib/bumblebee'
+
+def fixture_path(filename)
+  File.join('spec', 'fixtures', filename)
+end
+
+def fixture(filename)
+  # Excel adds a Byte Order Mark to the beginning of the file. Let Ruby
+  # know about this so that the first 'id' column is correctly parsed.
+  # More info about the Excel Byte Order Mark and Ruby is available at:
+  # https://estl.tech/of-ruby-and-hidden-csv-characters-ef482c679b35 .
+  file = File.open(fixture_path(filename), 'r:bom|utf-8')
+
+  file.read
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bumblebee
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-23 00:00:00.000000000 Z
+date: 2019-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_hashable
@@ -58,14 +58,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.59'
+        version: 0.63.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.59'
+        version: 0.63.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
 description: |2
       Higher level languages, such as Ruby, make interacting with CSVs trivial.
       Even so, this library provides a very simple object/csv mapper that allows you to fully interact with CSVs in a declarative way.
@@ -79,6 +107,7 @@ files:
 - ".editorconfig"
 - ".gitignore"
 - ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
@@ -95,7 +124,8 @@ files:
 - lib/bumblebee/version.rb
 - spec/bumblebee/bumblebee_spec.rb
 - spec/bumblebee/column_spec.rb
-- spec/bumblebee/fixtures/simple_readme_example.csv
+- spec/fixtures/custom_readme_example.csv
+- spec/fixtures/simple_readme_example.csv
 - spec/spec_helper.rb
 homepage: https://github.com/bluemarblepayroll/bumblebee
 licenses:
@@ -123,5 +153,6 @@ summary: Object/CSV Mapper
 test_files:
 - spec/bumblebee/bumblebee_spec.rb
 - spec/bumblebee/column_spec.rb
-- spec/bumblebee/fixtures/simple_readme_example.csv
+- spec/fixtures/custom_readme_example.csv
+- spec/fixtures/simple_readme_example.csv
 - spec/spec_helper.rb