skn_utils 3.1.4 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19745a2e2656ae6e549c7d9cfda1539fc06e011a
-  data.tar.gz: 27b7e896212e6d336c2ede19cd1f1d857476f282
+  metadata.gz: ecb548ae02a698328f3c04c7b9e7dbfd115804cb
+  data.tar.gz: eec07b8981a3778c0146e529cf635a402b7ca3d6
 SHA512:
-  metadata.gz: 99583604dd3ae0bbb11d0babd711e5ba7f1878c2bdf114da8f52deb6821ff459389c47ed490132eb448cb83ef7f12126bb6705f95126c4f647e59f57566e0d06
-  data.tar.gz: 5b7117ec60265bc0f2de853e2cf2a6b49ec41498e5247ea31e7ed5f935e078176be750f622fc41252a41e8d65c799c784dda272cc1f519ff4d1476f1f37da291
+  metadata.gz: b2297dc9806e0155a8cdf6e89051c699b4f41c871f89cb69cc6f07faf0159b230edfebfff452cb58684909e57e6fc6eb5cff9330b8a844a66a2548ccbd1f1e76
+  data.tar.gz: a8c18cc46ac4f2b6c770d2aad74c0505612aff180d37a235641a8587345a1ee3882411ba51dee464221c035954a13ec02156358b4ca9f901f6bb1cbfdb0b296d

data/Gemfile

@@ -1,6 +1,4 @@
 source 'https://rubygems.org'
 
-gem "deep_merge", '~> 1.1', :require => 'deep_merge/rails_compat'
-
 # Specify your gem's dependencies in skn_utils.gemspec
 gemspec

data/README.md

@@ -16,16 +16,14 @@ Ruby Gem containing a Ruby PORO (Plain Old Ruby Object) that can be instantiated
 
 
 ## New Features
-    07/2017  V3.1.4
+    07/2017  V3.1.5
     Added SknSettings class for use as a replacement to the popular, but obsolete, Config.gem
     SknSettings.load_configuration_basename!(config_file_name-only) or 'Rails.env.to_s' value, will load all the yml files in this order:
     ./config/settings.yml
-    ./config/settings/<name>.yml
-    ./config/settings/<name>.local.yml
-    and deep_merge the results.  Ya might have to add this gem statement to your Rails Application GemFile.
-                 gem 'deep_merge', '~> 1.1', :require => 'deep_merge/rails_compat'
+    ./config/settings/<config_name>.yml
+    ./config/settings/<config_name>.local.yml
     I also restored SknUtils:ResultBean and SknUtils::PageControls to the classes contained in this gem.  They are simple wrappers
-    inheriting the NestedResult class.
+    inheriting the NestedResult class.  Also added SknHash class as a wrapper without the SknUtils namespace required or exposed
 
     03/2017  V3.0.0
     Added SknUtils::NestedResult to replace, or be an alternate, to ResultBean, GenericBean, PageControls, ValueBean, and AttributeHelper.
@@ -54,33 +52,47 @@ Ruby Gem containing a Ruby PORO (Plain Old Ruby Object) that can be instantiated
     None required other than initialization hash
 
 
-## Public Methods
+## 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
+      #load_config_basename!(config_name) -- Where config_name is the name of yml files stored in the `./config/settings` directory
+      #config_path!(path)                 -- Where path format is './<dirs>/', default is: './config/'
+                                             and contains a settings.yml file and a 'path/settings/' directory
+
+    Paths ./config and ./config/settings must exist.
+    File ./config/settings.yml must exist and contain a valid YAML file structure.
+      ./config/settings.yml                              -- Required   base
+      ./config/settings/<config_name>.yml                -- Optional   base.deep_merge!()
+      ./config/settings/<config_name>.local.yml          -- Optional   base.deep_merge!()
+
+
+## Public Methods: SknUtils::NestedResult, SknHash & SknSettings
     Each concrete Class supports the following utility methods:
       #to_hash                       -- returns a hash of current key/value pairs, including nested
       #to_json                       -- returns a json string of current key/value pairs, including nested
       #hash_from(:base_key)          -- exports the internal hash starting with this base level key
       #obj.obj2.hash_from(:base)     -- exports the internal hash starting from this nested base level key
+
       #[]                            -- returns value of attr, when #[<attr_name_symbol>]
       #[]=(attr, value)              -- assigns value to existing attr, or creates a new key/value pair
-      #<attr>?                       -- detects true/false presence? of attr, and non-blank existance of attr's value; when #address?
       #<attr>                        -- returns value of named attribute
       #<attr> = (value)              -- assigns value to existing attr, or creates a new key/value pair
-      -- Where <attr> is a key value from the initial hash, or a key that was/will be dynamically added      
+      -- Where <attr> is a key value from the initial hash, or a key that was/will be dynamically added
 
+      #keys                          -- returns array of symbol #keys from current nested level
+      #==                            -- alias to #===
+      #===                           -- returns true/false from camparison of the two objects
+      #eql?                          -- returns true/false from camparison of the two objects
+      #<attr>?                       -- detects true/false presence? of attr, and non-blank existance of attr's value; when #address?
 
 
 ## Public Components
-    SknUtils::NestedResult                # >= V 3.0.0 Primary Key/Value Container with Dot/Hash notiation support.
-
-
-    *** <= V 2.0.6 Depreciated, HAS been removed ***
+    SknUtils::NestedResult           # >= V 3.0.0 Primary Key/Value Container with Dot/Hash notiation support.
+    SknSettings                      # Application Configuration class, Key/Value Container with Dot/Hash notiation support.
 
-    Inherit from NestedResultBase or instantiate an pre-built Class:
-      SknUtils::ResultBean                # => Not Serializable and follows hash values only.
-      SknUtils::PageControls              # => Serializable and follows hash values and arrays of hashes.
-      SknUtils::GenericBean               # => Serializable and follows hash values only.
-      SknUtils::ValueBean                 # => Serializable and DOES NOT follows hash values.
-    or Include SknUtils::AttributeHelpers # => Adds getter/setters, and hash notation access to instance vars of any object.
+    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
 
 
 ## Basic features include:
@@ -192,7 +204,7 @@ gem 'skn_utils'
 
 
 And then execute:
-    $ bundle
+    $ bundle install
 
 
 Or install it yourself as:
@@ -219,14 +231,20 @@ $ cd skn_utils
 $ bin/console
 
 [1] pry(main)> rb = SknUtils::NestedResult.new({sample: [{one: "one", two: "two"},{one: 1, two: 2}] })
-[2] pry(main)> pg = SknUtils::NestedResult.new({sample: [{three: 3, four: 4},{five: 'five', two: 'two'}] })
+[2] pry(main)> pg = SknHash.new({sample: [{three: 3, four: 4},{five: 'five', two: 'two'}] })
 [3] pry(main)> pg.sample.first.three
 [4] pry(main)> rb.sample.first.one
 [5] pry(main)> rb.sample.first[:one]
 [6] pry(main)> rb.hash_from(:sample)
 [7] pry(main)> rb.sample?
 [8] pry(main)> rb.sample[0].one?
-    
+...
+[10] pry(main)> cfg = SknSettings
+[11] pry(main)> cfg.config_path!('./spec/factories/')
+[12] pry(main)> cfg.load_config_basename!('test')
+[13] pry(main)> cfg.keys
+[14] pry(main)> cfg.Packaging.keys
+
 [n] pry(main)> exit
 * Done
 ```

data/bin/benchmark.rb

@@ -3,7 +3,6 @@
 require 'bundler/setup'
 require 'skn_utils'
 require 'ostruct'
-require 'psych'
 require 'benchmark/ips'
 
 Benchmark.ips do |x|

data/bin/console

@@ -1,9 +1,6 @@
 #!/usr/bin/env ruby
 
 require 'bundler/setup'
-require 'psych'
-require 'erb'
-require 'deep_merge/rails_compat'
 require 'skn_utils'
 
 require 'pry'

data/lib/skn_hash.rb

@@ -0,0 +1,6 @@
+##
+#
+
+class SknHash < SknUtils::NestedResult
+
+end

data/lib/skn_utils/nested_result.rb

@@ -173,6 +173,23 @@ module SknUtils
       end
     end
 
+    # returns hash from any root key starting point: object.root_key
+    # - protected to reasonably ensure key is a symbol
+    def hash_from(sym)
+      starting_sym = key_as_sym(sym)
+      bundle = ((starting_sym == container) ? container : { starting_sym => container[starting_sym] })
+      bundle.keys.each_with_object({}) do |attr,collector|
+        value = bundle[attr]
+        case value
+          when NestedResult
+            value = value.to_hash
+          when Array
+            value = value.map {|ele| array_to_hash(ele) }
+        end
+        collector[attr] = value                                                          # new copy
+      end
+    end
+
     protected
 
     def reset_from_empty!(params={})
@@ -214,23 +231,6 @@ module SknUtils
       @container ||= {}
     end
 
-    # returns hash from any root key starting point: object.root_key
-    # - protected to reasonably ensure key is a symbol
-    def hash_from(sym)
-      starting_sym = key_as_sym(sym)
-      bundle = ((starting_sym == container) ? container : { starting_sym => container[starting_sym] })
-      bundle.keys.each_with_object({}) do |attr,collector|
-        value = bundle[attr]
-        case value
-          when NestedResult
-            value = value.to_hash
-          when Array
-            value = value.map {|ele| array_to_hash(ele) }
-        end
-        collector[attr] = value                                                          # new copy
-      end
-    end
-
     # Feature: enables dot.notation and creates matching getter/setters
     def enable_dot_notation(sym)
       name = key_as_sym(sym)

data/lib/skn_utils/skn_configuration.rb

@@ -17,6 +17,10 @@ module SknUtils
       self
     end
 
+    def config_path!(fpath)
+      @base_path = fpath if File.exist?("#{fpath}settings.yml")
+    end
+
     private
 
     def load_config(conf)
@@ -26,11 +30,11 @@ module SknUtils
 
       yname   = "#{@base_path}settings/#{conf}.yml"
         f_env   = load_yml_with_erb(yname) if File.exist?(yname)
-        f_base  = f_base.deeper_merge!(f_env) unless (f_env.nil? || f_env.empty?)
+        f_base  = f_base.deep_merge!(f_env) unless (f_env.nil? || f_env.empty?)
 
       yname   = "#{@base_path}settings/#{conf}.local.yml"
         f_local = load_yml_with_erb(yname)  if File.exist?(yname)
-        f_base  = f_base.deeper_merge!(f_local) unless (f_local.nil? || f_local.empty?)
+        f_base  = f_base.deep_merge!(f_local) unless (f_local.nil? || f_local.empty?)
 
       f_base
     end

data/lib/skn_utils/version.rb

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

data/lib/skn_utils.rb

@@ -7,7 +7,13 @@ require 'skn_utils/notifier_base'
 require 'skn_utils/skn_configuration'
 require 'skn_utils/exploring/commander'
 require 'skn_utils/exploring/action_service'
-require 'deep_merge/rails_compat'
+require 'psych'
+require 'json'
+require 'erb'
+unless defined?(Rails)
+ require 'deep_merge'
+end
+require 'skn_hash'
 require 'skn_settings'
 
 module SknUtils

data/skn_utils.gemspec

@@ -19,16 +19,16 @@ with easy access to its contents, and on-demand transformation back to the hash
 Review the RSpec tests, and or review the README for more details.
 EOF
   spec.post_install_message = <<-EOF
-This version does not include ResultBean, PageControls, or ValueBean classes.  
-SknUtils::NestedResult class replaces those original classes and their function.  
+This version includes modified versions of SknUtils::ResultBean, SknUtils::PageControls classes, which inherit from  
+SknUtils::NestedResult class.  SknUtils::NestedResult replaces those original classes and consolidates their function.  
 
-Please update your existing code to make the above change or use the prior version 2.0.6
+Please update your existing code in consideration of the above change, or use the prior version 2.0.6.
 
 ATTENTION: **************************************************************** 
-    This version requires the following be added to your Rails Application 'Gemfile'
+    This version may require the following be added to your Rails Application 'Gemfile',
     if you are using the SknSettings configuration class.
 
-    gem 'deep_merge', '~> 1.1', :require => 'deep_merge/rails_compat'
+    gem 'deep_merge', '~> 1.1'
 
     ************************************************************************
 EOF
@@ -40,7 +40,7 @@ EOF
   spec.test_files    = spec.files.grep(%r{^(spec)/})
   spec.require_paths = ['lib']
 
-  # spec.add_runtime_dependency 'deep_merge', '~> 1.1'
+  spec.add_runtime_dependency 'deep_merge', '~> 1.1'
 
   spec.add_development_dependency "bundler", ">= 0"
   spec.add_development_dependency "rake", ">= 0"

data/spec/spec_helper.rb

@@ -11,11 +11,6 @@ SimpleCov.start do
   add_filter '/spec/'
 end
 
-require 'psych'
-require 'json'
-require 'erb'
-require 'deep_merge/rails_compat'
-
 require 'skn_utils'
 require 'skn_utils/exploring/commander'
 require 'skn_utils/exploring/action_service'
@@ -23,9 +18,6 @@ require 'skn_utils/exploring/configuration'
 
 require 'rspec'
 
-# Shared Examples and Support Routines
-Dir["./spec/support/**/*.rb"].sort.each { |f| require f}
-
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
   Kernel.srand config.seed

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: skn_utils
 version: !ruby/object:Gem::Version
-  version: 3.1.4
+  version: 3.2.0
 platform: ruby
 authors:
 - James Scott Jr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-13 00:00:00.000000000 Z
+date: 2017-07-14 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: deep_merge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -114,6 +128,7 @@ files:
 - Rakefile
 - bin/benchmark.rb
 - bin/console
+- lib/skn_hash.rb
 - lib/skn_settings.rb
 - lib/skn_utils.rb
 - lib/skn_utils/exploring/action_service.rb
@@ -142,13 +157,14 @@ homepage: https://github.com/skoona/skn_utils
 licenses:
 - MIT
 metadata: {}
-post_install_message: "This version does not include ResultBean, PageControls, or
-  ValueBean classes.  \nSknUtils::NestedResult class replaces those original classes
-  and their function.  \n\nPlease update your existing code to make the above change
-  or use the prior version 2.0.6\n\nATTENTION: ****************************************************************
-  \n    This version requires the following be added to your Rails Application 'Gemfile'\n
-  \   if you are using the SknSettings configuration class.\n\n    gem 'deep_merge',
-  '~> 1.1', :require => 'deep_merge/rails_compat'\n\n    ************************************************************************\n"
+post_install_message: "This version includes modified versions of SknUtils::ResultBean,
+  SknUtils::PageControls classes, which inherit from  \nSknUtils::NestedResult class.
+  \ SknUtils::NestedResult replaces those original classes and consolidates their
+  function.  \n\nPlease update your existing code in consideration of the above change,
+  or use the prior version 2.0.6.\n\nATTENTION: ****************************************************************
+  \n    This version may require the following be added to your Rails Application
+  'Gemfile',\n    if you are using the SknSettings configuration class.\n\n    gem
+  'deep_merge', '~> 1.1'\n\n    ************************************************************************\n"
 rdoc_options: []
 require_paths:
 - lib