skn_utils 5.3.0 → 5.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b812d7904cab21c79e37afec4bf5c9eb2f67336
-  data.tar.gz: 966367ddcb978a3bb2eb6eeea71a89c93b3ee347
+  metadata.gz: faaa010ea403a5bfbf20386ee86a9c68e8982da1
+  data.tar.gz: 909be6bef4b46a41bfd293d35a3059396d4adba5
 SHA512:
-  metadata.gz: 595bf74de49521fe61e6ec10dee7f1c56b97798096ff540e03e1bdc92e92c82e7b805018150bfb0495bca45b74c1c76ac6c9bc38aee19b774a8a081f2b6aa327
-  data.tar.gz: 1b57076cadc213712426727bcaac68a546f99f0cab187b15618b8799d106b8019d056742aa87ef092af9f271e7cf6a704bc43990ab6dd7d84fcdeb7ea7bd06d2
+  metadata.gz: 46f92868aaecee7ece92b3d1c4b5bc33b5643e8c2de3a5f442e5141edb2b45d5a4cb8d4bd29e24241a34001b253abec38fe381e8ca8d798dc8eb6d662fdc12c2
+  data.tar.gz: 81c41c8dda9b50797a76005a29cb329b2d8bc9da0af585d1848124a54606ac1f3a9d8bb8bb1d6ec5b2806df0002d673849425ca68290121e4ac327c7b94f784d

data/README.md

