acts_as_hashable 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 217324e6b005f92191c5cef6ea14dadc12defe0d
-  data.tar.gz: a1bb063e19bfc8b0a3ca0f88b70abad248874ccb
+  metadata.gz: aeda82e04843a1f805a0e056f3a1a988cf3fa624
+  data.tar.gz: 129e4222c77d0527b9932d36761a354b7e237f3f
 SHA512:
-  metadata.gz: 33170c36d1877dd1bbd66a750ed8411cc79a7e4f9d78af9b69e0f058115ee105a7652f6a4eede7a7052949be257110be449f6c1d2308d90dfb0363c5802eddd3
-  data.tar.gz: 279f2504eb4139cd5d5c4eb3f92b0bf72f85be84bc8a005a55cebcc76f2b453553be2dc376033cc2e186d3719d43c86dff21b6e9cf5035c5296a6f1a68d72414
+  metadata.gz: 70e823f2d22dc978bdc537c6bf3f74163daa796db9035f6dd3afb49d30868974f475626d14d0e046d121428efb2acca4889771f03532bb73354c20391e23feb2
+  data.tar.gz: c5520831734e879970e1abea57eead97a92794345d8d0ac6c1fc40990ba9e641fef2b983b16aa7e438d1e43fb24bac2751dd8b9d29f4fad7f2f553b29500766e

data/.rubocop.yml

@@ -0,0 +1,4 @@
+inherit_from: .rubocop_todo.yml
+
+Metrics/LineLength:
+  Max: 100

data/.rubocop_todo.yml

@@ -0,0 +1,50 @@
+# 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'

data/.travis.yml

@@ -4,4 +4,5 @@ rvm:
   - 2.3.7
 cache: bundler
 script:
+  - bundle exec rubocop
   - bundle exec rspec

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

data/Gemfile.lock

@@ -1,12 +1,19 @@
 PATH
   remote: .
   specs:
-    acts_as_hashable (1.0.2)
+    acts_as_hashable (1.0.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.0)
     diff-lcs (1.3)
+    jaro_winkler (1.5.1)
+    parallel (1.12.1)
+    parser (2.5.1.2)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    rainbow (3.0.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -20,6 +27,16 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
+    rubocop (0.59.2)
+      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)
+    ruby-progressbar (1.10.0)
+    unicode-display_width (1.4.0)
 
 PLATFORMS
   ruby
@@ -27,6 +44,7 @@ PLATFORMS
 DEPENDENCIES
   acts_as_hashable!
   rspec
+  rubocop (~> 0.59.2)
 
 BUNDLED WITH
    1.16.3

data/acts_as_hashable.gemspec

@@ -1,25 +1,28 @@
-require "./lib/acts_as_hashable/version"
+# frozen_string_literal: true
+
+require './lib/acts_as_hashable/version'
 
 Gem::Specification.new do |s|
   s.name        = 'acts_as_hashable'
   s.version     = ActsAsHashable::VERSION
-  s.summary     = "Simple hash-based factory methods for objects."
+  s.summary     = 'Simple hash-based factory methods for objects.'
 
-  s.description = <<-EOS
+  s.description = <<-DESCRIPTION
     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.
-  EOS
+  DESCRIPTION
 
-  s.authors     = [ 'Matthew Ruggio' ]
-  s.email       = [ 'mruggio@bluemarblepayroll.com' ]
+  s.authors     = ['Matthew Ruggio']
+  s.email       = ['mruggio@bluemarblepayroll.com']
   s.files       = `git ls-files`.split("\n")
   s.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.homepage    = 'https://github.com/bluemarblepayroll/acts_as_hashable'
   s.license     = 'MIT'
 
   s.required_ruby_version = '>= 2.3.1'
 
   s.add_development_dependency('rspec')
+  s.add_development_dependency('rubocop', '~> 0.59.2')
 end

data/lib/acts_as_hashable/acts_as_hashable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Copyright (c) 2018-present, Blue Marble Payroll, LLC
 #
@@ -9,6 +11,7 @@ require_relative 'utilities'
 require_relative 'hashable'
 
 module ActsAsHashable
