skn_utils 3.6.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f318459d97979405431fd4e09eb85d8688707636
-  data.tar.gz: 350ee31b2176feae8d567d02e649eb220b2c8a0d
+  metadata.gz: 95950dfdf413d133698bc9614a5513cd5d91bf82
+  data.tar.gz: 9fc06b3576d657326af58ad7d4caa7ce20613f40
 SHA512:
-  metadata.gz: c10cff645d8c75d49abe41ef1b438ba0e3e057f509bd9454133cb9e0bdf32840c82b7a5c861f7ec3787d8565b5f10617cb0dc2cfca9439cd27a28cbdcf31f07e
-  data.tar.gz: 904d521b3bc3849a8bc6e71e7f0376668ed378e7fdd887e83279486a016b8710c068ebd3c8dbe59250224de26d78a11267c19263b71816f503406975d0b00ec5
+  metadata.gz: dcb65cc5acde288729d5b11f0812ffd3a3c199ae1609492398fc06b96ce75246430ba21b945238494d28af65fe4e333193ec36baaa6797e84e55f8f5c984be4e
+  data.tar.gz: 60788d945065c38d3c0ed1ff2e5a889533c89223ced661275b6ab94a49242aa9c09810316b666bf983b19a0de525041db30a0b7d7ce8f894dfca79254b17bcb2

data/README.md

@@ -9,13 +9,29 @@ Ruby Gem containing a Ruby PORO (Plain Old Ruby Object) that can be instantiated
  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.
 
-* Transforms the initializating hash into accessible object instance values, with their keys as method names.
+* 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 element of the Arrays 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.
 
+#### Primary Classes
+* SknSettings
+* SknContainer
+* SknHash
+* SknUtils::NestedResult
+* SknUtils::ResultBean
+* SknUtils::PageControls
+* SknUtils::Configurable
+* SknUtils::NullObject
+* SknUtils::EnvStringHandler
+* SknUtils::CoreObjectExtensions
 
 ## New Features
+    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.
+    - Simply add `using SknUtils::CoreObjectExtensions` to any class or module you wish to use the `:present?`, `:blank?`, etc methods.
+
     01/2018  V3.6.0
     Moved Linked List to my Minimum_Heaps gem.  This repo has a tag of 'lists' documententing the removal
     Removed classes and utils not directly related to NestedResult
@@ -210,10 +226,11 @@ Ruby Gem containing a Ruby PORO (Plain Old Ruby Object) that can be instantiated
 
 ## Installation
 
-    runtime prereqs:
-        V3+ None
-        V2+ None
-        V1+ gem 'active_model', '~> 3.0'
+runtime prereqs:
+* V4+ None
+* V3+ None
+* V2+ None
+* V1+ gem 'active_model', '~> 3.0'
 
 
 Add this line to your application's Gemfile:

data/lib/skn_utils/core_extensions.rb

@@ -0,0 +1,141 @@
+# ##
+# File: ./lib/skn_utils/core_extensions.rb  --
+# -- from: Rails 4.1 ActiveSupport:lib/active_support/core_ext/object/blank.rb
+# -- Ref: https://6ftdan.com/allyourdev/2015/01/20/refinements-over-monkey-patching/
+
+module SknUtils
+  module CoreObjectExtensions
+
+    unless Object.respond_to?(:present?)
+
+      refine Object do
+        # An object is blank if it's false, empty, or a whitespace string.
+        # For example, '', '   ', +nil+, [], and {} are all blank.
+        #
+        # This simplifies
+        #
+        #   address.nil? || address.empty?
+        #
+        # to
+        #
+        #   address.blank?
+        #
+        # @return [true, false]
+        def blank?
+          respond_to?(:empty?) ? !!empty? : !self
+        end
+
+        # An object is present if it's not blank.
+        #
+        # @return [true, false]
+        def present?
+          !blank?
+        end
+
+        # Returns the receiver if it's present otherwise returns +nil+.
+        # <tt>object.presence</tt> is equivalent to
+        #
+        #    object.present? ? object : nil
+        #
+        # For example, something like
+        #
+        #   state   = params[:state]   if params[:state].present?
+        #   country = params[:country] if params[:country].present?
+        #   region  = state || country || 'US'
+        #
+        # becomes
+        #
+        #   region = params[:state].presence || params[:country].presence || 'US'
+        #
+        # @return [Object]
+        def presence
+          self if present?
+        end
+      end
+
+      refine NilClass do
+        # +nil+ is blank:
+        #
+        #   nil.blank? # => true
+        #
+        # @return [true]
+        def blank?
+          true
+        end
+      end
+
+      refine FalseClass do
+        # +false+ is blank:
+        #
+        #   false.blank? # => true
+        #
+        # @return [true]
+        def blank?
+          true
+        end
+      end
+
+      refine TrueClass do
+        # +true+ is not blank:
+        #
+        #   true.blank? # => false
+        #
+        # @return [false]
+        def blank?
+          false
+        end
+      end
+
+      refine Array do
+        # An array is blank if it's empty:
+        #
+        #   [].blank?      # => true
+        #   [1,2,3].blank? # => false
+        #
+        # @return [true, false]
+        alias_method :blank?, :empty?
+      end
+
+      refine Hash do
+        # A hash is blank if it's empty:
+        #
+        #   {}.blank?                # => true
+        #   { key: 'value' }.blank?  # => false
+        #
+        # @return [true, false]
+        alias_method :blank?, :empty?
+      end
+
+      refine String do
+        # A string is blank if it's empty or contains whitespaces only:
+        #
+        #   ''.blank?       # => true
+        #   '   '.blank?    # => true
+        #   "\t\n\r".blank? # => true
+        #   ' blah '.blank? # => false
+        #
+        # Unicode whitespace is supported:
+        #
+        #   "\u00a0".blank? # => true
+        #
+        # @return [true, false]
+        def blank?
+          /\A[[:space:]]*\z/ === self
+        end
+      end
+
+      refine Numeric  do #:nodoc:
+        # No number is blank:
+        #
+        #   1.blank? # => false
+        #   0.blank? # => false
+        #
+        # @return [false]
+        def blank?
+          false
+        end
+      end
+    end # end unless respond_to
+
+  end # end CoreObjectExtensions
+end # end SknUtils

