skn_utils 4.0.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 95950dfdf413d133698bc9614a5513cd5d91bf82
-  data.tar.gz: 9fc06b3576d657326af58ad7d4caa7ce20613f40
+  metadata.gz: a3753d9ee00c1e673e9a0871893dcb890daf35f0
+  data.tar.gz: d4c099ccade3b20002992624012fc5281f5e7901
 SHA512:
-  metadata.gz: dcb65cc5acde288729d5b11f0812ffd3a3c199ae1609492398fc06b96ce75246430ba21b945238494d28af65fe4e333193ec36baaa6797e84e55f8f5c984be4e
-  data.tar.gz: 60788d945065c38d3c0ed1ff2e5a889533c89223ced661275b6ab94a49242aa9c09810316b666bf983b19a0de525041db30a0b7d7ce8f894dfca79254b17bcb2
+  metadata.gz: 4bba7536ad36ebcfb79bf9dd4f73757de8ce7c56ea99f6227dfcd5b29c3464e5c2d807c34cb1668c266aed078c80c4e15aefa98d1b75aa3606ee6edf67ad0f79
+  data.tar.gz: 5f41b41a42d3f15197122936145357e89109411f126c189c92f6bb33d1a240c74769e0bdccd529073934fd8d30fc58da9c9dc8740969934446ef7da5c0223a8b

data/README.md

@@ -3,18 +3,46 @@
 
 # SknUtils
 #### SknUtils::NestedResult class; dynamic key/value container
-The intent of this gem is to be a container of data results or key/value pairs, with easy access to its contents, and on-demand transformation back to the hash (#to_hash).
+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).
 
-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 or Hash notational accessors to each key's value.  Additional key/value pairs can be added post-create
- by 'obj.my_new_var = "some value"', or simply assigning it.
+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"`
 
 * Transforms the initialing hash into accessible object instance values, with their keys as method names.
 * If the key's value is also a hash, it too will become an Object.
 * if the key's value is a Array of Hashes, or Array of Arrays of Hashes, each hash element of the Arrays will become an Object.
 * The current key/value (including nested) pairs are returned via #to_hash or #to_json when and if needed.
