skn_utils 5.4.0 → 5.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: faaa010ea403a5bfbf20386ee86a9c68e8982da1
-  data.tar.gz: 909be6bef4b46a41bfd293d35a3059396d4adba5
+  metadata.gz: a38f9d3fd144a0b4d591b492fd5dd4ba2c9e448a
+  data.tar.gz: 9d5bdceb553ee84f17d37c8f8b3c06d1126f831e
 SHA512:
-  metadata.gz: 46f92868aaecee7ece92b3d1c4b5bc33b5643e8c2de3a5f442e5141edb2b45d5a4cb8d4bd29e24241a34001b253abec38fe381e8ca8d798dc8eb6d662fdc12c2
-  data.tar.gz: 81c41c8dda9b50797a76005a29cb329b2d8bc9da0af585d1848124a54606ac1f3a9d8bb8bb1d6ec5b2806df0002d673849425ca68290121e4ac327c7b94f784d
+  metadata.gz: c1d14426f03a6b19cb668f596ccf777352e78295c3c36c7dbe11b56939e90e0b79adb3676b09ab16a61f3167b8089c2f97a40ef846185ac17b527bac04edab04
+  data.tar.gz: 296386960a3ee3d438334fb1a0ded9ae275632ce5bbf6f486cbdbdab18b5904d6f82c9b33373a0632e7c14e34156230ba2b6c1c9008c27305ba7541f15b0435b

data/lib/skn_container.rb

@@ -1,4 +1,5 @@
-# ##
+# frozen_string_literal: true
+
 # ##
 # SknContainer
 # - Key/Value Container where keys and/or values can be any valid Ruby Class, Proc, Instance, or object.

data/lib/skn_failure.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # ##
 # Bad Result
 #

data/lib/skn_hash.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ##
 #
 

data/lib/skn_registry.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # ##
 # SknRegistry
 # - Key/Value Container where keys and/or values can be any valid Ruby Class, Proc, Instance, or object.

data/lib/skn_settings.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ##
 # Initialize:
 #   SknSettings.load_config_basename!('some_name')

data/lib/skn_success.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # ##
 # Good Result
 #

data/lib/skn_utils/configurable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ##
 # File: <gem-root>/lib/skn_utils/configurable.rb
 #  Ref: https://www.toptal.com/ruby/ruby-dsl-metaprogramming-guide
@@ -25,7 +27,7 @@ module SknUtils
   # end
   #
   #################
-  # During Definition
+  # -or- During Definition
   #################
   # class MyApp
   #   include SknUtils::Configurable.with(:app_id, :title, :cookie_name, {root_enable: true})
@@ -36,6 +38,7 @@ module SknUtils
   #     cookie_name { "#{app_id}_session" }
   #   end
   #
+  #   # these are the root_enable default settings
   #   self.logger = Logger.new
   #   self.env    = ENV.fetch('RACK_ENV', 'development')
   #   self.root   = Dir.pwd
@@ -65,9 +68,9 @@ module SknUtils
 
   module Configurable
 
-    def self.with(*attrs, **options)
+    def self.with(*config_attrs, **root_options)
       _not_provided = Object.new
-      _app_main = options.empty? || options.values.any?{|v| v == true}
+      _root_options = root_options.empty? || root_options.values.any?{|v| v == true}
 
       # Define the config class/module methods
       config_class = Class.new do
@@ -79,7 +82,7 @@ module SknUtils
           instance_variable_set("@#{attr}", val)
         end
 
-        attrs.each do |attr|
+        config_attrs.each do |attr|
           define_method attr do |value = _not_provided, &block|
             if value === _not_provided && block.nil?
               result = instance_variable_get("@#{attr}")
@@ -90,7 +93,7 @@ module SknUtils
           end
         end
 
-        attr_writer *attrs
+        attr_writer *config_attrs
       end
 
       # Define the runtime access methods
@@ -101,7 +104,7 @@ module SknUtils
         def configure(&block)
           config.instance_eval(&block)
         end
-        if _app_main
+        if _root_options
           # Enable Rails<Like>.env and Rails.logger like feature:
           # - MyClass.env.production? or MyClass.logger or MyClass.root
           def registry
@@ -142,3 +145,12 @@ module SknUtils
 
   end # end module
 end # End module
+
+#
+# def [](key)
+#   @internal_var[key]
+# end
+#
+# def []=(key, value)
+#   @internal_var[key] = value
+# end

data/lib/skn_utils/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # ##
 # lib/skn_utils/configuration.rb
 #

data/lib/skn_utils/core_extensions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # ##
 # File: ./lib/skn_utils/core_extensions.rb  --
 # -- from: Rails 4.1 ActiveSupport:lib/active_support/core_ext/object/blank.rb

