zombie-chaser 0.0.3 → 0.1.0

data/History.txt

@@ -0,0 +1,22 @@
+=== 0.1.0 / 2010-04-11
+
+* Zombie speed is inversely proportional to number of tests, so numerous tests won't take to long.
+* Console based interface width is configurable.
+* There are multiple zombies, and can come from all directions.
+* Zombies lurch as they move.
+* Fixed nethack-style representations and messages being on the same line when using console based interface.
+* Gosu has to be installed manually, as it's not listed as a dependency.
+
+== 0.0.3 / 2009-12-13 7274dd9eeb09720a6be2afc5a261c878c2dfc7a1
+
+* GUI window size is configurable.
+* Users can choose between GUI and console based interface.
+* Ensured that excessive tests won't cause images to go off the screen.
+
+== 0.0.2 / 2009-12-08 0a888b2ea33481e078ab7640c9fd38dc6a23710f
+
+* Fix of brown paper bag bug: images weren't found when in gem form. 
+
+== 0.0.1 / 2009-12-07 4881d00aaa9e19491b191a5c35b351bffdd08212
+
+* Initial release

data/README.txt

@@ -1,47 +1,57 @@
-== DESCRIPTION:
-
-Zombie chaser is a graphic(al) interface to mutation testing. Kill off the mutants, or they will eat your brains!
-
-The human running across the screen represents the normal running of your unit tests. If one of them fails, then the human dies.
-
-Then the zombies chase after you. Each zombie represents a mutation to your code. If your unit tests detect that something's wrong with your code, then the mutation gets killed. Otherwise, the zombie gets to meet you.
-
-== FEATURES/PROBLEMS:
-
-* Code is slightly different to chaser.
-* Not quite finished.
-
-== REQUIREMENTS:
-
-* Gosu
-* Test-unit (for ruby 1.9)
-
-== INSTALL:
-
-* sudo gem install zombie-chaser
-
-== LICENSE:
-
-(The MIT License)
-
-Copyright (c) 2006-2009 Ryan Davis and Kevin Clark and Andrew Grimm,
-Chris Lloyd, Dave Newman, Carl Woodward & Daniel Bogan.
-
-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.
+== DESCRIPTION:
+
+Zombie chaser is a graphic(al) interface to mutation testing. Kill off the mutants, or they will eat your brains!
+
+The human running across the screen represents the normal running of your unit tests. If one of them fails, then the human dies.
+
+Then the zombies chase after you. Each zombie represents a mutation to your code (your code doing something it shouldn't be doing). If your unit tests detect that something's wrong with your code, then the mutation gets killed. Otherwise, the zombie gets to meat you.
+
+There are two alternatives for the interface. One is a GUI, while the other is a nethack-style interface that runs within the console itself. Zombie-chaser aims to be compatible with any flavor of ruby on any platform.
+
+== REQUIREMENTS:
+
+* Gosu (optional)
+* Test-unit (for ruby 1.9)
+
+== INSTALL:
+
+* [sudo] gem install zombie-chaser
+* [sudo] gem install gosu #Optional
+* [sudo] gem install test-unit #Optional
+
+* Don't use sudo if it's not applicable (can't or don't want to use root, or you're using Windows)
+* Gosu is not listed as a dependency, as otherwise jruby complains about gosu's absence before the program starts. Therefore you have to install it manually if you want a GUI interface.
+* If you're using ruby 1.9, you'll need to install the gem version of test-unit.
+
+== CURRENT BUGS:
+
+* Resource-intensive tests are especially slow in GUI mode for some reason. Run them in console mode (using --console) to make the program run faster.
+* Very occasionally, the program can crash, possibly because of threading issues. Please notify me if it becomes a consistent problem.
+* GUI version doesn't work in ruby 1.9.
+* Neither GUI nor console works on jruby for ruby version 1.9.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2006-2009 Ryan Davis and Kevin Clark and Andrew Grimm,
+Chris Lloyd, Dave Newman, Carl Woodward & Daniel Bogan.
+
+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/Rakefile

@@ -1,24 +1,26 @@
-task :default => [:test]
-
-begin
-  require 'jeweler'
-  require File.dirname(__FILE__) + "/lib/zombie_test_chaser.rb"
-  Jeweler::Tasks.new do |gemspec|
-    gemspec.name = "zombie-chaser"
-    gemspec.summary = "Lightweight mutation testing ... with ZOMBIES!!!"
-    gemspec.description = "A zombie-themed graphic(al) user interface for mutation testing"
-    gemspec.email = "andrew.j.grimm@gmail.com"
-    gemspec.authors = ["Andrew Grimm", "Ryan Davis", "Eric Hodel", "Kevin Clark"]
-    #gemspec.add_dependency('test-unit') #FIXME Don't know how to only add the dependency for ruby 1.9
-    gemspec.add_dependency('gosu') #FIXME add option for command-line version, which'll make gosu an optional dependency
-    gemspec.version = ZombieTestChaser::VERSION
-    gemspec.homepage = "http://andrewjgrimm.wordpress.com/2009/11/08/declare-war-on-everything-with-chaser/"
-  end
-rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install jeweler"
-end
-
-task :test do
-  ruby "test/test_unit.rb"
-end
-
+task :default => [:test]
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "zombie-chaser"
+    gemspec.summary = "Lightweight mutation testing ... with ZOMBIES!!!"
+    gemspec.description = "A zombie-themed graphic(al) user interface for mutation testing"
+    gemspec.email = "andrew.j.grimm@gmail.com"
+    gemspec.authors = ["Andrew Grimm", "Ryan Davis", "Eric Hodel", "Kevin Clark"]
+    #gemspec.add_dependency('test-unit') #FIXME Don't know how to only add the dependency for ruby 1.9
+    # Question about conditional dependency asked at http://stackoverflow.com/questions/1620342/how-do-i-add-conditional-rubygem-requirements-to-a-gem-specification
+    #gemspec.add_dependency('gosu') #TODO ask rubygems people to make it possible to specify an optional runtime dependency
+    # Comment about optional runtime dependencies at https://oree.ch/2009/06/06/rubygems-dependencies.html argues you shouldn't list optional dependencies
+    #gemspec.version = ZombieTestChaser::VERSION #Can't access ZombieTestChaser without starting up test/unit
+    gemspec.version = '0.1.0' # Check that it's consistent with ZombieTestChaser::VERSION
+    gemspec.homepage = "http://andrewjgrimm.wordpress.com/2009/11/08/declare-war-on-everything-with-chaser/"
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+end
+
+#Fixme work out how to change this to TestTask without problems
+task :test do
+  ruby "-Ilib", "-Itest", "test/test_unit.rb"
+end

data/bin/zombie-chaser

@@ -1,79 +1,77 @@
-#!/usr/local/bin/ruby
-
-$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
-$:.unshift File.join(File.dirname(__FILE__), *%w[.. ui])
-require 'zombie_test_chaser'
-require 'ui'
-require 'optparse'
-
-force = false
-target_everything = false
-
-opts = OptionParser.new do |opts|
-  opts.banner = "Usage: #{File.basename($0)} class_name [method_name]"
-  opts.on("-v", "--verbose", "Loudly explain chaser run") do |opt|
-    ZombieTestChaser.debug = true
-  end
-
-  opts.on("-V", "--version", "Prints zombie-chaser's version number") do |opt|
-    puts "zombie-chaser #{ZombieTestChaser::VERSION}"
-    exit 0
-  end
-
-  opts.on("-t", "--tests TEST_PATTERN",
-          "Location of tests (glob). Unix-style even on Windows, so use forward slashes.") do |pattern|
-    ZombieTestChaser.test_pattern = pattern
-  end
-
-  opts.on("--everything", "Zombie chase all classes") do |opt|
-    puts "You're now facing a plague of zombies!"
-    target_everything = true
-  end
-
-  opts.on("-F", "--force", "Ignore initial test failures") do |opt|
-    force = true
-  end
-
-  opts.on("-T", "--timeout SECONDS", "The maximum time for a test run in seconds",
-                                     "Used to catch infinite loops") do |timeout|
-    Chaser.timeout = timeout.to_i
-    puts "Setting timeout at #{timeout} seconds."
-  end
-
-  opts.on("--width PIXELS", "Width of screen in pixels") do |width|
-    Window.width = Integer(width)
-  end
-
-  opts.on("--height PIXELS", "Height of screen in pixels") do |height|
-    Window.height = Integer(height)
-  end
-
-  opts.on("--console", "Use nethack-style text interface") do |opt|
-    World.interface_type = :console_interface
-  end
-
-  opts.on("-r", "--random-seed SEED", "Random seed number (under development)") do |seed|
-    srand(seed.to_i)
-  end
-
-  opts.on("-h", "--help", "Show this message") do |opt|
-    puts opts
-    exit 0
-  end
-end
-
-looks_like_rails = test ?f, 'config/environment.rb'
-ZombieTestChaser.test_pattern = "test/**/*.rb" if looks_like_rails
-
-opts.parse!
-
-impl = ARGV.shift
-meth = ARGV.shift
-
-unless impl or target_everything then
-  puts opts
-  exit 1
-end
-
-exit ZombieTestChaser.validate(impl, meth, force)
-
+#!/usr/local/bin/ruby
+
+require 'zombie-chaser/zombie_test_chaser'
+require 'optparse'
+
+force = false
+target_everything = false
+
+opts = OptionParser.new do |opts|
+  opts.banner = "Usage: #{File.basename($0)} class_name [method_name]"
+  opts.on("-v", "--verbose", "Loudly explain chaser run") do |opt|
+    ZombieTestChaser.debug = true
+  end
+
+  opts.on("-V", "--version", "Prints zombie-chaser's version number") do |opt|
+    puts "zombie-chaser #{ZombieTestChaser::VERSION}"
+    exit 0
+  end
+
+  opts.on("-t", "--tests TEST_PATTERN",
+          "Location of tests (glob). Unix-style even on Windows, so use forward slashes.") do |pattern|
+    ZombieTestChaser.test_pattern = pattern
+  end
+
+  opts.on("--everything", "Zombie chase all classes") do |opt|
+    puts "You're now facing a plague of zombies!"
+    target_everything = true
+  end
+
+  opts.on("-F", "--force", "Ignore initial test failures") do |opt|
+    force = true
+  end
+
+  opts.on("-T", "--timeout SECONDS", "The maximum time for a test run in seconds",
+                                     "Used to catch infinite loops") do |timeout|
+    Chaser.timeout = timeout.to_i
+    puts "Setting timeout at #{timeout} seconds."
+  end
+
+  opts.on("--width PIXELS", "Width of screen in pixels (or that of a console interface in characters)") do |width|
+    Window.width = Integer(width)
+    ConsoleInterface.width = Integer(width)
+  end
+
+  opts.on("--height PIXELS", "Height of screen in pixels") do |height|
+    Window.height = Integer(height)
+  end
+
+  opts.on("--console", "Use nethack-style text interface") do |opt|
+    World.interface_type = :console_interface
+  end
+
+  opts.on("-r", "--random-seed SEED", "Random seed number (under development)") do |seed|
+    srand(seed.to_i)
+  end
+
+  opts.on("-h", "--help", "Show this message") do |opt|
+    puts opts
+    exit 0
+  end
+end
+
+looks_like_rails = test ?f, 'config/environment.rb'
+ZombieTestChaser.test_pattern = "test/**/*.rb" if looks_like_rails
+
+opts.parse!
+
+impl = ARGV.shift
+meth = ARGV.shift
+
+unless impl or target_everything then
+  puts opts
+  exit 1
+end
+
+exit ZombieTestChaser.validate(impl, meth, force)
+

data/lib/{chaser.rb → zombie-chaser/chaser.rb}

@@ -1,373 +1,392 @@
-require 'rubygems'
-require 'timeout'
-require 'world'
-
-class String # :nodoc:
-  def to_class
-    split(/::/).inject(Object) { |klass, name| klass.const_get(name) }
-  end
-end
-
-##
-# Test Unit Sadism
-
-class Chaser
-
-  class Timeout < Timeout::Error; end
-
-  ##
-  # The version of Chaser you are using.
-
-  VERSION = '0.0.4'
-
-  ##
-  # Is this platform MS Windows-like?
-
-  WINDOZE = RUBY_PLATFORM =~ /mswin/
-
-  ##
-  # Path to the bit bucket.
-
-  NULL_PATH = WINDOZE ? 'NUL:' : '/dev/null'
-
-  ##
-  # Class being chased
-
-  attr_accessor :klass
-
-  ##
-  # Name of class being chased
-
-  attr_accessor :klass_name
-
-  ##
-  # Method being chased
-
-  attr_accessor :method
-
-  ##
-  # Name of method being chased
-
-  attr_accessor :method_name
-
-  ##
-  # The original version of the method being chased
-
-  attr_reader :old_method
-
-  @@debug = false
-  @@guess_timeout = true
-  @@timeout = 60 # default to something longer (can be overridden by runners)
-
-  def self.debug
-    @@debug
-  end
-
-  def self.debug=(value)
-    @@debug = value
-  end
-
-  def self.timeout=(value)
-    @@timeout = value
-    @@guess_timeout = false # We've set the timeout, don't guess
-  end
-
-  def self.guess_timeout?
-    @@guess_timeout
-  end
-
-  ##
-  # Creates a new Chaser that will chase +klass_name+ and +method_name+,
-  # sending results to +reporter+.
-
-  def initialize(klass_name = nil, method_name = nil, reporter = Reporter.new)
-    @klass_name = klass_name
-    @method_name = method_name.intern if method_name
-
-    @klass = klass_name.to_class if klass_name
-
-    @method = nil
-    @reporter = reporter
-
-    @mutated = false
-
-    @failure = false
-  end
-
-  ##
-  # Overwrite test_pass? for your own Chaser runner.
-
-  def tests_pass?
-    raise NotImplementedError
-  end
-
-  def run_tests
-    if zombie_survives? then
-      record_passing_mutation
-    else
-      @reporter.report_test_failures
-    end
-  end
-
-  ############################################################
-  ### Running the script
-
-  def validate
-    @reporter.method_loaded(klass_name, method_name)
-
-    begin
-      modify_method
-      timeout(@@timeout, Chaser::Timeout) { run_tests }
-    rescue Chaser::Timeout
-      @reporter.warning "Your tests timed out. Chaser may have caused an infinite loop."
-    rescue Interrupt
-      @reporter.warning 'Mutation canceled, hit ^C again to exit'
-      sleep 2
-    end
-
-    unmodify_method # in case we're validating again. we should clean up.
-
-    if @failure
-      @reporter.report_failure
-      false
-    else
-      @reporter.no_surviving_mutant
-      true
-    end
-  end
-
-  def record_passing_mutation
-    @failure = true
-  end
-
-  def calculate_proxy_method_name(original_name)
-    result = "__chaser_proxy__#{original_name}"
-    character_renaming = {"[]" => "square_brackets", "^" => "exclusive_or",
-    "=" => "equals", "&" => "ampersand", "*" => "splat", "+" => "plus",
-    "-" => "minus", "%" => "percent", "~" => "tilde", "@" => "at",
-    "/" => "forward_slash", "<" => "less_than", ">" => "greater_than"}
-    character_renaming.each do |characters, renamed_string_portion|
-      result.gsub!(characters, renamed_string_portion)
-    end
-    result
-  end
-
-  def unmodify_instance_method
-    chaser = self
-    @mutated = false
-    chaser_proxy_method_name = calculate_proxy_method_name(@method_name)
-    @klass.send(:define_method, chaser_proxy_method_name) do |block, *args|
-      chaser.old_method.bind(self).call(*args) {|*yielded_values| block.call(*yielded_values)}
-    end
-  end
-
-  def unmodify_class_method
-    chaser = self
-    @mutated = false
-    chaser_proxy_method_name = calculate_proxy_method_name(clean_method_name)
-    aliasing_class(@method_name).send(:define_method, chaser_proxy_method_name) do |block, *args|
-      chaser.old_method.bind(self).call(*args) {|*yielded_values| block.call(*yielded_values)}
-    end
-  end
-
-  # Ruby 1.8 doesn't allow define_method to handle blocks.
-  # The blog post http://coderrr.wordpress.com/2008/10/29/using-define_method-with-blocks-in-ruby-18/
-  # show that define_method has problems, and showed how to do workaround_method_code_string
-  def modify_instance_method
-    chaser = self
-    @mutated = true
-    @old_method = @klass.instance_method(@method_name)
-    chaser_proxy_method_name = calculate_proxy_method_name(@method_name)
-    workaround_method_code_string = <<-EOM
-      def #{@method_name}(*args, &block)
-        #{chaser_proxy_method_name}(block, *args)
-      end
-    EOM
-    @klass.class_eval do
-      eval(workaround_method_code_string)
-    end
-    @klass.send(:define_method, chaser_proxy_method_name) do |block, *args|
-      original_value = chaser.old_method.bind(self).call(*args) do |*yielded_values|
-        mutated_yielded_values = yielded_values.map{|value| chaser.mutate_value(value)}
-        block.call(*mutated_yielded_values)
-      end
-      chaser.mutate_value(original_value)
-    end
-  end
-
-  def modify_class_method
-    chaser = self
-    @mutated = true
-    @old_method = aliasing_class(@method_name).instance_method(clean_method_name)
-    chaser_proxy_method_name = calculate_proxy_method_name(clean_method_name)
-    workaround_method_code_string = <<-EOM
-      def #{@method_name}(*args, &block)
-        #{chaser_proxy_method_name}(block, *args)
-      end
-    EOM
-    @klass.class_eval do
-      eval(workaround_method_code_string)
-    end
-    aliasing_class(@method_name).send(:define_method, chaser_proxy_method_name) do |block, *args|
-      original_value = chaser.old_method.bind(self).call(*args) do |*yielded_values|
-        mutated_yielded_values = yielded_values.map{|value| chaser.mutate_value(value)}
-        block.call(*mutated_yielded_values)
-      end
-      chaser.mutate_value(original_value)
-    end
-  end
-
-  def modify_method
-    if method_name.to_s =~ /self\./
-      modify_class_method
-    else
-      modify_instance_method
-    end
-  end
-
-  def unmodify_method
-    if method_name.to_s =~ /self\./ #TODO fix duplication. Give the test a name
-      unmodify_class_method
-    else
-      unmodify_instance_method
-    end
-  end
-
-
-  ##
-  # Replaces the value with a random value.
-
-  def mutate_value(value)
-    case value
-    when Fixnum, Float, Bignum
-      value + rand_number
-    when String
-      rand_string
-    when Symbol
-      rand_symbol
-    when Regexp
-      Regexp.new(Regexp.escape(rand_string.gsub(/\//, '\\/')))
-    when Range
-      rand_range
-    when NilClass, FalseClass
-      rand_number
-    when TrueClass
-      false
-    else
-      nil
-    end
-  end
-
-  ############################################################
-  ### Convenience methods
-
-  def aliasing_class(method_name)
-    method_name.to_s =~ /self\./ ? class << @klass; self; end : @klass
-  end
-
-  def clean_method_name
-    method_name.to_s.gsub(/self\./, '')
-  end
-
-  ##
-  # Returns a random Fixnum.
-
-  def rand_number
-    (rand(100) + 1)*((-1)**rand(2))
-  end
-
-  ##
-  # Returns a random String
-
-  def rand_string
-    size = rand(50)
-    str = ""
-    size.times { str << rand(126).chr }
-    str
-  end
-
-  ##
-  # Returns a random Symbol
-
-  def rand_symbol
-    letters = ('a'..'z').to_a + ('A'..'Z').to_a
-    str = ""
-    (rand(50) + 1).times { str << letters[rand(letters.size)] }
-    :"#{str}"
-  end
-
-  ##
-  # Returns a random Range
-
-  def rand_range
-    min = rand(50)
-    max = min + rand(50)
-    min..max
-  end
-
-  ##
-  # Suppresses output on $stdout and $stderr.
-
-  def silence_stream
-    return yield if @@debug
-
-    begin
-      dead = File.open(Chaser::NULL_PATH, "w")
-
-      $stdout.flush
-      $stderr.flush
-
-      oldstdout = $stdout.dup
-      oldstderr = $stderr.dup
-
-      $stdout.reopen(dead)
-      $stderr.reopen(dead)
-
-      result = yield
-
-    ensure
-      $stdout.flush
-      $stderr.flush
-
-      $stdout.reopen(oldstdout)
-      $stderr.reopen(oldstderr)
-      result
-    end
-  end
-
-  class Reporter
-    def method_loaded(klass_name, method_name)
-      info "#{klass_name}\##{method_name} loaded"
-    end
-
-    def warning(message)
-      puts "!" * 70
-      puts "!!! #{message}"
-      puts "!" * 70
-      puts
-    end
-
-    def info(message)
-      puts "*"*70
-      puts "***  #{message}"
-      puts "*"*70
-      puts
-    end
-
-    def report_failure
-      puts
-      puts "The affected method didn't cause test failures."
-      puts
-    end
-
-    def no_surviving_mutant
-      puts "The mutant didn't survive. Cool!\n\n"
-    end
-
-    def report_test_failures
-      puts "Tests failed -- this is good" if Chaser.debug
-    end
-  end
-
-end
-
+require 'rubygems'
+require 'timeout'
+require 'zombie-chaser/world'
+
+class String # :nodoc:
+  def to_class
+    split(/::/).inject(Object) { |klass, name| klass.const_get(name) }
+  end
+end
+
+##
+# Test Unit Sadism
+
+class Chaser
+
+  class Timeout < Timeout::Error; end
+
+  ##
+  # The version of Chaser you are using.
+
+  VERSION = '0.0.4'
+
+  ##
+  # Is this platform MS Windows-like?
+
+  WINDOZE = RUBY_PLATFORM =~ /mswin/
+
+  ##
+  # Path to the bit bucket.
+
+  NULL_PATH = WINDOZE ? 'NUL:' : '/dev/null'
+
+  ##
+  # Class being chased
+
+  attr_accessor :klass
+
+  ##
+  # Name of class being chased
+
+  attr_accessor :klass_name
+
+  ##
+  # Method being chased
+
+  attr_accessor :method
+
+  ##
+  # Name of method being chased
+
+  attr_accessor :method_name
+
+  ##
+  # The original version of the method being chased
+
+  attr_reader :old_method
+
+  @@debug = false
+  @@guess_timeout = true
+  @@timeout = 60 # default to something longer (can be overridden by runners)
+
+  def self.debug
+    @@debug
+  end
+
+  def self.debug=(value)
+    @@debug = value
+  end
+
+  def self.timeout=(value)
+    @@timeout = value
+    @@guess_timeout = false # We've set the timeout, don't guess
+  end
+
+  def self.guess_timeout?
+    @@guess_timeout
+  end
+
+  #For the benefit of puts calls in ZombieTestChaser.validate
+  def interface_puts(*args)
+    @reporter.interface_puts(*args)
+  end
+
+  ##
+  # Creates a new Chaser that will chase +klass_name+ and +method_name+,
+  # sending results to +reporter+.
+
+  def initialize(klass_name = nil, method_name = nil, reporter = Reporter.new)
+    @klass_name = klass_name
+    @method_name = method_name.intern if method_name
+
+    @klass = klass_name.to_class if klass_name
+
+    @method = nil
+    @reporter = reporter
+
+    @mutated = false
+
+    @failure = false
+  end
+
+  ##
+  # Overwrite test_pass? for your own Chaser runner.
+
+  def tests_pass?
+    raise NotImplementedError
+  end
+
+  def run_tests
+    if zombie_survives? then
+      record_passing_mutation
+    else
+      @reporter.report_test_failures
+    end
+  end
+
+  ############################################################
+  ### Running the script
+
+  def validate
+    @reporter.method_loaded(klass_name, method_name)
+
+    begin
+      modify_method
+      timeout(@@timeout, Chaser::Timeout) { run_tests }
+    rescue Chaser::Timeout
+      @reporter.warning "Your tests timed out. Chaser may have caused an infinite loop."
+    rescue Interrupt
+      @reporter.warning 'Mutation canceled, hit ^C again to exit'
+      sleep 2
+    end
+
+    unmodify_method # in case we're validating again. we should clean up.
+
+    if @failure
+      @reporter.report_failure
+      false
+    else
+      @reporter.no_surviving_mutant
+      true
+    end
+  end
+
+  def record_passing_mutation
+    @failure = true
+  end
+
+  def calculate_proxy_method_name(original_name)
+    result = "__chaser_proxy__#{original_name}"
+    character_renaming = {"[]" => "square_brackets", "^" => "exclusive_or",
+    "=" => "equals", "&" => "ampersand", "*" => "splat", "+" => "plus",
+    "-" => "minus", "%" => "percent", "~" => "tilde", "@" => "at",
+    "/" => "forward_slash", "<" => "less_than", ">" => "greater_than"}
+    character_renaming.each do |characters, renamed_string_portion|
+      result.gsub!(characters, renamed_string_portion)
+    end
+    result
+  end
+
+  def unmodify_instance_method
+    chaser = self
+    @mutated = false
+    chaser_proxy_method_name = calculate_proxy_method_name(@method_name)
+    @klass.send(:define_method, chaser_proxy_method_name) do |block, *args|
+      chaser.old_method.bind(self).call(*args) {|*yielded_values| block.call(*yielded_values)}
+    end
+  end
+
+  def unmodify_class_method
+    chaser = self
+    @mutated = false
+    chaser_proxy_method_name = calculate_proxy_method_name(clean_method_name)
+    aliasing_class(@method_name).send(:define_method, chaser_proxy_method_name) do |block, *args|
+      chaser.old_method.bind(self).call(*args) {|*yielded_values| block.call(*yielded_values)}
+    end
+  end
+
+  # Ruby 1.8 doesn't allow define_method to handle blocks.
+  # The blog post http://coderrr.wordpress.com/2008/10/29/using-define_method-with-blocks-in-ruby-18/
+  # show that define_method has problems, and showed how to do workaround_method_code_string
+  def modify_instance_method
+    chaser = self
+    @mutated = true
+    @old_method = @klass.instance_method(@method_name)
+    chaser_proxy_method_name = calculate_proxy_method_name(@method_name)
+    workaround_method_code_string = <<-EOM
+      def #{@method_name}(*args, &block)
+        #{chaser_proxy_method_name}(block, *args)
+      end
+    EOM
+    @klass.class_eval do
+      remove_method(chaser.clean_method_name.to_sym)
+      eval(workaround_method_code_string)
+    end
+    @klass.send(:define_method, chaser_proxy_method_name) do |block, *args|
+      original_value = chaser.old_method.bind(self).call(*args) do |*yielded_values|
+        mutated_yielded_values = yielded_values.map{|value| chaser.mutate_value(value)}
+        block.call(*mutated_yielded_values)
+      end
+      chaser.mutate_value(original_value)
+    end
+  end
+
+  def modify_class_method
+    chaser = self
+    @mutated = true
+    @old_method = aliasing_class(@method_name).instance_method(clean_method_name)
+
+    aliasing_class(@method_name).class_eval do
+      remove_method(chaser.clean_method_name.to_sym)
+    end
+
+    chaser_proxy_method_name = calculate_proxy_method_name(clean_method_name)
+    workaround_method_code_string = <<-EOM
+      def #{@method_name}(*args, &block)
+        #{chaser_proxy_method_name}(block, *args)
+      end
+    EOM
+    @klass.class_eval do
+      eval(workaround_method_code_string)
+    end
+    aliasing_class(@method_name).send(:define_method, chaser_proxy_method_name) do |block, *args|
+      original_value = chaser.old_method.bind(self).call(*args) do |*yielded_values|
+        mutated_yielded_values = yielded_values.map{|value| chaser.mutate_value(value)}
+        block.call(*mutated_yielded_values)
+      end
+      chaser.mutate_value(original_value)
+    end
+  end
+
+  def modify_method
+    if method_name.to_s =~ /self\./
+      modify_class_method
+    else
+      modify_instance_method
+    end
+  end
+
+  def unmodify_method
+    if method_name.to_s =~ /self\./ #TODO fix duplication. Give the test a name
+      unmodify_class_method
+    else
+      unmodify_instance_method
+    end
+  end
+
+
+  ##
+  # Replaces the value with a random value.
+
+  def mutate_value(value)
+    case value
+    when Fixnum, Float, Bignum
+      value + rand_number
+    when String
+      rand_string
+    when Symbol
+      rand_symbol
+    when Regexp
+      Regexp.new(Regexp.escape(rand_string.gsub(/\//, '\\/')))
+    when Range
+      rand_range
+    when NilClass, FalseClass
+      rand_number
+    when TrueClass
+      false
+    else
+      nil
+    end
+  end
+
+  ############################################################
+  ### Convenience methods
+
+  def aliasing_class(method_name)
+    method_name.to_s =~ /self\./ ? class << @klass; self; end : @klass
+  end
+
+  def clean_method_name
+    method_name.to_s.gsub(/self\./, '')
+  end
+
+  ##
+  # Returns a random Fixnum.
+
+  def rand_number
+    (rand(100) + 1)*((-1)**rand(2))
+  end
+
+  ##
+  # Returns a random String
+
+  def rand_string
+    size = rand(50)
+    str = ""
+    size.times { str << rand(126).chr }
+    str
+  end
+
+  ##
+  # Returns a random Symbol
+
+  def rand_symbol
+    letters = ('a'..'z').to_a + ('A'..'Z').to_a
+    str = ""
+    (rand(50) + 1).times { str << letters[rand(letters.size)] }
+    :"#{str}"
+  end
+
+  ##
+  # Returns a random Range
+
+  def rand_range
+    min = rand(50)
+    max = min + rand(50)
+    min..max
+  end
+
+  ##
+  # Suppresses output on $stdout and $stderr.
+
+  def silence_stream
+    return yield if @@debug
+
+    begin
+      dead = File.open(Chaser::NULL_PATH, "w")
+
+      $stdout.flush
+      $stderr.flush
+
+      oldstdout = $stdout.dup
+      oldstderr = $stderr.dup
+
+      $stdout.reopen(dead)
+      $stderr.reopen(dead)
+
+      result = yield
+
+    ensure
+      $stdout.flush
+      $stderr.flush
+
+      $stdout.reopen(oldstdout)
+      $stderr.reopen(oldstderr)
+      result
+    end
+  end
+
+  class Reporter
+    def initialize(interface)
+      @interface = interface
+    end
+
+    def method_loaded(klass_name, method_name)
+      info "#{klass_name}\##{method_name} loaded"
+    end
+
+    def warning(message)
+      interface_puts "!" * 70,
+                     "!!! #{message}",
+                     "!" * 70,
+                     ""
+    end
+
+    def info(message)
+      interface_puts "*"*70,
+                     "***  #{message}",
+                     "*"*70,
+                     ""
+    end
+
+    def report_failure
+      interface_puts "",
+                     "The affected method didn't cause test failures.",
+                     ""
+    end
+
+    def no_surviving_mutant
+      interface_puts "The mutant didn't survive. Cool!\n\n"
+    end
+
+    def report_test_failures
+      interface_puts "Tests failed -- this is good" if Chaser.debug
+    end
+
+    def interface_puts(*args)
+      @interface.interface_puts(*args)
+    end
+  end
+
+end
+