skn_utils 4.0.4 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c8d822f2476ea5f01e6862c6fbd47c40d359da3
-  data.tar.gz: cd4f1a35654e403618ae01a6f339ea015c91ad3d
+  metadata.gz: 3697c08bd7a516dbb2a55b859f12b18a1cd7e9ca
+  data.tar.gz: e38dac4af4d7e5da6dd5096b513e95e407784390
 SHA512:
-  metadata.gz: 4807810404d01d9f6410efdbb61b041992ccaf06d2814f80cf0df247e4d901d81865f15296d83f4245d5bb13396bfce7b95e79d2b81614371056ce1282067a0e
-  data.tar.gz: 17132674f1dd97946ab99ad8f6970f3a17d19e4c842a88eaf2ee04c7d52c14032e89bc8c97522558d18e49425ed25954d0a669c5665d9fdfc84d71cc3712a105
+  metadata.gz: 2223a7fb6597e014f2b94135f1c8626c12a798f3c6193cb1909fa887cc9aeb8ba311580f147f6289e18872b1961e8c431679d288d5cc88ae7a377c63aa39194a
+  data.tar.gz: 5ad2921a2d3cf465457f0f24f327a2286daff274cc9975e7f3d42fc46d9946074674a0ff8bd93863ab5e8001b66bff831292519f64899908bb4e2c6d7e36d798

data/README.md

@@ -44,17 +44,21 @@ There are many more use cases for Ruby's Hash that this gem just makes easier to
 
 #### Available Classes
 * SknSettings
+    * SknUtils::Configurable
+    * SknUtils::EnvStringHandler
 * SknContainer
 * SknHash
-* SknUtils::NestedResult
-* SknUtils::ResultBean
-* SknUtils::PageControls
-* SknUtils::Configurable
+    * SknUtils::NestedResult
+    * SknUtils::ResultBean
+    * SknUtils::PageControls
 * SknUtils::NullObject
-* SknUtils::EnvStringHandler
 * SknUtils::CoreObjectExtensions
 
 ## History
