skn_utils 1.4.5 → 1.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d507e27470fdd7830e4d234c8379439c2257cc3c
-  data.tar.gz: 0e8cb8c6436691a0ee084a37a54f7faf2c8e0e43
+  metadata.gz: 31af39f0868ea4999dc766b6aae69160f4bddd49
+  data.tar.gz: e93e86e18c70fabab120f77f6bc84c6f9d858337
 SHA512:
-  metadata.gz: 4efb27c8aee7c16609c383e3bebd0103c000d6d35c1a1172db3a5e6542d011aa717cff3e0bb312e8cf8a30a41fa89a4be480c1e190ae9c5bfa41146467e1eaaa
-  data.tar.gz: bcfff18e1eb895e891455a22350f2512d99ac4bb70a32ff2d543d7e7d740b462f9ce13607dfa4d2cd711fcb30c1b3fe890abb649a2017d9e66947fbe38cc6fdc
+  metadata.gz: e02f2ff71734ebfc2ebc213575eef8f15015c8fb879ac7b8222f6a0e21caa1e247daae0041f9d264a5c649de7bf86857734daf6b88341c6e34d3250085e886ef
+  data.tar.gz: a443ea041ec7ab9495f0662082913ffc75bd8c4380c1c6187b13784b09e2f6490a3acc0bbe17d298f90ec44ad20457b63ce456d9f62e56733a89701a8f037884

data/LICENSE

@@ -1,22 +1,22 @@
-The MIT License (MIT)
+Copyright (c) 2015 James Scott Jr
 
