skn_utils 5.0.0 → 5.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3697c08bd7a516dbb2a55b859f12b18a1cd7e9ca
-  data.tar.gz: e38dac4af4d7e5da6dd5096b513e95e407784390
+  metadata.gz: 909a823062d4f9798fcdd311a66150ba6ab8d9c7
+  data.tar.gz: b4fb998ff089836a7b7760ddc1741527338272d4
 SHA512:
-  metadata.gz: 2223a7fb6597e014f2b94135f1c8626c12a798f3c6193cb1909fa887cc9aeb8ba311580f147f6289e18872b1961e8c431679d288d5cc88ae7a377c63aa39194a
-  data.tar.gz: 5ad2921a2d3cf465457f0f24f327a2286daff274cc9975e7f3d42fc46d9946074674a0ff8bd93863ab5e8001b66bff831292519f64899908bb4e2c6d7e36d798
+  metadata.gz: 68d2d352112cdfc76966e4b868639fc855f757679c8d4fcddb016f6af7ae8a9f82dd901034fefb9fad107322e9151174e6713e78fce46b816d0c4290832b0934
+  data.tar.gz: 4dcdde155be60d80582ff95e398c4717771f093f488fbd498665806f5de6a1b63af52de0f05b6c38e4c2bfac3d2cfa77739b0765efaf243e57799d7a067692cf

data/README.md

@@ -43,6 +43,8 @@ Ruby's Hash object is already extremely flexible, even more so with the addition
 There are many more use cases for Ruby's Hash that this gem just makes easier to implement.
 
 #### Available Classes
+* SknSuccess
+# SknFailure
 * SknSettings
     * SknUtils::Configurable
     * SknUtils::EnvStringHandler
@@ -55,6 +57,10 @@ There are many more use cases for Ruby's Hash that this gem just makes easier to
 * SknUtils::CoreObjectExtensions
 
 ## History
+    10/12/2018 V5.0.1
+    Added SknSuccess/SknFailure as value object to carry return codes vs exceptions
+    Modified Configurable to mimic Rails.env, Rails.root, and Rails.logger
+
     10/2/2018 V5.0.0
     Modified SknContainer (IoC) to only use #register and #resolve as it's public API.
     - Inspired by: [Andrew Holland](http://cv.droppages.com)
@@ -127,9 +133,11 @@ There are many more use cases for Ruby's Hash that this gem just makes easier to
 
     SknSettings                      # Multi-level application Configuration class, Key/Value Container with Dot/Hash notiation support.
 
-    SknUtils::Configurable           # Basic one-level configuration settings module for Applications and or Gems
+    SknUtils::Configurable           # Basic one-level configuration Applications classes or modules. Adds MyClass.root,MyClass.env, and MyClass.logger, with MyClass.config.<user_attrs>
+    
     SknContainer                     # Basic Key/Value container which #registers and #resolves procs, classes, and/or object
-
+    SknSuccess                       # Three attribute value containers for return codes   -- #success, #message, #value
+    SknFailure                       # Three attribute value containers for return codes   -- #success, #message, #value
 
 ## Configuration Options
     None required other than initialization hash
@@ -139,7 +147,7 @@ There are many more use cases for Ruby's Hash that this gem just makes easier to
     SknContainer is global constant containing an initialized Object of Concurrent::Hash using defaults with additional methods.
     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 = {}, &block)
+      #register(key, contents = nil, options = {})
         - example: 
             SknContainer.register(:some_klass, MyClass)                   -- class as value
             SknContainer.register(:the_instance, MyClass.new)             -- Object Instance as value 
@@ -163,7 +171,7 @@ There are many more use cases for Ruby's Hash that this gem just makes easier to
 
 
 ## Public Methods: SknSettings ONLY
-    SknSettings is global constant containing an initialized Object of SknUtils::SknConfiguration using defaults
+    SknSettings is global constant containing an initialized Object of SknUtils::Configuration 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/'

data/lib/skn_container.rb