data/lib/skn_utils/nested_result.rb

@@ -93,8 +93,17 @@
 module SknUtils
   class NestedResult
 
-    def initialize(params={}, mod=true)
-      reset_from_empty!(params, mod)
+    # ##
+    # Onlye good for the first level
+    def self.with_methods(args)
+      new(args, false)
+    end
+    def self.with_instance_vars(args)
+      new(args, true)
+    end
+
+    def initialize(params={}, speed=true)
+      reset_from_empty!(params, speed)
     end
 
     def [](attr)

data/lib/skn_utils/skn_configuration.rb

@@ -6,7 +6,7 @@ module SknUtils
   class SknConfiguration < NestedResult
 
     def initialize(params={})
-      default_mode = defined?(Rails) ? Rails.env : ENV.fetch('RAILS_ENV', 'development') 
+      default_mode = defined?(Rails) ? Rails.env : 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/version.rb

@@ -1,8 +1,8 @@
 # A better way to say it
 module SknUtils
   class Version
-    MAJOR = 3
-    MINOR = 6
+    MAJOR = 4
+    MINOR = 0
     PATCH = 0
 
     def self.to_s

data/lib/skn_utils.rb

@@ -13,6 +13,7 @@ unless defined?(Rails)
     puts e.message
   end
 end
+require 'skn_utils/core_extensions'
 require 'skn_utils/env_string_handler'
 require 'skn_utils/nested_result'
 require 'skn_utils/result_bean'

data/spec/factories/settings.yml

@@ -7,3 +7,9 @@ Packaging:
   isProduction: false
   configName: development
   short_name: skn
+
+# Create a EnvStringHandler to support: SknSettings.env.development?
+# Yes, its YAML trick
+env: !ruby/string:SknUtils::EnvStringHandler <%= ENV['RACK_ENV'] %>
+root: <%= Dir.pwd %>
+

data/spec/lib/skn_settings_spec.rb

@@ -7,4 +7,16 @@ describe SknSettings, "Application Configuration" do
     expect(SknSettings.Packaging.configName).to eq 'test.local'
     expect(SknSettings.Packaging.isTest).to be true
   end
+
+  it 'contains the current RACK or RAILS environment values' do
+    expect(SknSettings.env).to eq 'test'
+    expect(SknSettings.env.test?).to be true
+    expect(SknSettings.env.development?).to be false
+  end
+
+  it 'contains the application root path as a string' do
+    expect(SknSettings.root).to eq Dir.pwd
+    expect(SknSettings.root).to be_a(String)
+  end
+
 end

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 ENV['RAILS_ENV'] = 'test'
+ENV['RACK_ENV'] = 'test'
 
 ENV['TEST_GEM'] = 'gem'   # enable SknSettings Gem Mode Testing
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skn_utils
 version: !ruby/object:Gem::Version
-  version: 3.6.0
+  version: 4.0.0
 platform: ruby
 authors:
 - James Scott Jr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-21 00:00:00.000000000 Z
+date: 2018-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -150,6 +150,7 @@ files:
 - lib/skn_settings.rb
 - lib/skn_utils.rb
 - lib/skn_utils/configurable.rb
+- lib/skn_utils/core_extensions.rb
 - lib/skn_utils/env_string_handler.rb
 - lib/skn_utils/nested_result.rb
 - lib/skn_utils/notifier_base.rb