hashcraft 1.0.0.pre.alpha.5 → 1.0.0.pre.alpha.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9c8a4af5a05076883863320714728589bf2b49a0bd3b7f78e59be638697f6c9
-  data.tar.gz: 076117b9ba1523dc28f1eb62ce0cf19633d5eefc45db338e3633a325e5884234
+  metadata.gz: c70ff2e1bf5cecc91ae33eba7b1fb5810371ab3f67a4f077e02c0dc8a3b6fac8
+  data.tar.gz: b116b485b82e3cacc55e7a217d3682a06334a970c105eef95db01f054bf44655
 SHA512:
-  metadata.gz: 7075af55fa51130fb90ab52fe7456e374faef7aba9b32a82ff9d88cff488b95ba378049f997e44bbd1f48f80cfdb66a71fcc37432359662ef92c31115c65d371
-  data.tar.gz: a5dbad75e29f37aac42b0142bec8ea7cb9c167408d9691c80247adf82475ed92c9769e2bd6be0e9bebe82c7e344bd3e44d149337bed0bf725107c9fde6b710db
+  metadata.gz: a03980f411dd97dd6744780fa01a74891f618703faaa3b06c24cd2f088ab387a4127ab17d9c9b0f02c7c746fd0701ee66743d4debee5e4c29f9c8704d03f2cca
+  data.tar.gz: e90a7ea856b01fd8298e30a2eef2c1ad81d0337c819792a0df8108145419caa1fe19502502c0a3df17f1e24b792c435b4e7983030dc61cb2d4f310cbb7a639e3

data/.gitignore

@@ -4,5 +4,4 @@
 /coverage
 Gemfile.lock
 /pkg
-
-
+/doc

data/lib/hashcraft.rb

@@ -10,11 +10,8 @@
 require 'forwardable'
 require 'singleton'
 
-# Monkey-patching core libraries
-require_relative 'hashcraft/core_ext/hash'
-Hash.include Hashcraft::CoreExt::Hash
-
 # General tooling
 require_relative 'hashcraft/generic'
 
+# Main Entrypoint(s)
 require_relative 'hashcraft/base'

data/lib/hashcraft/base.rb

@@ -16,7 +16,6 @@ module Hashcraft
     extend Forwardable
 
     def_delegators :'self.class',
-                   :option?,
                    :option_set,
                    :find_option,
                    :key_transformer_to_use,
@@ -37,6 +36,8 @@ module Hashcraft
       end
     end
 
+    # Main compilation method.  Once an object is hydrated, you can call this method to get the
+    # materialized hash.
     def to_h
       data.each_with_object({}) do |(key, value), memo|
         method = value.is_a?(Array) ? :evaluate_values! : :evaluate_value!
@@ -57,20 +58,6 @@ module Hashcraft
       (opts || {}).each { |k, v| send(k, v) }
     end
 
-    def respond_to_missing?(method_name, include_private = false)
-      option?(method_name) || super
-    end
-
-    def method_missing(method_name, *arguments, &block)
-      if option?(method_name)
-        option = find_option(method_name)
-
-        value!(option, arguments.first, &block)
-      else
-        super
-      end
-    end
-
     def evaluate_values!(data, key, values)
       data[key] ||= []
 

data/lib/hashcraft/dsl.rb

@@ -18,15 +18,21 @@ module Hashcraft
     attr_reader :local_key_transformer,
                 :local_value_transformer
 
+    # DSL Method used to declare what the sub-class should use as a transformer for all keys.
+    # It will follow the typical inheritance chain and find the closest
+    # transformer to use (child-first).
     def key_transformer(name)
       tap { @local_key_transformer = TransformerRegistry.resolve(name) }
     end
 
+    # DSL Method used to declare what the sub-class should use as a transformer for all values.
+    # It will follow the typical inheritance chain and find the closest
+    # transformer to use (child-first).
     def value_transformer(name)
       tap { @local_value_transformer = TransformerRegistry.resolve(name) }
     end
 
-    def key_transformer_to_use
+    def key_transformer_to_use # :nodoc:
       return @key_transformer_to_use if @key_transformer_to_use
 
       @closest_key_transformer =
@@ -35,7 +41,7 @@ module Hashcraft
                  &.local_key_transformer || Transformers::PassThru.instance
     end
 
-    def value_transformer_to_use
+    def value_transformer_to_use # :nodoc:
       return @value_transformer_to_use if @value_transformer_to_use
 
       @closest_value_transformer =
@@ -44,14 +50,12 @@ module Hashcraft
                  &.local_value_transformer || Transformers::PassThru.instance
     end
 
