skn_utils 5.1.2 → 5.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '090c4c00d9e44ae01b59c322e713f83b8f55d9c8'
-  data.tar.gz: 0d518e1ba1b7c1d2c6863823da2f70c5ea47b3cc
+  metadata.gz: ab0d406a18ec9195e66f548bf411ac0180f3c5e9
+  data.tar.gz: 940e9429c70622331c953c03029b31f1af5cae27
 SHA512:
-  metadata.gz: bc9984b808ca93aff1e15a601f5471307ce01e21dc66299dbdde992a8bdb759bed67ec1ddcadcd0eb693de430ebc634bfaf2ea3c5d6f30f42fd54819df7c5106
-  data.tar.gz: 0ac31c49c966eabf65d0e88372627e6b0deb55c07cf1e38fc931042b8a1a570e5050ab9b8603bb94d791b1607e185fd4a12723e074041c59fe814244cc811e14
+  metadata.gz: 62c4dd21348287fb7503b4b30ca15443ca2b1bfe188f9b4e89b22c520e45fde18008b2f3c08df1d505ee6e287a806df14abaaf6e382467e586f7ba8309d66af9
+  data.tar.gz: a0821fe5d46bd2bb5cefa7829a77b0081383691fdd4ac0c75a9012294d34803da742c7ac1aacc8594b4b86a17c6a21e5d957c80ac0eb9d5f314755985a8286ec

data/README.md

@@ -27,7 +27,7 @@ Ruby's Hash object is already extremely flexible, even more so with the addition
             - enables `SknSettings.env.production?` ...
 1. Since SknSettings is by necessity a global constant, it can serve as Session Storage to keep system objects; like a ROM-RB instance.
 1. In-Memory Key-Store, use it to cache active user objects, or active Integration passwords, and/or objects that are not serializable.
