message-recorder 1.0.0

data/spec/chain_spec.rb

@@ -0,0 +1,26 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Message::Recorder::Chain do
+  
+  before do
+    @recorder = Message::Recorder.new
+  end
+  
+  it "should record" do
+    chain = Message::Recorder::Chain.new
+    chain.record(:downcase)
+    chain.record(:+, " world")
+    
+    chain.size.should be_eql(2)
+    chain.send_to("HELLO",@recorder).should be_eql("hello world")
+  end
+  
+  it "should dup properly" do
+    chain = Message::Recorder::Chain.new
+    chain.record(:downcase)
+    chain.record(:+, " world")
+    
+    chain.dup.should be_eql(chain)
+  end
+  
+end

data/spec/collector_spec.rb

@@ -0,0 +1,77 @@
+
+require "pp"
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Message::Recorder::Collector do
+  
+  before do
+    @recorder = Message::Recorder.new
+  end
+  
+  it "should record" do
+    chain = Message::Recorder::Collector.new
+    chain.record(:downcase)
+    chain.record(:+, " world")
+    
+    chain.size.should be_eql(1)
+    chain.first.size.should be_eql(2)
+    chain.send_to("HELLO", @recorder).should be_eql(["hello world"])
+  end
+  
+  it "should branch" do
+    chain = Message::Recorder::Collector.new
+    chain.record(:downcase)
+    chain.record(:+, " world")
+    
+    chain.size.should be_eql(1)
+    chain.first.size.should be_eql(2)
+    chain.send_to("HELLO", @recorder).should be_eql(["hello world"])
+    
+    branch = chain.branch
+    branch.record(:+, "!")
+    branch.size.should be_eql(1)
+    branch.first.size.should be_eql(3)
+    branch.send_to("HELLO", @recorder).should be_eql(["hello world!"])
+    
+    branch.should_not be_equal(chain)
+  end
+  
+  it "should collect a single chain" do
+    collector = Message::Recorder::Collector.new
+    collector.collect_messages.downcase + " world"
+    
+    collector.size.should be_eql(1)
+    collector.send_to("HELLO", @recorder).should be_eql(["hello world"])
+  end
+  
+  it "should collect a branched chain" do
+    collector = Message::Recorder::Collector.new
+    collector.collect_messages.downcase.with_results do
+      intern
+      capitalize
+    end
+    
+    collector.size.should be_eql(2)
+    collector.first.size.should be_eql(2)
+    collector.last.size.should be_eql(2)
+    collector.send_to("HELLO",@recorder).should ==([:hello, "Hello"])
+  end
+  
+  it "should collect a branched chain" do
+    collector = Message::Recorder::Collector.new
+    collector.collect_messages.compact.with_results do
+      collect { |s| s.intern }
+      collect { |s| s.capitalize }.with_results do
+        collect { |s| s.concat " world" }
+        collect { |s| s.concat " simon" }
+      end.with_results do
+        collect { |s| s.concat "!" }
+        collect { |s| s.concat "?" }
+      end
+    end
+    
+    expected = [[:hello, :bye], ["Hello world!", "Bye world!"], ["Hello simon!", "Bye simon!"], ["Hello world?", "Bye world?"], ["Hello simon?", "Bye simon?"]]
+    collector.send_to([nil, "hello", nil, "bye", nil], @recorder).should == expected
+  end
+  
+end

data/spec/fob_spec.rb

@@ -0,0 +1,13 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Message::Recorder do
+  
+  it "should dup properly" do
+    chain = Message::Recorder::Chain.new
+    chain.record(:downcase)
+    chain.record(:+, " world")
+    
+    chain.dup.should be_eql(chain)
+  end
+  
+end

data/spec/message_spec.rb

@@ -0,0 +1,89 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Message::Recorder::Message do
+  
+  before do
+    @recorder = Message::Recorder.new
+  end
+  
+  it "should init properly (with all arguments)" do
+    message = Message::Recorder::Message.new(:inject, 0) { |sum, n| sum += n }
+    message.method_name.should be_eql(:inject)
+    message.arguments.should be_eql([0])
+    message.block.should_not be_nil
+  end
+  
+  it "should init properly (with all arguments, except block)" do
+    message = Message::Recorder::Message.new(:inject, 0)
+    message.method_name.should be_eql(:inject)
+    message.arguments.should be_eql([0])
+    message.block.should_not be_nil
+  end
+  
+  it "should init properly (with all arguments, except m_arguments)" do
+    message = Message::Recorder::Message.new(:inject) { |sum, n| sum += n }
+    message.method_name.should be_eql(:inject)
+    message.arguments.should be_eql([])
+    message.block.should_not be_nil
+  end
+  
+  it "should init properly (with all arguments, except block m_arguments)" do
+    message = Message::Recorder::Message.new(:inject)
+    message.method_name.should be_eql(:inject)
+    message.arguments.should be_eql([])
+    message.block.should_not be_nil
+  end
+  
+  it "should send itself properly to a subject (without arguments and block)" do
+    message = Message::Recorder::Message.new(:downcase)
+    message.send_to("HELLO", @recorder).should be_eql("hello")
+  end
+  
+  it "should send itself properly to a subject (without block)" do
+    message = Message::Recorder::Message.new(:+, " world")
+    message.send_to("hello", @recorder).should be_eql("hello world")
+  end
+  
+  it "should send itself properly to a subject (without arguments)" do
+    message = Message::Recorder::Message.new(:inject) { |sum, n| sum + n }
+    message.send_to([1,2,3], @recorder).should be_eql(6)
+  end
+  
+  it "should send itself properly to a subject" do
+    message = Message::Recorder::Message.new(:inject, 6) { |sum, n| sum + n }
+    message.send_to([1,2,3], @recorder).should be_eql(12)
+  end
+  
+  it "should dup properly (with all arguments)" do
+    message = Message::Recorder::Message.new(:inject, 0) { |sum, n| sum += n }
+    message = message.dup
+    message.method_name.should be_eql(:inject)
+    message.arguments.should be_eql([0])
+    message.block.should_not be_nil
+  end
+  
+  it "should dup properly (with all arguments, except block)" do
+    message = Message::Recorder::Message.new(:inject, 0)
+    message = message.dup
+    message.method_name.should be_eql(:inject)
+    message.arguments.should be_eql([0])
+    message.block.should_not be_nil
+  end
+  
+  it "should dup properly (with all arguments, except m_arguments)" do
+    message = Message::Recorder::Message.new(:inject) { |sum, n| sum += n }
+    message = message.dup
+    message.method_name.should be_eql(:inject)
+    message.arguments.should be_eql([])
+    message.block.should_not be_nil
+  end
+  
+  it "should dup properly (with all arguments, except block m_arguments)" do
+    message = Message::Recorder::Message.new(:inject)
+    message = message.dup
+    message.method_name.should be_eql(:inject)
+    message.arguments.should be_eql([])
+    message.block.should_not be_nil
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--colour
+-f specdoc

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+require File.join(File.dirname(__FILE__), "..", "lib", "message-recorder")

data/tasks/deployment.rake

@@ -0,0 +1,34 @@
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+
+desc 'Install the package as a gem, without generating documentation(ri/rdoc)'
+task :install_gem_no_doc => [:clean, :package] do
+  sh "#{'sudo ' unless Hoe::WINDOZE }gem install pkg/*.gem --no-rdoc --no-ri"
+end
+
+namespace :manifest do
+  desc 'Recreate Manifest.txt to include ALL files'
+  task :refresh do
+    `rake check_manifest | patch -p0 > Manifest.txt`
+  end
+end

data/tasks/environment.rake

@@ -0,0 +1,7 @@
+task :ruby_env do
+  RUBY_APP = if RUBY_PLATFORM =~ /java/
+    "jruby"
+  else
+    "ruby"
+  end unless defined? RUBY_APP
+end

data/tasks/rspec.rake

