hashcraft 1.0.0.pre.alpha.6 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c70ff2e1bf5cecc91ae33eba7b1fb5810371ab3f67a4f077e02c0dc8a3b6fac8
-  data.tar.gz: b116b485b82e3cacc55e7a217d3682a06334a970c105eef95db01f054bf44655
+  metadata.gz: 38c94cd212c01aa72103257b3d053e3dd9beeb190641fcb82df4ac1896db27ba
+  data.tar.gz: 21de2c24f3a98e759b68e4783b29d9c8e11f45cc3e71b71bd779e0319ba52986
 SHA512:
-  metadata.gz: a03980f411dd97dd6744780fa01a74891f618703faaa3b06c24cd2f088ab387a4127ab17d9c9b0f02c7c746fd0701ee66743d4debee5e4c29f9c8704d03f2cca
-  data.tar.gz: e90a7ea856b01fd8298e30a2eef2c1ad81d0337c819792a0df8108145419caa1fe19502502c0a3df17f1e24b792c435b4e7983030dc61cb2d4f310cbb7a639e3
+  metadata.gz: 5ab0f421744e572638f75ccf04508471f7df8131f105b8e55ae806b90255340f8b45193f72c94dfb84ee1b6037e836e8d29050c8963417d41484c2f83efe97b5
+  data.tar.gz: 3c2e2f61c4eeea3af9fdc95d493461bd727e9b49134c60a8577b5a7c149ae3a4da1796c05f3db6257afed23b2abd29bf1ef146359dc3d5726185ec73b7c6a221

data/.rubocop.yml

@@ -1,3 +1,7 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: enable
+
 Layout/LineLength:
   Max: 100
   Exclude:
@@ -15,9 +19,6 @@ Metrics/BlockLength:
 Metrics/MethodLength:
   Max: 30
 
-AllCops:
-  TargetRubyVersion: 2.5
-
 Metrics/AbcSize:
   Max: 16
 

data/CHANGELOG.md

@@ -1,4 +1,4 @@
-# 1.0.0 TBD
+# 1.0.0 July 15th, 2020
 
 Initial, feature-complete implementation.
 

data/README.md

@@ -276,7 +276,7 @@ config = Grid.new do
 end.to_h
 ````
 
-Assuming our en.yml looks like the above example and our locale is set to:en then the resulting `config` value will now be:
+Assuming our en.yml looks like the above example and our locale is set to :en then the resulting `config` value will now be:
 
 ````ruby
 {

data/hashcraft.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency('pry', '~>0')
   s.add_development_dependency('rake', '~> 13')
   s.add_development_dependency('rspec')
-  s.add_development_dependency('rubocop', '~>0.79.0')
-  s.add_development_dependency('simplecov', '~>0.17.0')
+  s.add_development_dependency('rubocop', '~>0.88.0')
+  s.add_development_dependency('simplecov', '~>0.18.5')
   s.add_development_dependency('simplecov-console', '~>0.6.0')
 end

data/lib/hashcraft/base.rb

@@ -8,6 +8,7 @@
 #
 
 require_relative 'dsl'
+require_relative 'transformers'
 
 module Hashcraft
   # Super-class for craftable objects.
@@ -59,11 +60,7 @@ module Hashcraft
     end
 
     def evaluate_values!(data, key, values)
-      data[key] ||= []
-
-      values.each do |value|
-        data[key] << (value.is_a?(Hashcraft::Base) ? value.to_h : value)
-      end
+      data[key] = values.map { |value| value.is_a?(Hashcraft::Base) ? value.to_h : value }
 
       self
     end
@@ -78,7 +75,7 @@ module Hashcraft
       return self unless option.eager?
 
       key   = hash_key(option)
-      value = value_transformer_to_use.transform(option.default.dup, option)
+      value = Transformers.instance.transform(value_transformer_to_use, option.default.dup, option)
 
       data[key] = value
 
@@ -88,7 +85,7 @@ module Hashcraft
     def value!(option, value, &block)
       key   = hash_key(option)
       value = option.craft_value(value, &block)
-      value = value_transformer_to_use.transform(value, option)
+      value = Transformers.instance.transform(value_transformer_to_use, value, option)
 
       option.value!(data, key, value)
 
@@ -96,7 +93,7 @@ module Hashcraft
     end
 
     def hash_key(option)
-      key_transformer_to_use.transform(option.hash_key, option)
+      Transformers.instance.transform(key_transformer_to_use, option.hash_key, option)
     end
   end
 end

data/lib/hashcraft/dsl.rb

@@ -8,7 +8,6 @@
 #
 
 require_relative 'option'
-require_relative 'transformer_registry'
 
 module Hashcraft
   # The class API used to define options for a craftable class.  Each class stores its own
@@ -22,32 +21,32 @@ module Hashcraft
     # 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) }
+      tap { @local_key_transformer = 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) }
+      tap { @local_value_transformer = name }
     end
 
     def key_transformer_to_use # :nodoc:
       return @key_transformer_to_use if @key_transformer_to_use
 
-      @closest_key_transformer =
+      @key_transformer_to_use =
         ancestors.select { |a| a < Base }
                  .find(&:local_key_transformer)
-                 &.local_key_transformer || Transformers::PassThru.instance
+                 &.local_key_transformer
     end
 
     def value_transformer_to_use # :nodoc:
       return @value_transformer_to_use if @value_transformer_to_use
 
-      @closest_value_transformer =
+      @value_transformer_to_use =
         ancestors.select { |a| a < Base }
                  .find(&:local_value_transformer)
-                 &.local_value_transformer || Transformers::PassThru.instance
+                 &.local_value_transformer
     end
 
     def find_option(name) # :nodoc:

data/lib/hashcraft/mutators.rb

@@ -0,0 +1,45 @@
+# 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
+  # Singleton that knows how to register and retrieve mutator instances.
+  # Entries can either be instances that respond to value! or procs that accept three arguments.
+  class Mutators < Generic::Registry # :nodoc:
+    FUNCTIONS = {
+      always_false: ->(data, key, _value) { data[key] = false },
+      always_true: ->(data, key, _value) { data[key] = true },
+      array: ->(data, key, value)  { (data[key] ||= []) << value },
+      flat_array: lambda do |data, key, value|
+        data[key] ||= []
+
+        if value.is_a?(::Array)
+          data[key] += value
+        else
+          data[key] << value
+        end
+      end,
+      hash: ->(data, key, value) { (data[key] ||= {}).merge!(value || {}) },
+      property: ->(data, key, value) { data[key] = value },
+    }.freeze
+
+    private_constant :FUNCTIONS
+
+    def initialize
+      # append on the default case
+      super(FUNCTIONS.merge('': FUNCTIONS[:property]))
+    end
+
+    def value!(name, data, key, value)
+      object = resolve(name)
+      method = object.is_a?(Proc) ? :call : :value!
+
+      object.send(method, data, key, value)
+    end
+  end
+end

data/lib/hashcraft/option.rb

@@ -7,7 +7,7 @@
 # LICENSE file in the root directory of this source tree.
 #
 
-require_relative 'mutator_registry'
+require_relative 'mutators'
 
 module Hashcraft
   # Defines a method and corresponding attribute for a craftable class.
@@ -29,14 +29,14 @@ module Hashcraft
       @eager         = opts[:eager] || false
       @internal_meta = symbolize_keys(opts[:meta] || {})
       @key           = opts[:key].to_s
-      @mutator       = MutatorRegistry.resolve(opts[:mutator])
+      @mutator       = opts[:mutator]
       @name          = name.to_s
 
       freeze
     end
 
     def value!(data, key, value) # :nodoc:
-      mutator.value!(data, key, value)
+      Mutators.instance.value!(mutator, data, key, value)
     end
 
     # Options are sent into transformers as arguments.  Leverage the meta key for an option
@@ -59,7 +59,7 @@ module Hashcraft
     attr_reader :internal_meta
 
     def symbolize_keys(hash)
-      hash.map { |k, v| [k.to_sym, v] }.to_h
+      hash.transform_keys(&:to_sym)
     end
   end
 end

data/lib/hashcraft/transformers.rb

@@ -0,0 +1,40 @@
+# 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
+  # Singleton that knows how to register and retrieve transformer instances.
+  # Entries can either be instances that respond to transform or procs that accept two arguments.
+  class Transformers < Generic::Registry # :nodoc:
+    FUNCTIONS = {
+      camel_case: lambda do |value, _option|
+        return value.to_s if value.to_s.empty?
+
+        name = value.to_s.split('_').collect(&:capitalize).join
+
+        name[0, 1].downcase + name[1..-1]
+      end,
+      pascal_case: ->(value, _option) { value.to_s.split('_').collect(&:capitalize).join },
+      pass_thru: ->(value, _option) { value }
+    }.freeze
+
+    private_constant :FUNCTIONS
+
+    def initialize
+      # append on the default case
+      super(FUNCTIONS.merge('': FUNCTIONS[:pass_thru]))
+    end
+
+    def transform(name, value, option)
+      object = resolve(name)
+      method = object.is_a?(Proc) ? :call : :transform
+
+      object.send(method, value, option)
+    end
+  end
+end

data/lib/hashcraft/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hashcraft
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.alpha.6
+  version: 1.0.0
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-08 00:00:00.000000000 Z
+date: 2020-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard-rspec
@@ -72,28 +72,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.79.0
+        version: 0.88.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.79.0
+        version: 0.88.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: 0.18.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: 0.18.5
 - !ruby/object:Gem::Dependency
   name: simplecov-console
   requirement: !ruby/object:Gem::Requirement
@@ -136,18 +136,9 @@ files:
 - lib/hashcraft/generic.rb
 - lib/hashcraft/generic/dictionary.rb
 - lib/hashcraft/generic/registry.rb
-- lib/hashcraft/mutator_registry.rb
-- lib/hashcraft/mutators/always_false.rb
-- lib/hashcraft/mutators/always_true.rb
-- lib/hashcraft/mutators/array.rb
-- lib/hashcraft/mutators/flat_array.rb
-- lib/hashcraft/mutators/hash.rb
-- lib/hashcraft/mutators/property.rb
+- lib/hashcraft/mutators.rb
 - lib/hashcraft/option.rb
-- lib/hashcraft/transformer_registry.rb
-- lib/hashcraft/transformers/camel_case.rb
-- lib/hashcraft/transformers/pascal_case.rb
-- lib/hashcraft/transformers/pass_thru.rb
+- lib/hashcraft/transformers.rb
 - lib/hashcraft/version.rb
 homepage: https://github.com/bluemarblepayroll/hashcraft
 licenses:
@@ -169,9 +160,9 @@ 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: 

data/lib/hashcraft/mutator_registry.rb

@@ -1,32 +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.
-#
-
-require_relative 'mutators/always_false'
-require_relative 'mutators/always_true'
-require_relative 'mutators/array'
-require_relative 'mutators/flat_array'
-require_relative 'mutators/hash'
-require_relative 'mutators/property'
-
-module Hashcraft
-  # Singleton that knows how to register and retrieve mutator instances.
-  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
-      )
-    end
-  end
-end

data/lib/hashcraft/mutators/always_false.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 Mutators # :nodoc: all
-    # Set to false, no matter what.
-    class AlwaysFalse
-      include Singleton
-
-      def value!(data, key, _value)
-        tap { data[key] = false }
-      end
-    end
-  end
-end

data/lib/hashcraft/mutators/always_true.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 Mutators # :nodoc: all
-    # Set to true, no matter what.
-    class AlwaysTrue
-      include Singleton
-
-      def value!(data, key, _value)
-        tap { data[key] = true }
-      end
-    end
-  end
-end

data/lib/hashcraft/mutators/array.rb

@@ -1,26 +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 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
-      include Singleton
-
-      def value!(data, key, value)
-        data[key] ||= []
-
-        data[key] << value
-
-        self
-      end
-    end
-  end
-end

data/lib/hashcraft/mutators/flat_array.rb

@@ -1,30 +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 Mutators # :nodoc: all
-    # If the value is an array then concat, if it is not an array then push.
-    class FlatArray
-      include Singleton
-
-      def value!(data, key, value)
-        data[key] ||= []
-
-        # Prefixed Array with double colons to not get confused with our Array mutator class.
-        if value.is_a?(::Array)
-          data[key] += value
-        else
-          data[key] << value
-        end
-
-        self
-      end
-    end
-  end
-end

data/lib/hashcraft/mutators/hash.rb

@@ -1,25 +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 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
-      include Singleton
-
-      def value!(data, key, value)
-        data[key] ||= {}
-        data[key].merge!(value || {})
-
-        self
-      end
-    end
-  end
-end

data/lib/hashcraft/mutators/property.rb

@@ -1,22 +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 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
-      include Singleton
-
-      def value!(data, key, value)
-        tap { data[key] = value }
-      end
-    end
-  end
-end

data/lib/hashcraft/transformer_registry.rb

@@ -1,26 +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.
-#
-
-require_relative 'transformers/camel_case'
-require_relative 'transformers/pascal_case'
-require_relative 'transformers/pass_thru'
-
-module Hashcraft
-  # Singleton that knows how to register and retrieve transformer instances.
-  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
-      )
-    end
-  end
-end

data/lib/hashcraft/transformers/camel_case.rb

@@ -1,27 +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 Transformers # :nodoc: all
-    # Transform snake-cased to camel-cased string. Example:
-    #   date_of_birth => dateOfBirth
-    #   DATE_OF_BIRTH => dateOfBirth
-    class CamelCase
-      include Singleton
-
-      def transform(value, _option)
-        return '' if value.to_s.empty?
-
-        name = value.to_s.split('_').collect(&:capitalize).join
-
-        name[0, 1].downcase + name[1..-1]
-      end
-    end
-  end
-end

data/lib/hashcraft/transformers/pascal_case.rb

@@ -1,25 +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 Transformers # :nodoc: all
-    # Transform snake-cased to pascal-cased string. Example:
-    #   date_of_birth => DateOfBirth
-    #   DATE_OF_BIRTH => DateOfBirth
-    class PascalCase
-      include Singleton
-
-      def transform(value, _option)
-        return '' if value.to_s.empty?
-
-        value.to_s.split('_').collect(&:capitalize).join
-      end
-    end
-  end
-end

data/lib/hashcraft/transformers/pass_thru.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 Transformers # :nodoc: all
-    # Default transformer, simply returns the value passed in.
-    class PassThru
-      include Singleton
-
-      def transform(value, _option)
-        value
-      end
-    end
-  end
-end