-1. Command registries used to displatch command requests to proper command handler. see example app [SknBase](https://github.com/skoona/skn_base/blob/master/strategy/services/content/command_handler.rb)
+1. Command registries used to dispatch command requests to proper command handler. see example app [SknBase](https://github.com/skoona/skn_base/blob/master/strategy/services/content/command_handler.rb)
 ```ruby
     SknSettings.registry = {
                             Services::Content::Commands::RetrieveAvailableResources  => method(:resources_metadata_service),
@@ -60,6 +60,10 @@ There are many more use cases for Ruby's Hash that this gem just makes easier to
 
 
 ## History
+    10/17/2018 V5.1.3
+    Enhanced SknUtils::Configurable to include a #registry method/value at its root, like Clas.registry or Class.root
+    - Right now these are Class methods only, will update them to survive #new later.
+
     10/15/2018 V5.1.1
     Enhanced SknSettings to match 95% of the (Rb)Config.gem public API.
     
@@ -143,7 +147,7 @@ There are many more use cases for Ruby's Hash that this gem just makes easier to
         SknUtils::PageControls       # Wrapper for name only, inherits from SknUtils::NestedResult
         SknUtils::DottedHash         # Wrapper for name only, inherits from SknUtils::NestedResult
 
-    SknUtils::Configurable           # Basic one-level configuration Applications classes or modules. Adds MyClass.root,MyClass.env, and MyClass.logger, with MyClass.config.<user_attrs>
+    SknUtils::Configurable           # Basic one-level class configuration Module
 
     SknSettings                      # Multi-level application Configuration class, Key/Value Container with Dot/Hash notiation support.    
 
@@ -153,8 +157,66 @@ There are many more use cases for Ruby's Hash that this gem just makes easier to
     SknFailure                       # Three attribute value containers for return codes   -- #success, #message, #value
 
 
-## Configuration Options
-    None required 
+## Public Methods: SknUtils::Configurable module
+ For making an arbitrary class configurable and then specifying those configuration values using a clean and simple DSL.
+```ruby
+  ################
+  Inside Target component
+  ################
+  class MyApp
+    include SknUtils::Configurable.with(:app_id, :title, :cookie_name) # or {root_enable: false})
+    # ... default=true for root|env|logger
+  end
+
+  ################
+  Inside Initializer
+  ################
+  MyApp.configure do
+    app_id "my_app"
+    title "My App"
+    cookie_name { "#{app_id}_session" }
+  end
+
+  ################
+  During Definition
+  ################
+  class MyApp
+    include SknUtils::Configurable.with(:app_id, :title, :cookie_name, {root_enable: true})
+    # ...
+    configure do
+      app_id "my_app"
+      title "My App"
+      cookie_name { "#{app_id}_session" }
+    end
+
+    self.logger = Logger.new
+    self.env    = ENV.fetch('RACK_ENV', 'development')
+    self.root   = Dir.pwd
+  end
+
+  ################
+  Usage:
+  ################
+  MyApp.config.app_id # ==> "my_app"
+  MyApp.logger        # ==> <Logger.class>
+  MyApp.registry      # ==> <SknRegistry.instance> or user assigned object
+  MyApp.env.test?     # ==> true
+
+  ###############
+  Syntax
+  ###############
+  Main Class Attrs
+  - root     =  application rood directory as Pathname
+  - env      =  string value from RACK_ENV
+  - registry =  SknRegistry instance
+  - logger   =  Assigned Logger instance
+  #with(*user_attrs, enable_root: true|false) - defaults to enable of Main Class Attrs
+  
+  # ##
+  # User-Defined Attrs
+  # ## 
+  MyThing.with(:name1, :name2, ...)
+```
 
 
 ## Public Methods: SknContainer ONLY

data/lib/skn_utils/configurable.rb

@@ -37,8 +37,8 @@ module SknUtils
   #   end
   #
   #   self.logger = Logger.new
-  #   self.env = ENV.fetch('RACK_ENV', 'development')
-  #   self.root = Dir.pwd
+  #   self.env    = ENV.fetch('RACK_ENV', 'development')
+  #   self.root   = Dir.pwd
   # end
   #
   #################
@@ -52,9 +52,10 @@ module SknUtils
   # Syntax
   # ###############
   # Main Class Attrs
-  # - root    =  application rood directory as Pathname
-  # - env     =  string value from RACK_ENV
-  # - logger  =  Assiigned Logger instance
+  # - root     =  application rood directory as Pathname
+  # - env      =  string value from RACK_ENV
+  # - registry =  SknRegistry instance
+  # - logger   =  Assigned Logger instance
   # #with(*user_attrs, enable_root: true|false) - defaults to enable of Main Class Attrs
   # ##
   # User-Defined Attrs
@@ -103,6 +104,12 @@ module SknUtils
         if _app_main
           # Enable Rails<Like>.env and Rails.logger like feature:
           # - MyClass.env.production? or MyClass.logger or MyClass.root
+          def registry
+            @__registry ||= ::SknRegistry.new
+          end
+          def registry=(obj_instance)
+            @__registry = obj_instance
+          end
           def env
             @__env ||= ::SknUtils::EnvStringHandler.new( ENV.fetch('RACK_ENV', 'development') )
           end

data/lib/skn_utils/version.rb

@@ -3,7 +3,7 @@ module SknUtils
   class Version
     MAJOR = 5
     MINOR = 1
-    PATCH = 2
+    PATCH = 3
 
     def self.to_s
       [MAJOR, MINOR, PATCH].join('.')

data/spec/lib/skn_utils/configurable_spec.rb

@@ -4,10 +4,11 @@
 
 class MyApp
   include SknUtils::Configurable.with( :app_id, :title, :cookie_name, enable_root: true) # No options hash defaults to true
-  # - and accept defaults for #env=, #root=, and #logger=
+  # - and accept defaults for #env=, #root=, #registry=, and #logger=
 
   # notice: self.logger=, the self is required when assigning values
   self.logger = Object.new
+  self.registry = Object.new
 
   configure do
     app_id 'some app'
@@ -50,6 +51,9 @@ describe SknUtils::Configurable, "Gem Configuration module." do
     it "MyApp.logger returns expected value. " do
       expect( MyApp.logger ).to be_instance_of(Object) # eq('No Logger Assigned.')
     end
+    it "MyApp.registry returns expected value. " do
+      expect( MyApp.registry ).to be_instance_of(Object)
+    end
   end
 
   context "Module & Class Operational Features. " do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: skn_utils
 version: !ruby/object:Gem::Version
-  version: 5.1.2
+  version: 5.1.3
 platform: ruby
 authors:
 - James Scott Jr