methodchain 0.1.0 → 0.2.0

data/README

@@ -1,12 +1,12 @@
 == Summary
-methodchain - ruby helpers for method chaining: tap, then, else
+methodchain - ruby helpers for method chaining: chain, tap, then, else
 Easy ways to navigate around nil without creating local variables.
 
 == Author and License
 Copyright (c) 2008 Greg Weber, http://gregweber.info
 Licensed under the MIT license
 
-== Example
+== Examples
 ==== tap
 if you don't already know about this method, look it up on the net.  The tap included here allows message sending.
 
@@ -17,38 +17,56 @@ NEW WAY
 
 ==== #then and #else
 OLD WAY
+
   name = person ? person.name : nil
 
 NEW WaY
+
   name = person.then {|p| p.name}
 
 not a huge savings. But sometimes the person variable is actually a function call, and then we must save it in a variable first.
 
 OLD WAY
+
   location = Location.find(:first, ...)
   @phone = location && location.phone
 
 NEW WaY
+
   @phone = Location.find(:first, ...).then {phone}
-  here we have reduced a line of code and removed a local variable
+  
+here we have reduced a line of code and removed a local variable
+#then and #else can return a default value instead of evaluating a block
+'a'.then('b') #=> 'b'
+nil.then('b').else('c') #=> 'c'
 
+=== #chain
 OLD WAY
-  if(customer && customer.order && customer.order.id == new_customer_id)
-    'success'
-  else
-    'fail'
-  end
+
+  customer && customer.order && customer.order.id
 
 NEW WaY
-  customer.then {order}.then {id == new_customer_id}.then('success').else('fail')
 
-Here we have removed one call to order and reduced the code to a one-liner.  There is also an equivalent block form
-  customer.then {order}.then {id == new_customer_id}.then do |o|
-    'success'
-  end.else do
-    'fail'
+  customer.chain(:order, :id)
+ 
+note that this is equivalent to
+
+  customer.then {order}.then {id}
+
+=== chain - Custom guards and multiple argumentes
+OLD WAY - guarding against zero
+
+  result = if value == 0 then value else
+    tmp = calc(value)
+
+    if tmp == 0 then tmp else
+      more_calc(tmp, 20)
+    end
   end
 
+NEW WAY
+  value.chain(:calc, [:more_calc, 20]) {|s| s == 0 }
+
 == Usage
   require 'rubygems'
 
@@ -64,8 +82,8 @@ not_included will load the MethodChain module without including it anywhere.
 Already have your own version of tap? use the module-import gem to decide what to include
 
 == Implementation
-* There are no proxy objects, these are simply function calls, so it should be fast.
-* A helper method called self_eval is also exposed.  This method allows the two different block forms {|p| p.name} and {name}, where the second form is called using instance_eval.
+* There are no proxy objects and no use of method_missing- these are simply function calls, so it should be fast.
+* A helper method called self_eval is also exposed.  This method allows the two different block forms {|p| p.name} and {name}, where the first form yields self and the second form is called using instance_eval.
 
 == Install
 gem install methodchain

data/doc/created.rid

@@ -1 +1 @@
-Sun, 09 Mar 2008 12:16:13 -0500
+Sun, 09 Mar 2008 15:08:53 -0500

data/doc/fr_method_index.html

@@ -20,10 +20,11 @@
 <div id="index">
   <h1 class="section-bar">Methods</h1>
   <div id="index-entries">
-    <a href="classes/MethodChain.html#M000003">else (MethodChain)</a><br />
-    <a href="classes/MethodChain.html#M000001">self_eval (MethodChain)</a><br />
-    <a href="classes/MethodChain.html#M000004">tap (MethodChain)</a><br />
-    <a href="classes/MethodChain.html#M000002">then (MethodChain)</a><br />
+    <a href="classes/MethodChain.html#M000001">chain (MethodChain)</a><br />
+    <a href="classes/MethodChain.html#M000004">else (MethodChain)</a><br />
+    <a href="classes/MethodChain.html#M000002">self_eval (MethodChain)</a><br />
+    <a href="classes/MethodChain.html#M000005">tap (MethodChain)</a><br />
+    <a href="classes/MethodChain.html#M000003">then (MethodChain)</a><br />
   </div>
 </div>
 </body>

data/rakefile

@@ -42,7 +42,7 @@ require 'rake/gempackagetask'
 spec = Gem::Specification.new do |s|
   s.name = project
   s.rubyforge_project = project
-  s.version = "0.1.0"
+  s.version = "0.2.0"
   s.author = "Greg Weber"
   s.email = "greg@gregweber.info"
   s.homepage = "http://projects.gregweber.info/#{project}"

data/spec/methodchain_spec.rb

@@ -1,36 +1,44 @@
 require File.dirname(__FILE__) + '/../lib/methodchain'
 
-def test_then_else *vals
-  bool = !!vals.first
-  same,opp = bool ? [:then,:else] : [:else,:then]
-
-  it "should return self if self evaluates to #{!bool}" do
-    vals.each do |val|
-      val.send(opp).should == val
-      val.send(opp,'aye').should == val
-      val.send(opp,'aye') {|a,b,c| a}.should == val
-      val.send(opp) {|a,b,c| a}.should == val
+describe "#chain" do
+  it "should return self when no arguments are given" do
+    [nil,'a'].each do |var|
+      var.chain.should == var
+      var.chain {fail}.should == var
     end
   end