+    10/2/2018 V5.0.0
+    Modified SknContainer (IoC) to only use #register and #resolve as it's public API.
+    - Inspired by: [Andrew Holland](http://cv.droppages.com)
+
     09/30/2018 V4.0.4
     Updated EnvStringHandler class to behave like Rails.root in all respects.
 
@@ -124,12 +128,40 @@ There are many more use cases for Ruby's Hash that this gem just makes easier to
     SknSettings                      # Multi-level application Configuration class, Key/Value Container with Dot/Hash notiation support.
 
     SknUtils::Configurable           # Basic one-level configuration settings module for Applications and or Gems
+    SknContainer                     # Basic Key/Value container which #registers and #resolves procs, classes, and/or object
 
 
 ## Configuration Options
     None required other than initialization hash
 
 
+## Public Methods: SknContainer ONLY
+    SknContainer is global constant containing an initialized Object of Concurrent::Hash using defaults with additional methods.
+    Returns the keyed value as the original instance/value or if provided a proc the result of calling that proc.
+    To register a class or object for global retrieval, use the following API.  Also review the RSpecs for additional useage info.
+      #register(key, contents = nil, options = {}, &block)
+        - example: 
+            SknContainer.register(:some_klass, MyClass)                   -- class as value
+            SknContainer.register(:the_instance, MyClass.new)             -- Object Instance as value 
+            SknContainer.register(:unique_instance, -> {MyClass.new})     -- New Object Instance for each #resolve 
+
+            SknContainer                                                  -- #register return self to enable chaining
+                .register(:unique_instance, -> {MyClass.new})
+                  .register(:the_instance, MyClass.new)
+                    .register(:some_klass, MyClass)    
+            
+      #resolve(key)
+        - example:
+            klass  = SknContainer.resolve(:some_klass) 
+            result = SknContainer.resolve(:some_klass).new
+            
+            obj_instance1 = SknContainer.resolve(:unique_instance) 
+            obj_instance2 = SknContainer.resolve(:unique_instance)
+            
+            same_instance = SknContainer.resolve(:the_instance)
+
+
+
 ## Public Methods: SknSettings ONLY
     SknSettings is global constant containing an initialized Object of SknUtils::SknConfiguration using defaults
     To change the 'development'.yml default please use the following method early or in the case of Rails in 'application.rb

data/lib/skn_container.rb

@@ -1,12 +1,76 @@
-##
-# Register:
-#   SknContainer.<new.key> = AnyObject
+# ##
+#
+# Credits: Inspired by: andyholland1991@aol.com, http://cv.droppages.com
+#
+#   class UserRepository
+#     def self.first
+#       { name: 'Jack' }
+#     end
+#   end
+#
+#   class PersonRepository
+#     def first
+#       { name: 'Gill' }
+#     end
+#   end
+#
+## Using Classes
+#
+#   SknContainer.register(:user_repository, UserRepository)
+#   -- or --
+#   SknContainer.register(:user_repository, UserRepository, call: false )
+#
+#   SknContainer.resolve(:user_repository).first
+#
+##  Using Procs
+#
+#   SknContainer.register(:person_repository, -> { PersonRepository.new })
+#   -- or --
+#   SknContainer.register(:person_repository, -> { PersonRepository.new }, call: true )
 #
-# Resolve:
-#   SknContainer.<new.key>  # => AnyObject
-#   SknContainer.<new.key>?  # => True | False based on existance #
+#   SknContainer.resolve(:person_repository).first
 ##
 
 # This creates a global constant (and singleton) wrapping a Hash
-class << (SknContainer = SknUtils::NestedResult.new())
+class << (SknContainer = Concurrent::Hash.new)
+
+  class Content
+    attr_reader :item, :options
+
+    def initialize(item, options = {})
+      @item, @options = item, {
+          call: item.is_a?(::Proc)
+      }.merge(options)
+    end
+
+    def call
+      if options[:call] == true
+        item.call
+      else
+        item
+      end
+    end
+  end
+
+  def register(key, contents = nil, options = {}, &block)
+    if block_given?
+      item = block
+      options = contents if contents.is_a?(::Hash)
+    else
+      item = contents
+    end
+
+    self[key] = Content.new(item, options)
+
+    self # enable chaining
+  end
+
+  def resolve(key)
+    content = self.fetch(key) do
+      fail ArgumentError, "Nothing registered with the name #{key}"
+    end
+
+    content.call
+  end
+
 end

data/lib/skn_utils/version.rb

@@ -1,9 +1,9 @@
 # A better way to say it
 module SknUtils
   class Version
-    MAJOR = 4
+    MAJOR = 5
     MINOR = 0
-    PATCH = 4
+    PATCH = 0
 
     def self.to_s
       [MAJOR, MINOR, PATCH].join('.')

data/spec/lib/skn_utils/container_spec.rb

@@ -0,0 +1,61 @@
+##
+# spec/lib/skn_utils/container_spec.rb
+#
+
+class MyService
+  def value
+    true
+  end
+end
+
+
+
+describe SknContainer, "Gem D/I Lite Container module." do
+
+
+  context "Operational Features. " do
+
+    it "#register accepts a proc object to produce unique instances. " do
+      val = subject.register(:service, -> {MyService.new} )
+      expect( val ).to eq subject
+    end
+
+    it "#resolve returns new instances. " do
+      subject.register(:service, -> {MyService.new} )
+      val_a = subject.resolve(:service)
+      val_b = subject.resolve(:service)
+
+      expect( val_a ).to be_instance_of MyService
+      expect( val_a ).to_not be_equal val_b
+    end
+
+    it "#register accepts a class object and return self to enable chaining. " do
+      val = subject.register(:service_k, MyService).register(:more, "More")
+      expect( val ).to eq subject
+    end
+
+    it "#resolve returns class value. " do
+      subject.register(:service_k, MyService)
+      val = subject.resolve(:service_k)
+
+      expect( val ).to be_equal MyService
+      expect( val.new.value ).to be true
+    end
+
+    it "#resolve returns the same object value. " do
+      thingy = MyService.new
+      subject.register(:service_k, thingy)
+      val_a = subject.resolve(:service_k)
+      val_b = subject.resolve(:service_k)
+
+      expect( val_a ).to be_equal thingy
+      expect( val_a ).to be_equal val_b
+    end
+
+    it "#resolve raises ArgumentError when key is not found. " do
+      subject.register(:service_a, "AnyValue")
+      expect{subject.resolve(:no_find)}.to raise_error ArgumentError
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skn_utils
 version: !ruby/object:Gem::Version
-  version: 4.0.4
+  version: 5.0.0
 platform: ruby
 authors:
 - James Scott Jr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-01 00:00:00.000000000 Z
+date: 2018-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -184,6 +184,7 @@ files:
 - spec/factories/settings/test.yml
 - spec/lib/skn_settings_spec.rb
 - spec/lib/skn_utils/configurable_spec.rb
+- spec/lib/skn_utils/container_spec.rb
 - spec/lib/skn_utils/nested_result_spec.rb
 - spec/lib/skn_utils/notifier_base_spec.rb
 - spec/lib/skn_utils/null_object_spec.rb
@@ -222,6 +223,7 @@ test_files:
 - spec/factories/settings/test.yml
 - spec/lib/skn_settings_spec.rb
 - spec/lib/skn_utils/configurable_spec.rb
+- spec/lib/skn_utils/container_spec.rb
 - spec/lib/skn_utils/nested_result_spec.rb
 - spec/lib/skn_utils/notifier_base_spec.rb
 - spec/lib/skn_utils/null_object_spec.rb