acts_as_hashable 1.0.5 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff6ee1d4bdac43f6841c65d7d4621e9a02dbcfa5abd1284d9f7de45f8da91810
-  data.tar.gz: 1677ea47f8beee3825a42c03bf49596e1a803b0940e5c405a254112a07f9b3f1
+  metadata.gz: f5f83e22faa7ed0b0ff1d37038a51dcb92b5bbf07e2ae4e0256091d5954da642
+  data.tar.gz: 7c6d956f731420f46a1c924a6e7c8f2213aede31fb6f90ec397b734482eeb806
 SHA512:
-  metadata.gz: 3080003d4ee62018ac67e47b5ed03c417526e3ccb3061321cdfbf4b838f4f722ac17b88f9e9496deb810f34b7df05f949b64dfc6de4699b5de2927b14f5c3dc6
-  data.tar.gz: 1766f6ab2413d21543762de7768910b51c13b69022fb3b3973405845a8e308f843a7cb8b2c5d82bde14a507c7177ce99b32e2cac05cc519912cbaf66c3477711
+  metadata.gz: 67ac75655f768375a9148cb86b51d9e39ab2071376a6480d03d33d93a289fb745fa18cb74ec55e31e16e729a86ae5c3e4d79d71314da44c80d8e0bfc324252ea
+  data.tar.gz: ba7c1cbcbc7c1a538c7d8b7d9905f9f9a581cba4264339f5d1e41497128c3d512e817046b87c2964b44230997203bd2d138684732604bfd289c6c6230dd6c398

data/.gitignore

@@ -2,3 +2,5 @@
 *.gem
 /tmp
 /coverage
+/pkg
+Gemfile.lock

data/.rubocop.yml

@@ -3,9 +3,11 @@ Metrics/LineLength:
 
 Metrics/BlockLength:
   ExcludedMethods: ['it', 'describe', 'context', 'let', 'specify']
+  Exclude:
+    - acts_as_hashable.gemspec
 
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.5
 
 Style/RescueModifier:
   Enabled: false

data/.ruby-version

@@ -1 +1 @@
-2.6.0
+2.6.6

data/.travis.yml

@@ -4,10 +4,9 @@ env:
 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
+  - 2.5.8
+  - 2.6.6
+  - 2.7.1
 cache: bundler
 before_script:
   - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
@@ -18,3 +17,8 @@ script:
   - bundle exec rspec
 after_script:
   - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+addons:
+  # https://docs.travis-ci.com/user/uploading-artifacts/
+  artifacts:
+    paths:
+      - Gemfile.lock

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# 1.2.0 (June 9th, 2020)
+
+* Bumped minimum Ruby version to >= 2.5
+* Do not pass in any constructor arguments unless we have at least one key.
+* Add more detail to construction errors.
+
+# 1.1.0 (May 3rd, 2019)
+
+* Added acts_as_hashable_factory to dynamically create objects.
+
 # 1.0.5 (February 5th, 2019)
 
 * Fixed equality bug in array reject block.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at oss@bluemarblepayroll.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Guardfile

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-guard :rspec, cmd: 'bundle exec rspec' do
+guard :rspec, cmd: 'DISABLE_SIMPLECOV=true bundle exec rspec --format=documentation' do
   require 'guard/rspec/dsl'
   dsl = Guard::RSpec::Dsl.new(self)
 

data/README.md

@@ -30,6 +30,8 @@ bundle add acts_as_hashable
 
 ## Examples
 
+### Utilizing Classes on Hashabled Classes
+
 Consider the following example:
 
 ````
@@ -125,6 +127,76 @@ class Pet
 end
 ````
 
+### Dynamic Factory Building
+
+More complex relationships may contain objects with disparate types.  In this case we can use the included factory
+pattern to help us build these.  Based on our examples above:
+
+```ruby
+class ExampleFactory
+  acts_as_hashable_factory
+
+  register 'Pet', Pet
+
+  register 'HeadOfHousehold', HeadOfHousehold
+end
+```
+
+Now we can dynamically build these using:
+
+```ruby
+objects = [
+  {
+    type: 'Pet',
+    name: 'Doug the dog',
+    toy: { squishy: true }
+  },
+  {
+    type: 'HeadOfHousehold',
+    person: {
+      name: 'Matt',
+      age: 109
+    },
+    partner: {
+      name: 'Katie',
+      age: 110
+    }
+  }
+]
+
+hydrated_objects = ExampleFactory.array(objects)
+```
+
+If the type key does not happen to be `type` then you can explicitly set this as:
+
+```ruby
+class ExampleFactory
+  acts_as_hashable_factory
+
+  type_key 'object_type'
+
+  register 'Pet', Pet
+
+  register 'HeadOfHousehold', HeadOfHousehold
+end
+```
+
+You can also choose to pass in a proc/lambda instead of a class constant:
+
+```ruby
+class ExampleFactory
+  acts_as_hashable_factory
+
+  type_key 'object_type'
+
+  register 'Pet', Pet
+
+  register 'HeadOfHousehold', ->(_key) { HeadOfHousehold }
+end
+```
+
+In case you need full control of the registry you can also choose to simply override the class-level `registry` method which will simply return a hash of keys (names) and values (class constants).
+
 ## Contributing
 
 ### Development Environment Configuration
