filtration 0.0.4 → 0.0.5

data/README.rdoc

@@ -3,6 +3,7 @@ Filtration is a clean, lightweight way to filter arguments going into and coming
 
 == Usage
 Example:
+
   class Bar
   
     def foo(x)
@@ -26,20 +27,20 @@ Example:
   class Foo < Bar
     
     prefilter(:foo){|x| x * 2}
-    #=> (x * 2) + 2 = 6 (for x = 2)
     
     postfilter(:foo_too){|x| x * 2}
-    #=> (x + 2) * 2 = 8 (for x = 2)
-  
+
   end
-  
+
+  randy = Foo.new
+  randy.foo(2) #=> (x * 2) + 2 = 6 (for x = 2)
+  randy.foo_too(2) #=> (x + 2) * 2 = 8 (for x = 2)
+
   class AnotherFoo < Bar
     
     prefilter :foo, :double
-    #=> (x * 2) + 2 = 6 (for x = 2)
     
     postfilter :foo_too, :double
-    #=> (x + 2) * 2 => 8 (for x = 2)
     
     def double(x)
       x * 2
@@ -47,18 +48,24 @@ Example:
   
   end
   
+  savage = AnotherFoo.new
+  savage.foo(2)  #=> (x * 2) + 2 = 6
+  savage.foo_too(2) #=> (x + 2) * 2 => 8
+  
   class YetAnotherFoo < Bar
     
     prefilter :foo_as_well, &:upcase
-    #=> "#{x.upcase} to the max!" = 'FILTRATION to the max!' (for x = 'filtration')
     
     postfilter :foo_forever, &:upcase
-    #=> "#{x} to the max!".upcase = 'FILTRATION TO THE MAX!' (for x = 'filtration')
     
   end
 
+  machoman = YetAnotherFoo.new
+  machoman.foo_as_well('filtration') #=> "#{x.upcase} to the max!" = 'FILTRATION to the max!'
+  machoman.foo_forever('filtration') #=> "#{x} to the max!".upcase = 'FILTRATION TO THE MAX!'
+
 == Requirements
 Filtration stands on its own!
 
 == Development
-RSpec is used for testing, with SimpleCov for code coverage.
+RSpec is used for testing, with SimpleCov for code coverage.

data/lib/filtration.rb

@@ -1,13 +1,13 @@
 module Filtration
 
-  def prefilter(method, filter=nil, &block)
-    old_method = instance_method(method)
-    raise "Method #{method} takes 0 arguments" if old_method.arity == 0
-
-    raise "Cannot use both filter method and block" if !filter.nil? && !block.nil?
-    raise "Block or filter method missing" if filter.nil? && block.nil?
-
-    define_method(method) do |*args|
+  # for method with arity > 0, 'target', intercept arguments and apply
+  # method 'filter' or passed 'block' to them before running 'target' with them
+  def prefilter(target, filter=nil, &block)
+    old_method = instance_method(target)
+    raise "Method #{target} takes 0 arguments" if old_method.arity == 0
+    raise "Must use either passed filter method or passed block" unless filter.nil? ^ block.nil?
+
+    define_method(target) do |*args|
       if filter.nil?
         old_method.bind(self).call(block.call(*args))
       else
@@ -18,14 +18,13 @@ module Filtration
     end
   end
 
-  def postfilter(method, filter=nil, &block)
-    old_method = instance_method(method)
-    raise "Method #{method} takes 0 arguments" if old_method.arity == 0
+  # for method, 'target', intercept output and apply method 'filter' or
+  # passed 'block' to it before returning the value
+  def postfilter(target, filter=nil, &block)
+    old_method = instance_method(target)
+    raise "Must use either passed filter method or passed block" unless filter.nil? ^ block.nil?
 
-    raise "Cannot use both filter method and block" if !filter.nil? && !block.nil?
-    raise "Block or filter method missing" if filter.nil? && block.nil?
-
-    define_method(method) do |*args|
+    define_method(target) do |*args|
       if filter.nil?
         block.call(old_method.bind(self).call(*args))
       else
@@ -40,4 +39,4 @@ end
 
 class Object
   extend Filtration
-end
+end

metadata

@@ -1,8 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: filtration
 version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.0.4
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - R. Scott Reis
@@ -10,7 +14,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-15 00:00:00 Z
+date: 2011-08-13 00:00:00 -05:00
+default_executable: 
 dependencies: []
 
 description: 
@@ -28,6 +33,7 @@ files:
 - spec/spec_helper.rb
 - spec/spec_dummies.rb
 - spec/filtration_spec.rb
+has_rdoc: true
 homepage: 
 licenses: []
 
@@ -44,17 +50,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.7.2
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Filtration enables pre/post method callback, similar to Python decorators