@@ -0,0 +1,25 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+module Spec 
+   class << self; def run; false; end; end 
+end 
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/*_spec.rb']
+end

data/tasks/website.rake

@@ -0,0 +1,17 @@
+desc 'Generate website files'
+task :website_generate => :ruby_env do
+  (Dir['website/**/*.txt'] - Dir['website/version*.txt']).each do |txt|
+    sh %{ #{RUBY_APP} script/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
+  end
+end
+
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  host = "#{rubyforge_username}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{PATH}/"
+  local_dir = 'website'
+  sh %{rsync -aCv #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+desc 'Generate and upload website files'
+task :website => [:website_generate, :website_upload, :publish_docs]

data/website/index.html

@@ -0,0 +1,130 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <link rel="stylesheet" href="stylesheets/screen.css" type="text/css" media="screen" />
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>
+      message recorder
+  </title>
+  <script src="javascripts/rounded_corners_lite.inc.js" type="text/javascript"></script>
+<style>
+
+</style>
+  <script type="text/javascript">
+    window.onload = function() {
+      settings = {
+          tl: { radius: 10 },
+          tr: { radius: 10 },
+          bl: { radius: 10 },
+          br: { radius: 10 },
+          antiAlias: true,
+          autoPad: true,
+          validTags: ["div"]
+      }
+      var versionBox = new curvyCorners(settings, document.getElementById("version"));
+      versionBox.applyCornersToAll();
+    }
+  </script>
+</head>
+<body>
+<div id="main">
+
+    <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>
+    </div>
+    <h2>&#x2192; &#8216;message-recorder&#8217;</h2>
+
+
+	<h2>What</h2>
+
+
+	<p><tt>Message::Recorder</tt> is a tool to record messages send to Ruby objects.</p>
+
+
+	<h2>Installing</h2>
+
+
+	<p><pre class='syntax'><span class="ident">sudo</span> <span class="ident">gem</span> <span class="ident">install</span> <span class="ident">message</span><span class="punct">-</span><span class="ident">recorder</span></pre></p>
+
+
+	<h2>The basics</h2>
+
+
+	<p>This snippet will first record a <tt>downcase</tt> message and after that it will replay the recorded messages on some objects.</p>
+
+
+	<p><pre class='syntax'>
+<span class="ident">recorder</span> <span class="punct">=</span> <span class="constant">Message</span><span class="punct">::</span><span class="constant">Recorder</span><span class="punct">.</span><span class="ident">new</span>
+<span class="ident">recorder</span><span class="punct">.</span><span class="ident">record</span><span class="punct">.</span><span class="ident">downcase</span>
+<span class="ident">recorder</span><span class="punct">.</span><span class="ident">send_to</span><span class="punct">(&quot;</span><span class="string">HELLO</span><span class="punct">&quot;)</span> <span class="comment"># =&gt; [&quot;hello&quot;]</span>
+<span class="ident">recorder</span><span class="punct">.</span><span class="ident">send_to</span><span class="punct">(&quot;</span><span class="string">WORLD</span><span class="punct">&quot;)</span> <span class="comment"># =&gt; [&quot;world&quot;]</span>
+</pre></p>
+
+
+	<p>This is an example of branching. the <tt>with_results</tt> method accepts a block which is used to define multiple message chains at once.</p>
+
+
+	<p><pre class='syntax'>
+<span class="ident">recorder</span> <span class="punct">=</span> <span class="constant">Message</span><span class="punct">::</span><span class="constant">Recorder</span><span class="punct">.</span><span class="ident">new</span>
+<span class="ident">recorder</span><span class="punct">.</span><span class="ident">record</span><span class="punct">.</span><span class="ident">downcase</span><span class="punct">.</span><span class="ident">with_results</span> <span class="keyword">do</span>
+  <span class="ident">intern</span>
+  <span class="ident">capitalize</span>
+<span class="keyword">end</span>
+
+<span class="ident">recorder</span><span class="punct">.</span><span class="ident">send_to</span><span class="punct">(&quot;</span><span class="string">HELLO</span><span class="punct">&quot;)</span> <span class="comment"># =&gt; [:hello, &quot;Hello&quot;]</span>
+</pre></p>
+
+
+	<h2>Demonstration of usage</h2>
+
+
+	<p>This is a more complex example with nested branches.</p>
+
+
+	<p><pre class='syntax'>
+<span class="ident">recorder</span> <span class="punct">=</span> <span class="constant">Message</span><span class="punct">::</span><span class="constant">Recorder</span><span class="punct">.</span><span class="ident">new</span>
+<span class="ident">recorder</span><span class="punct">.</span><span class="ident">record</span><span class="punct">.</span><span class="ident">compact</span><span class="punct">.</span><span class="ident">with_result</span> <span class="keyword">do</span>
+  <span class="ident">collect</span> <span class="punct">{</span> <span class="punct">|</span><span class="ident">s</span><span class="punct">|</span> <span class="ident">s</span><span class="punct">.</span><span class="ident">intern</span> <span class="punct">}</span>
+  <span class="ident">collect</span> <span class="punct">{</span> <span class="punct">|</span><span class="ident">s</span><span class="punct">|</span> <span class="ident">s</span><span class="punct">.</span><span class="ident">capitalize</span> <span class="punct">}.</span><span class="ident">with_results</span> <span class="keyword">do</span>
+    <span class="ident">collect</span> <span class="punct">{</span> <span class="punct">|</span><span class="ident">s</span><span class="punct">|</span> <span class="ident">s</span><span class="punct">.</span><span class="ident">concat</span> <span class="punct">&quot;</span><span class="string"> world</span><span class="punct">&quot;</span> <span class="punct">}</span>
+    <span class="ident">collect</span> <span class="punct">{</span> <span class="punct">|</span><span class="ident">s</span><span class="punct">|</span> <span class="ident">s</span><span class="punct">.</span><span class="ident">concat</span> <span class="punct">&quot;</span><span class="string"> simon</span><span class="punct">&quot;</span> <span class="punct">}</span>
+  <span class="keyword">end</span><span class="punct">.</span><span class="ident">with_results</span> <span class="keyword">do</span>
+    <span class="ident">collect</span> <span class="punct">{</span> <span class="punct">|</span><span class="ident">s</span><span class="punct">|</span> <span class="ident">s</span><span class="punct">.</span><span class="ident">concat</span> <span class="punct">&quot;</span><span class="string">!</span><span class="punct">&quot;</span> <span class="punct">}</span>
+    <span class="ident">collect</span> <span class="punct">{</span> <span class="punct">|</span><span class="ident">s</span><span class="punct">|</span> <span class="ident">s</span><span class="punct">.</span><span class="ident">concat</span> <span class="punct">&quot;</span><span class="string">?</span><span class="punct">&quot;</span> <span class="punct">}</span>
+  <span class="keyword">end</span>
+<span class="keyword">end</span>
+
+<span class="ident">results</span> <span class="punct">=</span> <span class="ident">recorder</span><span class="punct">.</span><span class="ident">send_to</span><span class="punct">([</span><span class="constant">nil</span><span class="punct">,</span> <span class="punct">&quot;</span><span class="string">hello</span><span class="punct">&quot;,</span> <span class="constant">nil</span><span class="punct">,</span> <span class="punct">&quot;</span><span class="string">bye</span><span class="punct">&quot;,</span> <span class="constant">nil</span><span class="punct">])</span>
+<span class="ident">results</span> <span class="punct">==</span> <span class="punct">[</span> <span class="comment"># the result is ...</span>
+  <span class="punct">[</span><span class="symbol">:hello</span><span class="punct">,</span> <span class="symbol">:bye</span><span class="punct">],</span>
+  <span class="punct">[&quot;</span><span class="string">Hello world!</span><span class="punct">&quot;,</span> <span class="punct">&quot;</span><span class="string">Bye world!</span><span class="punct">&quot;],</span>
+  <span class="punct">[&quot;</span><span class="string">Hello simon!</span><span class="punct">&quot;,</span> <span class="punct">&quot;</span><span class="string">Bye simon!</span><span class="punct">&quot;],</span>
+  <span class="punct">[&quot;</span><span class="string">Hello world?</span><span class="punct">&quot;,</span> <span class="punct">&quot;</span><span class="string">Bye world?</span><span class="punct">&quot;],</span>
+  <span class="punct">[&quot;</span><span class="string">Hello simon?</span><span class="punct">&quot;,</span> <span class="punct">&quot;</span><span class="string">Bye simon?</span><span class="punct">&quot;]</span>
+<span class="punct">]</span>
+</pre></p>
+
+
+	<h2>License</h2>
+
+
+	<p>This code is free to use under the terms of the <span class="caps">MIT</span> license.</p>
+
+
+	<h2>Contact</h2>
+
+
+	<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>
+      Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
+    </p>
+</div>
+
+<!-- insert site tracking codes here, like Google Urchin -->
+
+</body>
+</html>

data/website/index.txt

@@ -0,0 +1,72 @@
+h1. message recorder
+
+h2. → 'message-recorder'
+
+
+h2. What
+
+<tt>Message::Recorder</tt> is a tool to record messages send to Ruby objects.
+
+h2. Installing
+
+<pre syntax="ruby">sudo gem install message-recorder</pre>
+
+h2. The basics
+
+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">
+recorder = Message::Recorder.new
+recorder.record.downcase
+recorder.send_to("HELLO") # => ["hello"]
+recorder.send_to("WORLD") # => ["world"]
+</pre>
+
+This is an example of branching. the <tt>with_results</tt> method accepts a block which is used to define multiple message chains at once.
+
+<pre syntax="ruby">
+recorder = Message::Recorder.new
+recorder.record.downcase.with_results do
+  intern
+  capitalize
+end
+
+recorder.send_to("HELLO") # => [:hello, "Hello"]
+</pre>
+
+h2. Demonstration of usage
+
+This is a more complex example with nested branches.
+
+<pre syntax="ruby">
+recorder = Message::Recorder.new
+recorder.record.compact.with_result do
+  collect { |s| s.intern }
+  collect { |s| s.capitalize }.with_results do
+    collect { |s| s.concat " world" }
+    collect { |s| s.concat " simon" }
+  end.with_results do
+    collect { |s| s.concat "!" }
+    collect { |s| s.concat "?" }
+  end
+end
+
+results = recorder.send_to([nil, "hello", nil, "bye", nil])
+results == [ # the result is ...
+  [:hello, :bye],
+  ["Hello world!", "Bye world!"],
+  ["Hello simon!", "Bye simon!"],
+  ["Hello world?", "Bye world?"],
+  ["Hello simon?", "Bye simon?"]
+]
+</pre>
+
+
+h2. License
+
+This code is free to use under the terms of the MIT license. 
+
+h2. Contact
+
+Comments are welcome. Send an email to "Simon Menke":mailto:simon@5xm.org
+