@@ -29,6 +29,12 @@
 #   SknContainer.register(:person_repository, -> { PersonRepository.new }, call: true )
 #
 #   SknContainer.resolve(:person_repository).first
+#
+##  Outside Example
+#   SknContainer.register(:some_block, {call: false}) {|str| str.upcase }
+# #
+#   SknContainer.resolve(:some_block).call("hello")
+#   # ==> "HELLO"
 ##
 
 # This creates a global constant (and singleton) wrapping a Hash

data/lib/skn_failure.rb

@@ -0,0 +1,25 @@
+# ##
+# Bad Result
+
+class SknFailure
+  attr_reader :value, :success, :message
+
+  def self.call(*args)
+    new(*args)
+  end
+
+  def initialize(*args)
+    val, rc, msg = *args
+    # puts "#{self.class.name} => val:#{val}, rc:#{rc}, msg:#{msg}, args:#{args}"
+
+    if args.size.eql?(2) and not ['TrueClass','FalseClass'].include?(rc.class.name)
+      msg = rc
+      rc = false
+    end
+
+    @value = val || "Failure"
+    @success = !!rc
+    @message = msg || ''
+  end
+
+end

data/lib/skn_settings.rb

@@ -7,5 +7,5 @@
 ##
 
 # This creates a global constant (and singleton) with a defaulted configuration
-class << (SknSettings = SknUtils::SknConfiguration.new())
+class << (SknSettings = SknUtils::Configuration.new())
 end

data/lib/skn_success.rb

@@ -0,0 +1,25 @@
+# ##
+# Good Result
+
+class SknSuccess
+  attr_reader :value, :success, :message
+
+  def self.call(*args)
+    new(*args)
+  end
+
+  def initialize(*args)
+    val, rc, msg = *args
+    # puts "#{self.class.name} => val:#{val}, rc:#{rc}, msg:#{msg}, args:#{args}"
+
+    if args.size.eql?(2) and not ['TrueClass','FalseClass', 'NilClass'].include?(rc.class.name)
+      msg = rc
+      rc = true
+    end
+
+    @value = val || "Success"
+    @success = !!rc || true
+    @message = msg || ''
+  end
+
+end

data/lib/skn_utils.rb

@@ -20,12 +20,14 @@ require 'skn_utils/result_bean'
 require 'skn_utils/page_controls'
 require 'skn_utils/null_object'
 require 'skn_utils/notifier_base'
-require 'skn_utils/skn_configuration'
+require 'skn_utils/configuration'
 require 'skn_utils/configurable'
 
 require 'skn_hash'
 require 'skn_container'
 require 'skn_settings'
+require 'skn_success'
+require 'skn_failure'
 
 module SknUtils
 

data/lib/skn_utils/configurable.rb

@@ -4,46 +4,83 @@
 #
 
 module SknUtils
