wwood-reach 0.1.1 → 0.2.0

data/README.rdoc

@@ -1,8 +1,10 @@
 Copyright (C) 2008      Ben J Woodcroft <donttrustben somewhere near gmail.com>
 
+This software is BETA! Use at your own risk.
+
 = Reach
 
-Reach is a small Ruby liby that extends Array so they are more transparent
+Reach is a small Ruby liby that extends the Array class so that Arrays are more transparent
 to methods. For instance, a ReachableArray of Book objects can not only take normal Array methods such as
 collect and sum, but also methods that operate Book objects, such as author and title. 
 
@@ -14,11 +16,11 @@ Say I want all the books.
 
   % Book.all
 
-Then I want all the bookshelves from those books. A common way to do this is to use the collect method of arrays:
+Then I want to find all the bookshelves from those that contain those books.
 
   % Book.all.collect{|book| book.bookshelf} => array of bookshelves.
 
-From personal experience, running a single method on each array element and collecting the results is quite common, especially in Rails. The idea, then, is to make the arrays not just responsive to the methods that apply to the Array itself, but to methods that apply to the members of that array. That is, make the array reachable (caution: made up word). In the case above we want to run the 'bookshelf' method on each of the book objects in the array.
+From personal experience, running a single method on each array element and collecting the results is quite common, especially in Rails. The idea, then, is to make the arrays not just responsive to the methods that apply to the Array itself, but to methods that apply to the +members+ of that array. That is, make the array reachable (caution: made up word). In the case above we want to run the 'bookshelf' method on each of the book objects in the array.
 
 To make an array reachable, convert it into a ReachableArray object, by calling the reach method of Array, which is added by the inclusion of the reach library. 
 
@@ -30,7 +32,7 @@ Now getting the corresponding array of bookshelves requires less typing:
   % require 'reach'
   % Book.all.reach.bookshelf => ReachableArray of Bookshelf objects
 
-Notice that a ReachableArray is returned, not an Array. This means you can chain reaches together:
+Notice that a ReachableArray is returned by the bookshelf method, not an Array. This means you can chain reaches together:
 
   % require 'reach'
   % Author.all.reach.book.bookshelf => ReachableArray of Bookshelf objects
@@ -40,6 +42,13 @@ Removing reachability from the array, or retracting, is equally as simple - just
   % require 'reach'
   % Book.all.reach.bookshelf.retract => Array of Bookshelf objects
 
+=== Slap
+
+Like reach. the slap method is another method added to the Array class to make it mroe transparent. The difference is that reach looks to see if the given method operates on the Array class, and if not then applies it to each member of that array. The slap method bypasses the first step, and just applies the given method to each member. For instance
+
+ % require 'reach'
+ % [[1,2,3],[4]].slap.length.retract => [1,3] 
+
 == Caution
 
 When operating on a ReachableArray, methods that operate on the Array itself take precedence over methods that apply to array members.

data/lib/reach.rb

@@ -19,6 +19,10 @@ class Array
   def reach
     ReachingArray.new(self)
   end
+  
+  def slap
+    SlappingArray.new(self)
+  end
 end
 
 class ReachingArray
@@ -58,4 +62,40 @@ class ReachingArray
   def to_s
     @retract.to_s
   end
+  
+  def slap
+    retract.slap
+  end
+end
+
+class SlappingArray
+  # The array that this reaching array is extending. This might
+  # be a real Array, or a ReachingArray
+  attr_accessor :retract
+  
+  def initialize(retract)
+    @retract = retract
+  end
+  
+  # Try to pass the method to each of the array members 
+  def method_missing(method, *args, &block)
+    @retract = @retract.collect do |o|
+      o.send(method, *args, &block)
+    end
+    return self
+  end
+  
+  # Equality test - equality of the underlying retract
+  # arrays is all that matter
+  def ==(another)
+    @retract <=> another.retract
+  end
+  
+  def to_s
+    @retract.to_s
+  end
+  
+  def reach
+    retract.reach
+  end
 end

data/reach.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name     = "reach"
-  s.version  = "0.1.1"
-  s.date     = "2008-09-05"
+  s.version  = "0.2.0"
+  s.date     = "2008-10-23"
   s.summary  = "Extend the Ruby Array class for less loops and blocks"
   s.email    = "donttrustben somewhere near gmail.com"
   s.homepage = "http://github.com/wwood/reach"

data/test/test_reach.rb

@@ -60,3 +60,28 @@ class ReachTest < Test::Unit::TestCase
     assert_equal [1,2].to_s, [1,2].reach.to_s
   end
 end
+
+class SlapTest < Test::Unit::TestCase
+  def setup
+    @one_level = %w(a b c)
+    @two_level = [[1,2,3],[5]]
+  end
+  
+  def test_simple
+    assert_kind_of SlappingArray, @two_level.slap
+    
+    assert_equal [3,1], @two_level.slap.length.retract
+  end
+  
+  def test_mutate
+    assert_kind_of ReachingArray, @two_level.slap.reach
+    assert_equal [[1,2,3],[5]], @two_level.slap.reach.retract
+  end
+  
+  def test_array_method_fail
+    assert_raise NoMethodError do 
+      @one_level.slap.join(' ')
+    end
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: wwood-reach
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - Ben J Woodcroft
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-05 00:00:00 -07:00
+date: 2008-10-23 00:00:00 -07:00
 default_executable: 
 dependencies: []