-Copyright (c) 2015 James Scott, Jr
+MIT License
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,223 @@
+[![Gem Version](https://badge.fury.io/rb/skn_utils.svg)](http://badge.fury.io/rb/skn_utils)
+
+= SknUtils 
+Rails Gem containing a Ruby PORO (Plain Old Ruby Object) that can be instantiated at runtime with an input hash.  This library creates an Object with instance variables and associated getters and setters for Dot or Hash notational access to each instance variable.  Additional instance variables can be added post-create by 'obj.my_new_var = "some value"', or simply assigning it.  
+
+
+The intent of this component is to be a container of data results, with easy access to its contents with on-demand transformation to hash, xml, or json. 
+
+* If the key's value is also a hash, it too can optionally become an Object.
+* if the key's value is a Array of Hashes, each element of the Array can optionally become an Object.
+  
+  This nesting action is controlled by the value of the options key ':depth'. 
+    The key :depth defaults to :multi, an has options of :single, :multi, or :multi_with_arrays
+  
+  The ability of the resulting Object to be Marshalled(dump/load) can be preserved by merging configuration options 
+    into the input params key ':enable_serialization' set to true.  It defaults to false for speed purposes
+ 
+
+=== Configuration Options
+--------------------------------
+
+    :enable_serialization = false     -- [ true | false ], for speed, omits creation of attr_accessor
+    :depth = :multi                   -- [ :single | :multi | :multi_with_arrays ]
+
+=== Public Components
+--------------------------------
+
+    Inherit from NestedResultBase or instantiate an pre-built Class:
+      SknUtils::GenericBean              # => Serializable, includes attr_accessors, and follows hash values only.
+      SknUtils::PageControls             # => Serializable, includes attr_accessors, and follows hash values and arrays of hashes.
+      SknUtils::ResultBean               # => Not Serializable, includes attr_accessors, and follows hash values only.
+      SknUtils::ResultsBeanWithErrors    # => Same as ResultBean with addition of ActiveModel::Errors object.
+    or Include AttributeHelpers          # => Add getter/setters, and hash notation access to instance vars of any object.
+
+
+== Basic features include:
+```ruby
+ - provides the hash or dot notation methods of accessing values from object created; i.e
+     'obj = ResultBean.new({value1: "some value", value2: {one: 1, two: "two"}}) 
+     'x = obj.value1' or 'x = obj.value2.one'
+     'x = obj["value1"]'
+     'x = obj[:value1]'
+
+ - enables serialization by avoiding the use of ''singleton_class'' methods which breaks Serializers:
+    Serializer supports xml, json, hash, and standard Marshall''ing
+
+    person = PageControls.new({name: "Bob"})
+    person.attributes          # => {"name"=>"Bob"}
+    person.serializable_hash   # => {"name"=>"Bob"}
+    person.to_hash             # => {"name"=>"Bob"}
+    person.to_json             # => "{\"name\":\"Bob\"}"
+    person.to_xml              # => "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<page-controls>\n  <name>Bob</name>\n</page-controls>\n"
+    dmp = Marshal.dump(person) # => "\x04\bo:\x1ASknUtils::PageControls\x06:\n@nameI\"\bBob\x06:\x06ET"
+    person = Marshal.load(dmp) # => #<SknUtils::PageControls:0x007faede906d40 @name="Bob">
+
+    ***GenericBean designed to automatically handle the setup for serialization and multi level without arrays 
+
+ - post create additions:
+    'obj = ResultBean.new({value1: "some value", value2: {one: 1, two: "two"}}) 
+    'x = obj.one'                          --causes NoMethodError
+    'x = obj.one = 'some other value'      --creates a new instance value with accessors
+    'x = obj.one = {key1: 1, two: "two"}'  --creates a new ***bean as the value of obj.one
+    'y = obj.one.two'                      --returns "two"
+    'y = obj.one[:two]                     --returns "two"
+    'y = obj.one['two']                    --returns "two"
+
+ - supports predicates <attr>? and clear_<attr>? method patterns: 
+    'obj = PageControls.new({name: "Something", phone: "2609998888"})'
+    'obj.name?'       # => true    true or false, like obj.name.present?
+    'obj.clear_name'  # => nil     sets :name to nil
+```
+
+The combination of this NestedResultBase(dot notation class) and AttributeHelpers(hash notation module), produces this effect given the same params hash:
+
+    SknUtils::ResultBean.new(params)                          Basic dot notation: effect of :depth
+    ----------------------------------------------------      -----------------------------------------------------------------
+
+(DOES NOT FOLLOW Values) :depth => :single
+```ruby
+    * params = {one: 1,                                         drb.one      = 1
+                two: { one: 1,                                  drb.two      = {one: 1, two: 'two}
+                       two: "two"                               drb.two.two  = NoMethodError
+                     }, 
+                three: [ {one: 'one', two: 2},                  drb.three    = [{one: 'one', two: 2},{three: 'three', four: 4}]
+                         {three: 'three', four: 4}              drb.three[1] = {three: 'three', four: 4}
+                       ]                                        drb.three[1].four = NoMethodError
+               }      
+```
+
+(Follow VALUES that are Hashes only.) :depth => :multi
+```ruby
+    * params = {one: 1,                                         drb.one      = 1
+                two: { one: 1,                                  drb.two      = <SknUtils::ResultBean>
+                     two: "two"                                 drb.two.two  = 'two'
+                     }, 
+                three: [ {one: 'one', two: 2},                  drb.three    = [{one: 'one', two: 2},{three: 'three', four: 4}]
+                         {three: 'three', four: 4}              drb.three[1] = {three: 'three', four: 4}
+                       ]                                        drb.three[1].four = NoMethodError
+             }
+```
+ 
+(Follow VALUES that are Hashes and/or Arrays of Hashes) :depth => :multi_with_arrays
+```ruby
+    * params = {one: 1,                                         drb.one      = 1
+                two: { one: 1,                                  drb.two      = <SknUtils::ResultBean>
+                       two: "two"                               drb.two.two  = 'two'
+                     }, 
+                three: [ {one: 'one', two: 2},                  drb.three    = [<SknUtils::ResultBean>,<SknUtils::ResultBean>]
+                         {three: 'three', four: 4}              drb.three[1] = <SknUtils::ResultBean>
+                       ]                                        drb.three[1].four = 4
+               }      
+ 
+```
+= Usage: 
+
+(DOES NOT FOLLOW Values)
+```ruby
+       class SmallPackage < SknUtils::NestedResultBase
+          def initialize(params={})
+            super( params.merge({depth: :single}) )    # override default of :multi level
+          end
+       end
+```
+
+(Follow VALUES that are Hashes only.)
+```ruby
+       class ResultBean < SknUtils::NestedResultBase
+          # defaults to :multi level
+       end
+       
+    -- or --
+    
+       class ResultBean < SknUtils::NestedResultBase
+          def initialize(params={})
+            # your other init stuff here
+            super(params)    # default taken 
+          end
+       end
+       
+    -- or --
+    
+       class ResultBean < SknUtils::NestedResultBase
+          def initialize(params={})
+            # your other init stuff here
+            super( params.merge({depth: :multi}) )    # Specified
+          end
+       end
+       
+    ** - or -- enable serialization and default to multi
+       class GenericBean < SknUtils::NestedResultBase
+          def initialize(params={})
+            super( params.merge({enable_serialization: true}) )    # Specified with Serialization Enabled
+          end
+       end
+```
+
+(Follow VALUES that are Hashes and/or Arrays of Hashes, and enable Serializers)
+```ruby
+       class PageControl < SknUtils::NestedResultBase
+          def initialize(params={})
+            super( params.merge({depth: :multi_with_arrays, enable_serialization: true}) )    # override defaults
+          end
+       end
+```
+
+
+NOTE: Cannot be Marshalled/Serialized unless input params.merge({enable_serialization: true}) -- default is false
+Use GenericBean or PageControls if serialization is needed, they initialize with this value true.
+
+== Installation
+----------------
+runtime prereqs: gem 'active_model', '~> 3.0'
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'skn_utils'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install skn_utils
+
+== Build    
+
+1. $ git clone git@github.com:skoona/skn_utils.git
+2. $ cd skn_utils
+3. $ gem install bundler
+4. $ bundle install
+5. $ bundle exec rspec
+6. $ gem build skn_utils.gemspec
+7. $ gem install skn_utils
+* Done
+
+== Console Workout    
+
+Start with building gem first.
+```bash    
+$ cd skn_utils
+$ bundle exec pry
+[1] pry(main)> require 'active_model' 
+[2] pry(main)> require 'skn_utils'    
+[3] pry(main)> rb = SknUtils::ResultBean.new({sample: [{one: "one", two: "two"},{one: 1, two: 2}] })
+[4] pry(main)> pg = SknUtils::PageControls.new({sample: [{one: "one", two: "two"},{one: 1, two: 2}] }) 
+[5] pry(main)> pg.sample.first.one          # Tip :multi_with_arrays
+[6] pry(main)> rb.sample.first.one          # Tip :multi without arrays  you will get a NoMethodError
+[7] pry(main)> rb.sample.first[:one]        
+    
+[n] pry(main)> exit
+* Done
+```
+    
+== Contributing
+
+1. Fork it 
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -3,4 +3,5 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
+desc "Run RSpec tests."
 task :default => :spec

data/lib/skn_utils/attribute_helpers.rb

@@ -51,16 +51,18 @@ module SknUtils
     end
 
     # An alternative mechanism for property access.
-    # This let's you do foo['bar'] along with foo.bar.
+    # Hash notation
     def [](attr)
       send("#{attr}")
     end
 
+    # Hash notation
     def []=(attr, value)
       send("#{attr}=", value)
     end
 
     # determines if this is one of our objects
+    #:nodoc:
     def attribute_helper_object
       true
     end
@@ -70,6 +72,7 @@ module SknUtils
     ##
     private
 
+    #:nodoc:
     def attribute?(attr)
       if attr.is_a? Symbol
         send(attr).present?
@@ -78,6 +81,7 @@ module SknUtils
       end
     end
 
+    #:nodoc:
     def clear_attribute(attr)
       if attr.is_a? Symbol
         instance_variable_set("@#{attr.to_s}", nil)
@@ -88,14 +92,17 @@ module SknUtils
 
     # 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
@@ -111,6 +118,7 @@ module SknUtils
     # 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]}")

data/lib/skn_utils/generic_bean.rb

@@ -11,6 +11,7 @@
 module SknUtils
 
   class GenericBean < NestedResultBase
+    #:nodoc:
     def initialize(params={})
       super( params.merge({enable_serialization: true}) )
     end

data/lib/skn_utils/nested_result_base.rb

@@ -156,6 +156,7 @@ module SknUtils
     # :depth defaults to :multi
     # :enable_serialization controls the use of singleton_method() to preserve the ability to Marshal
     # :enable_serialization defaults to false
+    #:nodoc:
     def initialize(params={})
       @skn_enabled_depth = params.delete(:depth) {|not_found| :multi }
       @skn_enable_serialization = params.delete(:enable_serialization) {|not_found| false }
@@ -169,6 +170,7 @@ module SknUtils
       end
     end
 
+    #:nodoc:
     def single_level_initializer(params={})   # Single Level Initializer -- ignore value eql hash
       params.each do |k,v|
         key = clean_key(k)
@@ -177,6 +179,7 @@ module SknUtils
       end
     end
 
+    #:nodoc:
     def multi_level_initializer(params={}) # Multi Level Initializer -- value eql hash then interate
       params.each do |k,v|
         key = clean_key(k)
@@ -189,6 +192,7 @@ module SknUtils
       end
     end
 
+    #:nodoc:
     def multi_level_incl_arrays_initializer(params={}) # Multi Level Initializer including Arrays of Hashes
       params.each do |k,v|
         key = clean_key(k)
@@ -208,12 +212,13 @@ module SknUtils
       @skn_enable_serialization
     end
 
-    # enablement for latter additions    
+    # enablement for latter additions        
     def depth_level
       @skn_enabled_depth
     end
 
     # 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

data/lib/skn_utils/page_controls.rb

@@ -12,6 +12,7 @@
 module SknUtils
 
   class PageControls < NestedResultBase
+    #:nodoc:
     def initialize(params={})
       super( params.merge({enable_serialization: true, depth: :multi_with_arrays}) )
     end

data/lib/skn_utils/result_bean_with_errors.rb

@@ -22,20 +22,24 @@ module SknUtils
 
     attr_reader :errors
 
+    #:nodoc:
     def initialize(params={})
       @errors = params.delete :errors
       @errors = ActiveModel::Errors.new(self) unless @errors.present?
       super(params)
     end
-
+    
+    #:nodoc:
     def read_attribute_for_validation(attr)
       send(attr)
     end
 
+    #:nodoc:
     def self.human_attribute_name(attr, options = {})
       attr
     end
 
+    #:nodoc:
     def self.lookup_ancestors
       [self]
     end

data/lib/skn_utils/version.rb

@@ -1,3 +1,3 @@
 module SknUtils
-  VERSION = "1.4.5"
+  VERSION = "1.4.6"
 end

data/skn_utils.gemspec

@@ -8,6 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = SknUtils::VERSION
   spec.author        = 'James Scott Jr'
   spec.email         = 'skoona@gmail.com'
+  spec.date          = %q{2015-04-06}
   spec.summary       = <<EOF
 Ruby convenience utilities, the first being a ResultBean. 
 
@@ -52,5 +53,10 @@ EOF
   spec.add_development_dependency "rake", ">= 0"
   spec.add_development_dependency "rspec", '~> 3.0'
   spec.add_development_dependency "pry", ">= 0"
-  spec.post_install_message = "Thanks for installing SknUtils, keep watch more utilities will be added!"
+  
+  ## 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.0'
+  spec.specification_version = 3 if spec.respond_to? :specification_version  
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skn_utils
 version: !ruby/object:Gem::Version
-  version: 1.4.5
+  version: 1.4.6
 platform: ruby
 authors:
 - James Scott Jr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-08 00:00:00.000000000 Z
+date: 2015-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -99,8 +99,8 @@ files:
 - ".rspec"
 - Gemfile
 - LICENSE
-- LICENSE.txt
 - README.md
+- README.rdoc
 - Rakefile
 - lib/skn_utils.rb
 - lib/skn_utils/attribute_helpers.rb
@@ -122,8 +122,7 @@ homepage: https://github.com/skoona/skn_utils
 licenses:
 - MIT
 metadata: {}
-post_install_message: Thanks for installing SknUtils, keep watch more utilities will
-  be added!
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -131,7 +130,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -141,7 +140,7 @@ requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.6
 signing_key: 
-specification_version: 4
+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 intantiated  via a hash at Ruby/Rails Runtime, allows access to vars

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2015 James Scott Jr
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.