acts_as_hashable 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: aeda82e04843a1f805a0e056f3a1a988cf3fa624
-  data.tar.gz: 129e4222c77d0527b9932d36761a354b7e237f3f
+SHA256:
+  metadata.gz: 34122d00042ad3753c5f5535693e547883977104446605839d6193a45b64f8fb
+  data.tar.gz: 7f637e61431036291d0c83db0755a2e254e6a08a7847403ae76de976bfebbe88
 SHA512:
-  metadata.gz: 70e823f2d22dc978bdc537c6bf3f74163daa796db9035f6dd3afb49d30868974f475626d14d0e046d121428efb2acca4889771f03532bb73354c20391e23feb2
-  data.tar.gz: c5520831734e879970e1abea57eead97a92794345d8d0ac6c1fc40990ba9e641fef2b983b16aa7e438d1e43fb24bac2751dd8b9d29f4fad7f2f553b29500766e
+  metadata.gz: 9531ba6e0a23cdbdc7e32db6ee2b886e0177ab6b1a5f64b003f343556c1a5fa71b521181f9b7df1eec9175316ccb0931979663f26f0f20fd1df0a231aa1077cf
+  data.tar.gz: b53371ea96ea5ecc81668be3adf0cb6f9c380d3e82b351a535937174ea150067bcf6a9fa8db5e2663fcc9d0010703e41161b44f112b445aa3af853b1923066f8

data/.gitignore

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

data/.rubocop.yml

@@ -1,4 +1,11 @@
-inherit_from: .rubocop_todo.yml
-
 Metrics/LineLength:
   Max: 100
+
+Metrics/BlockLength:
+  ExcludedMethods: ['it', 'describe', 'context', 'let', 'specify']
+
+AllCops:
+  TargetRubyVersion: 2.3
+
+Style/RescueModifier:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-2.3.7
+2.6.0

data/.travis.yml

@@ -1,8 +1,20 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=830db02445429888fcdd7d1406dd82e9b32535e863ac54a538a162c0c4acd4d1
 language: ruby
 rvm:
-  - 2.3.1
-  - 2.3.7
+  # 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
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# 1.0.4 (January 30th, 2019)
+
+Maintenance Release
+
+* Added bin/console script
+* Added CHANGELOG
+* Updated README with publication steps, additional testing steps
+* Bumped minimum Ruby to 2.3.8
+* Added Guard

data/Gemfile.lock

@@ -1,19 +1,56 @@
 PATH
   remote: .
   specs:
-    acts_as_hashable (1.0.3)
+    acts_as_hashable (1.0.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ansi (1.5.0)
     ast (2.4.0)
+    coderay (1.1.2)
     diff-lcs (1.3)
-    jaro_winkler (1.5.1)
-    parallel (1.12.1)
-    parser (2.5.1.2)
+    docile (1.3.1)
+    ffi (1.10.0)
+    formatador (0.2.5)
+    guard (2.15.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    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)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.13)
+    method_source (0.9.2)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.13.0)
+    parser (2.6.0.0)
       ast (~> 2.4.0)
     powerpack (0.1.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
     rainbow (3.0.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -27,24 +64,39 @@ 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)
-    unicode-display_width (1.4.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.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   acts_as_hashable!
+  guard-rspec (~> 4.7)
   rspec
-  rubocop (~> 0.59.2)
+  rubocop (~> 0.63.1)
+  simplecov (~> 0.16.1)
+  simplecov-console (~> 0.4.2)
 
 BUNDLED WITH
-   1.16.3
+   1.17.2

data/Guardfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/README.md

@@ -1,8 +1,8 @@
 # Acts as Hashable
 
-[![Build Status](https://travis-ci.org/bluemarblepayroll/acts_as_hashable.svg?branch=master)](https://travis-ci.org/bluemarblepayroll/acts_as_hashable)
+[![Gem Version](https://badge.fury.io/rb/acts_as_hashable.svg)](https://badge.fury.io/rb/acts_as_hashable) [![Build Status](https://travis-ci.org/bluemarblepayroll/acts_as_hashable.svg?branch=master)](https://travis-ci.org/bluemarblepayroll/acts_as_hashable) [![Maintainability](https://api.codeclimate.com/v1/badges/647dac37b9a8177f3d84/maintainability)](https://codeclimate.com/github/bluemarblepayroll/acts_as_hashable/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/647dac37b9a8177f3d84/test_coverage)](https://codeclimate.com/github/bluemarblepayroll/acts_as_hashable/test_coverage)
 
-This is a small library that helps increase the pliability of object constructor signatures.  
+This is a small library that helps increase the pliability of object constructor signatures.
 Instead of instantiating via the constructor, this library can install helper factory
 class-level methods that you can use with hashes:
 
@@ -10,7 +10,7 @@ class-level methods that you can use with hashes:
 * array(): create an array of instances of a class
 
 One caveat to this library is that it is not meant to be a complete modeling solution but rather
-just a tool that helps model a domain or complete a modeling framework.  
+just a tool that helps model a domain or complete a modeling framework.
 The main missing element to this library is that you still have to manage and implement constructors.
 The two class-level factory methods are just meant to create a syntactic hash-like interface.
 
@@ -142,9 +142,37 @@ Basic steps to take to get this repository compiling:
 To execute the test suite run:
 
 ````
-rspec spec --format documentation
+bundle exec rspec spec --format documentation
 ````
 
+Alternatively, you can have Guard watch for changes:
+
+````
+bundle exec guard
+````
+
+Also, do not forget to run Rubocop:
+
+````
+bundle exec rubocop
+````
+
+### Publishing
+
+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/acts_as_hashable/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 acts_as_hashable`
+7. Publish package to RubyGems: `gem push acts_as_hashable-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`
+
 ## License
 
 This project is MIT Licensed.

data/acts_as_hashable.gemspec

@@ -21,8 +21,11 @@ Gem::Specification.new do |s|
   s.homepage    = 'https://github.com/bluemarblepayroll/acts_as_hashable'
   s.license     = 'MIT'
 
-  s.required_ruby_version = '>= 2.3.1'
+  s.required_ruby_version = '>= 2.3.8'
 
+  s.add_development_dependency('guard-rspec', '~>4.7')
   s.add_development_dependency('rspec')
-  s.add_development_dependency('rubocop', '~> 0.59.2')
+  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/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'acts_as_hashable'
+
+# 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/acts_as_hashable/hashable.rb

@@ -11,24 +11,44 @@ module ActsAsHashable
   # This class contains the main set of class-level methods that can be used by
   # hashable classes.
   module Hashable
+    HASHABLE_HYDRATORS = [
+      {
+        condition: ->(_context, object, _nullable) { object.is_a?(Hash) },
+        converter: lambda do |context, object, _nullable|
+          context.new(**::ActsAsHashable::Utilities.symbolize_keys(object))
+        end
+      },
+      {
+        condition: ->(context, object, _nullable) { object.is_a?(context) },
+        converter: ->(_context, object, _nullable) { object }
+      },
+      {
+        condition: ->(_context, object, nullable) { object.nil? && nullable },
+        converter: ->(_context, _object, _nullable) { nil }
+      },
+      {
+        condition: ->(_context, object, nullable) { object.nil? && !nullable },
+        converter: ->(context, _object, _nullable) { context.new }
+      }
+    ].freeze
+
+    private_constant :HASHABLE_HYDRATORS
+
     def array(object, nullable: true)
       objects = object.is_a?(Hash) ? [object] : Array(object)
 
-      objects.select { |o| !!o }.map { |o| make(o, nullable: nullable) }
+      objects.reject { |o| o == false || o.nil? }
+             .map { |o| make(o, nullable: nullable) }
     end
 
     def make(object, nullable: true)
-      if object.is_a?(Hash)
-        new(**::ActsAsHashable::Utilities.symbolize_keys(object))
-      elsif object.is_a?(self)
-        object
-      elsif object.nil? && nullable
-        nil
-      elsif object.nil? && !nullable
-        new
-      else
-        raise "Cannot create hashable object with class name: #{object.class.name}"
+      HASHABLE_HYDRATORS.each do |hydrator|
+        if hydrator[:condition].call(self, object, nullable)
+          return hydrator[:converter].call(self, object, nullable)
+        end
       end
+
+      raise ArgumentError, "Cannot create hashable object with class name: #{object.class.name}"
     end
   end
 end

data/lib/acts_as_hashable/version.rb

@@ -8,5 +8,5 @@
 #
 
 module ActsAsHashable
-  VERSION = '1.0.3'
+  VERSION = '1.0.4'
 end

data/spec/acts_as_hashable_spec.rb

@@ -7,12 +7,52 @@
 # LICENSE file in the root directory of this source tree.
 #
 
-require './lib/acts_as_hashable'
-require './spec/examples'
+require './spec/spec_helper'
 
 describe ActsAsHashable do
   context '#make' do
+    context 'when passing in unacceptable input' do
+      it 'should raise ArgumentError for number' do
+        expect { Pet.make(1) }.to raise_error(ArgumentError)
+      end
+
+      it 'should raise ArgumentError for string' do
+        expect { Pet.make('') }.to raise_error(ArgumentError)
+      end
+
+      it 'should raise ArgumentError for true' do
+        expect { Pet.make(true) }.to raise_error(ArgumentError)
+      end
+
+      it 'should raise ArgumentError for array' do
+        expect { Pet.make([]) }.to raise_error(ArgumentError)
+      end
+    end
+
     context 'with a hash constructor interface' do
+      it 'should properly return object if object is already the same type' do
+        original_pet_obj = Pet.new
+        pet_obj = Pet.make(original_pet_obj)
+
+        expect(pet_obj.hash).to eq(original_pet_obj.hash)
+        expect(pet_obj.name).to be nil
+        expect(pet_obj.toy).to be nil
+      end
+
+      it 'should properly return hydrated object if nil is passed in and is not nullable' do
+        pet_obj = Pet.make(nil, nullable: false)
+
+        expect(pet_obj.name).to be nil
+        expect(pet_obj.toy).to be nil
+      end
+
+      it 'should properly return nil if nil is passed in and is nullable' do
+        pet_obj = Pet.make(nil, nullable: false)
+
+        expect(pet_obj.name).to be nil
+        expect(pet_obj.toy).to be nil
+      end
+
       it 'should properly instantiate objects from a symbol-keyed hash' do
         pet = {
           name: 'Doug the dog',
@@ -31,11 +71,11 @@ describe ActsAsHashable do
         head_of_household = {
           person: {
             name: 'Matt',
-            age:  109
+            age: 109
           },
           partner: {
             name: 'Katie',
-            age:  110
+            age: 110
           }
         }
 
@@ -47,15 +87,15 @@ describe ActsAsHashable do
         expect(head_of_household_obj.partner.age).to eq(110)
       end
 
-      it 'should properly instantiate objects from symbol-keyed hash' do
+      it 'should properly instantiate objects from string-keyed hash' do
         head_of_household = {
-          'person'  => {
-            'name'  => 'Matt',
-            'age'   => 109
+          'person' => {
+            'name' => 'Matt',
+            'age' => 109
           },
           'partner' => {
-            'name'  => 'Katie',
-            'age'   =>  110
+            'name' => 'Katie',
+            'age' => 110
           }
         }
 
@@ -71,11 +111,11 @@ describe ActsAsHashable do
         head_of_household = {
           person: {
             # name: 'Matt',
-            age:  109
+            age: 109
           },
           partner: {
             name: 'Katie',
-            age:  110
+            age: 110
           }
         }
 
@@ -86,12 +126,12 @@ describe ActsAsHashable do
         head_of_household = {
           person: {
             name: 'Matt',
-            age:  109,
+            age: 109,
             height_in_inches: 700
           },
           partner: {
             name: 'Katie',
-            age:  110
+            age: 110
           }
         }
 
@@ -105,11 +145,11 @@ describe ActsAsHashable do
           head_of_household: {
             person: {
               name: 'Matt',
-              age:  109
+              age: 109
             },
             partner: {
               name: 'Katie',
-              age:  110
+              age: 110
             }
           },
           children: [
@@ -137,11 +177,11 @@ describe ActsAsHashable do
           head_of_household: {
             person: {
               name: 'Matt',
-              age:  109
+              age: 109
             },
             partner: {
               name: 'Katie',
-              age:  110
+              age: 110
             }
           },
           children: { name: 'Martin', age: 29 }

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2018-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'simplecov'
+require 'simplecov-console'
+SimpleCov.formatter = SimpleCov::Formatter::Console
+SimpleCov.start
+
+require './lib/acts_as_hashable'
+require './spec/examples'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_hashable
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-28 00:00:00.000000000 Z
+date: 2019-02-04 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -30,35 +44,66 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.59.2
+        version: 0.63.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        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.59.2
+        version: 0.4.2
 description: |2
       This is a small library that helps increase the pliability of object constructor signatures.
       Instead of instantiating via the constructor, this library can install helper factory
       class-level methods that you can use with hashes.
 email:
 - mruggio@bluemarblepayroll.com
-executables: []
+executables:
+- console
 extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
 - ".gitignore"
 - ".rubocop.yml"
-- ".rubocop_todo.yml"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
+- Guardfile
 - LICENSE
 - README.md
 - acts_as_hashable.gemspec
+- bin/console
 - lib/acts_as_hashable.rb
 - lib/acts_as_hashable/acts_as_hashable.rb
 - lib/acts_as_hashable/hashable.rb
@@ -66,6 +111,7 @@ files:
 - lib/acts_as_hashable/version.rb
 - spec/acts_as_hashable_spec.rb
 - spec/examples.rb
+- spec/spec_helper.rb
 homepage: https://github.com/bluemarblepayroll/acts_as_hashable
 licenses:
 - MIT
@@ -78,18 +124,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.1
+      version: 2.3.8
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Simple hash-based factory methods for objects.
 test_files:
 - spec/acts_as_hashable_spec.rb
 - spec/examples.rb
+- spec/spec_helper.rb

data/.rubocop_todo.yml

@@ -1,50 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2018-09-27 15:44:50 -0500 using RuboCop version 0.59.2.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 5
-# Configuration parameters: CountComments, ExcludedMethods.
-# ExcludedMethods: refine
-Metrics/BlockLength:
-  Max: 128
-
-# Offense count: 1
-Metrics/CyclomaticComplexity:
-  Max: 7
-
-# Offense count: 1
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
-# URISchemes: http, https
-Metrics/LineLength:
-  Max: 105
-
-# Offense count: 1
-# Configuration parameters: CountComments, ExcludedMethods.
-Metrics/MethodLength:
-  Max: 11
-
-# Offense count: 1
-Metrics/PerceivedComplexity:
-  Max: 8
-
-# Offense count: 1
-Style/DoubleNegation:
-  Exclude:
-    - 'lib/acts_as_hashable/hashable.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: InverseMethods, InverseBlocks.
-Style/InverseMethods:
-  Exclude:
-    - 'lib/acts_as_hashable/hashable.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/RescueModifier:
-  Exclude:
-    - 'lib/acts_as_hashable/utilities.rb'