-
-# In the end, we have got ourselves a pretty neat module for making an arbitrary
-# class configurable and then specifying those configuration values using a clean
-# and simple DSL that also lets us reference one configuration attribute
-# from another:
-#
-#################
-# Inside Target component
-#################
-# class MyApp
-#   include SknUtils::Configurable.with(:app_id, :title, :cookie_name)
-#   # ...
-# end
-#
-#################
-# Inside Initializer
-#################
-# MyApp.configure do
-#   app_id "my_app"
-#   title "My App"
-#   cookie_name { "#{app_id}_session" }
-# end
-#
-#################
-# Usage:
-#################
-# MyApp.config.app_id # ==> "my_app"
-#
-# Here is the final version of the module that implements our DSL—a total of 36 lines of code:
+  # For making an arbitrary class configurable and then specifying those configuration values using a clean
+  # and simple DSL that also lets us reference one configuration attribute from another
+  #
+  #################
+  # 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
+  #
+  #################
+  # Inside Initializer
+  #################
+  # MyApp.configure do
+  #   app_id "my_app"
+  #   title "My App"
+  #   cookie_name { "#{app_id}_session" }
+  # end
+  #
+  #################
+  # During Definition
+  #################
+  # class MyApp
+  #   include SknUtils::Configurable.with(:app_id, :title, :cookie_name, {root_enable: true})
+  #   # ...
+  #   configure do
+  #     app_id "my_app"
+  #     title "My App"
+  #     cookie_name { "#{app_id}_session" }
+  #   end
+  #
+  #   self.logger = Logger.new
+  #   self.env = ENV.fetch('RACK_ENV', 'development')
+  #   self.root = Dir.pwd
+  # end
+  #
+  #################
+  # Usage:
+  #################
+  # MyApp.config.app_id # ==> "my_app"
+  # MyApp.logger        # ==> <Logger.class>
+  # MyApp.env.test?     # ==> true
+  #
+  # ###############
+  # Syntax
+  # ###############
+  # Main Class Attrs
+  # - root    =  application rood directory as Pathname
+  # - env     =  string value from RACK_ENV
+  # - logger  =  Assiigned Logger instance
+  # #with(*user_attrs, enable_root: true|false) - defaults to enable of Main Class Attrs
+  # ##
+  # User-Defined Attrs
+  # MyThing.with(:name1, :name2, ...)
+  #
+  # ##
 
   module Configurable
 
-    def self.with(*attrs)
-      not_provided = Object.new
+    def self.with(*attrs, **options)
+      _not_provided = Object.new
+      _app_main = options.empty? || options.values.any?{|v| v == true}
 
-      # Define the class/module methods
+      # Define the config class/module methods
       config_class = Class.new do
+        # add hash notation
+        define_method :[] do |attr|
+          instance_variable_get("@#{attr}")
+        end
+        define_method :[]= do |attr, val|
+          instance_variable_set("@#{attr}", val)
+        end
+
         attrs.each do |attr|
-          define_method attr do |value = not_provided, &block|
-            if value === not_provided && block.nil?
+          define_method attr do |value = _not_provided, &block|
+            if value === _not_provided && block.nil?
               result = instance_variable_get("@#{attr}")
               result.is_a?(Proc) ? instance_eval(&result) : result
             else
@@ -53,17 +90,38 @@ module SknUtils
         end
 
         attr_writer *attrs
-       end
+      end
 
       # Define the runtime access methods
       class_methods = Module.new do
         define_method :config do
-          @config ||= config_class.new
+          @__config ||= config_class.new
         end
-
         def configure(&block)
           config.instance_eval(&block)
         end
+        if _app_main
+          # Enable Rails<Like>.env and Rails.logger like feature:
+          # - MyClass.env.production? or MyClass.logger or MyClass.root
+          def env
+            @__env ||= ::SknUtils::EnvStringHandler.new( ENV.fetch('RACK_ENV', 'development') )
+          end
+          def env=(str)
+            @__env = ::SknUtils::EnvStringHandler.new( str || ENV.fetch('RACK_ENV', 'development') )
+          end
+          def root
+            @__root ||= ::SknUtils::EnvStringHandler.new( Dir.pwd )
+          end
+          def root=(path)
+            @__root = ::SknUtils::EnvStringHandler.new( path || Dir.pwd )
+          end
+          def logger
+            @__logger ||= 'No Logger Assigned.'
+          end
+          def logger=(obj)
+            @__logger = obj
+          end
+        end
       end
 
       # Apply the custom configuration

data/lib/skn_utils/{skn_configuration.rb → configuration.rb}

@@ -3,10 +3,10 @@
 
 module SknUtils
 
-  class SknConfiguration < NestedResult
+  class Configuration < NestedResult
 
     def initialize(params={})
-      default_mode = defined?(Rails) ? Rails.env : ENV.fetch('RACK_ENV', 'development')
+      default_mode = ENV.fetch('RACK_ENV', 'development')
       @config_filename = params.is_a?(String) ? params : params.fetch(:config_filename, default_mode)
       @base_path = ENV.fetch('TEST_GEM', 'rails').eql?('gem') ? './spec/factories/' : './config/'
       load_config_basename!(@config_filename)

