skn_utils 3.0.1 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7fe0db5477b549906e45652fb7ead4ac75b227be
-  data.tar.gz: caa018ba88a00a513eb445612baba7ce3b5b20c0
+  metadata.gz: 82fb6a798fdac8263ee4faa65a6dd734cf148365
+  data.tar.gz: 2dc5b9cc3fa76df1d7c9dbef494b8e9d2dcee707
 SHA512:
-  metadata.gz: 7564b414d805436f0419845b9a47da19194d868aa18149893d33cb9cf29569c7842cacdac6533152234f6456d7b875b95561b7c3ff7a2b938d77b20b5d4b7d50
-  data.tar.gz: 9d952ba616307c63b09f7980e5c18a60f1b66205dde461898dfd3643f438e43836225fa605f9d91bb00928afc667ffc915677c60245e4f8ef398b009912f868e
+  metadata.gz: f5d5410f5f06e63a85e054a36e27f20cd5a8c344c59453f992c36e3e28d9632ac256e10f96df6b03421649da3b64e5493808c48e42b5abbc1bce18206347b2c9
+  data.tar.gz: 217fc83650fff470b1a5869734747875727bfbcc374a2762e3562b1d610a90bd020505dfbb2ef2340bf09ddcc98791f2688e3095af5f6a0569eb3c86782c5219

data/lib/skn_utils/nested_result.rb

@@ -95,7 +95,7 @@ module SknUtils
 
     def initialize(params={})
       @container =  {}
-      initialize_from_hash(params)
+      initialize_for_speed(params)
     end
 
     def [](attr)
@@ -131,33 +131,10 @@ module SknUtils
     #
     # Returns a string containing a detailed summary of the keys and values.
     #
-    InspectKey = :__inspect_key__ # :nodoc:
-    def inspect
-      package = to_hash
-      str = "#<#{self.class}"
-
-      ids = (Thread.current[InspectKey] ||= [])
-      if ids.include?(object_id)
-        return str << ' ...>'
-      end
-
-      ids << object_id
-      begin
-        first = true
-        for k,v in package
-          str << "," unless first
-          first = false
-          str << " #{k}=#{v.inspect}"
-        end
-        return str << '>'
-      ensure
-        ids.pop
-      end
+    def to_s
+      attributes.to_s
     end
 
-    alias_method :to_s, :inspect
-
-
     ##
     # Ruby basic Class methods
     #
@@ -186,14 +163,14 @@ module SknUtils
     #
     # Use our unwrapped/original input Hash when yaml'ing
     def encode_with(coder)
-      coder['container'] = self.to_h
+      coder['container'] = attributes
     end
 
     # Use our hash from above to fully re-initialize this instance
     def init_with(coder)
       case coder.tag
-        when '!ruby/object:SknUtils::NestedResult'
-          initialize_from_hash( coder.map['container'] )
+        when '!ruby/object:SknUtils::NestedResult', "!ruby/object:#{self.class.name}"
+          initialize_for_speed( coder.map['container'] )
       end
     end
 
@@ -208,7 +185,7 @@ module SknUtils
 
     # Using the String from above create and return an instance of this class
     def marshal_load(hash)
-      initialize_from_hash(hash)
+      initialize_for_speed(hash)
     end
 
     def respond_to_missing?(method, incl_private=false)
@@ -237,14 +214,14 @@ module SknUtils
     # - protected to reasonably ensure key is a symbol
     def hash_from(sym)
       starting_sym = key_as_sym(sym)
-      bundle = starting_sym == container ? container : { starting_sym => container[starting_sym] }
+      bundle = ((starting_sym == container) ? container : { starting_sym => container[starting_sym] })
       bundle.keys.each_with_object({}) do |attr,collector|
         value = bundle[attr]
         case value
-          when Array
-            value = value.map {|ele| array_to_hash(ele) }
           when NestedResult
             value = value.to_hash
+          when Array
+            value = value.map {|ele| array_to_hash(ele) }
         end
         collector[attr] = value                                                          # new copy
       end
@@ -265,6 +242,22 @@ module SknUtils
       name
     end
 
