acts_as_hashable 1.2.0.pre.alpha.1 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0dede2b7914dcb91cd030c65e5385220553d7cd523172e40c5390a644598cb5
-  data.tar.gz: 47a708a122c7c12d80fa9932b24c2d5cbe4ab8cab97264afb818c0a0781ac308
+  metadata.gz: a65b9069ee49d32c52627fd9ef82275b065f11a4b823baf014e8b4dd0da378ab
+  data.tar.gz: e94f87a51dd6e013787402ca03f6be9118a07f5e9d5c922eb1707bfb8a812bfb
 SHA512:
-  metadata.gz: 1720b09fddd1101546b452bde063e5d7a516d5883ce75cd4a5bca09726cf6d97ad7e28a7ca1dee4966fa926ffddc7a293b1dc7bc5e19888b420525ea156e4037
-  data.tar.gz: 69d1012dddafed50c20503cb27049d4df950182587f7d911f658b0fb239e36f103a62d70a6a5d3a35bc2ed535c28ef8cd309726ec18dd98825d1e1d2fcd7e169
+  metadata.gz: a898e36e34decb4cbb3cdea1bc0126babda2d3a5be4e67423ba02f600102f9763553a7ed26451cb56d4008a45571f96374716e737130def6192940eb99084000
+  data.tar.gz: 6740620f589c266e32ad37b4e7edd1685b1c87357dbdb530a51d25f2cbb8dde65104562ae6198300b0fee10b852bf9fc336fcc4dc99ae98283f89b5e389d4569

data/.circleci/config.yml

@@ -0,0 +1,71 @@
+version: 2.1
+
+orbs:
+  status_to_ms_teams: bluemarblepayroll/status_to_ms_teams_pure_bash@1.0.0
+
+jobs:
+  build:
+    parameters:
+      use-bundler-cache:
+        type: boolean
+        default: true
+
+    docker:
+      - image: circleci/ruby:2.6.6-buster
+        environment:
+          FORBID_FOCUSED_SPECS: 1
+    working_directory: ~/acts_as_hashable
+    steps:
+      - checkout
+
+      # TODO: wrap bundler caching logic into an Orb:
+      - when:
+          condition: << parameters.use-bundler-cache >>
+          steps:
+            - restore_cache:
+                key: v1.0.0-build-ruby-dependency-cache-{{ checksum "acts_as_hashable.gemspec" }}-{{ checksum "Gemfile" }}-{{ checksum ".ruby-version" }}
+
+      - run: bundle install --path vendor/bundle
+
+      - when:
+          condition: << parameters.use-bundler-cache >>
+          steps:
+            - save_cache:
+                key: v1.0.0-build-ruby-dependency-cache-{{ checksum "acts_as_hashable.gemspec" }}-{{ checksum "Gemfile" }}-{{ checksum ".ruby-version" }}
+                paths:
+                  - vendor/bundle
+
+      - store_artifacts:
+          path: Gemfile.lock
+
+      - run: bundle exec rubocop
+
+      - run: COVERAGE=true bundle exec rspec -r rspec_junit_formatter --format progress --format RspecJunitFormatter -o test-results/rspec/results.xml
+
+      - store_test_results:
+          path: test-results
+
+      - store_artifacts:
+          path: coverage
+
+      - status_to_ms_teams/report:
+          webhook_url: $MS_TEAMS_WEBHOOK_URL
+
+workflows:
+  version: 2.1
+  build:
+    jobs:
+      - build:
+          context: org-global
+  monthly-gem-dependency-refresh-check:
+    triggers:
+      - schedule:
+          cron: '0 0 1 * *'
+          filters:
+            branches:
+              only:
+                - master
+    jobs:
+      - build:
+          context: org-global
+          use-bundler-cache: false

data/.gitignore

@@ -4,3 +4,4 @@
 /coverage
 /pkg
 Gemfile.lock
+/test-results

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.6.6

data/CHANGELOG.md

@@ -1,4 +1,10 @@
-# 1.2.0 (une 8th, 2020)
+# 1.3.0 (September 5th, 2020)
+
+Additions:
+
+* Added dynamic class constantization when a string is registered for a Factory.
+
+# 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.

data/README.md

@@ -1,7 +1,5 @@
 # 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) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-
 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:
@@ -19,7 +17,7 @@ The two class-level factory methods are just meant to create a syntactic hash-li
 To install through Rubygems:
 
 ````
-gem install install acts_as_hashable
+gem install acts_as_hashable
 ````
 
 You can also add this to your Gemfile:
@@ -197,6 +195,22 @@ 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).
 
+### Resolving Constants at Runtime
+
+Factories can also be resolved using Ruby's Object#const_get and Object#const_missing.  Simply register a string  representing the class in order to use these mechanics, such as:
+
+```ruby
+class ExampleFactory
+  acts_as_hashable_factory
+
+  type_key 'object_type'
+
+  register 'Pet', 'Pet'
+
+  register 'HeadOfHousehold', ->(_key) { HeadOfHousehold }
+end
+```
+
 ## Contributing
 
 ### Development Environment Configuration

data/acts_as_hashable.gemspec

@@ -20,13 +20,6 @@ Gem::Specification.new do |s|
   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.5'
 
@@ -37,6 +30,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency('pry-byebug', '~> 3')
   s.add_development_dependency('rake', '~> 13.0')
   s.add_development_dependency('rspec')