-    def option?(name)
-      option_set.exist?(name)
-    end
-
-    def find_option(name)
+    def find_option(name) # :nodoc:
       option_set.find(name)
     end
 
+    # The main class-level DSL method consumed by sub-classes.  This is the entry-point for the
+    # declaration of available options.
     def option(*args)
       opts = args.last.is_a?(Hash) ? args.pop : {}
 
@@ -59,12 +63,22 @@ module Hashcraft
         option = Option.new(key, opts)
 
         local_option_set.add(option)
+
+        method_name = option.name
+
+        class_eval <<~RUBY, __FILE__, __LINE__ + 1
+          def #{method_name}(opts = {}, &block)
+            option = find_option('#{method_name}')
+
+            value!(option, opts, &block)
+          end
+        RUBY
       end
 
       self
     end
 
-    def option_set
+    def option_set # :nodoc:
       @option_set ||=
         ancestors
         .reverse
@@ -72,7 +86,7 @@ module Hashcraft
         .each_with_object(Generic::Dictionary.new) { |a, memo| memo.merge!(a.local_option_set) }
     end
 
-    def local_option_set
+    def local_option_set # :nodoc:
       @local_option_set ||= Generic::Dictionary.new(key: :name)
     end
   end

data/lib/hashcraft/generic/dictionary.rb

@@ -8,7 +8,7 @@
 #
 
 module Hashcraft
-  module Generic
+  module Generic # :nodoc: all
     # Dictionary structure defining how we want to organize objects.  Basically a type-insensitive
     # hash where each key is the object's value for the specified key.
     # All keys are #to_s evaluated in order to achieve the type-insensitivity.
@@ -34,10 +34,6 @@ module Hashcraft
         values.each(&block)
       end
 
-      def exist?(key)
-        !find(key).nil?
-      end
-
       def find(key)
         @map[key.to_s]
       end

data/lib/hashcraft/generic/registry.rb

@@ -8,7 +8,7 @@
 #
 
 module Hashcraft
-  module Generic
+  module Generic # :nodoc: all
     # A general data structure that can register and resolve objects by name.
     # It also will act as a pass-thru if a non-string or non-symbol is passed through.
     class Registry

data/lib/hashcraft/mutator_registry.rb

@@ -16,16 +16,16 @@ require_relative 'mutators/property'
 
 module Hashcraft
   # Singleton that knows how to register and retrieve mutator instances.
-  class MutatorRegistry < Generic::Registry
+  class MutatorRegistry < Generic::Registry # :nodoc:
     def initialize
       super(
+        '' => Mutators::Property.instance,
         'always_false' => Mutators::AlwaysFalse.instance,
         'always_true' => Mutators::AlwaysTrue.instance,
         'array' => Mutators::Array.instance,
         'flat_array' => Mutators::FlatArray.instance,
         'hash' => Mutators::Hash.instance,
-        'property' => Mutators::Property.instance,
-        '' => Mutators::Property.instance
+        'property' => Mutators::Property.instance
       )
     end
   end

data/lib/hashcraft/mutators/always_false.rb

@@ -8,7 +8,7 @@
 #
 
 module Hashcraft
-  module Mutators
+  module Mutators # :nodoc: all
     # Set to false, no matter what.
     class AlwaysFalse
       include Singleton

data/lib/hashcraft/mutators/always_true.rb

@@ -8,7 +8,7 @@
 #
 
 module Hashcraft
-  module Mutators
+  module Mutators # :nodoc: all
     # Set to true, no matter what.
     class AlwaysTrue
       include Singleton

data/lib/hashcraft/mutators/array.rb

@@ -8,7 +8,7 @@
 #
 
 module Hashcraft
-  module Mutators
+  module Mutators # :nodoc: all
     # When a hash's key is an array then this mutator can be used to push a new value on the
     # respective array.
     class Array

data/lib/hashcraft/mutators/flat_array.rb

@@ -8,7 +8,7 @@
 #
 
 module Hashcraft
-  module Mutators
+  module Mutators # :nodoc: all
     # If the value is an array then concat, if it is not an array then push.
     class FlatArray
       include Singleton

data/lib/hashcraft/mutators/hash.rb

@@ -8,7 +8,7 @@
 #
 
 module Hashcraft
-  module Mutators
+  module Mutators # :nodoc: all
     # When a hash's key a Hash then this mutator can be used to merge a new value on the
     # respective hash.
     class Hash

data/lib/hashcraft/mutators/property.rb

@@ -8,7 +8,7 @@
 #
 
 module Hashcraft