+  it "should send symbols" do
+    [[]].chain(:flatten).should == []
+  end
+  it "should send procs" do
+    [[]].chain(:flatten, lambda{|arr| arr.push('a')}).should == ['a']
+    [[]].chain(:flatten, lambda{ push('a') }).should == ['a']
+  end
+  it "should send an array as a message with arguments" do
+    [['a']].chain(:flatten, lambda{|arr| arr.push('b')}, [:join, ' ']).should == 'a b'
+  end
 
-  it "if self evaluates to #{bool} ##{same} should yield self to a block if one is given, and return that block's value" do
-    vals.each do |val|
-      val.send(same)   {|v| v.should == val; 'foo'}.should == 'foo'
-      val.send(same,1) {|v| v.should == val; 'foo'}.should == 'foo'
-    end
+  it "should guard the chain against nil and false" do
+    nil.chain(:foo,:bar,:baz).should == nil
+    false.chain(:foo,:bar,:baz).should == false
+    [].chain(:flatten!,:not_defined).should == nil
+    [].chain(:flatten!, lambda{|arr| arr.push('a')}).should == nil
+    lambda{"foo".chain(:to_s,:not_defined)}.should raise_error(NoMethodError)
   end
+  it "should allow custom guards with blocks" do
+    nil.chain {nil?}.should == nil
+    'a'.chain {nil?}.should == 'a'
+    nil.chain(:to_s) {nil?}.should == ''
+    'a'.chain(lambda{fail}) {nil?}.should == 'a'
 
-  it "should validate arguments if self evaluates to #{bool}" do
-    vals.each {|val| lambda{val.send(same)}.should raise_error(ArgumentError)}
-    vals.each {|val| lambda{val.send(same){|a,b|}}.should raise_error(ArgumentError)}
-    vals.each {|val| lambda{val.send(same){|a,*b|}}.should raise_error(ArgumentError)}
+    nil.chain {is_a?(String)}.should == nil
+    'a'.chain {is_a?(String)}.should == 'a'
+    nil.chain(lambda{fail}) {is_a?(String)}.should == nil
+    'a'.chain(:upcase) {is_a?(String)}.should == 'A'
   end
 end
 
-describe Object do
-  test_then_else('a',true)
-  test_then_else(nil,false)
-
+describe "#tap" do
   it "#tap should yield self to a block and return self if block has one argument" do
     [true,false,'a'].each do |o|
       o.tap {|s| s.should == o }.should == o
@@ -58,3 +66,35 @@ describe Object do
     [1, 2, 3, 4, 5].tap.should == [1, 2, 3, 4, 5]
   end
 end
+
+def test_then_else *vals
+  bool = !!vals.first
+  same,opp = bool ? [:then,:else] : [:else,:then]
+
+  it "should return self if self evaluates to #{!bool}" do
+    vals.each do |val|
+      val.send(opp).should == val
+      val.send(opp,'aye').should == val
+      val.send(opp,'aye') {|a,b,c| a}.should == val
+      val.send(opp) {|a,b,c| a}.should == val
+    end
+  end
+
+  it "if self evaluates to #{bool} ##{same} should yield self to a block if one is given, and return that block's value" do
+    vals.each do |val|
+      val.send(same)   {|v| v.should == val; 'foo'}.should == 'foo'
+      val.send(same,1) {|v| v.should == val; 'foo'}.should == 'foo'
+    end
+  end
+
+  it "should validate arguments if self evaluates to #{bool}" do
+    vals.each {|val| lambda{val.send(same)}.should raise_error(ArgumentError)}
+    vals.each {|val| lambda{val.send(same){|a,b|}}.should raise_error(ArgumentError)}
+    vals.each {|val| lambda{val.send(same){|a,*b|}}.should raise_error(ArgumentError)}
+  end
+end
+
+describe "#then,#else" do
+  test_then_else('a',true)
+  test_then_else(nil,false)
+end

metadata

@@ -3,7 +3,7 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: methodchain
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 date: 2008-03-09 00:00:00 -06:00
 summary: convenience methods for method chaining
 require_paths: 
@@ -48,8 +48,7 @@ files:
 - pkg/methodchain-0.0.1.gem
 - pkg/methodchain-0.0.3.gem
 - pkg/methodchain-0.0.5.gem
-- spec/not_included.rb
-- spec/then_else.rb
+- pkg/methodchain-0.1.0.gem
 - spec/methodchain_spec.rb
 - README
 test_files: []

data/spec/not_included.rb

@@ -1,11 +0,0 @@
-# test optional imports
-
-describe "requiring not_included" do
-  it "should not import methods into Object" do
-    require File.dirname(__FILE__) + '/../lib/methodchain/not_included'
-    Object.new.should_not respond_to(:tap)
-    Object.new.should_not respond_to(:then)
-    Object.new.should_not respond_to(:else)
-    MethodChain.should be_kind_of(Module)
-  end
-end

data/spec/then_else.rb

@@ -1,11 +0,0 @@
-# test optional imports
-
-describe "requiring not_tap" do
-  it "should not import tap into Object" do
-    require File.dirname(__FILE__) + '/../lib/methodchain/then_else'
-    MethodChain.should be_kind_of(Module)
-    Object.new.should_not respond_to(:tap)
-    Object.new.should respond_to(:then)
-    Object.new.should respond_to(:else)
-  end
-end