safe_nested_calls 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1 @@
+"--color" 

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in nested_respond_to.gemspec
+gemspec
+
+group :development, :test do
+	gem 'guard'
+  gem 'guard-rspec'
+end

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/README.md

@@ -0,0 +1,58 @@
+# safe_nested_calls #
+
+This gem allows you to safely call nested methods 
+on an object, and not worry about whether or not
+the methods are defined. It is very useful for 
+managing dynamically created objects.
+
+# Installation #
+
+   gem install 'safe_nested_calls'
+  
+If you are using Rails, then it will automatically load 
+on server start, but if not, somewhere in your code, put:
+
+    require 'safe_nested_calls'
+
+# Usage #
+
+safe_nested_calls adds two extra methods to Object,
+	
+  `nested_respond_to?` and `safe_nested_method`.
+
+### nested_respond_to? ###
+		
+	if object.nested_respond_to?(:one, :two, :three)
+      
+which is equivalent to
+
+	if object.respond_to? :one
+		if object.one.respond_to? :two
+			object.one.two.respond_to? :three
+
+  
+### safe_nested_method ###
+
+This method can call the actual nested method desired, with optional parameters
+
+    object.safe_nested_method(:one, :two, :three) => returns object.one.two.three
+      
+To use parameters, use a hash of :method => args, where args are the method arguments
+
+    object.safe_nested_method(:one => 1, :two => [1, 2], :three => [1,2,3])
+      
+which is equivalent to
+
+    object.one(1).two(1,2).three(1,2,3)
+      
+
+#### Parameters #####
+
+If you need to call of mix of methods with and without parameters, set the arguments for 
+the methods without parameters to :none
+
+    object.safe_nested_method(:get => :none, :increment => 4, :save => :none)
+      
+which is equivalent to
+
+    object.get().increment(4).save()

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/safe_nested_calls.rb

@@ -0,0 +1,56 @@
+require "safe_nested_calls/version"
+require "safe_nested_calls/railtie" if defined? Rails
+
+module NestedRespondTo
+	def nested_respond_to?(*methods)
+	  if nil? || methods.empty?
+	    true
+	  else
+	    method = methods.shift
+	    if self.respond_to?(method)
+	      self.send(method).nested_respond_to?(*methods)
+	    else
+	      false
+	    end
+	  end
+	end
+
+	def safe_nested_method(*params)
+		p = params
+		if params.respond_to?(:size) && params.size == 1 && params[0].is_a?(Hash)
+			p = params[0]
+		end
+
+		if p.empty?
+			return self
+		end
+
+		if p.is_a? Array
+			name = p.shift
+			if name.class != Symbol
+				raise ArgumentError, 'Parameters must be symbols'
+			end
+			if self.respond_to?(name)
+				self.send(name).safe_nested_method(*p)
+			else
+				return nil
+			end
+		elsif p.is_a? Hash
+			name, args = p.shift
+			if name.class != Symbol
+				raise ArgumentError, 'Parameters must be symbols'
+			end
+			if self.respond_to?(name)
+				if args == :none
+					self.send(name).safe_nested_method(*[p])
+				else
+					self.send(name, *args).safe_nested_method(*p)
+				end
+			else
+				return nil
+			end
+		end
+  end
+end
+
+Object.send(:include, NestedRespondTo)

data/lib/safe_nested_calls/railtie.rb

@@ -0,0 +1,7 @@
+module SafeNestedCalls
+  class Railtie < Rails::Railtie
+    initializer "SafeNestedCalls" do |app|
+    	require 'safe_nested_calls'
+  	end
+  end
+end

data/lib/safe_nested_calls/version.rb

@@ -0,0 +1,3 @@
+module SafeNestedCalls
+  VERSION = "0.0.1"
+end

data/safe_nested_calls.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "safe_nested_calls/version"
+
+Gem::Specification.new do |s|
+  s.name        = "safe_nested_calls"
+  s.version     = SafeNestedCalls::VERSION
+  s.authors     = ["Rick Button"]
+  s.email       = ["rickb@extemprep.com"]
+  s.homepage    = ""
+  s.summary     = %q{Safely call nested methods in Ruby}
+  s.description = %q{Allows you to safely call nested methods on an object, returning nil if they are undefined. }
+
+  s.rubyforge_project = "safe_nested_calls"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+
+  s.add_development_dependency "rspec"
+end

data/spec/safe_nested_calls/safe_nested_calls_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+class A
+	def do_magic(var)
+		'magic ' << var
+	end
+end
+class B
+	attr_accessor :a
+end
+class C
+	attr_accessor :b
+end
+class D
+	attr_accessor :c
+end		
+
+
+describe 'SafeNestedCalls' do
+	d = D.new
+	d.c = C.new
+	d.c.b = B.new
+	d.c.b.a = A.new
+
+	describe 'nested_respond_to?' do
+		it 'should return true when the methods all exist' do
+			d.nested_respond_to?(:c, :b, :a).should eq(true)
+		end
+
+		it 'should return false when a method does not exist' do
+			d.nested_respond_to?(:c, :b, :LOL_DOESNT_EXIST).should eq(false)
+		end
+	end
+
+	describe 'safe_nested_method' do
+		it 'should return the nested object when the methods all exist (with no params)' do
+			d.safe_nested_method(:c, :b, :a).should eq(d.c.b.a)
+		end
+
+		it 'should return nil when a method does not exist (with no params)' do
+			d.safe_nested_method(:c, :b, :LOL_DOESNT_EXIST).should eq(nil)
+		end
+
+		it 'should return the nested object when the methods all exist (with params)' do
+			d.safe_nested_method(:c=>:none, :b=>:none, :a => :none, :do_magic => ['tree house']).should eq('magic tree house')
+		end
+
+		it 'should return nil when a method does not exist (with params)' do
+			d.safe_nested_method(:c=>:none, :b=>:none, :LOL_DOESNT_EXIST => ['death house']).should eq(nil)
+		end
+
+		it 'should raise an ArguementError when an incorrect parameter is sent' do
+			expect { d.safe_nested_method Object.new }.should raise_error(ArgumentError)
+		end
+		it 'should raise an ArguementError when an incorrect parameter is sent (inside a hash)' do
+			expect { d.safe_nested_method Object.new => :NOPE }.should raise_error(ArgumentError)
+		end
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'safe_nested_calls'

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: safe_nested_calls
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Rick Button
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &19346436 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *19346436
+description: ! 'Allows you to safely call nested methods on an object, returning nil
+  if they are undefined. '
+email:
+- rickb@extemprep.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- lib/safe_nested_calls.rb
+- lib/safe_nested_calls/railtie.rb
+- lib/safe_nested_calls/version.rb
+- safe_nested_calls.gemspec
+- spec/safe_nested_calls/safe_nested_calls_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: safe_nested_calls
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Safely call nested methods in Ruby
+test_files: []