+* Best described as dot notation wrapper over a Ruby (Concurrent-Ruby) Hash.
+
+Ruby's Hash object is already extremely flexible, even more so with the addition of dot-notation.  As I work more with Ruby outside of Rails, I'm finding more use cases for the capabilities of this gem.  Here are a few examples:
+
+1. Application settings containers, SknSettings.  Loads Yaml file based on `ENV['RACK_ENV']` value, or specified file-key.
+    - Replaces Config and/or RBConfig Gems for yaml based settings
+1. Substitute for Rails.root, via a little ERB/YAML/Marshal statement in settings.yml file, and a helper class
+    - settings.yml (YAML)
+        - `root: <%= Dir.pwd %>`
+            - enables `SknSettings.root`
+        - `env:  !ruby/string:SknUtils::EnvStringHandler <%= ENV.fetch('RACK_ENV', 'development') %>`
+            - 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)
+```ruby
+    SknSettings.registry = {
+                            Services::Content::Commands::RetrieveAvailableResources  => method(:resources_metadata_service),
+                            Services::Content::Commands::RetrieveResourceContent  => method(:resource_content_service)
+                           }
+    ...
+    SknSettings.registry[ cmd.class ].call( cmd )
+    -- or --
+    SknSettings.registry.key?( cmd.class ) && cmd.valid? ?
+        SknSettings.registry[ 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.
 
-#### Primary Classes
+#### Available Classes
 * SknSettings
 * SknContainer
 * SknHash
@@ -26,7 +54,7 @@ Ruby Gem containing a Ruby PORO (Plain Old Ruby Object) that can be instantiated
 * SknUtils::EnvStringHandler
 * SknUtils::CoreObjectExtensions
 
-## New Features
+## History
     02/04/2018 V4.0.0
     Added SknUtils::CoreObjectExtensions, this module contains those popular Rails ActiveSupport extensions like `:present?`.
     - However, it is contructed with the Ruby `:refine` and `using SknUtils::CoreObjectExtensions` constraints, so as not to intefer with existing monkey-patches.
@@ -82,7 +110,7 @@ Ruby Gem containing a Ruby PORO (Plain Old Ruby Object) that can be instantiated
 
 
 ## Public Components
-    SknUtils::NestedResult           # >= V 3.0.0 Primary Key/Value Container with Dot/Hash notiation support.
+    SknUtils::NestedResult           # Primary Key/Value Container with Dot/Hash notiation support.
     SknHash                          # Wrapper for name only, WITHOUT SknUtils namespace, inherits from SknUtils::NestedResult
     SknUtils::ResultBean             # Wrapper for name only, inherits from SknUtils::NestedResult
     SknUtils::PageControls           # Wrapper for name only, inherits from SknUtils::NestedResult

data/lib/skn_utils/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skn_utils
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.0.1
 platform: ruby
 authors:
 - James Scott Jr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-05 00:00:00.000000000 Z
+date: 2018-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -142,7 +142,6 @@ files:
 - README.rdoc
 - Rakefile
 - _config.yml
-- bin/bench_linklists.rb
 - bin/bench_nested_result.rb
 - bin/console
 - lib/skn_container.rb

data/bin/bench_linklists.rb

@@ -1,94 +0,0 @@
-#!/usr/bin/env ruby
-
-#
-# Ref: https://github.com/evanphx/benchmark-ips
-#
-
-require 'bundler/setup'
-require 'skn_utils'
-require 'ostruct'
-require 'benchmark/ips'
-
-class GCSuite
-  def warming(*)
-    run_gc
-  end
-
-  def running(*)
-    run_gc
-  end
-
-  def warmup_stats(*)
-  end
-
-  def add_report(*)
-  end
-
-  private
-
-  def run_gc
-    GC.enable
-    GC.start
-    GC.disable
-  end
-end
-
-suite = GCSuite.new
-
-# Warming up --------------------------------------
-# LinkedList Ops     2.297k i/100ms
-#      Array Ops    34.468k i/100ms
-# Calculating -------------------------------------
-# LinkedList Ops     17.015k (±35.2%) i/s -     71.207k in   5.100193s
-#      Array Ops    377.943k (± 7.3%) i/s -      1.896M in   5.048217s
-#
-# Comparison:
-#       Array Ops:   377942.7 i/s
-# LinkedList Ops:    17015.4 i/s - 22.21x  slower
-
-
-Benchmark.ips do |x|
-  x.config(:suite => suite)
-
-  adders = [50, 10, 110, 6, 30, 101, 12, 33, 4]
-  vargs  = [70, 71, 72, 73, 74, 75, 76, 77, 78, 79]
-  cproc  = lambda {|a| a}
-
-  x.report('Array Ops') do
-    ary = Array.new(vargs)
-    # adders.each {|x| ary.push(x) }
-    adders.each {|x| ary.insert(5, x) }
-    value = ary.sort!
-    ary.first
-    ary.clear
-  end
-
-  x.report('Single Ops') do
-    ll = SknUtils::Lists::LinkedList.new(*vargs, &cproc)
-    # adders.each {|x| ll.insert(x) }
-    adders.each {|x| ll.insert_after(74, x) }
-    value = ll.sort!
-    ll.first
-    ll.clear
-  end
-
-  x.report('Double Ops') do
-    dll = SknUtils::Lists::DoublyLinkedList.new(*vargs, &cproc)
-    # adders.each {|x| dll.insert(x) }
-    adders.each {|x| dll.insert_after(74, x) }
-    value = dll.sort!
-    dll.first
-    dll.clear
-  end
-
-  x.report('Circulat Ops') do
-    cl = SknUtils::Lists::CircularLinkedList.new(*vargs, &cproc)
-    # adders.each {|x| cl.insert(x) }
-    adders.each {|x| cl.insert_after(74, x) }
-    value = cl.sort!
-    cl.first
-    cl.clear
-  end
-
-  x.compare!
-end