skn_utils 3.0.2 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82fb6a798fdac8263ee4faa65a6dd734cf148365
-  data.tar.gz: 2dc5b9cc3fa76df1d7c9dbef494b8e9d2dcee707
+  metadata.gz: b8101dc2b931c238b66774b58096c9220b04978e
+  data.tar.gz: 4250acac9028a89de948d8c82986191d6471db09
 SHA512:
-  metadata.gz: f5d5410f5f06e63a85e054a36e27f20cd5a8c344c59453f992c36e3e28d9632ac256e10f96df6b03421649da3b64e5493808c48e42b5abbc1bce18206347b2c9
-  data.tar.gz: 217fc83650fff470b1a5869734747875727bfbcc374a2762e3562b1d610a90bd020505dfbb2ef2340bf09ddcc98791f2688e3095af5f6a0569eb3c86782c5219
+  metadata.gz: 9a0c6456e74196bad005876f4ff2d9a24635a22ab3d3a40f98daa7444461b33cc1a9d7fc868f22dd77db3da99a22935062cf17639c40760fbf74139d1669c49c
+  data.tar.gz: 7ae18c76e710f02b873165afc916ae97da9b7571bae75eb171e6f86869de684774815878141c389de52d19735e046e4fbde818169cdeb3535c4ff87ef6c5439a

data/Gemfile

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

data/bin/benchmark.rb

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'skn_utils'
+require 'ostruct'
+require 'psych'
+require 'benchmark/ips'
+
+Benchmark.ips do |x|
+
+  class RegularClass
+    attr_accessor :foo
+  end
+
+  class OpenStructClass < OpenStruct
+  end
+
+  x.report('regular class') do
+    r = RegularClass.new
+    r.foo = :bar
+    r.foo
+  end
+
+  x.report('OpenStruct class') do
+    o = OpenStructClass.new(foo: nil)
+    o.foo = :bar
+    o.foo
+  end
+
+  x.report('NestedResult class') do
+    n = SknUtils::NestedResult.new(foo: nil)
+    n.foo = :bar
+    n.foo
+  end
+end
+
+# Warming up --------------------------------------
+#      regular class   182.079k i/100ms
+#   OpenStruct class    12.129k i/100ms
+# NestedResult class    11.075k i/100ms
+# Calculating -------------------------------------
+#      regular class      4.140M (± 2.2%) i/s -     20.757M in   5.015689s
+#   OpenStruct class    129.418k (± 2.3%) i/s -    654.966k in   5.063580s
+# NestedResult class    115.819k (± 2.3%) i/s -    586.975k in   5.070852s

data/bin/console

@@ -1,8 +1,10 @@
 #!/usr/bin/env ruby
 
 require 'bundler/setup'
-require 'skn_utils'
 require 'psych'
+require 'erb'
+require 'deep_merge/rails_compat'
+require 'skn_utils'
 
 require 'pry'
 Pry.start

data/lib/skn_settings.rb

@@ -0,0 +1,11 @@
+##
+# Initialize:
+#   SknSettings.load_config_basename!('some_name')
+#
+# Usage:
+#   SknSettings.<config.key>[.<config.key>]...
+##
+
+# This creates a global constant (and singleton) with a defaulted configuration
+class << (SknSettings = SknUtils::SknConfiguration.new())
+end

data/lib/skn_utils/nested_result.rb

@@ -94,8 +94,7 @@ module SknUtils
   class NestedResult
 
     def initialize(params={})
-      @container =  {}
-      initialize_for_speed(params)
+      reset_from_empty!(params)
     end
 
     def [](attr)
@@ -170,12 +169,17 @@ module SknUtils
     def init_with(coder)
       case coder.tag
         when '!ruby/object:SknUtils::NestedResult', "!ruby/object:#{self.class.name}"
-          initialize_for_speed( coder.map['container'] )
+          reset_from_empty!( coder.map['container'] )
       end
     end
 
     protected
 
+    def reset_from_empty!(params={})
+      @container =  {}
+      initialize_for_speed(params)
+    end
+
     ##
     # Marshal.load()/.dump() support, chance to re-initialize value methods
     #
@@ -185,7 +189,7 @@ module SknUtils
 
     # Using the String from above create and return an instance of this class
     def marshal_load(hash)
-      initialize_for_speed(hash)
+      reset_from_empty!(hash)
     end
 
     def respond_to_missing?(method, incl_private=false)
@@ -316,10 +320,10 @@ module SknUtils
 
 
       if method.to_s.end_with?("=")                                    # add new key/value pair, transform value if Hash or Array
-        initialize_from_hash({method_nsym => args.first})
+        initialize_from_hash({method_nsym => args.first})         # Add Reader/Writer one first need
 
       elsif container.key?(method_sym)
-        container[enable_dot_notation(method_sym)]                # Add Reader/Writer one first need
+        container[method_sym]                                         # Add Reader/Writer one first need
 
       elsif method.to_s.end_with?('?')                                # order of tests is significant,
         attribute?(method_nsym)

data/lib/skn_utils/skn_configuration.rb