data/lib/skn_utils/core_extensions.rb

@@ -8,7 +8,7 @@ module SknUtils
 
     unless Object.respond_to?(:present?)
 
-      refine Object do
+      class ::Object
         # An object is blank if it's false, empty, or a whitespace string.
         # For example, '', '   ', +nil+, [], and {} are all blank.
         #
@@ -53,7 +53,7 @@ module SknUtils
         end
       end
 
-      refine NilClass do
+      class ::NilClass
         # +nil+ is blank:
         #
         #   nil.blank? # => true
@@ -64,7 +64,7 @@ module SknUtils
         end
       end
 
-      refine FalseClass do
+      class ::FalseClass
         # +false+ is blank:
         #
         #   false.blank? # => true
@@ -75,7 +75,7 @@ module SknUtils
         end
       end
 
-      refine TrueClass do
+      class ::TrueClass
         # +true+ is not blank:
         #
         #   true.blank? # => false
@@ -86,7 +86,7 @@ module SknUtils
         end
       end
 
-      refine Array do
+      class ::Array
         # An array is blank if it's empty:
         #
         #   [].blank?      # => true
@@ -96,7 +96,7 @@ module SknUtils
         alias_method :blank?, :empty?
       end
 
-      refine Hash do
+      class ::Hash
         # A hash is blank if it's empty:
         #
         #   {}.blank?                # => true
@@ -106,7 +106,7 @@ module SknUtils
         alias_method :blank?, :empty?
       end
 
-      refine String do
+      class ::String
         # A string is blank if it's empty or contains whitespaces only:
         #
         #   ''.blank?       # => true
@@ -124,7 +124,7 @@ module SknUtils
         end
       end
 
-      refine Numeric  do #:nodoc:
+      class ::Numeric
         # No number is blank:
         #
         #   1.blank? # => false
@@ -135,6 +135,7 @@ module SknUtils
           false
         end
       end
+
     end # end unless respond_to
 
   end # end CoreObjectExtensions

data/lib/skn_utils/version.rb

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

data/spec/lib/skn_utils/configurable_spec.rb

@@ -1,9 +1,19 @@
 ##
-# spec/lib/skn_utils/exploring/configuration_spec.rb
+# spec/lib/skn_utils/configurable_spec.rb
 #
 
 class MyApp
-  include SknUtils::Configurable.with(:app_id, :title, :cookie_name)
+  include SknUtils::Configurable.with( :app_id, :title, :cookie_name, enable_root: true) # No options hash defaults to true
+  # - and accept defaults for #env=, #root=, and #logger=
+
+  # notice: self.logger=, the self is required when assigning values
+  self.logger = Object.new
+
+  configure do
+    app_id 'some app'
+    title 'My Title'
+    cookie_name 'Chocolate'
+  end
 
   def null_value
     @app_id.dup
@@ -11,22 +21,16 @@ class MyApp
 end
 
 module MyMod
-  include SknUtils::Configurable.with(:app_id, :title, :cookie_name)
+  include SknUtils::Configurable.with(:app_id, :title, :cookie_name,  enable_root: false)
 
   def self.null_value
-    @@app_id.dup
+    @app_id.dup
   end
 end
 
-MyApp.configure do
-       app_id 'some app'
-        title 'My Title'
-  cookie_name 'Chocolate'
-end
-
 MyMod.configure do
-       app_id 'some module'
-        title 'Some Title'
+  app_id 'some module'
+  title 'Some Title'
   cookie_name 'Caramel'
 end
 
@@ -35,8 +39,20 @@ describe SknUtils::Configurable, "Gem Configuration module." do
 
   let(:my_app) { MyApp.new }
 
+  context "Top Level AppClass Extra Operational Features. " do
 