+    # Don't create methods until first access
+    def initialize_for_speed(hash)
+      hash.each_pair do |k,v|
+        key = key_as_sym(k)
+        case v
+          when Array
+            value = v.map { |element| translate_value(element) }
+            container.store(key, value)
+          when Hash
+            container.store(key, NestedResult.new(v))
+          else
+            container.store(key, v)
+        end
+      end
+    end
+
     def initialize_from_hash(hash)
       hash.each_pair do |k,v|
         key = key_as_sym(k)
@@ -284,10 +277,10 @@ module SknUtils
     # Feature: unwrap array of array-of-hashes/object
     def array_to_hash(array)
       case array
-        when Array
-          array.map { |element| array_to_hash(element) }
         when NestedResult
           array.to_hash
+        when Array
+          array.map { |element| array_to_hash(element) }
         else
           array
       end
@@ -296,10 +289,10 @@ module SknUtils
     # Feature: wrap array of array-of-hashes/object
     def translate_value(value)
       case value
-        when Array
-          value.map { |element| translate_value(element) }
         when Hash
           NestedResult.new(value)
+        when Array
+          value.map { |element| translate_value(element) }
         else
           value
       end
@@ -322,18 +315,16 @@ module SknUtils
       method_nsym = method_sym.is_a?(Symbol) ? method.to_s[0..-2].to_sym : method
 
 
-      if method.to_s.end_with?("=") and container[method_nsym].nil?           # add new key/value pair, transform value if Hash or Array
+      if method.to_s.end_with?("=")                                    # add new key/value pair, transform value if Hash or Array
         initialize_from_hash({method_nsym => args.first})
 
       elsif container.key?(method_sym)
-        puts "#{__method__}() method: #{method}"
-        enable_dot_notation(method_sym)                                          # Add Reader/Writer one first need
-        container[method_sym]
+        container[enable_dot_notation(method_sym)]                # Add Reader/Writer one first need
 
-      elsif method.to_s.end_with?('?')                                           # order of tests is significant,
+      elsif method.to_s.end_with?('?')                                # order of tests is significant,
         attribute?(method_nsym)
 
-      else
+      else # TODO: replace following with nil to match OpenStruct behavior when key not found
         e = NoMethodError.new "undefined method `#{method}' for #{self.class.name}", method, args
         e.set_backtrace caller(1)
         raise e
@@ -343,40 +334,3 @@ module SknUtils
 
   end # end class
 end # end module
-
-
-# YAML.load(str) will trigger #init_with for each type it encounters when loading
-# Psych.dump ==> "--- !ruby/object:SknUtils::NestedResult\ncontainer:\n  :one: 1\n  :two: two\n"
-#
-#
-# [2] pry(main)> ay = Psych.dump a
-# respond_to_missing?() checking for method: :encode_with existence.
-#   => "--- !ruby/object:SknUtils::NestedResult\ncontainer:\n  :one: 1\n  :two: two\n"
-# [3] pry(main)> az = Psych.load ay
-# respond_to_missing?() checking for method: :init_with existence.
-# respond_to_missing?() checking for method: :yaml_initialize existence.
-#   => #<SknUtils::NestedResult:0x007fe410993238 @container={:one=>1, :two=>"two"}>
-
-
-# YAML RTM? querys
-# [:encode_with, :init_with].include?(method)
-
-
-# can be accessed just like a hash
-# respond_to_missing?() checking for method: :encode_with existence.
-#     respond_to_missing?() checking for method: :encode_with existence.
-#     respond_to_missing?() checking for method: :encode_with existence.
-#     respond_to_missing?() checking for method: :encode_with existence.
-#     respond_to_missing?() checking for method: :encode_with existence.
-#     respond_to_missing?() checking for method: :encode_with existence.
-#     respond_to_missing?() checking for method: :encode_with existence.
-#     respond_to_missing?() checking for method: :encode_with existence.
-#     init_with() hooking into Yaml/Psych.load for codes: {:seven=>7, :eight=>"eight"}.
-#     init_with() hooking into Yaml/Psych.load for codes: {:four=>4, :five=>5, :six=>#<SknUtils::NestedResult:0x007fba101740e0 @container={:seven=>7, :eight=>"eight"}>, :seven=>false}.
-#     init_with() hooking into Yaml/Psych.load for codes: {:any_key=>#<Tuple:0x007fba101643e8 @first="foo", @second="bar">}.
-#     init_with() hooking into Yaml/Psych.load for codes: {:seven=>7, :eight=>"eight"}.
-#     init_with() hooking into Yaml/Psych.load for codes: {:four=>4, :five=>5, :six=>#<SknUtils::NestedResult:0x007fba1014f880 @container={:seven=>7, :eight=>"eight"}>}.
-#     init_with() hooking into Yaml/Psych.load for codes: {:nine=>9, :ten=>"ten"}.
-#     init_with() hooking into Yaml/Psych.load for codes: {:four=>4, :five=>5, :six=>#<SknUtils::NestedResult:0x007fba1014cd60 @container={:nine=>9, :ten=>"ten"}>}.
-#     init_with() hooking into Yaml/Psych.load for codes: {:one=>"one", :two=>"two", :three=>#<SknUtils::NestedResult:0x007fba10175058 @container={:four=>4, :five=>5, :six=>#<SknUtils::NestedResult:0x007fba101740e0 @container={:seven=>7, :eight=>"eight"}>, :seven=>false}>, :four=>#<SknUtils::NestedResult:0x007fba101664b8 @container={:any_key=>#<Tuple:0x007fba101643e8 @first="foo", @second="bar">}>, :five=>[4, 5, 6], :six=>[#<SknUtils::NestedResult:0x007fba10154628 @container={:four=>4, :five=>5, :six=>#<SknUtils::NestedResult:0x007fba1014f880 @container={:seven=>7, :eight=>"eight"}>}>, #<SknUtils::NestedResult:0x007fba1014d738 @container={:four=>4, :five=>5, :six=>#<SknUtils::NestedResult:0x007fba1014cd60 @container={:nine=>9, :ten=>"ten"}>}>, #<Tuple:0x007fba10146d48 @first="another", @second="tuple">], :seven=>#<Tuple:0x007fba10145a60 @first="hello", @second="world">}.
-

