bumblebee 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65ab8c72986bdae30dd8ed596620fff17751a35ea0f5e46ac8cf3b038d13d309
-  data.tar.gz: 756adec9d9ffd8dfb239effc74b908b73190e4c3f023c83bc44d93114bf77cf1
+  metadata.gz: 1fc1683a1f73e0f3cfb12d5b718694519fb154d5201b35449730c9df7162a1aa
+  data.tar.gz: 3e73073d56e7996a848ee02c1b0d5082528f1c94d1bd5f1fb42b7dd20833e943
 SHA512:
-  metadata.gz: 40ddf7bed866c0a3ab76357c4c9a1c89a7e28ef7e31d68b2260fea25a422dc321dd14ef59c4e9ccda714e6270707f15744307c54505903658336afb482cc7a56
-  data.tar.gz: bac2237f95edee3ff77c83c0f05886b933f910d803921752e7354395896349b565b5f7611694900b91e29b4a2c51a450421f57c96eebe94f7da7b9a65dc93e99
+  metadata.gz: e565c2a8660b28c41e46d5e018e7656393db90fa9b9627387d829ed1f311a590ab617750177b83a453ce099313a3020fdb53d92ff771124a50033be679d0d69b
+  data.tar.gz: 85813743f37ad1094be77b0a182521b6873dc65ba2cbe830c107a21d4e2276471a9b2509cfca80a8e4f478566b7f5da3064b5b78c484b6bce25278d0230c59ef

data/.travis.yml

@@ -1,5 +1,6 @@
 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

data/CHANGELOG.md

@@ -1,11 +1,15 @@
+# 1.2.1 (January 22, 2019)
+
+* README enhancements.
+
 # 1.2.0 (January 22, 2019)
 
-- Updated parser so it is position-agnostic.  Previously the position of the headers mattered to the parser.  Now, the headers in the file will be used and matched on with the column headers.
+* Updated parser so it is position-agnostic.  Previously the position of the headers mattered to the parser.  Now, the headers in the file will be used and matched on with the column headers.
 
 # 1.1.0 (January 22, 2019)
 
-- Updated parser so it is now compatible and works with Ruby 2.5.3 and 2.6.0.
-- Minimum Ruby version bumped to 2.3.8
+* Updated parser so it is now compatible and works with Ruby 2.5.3 and 2.6.0.
+* Minimum Ruby version bumped to 2.3.8
 
 # 1.0.0 (December 27, 2018)
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bumblebee (1.2.0)
+    bumblebee (1.2.1)
       acts_as_hashable (~> 1.0)
 
 GEM

data/README.md