@@ -168,10 +240,11 @@ After code changes have successfully gone through the Pull Request review proces
 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`
+6. Run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Code of Conduct
+
+Everyone interacting in this codebase, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/bluemarblepayroll/acts_as_hashable/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: %i[rubocop spec]

data/acts_as_hashable.gemspec

@@ -14,16 +14,28 @@ Gem::Specification.new do |s|
   DESCRIPTION
 
   s.authors     = ['Matthew Ruggio']
+  s.bindir      = 'exe'
   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 = []
+  s.files       = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   s.homepage    = 'https://github.com/bluemarblepayroll/acts_as_hashable'
   s.license     = 'MIT'
+  s.metadata    = {
+    'bug_tracker_uri' => 'https://github.com/bluemarblepayroll/acts_as_hashable/issues',
+    'changelog_uri' => 'https://github.com/bluemarblepayroll/acts_as_hashable/blob/master/CHANGELOG.md',
+    'documentation_uri' => 'https://www.rubydoc.info/gems/acts_as_hashable',
+    'homepage_uri' => s.homepage,
+    'source_code_uri' => s.homepage
+  }
 
-  s.required_ruby_version = '>= 2.3.8'
+  s.required_ruby_version = '>= 2.5'
+
+  s.add_dependency('caution', '~>1')
 
   s.add_development_dependency('guard-rspec', '~>4.7')
+  s.add_development_dependency('pry')
+  s.add_development_dependency('pry-byebug', '~> 3')
+  s.add_development_dependency('rake', '~> 13.0')
   s.add_development_dependency('rspec')
   s.add_development_dependency('rubocop', '~> 0.63.1')
   s.add_development_dependency('simplecov', '~>0.16.1')

data/bin/console

@@ -7,9 +7,5 @@ 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
+require 'pry'
+Pry.start

data/lib/acts_as_hashable.rb

@@ -7,4 +7,27 @@
 # LICENSE file in the root directory of this source tree.
 #
 
-require_relative 'acts_as_hashable/acts_as_hashable'
+require 'caution'
+require 'forwardable'
+
+require_relative 'acts_as_hashable/factory'
+require_relative 'acts_as_hashable/hash_refinements'
+require_relative 'acts_as_hashable/type_factory'
+require_relative 'acts_as_hashable/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
+    end
+
+    def acts_as_hashable_factory
+      extend ActsAsHashable::Factory
+    end
+  end
+end
+
+Object.class_eval do
+  extend ::ActsAsHashable::DslHook
+end

data/lib/acts_as_hashable/factory.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-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.
+#
+
+module ActsAsHashable
+  # This class serves as a singleton that can make mapped acts_as_hashable components.
+  # It is important to note that these components *must* be acts_as_hashable objects.
+  # In order to use you just have to subclass this class and implement
+  # a method called 'registry', such as:
+  #   def registry
+  #     {
+  #       'Table': Table,
+  #       'Text': Text
+  #     }
+  #   end
+  # You can also use the 'register' DSL:
+  #   register 'some_class_name', SomeClassName
+  #   register 'some_class_name', '', SomeClassName
+  # or:
+  #   register 'some_class_name', ->(_key) { SomeClassName }
+  module Factory
+    extend Forwardable
+
+    def_delegators :factory, :array, :make
+
+    def register(*args)
+      raise ArgumentError, "missing at least one key and value: #{args}" if args.length < 2
+
+      value = args.last
+
+      args[0..-2].each do |key|
+        registry[key] = value
+      end
+    end
+
+    def registry
+      @registry ||= {}
+    end
+
+    def materialize_registry
+      @registry.map do |k, v|
+        value = v.is_a?(Proc) ? v.call(k) : v
+        [k, value]
+      end.to_h
+    end
+
+    def type_key(key)
+      @typed_with = key
+    end
+
+    def typed_with
+      @typed_with || TypeFactory::DEFAULT_TYPE_KEY
+    end
+
+    private
+
+    def factory
+      @factory ||= TypeFactory.new(materialize_registry, typed_with)
+    end
+  end
+end

data/lib/acts_as_hashable/hash_refinements.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-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.
+#
+
+module ActsAsHashable
+  # Let's provide a refinenment instead of monkey-patching Hash.  That way we can stop
+  # polluting other libraries and internalize our specific needs.
+  module HashRefinements
+    refine Hash do
+      def symbolize_keys
+        map { |k, v| [k.to_sym, v] }.to_h
+      end
+    end
+  end
+end

data/lib/acts_as_hashable/hashable.rb

@@ -11,11 +11,21 @@ module ActsAsHashable
   # This class contains the main set of class-level methods that can be used by
   # hashable classes.
   module Hashable
+    using HashRefinements
+
+    class HydrationError < Caution::CauseInjectingError; end
+
     HASHABLE_HYDRATORS = [
       {
         condition: ->(_context, object, _nullable) { object.is_a?(Hash) },
         converter: lambda do |context, object, _nullable|
-          context.new(**::ActsAsHashable::Utilities.symbolize_keys(object))
+          args = (object || {}).symbolize_keys
+
+          if args.keys.any?
+            context.new(**args)
+          else
+            context.new
+          end
         end
       },
       {
@@ -43,12 +53,20 @@ module ActsAsHashable
 
     def make(object, nullable: true)
       HASHABLE_HYDRATORS.each do |hydrator|
-        if hydrator[:condition].call(self, object, nullable)
-          return hydrator[:converter].call(self, object, nullable)
-        end
+        next unless hydrator[:condition].call(self, object, nullable)
+
+        return hydrate(hydrator, object, nullable)
       end
 
       raise ArgumentError, "Cannot create hashable object with class name: #{object.class.name}"
     end
+
+    private
+
+    def hydrate(hydrator, object, nullable)
+      hydrator[:converter].call(self, object, nullable)
+    rescue ArgumentError
+      raise HydrationError, "#{name} cannot be hydrated using arguments: #{object}"
+    end
   end
 end

data/lib/acts_as_hashable/type_factory.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-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.
+#
+
+module ActsAsHashable
+  # A TypeFactory object understands how to build objects using a special designated 'type' key.
+  class TypeFactory
+    using HashRefinements
+
+    DEFAULT_TYPE_KEY = :type
+
+    attr_reader :registry, :type_key
+
+    def initialize(registry = {}, type_key = DEFAULT_TYPE_KEY)
+      @registry = registry.symbolize_keys
+      @type_key = type_key.to_s.to_sym
+
+      freeze
+    end
+
+    def array(objects = [])
+      objects = objects.is_a?(Hash) ? [objects] : Array(objects)
+
+      objects.map do |object|
+        object.is_a?(Hash) ? make(object) : object
+      end
+    end
+
+    def make(config = {})
+      config        = (config || {}).symbolize_keys
+      type          = config[type_key].to_s.to_sym
+      object_class  = registry[type]
+
+      raise ArgumentError, "cannot find registration for: '#{type}'" unless object_class
+
+      config_without_type = config.reject { |k| k == type_key }
+
+      # We want to defer to the classes proper maker if it exists.
+      # Technically, this factory should only make classes that include Hashable, but just to be
+      # sure we do not break any existing compatibility, lets make it work for both.
+      method_name = object_class.respond_to?(:make) ? :make : :new
+
+      object_class.send(method_name, config_without_type)
+    end
+  end
+end

data/lib/acts_as_hashable/version.rb

@@ -8,5 +8,5 @@
 #
 
 module ActsAsHashable
-  VERSION = '1.0.5'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_hashable
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.2.0
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2019-02-05 00:00:00.000000000 Z
+date: 2020-06-09 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: caution
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +38,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -86,8 +142,7 @@ description: |2
       class-level methods that you can use with hashes.
 email:
 - mruggio@bluemarblepayroll.com
-executables:
-- console
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
@@ -97,25 +152,30 @@ files:
 - ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - Guardfile
 - LICENSE
 - README.md
+- Rakefile
 - acts_as_hashable.gemspec
 - bin/console
+- exe/.gitkeep
 - lib/acts_as_hashable.rb
-- lib/acts_as_hashable/acts_as_hashable.rb
+- lib/acts_as_hashable/factory.rb
+- lib/acts_as_hashable/hash_refinements.rb
 - lib/acts_as_hashable/hashable.rb
-- lib/acts_as_hashable/utilities.rb
+- lib/acts_as_hashable/type_factory.rb
 - 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
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/bluemarblepayroll/acts_as_hashable/issues
+  changelog_uri: https://github.com/bluemarblepayroll/acts_as_hashable/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/acts_as_hashable
+  homepage_uri: https://github.com/bluemarblepayroll/acts_as_hashable
+  source_code_uri: https://github.com/bluemarblepayroll/acts_as_hashable
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -124,18 +184,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.8
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 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
+test_files: []

data/Gemfile.lock

@@ -1,102 +0,0 @@
-PATH
-  remote: .
-  specs:
-    acts_as_hashable (1.0.5)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ansi (1.5.0)
-    ast (2.4.0)
-    coderay (1.1.2)
-    diff-lcs (1.3)
-    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)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    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.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.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  acts_as_hashable!
-  guard-rspec (~> 4.7)
-  rspec
-  rubocop (~> 0.63.1)
-  simplecov (~> 0.16.1)
-  simplecov-console (~> 0.4.2)
-
-BUNDLED WITH
-   1.17.2

data/lib/acts_as_hashable/acts_as_hashable.rb

@@ -1,24 +0,0 @@
-# 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_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
-    end
-  end
-end
-
-Object.class_eval do
-  extend ::ActsAsHashable::DslHook
-end

data/lib/acts_as_hashable/utilities.rb

@@ -1,34 +0,0 @@
-# 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.
-#
-
-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 }
-      end
-
-      # https://apidock.com/rails/v4.2.7/Hash/transform_keys
-      def transform_keys(hash)
-        return enum_for(:transform_keys) unless block_given?
-
-        result = {}
-
-        hash.keys.each do |key|
-          result[yield(key)] = hash[key]
-        end
-
-        result
-      end
-    end
-  end
-end

data/spec/acts_as_hashable_spec.rb

@@ -1,203 +0,0 @@
-# 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 './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',
-          toy: { squishy: true }
-        }
-
-        pet_obj = Pet.make(pet)
-
-        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
-          },
-          partner: {
-            name: 'Katie',
-            age: 110
-          }
-        }
-
-        head_of_household_obj = HeadOfHousehold.make(head_of_household)
-
-        expect(head_of_household_obj.person.name).to eq('Matt')
-        expect(head_of_household_obj.person.age).to eq(109)
-        expect(head_of_household_obj.partner.name).to eq('Katie')
-        expect(head_of_household_obj.partner.age).to eq(110)
-      end
-
-      it 'should properly instantiate objects from string-keyed hash' do
-        head_of_household = {
-          'person' => {
-            'name' => 'Matt',
-            'age' => 109
-          },
-          'partner' => {
-            'name' => 'Katie',
-            'age' => 110
-          }
-        }
-
-        head_of_household_obj = HeadOfHousehold.make(head_of_household)
-
-        expect(head_of_household_obj.person.name).to eq('Matt')
-        expect(head_of_household_obj.person.age).to eq(109)
-        expect(head_of_household_obj.partner.name).to eq('Katie')
-        expect(head_of_household_obj.partner.age).to eq(110)
-      end
-
-      it 'should raise an ArgumentError for missing required keyword' do
-        head_of_household = {
-          person: {
-            # name: 'Matt',
-            age: 109
-          },
-          partner: {
-            name: 'Katie',
-            age: 110
-          }
-        }
-
-        expect { HeadOfHousehold.make(head_of_household) }.to raise_error(ArgumentError)
-      end
-
-      it 'should raise an ArgumentError for unknown required keyword' do
-        head_of_household = {
-          person: {
-            name: 'Matt',
-            age: 109,
-            height_in_inches: 700
-          },
-          partner: {
-            name: 'Katie',
-            age: 110
-          }
-        }
-
-        expect { HeadOfHousehold.make(head_of_household) }.to raise_error(ArgumentError)
-      end
-    end
-
-    context '#array' 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
-            },
-            partner: {
-              name: 'Katie',
-              age: 110
-            }
-          },
-          children: [
-            { name: 'Martin', age: 29 },
-            { name: 'Short',  age: 99 }
-          ]
-        }
-
-        family_obj = Family.make(family)
-
-        expect(family_obj.head_of_household.person.name).to   eq('Matt')
-        expect(family_obj.head_of_household.person.age).to    eq(109)
-        expect(family_obj.head_of_household.partner.name).to  eq('Katie')
-        expect(family_obj.head_of_household.partner.age).to   eq(110)
-
-        expect(family_obj.children.length).to  eq(2)
-        expect(family_obj.children[0].name).to eq('Martin')
-        expect(family_obj.children[0].age).to  eq(29)
-        expect(family_obj.children[1].name).to eq('Short')
-        expect(family_obj.children[1].age).to  eq(99)
-      end
-
-      it 'should properly instantiate arrays of objects when only a single hash is passed in' do
-        family = {
-          head_of_household: {
-            person: {
-              name: 'Matt',
-              age: 109
-            },
-            partner: {
-              name: 'Katie',
-              age: 110
-            }
-          },
-          children: { name: 'Martin', age: 29 }
-        }
-
-        family_obj = Family.make(family)
-
-        expect(family_obj.head_of_household.person.name).to   eq('Matt')
-        expect(family_obj.head_of_household.person.age).to    eq(109)
-        expect(family_obj.head_of_household.partner.name).to  eq('Katie')
-        expect(family_obj.head_of_household.partner.age).to   eq(110)
-
-        expect(family_obj.children.length).to  eq(1)
-        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

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

data/spec/spec_helper.rb

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