data/lib/skn_utils/notifier_base.rb

@@ -4,91 +4,39 @@
 #
 # Ref: https://ozone.wordpress.com/category/programming/metaprogramming/
 
-
-class NotifierBase
-
-  def initialize
-    @listeners = []
-  end
-
-  def register_listener(l)
-    @listeners.push(l) unless @listeners.include?(l)
-  end
-
-  def unregister_listener(l)
-    @listeners.delete(l)
-  end
-
-  def self.attribute(*properties)
-    properties.each do |prop|
-      define_method(prop) {
-        instance_variable_get("@#{prop}")
-      }
-      define_method("#{prop}=") do |value|
-        old_value = instance_variable_get("@#{prop}")
-        return if (value == old_value)
-        @listeners.each { |listener|
-          listener.attribute_changed(prop, old_value, value)
+module SknUtils
+  class NotifierBase
+
+    def initialize
+      @listeners = []
+    end
+
+    def register_listener(listener)
+      @listeners.push(listener) unless @listeners.include?(listener)
+    end
+
+    def unregister_listener(listener)
+      @listeners.delete(listener)
+    end
+
+    # create writer-with-notify and reader
+    def self.attribute(*attrs)
+      attrs.each do |attr|
+        instance_variable_set("@#{attr}", nil)
+        define_method(attr) {
+          instance_variable_get("@#{attr}")
         }
-        instance_variable_set("@#{prop}", value)
-      end
-    end # loop on properties
-  end # end of attribute method
-
-end # end of NotifierBase class
-
-
-# Create a bean from that base
-class TestBean < NotifierBase
-  attribute :name, :firstname
-end
-
-class LoggingPropertyChangeListener
-  def attribute_changed(attribute, old_value, new_value)
-    print attribute, " changed from ",
-          old_value, " to ",
-          new_value, "\n"
-  end
+        define_method("#{attr}=") do |value|
+          old_value = instance_variable_get("@#{attr}")
+          return if (value == old_value)
+          @listeners.each { |listener|
+            listener.attribute_changed(attr, old_value, value)
+          }
+          instance_variable_set("@#{attr}", value)
+        end
+      end # loop on attrs
+    end # end of attribute method
+
+  end # end of NotifierBase class
 end
 
-class SimpleBean < NotifierBase
-  attribute :name, :firstname
-
-  def impotent_name=(new_name)
-    @name = new_name
-  end
-end
-
-
-test = TestBean.new
-listener = LoggingPropertyChangeListener.new
-test.register_listener(listener)
-test.name = 'James Scott'
-test.firstname = "Scott"
-test.firstname = "James"
-test.unregister_listener(listener)
-
-
-
-test = SimpleBean.new
-listener = LoggingPropertyChangeListener.new
-test.register_listener(listener)
-test.name = 'James Scott'
-test.firstname = 'Scott'
-test.firstname = 'James'
-test.unregister_listener(listener)
-
-
-# output it generates:
-
-# ==> name changed from nil to James Scott
-# ==> firstname changed from nil to Scott
-# ==> firstname changed from Scott to James
-
-
-#
-# END
-#
-
-
-

data/lib/skn_utils/version.rb

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

data/lib/skn_utils.rb

@@ -1,6 +1,7 @@
 require "skn_utils/version"
 require 'skn_utils/nested_result'
 require 'skn_utils/null_object'
+require 'skn_utils/notifier_base'
 require 'skn_utils/exploring/commander'
 require 'skn_utils/exploring/action_service'
 

data/skn_utils.gemspec

@@ -22,7 +22,7 @@ EOF
 This version does not include ResultBean, PageControls, or ValueBean classes.  
 SknUtils::NestedResult class replaces those original classes and their function.  
 
-Please update your existing code to make the above change or use the prior version 2.0.7
+Please update your existing code to make the above change or use the prior version 2.0.6
 EOF
   spec.homepage      = "https://github.com/skoona/skn_utils"
   spec.license       = "MIT"
@@ -30,17 +30,11 @@ EOF
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = []
   spec.test_files    = spec.files.grep(%r{^(spec)/})
-  spec.require_paths = ["lib"]
+  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"
-
-  ## Make sure you can build the gem on older versions of RubyGems too:
-  spec.rubygems_version = "1.6.2"
-  spec.required_rubygems_version = Gem::Requirement.new(">= 0") if spec.respond_to? :required_rubygems_version=
-  spec.required_ruby_version = '~> 2.0'
-  spec.specification_version = 3 if spec.respond_to? :specification_version  
 end

data/spec/lib/skn_utils/nested_result_spec.rb

@@ -22,6 +22,18 @@ class MyObject
 
 end
 
+class IFeature < SknUtils::NestedResult
+  def initialize(parms={})
+    super(parms)
+    # @some_value = 'Three'
+  end
+
+  def say(val='hello')
+    "Three #{val}s"
+  end
+end
+
+
 RSpec.shared_examples 'plain old ruby object' do
 
   context "Core Operations " do
@@ -165,6 +177,19 @@ end
 
 
 RSpec.describe SknUtils::NestedResult, 'NestedResult class - Basic usage.' do
+  let(:ifeature) do
+    IFeature.new(one: 'one', 4201 => 'Account Code',
+                               two: 'two',
+                               three: { four: 4, five: 5, six: { seven: 7, eight: 'eight' }, seven: false },
+                               four: { any_key: MyObject.new(value: ['MyObject Testing', 'Looking for Modifications']) },
+                               five: [4, 5, 6],
+                               six: [{ four: 4, five: 5, six: { seven: 7, eight: 'eight' } },
+                                     { four: 4, five: 5, six: { nine: 9, ten: 'ten' } },
+                                     MyObject.new(value: ['MyObject Testing', 'Looking for Modifications'])],
+                               seven: MyObject.new(value: ['MyObject Testing', 'Looking for Modifications']),
+                               eight: [[{one: 'one', two: 'two'}],[{three: 'three', four: 'four'}]])
+  end
+
   let(:object) do
     SknUtils::NestedResult.new(one: 'one', 4201 => 'Account Code',
                               two: 'two',
@@ -227,6 +252,12 @@ RSpec.describe SknUtils::NestedResult, 'NestedResult class - Basic usage.' do
     it_behaves_like 'plain old ruby object' do
       let(:bean) { object }
     end
+    it_behaves_like 'plain old ruby object' do
+      let(:bean) { ifeature }
+    end
+    it "behaves as expected when inherited" do
+      expect(ifeature.say('Person')).to eq('Three Persons')
+    end
   end
 
   context 'Marshalling to JSON' do
@@ -235,10 +266,24 @@ RSpec.describe SknUtils::NestedResult, 'NestedResult class - Basic usage.' do
     end
   end
 
+  context 'IFeature Basic Operations after Yaml marshaling' do
+    let(:dumped_object) { Psych.dump(ifeature) }
+
+    it "#encode_with exports the original hash when YAML'ed" do
+      expect(dumped_object).to include('ruby/object:IFeature')
+      expect(dumped_object[42..-1]).to_not include('ruby/object:IFeature')
+    end
+
+    it_behaves_like 'plain old ruby object' do
+      let(:bean) { Psych.load(dumped_object) }
+    end
+  end
+
   context 'Basic Operations after Yaml marshaling' do
     let(:dumped_object) { Psych.dump(object) }
 
     it "#encode_with exports the original hash when YAML'ed" do
+      expect(dumped_object).to include('ruby/object:SknUtils::NestedResult')
       expect(dumped_object[42..-1]).to_not include('ruby/object:SknUtils::NestedResult')
     end
 

data/spec/lib/skn_utils/notifier_base_spec.rb

@@ -0,0 +1,66 @@
+##
+# spec/lib/skn_utils/null_object_spec.rb
+#
+
+# Create a bean from that base
+class TestBean < SknUtils::NotifierBase
+  attribute :name, :firstname
+end
+
+class LoggingPropertyChangeListener
+  def attribute_changed(attribute, old_value, new_value)
+    print attribute, " changed from ",
+          old_value, " to ",
+          new_value, "\n"
+  end
+end
+
+class SimpleBean < SknUtils::NotifierBase
+  attribute :name, :firstname
+
+  def impotent_name=(new_name)
+    @name = new_name
+  end
+end
+
+
+RSpec.describe SknUtils::NotifierBase, "Notify feature example for Ruby " do
+  let(:test_obj)   { TestBean.new }
+  let(:simple_obj) { SimpleBean.new }
+  let(:listener)   { LoggingPropertyChangeListener.new }
+
+  context "Basic Operations" do
+    it "Initializes without params" do
+      expect(subject).to be
+    end
+    it "Can be Inherited." do
+      expect(test_obj).to be
+    end
+  end
+
+  context "Notify Operations" do
+    it "#register_listener registers listeners." do
+      expect(test_obj.register_listener(listener)).to include(listener)
+    end
+
+    it "#unregister_listener removes listener." do
+      test_obj.register_listener(listener)
+      expect(test_obj.unregister_listener(listener)).to eq(listener)
+    end
+
+    it "notifies listeners of changes when attribute writer is used." do
+      test_obj.register_listener(listener)
+      expect(listener).to receive(:attribute_changed).with(:name, nil, 'James Scott')
+      test_obj.name = 'James Scott'
+    end
+
+    it "does not notify listeners when attribute writer is not used." do
+      simple_obj.register_listener(listener)
+      expect(listener).not_to receive(:attribute_changed)
+      simple_obj.impotent_name = 'James Scott'
+      expect(simple_obj.name).to eq('James Scott')
+    end
+
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skn_utils
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.2
 platform: ruby
 authors:
 - James Scott Jr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-31 00:00:00.000000000 Z
+date: 2017-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -112,6 +112,7 @@ files:
 - spec/lib/skn_utils/exploring/commander_spec.rb
 - spec/lib/skn_utils/exploring/configuration_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/spec_helper.rb
 homepage: https://github.com/skoona/skn_utils
@@ -121,15 +122,15 @@ metadata: {}
 post_install_message: "This version does not include ResultBean, PageControls, or
   ValueBean classes.  \nSknUtils::NestedResult class replaces those original classes
   and their function.  \n\nPlease update your existing code to make the above change
-  or use the prior version 2.0.7\n"
+  or use the prior version 2.0.6\n"
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -139,7 +140,7 @@ requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.11
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: SknUtils contains a small collection of Ruby utilities, the first being a
   NestedResult a key/value container.
 test_files:
@@ -147,5 +148,6 @@ test_files:
 - spec/lib/skn_utils/exploring/commander_spec.rb
 - spec/lib/skn_utils/exploring/configuration_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/spec_helper.rb