skn_utils 2.0.6 → 3.0.0

data/spec/lib/skn_utils/nested_result_spec.rb

@@ -0,0 +1,268 @@
+##
+# spec/lib/skn_utils/nested_bean_spec.rb
+#
+
+class MyObject
+
+  attr_accessor :some_instance_value
+
+  def initialize(parms)
+    @some_instance_value = parms[:value]
+  end
+
+  def say(str)
+    "saying #{str}!"
+  end
+
+  def to_h
+    hsh = {msg: "You called #{__method__} on me!"}
+    puts hsh
+    hsh
+  end
+
+end
+
+RSpec.shared_examples 'plain old ruby object' do
+
+  context "Core Operations " do
+    it 'creates NestedResults all the way down' do
+      expect(object.three.six).to be_a(SknUtils::NestedResult)
+      expect(object.six.last).to be_a(MyObject)
+    end
+
+    it 'provides getters' do
+      expect(bean.one).to eql('one')
+      expect(bean[:one]).to eql('one')
+      expect(bean['one']).to eql('one')
+      expect(bean.two).to eql('two')
+      expect(bean[:two]).to eql('two')
+      expect(bean['two']).to eql('two')
+    end
+
+    it 'provides setters' do
+      bean.one = '1'
+      bean.two = '2'
+      expect(bean.two).to eql('2')
+      expect(bean.one).to eql('1')
+    end
+
+    it 'can access deeply nested attributes' do
+      expect(bean.six.first.six.eight).to eql('eight')
+      expect(bean.eight.first.first.one).to eql('one')
+    end
+
+    it 'does not affect custom objects being passed in' do
+      expect(bean.four.any_key.some_instance_value).to eql(['MyObject Testing', 'Looking for Modifications'])
+    end
+
+    it 'allows setting of new attributes' do
+      bean.foo = 'bar'
+      expect(bean.foo).to eql('bar')
+    end
+
+    it '#attribute? returns true or false based on true presence and non-blank contents of attribute.' do
+      expect(bean.one?).to be_truthy
+      expect(bean.three.seven?).to be_truthy
+      expect(bean.three.seven).to be false
+    end
+
+    it 'can delete attributes' do
+      bean.delete_field(:two)
+      expect(bean.two?).to be_falsey
+      bean.delete_field(:two)
+      expect(bean.two?).to be_falsey
+    end
+
+    it 'can be accessed just like a hash with indifferent access' do
+      bean.one = '1'
+      expect(bean[:one]).to eql('1')
+      expect(bean['one']).to eql('1')
+    end
+
+    it '#respond_to? replies as expected' do
+      expect(bean.respond_to?(:one)).to be true
+      expect(object2.respond_to?(:eleven)).to be true
+    end
+
+    it 'supports Fixnum keys ' do
+      expect(bean[4201]).to eq 'Account Code'
+      expect(bean[4201] = 'account code').to eq 'account code'
+      expect(bean[4202]).to be_falsey
+      expect(bean[4202] = 'account code').to eq 'account code'
+    end
+
+    it "protected #hash_from returns remaining hash from any root key as the starting point" do
+      expect(bean.send(:hash_from, :one)).to eql({one: 'one'})
+      expect(bean.send(:hash_from, :three)).to eql({three: { four: 4, five: 5, six: { seven: 7, eight: 'eight' }, seven: false }})
+      expect(bean.send(:hash_from, :eight)).to eql({eight: [[{one: 'one', two: 'two'}],[{three: 'three', four: 'four'}]]})
+    end
+
+    it 'Raises NoMethodError in response to invalid key access' do
+      expect{object.sixty_two}.to raise_exception(NoMethodError)
+    end
+
+    context '#attribute? present? like feature operates as expected' do
+      let(:base) do
+        SknUtils::NestedResult.new({
+                                      empty_string: "", blank_string: " ", null: nil,
+                                      empty_array: [], blank_arrays: [[]], empty_hash: {}
+                                  })
+      end
+
+      it '#attribute? returns false when attribute is not defined or unknown' do
+        [:empty_string, :blank_string, :null_string,
+         :empty_hash, :empty_array, :blank_arrays, :twelve].each do |key|
+          expect(base.send(:attribute?, key)).to be false
+        end
+      end
+    end
+
+  end
+
+  context '#to_h' do
+    let(:hash) { bean.to_h }
+
+    it 'returns a hash of all attributes and their values.' do
+      expect(hash).to be_a(Hash)
+    end
+
+    it 'translates nested objects back to hashes when calling to_h' do
+      expect(hash[:three][:six]).to be_a(Hash)
+    end
+
+    it 'translates elements with Fixnum as key back to hashes when calling to_h' do
+      expect(hash[4201]).to eq('Account Code')
+    end
+
+    it 'handles array types when calling to_h' do
+      expect(hash[:six]).to be_a(Array)
+      expect(hash[:six][2]).to be_a(MyObject)
+      expect(hash[:six][0]).to be_a(Hash)
+      expect(hash[:six].size).to eql(3)
+    end
+
+    it 'handles hashes nested in arrays when calling to_h' do
+      expect(hash[:six][0]).to be_a(Hash)
+    end
+
+    it 'handles hashes nested in arrays of arrays-of-hashes when calling to_h' do
+      expect(hash[:eight][0][0]).to be_a(Hash)
+      expect(hash[:eight][1][0]).to be_a(Hash)
+      expect(hash[:eight].first.first[:one]).to eql('one')
+      expect(hash[:eight].last.first[:four]).to eql('four')
+    end
+
+    it 'handles non-hash attributes properly' do
+      expect(hash[:one]).to eql('one')
+    end
+
+    it 'does not change custom objects nested in beanure' do
+      expect(hash[:four][:any_key]).to be_a(MyObject)
+      expect(hash[:four][:any_key].some_instance_value).to eql(['MyObject Testing', 'Looking for Modifications'])
+    end
+  end
+end
+
+
+RSpec.describe SknUtils::NestedResult, 'NestedResult class - Basic usage.' do
+  let(:object) do
+    SknUtils::NestedResult.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(:object2) do
+    SknUtils::NestedResult.new({ten: 10,
+                               eleven: 11,
+                               twelve: [[{five: 5, six: 6}],[{three: 3, '04' => 'four'}]]})
+  end
+
+  let(:json_bean) { object.to_json }
+
+  context 'Initializers' do
+    it 'Creates an empty bean if no params are passed' do
+      is_expected.to be
+    end
+
+    it 'Initializes from a hash' do
+      expect(SknUtils::NestedResult.new(one: 'one', two: 'two')).to be
+    end
+
+    it 'Initializes with attr methods intact after YAML.load' do
+      yamled =  Psych.load( Psych.dump(object) )
+      [:one, :two, :three, :four, :five, :six, :seven, :eight].each do |key|
+        expect(yamled.respond_to?(key)).to be true
+      end
+    end
+
+    it '#respond_to? verifies attr methods are created on the singleton class and not base class. ' do
+      [:one, :two, :three, :four, :five, :six, :seven, :eight].each do |key|
+        expect(object.respond_to?(key)).to be true
+      end
+      [:one, :two, :three, :four, :five, :six, :seven, :eight].each do |key|
+        expect(object2.respond_to?(key)).to be false
+      end
+      [:ten, :eleven, :twelve].each do |key|
+        expect(object2.respond_to?(key)).to be true
+      end
+      [:ten, :eleven, :twelve].each do |key|
+        expect(object.respond_to?(key)).to be false
+      end
+    end
+
+    it '#keys returns array of input hash keys' do
+      expect(object.keys).to eq([:one, 4201, :two, :three, :four, :five, :six, :seven, :eight])
+    end
+
+  end
+
+  context 'Basic Operations without marshaling' do
+    it_behaves_like 'plain old ruby object' do
+      let(:bean) { object }
+    end
+  end
+
+  context 'Marshalling to JSON' do
+    it 'maintains structure when marshalling to JSON' do
+      expect(JSON.parse(json_bean)['five']).to eql([4, 5, 6])
+    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[42..-1]).to_not include('ruby/object:SknUtils::NestedResult')
+    end
+
+    it_behaves_like 'plain old ruby object' do
+      let(:bean) { Psych.load(dumped_object) }
+    end
+  end
+
+  context 'NestedResults stripped of their internal singleton accessors can be Marshaled!' do
+    let(:dumped_object) { Psych.dump(object) }
+    let(:loaded_object) { Psych.load(dumped_object) }
+    let(:marshaled_object) { Marshal.dump(loaded_object) }
+
+    it_behaves_like 'plain old ruby object' do
+      let(:bean) { Marshal.load(marshaled_object) }
+    end
+  end
+
+  context 'NestedResults Survive direct Marshall' do
+    let(:marshaled_object) { Marshal.dump(object) }
+
+    it_behaves_like 'plain old ruby object' do
+      let(:bean) { Marshal.load(marshaled_object) }
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -6,7 +6,8 @@ require 'skn_utils/exploring/action_service'
 require 'skn_utils/exploring/configuration'
 
 require 'rspec'
