skn_utils 2.0.4 → 2.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb76906e8c9a9acc4a24c4f3d901a82a4a75551e
-  data.tar.gz: 5c837b3b0237136a0d26f9819360c5223b49f0e6
+  metadata.gz: b1dc55e64c570ca63ce385bbedae8052d9166603
+  data.tar.gz: a8e49bd524bbfebbb11ccb0cc1b6a21f3a0af8cd
 SHA512:
-  metadata.gz: 17ae5f8c61d19c3aed3e5b4915c68b341a2ac4f45da80b8a2841bafc620a88af72c245b45271782d3d748abce12406e712a53d7004b800c87bb75f82ed88c5b7
-  data.tar.gz: 3baa78fcdb3f07c458a5b9b5b378d971ec68a7b9828489e1971386a14dafce68929eef868c16ed790a80919d26e574a1fd4551b0ee2fb46a125b722d2a784b4e
+  metadata.gz: 75aa0eace6c9d4ac13f674b67a50724e37c7b18439f7cfa42aeeb6bfa676ac13d1136302e9833e986d5ebefaf833490746003e35ca8b965b4b80c5ce6a59d35d
+  data.tar.gz: 7009021f7d9aea4afd4a1c530ad0a5bfa1f6dd95d9501db230c21d0f53fd57c0c5158affde4f5a2dc4ca93b9fdb6d96c84a1c24f4cded6f58155bec34507e6ef

data/README.md

@@ -272,4 +272,5 @@ $ bundle exec pry
 
 ## License
 
-MIT. See `LICENSE`.
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/lib/skn_utils/exploring/configuration.rb

@@ -0,0 +1,53 @@
+##
+# File: <gem-root>/lib/skn_utils/exploring/configuration.rb
+#
+# Engines and Gem sometimes need a configuration object, this is an example
+# Options class, consider OpenStruct2 or ActiveSupport::OrderedOptions as alternatives
+
+module SknUtils
+  module Exploring
+    module Configuration
+
+      module_function
+
+      def option_defaults
+        @@option_defaults ||= {one: 1, two: 2, three: 3}
+      end
+      def option_defaults=(parms)
+        @@option_defaults = parms
+      end
+
+      def reset!
+        @@configuration = Options.new(option_defaults)
+        true
+      end
+
+      def config
+        configure
+      end
+
+      def configure         # Initialize with both the configuration keys and default values
+        @@configuration || reset!
+        yield(@@configuration) if block_given?
+        @@configuration
+      end
+
+      private
+
+      class Options
+        def initialize(parms={})
+          parms.each_pair do |k,v|
+            self.singleton_class.send(:attr_accessor, k)
+            instance_variable_set("@#{k}",v)
+          end
+        end
+      end
+
+    end
+    # require your Gem or Engine here
+
+  end
+end
+
+# In config/initializers/gem_config.rb
+# SknUtils::Exploring::Configuration.class_variable_set(:option_defaults, {one: 1, two: 2, three: 3})

data/lib/skn_utils/version.rb

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

data/spec/lib/skn_utils/exploring/configuration_spec.rb

@@ -0,0 +1,52 @@
+##
+# spec/lib/skn_utils/exploring/configuration_spec.rb
+#
+
+describe "Gem Configuration Example." do
+
+  let!(:subject) { SknUtils::Exploring::Configuration }
+
+
+  context "Initializers Feature. " do
+    before(:each) do
+      subject.reset!
+    end
+
+    it "#configure can be called without a block." do
+      expect( subject.configure ).to be_a(SknUtils::Exploring::Configuration::Options)
+    end
+
+    it "#configure can be called with a block." do
+      expect( subject.configure() {|c| c.one = 'One'} ).to be_a(SknUtils::Exploring::Configuration::Options)
+    end
+
+    it "#reset! allows new defaults to be applied." do
+      subject.option_defaults = {four: 4, five: 5, six: 6}
+      subject.reset!
+      expect( subject.config.five ).to eq(5)
+      subject.option_defaults = nil # remove prior defaults
+      subject.reset!
+      expect( subject.config.one ).to eq(1)
+    end
+
+  end
+
+  context "Runtime Features. " do
+    before(:each) do
+      subject.reset!
+    end
+
+    it "#config returns the selected value." do
+      subject.config.one = 1
+      expect( subject.config.one ).to eq(1)
+    end
+
+    it "#config overrides the selected value." do
+      subject.config.three = 12
+      expect( subject.config.three ).to eq(12)
+    end
+
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -3,6 +3,7 @@ ENV['RAILS_ENV'] ||= 'test'
 require 'skn_utils'
 require 'skn_utils/exploring/commander'
 require 'skn_utils/exploring/action_service'
+require 'skn_utils/exploring/configuration'
 
 require 'rspec'
 require 'yaml'
@@ -21,7 +22,7 @@ RSpec.configure do |config|
   config.filter_run :focus
   config.run_all_when_everything_filtered = true
 
-  config.disable_monkey_patching!  # -- breaks rspec runtime
+  # config.disable_monkey_patching!  # -- breaks rspec runtime
   config.warnings = true
 
   if config.files_to_run.one?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skn_utils
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.0.5
 platform: ruby
 authors:
 - James Scott Jr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-10 00:00:00.000000000 Z
+date: 2016-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,7 @@ files:
 - lib/skn_utils/attribute_helpers.rb
 - lib/skn_utils/exploring/action_service.rb
 - lib/skn_utils/exploring/commander.rb
+- lib/skn_utils/exploring/configuration.rb
 - lib/skn_utils/generic_bean.rb
 - lib/skn_utils/nested_result_base.rb
 - lib/skn_utils/page_controls.rb
@@ -101,8 +102,9 @@ files:
 - lib/skn_utils/value_bean.rb
 - lib/skn_utils/version.rb
 - skn_utils.gemspec
-- spec/lib/skn_utils/action_service_spec.rb
-- spec/lib/skn_utils/commander_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
 - spec/lib/skn_utils/generic_bean_spec.rb
 - spec/lib/skn_utils/page_controls_spec.rb
 - spec/lib/skn_utils/result_bean_spec.rb
@@ -139,8 +141,9 @@ summary: Ruby convenience utilities, the first being a ResultBean.    ResultBean
   via dot or hash notation,  and is serializable (<obj>.to_hash) using standard Hash
   serialization methods.
 test_files:
-- spec/lib/skn_utils/action_service_spec.rb
-- spec/lib/skn_utils/commander_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
 - spec/lib/skn_utils/generic_bean_spec.rb
 - spec/lib/skn_utils/page_controls_spec.rb
 - spec/lib/skn_utils/result_bean_spec.rb