+  # This module adds the class-level method that marks a class as hashable.
   module DslHook
     def acts_as_hashable
       extend ::ActsAsHashable::Hashable

data/lib/acts_as_hashable/hashable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Copyright (c) 2018-present, Blue Marble Payroll, LLC
 #
@@ -6,31 +8,27 @@
 #
 
 module ActsAsHashable
+  # This class contains the main set of class-level methods that can be used by
+  # hashable classes.
   module Hashable
-
     def array(object, nullable: true)
-      if object.is_a?(Hash)
-        objects = [ object ]
-      else
-        objects = Array(object)
-      end
+      objects = object.is_a?(Hash) ? [object] : Array(object)
 
       objects.select { |o| !!o }.map { |o| make(o, nullable: nullable) }
     end
 
     def make(object, nullable: true)
       if object.is_a?(Hash)
-        self.new(**::ActsAsHashable::Utilities.symbolize_keys(object))
+        new(**::ActsAsHashable::Utilities.symbolize_keys(object))
       elsif object.is_a?(self)
         object
       elsif object.nil? && nullable
         nil
       elsif object.nil? && !nullable
-        self.new
+        new
       else
         raise "Cannot create hashable object with class name: #{object.class.name}"
       end
     end
-
   end
 end

data/lib/acts_as_hashable/utilities.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Copyright (c) 2018-present, Blue Marble Payroll, LLC
 #
@@ -6,9 +8,10 @@
 #
 
 module ActsAsHashable
+  # Some extra functions that are either ancillary to the main domain or polyfill other
+  # mainstream imnplementations.
   class Utilities
     class << self
-
       # https://apidock.com/rails/Hash/symbolize_keys
       def symbolize_keys(hash)
         transform_keys(hash) { |key| key.to_sym rescue key }
@@ -26,7 +29,6 @@ module ActsAsHashable
 
         result
       end
-
     end
   end
 end

data/lib/acts_as_hashable/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Copyright (c) 2018-present, Blue Marble Payroll, LLC
 #
@@ -6,5 +8,5 @@
 #
 
 module ActsAsHashable
-  VERSION = "1.0.2"
+  VERSION = '1.0.3'
 end

data/lib/acts_as_hashable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Copyright (c) 2018-present, Blue Marble Payroll, LLC
 #

data/spec/acts_as_hashable_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # Copyright (c) 2018-present, Blue Marble Payroll, LLC
 #
@@ -6,68 +8,12 @@
 #
 
 require './lib/acts_as_hashable'
-
-class Toy
-  acts_as_hashable
-
-  attr_reader :squishy
-
-  def initialize(opts = {})
-    @squishy = opts[:squishy] || false
-  end
-end
-
-class Pet
-  acts_as_hashable
-
-  attr_reader :name, :toy
-
-  def initialize(opts = {})
-    @name = opts[:name]
-    @toy  = Toy.make(opts[:toy])
-  end
-end
-
-class Person
-  acts_as_hashable
-
-  attr_reader :name, :age
-
-  def initialize(name:, age:)
-    @name = name
-    @age  = age
-  end
-end
-
-class HeadOfHousehold
-  acts_as_hashable
-
-  attr_reader :person, :partner
-
-  def initialize(person:, partner: nil)
-    @person   = Person.make(person)
-    @partner  = Person.make(partner)
-  end
-end
-
-class Family
-  acts_as_hashable
-
-  attr_reader :head_of_household, :children
-
-  def initialize(head_of_household:, children: [])
-    @head_of_household  = HeadOfHousehold.make(head_of_household)
-    @children           = Person.array(children)
-  end
-end
+require './spec/examples'
 
 describe ActsAsHashable do
   context '#make' do
-
     context 'with a hash constructor interface' do
-
       it 'should properly instantiate objects from a symbol-keyed hash' do
