message-recorder 1.0.0 → 1.0.1

data/History.txt

@@ -1,3 +1,10 @@
+== 1.0.1 2008-02-13
+
+* 1 major enhancement:
+  * before and after filters are simplified.
+* Added Array extension
+* Added Object extension
+
 == 1.0.0 2008-02-13
 
 * 1 major enhancement:

data/Manifest.txt

@@ -5,6 +5,8 @@ README.txt
 Rakefile
 config/hoe.rb
 config/requirements.rb
+lib/extentions/array.rb
+lib/extentions/object.rb
 lib/message-recorder.rb
 lib/message-recorder/branching_mock.rb
 lib/message-recorder/chain.rb

data/config/hoe.rb

@@ -65,6 +65,7 @@ hoe = Hoe.new(GEM_NAME, VERS) do |p|
 end
 
 CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
-PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+# PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+PATH    = RUBYFORGE_PROJECT
 hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
 hoe.rsync_args = '-av --delete --ignore-errors'

data/lib/extentions/array.rb

@@ -0,0 +1,28 @@
+# Copyright (c) 2008 Simon Menke
+# 
+# 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.
+
+class Array
+  
+  # send each entry to a recorder. (using Message::Recorder#send_to)
+  def each_play(recorder)
+    each { |object| object.play(recorder) }
+  end
+end

data/lib/extentions/object.rb

@@ -0,0 +1,28 @@
+# Copyright (c) 2008 Simon Menke
+# 
+# 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.
+
+class Object
+  
+  # send the receiver to a recorder. (using Message::Recorder#send_to)
+  def play(recorder)
+    recorder.send_to(self)
+  end
+end

data/lib/message-recorder.rb

@@ -29,3 +29,6 @@ require File.join(File.dirname(__FILE__), "message-recorder", "chain")
 require File.join(File.dirname(__FILE__), "message-recorder", "collector")
 require File.join(File.dirname(__FILE__), "message-recorder", "branching_mock")
 require File.join(File.dirname(__FILE__), "message-recorder", "chaining_mock")
+
+require File.join(File.dirname(__FILE__), "extentions", "object")
+require File.join(File.dirname(__FILE__), "extentions", "array")

data/lib/message-recorder/chain.rb

@@ -32,9 +32,10 @@ class Message::Recorder::Chain < ::Array # :nodoc:
   
   def send_to(subject_, recorder)
     inject(subject_) do |subject,message|
-      return nil if recorder.break_if.call(subject)
-      
-      message.send_to(subject, recorder)
+      return nil unless recorder.filter_before(subject, message.method_name, message.arguments)
+      new_subject = message.send_to(subject, recorder)
+      recorder.filter_after(subject, message.method_name, message.arguments, new_subject)
+      new_subject
     end
   end
   

data/lib/message-recorder/message.rb

@@ -30,12 +30,7 @@ class Message::Recorder::Message # :nodoc:
   end
 
   def send_to(subject, recorder)
-    recorder.before_call.call(subject, self.method_name, self.arguments)
-    
-    result = subject.__send__(self.method_name, *self.arguments, &self.block)
-    
-    recorder.after_call.call(subject, self.method_name, self.arguments, result)
-    result
+    subject.__send__(self.method_name, *self.arguments, &self.block)
   end
 
   def arguments

data/lib/message-recorder/recorder.rb

@@ -19,52 +19,72 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-# 
+# Example:
+#   recorder = Message::Recorder.new
+#   recorder.record.downcase.intern
+#   recorder.before do |subject, method, arguments|
+#     !(subject.nil? or subject.empty?)
+#   end
+#   recorder.after do |subject, method, arguments, return_value|
+#     p return_value
+#   end
+#   recorder.send_to(nil)        # => nil
+#   recorder.send_to("")         # => nil
+#   recorder.send_to("Mr_Henry") # => :mr_henry
 class Message::Recorder
   