data/lib/skn_utils/dotted_hash.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module SknUtils
   class DottedHash < NestedResult

data/lib/skn_utils/env_string_handler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # File: ./lib/skn_utils/env_string_handler.rb
 #
 # Wrapping a string in this class gives you a prettier way to test

data/lib/skn_utils/nested_result.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ##
 # <project.root>/lib/skn_utils/nested_result.rb
 #

data/lib/skn_utils/notifier_base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 #
 # Ruby Notify like class

data/lib/skn_utils/null_object.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #
 # lib/skn_utils/null_object.rb
 #

data/lib/skn_utils/page_controls.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 
 module SknUtils
   class PageControls < NestedResult

data/lib/skn_utils/result_bean.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 
 module SknUtils
   class ResultBean < NestedResult

data/lib/skn_utils/version.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 # A better way to say it
 module SknUtils
   class Version
     MAJOR = 5
     MINOR = 4
-    PATCH = 0
+    PATCH = 1
 
     def self.to_s
       [MAJOR, MINOR, PATCH].join('.')

data/lib/skn_utils/wrappable.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# ##
+#
+# Ref: https://blog.appsignal.com/2018/10/02/ruby-magic-class-level-instance-variables.html
+
+module SknUtils
+
+  module Wrappable
+    def wrap(mod)
+      wrappers << mod
+    end
+
+    def wrappers
+      @wrappers ||= []
+    end
+
+    def inherited_wrappers
+      ancestors
+          .grep(Wrappable)
+          .reverse
+          .flat_map(&:wrappers)
+    end
+
+    def new(*arguments, &block)
+      instance = allocate
+      inherited_wrappers.each { |mod|instance.singleton_class.include(mod) }
+      instance.send(:initialize, *arguments, &block)
+      instance
+    end
+  end
+end

data/lib/skn_utils.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 
 require "skn_utils/version"
 require 'psych'
@@ -25,6 +27,7 @@ require 'skn_utils/null_object'
 require 'skn_utils/notifier_base'
 require 'skn_utils/configuration'
 require 'skn_utils/configurable'
+require 'skn_utils/wrappable'
 
 require 'skn_hash'
 require 'skn_registry'

data/skn_utils.gemspec

@@ -1,5 +1,6 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
+# lib = File.expand_path('../lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'skn_utils/version'
 

data/spec/lib/skn_utils/configurable_spec.rb

@@ -2,51 +2,20 @@
 # spec/lib/skn_utils/configurable_spec.rb
 #
 
-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=, #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'
-    title 'My Title'
-    cookie_name 'Chocolate'
-  end
-
-  def null_value
-    @app_id.dup
-  end
-end
-
-module MyMod
-  include SknUtils::Configurable.with(:app_id, :title, :cookie_name,  enable_root: false)
-
-  def self.null_value
-    @app_id.dup
-  end
-end
-
-MyMod.configure do
-  app_id 'some module'
-  title 'Some Title'
-  cookie_name 'Caramel'
-end
+require "support/configurables"
 
 
 describe SknUtils::Configurable, "Gem Configuration module." do
 
   let(:my_app) { MyApp.new }
 
-  context "Top Level AppClass Extra Operational Features. " do
+  context "MyApp: Top Level AppClass Extra Operational Features. " do
 
     it "MyApp.env.test? returns expected value. " do
       expect( MyApp.env.test? ).to be true
     end
     it "MyApp.root returns expected value. " do
-      expect( MyApp.root.realdirpath.to_s ).to eq( Dir.pwd )
+      expect( MyApp.root ).to eq( Dir.pwd )
     end
     it "MyApp.logger returns expected value. " do
       expect( MyApp.logger ).to be_instance_of(Object) # eq('No Logger Assigned.')
@@ -60,9 +29,11 @@ describe SknUtils::Configurable, "Gem Configuration module." do
 
     it "my_app#config.title returns expected value. " do
       expect( MyApp.config.title ).to eq( "My Title" )
+      expect( MyApp.config[:title] ).to eq( "My Title" )
     end
-    it "my_app#config.app_id returns expected value. " do
-      expect( MyApp.config.app_id ).to eq( "some app" )
+    it "my_app#config[:value] accepts and returns expected value. " do
+      expect( MyApp.config[:value]="New Attribute" ).to eq( "New Attribute" )
+      expect( MyApp.config[:value] ).to eq( "New Attribute" )
     end
 
     it "MyMod#config.app_id  returns expected value. " do
@@ -70,6 +41,11 @@ describe SknUtils::Configurable, "Gem Configuration module." do
     end
     it "MyMod#config.cookie_name returns expected value. " do
       expect( MyMod.config.cookie_name ).to eq( 'Caramel' )