-  context "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 )
+    end
+    it "MyApp.logger returns expected value. " do
+      expect( MyApp.logger ).to be_instance_of(Object) # eq('No Logger Assigned.')
+    end
+  end
+
+  context "Module & Class Operational Features. " do
 
     it "my_app#config.title returns expected value. " do
       expect( MyApp.config.title ).to eq( "My Title" )
@@ -52,6 +68,10 @@ describe SknUtils::Configurable, "Gem Configuration module." do
       expect( MyMod.config.cookie_name ).to eq( 'Caramel' )
     end
 
+    it "MyMod#logger raises NoMethodError as expected. " do
+      expect{ MyMod.logger }.to raise_error(NoMethodError)
+    end
+
   end
 
 end

data/spec/lib/skn_utils/container_spec.rb

@@ -10,8 +10,7 @@ end
 
 
 
-describe SknContainer, "Gem D/I Lite Container module." do
-
+describe SknContainer, "IoC Lite Container module." do
 
   context "Operational Features. " do
 
@@ -56,6 +55,14 @@ describe SknContainer, "Gem D/I Lite Container module." do
       subject.register(:service_a, "AnyValue")
       expect{subject.resolve(:no_find)}.to raise_error ArgumentError
     end
+
+    it "#resolve returns block without calling it first. " do
+      subject.register(:service_b, {call: false}) do |str|
+        str.upcase
+      end
+
+      expect( subject.resolve(:service_b).call("Hello") ).to eq "HELLO"
+    end
   end
 
 end

data/spec/lib/skn_utils/failure_spec.rb

@@ -0,0 +1,67 @@
+
+describe SknFailure, "Result/Response Value Container" do
+
+  let(:default_instance) { described_class.call }
+
+  context "Created without Params" do
+
+    it "Exists. " do
+      expect(default_instance).to be
+    end
+
+    it "Has default value. " do
+      expect(default_instance.value ).to eq "Failure"
+    end
+
+    it "Has default status. " do
+      expect(default_instance.success ).to be false
+    end
+
+    it "Has no default message. " do
+      expect(default_instance.message ).to be_empty
+    end
+  end
+
+  context "Created with Params" do
+    it "#success defaults to false. " do
+      expect(described_class.call("Testing").success ).to be false
+    end
+
+    it "#success accepts input. " do
+      expect(described_class.call("Testing", false).success ).to be false
+    end
+
+    it "#value defaults to Failure. " do
+      expect(described_class.call(nil, false ).value ).to eq "Failure"
+    end
+
+    it "#value accepts input. " do
+      expect(described_class.call("Don't know why!").value ).to eq "Don't know why!"
+    end
+
+    it "#message accepts input. " do
+      expect(described_class.call("Don't know why!", false, 'Something Bad Happened!').message ).to eq "Something Bad Happened!"
+    end
+  end
+
+  context "Supports #(), #call, #new, initialization and Forgives. " do
+
+  it "#(...) is supported. " do
+      expect(described_class.('payload', false, "Testing").message ).to eq('Testing')
+    end
+
+    it "#call(...) is supported. " do
+      expect(described_class.call('payload', false, "Testing").value ).to eq('payload')
+    end
+
+    it "#new(...) is supported. " do
+      expect(described_class.new('payload', false, "Testing").success ).to be false
+    end
+
+    it "Forgives absence of return code input with message. " do
+      expect(described_class.('Failure is ... !', 'Forgiveness is Wonderful!').message ).to eq('Forgiveness is Wonderful!')
+      expect(described_class.('Failure is ... !', 'Forgiveness is Wonderful!').success ).to be false
+    end
+  end
+end
+

data/spec/lib/skn_utils/success_spec.rb

