acts_as_hashable 1.0.5 → 1.1.0.pre.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff6ee1d4bdac43f6841c65d7d4621e9a02dbcfa5abd1284d9f7de45f8da91810
-  data.tar.gz: 1677ea47f8beee3825a42c03bf49596e1a803b0940e5c405a254112a07f9b3f1
+  metadata.gz: 9bfcbb15a9468d11fb85684f905f66f59bbeb3483d69bca332cc45e7c4ad5bf4
+  data.tar.gz: 555ebb09c100425427d23a228885b96d8d142f5b46ee350ab97edbbf90d5a8db
 SHA512:
-  metadata.gz: 3080003d4ee62018ac67e47b5ed03c417526e3ccb3061321cdfbf4b838f4f722ac17b88f9e9496deb810f34b7df05f949b64dfc6de4699b5de2927b14f5c3dc6
-  data.tar.gz: 1766f6ab2413d21543762de7768910b51c13b69022fb3b3973405845a8e308f843a7cb8b2c5d82bde14a507c7177ce99b32e2cac05cc519912cbaf66c3477711
+  metadata.gz: e041c6cc66f5cded7cf29f6ea0d5c1da08f9a8302bc92a4efacb8b79aac03c33bbc21534105101f1c402625eba7047734541063af870cd79d409cab1d68fd6cc
+  data.tar.gz: dc4a2825e441edee209913723ec1bf8ff8bbbbe4099694e4c0aa60bd556f288b7920c3f0236abca86ae66313e5c27935dc97fc0be318c25cabe3cc2685af4cb9

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 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/Gemfile.lock

@@ -1,13 +1,14 @@
 PATH
   remote: .
   specs:
-    acts_as_hashable (1.0.5)
+    acts_as_hashable (1.1.0.pre.alpha)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ansi (1.5.0)
     ast (2.4.0)
+    byebug (11.0.1)
     coderay (1.1.2)
     diff-lcs (1.3)
     docile (1.3.1)
@@ -47,7 +48,11 @@ GEM
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
+    pry-byebug (3.7.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
     rainbow (3.0.0)
+    rake (10.5.0)
     rb-fsevent (0.10.3)
     rb-inotify (0.10.0)
       ffi (~> 1.0)
@@ -93,10 +98,13 @@ PLATFORMS
 DEPENDENCIES
   acts_as_hashable!
   guard-rspec (~> 4.7)
+  pry
+  pry-byebug (~> 3)
+  rake (~> 10.0)
   rspec
   rubocop (~> 0.63.1)
   simplecov (~> 0.16.1)
   simplecov-console (~> 0.4.2)
 
 BUNDLED WITH
-   1.17.2
+   1.17.3

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,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/acts_as_hashable.gemspec

@@ -24,6 +24,9 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 2.3.8'
 
   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', '~> 10.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/factory.rb

@@ -0,0 +1,55 @@
+# 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* he acts_as_hashable objects.
+  # In order to use you just have to subclass this class and implement
+  # and method called 'registry', such as:
+  #   def registry
+  #     {
+  #       'Table': Table,
+  #       'Text': Text
+  #     }
+  #   end
+  module Factory
+    extend Forwardable
+
+    def_delegators :factory, :array, :make
+
+    def register(key, value)
+      registry[key] = value
+    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,13 @@ module ActsAsHashable
   # This class contains the main set of class-level methods that can be used by
   # hashable classes.
   module Hashable
+    using HashRefinements
+
     HASHABLE_HYDRATORS = [
       {
         condition: ->(_context, object, _nullable) { object.is_a?(Hash) },
         converter: lambda do |context, object, _nullable|
-          context.new(**::ActsAsHashable::Utilities.symbolize_keys(object))
+          context.new(**(object || {}).symbolize_keys)
         end
       },
       {

data/lib/acts_as_hashable/type_factory.rb

@@ -0,0 +1,46 @@
+# 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 section from type: #{type}" unless object_class
+
+      config_without_type = config.reject { |k| k == type_key }
+
+      object_class.new(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.1.0-alpha'
 end

data/lib/acts_as_hashable.rb

@@ -7,4 +7,26 @@
 # LICENSE file in the root directory of this source tree.
 #
 
-require_relative 'acts_as_hashable/acts_as_hashable'
+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/spec/examples.rb

@@ -60,3 +60,21 @@ class Family
     @children           = Person.array(children)
   end
 end
+
+class ExampleFactory
+  acts_as_hashable_factory
+
+  type_key :object_type
+
+  register 'Person', Person
+
+  register 'Pet', Pet
+
+  register 'Toy', Toy
+
+  # These are examples of registering a proc instead of a class constant.  It
+  # will send the key through the argument if you need
+  register 'Familiy', ->(_key) { Family }
+
+  register 'HeadOfHousehold', ->(_key) { HeadOfHousehold }
+end

data/spec/factory_spec.rb

@@ -0,0 +1,49 @@
+# 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::Factory do
+  subject { ExampleFactory }
+
+  it 'should hydrate example objects' do
+    objects = [
+      {
+        object_type: 'Pet',
+        name: 'Doug the dog',
+        toy: { squishy: true }
+      },
+      {
+        object_type: 'HeadOfHousehold',
+        person: {
+          name: 'Matt',
+          age: 109
+        },
+        partner: {
+          name: 'Katie',
+          age: 110
+        }
+      }
+    ]
+
+    hydrated_objects = subject.array(objects)
+
+    pet_obj = hydrated_objects.first
+
+    expect(pet_obj.name).to eq('Doug the dog')
+    expect(pet_obj.toy.squishy).to be true
+
+    head_of_household_obj = hydrated_objects.last
+
+    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
+end

data/spec/spec_helper.rb

@@ -7,10 +7,18 @@
 # LICENSE file in the root directory of this source tree.
 #
 
-require 'simplecov'
-require 'simplecov-console'
-SimpleCov.formatter = SimpleCov::Formatter::Console
-SimpleCov.start
+require 'pry'
+require 'pry-byebug'
+
+unless ENV['DISABLE_SIMPLECOV'] == 'true'
+  require 'simplecov'
+  require 'simplecov-console'
+
+  SimpleCov.formatter = SimpleCov::Formatter::Console
+  SimpleCov.start do
+    add_filter %r{\A/spec/}
+  end
+end
 
 require './lib/acts_as_hashable'
 require './spec/examples'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_hashable
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0.pre.alpha
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-05 00:00:00.000000000 Z
+date: 2019-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard-rspec
@@ -24,6 +24,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: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -97,20 +139,24 @@ 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
 - 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/factory_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/bluemarblepayroll/acts_as_hashable
 licenses:
@@ -127,9 +173,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.3.8
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.1
 signing_key: 
@@ -138,4 +184,5 @@ summary: Simple hash-based factory methods for objects.
 test_files:
 - spec/acts_as_hashable_spec.rb
 - spec/examples.rb
+- spec/factory_spec.rb
 - spec/spec_helper.rb

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