skn_utils 2.0.2 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16db7b3b33003706dd1edab8aaf65a4af517f383
-  data.tar.gz: d4c20f62a0723f50657e6025a62579f0c8c799a5
+  metadata.gz: 6db99e4aeb953f51c21ff313dee110b9af305691
+  data.tar.gz: 32a906192681346ab40052157e833ddd73d40bac
 SHA512:
-  metadata.gz: fe7fcee2998180166c6ebc4491170afcde6fd8b7973aaa72c1bb2122ca518a9545bbc81a51716f5a4ec9f59b35fe74ff4e6bf087a538aee9426989d9fbe41ec9
-  data.tar.gz: 33f8b0fbe884fd40feb53876b4e316260f80a6d53f284bf31ab11c1ba7797fffec8c63162ea57afebcff81b028e33c82a1bde4f75e1c7568e56ca8b462e2f3ff
+  metadata.gz: 0e6e5be4b0308853f81798dc2f0c599bd909c4353de6842e60d4f43cf6b09f58bda1e651845adc98f9338f7194b0ceacbf51638fe20349b2a96fb94acc0b9c72
+  data.tar.gz: bf41ea172ab26025e58e2242ab9e7498f0cdaa42ddb4cac661de862c0d83ae85cae3ad19e3d863278ad5cd17a214086f4e2c0cbc29ed0a79f64cd91a8eb658a5

data/README.md

@@ -25,6 +25,10 @@ into the input params key ':enable_serialization' set to true.  It defaults to f
 ### New Features
 --------------------------------
 