@@ -0,0 +1,47 @@
+#
+# @see SknSettings
+
+module SknUtils
+
+  class SknConfiguration < NestedResult
+
+    def initialize(params={})
+      default_mode = defined?(Rails) ? Rails.env : ENV.fetch('RAILS_ENV', 'development')
+      @config_filename = params.is_a?(String) ? params : params.fetch(:config_filename, default_mode)
+      @base_path = @config_filename.eql?('test') ? './spec/factories/' : './config/'
+      load_config_basename!(@config_filename)
+    end
+
+    def load_config_basename!(conf)
+      reset_from_empty!(load_config(conf))
+      self
+    end
+
+    private
+
+    def load_config(conf)
+      yname   = "#{@base_path}settings.yml"
+        return {} unless File.exist?(yname)
+        f_base  = load_yml_with_erb(yname)
+
+      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?)
+
+      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
+    end
+
+    def load_yml_with_erb(yml_file)
+      erb = ERB.new(File.read(yml_file)).result
+      erb.empty? ? {} : Psych.load(erb)
+    rescue => e
+      puts "#{self.class.name}##{__method__} Class: #{e.class}, Message: #{e.message}"
+      {}
+    end
+  end
+
+end

data/lib/skn_utils/version.rb

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

data/lib/skn_utils.rb

@@ -2,8 +2,10 @@ require "skn_utils/version"
 require 'skn_utils/nested_result'
 require 'skn_utils/null_object'
 require 'skn_utils/notifier_base'
+require 'skn_utils/skn_configuration'
 require 'skn_utils/exploring/commander'
 require 'skn_utils/exploring/action_service'
+require 'skn_settings'
 
 module SknUtils
 

data/skn_utils.gemspec

@@ -31,10 +31,11 @@ EOF
   spec.executables   = []
   spec.test_files    = spec.files.grep(%r{^(spec)/})
   spec.require_paths = ['lib']
-  
+
   spec.add_development_dependency "bundler", ">= 0"
   spec.add_development_dependency "rake", ">= 0"
   spec.add_development_dependency "rspec", '~> 3.0'
   spec.add_development_dependency "pry", ">= 0"
   spec.add_development_dependency "simplecov", ">= 0"
+  spec.add_development_dependency 'benchmark-ips'
 end

data/spec/factories/settings/test.local.yml

@@ -0,0 +1,3 @@
+---
+Packaging:
+  configName: test.local

data/spec/factories/settings/test.yml

@@ -0,0 +1,5 @@
+---
+Packaging:
+  isTest: true
+  isDevelopment: false
+  configName: test

data/spec/factories/settings.yml

@@ -0,0 +1,9 @@
+---
+Packaging:
+  pomVersion: <%= SknUtils::VERSION %>
+  isTest: false
+  isDevelopment: true
+  isStaging: false
+  isProduction: false
+  configName: development
+  short_name: skn

data/spec/lib/skn_settings_spec.rb

@@ -0,0 +1,10 @@
+#
+
+describe SknSettings, "Application Configuration" do
+
+  it 'contains the test settings for the application' do
+    expect(SknSettings.Packaging.pomVersion).to eq SknUtils::VERSION
+    expect(SknSettings.Packaging.configName).to eq 'test.local'
+    expect(SknSettings.Packaging.isTest).to be true
+  end
+end

data/spec/spec_helper.rb

@@ -1,4 +1,18 @@
-ENV['RAILS_ENV'] ||= 'test'
+ENV['RAILS_ENV'] = 'test'
+
+require 'bundler/setup'
+
+require 'simplecov'
+
+SimpleCov.start do
+  # any custom configs like groups and filters can be here at a central place
+  add_filter '/spec/'
+end
+
+require 'psych'
+require 'json'
+require 'erb'
+require 'deep_merge/rails_compat'
 
 require 'skn_utils'
 require 'skn_utils/exploring/commander'
@@ -6,8 +20,6 @@ require 'skn_utils/exploring/action_service'
 require 'skn_utils/exploring/configuration'
 
 require 'rspec'
-require 'psych'
-require 'json'
 
 # Shared Examples and Support Routines
 Dir["./spec/support/**/*.rb"].sort.each { |f| require f}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skn_utils
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.1.0
 platform: ruby
 authors:
 - James Scott Jr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-07 00:00:00.000000000 Z
+date: 2017-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: "The intent of the NestedResult class is to be a container of data results
   or key/value pairs, \nwith easy access to its contents, and on-demand transformation
   back to the hash (#to_hash).\n\nReview the RSpec tests, and or review the README
@@ -98,7 +112,9 @@ files:
 - README.md
 - README.rdoc
 - Rakefile
+- bin/benchmark.rb
 - bin/console
+- lib/skn_settings.rb
 - lib/skn_utils.rb
 - lib/skn_utils/exploring/action_service.rb
 - lib/skn_utils/exploring/commander.rb
@@ -106,8 +122,13 @@ files:
 - lib/skn_utils/nested_result.rb
 - lib/skn_utils/notifier_base.rb
 - lib/skn_utils/null_object.rb
+- lib/skn_utils/skn_configuration.rb
 - lib/skn_utils/version.rb
 - skn_utils.gemspec
+- spec/factories/settings.yml
+- spec/factories/settings/test.local.yml
+- spec/factories/settings/test.yml
+- spec/lib/skn_settings_spec.rb
 - spec/lib/skn_utils/exploring/action_service_spec.rb
 - spec/lib/skn_utils/exploring/commander_spec.rb
 - spec/lib/skn_utils/exploring/configuration_spec.rb
@@ -144,6 +165,10 @@ specification_version: 4
 summary: SknUtils contains a small collection of Ruby utilities, the first being a
   NestedResult a key/value container.
 test_files:
+- spec/factories/settings.yml
+- spec/factories/settings/test.local.yml
+- spec/factories/settings/test.yml
+- spec/lib/skn_settings_spec.rb
 - spec/lib/skn_utils/exploring/action_service_spec.rb
 - spec/lib/skn_utils/exploring/commander_spec.rb
 - spec/lib/skn_utils/exploring/configuration_spec.rb