-  module Mutators
+  module Mutators # :nodoc: all
     # When a hash key can be simply assigned to (like a property) then this mutator can be used to
     # simply do the assignment.
     class Property

data/lib/hashcraft/option.rb

@@ -21,13 +21,13 @@ module Hashcraft
 
     alias eager? eager
 
-    def initialize(name, opts = {})
+    def initialize(name, opts = {}) # :nodoc:
       raise ArgumentError, 'name is required' if name.to_s.empty?
 
       @craft         = opts[:craft]
       @default       = opts[:default]
       @eager         = opts[:eager] || false
-      @internal_meta = (opts[:meta] || {}).symbolize_keys
+      @internal_meta = symbolize_keys(opts[:meta] || {})
       @key           = opts[:key].to_s
       @mutator       = MutatorRegistry.resolve(opts[:mutator])
       @name          = name.to_s
@@ -35,24 +35,31 @@ module Hashcraft
       freeze
     end
 
-    def value!(data, key, value)
+    def value!(data, key, value) # :nodoc:
       mutator.value!(data, key, value)
     end
 
+    # Options are sent into transformers as arguments.  Leverage the meta key for an option
+    # to store any additional data that you may need in transformers.  This method provides a
+    # quick message-based entry point into inspecting the meta key's value.
     def meta(key)
       internal_meta[key.to_s.to_sym]
     end
 
-    def hash_key
+    def hash_key # :nodoc:
       key.empty? ? name : key
     end
 
-    def craft_value(value, &block)
+    def craft_value(value, &block) # :nodoc:
       craft ? craft.new(value, &block) : value
     end
 
     private
 
     attr_reader :internal_meta
+
+    def symbolize_keys(hash)
+      hash.map { |k, v| [k.to_sym, v] }.to_h
+    end
   end
 end

data/lib/hashcraft/transformer_registry.rb

@@ -13,13 +13,13 @@ require_relative 'transformers/pass_thru'
 
 module Hashcraft
   # Singleton that knows how to register and retrieve transformer instances.
-  class TransformerRegistry < Generic::Registry
+  class TransformerRegistry < Generic::Registry # :nodoc:
     def initialize
       super(
+        '' => Transformers::PassThru.instance,
         'camel_case' => Transformers::CamelCase.instance,
         'pascal_case' => Transformers::PascalCase.instance,
-        'pass_thru' => Transformers::PassThru.instance,
-        '' => Transformers::PassThru.instance
+        'pass_thru' => Transformers::PassThru.instance
       )
     end
   end

data/lib/hashcraft/transformers/camel_case.rb

@@ -8,7 +8,7 @@
 #
 
 module Hashcraft
-  module Transformers
+  module Transformers # :nodoc: all
     # Transform snake-cased to camel-cased string. Example:
     #   date_of_birth => dateOfBirth
     #   DATE_OF_BIRTH => dateOfBirth

data/lib/hashcraft/transformers/pascal_case.rb

@@ -8,7 +8,7 @@
 #
 
 module Hashcraft
-  module Transformers
+  module Transformers # :nodoc: all
     # Transform snake-cased to pascal-cased string. Example:
     #   date_of_birth => DateOfBirth
     #   DATE_OF_BIRTH => DateOfBirth

data/lib/hashcraft/transformers/pass_thru.rb

@@ -8,7 +8,7 @@
 #
 
 module Hashcraft
-  module Transformers
+  module Transformers # :nodoc: all
     # Default transformer, simply returns the value passed in.
     class PassThru
       include Singleton

data/lib/hashcraft/version.rb

@@ -8,5 +8,5 @@
 #
 
 module Hashcraft
-  VERSION = '1.0.0-alpha.5'
+  VERSION = '1.0.0-alpha.6'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hashcraft
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.alpha.5
+  version: 1.0.0.pre.alpha.6
 platform: ruby
 authors:
 - Matthew Ruggio
@@ -132,7 +132,6 @@ files:
 - hashcraft.gemspec
 - lib/hashcraft.rb
 - lib/hashcraft/base.rb
-- lib/hashcraft/core_ext/hash.rb
 - lib/hashcraft/dsl.rb
 - lib/hashcraft/generic.rb
 - lib/hashcraft/generic/dictionary.rb

data/lib/hashcraft/core_ext/hash.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-#
-# Copyright (c) 2020-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 Hashcraft
-  module CoreExt
-    # Monkey-patches for the core Hash class.  These will be manually mixed in separately.
-    module Hash
-      unless method_defined?(:symbolize_keys)
-        def symbolize_keys
-          map { |k, v| [k.to_sym, v] }.to_h
-        end
-      end
-    end
-  end
-end