-require 'yaml'
+require 'psych'
+require 'json'
 
 # Shared Examples and Support Routines
 Dir["./spec/support/**/*.rb"].sort.each { |f| require f}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skn_utils
 version: !ruby/object:Gem::Version
-  version: 2.0.6
+  version: 3.0.0
 platform: ruby
 authors:
 - James Scott Jr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-27 00:00:00.000000000 Z
+date: 2017-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,16 +66,23 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: "Creates an PORO Object with instance variables and associated getters
-  and setters for each input key, during runtime.\n If a key's value is also a hash,
-  it too can optionally become an Object.\n If a key's value is a Array of Hashes,
-  each element of the Array can optionally become an Object.\n\n  \nThis nesting action
-  is controlled by the value of the options key ':depth'.  Options key :depth defaults
-  \nto :multi, and has options of :single, :multi, or :multi_with_arrays\n\n  \nThe
-  ability of the resulting Object to be Marshalled(dump/load) can be preserved by
-  merging configuration options\ninto the input params.  Key ':enable_serialization'
-  set to true.  It defaults to false for speed purposes.\n\n\nReview the RSpec tests,
-  and or review the README for more details.\n"
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  The intent of NestedResult class is to be a container of data results or key/value pairs, with easy access to its contents, and on-demand transformation back to the hash (#to_hash).
+  Review the RSpec tests, and or review the README for more details.
 email: skoona@gmail.com
 executables: []
 extensions: []
@@ -90,30 +97,22 @@ files:
 - README.md
 - README.rdoc
 - Rakefile
+- bin/console
 - lib/skn_utils.rb
-- 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/nested_result.rb
+- lib/skn_utils/notifier_base.rb
 - lib/skn_utils/null_object.rb
-- lib/skn_utils/page_controls.rb
-- lib/skn_utils/result_bean.rb
-- lib/skn_utils/value_bean.rb
 - lib/skn_utils/version.rb
 - skn_utils.gemspec
 - 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/nested_result_spec.rb
 - spec/lib/skn_utils/null_object_spec.rb
-- spec/lib/skn_utils/page_controls_spec.rb
-- spec/lib/skn_utils/result_bean_spec.rb
-- spec/lib/skn_utils/value_bean_spec.rb
 - spec/spec_helper.rb
-- spec/support/shared_example_marshalable_ruby_pojo.rb
-- spec/support/shared_example_ruby_pojo.rb
 homepage: https://github.com/skoona/skn_utils
 licenses:
 - MIT
@@ -134,23 +133,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 3
-summary: Ruby convenience utilities, the first being a ResultBean.    ResultBean is
-  a PORO (Plain Old Ruby Object) which inherits from NestedResultBean class (inlcuded).
-  This class  is instantiated via a hash at Ruby Runtime, allowing access to vars
-  via dot or hash notation,  and is serializable (<obj>.to_hash) using standard Hash
-  serialization methods.
+summary: SknUtils contains a small collection of Ruby utilities, the first being a
+  NestedResult a key/value container.
 test_files:
 - 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/nested_result_spec.rb
 - spec/lib/skn_utils/null_object_spec.rb
-- spec/lib/skn_utils/page_controls_spec.rb
-- spec/lib/skn_utils/result_bean_spec.rb
-- spec/lib/skn_utils/value_bean_spec.rb
 - spec/spec_helper.rb
-- spec/support/shared_example_marshalable_ruby_pojo.rb
-- spec/support/shared_example_ruby_pojo.rb

data/lib/skn_utils/attribute_helpers.rb

@@ -1,188 +0,0 @@
-##
-# <project.root>/lib/skn_utils/attribute_helpers.rb
-#
-# *** See SknUtils::NestedResultBase for details ***
-#
-##
-# This module provides
-#
-# to_hash Serializer:
-#    person.to_hash
-#      => {"name"=>"Bob"}
-#
-# Support <attr>? and clear_<attr>? method patterns
-#  example:
-#    person.name?
-#      => true          true or false, like obj.name.present?
-#    person.clear_name
-#      => nil           sets :name to nil
-#
-# attr_accessor like feature for all instance variables
-#   person.name
-#     => "Bob"
-#   person.name = "James"
-#     => "James"
-##
-
-
-
-module SknUtils
-  module AttributeHelpers
-
-    # These methods normally come from ActiveSupport in Rails
-    # If your not using this gem with Rails, then the :included method
-    # will add these routines to the Object class
-    def self.included(mod)
-        unless Object.respond_to? :instance_variable_names  
-          Object.class_exec {
-            def instance_variable_names 
-              instance_variables.map { |var| var.to_s } 
-            end
-            def instance_values
-              Hash[instance_variables.map { |name| [name[1..-1], instance_variable_get(name)] }]
-            end
-          }
-        end
-    end
-
-    # return a hash of all attributes and their current values
-    # including nested arrays of hashes/objects
-    def attributes(filter_internal=true)
-      instance_variable_names.each_with_object({}) do |attr,collector|
-        next if ['skn_enable_serialization', 'skn_enabled_depth'].include?(attr.to_s[1..-1]) and filter_internal  # skip control keys
-        value = instance_variable_get(attr)
-
-        if value.kind_of?(Array) and value.first.respond_to?(:attribute_helper_object)
-          value = value.map {|ov| ov.respond_to?(:attribute_helper_object) ? ov.attributes : ov }
-        elsif value.respond_to?(:attribute_helper_object)
-          value = value.attributes
-        end
-        collector[attr.to_s[1..-1].to_sym] = value
-      end
-    end
-
-    def to_hash(exclude_internal_vars=false)
-      attributes(!exclude_internal_vars)
-    end
-    alias_method :to_h, :to_hash
-
-    # An alternative mechanism for property access.
-    # Hash notation
-    def [](attr)
-      send("#{attr}")
-    end
-
-    # Hash notation
-    def []=(attr, value)
-      send("#{attr}=", value)
-    end
-
-    ##
-    #  DO NOT ADD METHODS BELOW THIS LINE, unless you want them to be private
-    ##
-
-    # Support the regular respond_to? method by 
-    # answering for any attr that method missing actually handle
-    #:nodoc:
-    def respond_to_missing?(method, incl_private=false)
-       instance_variable_names.include?("@#{method.to_s}") || super(method,incl_private)
-    end
-    
-    private
-
-    # Deals with the true existance of an attribute and then its non-blank or empty value
-    # - attribute must exist and have a non-blank value to cause this method to return true
-    #:nodoc:    
-    def attribute?(attr)
-      return false unless  instance_variable_names.include?("@#{attr.to_s}")
-      if attr.is_a? Symbol        
-       ![ "", " ", nil, [],[""], [" "], {} ].include?( send(attr) )
-      else
-        ![ "", " ", nil, [],[""], [" "], {} ].include?( send(attr.to_sym) )
-      end
-    end
-
-    #:nodoc:
-    def clear_attribute(attr)
-      if attr.is_a? Symbol
-        instance_variable_set("@#{attr.to_s}", nil)
-      else
-        instance_variable_set("@#{attr}", nil)
-      end
-    end
-
-    # Determines operable Options in effect for this instance
-    # see NestedResultBase
-    #:nodoc:
-    def serial_required?
-      respond_to? :serialization_required? and serialization_required?
-    end
-    # see NestedResultBase
-    #:nodoc:
-    def multi_required?
-      respond_to? :depth_level and depth_level != :single 
-    end
-    # see NestedResultBase
-    #:nodoc:
-    def multi_with_arrays_required?
-      respond_to? :depth_level and depth_level == :multi_with_arrays 
-    end
-
-    ##
-    # Adds the attr?() method pattern.  all attributes will respond to attr?: example - obj.name? with true or false
-    # Adds the clear_attr() method pattern.  all attributes will respond to clear_attr(): example - obj.clear_name sets :name to nil
-    # Handles getter for any instance_variable currently defined
-    # Handles setter for any instance_variable currently defined
-    # Sets new instance_variable for any undefined variable with non-hash value
-    # Sets instance_variable value to Bean object for any undefined variable with hash value param
-    #
-    # Using any form of singleton_class() will break the generic bean, which requires Serialization.
-    # However not adding attr_accessors may impact performance, as method_missing must fill-in for read/writes
-    ##
-    #:nodoc:
-    def method_missing(method, *args, &block)
-      # puts("method_missing/method/class/*args=#{method}/#{method.class.name}/#{args}")
-      if method.to_s.start_with?('clear_') and instance_variable_defined?("@#{method.to_s[6..-1]}")
-        clear_attribute(method.to_s[6..-1].to_sym)
-      elsif method.to_s.end_with?('?')
-        if instance_variable_defined?("@#{method.to_s[0..-2]}")
-          attribute?(method.to_s[0..-2].to_sym)
-        else
-          false
-        end
-      elsif method.to_s.end_with?("=")              # add new attribute or whole object
-        if args.first.is_a?(Hash) 
-          singleton_class.send(:attr_accessor, method.to_s[0..-2]) unless serial_required?
-          if multi_required?
-            instance_variable_set "@#{method.to_s[0..-2]}", self.class.new(*args)
-          else
-            instance_variable_set "@#{method.to_s[0..-2]}", *args
-          end
-        elsif args.first.is_a?(Array) and args.flatten.first.kind_of?(Hash)
-          singleton_class.send(:attr_accessor, method.to_s[0..-2]) unless serial_required?
-          if multi_with_arrays_required?
-            instance_variable_set("@#{method.to_s[0..-2]}", 
-                (args.first.map {|nobj| nobj.kind_of?(Hash) ? self.class.new(nobj) : nobj }) 
-            )
-          else
-            instance_variable_set "@#{method.to_s[0..-2]}", *args
-          end
-        elsif !args.empty?
-          singleton_class.send(:attr_accessor, method.to_s[0..-2]) unless serial_required?
-          instance_variable_set "@#{method.to_s[0..-2]}", *args
-        else
-          super(method, *args, &block)      # throw excpt for not found or could return false
-        end
-      elsif instance_variable_defined? "@#{method.to_s}"
-        instance_variable_get "@#{method.to_s}"
-      else
-        super(method, *args, &block)
-      end
-    rescue
-       # puts $!.message + $!.backtrace.join("\n")
-      super(method, *args, &block)
-    end
-    # end of private section
-
-  end # end module
-end # end module

data/lib/skn_utils/generic_bean.rb

@@ -1,20 +0,0 @@
-##
-# <project.root>/lib/skn_utils/generic_bean.rb
-#
-# *** See SknUtils::NestedResultBase for details ***
-#
-##
-# (Defaults)
-# :enable_serialization = true
-# :depth = :multi
-
-module SknUtils
-
-  class GenericBean < NestedResultBase
-    #:nodoc:
-    def initialize(params={})
-      super( params.merge({enable_serialization: true}) )
-    end
-  end # end class
-  
-end # end module