heckle 1.4.3 → 2.0.0.b1

data/.autotest

@@ -3,10 +3,12 @@
 require 'autotest/restart'
 
 Autotest.add_hook :initialize do |at|
+  at.libs << ":../../ParseTree/dev/lib"
+  at.libs << ":../../ParseTree/dev/test"
   at.libs << ":../../RubyInline/dev/lib"
-  at.libs << ":../../ParseTree/dev/lib:../../ParseTree/dev/test"
+  at.libs << ":../../ruby2ruby/1.3.1/lib"
+  at.libs << ":../../ZenTest/dev/lib"
   at.libs << ":../../sexp_processor/dev/lib"
-  at.libs << ":../../ruby2ruby/dev/lib"
 
   %w(Dasgn Iter Dasgncurr Cvasgn Boolean Call Callblock
      ClassMethod Gasgn Iasgn If Lasgn Masgn Ranges Regexes

data/History.txt

@@ -1,3 +1,19 @@
+=== 2.0.0.b1 / 2012-10-02
+
+* 1 major enhancement:
+
+  * Hot damn! It works with ruby_parser!!! (phiggins)
+
+* 1 minor enhancement:
+
+  * 1.9 support! (phiggins)
+
+* 3 bug fixes:
+
+  * Fixed Ruby2Ruby usage (raggi)
+  * Fixed dependencies so heckle doesn't use ruby_parser 3 and friends.
+  * Fixed grammar in description.  Reported by Jean Lange.
+
 === 1.4.3 / 2009-06-23
 
 * 2 minor enhancements:

data/Manifest.txt

@@ -6,10 +6,18 @@ Rakefile
 bin/heckle
 lib/autotest/heckle.rb
 lib/heckle.rb
+lib/heckle_runner.rb
+lib/minitest_heckler.rb
 lib/test_unit_heckler.rb
 sample/Rakefile
 sample/changes.log
-sample/lib/heckled.rb
 sample/test/test_heckled.rb
+test/fixtures/heckle_dummy.rb
 test/fixtures/heckled.rb
+test/fixtures/minitest_project/README.txt
+test/fixtures/minitest_project/Rakefile
+test/fixtures/minitest_project/lib/doubler.rb
+test/fixtures/minitest_project/test/test_doubler_with_a_number.rb
+test/fixtures/minitest_project/test/test_doubler_with_bad_input.rb
 test/test_heckle.rb
+test/test_heckle_runner.rb

data/README.txt

@@ -1,11 +1,12 @@
 = heckle
 
-* http://www.rubyforge.org/projects/seattlerb
-* http://seattlerb.rubyforge.org/heckle
+home :: http://ruby.sadi.st/Heckle.html
+repo :: https://github.com/seattlerb/heckle
+rdoc :: http://seattlerb.rubyforge.org/heckle
 
 == DESCRIPTION:
 
-Heckle is unit test sadism(tm) at it's core. Heckle is a mutation tester. It modifies your code and runs your tests to make sure they fail. The idea is that if code can be changed and your tests don't notice, either that code isn't being covered or it doesn't do anything.
+Heckle is unit test sadism(tm) at its core. Heckle is a mutation tester. It modifies your code and runs your tests to make sure they fail. The idea is that if code can be changed and your tests don't notice, either that code isn't being covered or it doesn't do anything.
 
 It's like hiring a white-hat hacker to try to break into your server and making sure you detect it. You learn the most by trying to break things and watching the outcome in an act of unit test sadism.
 
@@ -32,7 +33,7 @@ It's like hiring a white-hat hacker to try to break into your server and making
 
 (The MIT License)
 
-Copyright (c) 2006-2008 Ryan Davis and Kevin Clark
+Copyright (c) Ryan Davis, seattle.rb, and Kevin Clark
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -3,28 +3,28 @@
 require 'rubygems'
 require 'hoe'
 
-Hoe.add_include_dirs("../../ParseTree/dev/lib",
-                     "../../ParseTree/dev/test",
-                     "../../RubyInline/dev/lib",
-                     "../../ruby2ruby/dev/lib",
+Hoe.add_include_dirs("../../RubyInline/dev/lib",
+                     "../../ruby2ruby/1.3.1/lib",
                      "../../ZenTest/dev/lib",
                      "../../sexp_processor/dev/lib",
+                     "../../ruby_parser/2.3.1/lib",
                      "lib")
 
 Hoe.plugin :seattlerb
 
 Hoe.spec 'heckle' do
-  developer 'Ryan Davis', 'ryand-ruby@zenspider.com'
-  developer 'Eric Hodel', 'drbrain@segment7.net'
-  developer 'Kevin Clark', 'kevin.clark@gmail.com'
+  developer 'Ryan Davis',   'ryand-ruby@zenspider.com'
+  developer 'Pete Higgins', 'pete@peterhiggins.org'
+  # developer 'Eric Hodel',  'drbrain@segment7.net'
+  # developer 'Kevin Clark', 'kevin.clark@gmail.com'
 
-  self.rubyforge_name = 'seattlerb'
+  clean_globs << File.expand_path("~/.ruby_inline")
 
-  clean_globs    << File.expand_path("~/.ruby_inline")
-  extra_deps     << ['ParseTree', '>= 2.0.0']
-  extra_deps     << ['ruby2ruby', '>= 1.1.6']
-  extra_deps     << ['ZenTest', '>= 3.5.2']
-  multiruby_skip << "1.9"
+  dependency 'ruby_parser', '~> 2.3.1'
+  dependency 'ruby2ruby', '~> 1.3.0'
+  dependency 'ZenTest',   '~> 4.7.0'
+
+  self.test_globs = ["test/test_*.rb"]
 end
 
 # vim: syntax=ruby

data/bin/heckle

@@ -1,96 +1,8 @@
-#!/usr/local/bin/ruby
+#!/usr/bin/env ruby
 
-$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
-require 'test_unit_heckler'
-require 'optparse'
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+$LOAD_PATH << 'lib'
 
-force = false
-nodes = Heckle::MUTATABLE_NODES
-
-opts = OptionParser.new do |opts|
-  opts.banner = "Usage: #{File.basename($0)} class_name [method_name]"
-  opts.on("-v", "--verbose", "Loudly explain heckle run") do |opt|
-    TestUnitHeckler.debug = true
-  end
-
-  opts.on("-V", "--version", "Prints Heckle's version number") do |opt|
-    puts "Heckle #{Heckle::VERSION}"
-    exit 0
-  end
-
-  opts.on("-t", "--tests TEST_PATTERN",
-          "Location of tests (glob)") do |pattern|
-    TestUnitHeckler.test_pattern = pattern
-  end
-
-  opts.on("-F", "--force", "Ignore initial test failures",
-          "Best used with --focus") do |opt|
-    force = true
-  end
-
-  opts.on(      "--assignments", "Only mutate assignments") do |opt|
-    puts "!"*70
-    puts "!!! Heckling assignments only"
-    puts "!"*70
-    puts
-
-    nodes = Heckle::ASGN_NODES
-  end
-
-  opts.on("-b", "--branches", "Only mutate branches") do |opt|
-    puts "!"*70
-    puts "!!! Heckling branches only"
-    puts "!"*70
-    puts
-
-    nodes = Heckle::BRANCH_NODES
-  end
-
-  opts.on("-f", "--focus", "Apply the eye of sauron") do |opt|
-    puts "!"*70
-    puts "!!! Running in focused mode. FEEL THE EYE OF SAURON!!!"
-    puts "!"*70
-    puts
-
-    TestUnitHeckler.focus = true
-  end
-
-  opts.on("-T", "--timeout SECONDS", "The maximum time for a test run in seconds",
-                                     "Used to catch infinite loops") do |timeout|
-    Heckle.timeout = timeout.to_i
-    puts "Setting timeout at #{timeout} seconds."
-  end
-
-  opts.on("-n", "--nodes NODES", "Nodes to mutate",
-          "Possible values: #{Heckle::MUTATABLE_NODES.join(',')}") do |opt|
-    nodes = opt.split(',').collect {|n| n.to_sym }
-    puts "Mutating nodes: #{nodes.inspect}"
-  end
-
-  opts.on("-x", "--exclude-nodes NODES", "Nodes to exclude") do |opt|
-    exclusions = opt.split(',').collect {|n| n.to_sym }
-    nodes = nodes - exclusions
-    puts "Mutating without nodes: #{exclusions.inspect}"
-  end
-
-  opts.on("-h", "--help", "Show this message") do |opt|
-    puts opts
-    exit 0
-  end
-end
-
-looks_like_rails = test ?f, 'config/environment.rb'
-TestUnitHeckler.test_pattern = "test/**/*.rb" if looks_like_rails
-
-opts.parse!
-
-impl = ARGV.shift
-meth = ARGV.shift
-
-unless impl then
-  puts opts
-  exit 1
-end
-
-exit TestUnitHeckler.validate(impl, meth, nodes, force)
+require 'heckle_runner'
 
+exit HeckleRunner.run

data/lib/heckle.rb

@@ -1,5 +1,5 @@
 require 'rubygems'
-require 'parse_tree'
+require 'ruby_parser'
 require 'sexp_processor'
 require 'ruby2ruby'
 require 'timeout'
@@ -11,6 +11,17 @@ class String # :nodoc:
   end
 end
 
+class Sexp
+  # REFACTOR: move to sexp.rb
+  def each_sexp
+    self.each do |sexp|
+      next unless Sexp === sexp
+
+      yield sexp
+    end
+  end
+end
+
 ##
 # Test Unit Sadism
 
@@ -21,7 +32,7 @@ class Heckle < SexpProcessor
   ##
   # The version of Heckle you are using.
 
-  VERSION = '1.4.3'
+  VERSION = '2.0.0.b1'
 
   ##
   # Branch node types.
@@ -131,9 +142,11 @@ class Heckle < SexpProcessor
 
     @mutated = false
 
+    @original_tree = rewrite find_scope_and_method
+    @current_tree = @original_tree.deep_clone
+
     grab_mutatees
 
-    @original_tree = current_tree.deep_clone
     @original_mutatees = mutatees.deep_clone
   end
 
@@ -203,21 +216,23 @@ class Heckle < SexpProcessor
   end
 
   def heckle(exp)
-    exp_copy = exp.deep_clone
+    @current_tree = exp.deep_clone
     src = begin
             Ruby2Ruby.new.process(exp)
           rescue => e
-            puts "Error: #{e.message} with: #{klass_name}##{method_name}: #{exp_copy.inspect}"
+            puts "Error: #{e.message} with: #{klass_name}##{method_name}: #{@current_tree.inspect}"
             raise e
           end
 
-    original = Ruby2Ruby.new.process(@original_tree.deep_clone)
-    @reporter.replacing(klass_name, method_name, original, src) if @@debug
+    if @@debug
+      original = Ruby2Ruby.new.process(@original_tree.deep_clone)
+      @reporter.replacing(klass_name, method_name, original, src)
+    end
 
-    clean_name = method_name.to_s.gsub(/self\./, '')
     self.count += 1
-    new_name = "h#{count}_#{clean_name}"
 
+    clean_name = method_name.to_s.gsub(/self\./, '')
+    new_name = "h#{count}_#{clean_name}"
     klass = aliasing_class method_name
     klass.send :remove_method, new_name rescue nil
     klass.send :alias_method, new_name, clean_name
@@ -499,13 +514,102 @@ class Heckle < SexpProcessor
   end
 
   def current_tree
-    ur = Unifier.new
+    @current_tree.deep_clone
+  end
+
+  # Copied from Flay#process
+  def find_scope_and_method
+    expand_dirs_to_files.each do |file|
+      #warn "Processing #{file}" if option[:verbose]
 
-    sexp = ParseTree.translate(klass_name.to_class, method_name)
-    raise "sexp invalid for #{klass_name}##{method_name}" if sexp == [nil]
-    sexp = ur.process(sexp)
+      ext = File.extname(file).sub(/^\./, '')
+      ext = "rb" if ext.nil? || ext.empty?
+      msg = "process_#{ext}"
 
-    rewrite sexp
+      unless respond_to? msg then
+        warn " Unknown file type: #{ext}, defaulting to ruby"
+        msg = "process_rb"
+      end
+
+      begin
+        sexp = begin
+                 send msg, file
+               rescue => e
+                 warn " #{e.message.strip}"
+                 warn " skipping #{file}"
+                 nil
+               end
+
+        next unless sexp
+
+        found = find_scope sexp
+
+        return found if found
+      rescue SyntaxError => e
+        warn " skipping #{file}: #{e.message}"
+      end
+    end
+
+    raise "Couldn't find method."
+  end
+
+  def process_rb file
+    RubyParser.new.process(File.read(file), file)
+  end
+
+  def find_scope sexp, nesting=nil
+    nesting ||= klass_name.split("::").map {|k| k.to_sym }
+    current, *nesting = nesting
+
+    sexp = s(:block, sexp) unless sexp.first == :block
+
+    sexp.each_sexp do |node|
+      next unless [:class, :module].include? node.first
+      next unless node[1] == current
+
+      block = node.detect {|s| Sexp === s && s[0] == :scope }[1]
+
+      if nesting.empty?
+        return sexp if method_name.nil?
+
+        m = find_method block
+
+        return m if m
+      else
+        s =  find_scope block, nesting
+
+        return s if s
+      end
+    end
+
+    nil
+  end
+
+  def find_method sexp
+    class_method = method_name.to_s =~ /^self\./
+    clean_name = method_name.to_s.sub(/^self\./, '').to_sym
+
+    sexp = s(:block, sexp) unless sexp.first == :block
+
+    sexp.each_sexp do |node|
+      if class_method
+        return node if node[0] == :defs && node[2] == clean_name
+      else
+        return node if node[0] == :defn && node[1] == clean_name
+      end
+    end
+
+    nil
+  end
+
+  def expand_dirs_to_files(dirs='.')
+    Array(dirs).flatten.map { |p|
+      if File.directory? p then
+        Dir[File.join(p, '**', "*.rb")]
+      else
+        p
+      end
+    }.flatten
   end
 
   def reset
@@ -518,6 +622,8 @@ class Heckle < SexpProcessor
     return unless original_tree != current_tree
     @mutated = false
 
+    @current_tree = original_tree.deep_clone
+
     self.count += 1
 
     clean_name = method_name.to_s.gsub(/self\./, '')
@@ -600,7 +706,7 @@ class Heckle < SexpProcessor
   end
 
   def current_code
-    Ruby2Ruby.translate(klass_name.to_class, method_name)
+    Ruby2Ruby.new.process current_tree
   end
 
   ##
@@ -744,7 +850,7 @@ class Heckle < SexpProcessor
   # All nodes that can be mutated by Heckle.
 
   MUTATABLE_NODES = instance_methods.grep(/mutate_/).sort.map do |meth|
-    meth.sub(/mutate_/, '').intern
+    meth.to_s.sub(/mutate_/, '').intern
   end - [:asgn, :node] # Ignore these methods
 
   ##

data/lib/heckle_runner.rb

@@ -0,0 +1,113 @@
+require 'optparse'
+require 'heckle'
+require 'minitest_heckler'
+
+class HeckleRunner
+  def self.run argv=ARGV
+    options = parse_args argv
+
+    class_or_module, method = argv.shift, argv.shift
+
+    new(class_or_module, method, options).run
+  end
+
+  def self.parse_args argv
+    options = {
+      :force => false,
+      :nodes => Heckle::MUTATABLE_NODES,
+      :debug => false,
+      :focus => false,
+      :timeout => 5,
+      :test_pattern => 'test/test_*.rb',
+    }
+
+    OptionParser.new do |opts|
+      opts.version = Heckle::VERSION
+      opts.program_name = File.basename $0
+      opts.banner = "Usage: #{opts.program_name} class_name [method_name]"
+      opts.on("-v", "--verbose", "Loudly explain heckle run") do
+        options[:debug] = true
+      end
+
+      opts.on("-t", "--tests TEST_PATTERN",
+              "Location of tests (glob)") do |pattern|
+        options[:test_pattern] = pattern
+      end
+
+      opts.on("-F", "--force", "Ignore initial test failures",
+              "Best used with --focus") do
+        options[:force] = true
+      end
+
+      opts.on(      "--assignments", "Only mutate assignments") do
+        puts "!"*70
+        puts "!!! Heckling assignments only"
+        puts "!"*70
+        puts
+
+        options[:nodes] = Heckle::ASGN_NODES
+      end
+
+      opts.on("-b", "--branches", "Only mutate branches") do
+        puts "!"*70
+        puts "!!! Heckling branches only"
+        puts "!"*70
+        puts
+
+        options[:nodes] = Heckle::BRANCH_NODES
+      end
+
+      opts.on("-f", "--focus", "Apply the eye of sauron") do
+        puts "!"*70
+        puts "!!! Running in focused mode. FEEL THE EYE OF SAURON!!!"
+        puts "!"*70
+        puts
+
+        options[:focus] = true
+      end
+
+      opts.on("-T", "--timeout SECONDS", "The maximum time for a test run in seconds",
+                                         "Used to catch infinite loops") do |timeout|
+        timeout = timeout.to_i
+        puts "Setting timeout at #{timeout} seconds."
+        options[:timeout] = timeout
+      end
+
+      opts.on("-n", "--nodes NODES", "Nodes to mutate",
+              "Possible values: #{Heckle::MUTATABLE_NODES.join(',')}") do |opt|
+        nodes = opt.split(',').collect {|n| n.to_sym }
+        options[:nodes] = nodes
+        puts "Mutating nodes: #{nodes.inspect}"
+      end
+
+      opts.on("-x", "--exclude-nodes NODES", "Nodes to exclude") do |opt|
+        exclusions = opt.split(',').collect {|n| n.to_sym }
+        options[:nodes] = options[:nodes] - exclusions
+        puts "Mutating without nodes: #{exclusions.inspect}"
+      end
+    end.parse! argv
+
+    p options if options[:debug]
+
+    # TODO: Pass options to Heckle's initializer instead.
+    Heckle.debug = options[:debug]
+    Heckle.timeout = options[:timeout]
+
+    options
+  end
+
+  # TODO: this sucks
+  def heckler
+    MiniTestHeckler
+  end
+
+  def initialize class_or_module, method, options={}
+    @class_or_module = class_or_module
+    @method = method
+    @options = options
+  end
+
+  def run
+    heckler.new(@class_or_module, @method, @options).validate
+  end
+end