@@ -0,0 +1,68 @@
+
+describe SknSuccess, "Result/Response Value Container" do
+
+  let(:default_instance) { described_class.call }
+
+  context "Created without Params" do
+
+    it "Exists. " do
+      expect(default_instance).to be
+    end
+
+    it "Has default value " do
+      expect(default_instance.value ).to eq "Success"
+    end
+
+    it "Has default status " do
+      expect(default_instance.success ).to be true
+    end
+
+    it "Has no default message. " do
+      expect(default_instance.message ).to be_empty
+    end
+  end
+
+  context "Created with Params" do
+    it "#success defaults to true. " do
+      expect(described_class.call("Testing").success ).to be true
+    end
+
+    it "#success accepts input. " do
+      expect(described_class.call("Testing", true).success ).to be true
+    end
+
+    it "#value defaults to Success. " do
+      expect(described_class.call(nil, true).value ).to eq "Success"
+    end
+
+    it "#value accepts input. " do
+      expect(described_class.call({some: :hash}).value ).to be_a Hash
+      expect(described_class.call("Success is Wonderful!").value ).to eq "Success is Wonderful!"
+    end
+
+    it "#message accepts input. " do
+      expect(described_class.call("Success is Wonderful!", true, 'Something Good Happened!').message ).to eq "Something Good Happened!"
+    end
+  end
+
+  context "Supports #(), #call, #new, initialization and Forgives. " do
+
+    it "#(...) is supported. " do
+      expect(described_class.('payload', false, "Testing").message ).to eq('Testing')
+    end
+
+    it "#call(...) is supported. " do
+      expect(described_class.call('payload', false, "Testing").value ).to eq('payload')
+    end
+
+    it "#new(...) is supported. " do
+      expect(described_class.new('payload', false, "Testing").success ).to be true
+    end
+
+    it "Forgives absence of return code input with message. " do
+      expect(described_class.('Success is ... !', 'Forgiveness is Wonderful!').message ).to eq('Forgiveness is Wonderful!')
+      expect(described_class.('Success is ... !', 'Forgiveness is Wonderful!').success ).to be true
+    end
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skn_utils
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.0.1
 platform: ruby
 authors:
 - James Scott Jr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-02 00:00:00.000000000 Z
+date: 2018-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -165,10 +165,13 @@ files:
 - bin/console
 - bin/install
 - lib/skn_container.rb
+- lib/skn_failure.rb
 - lib/skn_hash.rb
 - lib/skn_settings.rb
+- lib/skn_success.rb
 - lib/skn_utils.rb
 - lib/skn_utils/configurable.rb
+- lib/skn_utils/configuration.rb
 - lib/skn_utils/core_extensions.rb
 - lib/skn_utils/env_string_handler.rb
 - lib/skn_utils/nested_result.rb
@@ -176,7 +179,6 @@ files:
 - lib/skn_utils/null_object.rb
 - lib/skn_utils/page_controls.rb
 - lib/skn_utils/result_bean.rb
-- lib/skn_utils/skn_configuration.rb
 - lib/skn_utils/version.rb
 - skn_utils.gemspec
 - spec/factories/settings.yml
@@ -185,9 +187,11 @@ files:
 - spec/lib/skn_settings_spec.rb
 - spec/lib/skn_utils/configurable_spec.rb
 - spec/lib/skn_utils/container_spec.rb
+- spec/lib/skn_utils/failure_spec.rb
 - spec/lib/skn_utils/nested_result_spec.rb
 - spec/lib/skn_utils/notifier_base_spec.rb
 - spec/lib/skn_utils/null_object_spec.rb
+- spec/lib/skn_utils/success_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/skoona/skn_utils
 licenses:
@@ -224,7 +228,9 @@ test_files:
 - spec/lib/skn_settings_spec.rb
 - spec/lib/skn_utils/configurable_spec.rb
 - spec/lib/skn_utils/container_spec.rb
+- spec/lib/skn_utils/failure_spec.rb
 - spec/lib/skn_utils/nested_result_spec.rb
 - spec/lib/skn_utils/notifier_base_spec.rb
 - spec/lib/skn_utils/null_object_spec.rb
+- spec/lib/skn_utils/success_spec.rb
 - spec/spec_helper.rb