@@ -2,9 +2,9 @@
 
 [![Build Status](https://travis-ci.org/bluemarblepayroll/bumblebee.svg?branch=master)](https://travis-ci.org/bluemarblepayroll/bumblebee)
 
-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.  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.
+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.
 
-There are situations where this may not be appropriate.  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.)
+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
 
@@ -34,7 +34,7 @@ id | name | dob        | phone
 
 Using the following column configuration:
 
-````
+````ruby
 columns = [
   { field: :id },
   { field: :name },
@@ -45,14 +45,22 @@ columns = [
 
 We could parse this data and turn it into hashes:
 
+````ruby
+objects = Bumblebee.parse_csv(columns, data)
 ````
-objects = ::Bumblebee.parse_csv(columns, data)
+
+Then `objects` is this array of hashes:
+
+````ruby
+[
+  { 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' }
+]
 ````
 
 *Note: Data, in this case, would be the read CSV file contents in string format.*
 
-The variable `objects` would now be an array of hash objects.
-
 ### Custom Headers
 
 If our headers are not a perfect 1:1 match to our object, such as:
@@ -65,7 +73,7 @@ ID # | First Name | Date of Birth | Phone #
 
 Then we can explicitly map those as:
 
-````
+````ruby
 columns = [
   { field: :id,     header: 'ID #' },
   { field: :name,   header: 'First Name' },
@@ -78,7 +86,7 @@ columns = [
 
 Let's say we have the following data which we want to create a CSV from:
 
-````
+````ruby
 objects = [
   {
     id: 1,
@@ -94,7 +102,7 @@ objects = [
   },
   {
     id: 3,
-    name:     { first: 'Sam' },   
+    name:     { first: 'Sam' },
     demo:     { dob: '1932-12-12' },
     contact:  { phone: '333-333-3333' }
   }
@@ -111,7 +119,7 @@ ID # | First Name | Date of Birth | Phone #
 
 Using the following column config:
 
-````
+````ruby
 columns = [
   { field: :id,                 header: 'ID #' },
   { field: [:name, :first],     header: 'First Name' },
@@ -122,8 +130,8 @@ columns = [
 
 And executing the following:
 
-````
-csv = ::Bumblebee.generate_csv(columns, objects)
+````ruby
+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.
@@ -132,25 +140,25 @@ The above columns config would work both ways, so if we received the CSV, we cou
 
 You can also pass in functions that can do the value formatting.  For example:
 
-````
+````ruby
 columns = [
   {
     field: :id,
     header: 'ID #'
   },
   {
-    field: :name,   
-    header: 'First Name',     
+    field: :name,
+    header: 'First Name',
     to_csv: [:name, :first, ->(o) { o.to_s.upcase }]
   },
   {
-    field: :dob,    
-    header: 'Date of Birth',  
+    field: :dob,
+    header: 'Date of Birth',
     to_csv: [:demo, :dob]
   },
   {
-    field: :phone,  
-    header: 'Phone #',        
+    field: :phone,
+    header: 'Phone #',
     to_csv: [:contact, :phone]
   }
 ]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'bumblebee'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/lib/bumblebee/version.rb

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

data/spec/bumblebee/bumblebee_spec.rb

@@ -37,7 +37,7 @@ describe ::Bumblebee do
   let(:quoted_csv) { "\"name\",\"dob\"\n\"Matt\",\"1901-01-03\"\n\"Nathan\",\"1931-09-03\"\n" }
 
   it 'should generate a csv' do
-    actual = ::Bumblebee.generate_csv(columns, people)
+    actual = Bumblebee.generate_csv(columns, people)
 
     expect(actual).to eq(csv)
   end
@@ -53,7 +53,7 @@ describe ::Bumblebee do
   end
 
   it 'should parse a csv' do
-    objects = ::Bumblebee.parse_csv(columns, csv)
+    objects = Bumblebee.parse_csv(columns, csv)
 
     expect(objects).to eq(people)
   end
@@ -63,4 +63,38 @@ describe ::Bumblebee do
 
     expect(objects).to eq(people)
   end
+
+  describe 'README examples' do
+    let(:columns) do
+      [
+        { field: :id },
+        { field: :name },
+        { field: :dob },
+        { field: :phone }
+      ]
+    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
+    end
+  end
 end

data/spec/bumblebee/fixtures/simple_readme_example.csv

@@ -0,0 +1,4 @@
+id,name,dob,phone
+1,Matt,2/3/01,555-555-5555
+2,Nick,9/3/21,444-444-4444
+3,Sam,12/12/32,333-333-3333

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bumblebee
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-22 00:00:00.000000000 Z
+date: 2019-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_hashable
@@ -71,7 +71,8 @@ description: |2
       Even so, this library provides a very simple object/csv mapper that allows you to fully interact with CSVs in a declarative way.
 email:
 - mruggio@bluemarblepayroll.com
-executables: []
+executables:
+- console
 extensions: []
 extra_rdoc_files: []
 files:
@@ -85,6 +86,7 @@ files:
 - Guardfile
 - LICENSE
 - README.md
+- bin/console
 - bumblebee.gemspec
 - lib/bumblebee.rb
 - lib/bumblebee/bumblebee.rb
@@ -93,6 +95,7 @@ files:
 - lib/bumblebee/version.rb
 - spec/bumblebee/bumblebee_spec.rb
 - spec/bumblebee/column_spec.rb
+- spec/bumblebee/fixtures/simple_readme_example.csv
 - spec/spec_helper.rb
 homepage: https://github.com/bluemarblepayroll/bumblebee
 licenses:
@@ -120,4 +123,5 @@ summary: Object/CSV Mapper
 test_files:
 - spec/bumblebee/bumblebee_spec.rb
 - spec/bumblebee/column_spec.rb
+- spec/bumblebee/fixtures/simple_readme_example.csv
 - spec/spec_helper.rb