+      expect( MyMod.config[:cookie_name] ).to eq( 'Caramel' )
+    end
+    it "MyMod#config[:value] accepts and returns expected value. " do
+      expect( MyMod.config[:value]="New Attribute" ).to eq( "New Attribute" )
+      expect( MyMod.config[:value] ).to eq( "New Attribute" )
     end
 
     it "MyMod#logger raises NoMethodError as expected. " do
@@ -78,4 +54,15 @@ describe SknUtils::Configurable, "Gem Configuration module." do
 
   end
 
+  context "#config instance vars are accessable as expected. " do
+
+    it "MyApp#null_value to return expected value" do
+      expect(my_app.null_value).to eq "some app"
+      expect{ MyApp.null_value }.to raise_error(NoMethodError)
+    end
+
+    it "MyMod#null_value to return expected value" do
+      expect( MyMod.null_value ).to eq "some module"
+    end
+  end
 end

data/spec/lib/skn_utils/wrappers_spec.rb

@@ -0,0 +1,80 @@
+# ##
+#
+
+module Powered
+  def make_noise
+    puts "Powering up"
+    super
+    puts "Shutting down"
+  end
+end
+
+class Machine
+  extend SknUtils::Wrappable
+
+  wrap Powered
+
+  def make_noise
+    puts "Buzzzzzz"
+  end
+end
+
+
+module Logging
+  def make_noise
+    puts "Started making noise"
+    super
+    puts "Finished making noise"
+  end
+end
+
+class Bird
+  extend SknUtils::Wrappable
+
+  wrap Logging
+
+  def make_noise
+    puts "Chirp, chirp!"
+  end
+end
+
+
+module Flying
+  def make_noise
+    super
+    puts "Is flying away"
+  end
+end
+
+class Pigeon < Bird
+  wrap Flying
+
+  def make_noise
+    puts "Coo!"
+  end
+end
+
+describe 'SknUtils::Wrappable Module Handles Inheritance properly ' do
+
+  it '#make_noise handles Bird module. ' do
+    expect do
+      obj = Bird.new
+      obj.make_noise
+    end.to output("Started making noise\nChirp, chirp!\nFinished making noise\n").to_stdout
+  end
+
+  it '#make_noise handles Pigeon module. ' do
+    expect do
+      obj = Pigeon.new
+      obj.make_noise
+    end.to output("Started making noise\nCoo!\nFinished making noise\nIs flying away\n").to_stdout
+  end
+
+  it '#make_noise handles Machine module. ' do
+    expect do
+      obj = Machine.new
+      obj.make_noise
+    end.to output("Powering up\nBuzzzzzz\nShutting down\n").to_stdout
+  end
+
+end

data/spec/support/configurables.rb

@@ -0,0 +1,36 @@
+##
+# spec/support/configurables.rb
+#
+
+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=, #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'
+    title 'My Title'
+    cookie_name 'Chocolate'
+  end
+
+  def null_value
+    self.class.config.app_id.dup
+  end
+end
+
+module MyMod
+  include SknUtils::Configurable.with(:app_id, :title, :cookie_name,  enable_root: false)
+
+  def self.null_value
+    config.app_id.dup
+  end
+end
+
+MyMod.configure do
+  app_id 'some module'
+  title 'Some Title'
+  cookie_name 'Caramel'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skn_utils
 version: !ruby/object:Gem::Version
-  version: 5.4.0
+  version: 5.4.1
 platform: ruby
 authors:
 - James Scott Jr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-16 00:00:00.000000000 Z
+date: 2019-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -183,6 +183,7 @@ files:
 - lib/skn_utils/page_controls.rb
 - lib/skn_utils/result_bean.rb
 - lib/skn_utils/version.rb
+- lib/skn_utils/wrappable.rb
 - skn_utils.gemspec
 - spec/factories/environments/development.yml
 - spec/factories/environments/production.yml
@@ -202,7 +203,9 @@ files:
 - spec/lib/skn_utils/null_object_spec.rb
 - spec/lib/skn_utils/registry_spec.rb
 - spec/lib/skn_utils/success_failure_value_container_spec.rb
+- spec/lib/skn_utils/wrappers_spec.rb
 - spec/spec_helper.rb
+- spec/support/configurables.rb
 homepage: https://github.com/skoona/skn_utils
 licenses:
 - MIT
@@ -250,4 +253,6 @@ test_files:
 - spec/lib/skn_utils/null_object_spec.rb
 - spec/lib/skn_utils/registry_spec.rb
 - spec/lib/skn_utils/success_failure_value_container_spec.rb
+- spec/lib/skn_utils/wrappers_spec.rb
 - spec/spec_helper.rb
+- spec/support/configurables.rb