+    08/2016  V2.0.3  
+    Added an exploritory ActionService class and RSpec test, triggered by reading [Kamil Lelonek](https://blog.lelonek.me/what-service-objects-are-not-7abef8aa2f99#.p64vudxq4)
+    I don't support his approach, but the CreateTask class caught my attention as a Rubyist.        
+
     02/2015  V2.0.2  
     Added Jim Gay's Direction module, from his [Eastward Video](http://confreaks.tv/videos/rubyconf2014-eastward-ho-a-clear-path-through-ruby-with-oo)
     which allows to use :command instead of :Forwardable to implement a portion of the 'Eastward' methodology.        

data/lib/skn_utils/action_service.rb

@@ -0,0 +1,88 @@
+## lib/skn_utils/action_service.rb
+#
+# Exploritory Action/Service Class
+# Ref: https://blog.lelonek.me/what-service-objects-are-not-7abef8aa2f99#.p64vudxq4
+#
+# Not a template or abstract class, Just an Example of an Action class
+#
+
+module SknUtils
+  class ActionService
+
+    def initialize(dependency_injection_arguments)
+      @thingy = dependency_injection_arguments
+    end
+
+    def call(*command_and_params)
+      puts "Called with: #{command_and_params}"
+      value = command_and_params
+      if value.first.is_a?(Symbol)
+        (value.size == 1 ? self.send(value.first) : self.send(value.first, value[1..-1]))
+      else
+        puts('No Action Taken')
+      end
+
+      self
+    end
+
+    private
+    # a bunch of private methods
+    def action_one
+      puts "#{__method__}() #{@thingy}"
+      true
+    end
+
+    def action_two(parm)
+      puts "#{__method__} => #{parm} #{@thingy}"
+      true
+    end
+
+  end # end class
+end # end module
+
+
+# - regular execution
+# action = DoSomeAction.new.(arg1, arg2)
+#
+# action.('Mine')
+# => Called with: ["Mine"]
+# => "No Action Taken"
+# => #<SknUtils::ActionService:0x007ffa62079c20 @thingy="Things">
+#
+# action.()
+# =>Called with: []
+# => "No Action Taken"
+# => #<SknUtils::ActionService:0x007ffa62079c20 @thingy="Things">
+#
+# action.(:action_two,'samples')
+# => Called with: [:action_two, "samples"]
+# => action_two(["samples"]) with Thingy: Things
+# => #<SknUtils::ActionService:0x007ffa62079c20 @thingy="Things">
+#
+# action.(:action_one,'samples')
+# => Called with: [:action_one, "samples"]
+# => action_one() Thingy: Things
+# => #<SknUtils::ActionService:0x007ffa62079c20 @thingy="Things">
+#
+# action.(:action_one).(:action_two,'Always')
+# => Called with: [:action_one]
+# => action_one() Thingy: Things
+# => Called with: [:action_two, "Always"]
+# => action_two(["Always"]) with Thingy: Things
+# => #<SknUtils::ActionService:0x007ffa62079c20 @thingy="Things">
+#
+# - with dependency injection
+#
+# def do_some_action
+#   DoSomeAction.new(http_adapter)
+# end
+#
+# do_some_action.(arg1, arg2)
+#
+#
+#
+# - in tests
+#
+# let(:do_some_action) { DoSomeAction.new(fake_http_adapter) }
+# it { is_expected.to be_connected }
+#

data/lib/skn_utils/attribute_helpers.rb

@@ -64,6 +64,7 @@ module SknUtils
     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

data/lib/skn_utils/nested_result_base.rb

@@ -36,7 +36,7 @@ module SknUtils
     def initialize(params={})
       @skn_enabled_depth = params.delete(:depth) {|not_found| :multi }
       @skn_enable_serialization = params.delete(:enable_serialization) {|not_found| false }
-      case depth_level
+      case @skn_enabled_depth
         when :single
               single_level_initializer(params)                 
         when :multi_with_arrays
@@ -99,22 +99,23 @@ module SknUtils
       true
     end
 
-    # Some keys have chars not suitable for symbol keys
+    # Some keys have chars not suitable for symbol keys => @,#,:,-
     #:nodoc:
     def clean_key(original)
-      formatted_key = original.to_s
-      if /^[#|@|:]/.match(formatted_key)  # filter out (@xsi) from '@xsi:type' keys
-        label = /@(.+):(.+)/.match(formatted_key) || /[#|@|:](.+)/.match(formatted_key) || [] 
-        formatted_key = case label.size
-                          when 1
-                            label[1].to_s
-                          when 2
-                            "#{label[1]}_#{label[2]}"
-                          else
-                            original  # who knows what it was, give it back
-                        end
-      end
-      formatted_key
+      formatted_key = original.to_s.gsub(/[#|@]/,'').gsub(/[:|-]/,'_')
+
+      # if /^[#|@|:]/.match(formatted_key)  # filter out (@xsi) from '@xsi:type' keys
+      #   label = /@(.+):(.+)/.match(formatted_key) || /[#|@|:](.+)/.match(formatted_key) || []
+      #   formatted_key = case label.size
+      #                     when 1
+      #                       label[1].to_s
+      #                     when 2
+      #                       "#{label[1]}_#{label[2]}"
+      #                     else
+      #                       original  # who knows what it was, give it back
+      #                   end
+      # end
+      # formatted_key
     end
     
         

data/lib/skn_utils/version.rb

@@ -1,3 +1,3 @@
 module SknUtils
-  VERSION = "2.0.2"
+  VERSION = "2.0.3"
 end

data/lib/skn_utils.rb

@@ -6,6 +6,7 @@ require 'skn_utils/page_controls'
 require 'skn_utils/result_bean'
 require 'skn_utils/value_bean'
 require 'skn_utils/commander'
+require 'skn_utils/action_service'
 
 module SknUtils
   

data/spec/lib/skn_utils/action_service_spec.rb

@@ -0,0 +1,40 @@
+##
+# spec/lib/skn_utils/action_service_spec.rb
+#
+
+RSpec.describe SknUtils::ActionService, "Example Service Object class with command interface." do
+  let(:action) {
+    SknUtils::ActionService.new('Thingys')
+  }
+
+  context "Handles Bad Input. " do
+    it "Handles invalid string input params" do
+      expect { action.('Samples') }.to output(/Samples/).to_stdout
+    end
+  end
+
+  context "Single Method Invocations. " do
+    it "Handles a call with no param" do
+      expect { action.() }.to output(/No Action Taken/).to_stdout
+    end
+    it "Handles a call with one param" do
+      expect { action.(:action_one) }.to output(/Thingys/).to_stdout
+    end
+    it "Handles a call with more than one param" do
+      expect { action.(:action_two, 'Wonderful') }.to output(/Wonderful/).to_stdout
+    end
+  end
+
+  context "Chaining Method Invocations. " do
+    it "Handles calls with no params" do
+      expect { action.().() }.to output(/No Action Taken/).to_stdout
+    end
+    it "Handles a calls with one param" do
+      expect { action.(:action_one).(:action_one) }.to output(/Thingys/).to_stdout
+    end
+    it "Handles a calls with more than one param" do
+      expect { action.(:action_two, 'Wonderful').(:action_two, 'Marvelous') }.to output(/Wonderful/).to_stdout
+    end
+  end
+
+end

data/spec/lib/skn_utils/result_bean_spec.rb

@@ -35,6 +35,9 @@ RSpec.describe SknUtils::ResultBean, "Result Bean class - Basic usage." do
     it "Supports - respond_to - methods, because it has accessor methods" do
       expect(object).to respond_to(:one)
     end
+    it "Supports - respond_to - methods, because it has respond_to_missing? method" do
+      expect(object.method(:one)).to be
+    end
   end
 
   shared_examples_for "retains initialization options" do

data/spec/lib/skn_utils/value_bean_spec.rb

@@ -0,0 +1,96 @@
+##
+# spec/lib/skn_utils/Value_bean_spec.rb
+#
+
+RSpec.describe SknUtils::ValueBean, "Basic Value Bean class " do
+  let(:object) {
+    SknUtils::ValueBean.new({one: "one",
+                             two: "two",
+                             three: {four: 4, five: 5, six: {seven: 7, eight: "eight" }},
+                             four: {any_key: "any value"}, five: []}
+                           )
+  }
+
+  context "Internal Operations, assuming :dept => :multi and enable_serialization => true" do
+    it "Creates an empty bean if no params are passed" do
+      is_expected.to be
+    end
+    it "Can be Marshalled after dynamically adding a key/value." do
+        expect { object.fifty = {any_key: "any value"} }.not_to raise_error  
+        expect { object.sixty = 60 }.not_to raise_error
+        dmp = obj = ""  
+        expect { dmp =  Marshal.dump(object) }.not_to raise_error
+        expect { obj = Marshal.load(dmp) }.not_to raise_error
+        expect(obj).to be_a(SknUtils::ValueBean)
+        expect(obj.fifty[:any_key]).to eql "any value"
+        expect(obj.sixty).to eql 60
+    end
+    it "Initializes from a hash" do
+      expect(SknUtils::ValueBean.new({one: "one", two: "two"})).to be
+    end
+    it "Does not modify the base class, only singleton instance methods" do
+      obj1 = SknUtils::ValueBean.new({one: "one", two: "two"})
+      obj2 = SknUtils::ValueBean.new({three: "3", four: "4"})
+      expect(obj1.one).to eql "one"
+      expect(obj2.three).to eql "3"
+      expect(obj2.one?).to be false
+      expect(obj1.three?).to be false
+      expect { obj1.three }.to raise_error NoMethodError
+      expect { obj2.one }.to raise_error NoMethodError
+    end
+    it "Supports - respond_to? - method, because it has accessors or method_missing coverage" do
+      expect(object).to respond_to(:one)
+      expect(object.one).to eql "one"
+      expect{ object.fifty = {any_key: "any value"} }.not_to raise_error  
+      expect( object.fifty).not_to respond_to(:any_key)
+    end
+    it "nest objects if multi-level hash is given" do
+      expect(object.one).to be_eql("one")
+      expect(object.two).to be_eql("two")
+      expect(object.three).to be_a(Hash)
+      expect(object.three[:five]).to eq(5)
+    end
+    it "#attributes method returns a hash of all attributes and their values." do
+      expect(object.to_hash).to be_a(Hash)
+      expect(object.to_hash[:one]).to be_eql("one")
+      expect(object.to_hash[:three]).to be_a(Hash)
+    end
+  end
+
+  shared_examples_for "retains initialization options" do
+    it "retains depth_level option flag" do
+      expect(@obj.depth_level).to eql(:single)
+    end
+    it "retains serialization option flag" do
+      expect(@obj.serialization_required?).to be true
+    end    
+  end
+
+  context "Basic Operations without marshaling " do
+    before :each do
+      @obj = object
+    end
+
+    it_behaves_like "retains initialization options"    
+    it_behaves_like "marshalable ruby pojo"
+  end
+  context "Basic Operations after Yaml marshaling " do
+    before :each do
+      dmp = YAML::dump(object)
+      @obj = YAML::load(dmp)
+    end
+
+    it_behaves_like "retains initialization options"    
+    it_behaves_like "marshalable ruby pojo"
+  end
+  context "Basic Operations after Marshal marshaling " do
+    before :each do
+      dmp =  Marshal.dump(object)
+      @obj = Marshal.load(dmp)
+    end
+
+    it_behaves_like "retains initialization options"    
+    it_behaves_like "marshalable ruby pojo"
+  end
+
+end

data/spec/support/shared_example_ruby_pojo.rb

@@ -49,6 +49,7 @@ RSpec.shared_examples "ruby pojo" do
   context "transformations are enabled with " do
     it "#attributes method returns a hash of all attributes and their values." do
       expect(@obj.to_hash).to be_a(Hash)
+      expect(@obj.to_h).to be_a(Hash)
       expect(@obj.to_hash[:one]).to be_eql("one")
       expect(@obj.to_hash[:three]).to be_a(Hash)
     end    

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skn_utils
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.3
 platform: ruby
 authors:
 - James Scott Jr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-10 00:00:00.000000000 Z
+date: 2016-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -91,6 +91,7 @@ files:
 - README.rdoc
 - Rakefile
 - lib/skn_utils.rb
+- lib/skn_utils/action_service.rb
 - lib/skn_utils/attribute_helpers.rb
 - lib/skn_utils/commander.rb
 - lib/skn_utils/generic_bean.rb
@@ -100,10 +101,12 @@ 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/generic_bean_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
@@ -136,10 +139,12 @@ 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/generic_bean_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