-
         pet = {
           name: 'Doug the dog',
           toy: { squishy: true }
@@ -78,20 +24,18 @@ describe ActsAsHashable do
         expect(pet_obj.name).to eq('Doug the dog')
         expect(pet_obj.toy.squishy).to be true
       end
-
     end
 
     context 'with keyword arguments interface' do
-
       it 'should properly instantiate objects from symbol-keyed hash' do
         head_of_household = {
           person: {
             name: 'Matt',
-            age:  109,
+            age:  109
           },
           partner: {
             name: 'Katie',
-            age:  110,
+            age:  110
           }
         }
 
@@ -107,11 +51,11 @@ describe ActsAsHashable do
         head_of_household = {
           'person'  => {
             'name'  => 'Matt',
-            'age'   => 109,
+            'age'   => 109
           },
           'partner' => {
             'name'  => 'Katie',
-            'age'   =>  110,
+            'age'   =>  110
           }
         }
 
@@ -127,11 +71,11 @@ describe ActsAsHashable do
         head_of_household = {
           person: {
             # name: 'Matt',
-            age:  109,
+            age:  109
           },
           partner: {
             name: 'Katie',
-            age:  110,
+            age:  110
           }
         }
 
@@ -143,36 +87,34 @@ describe ActsAsHashable do
           person: {
             name: 'Matt',
             age:  109,
-            height_in_inches: 700,
+            height_in_inches: 700
           },
           partner: {
             name: 'Katie',
-            age:  110,
+            age:  110
           }
         }
 
         expect { HeadOfHousehold.make(head_of_household) }.to raise_error(ArgumentError)
       end
-
     end
 
     context '#array' do
-
-      it 'should properly instantiate objects and arrays of objects from symbol-keyed hash and arrays' do
+      it 'should properly create objects and arrays of objects from symbol-keyed hash and arrays' do
         family = {
           head_of_household: {
             person: {
               name: 'Matt',
-              age:  109,
+              age:  109
             },
             partner: {
               name: 'Katie',
-              age:  110,
+              age:  110
             }
           },
           children: [
             { name: 'Martin', age: 29 },
-            { name: 'Short',  age: 99 },
+            { name: 'Short',  age: 99 }
           ]
         }
 
@@ -195,11 +137,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 }
@@ -216,7 +158,6 @@ describe ActsAsHashable do
         expect(family_obj.children[0].name).to eq('Martin')
         expect(family_obj.children[0].age).to  eq(29)
       end
-
     end
   end
 end

data/spec/examples.rb

@@ -0,0 +1,62 @@
+# 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.
+#
+
+class Toy
+  acts_as_hashable
+
+  attr_reader :squishy
+
+  def initialize(opts = {})
+    @squishy = opts[:squishy] || false
+  end
+end
+
+class Pet
+  acts_as_hashable
+
+  attr_reader :name, :toy
+
+  def initialize(opts = {})
+    @name = opts[:name]
+    @toy  = Toy.make(opts[:toy])
+  end
+end
+
+class Person
+  acts_as_hashable
+
+  attr_reader :name, :age
+
+  def initialize(name:, age:)
+    @name = name
+    @age  = age
+  end
+end
+
+class HeadOfHousehold
+  acts_as_hashable
+
+  attr_reader :person, :partner
+
+  def initialize(person:, partner: nil)
+    @person   = Person.make(person)
+    @partner  = Person.make(partner)
+  end
+end
+
+class Family
+  acts_as_hashable
+
+  attr_reader :head_of_household, :children
+
+  def initialize(head_of_household:, children: [])
+    @head_of_household  = HeadOfHousehold.make(head_of_household)
+    @children           = Person.array(children)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_hashable
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-27 00:00:00.000000000 Z
+date: 2018-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.59.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.59.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
@@ -36,6 +50,8 @@ extra_rdoc_files: []
 files:
 - ".editorconfig"
 - ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".ruby-version"
 - ".travis.yml"
 - Gemfile
@@ -49,6 +65,7 @@ files:
 - lib/acts_as_hashable/utilities.rb
 - lib/acts_as_hashable/version.rb
 - spec/acts_as_hashable_spec.rb
+- spec/examples.rb
 homepage: https://github.com/bluemarblepayroll/acts_as_hashable
 licenses:
 - MIT
@@ -75,3 +92,4 @@ specification_version: 4
 summary: Simple hash-based factory methods for objects.
 test_files:
 - spec/acts_as_hashable_spec.rb
+- spec/examples.rb