+  s.add_development_dependency('rspec_junit_formatter')
   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')

data/lib/acts_as_hashable/constant_resolver.rb

@@ -0,0 +1,34 @@
+# 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 is responsible for turning strings and symbols into constants.
+  # It does not deal with inflection, simply just constant resolution.
+  class ConstantResolver # :nodoc: all
+    # Only use Module constant resolution if a string or symbol was passed in.
+    # Any other type is defined as an acceptable constant and is simply returned.
+    def constantize(value)
+      value.is_a?(String) || value.is_a?(Symbol) ? object_constant(value) : value
+    end
+
+    private
+
+    # If the constant has been loaded, we can safely use it through const_get.
+    # If the constant has not been loaded, we need to defer to const_missing to resolve it.
+    # If we blindly call const_get, it may return false positives for namespaced constants
+    # or anything nested.
+    def object_constant(value)
+      if Object.const_defined?(value, false)
+        Object.const_get(value, false)
+      else
+        Object.const_missing(value)
+      end
+    end
+  end
+end

data/lib/acts_as_hashable/factory.rb

@@ -38,22 +38,22 @@ module ActsAsHashable
       end
     end
 
-    def registry
+    def registry # :nodoc:
       @registry ||= {}
     end
 
-    def materialize_registry
+    def materialize_registry # :nodoc:
       @registry.map do |k, v|
         value = v.is_a?(Proc) ? v.call(k) : v
         [k, value]
       end.to_h
     end
 
-    def type_key(key)
+    def type_key(key) # :nodoc:
       @typed_with = key
     end
 
-    def typed_with
+    def typed_with # :nodoc:
       @typed_with || TypeFactory::DEFAULT_TYPE_KEY
     end
 

data/lib/acts_as_hashable/hash_refinements.rb

@@ -10,7 +10,7 @@
 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
+  module HashRefinements # :nodoc: all
     refine Hash do
       def symbolize_keys
         map { |k, v| [k.to_sym, v] }.to_h

data/lib/acts_as_hashable/type_factory.rb

@@ -7,6 +7,8 @@
 # LICENSE file in the root directory of this source tree.
 #
 
+require_relative 'constant_resolver'
+
 module ActsAsHashable
   # A TypeFactory object understands how to build objects using a special designated 'type' key.
   class TypeFactory
@@ -17,8 +19,9 @@ module ActsAsHashable
     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
+      @constant_resolver = ConstantResolver.new
+      @registry          = registry.symbolize_keys
+      @type_key          = type_key.to_s.to_sym
 
       freeze
     end
@@ -34,9 +37,7 @@ module ActsAsHashable
     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
+      object_class  = resolve_object_class(type)
 
       config_without_type = config.reject { |k| k == type_key }
 
@@ -47,5 +48,19 @@ module ActsAsHashable
 
       object_class.send(method_name, config_without_type)
     end
+
+    private
+
+    attr_reader :constant_resolver
+
+    def resolve_object_class(type)
+      object_class = registry[type]
+
+      raise ArgumentError, "cannot find registration for: '#{type}'" unless object_class
+
+      return object_class unless object_class.is_a?(String)
+
+      constant_resolver.constantize(object_class)
+    end
   end
 end

data/lib/acts_as_hashable/version.rb

@@ -8,5 +8,5 @@
 #
 
 module ActsAsHashable
-  VERSION = '1.2.0-alpha.1'
+  VERSION = '1.3.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_hashable
 version: !ruby/object:Gem::Version
-  version: 1.2.0.pre.alpha.1
+  version: 1.3.1
 platform: ruby
 authors:
 - Matthew Ruggio
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-09 00:00:00.000000000 Z
+date: 2021-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: caution
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  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: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -146,22 +160,23 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".editorconfig"
 - ".gitignore"
 - ".rubocop.yml"
 - ".ruby-version"
-- ".travis.yml"
+- ".tool-versions"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Guardfile
-- LICENSE
 - README.md
 - Rakefile
 - acts_as_hashable.gemspec
 - bin/console
 - exe/.gitkeep
 - lib/acts_as_hashable.rb
+- lib/acts_as_hashable/constant_resolver.rb
 - lib/acts_as_hashable/factory.rb
 - lib/acts_as_hashable/hash_refinements.rb
 - lib/acts_as_hashable/hashable.rb
@@ -170,13 +185,8 @@ files:
 homepage: https://github.com/bluemarblepayroll/acts_as_hashable
 licenses:
 - MIT
-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: 
+metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -187,12 +197,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Simple hash-based factory methods for objects.
 test_files: []

data/.travis.yml

@@ -1,24 +0,0 @@
-env:
-  global:
-    - CC_TEST_REPORTER_ID=830db02445429888fcdd7d1406dd82e9b32535e863ac54a538a162c0c4acd4d1
-language: ruby
-rvm:
-  # Build on the latest stable of all supported Rubies (https://www.ruby-lang.org/en/downloads/):
-  - 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
-  - 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
-addons:
-  # https://docs.travis-ci.com/user/uploading-artifacts/
-  artifacts:
-    paths:
-      - Gemfile.lock

data/LICENSE

@@ -1,7 +0,0 @@
-Copyright 2018 Blue Marble Payroll, LLC
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.