-  # a Proc with one argument
-  #   recorder.break_if = Proc.new { |subject| subject.nil? }
-  # if the Proc returns false the chain will be broken.
-  attr_writer :break_if
-  
-  # a Proc with three arguments
-  #   recorder.before_call = Proc.new { |subject, method, arguments| ... }
-  attr_writer :before_call
-  
-  # a Proc with four arguments
-  #   recorder.after_call = Proc.new { |subject, method, arguments, return_value| ... }
-  attr_writer :after_call
+  # Takes a block with three arguments
+  #   recorder.before { |subject, method, arguments| ... }
+  # if the block returns false the chain will be broken.
+  def before(&block)
+    before_filters << block
+  end
   
-  def initialize # :nodoc:
-    @collector  = nil
-    before_call = nil
-    after_call  = nil
-    break_if    = nil
+  # Takes a block with four arguments
+  #   recorder.after { |subject, method, arguments, return_value| ... }
+  def after(&block)
+    after_filters << block
   end
   
   # #record returns a mock object which will store all the messages you send to it.
   def record
-    @collector = ::Message::Recorder::Collector.new
-    @collector.collect_messages
+    collector = nil
+    collector.collect_messages
   end
   
   # #send_to will send the recorded messages to the #subject.
   def send_to(subject)
-    @collector.send_to(subject, self)
+    collector.send_to(subject, self)
   end
   
   
+  attr_accessor :before_filters # :nodoc:
+  attr_accessor :after_filters  # :nodoc:
+  
+  def before_filters # :nodoc:
+    @before_filters ||= []
+  end
+  
+  def after_filters # :nodoc:
+    @before_filters ||= []
+  end
   
-  def break_if # :nodoc:
-    @break_if ||= Proc.new { |f| false }
+  def filter_before(subject, method, arguments) # :nodoc:
+    before_filters.each do |filter|
+      should_break = filter.call(subject, method, arguments)
+      return false if should_break === false
+    end
+    return true
   end
   
-  def before_call # :nodoc:
-    @before_call ||= Proc.new { |f, m, args| nil }
+  def filter_after(subject, method, arguments, return_value) # :nodoc:
+    after_filters.each do |filter|
+      filter.call(subject, method, arguments, return_value)
+    end
   end
   
-  def after_call # :nodoc:
-    @after_call ||= Proc.new { |f, m, args, result| nil }
+  def collector # :nodoc:
+    @collector ||= ::Message::Recorder::Collector.new
   end
   
 end

data/lib/message-recorder/version.rb

@@ -23,7 +23,7 @@ module Message #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 1
     MINOR = 0
-    TINY  = 0
+    TINY  = 1
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/website/index.html

@@ -33,7 +33,7 @@
     <h1>message recorder</h1>
     <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/message-recorder"; return false'>
       <p>Get Version</p>
-      <a href="http://rubyforge.org/projects/message-recorder" class="numbers">1.0.0</a>
+      <a href="http://rubyforge.org/projects/message-recorder" class="numbers">1.0.1</a>
     </div>
     <h2>&#x2192; &#8216;message-recorder&#8217;</h2>
 
@@ -53,6 +53,9 @@
 	<h2>The basics</h2>
 
 
+	<p>The rdocs are <a href="http://message-recorde.rubyforge.org/rdoc/">here</a></p>
+
+
 	<p>This snippet will first record a <tt>downcase</tt> message and after that it will replay the recorded messages on some objects.</p>
 
 
@@ -119,7 +122,7 @@
 
 	<p>Comments are welcome. Send an email to <a href="mailto:simon@5xm.org">Simon Menke</a></p>
     <p class="coda">
-      <a href="simon@5xm.org">Simon Menke</a>, 14th February 2008<br>
+      <a href="simon@5xm.org">Simon Menke</a>, 15th February 2008<br>
       Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
     </p>
 </div>

data/website/index.txt

@@ -13,6 +13,8 @@ h2. Installing
 
 h2. The basics
 
+The rdocs are "here":http://message-recorde.rubyforge.org/rdoc/
+
 This snippet will first record a <tt>downcase</tt> message and after that it will replay the recorded messages on some objects.
 
 <pre syntax="ruby">

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: message-recorder
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors: 
 - Simon Menke
@@ -34,6 +34,8 @@ files:
 - Rakefile
 - config/hoe.rb
 - config/requirements.rb
+- lib/extentions/array.rb
+- lib/extentions/object.rb
 - lib/message-recorder.rb
 - lib/message-recorder/branching_mock.rb
 - lib/message-recorder/chain.rb