message-recorder 1.0.0

data/History.txt

@@ -0,0 +1,4 @@
+== 1.0.0 2008-02-13
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+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.

data/Manifest.txt

@@ -0,0 +1,35 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/message-recorder.rb
+lib/message-recorder/branching_mock.rb
+lib/message-recorder/chain.rb
+lib/message-recorder/chaining_mock.rb
+lib/message-recorder/collector.rb
+lib/message-recorder/message.rb
+lib/message-recorder/recorder.rb
+lib/message-recorder/version.rb
+log/debug.log
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+spec/chain_spec.rb
+spec/collector_spec.rb
+spec/fob_spec.rb
+spec/message_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/rspec.rake
+tasks/website.rake
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.rhtml

data/README.txt

@@ -0,0 +1,63 @@
+= message recorder
+
+== What
+
+<tt>Message::Recorder</tt> is a tool to record messages send to Ruby objects.
+
+
+== Installing
+
+  sudo gem install message-recorder
+
+== The basics
+
+This snippet will first record a <tt>downcase</tt> message and after that it will replay the recorded messages on some objects.
+
+  recorder = Message::Recorder.new
+  recorder.record.downcase
+  recorder.send_to("HELLO") # => ["hello"]
+  recorder.send_to("WORLD") # => ["world"]
+
+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.
+
+  recorder = Message::Recorder.new
+  recorder.record.downcase.with_results do
+    intern
+    capitalize
+  end
+  
+  recorder.send_to("HELLO") # => [:hello, "Hello"]
+
+== Demonstration of usage
+
+This is a more complex example with nested branches.
+
+  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?"]
+  ]
+
+== License
+
+This code is free to use under the terms of the MIT license. 
+
+== Contact
+
+Comments are welcome. Send an email to Simon Menke mailto:simon@5xm.org
+

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,70 @@
+require 'message-recorder/version'
+
+AUTHOR = 'Simon Menke'  # can also be an array of Authors
+EMAIL = "simon@5xm.org"
+DESCRIPTION = "Record messages send to Ruby objects so you can replay them later on. (endlessly ;)"
+GEM_NAME = 'message-recorder' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'message-recorde' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = Message::VERSION::STRING # + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'message-recorder documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -0,0 +1,17 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require 'message-recorder'

data/lib/message-recorder.rb

@@ -0,0 +1,31 @@
+# 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.
+
+$:.unshift File.dirname(__FILE__)
+
+module Message ; end
+
+require File.join(File.dirname(__FILE__), "message-recorder", "recorder")
+require File.join(File.dirname(__FILE__), "message-recorder", "message")
+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")

data/lib/message-recorder/branching_mock.rb

@@ -0,0 +1,43 @@
+# 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 Message::Recorder::BranchingMock # :nodoc:
+  alias_method :__instance_eval__, :instance_eval
+  instance_methods.each { |m| undef_method m unless m =~ /^__/ }
+  
+  def initialize(collector)
+    @branched_collectors = []
+    @collector_prototype = collector.deep_copy
+    @collector = collector.clear
+  end
+  def __branch__(&block)
+    __instance_eval__(&block) unless block.nil?
+    @branched_collectors.each { |branched_collector| @collector.concat branched_collector }
+    Message::Recorder::ChainingMock.new(@collector)
+  end
+  def method_missing(m, *args, &block)
+    branched_collector = @collector_prototype.branch
+    @branched_collectors << branched_collector
+    
+    branched_collector.record(m, *args, &block)
+    Message::Recorder::ChainingMock.new(branched_collector)
+  end
+end

data/lib/message-recorder/chain.rb

@@ -0,0 +1,41 @@
+# 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 Message::Recorder::Chain < ::Array # :nodoc:
+  
+  def initialize(array=[])
+    super(array)
+  end
+  
+  def record(m, *args, &block)
+    push Message::Recorder::Message.new(m, *args, &block)
+  end
+  
+  def send_to(subject_, recorder)
+    inject(subject_) do |subject,message|
+      return nil if recorder.break_if.call(subject)
+      
+      message.send_to(subject, recorder)
+    end
+  end
+  
+end

data/lib/message-recorder/chaining_mock.rb

@@ -0,0 +1,55 @@
+# 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.
+
+
+# ChainingMock is the mock object returned by the Message::Recorder#record method.
+class Message::Recorder::ChainingMock
+  instance_methods.each { |m| undef_method m unless m =~ /^__/ }
+  
+  def initialize(collector) # :nodoc:
+    @collector = collector
+  end
+  
+  def method_missing(m, *args, &block) # :nodoc:
+    @collector.record(m, *args, &block)
+    return self
+  end
+  
+  # when a block is passed to __branch__ it will create a separate call chain for each method call.
+  #   recorder.record.__branch__ do
+  #      hello
+  #      bye
+  #   end
+  #   recorder.send_to subject
+  # is the same as
+  #   recorder.record.hello
+  #   recorder.send_to subject
+  #   
+  #   recorder.record.bye
+  #   recorder.send_to subject
+  def __branch__(&block)
+    Message::Recorder::BranchingMock.new(@collector).__branch__(&block)
+  end
+  alias_method :with_results, :__branch__
+  alias_method :with_result,  :__branch__
+  alias_method :branch,       :__branch__
+  
+end

data/lib/message-recorder/collector.rb

@@ -0,0 +1,52 @@
+# 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 Message::Recorder::Collector < ::Array # :nodoc:
+  
+  def initialize(array=[], root=nil)
+    super(array)
+    push ::Message::Recorder::Chain.new if self.empty?
+    root_collector = root
+  end
+  
+  def collect_messages
+    ::Message::Recorder::ChainingMock.new(self)
+  end
+  
+  def record(m, *args, &block)
+    each { |chain| chain.record(m, *args, &block) }
+  end
+  
+  def branch
+    self.deep_copy
+  end
+  
+  def deep_copy
+    ::Message::Recorder::Collector.new(collect { |chain| chain.dup })
+  end
+  
+  def send_to(subject, recorder)
+    results = ::Array.new
+    each { |chain| results << chain.send_to(subject, recorder) }
+    results
+  end
+  
+end