@@ -2,9 +2,7 @@
 [![Gem Version](https://badge.fury.io/rb/skn_utils.svg)](http://badge.fury.io/rb/skn_utils)
 
 # SknUtils
-#### SknUtils::NestedResult class; dynamic key/value container
-The intent of this gem is to be a container of nestable data results or key/value pairs, with easy access to its contents and on-demand transformation back to the creating hash (#to_hash).
-
+## SknUtils::NestedResult class; dynamic key/value container
 A Ruby Gem containing a Ruby PORO (Plain Old Ruby Object) that can be instantiated at runtime with an input hash.  This library creates
  an Object with Dot and Hash notational accessors to each key's value.  Additional key/value pairs can be added post-create
  by simply assigning it; `obj.my_new_var = "some value"`
@@ -29,20 +27,20 @@ Ruby's Hash object is already extremely flexible, even more so with the addition
 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 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 = {
+    SknSettings.command_handler = {
                             Commands::RetrieveAvailableResources  => method(:resources_metadata_service),
                             Commands::RetrieveResourceContent  => method(:resource_content_service)
                            }
     ...
-    SknSettings.registry[ cmd.class ].call( cmd )
+    SknSettings.command_handler[ cmd.class ].call( cmd )
     -- or --
-    SknSettings.registry.key?( cmd.class ) && cmd.valid? ?
-        SknSettings.registry[ cmd.class ].call( cmd ) :
-        command_not_found_action()
+    SknSettings.command_handler.key?( cmd.class ) && cmd.valid? ?
+        SknSettings.command_handler[ cmd.class ].call( cmd ) : command_not_found_action()
 ```
 There are many more use cases for Ruby's Hash that this gem just makes easier to implement.
 
-#### Available Classes
+
+## Available Classes
 * SknSuccess
 * SknFailure
 * SknSettings
@@ -58,10 +56,21 @@ There are many more use cases for Ruby's Hash that this gem just makes easier to
 * SknUtils::CoreObjectExtensions
 * SknUtils::Configurable
 
+## Available Class.Methods
+* SknUtils.catch_exceptions()
+* SknUtils.as_human_size()
+* SknUtils.duration(start_time=nil)
+
+
 
 ## History
+    12/16/2018 V5.4.0
+    Added :duration() utils to SknUtils module: 
+        #duration()            #=> returns start_time value 
+        #duration(start_time)  #=> returns elapsed-time as string, "%3.3f seconds"
+
     11/09/2018 V5.3.0
-    Added two utils to SknUtils class: 
+    Added two utils to SknUtils module: 
         #catch_exceptions(&blk)  #=> catch all exceptions and retry block x times 
         #as_human_size(12345)    #=> 12 KB
     - See related RSpecs
@@ -165,18 +174,20 @@ There are many more use cases for Ruby's Hash that this gem just makes easier to
 
 
 ## Public Methods: SknUtils::Configurable module
- For making an arbitrary class configurable and then specifying those configuration values using a clean and simple DSL.
+ For making an arbitrary class configurable and then specifying those configuration values. 
 ```ruby
+  # (1) First establish the method names of class values desired.
   ################
-  Inside Target component
+  # 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
 
+  # (2) Set initial values for those class values in a Rails Initializer, or before use.
   ################
-  Inside Initializer
+  # Inside Initializer
   ################
   MyApp.configure do
     app_id "my_app"
@@ -184,8 +195,9 @@ There are many more use cases for Ruby's Hash that this gem just makes easier to
     cookie_name { "#{app_id}_session" }
   end
 
+  # (2) Or set initial values for those class values when defining the class.
   ################
-  During Definition
+  # During Definition
   ################
   class MyApp
     include SknUtils::Configurable.with(:app_id, :title, :cookie_name, {root_enable: true})
@@ -201,8 +213,9 @@ There are many more use cases for Ruby's Hash that this gem just makes easier to
     self.root   = Dir.pwd
   end
 
+  # (3) Remember they are class values, use as needed.
   ################
-  Usage:
+  # Usage:
   ################
   MyApp.config.app_id # ==> "my_app"
   MyApp.logger        # ==> <Logger.class>
@@ -210,10 +223,10 @@ There are many more use cases for Ruby's Hash that this gem just makes easier to
   MyApp.env.test?     # ==> true
 
   ###############
-  Syntax
+  # Syntax
   ###############
-  Main Class Attrs
-  - root     =  application rood directory as Pathname
+  # Main Class Attrs  -- defaults
+  - root     =  application root directory as Pathname
   - env      =  string value from RACK_ENV
   - registry =  SknRegistry instance
   - logger   =  Assigned Logger instance
@@ -227,16 +240,17 @@ There are many more use cases for Ruby's Hash that this gem just makes easier to
 
 
 ## Public Methods: SknContainer ONLY
-    SknContainer is global constant containing an initialized Object of Concurrent::Hash using defaults with additional methods.
+    SknContainer is global constant assigned to an instantiated instance of SknRegistry.
     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 = {})
         - 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
+            SknContainer                                                  -- #register returns self to enable chaining
                 .register(:unique_instance, -> {MyClass.new})
                   .register(:the_instance, MyClass.new)
                     .register(:some_klass, MyClass)    

data/lib/skn_utils/version.rb

@@ -2,7 +2,7 @@
 module SknUtils
   class Version
     MAJOR = 5
-    MINOR = 3
+    MINOR = 4
     PATCH = 0
 
     def self.to_s

data/lib/skn_utils.rb

@@ -44,7 +44,8 @@ module SknUtils
     attempts = retries
     begin
 
-      SknSuccess.( yield )
+      res = yield
+      [SknFailure, SknFailure].any? {|o| res.kind_of?(o) } ? res : SknSuccess.( res )
 
     rescue StandardError, ScriptError => error
       puts "#{retry_count} - #{error.class.name}:#{error.message}"
@@ -53,7 +54,7 @@ module SknUtils
         sleep(pause_between)
         retry
       else
-        SknFailure.( "RETRY ATTEMPTS FAILED - #{error.class.name}:#{error.message}" )
+        SknFailure.( "RETRY ATTEMPTS FAILED - #{error.class.name}:#{error.message}", error.backtrace[0..5].to_s )
       end
     end
   end # end method
@@ -77,5 +78,11 @@ module SknUtils
     ((num > 9 || num.modulo(1) < 0.1) ? '%d %s' : '%.1f %s') % [num, units[exp]]
   end
 
+  # call without to get start time
+  # call with start_time to get duration string
+  def self.duration(start_time=nil)
+    start_time.nil? ? Process.clock_gettime(Process::CLOCK_MONOTONIC) :
+        "%3.3f seconds" % (Process.clock_gettime(Process::CLOCK_MONOTONIC) - start_time)
+  end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skn_utils
 version: !ruby/object:Gem::Version
-  version: 5.3.0
+  version: 5.4.0
 platform: ruby
 authors:
 - James Scott Jr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-10 00:00:00.000000000 Z
+date: 2018-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge