hashcraft 1.0.0.pre.alpha.4 → 1.0.0.pre.alpha.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de90f4a4235178d5dd03c534a7b371583825795ea40b0218f678e5be516dbaba
-  data.tar.gz: 0227f29c0dc69de054f58abd31f854fe4f2a9fed7ad4ba60c439d8ca76d09cbe
+  metadata.gz: d9c8a4af5a05076883863320714728589bf2b49a0bd3b7f78e59be638697f6c9
+  data.tar.gz: 076117b9ba1523dc28f1eb62ce0cf19633d5eefc45db338e3633a325e5884234
 SHA512:
-  metadata.gz: 1d1376245cf1dbf76948e6241965287776c169cf3d2c5e2879e396be0697f3bac9eb25539c3b8198997f4a5f2b2a74a9dfa9943229cf7f2183eeb196bb4cfeaa
-  data.tar.gz: 4da6b340943dd7241ed820853892808664aea71ed7ea45047764aaf1cc63e6b703129d9ab446fcac49b2b8417ff6378d2142fb5329a6c855211bfdffab1f1c75
+  metadata.gz: 7075af55fa51130fb90ab52fe7456e374faef7aba9b32a82ff9d88cff488b95ba378049f997e44bbd1f48f80cfdb66a71fcc37432359662ef92c31115c65d371
+  data.tar.gz: a5dbad75e29f37aac42b0142bec8ea7cb9c167408d9691c80247adf82475ed92c9769e2bd6be0e9bebe82c7e344bd3e44d149337bed0bf725107c9fde6b710db

data/README.md

@@ -147,7 +147,7 @@ This means there is an available method called api_url that can be called to set
 * **eager**: always assign a value.  When true it will always assign the key a value.
 * **key**: allows for aliasing keys.  If omitted, the key will be the option's method name (api_url as noted above).
 * **meta**: used to store any arbitrary data that can be accessed with transformers.
-* **mutator**: defines the type of the data backing the method, defaulting to property.  When the default property is used then it will simply assign the passed in value.  Other values are: `hash` and `array`.  When hash is used then the passed in value will be merged onto the key's value.  When array is used then the passed in value will be pushed onto the key's value.
+* **mutator**: defines the *type of update* to be made to the underlying value, defaulting to `property`.  When the default, `property`, is used then it will simply assign the passed in value.  Some other options are: `hash` and `array`.  When hash is used then the passed in value will be merged onto the key's value.  When array is used then the passed in value will be pushed onto the key's value.  For other types see the `Hashcraft::MutatorRegistry` file.
 
 ### Internationalization Support
 
@@ -155,7 +155,7 @@ There is currently no first-class support for internationalization, but you can
 
 ### Transformers
 
-Transformers are optional but come into play when you need any additional/special processing of keys and values.  By default, keys and values use the pass-thru transformer (Hashable::Transformers::PassThru) but can be explicitly passed any object that responds to `#transform(value, option)`.
+Transformers are optional but come into play when you need any additional/special processing of keys and values.  By default, keys and values use the pass-thru transformer, `Hashcraft::Transformers::PassThru`, but can be explicitly passed any object that responds to `#transform(value, option)`.
 
 #### Key Transformer Example
 
@@ -171,12 +171,35 @@ Say, for example, we wanted to transform all keys to camel case.  We could creat
   end
 ````
 
-We can then use this when deriving hashes (using the above Grid example):
+We can then use this when deriving hashes (building on the Grid example above):
 
 ````ruby
+class Content < Hashcraft::Base
+  option :property
+end
+
+class Column < Hashcraft::Base
+  option :header
+
+  option :content, craft: Content,
+                   mutator: :array,
+                   key: :contents
+end
+
+class Grid < Hashcraft::Base
+  key_transformer CamelCase.new
+
+  option :api_url,
+         :name
+
+  option :column, craft: Column,
+                  mutator: :array,
+                  key: :columns
+end
+
 config = Grid.new do
   api_url '/patients'
-end.to_h(key_transformer: CamelCase.new)
+end.to_h
 ````
 
 The resulting `config` value will now be:
@@ -190,12 +213,23 @@ The resulting `config` value will now be:
 Note that this library ships with some basic transformers like the one mentioned above.  If you want to use this then you can simply do this:
 
 ````ruby
+class Grid < Hashcraft::Base
+  key_transformer :camel_case
+
+  option :api_url,
+         :name
+
+  option :column, craft: Column,
+                  mutator: :array,
+                  key: :columns
+end
+
 config = Grid.new do
   api_url '/patients'
-end.to_h(key_transformer: :camel_case)
+end.to_h
 ````
 
-See Hashcraft::TransformerRegistry for a full list of provided transformers.
+See the `Hashcraft::TransformerRegistry` file for a full list of provided transformers.
 
 #### Value Transformer Example
 
@@ -213,10 +247,12 @@ class Localizer
 end
 ````
 
-Building on our Grid example, we could enhance the Column object as such:
+Building on our Grid example, we could enhance the Column object:
 
 ````ruby
 class Column < Hashcraft::Base
+  value_transformer Localizer.new
+
   option :header, meta: { localize: true }
 
   option :content, craft: Content,
@@ -225,7 +261,7 @@ class Column < Hashcraft::Base
 end
 ````
 
-We can then use the new value transformer (Localizer) when deriving hashes (using the above Grid and updated Column example):
+We can then use the new value transformer, `Localizer`, when deriving hashes (building on the above Grid and updated Column example):
 
 ````yaml
 en:
@@ -237,7 +273,7 @@ en:
 config = Grid.new do
   column header: :id
   column header: :first
-end.to_h(value_transformer: Localizer.new)
+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:

data/lib/hashcraft/mutator_registry.rb

@@ -7,7 +7,10 @@
 # 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'
 
@@ -16,7 +19,10 @@ module Hashcraft
   class MutatorRegistry < Generic::Registry
     def initialize
       super(
+        '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

data/lib/hashcraft/mutators/always_false.rb

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

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

@@ -9,13 +9,14 @@
 
 module Hashcraft
   module Mutators
-    # When a hash's key is an arry then this mutator can be used to push a new value on the
+    # 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

data/lib/hashcraft/mutators/flat_array.rb

@@ -0,0 +1,30 @@
+# 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
+    # 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/property.rb

@@ -15,9 +15,7 @@ module Hashcraft
       include Singleton
 
       def value!(data, key, value)
-        data[key] = value
-
-        self
+        tap { data[key] = value }
       end
     end
   end

data/lib/hashcraft/option.rb

@@ -12,10 +12,6 @@ require_relative 'mutator_registry'
 module Hashcraft
   # Defines a method and corresponding attribute for a craftable class.
   class Option
-    extend Forwardable
-
-    def_delegators :mutator, :value!
-
     attr_reader :craft,
                 :default,
                 :eager,
@@ -39,6 +35,10 @@ module Hashcraft
       freeze
     end
 
+    def value!(data, key, value)
+      mutator.value!(data, key, value)
+    end
+
     def meta(key)
       internal_meta[key.to_s.to_sym]
     end

data/lib/hashcraft/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hashcraft
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.alpha.4
+  version: 1.0.0.pre.alpha.5
 platform: ruby
 authors:
 - Matthew Ruggio
@@ -138,7 +138,10 @@ files:
 - 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/option.rb