rspec 0.5.9 → 0.5.10

data/CHANGES

@@ -1,5 +1,10 @@
 = RSpec Changelog
 
+== Version 0.5.10
+This version features a second rewrite of test2spec - hopefully better than the previous one.
+
+* Improved test2spec's internals. It now transforms the syntax tree before writing out the code.
+
 == Version 0.5.9
 This release improves test2spec by allowing more control over the output
 

data/README

@@ -3,15 +3,16 @@ Then you must install the following gems:
 
 * rake
 * rcov
-* RubyInline
 * ParseTree   (Ignore the message: test/test_parse_tree.rb:190:38: ':' not followed by identified or operator)
+* RubyInline
 * webgen
 * RedCloth
 * syntax
 
 Note that RSpec itself - once built - doesn't have any dependencies outside the Ruby core 
 and stdlib - with a few exceptions:
-* test2spec uses RubyInline, RubyToC and ParseTree
-* The spectask needs rcov if rcov is enabled.
+
+* The test2spec command line uses ParseTree and RubyInline
+* The Spec::Rake::SpecTask needs RCov if RCov is enabled in the task.
 
 See http://rspec.rubyforge.org for further documentation.

data/Rakefile

@@ -6,8 +6,6 @@ require 'rake/clean'
 require 'rake/testtask'
 require 'rake/rdoctask'
 require 'spec/version'
-require 'spec/rake/spectask'
-require 'spec/rake/rcov_verify'
 require 'rcov/rcovtask'
 
 # Some of the tasks are in separate files since they are also part of the website documentation
@@ -27,7 +25,7 @@ PKG_FILES = FileList[
   'doc/**/*'
 ]
 
-task :default => [:test]
+task :default => :test
 
 desc "Run all failing examples"
 Spec::Rake::SpecTask.new('failing_examples') do |t|
@@ -47,12 +45,18 @@ end
 
 desc 'Translate our own tests to specs'
 task :test2spec do
-  `bin/test2spec --template spec/test2spec.erb --specdir spec test`
+  `bin/test2spec --force --template spec/test2spec.erb --specdir spec/translated test`
 end
 
 desc 'Generate HTML documentation'
-task :doc => :test2spec do
-  sh %{pushd doc; webgen; popd}
+task :webgen => :test2spec do
+  Dir.chdir 'doc' do
+    output = nil
+    IO.popen('webgen 2>&1') do |io|
+      output = io.read
+    end
+    raise "ERROR while running webgen: #{output}" if output =~ /ERROR/n || $? != 0
+  end
 end
 
 desc 'Generate RDoc'
@@ -119,7 +123,7 @@ end
 
 task :clobber do
   rm_rf 'doc/output'
-  rm_rf 'spec/spec'
+  rm_rf 'spec/translated'
 end
 
 task :release => [:clobber, :verify_committed, :verify_user, :verify_password, :test, :publish_packages, :tag, :publish_website, :publish_news]
@@ -141,7 +145,7 @@ task :tag do
 end
 
 desc "Build the website with rdoc and rcov, but do not publish it"
-task :website => [:clobber, :rcov_verify, :doc, :examples_specdoc, :rdoc]
+task :website => [:clobber, :rcov_verify, :webgen, :examples_specdoc, :rdoc]
 
 task :verify_user do
   raise "RUBYFORGE_USER environment variable not set!" unless ENV['RUBYFORGE_USER']

data/bin/test2spec

@@ -7,10 +7,10 @@ require 'test/unit/ui/testrunnermediator'
 require 'test/unit/autorunner'
 require 'optparse'
 
-$LOAD_PATH.push File.dirname(__FILE__) + '/../lib'
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
 
 require 'rubygems'
-require 'spec/tool/translation_test_runner'
+require 'spec/test_to_spec/translation_test_runner'
 require 'spec/version'
 
 $test2spec_options = {
@@ -26,13 +26,11 @@ opts = OptionParser.new do |opts|
   end
 
   opts.on("-t", "--template FILE", 
-    "ERB template that will be used to create each file. The template",
-    "has access toi the following variables:",
+    "ERB template that will be used to decorate each translated file.",
+    "The template has access to the following variables:",
     "  translation   : the translated source code",
     "  depth         : the directory depth of the file to be written",
-    "  relative_path : the relative name of the file to be written",
-    "Example:",
-    "<%= @translation %>"
+    "  relative_path : the relative name of the file to be written"
   ) do |file|
     $test2spec_options[:template] = file
   end
@@ -87,7 +85,7 @@ module Test
     class AutoRunner
       def initialize(standalone)
         @standalone = standalone
-        @runner = proc { |r| Spec::Tool::TranslationTestRunner }
+        @runner = proc { |r| Spec::TestToSpec::TranslationTestRunner }
         @collector = COLLECTORS[(standalone ? :dir : :objectspace)]
         @filters = []
         @to_run = []

data/doc/plugin/version.rb

@@ -0,0 +1,19 @@
+require 'webgen/plugins/tags/tags'
+require File.dirname(__FILE__) + '/../../lib/spec/version'
+
+module Tags
+
+  class VersionTag < DefaultTag
+
+    summary "Puts the version on the page" 
+    depends_on 'Tags'
+
+    tag 'version'
+
+    def process_tag(tag, node, refNode)
+      return Spec::VERSION::STRING
+    end
+
+  end
+
+end

data/doc/src/default.template

@@ -11,7 +11,7 @@
 <div id="container">
 	<div id="header">
         <h2>Behaviour Driven Development for <strong>Ruby</strong></h2>
-		<h1>RSpec</h1>
+		<h1>RSpec {version: }</h1>
 	</div>
 
 	<div id="navigation">

data/doc/src/tools/rake.page

@@ -4,7 +4,7 @@ inMenu: true
 ---
 h2. Rake Task
 
-RSpec coomes with a Rake task for executing specs.
+RSpec comes with a Rake task for executing specs.
 See "Spec::Rake::SpecTask":../rdoc/classes/Spec/Rake/SpecTask.html for details.
 
 h3. Run specs

data/doc/src/tools/test2spec.page

@@ -2,11 +2,11 @@
 title: Test::Unit Migration
 inMenu: true
 ---
-h2. Test::Unit migration
+h2. Overview of test2spec
 
 RSpec's test2spec command line tool translates existing Test::Unit classes to RSpec.  
 
-Before you can use test2spec you must gem install ParseTree and RubyInline.
+Before you can use test2spec you must gem install ParseTree (and RubyInline).
 RubyInline only works on systems that have a C compiler - i.e. most anything except Windows.
 
 If you're stuck on Windows, ask a friend who has a POSIX system to translate your specs.
@@ -46,10 +46,10 @@ h2. Sample translation
   <tbody>
     <tr>
       <td>
-        <ruby file="../test/spec/tool/test_unit_api_test.rb"/>
+        <ruby file="../test/spec/test_to_spec/testfiles/test_unit_api_test.rb"/>
       </td>
       <td>
-        <ruby file="../spec/spec/tool/test_unit_api_spec.rb"/>
+        <ruby file="../spec/translated/test_unit_api_spec.rb"/>
       </td>
     </tr>
   </tbody>
@@ -73,17 +73,20 @@ at RSpec's bug report system  along with some code so we can reproduce (and hope
 
 h2. Internals
 
-The test2spec tool is based on three other tools:
+The test2spec commandline 'runs' the tests with a special test runner - one that translates and writes out
+the translations to disk instead of actually executing the tests.
+
+The translation is done by the <tt>Test::Unit::TestCase#to_rspec</tt> method (which test2spec adds to all 
+test classes). This method will load the parse tree for the class, transform that tree to an RSpec context 
+and return the source code (using RubyToRuby).
+
+test2spec is based directly on two other tools:
 
 * "RubyToRuby":http://blog.zenspider.com/archives/2005/02/rubytoruby.html
 * "ParseTree":http://rubyforge.org/projects/parsetree/
-* "RubyInline":http://rubyforge.org/projects/rubyinline/
 
 In fact, it's based on a modified version of "George Moschovitis' RubyToRuby enhancement":http://dark.fhtr.org/ruby2ruby.rb
 of "Ryan Davis' original RubyToRuby":http://blog.zenspider.com/archives/2005/02/rubytoruby.html.
 
 It has been modified to fix some subtle bugs that were not found by Gerorge's tests. The modified RubyToRuby
 currently lives in RSpec's subversion repository.
-
-The translation is done by TestUnitTranslator - subclass of RubyToRuby that writes out the syntax tree a little differently than
-its superclass. TestUnitTranslator looks for certain Test::Unit patterns and writes out an RSpec translation instead.

data/lib/spec/rake/spectask.rb

@@ -85,7 +85,7 @@ module Rake
         specs = file_list
         raise "No spec files found." if specs.empty?
         
-        spec = File.dirname(__FILE__) + '/../../../bin/spec'
+        spec = File.expand_path(File.dirname(__FILE__) + '/../../../bin/spec')
         file_prefix = @rcov ? " -- " : ""
         interpreter = @rcov ? "rcov" : "ruby"
         redirect = @out.nil? ? "" : " > #{@out}"

data/lib/spec/runner/base_text_formatter.rb

@@ -62,11 +62,10 @@ module Spec
       end
       
       # This method is invoked at the very end.
-      def dump_summary(duration, context_count, spec_count, failure_count)
+      def dump_summary(duration, spec_count, failure_count)
         return if @dry_run
         @output << "\n"
         @output << "Finished in " << (duration).to_s << " seconds\n\n"
-        @output << "#{context_count} context#{'s' unless context_count == 1}, "
         @output << "#{spec_count} specification#{'s' unless spec_count == 1}, "
         @output << "#{failure_count} failure#{'s' unless failure_count == 1}"
         @output << "\n"

data/lib/spec/runner/reporter.rb

@@ -43,7 +43,7 @@ module Spec
       def dump
         @formatter.start_dump
         dump_failures
-        @formatter.dump_summary(duration, @context_names.length, @spec_names.length, @failures.length)
+        @formatter.dump_summary(duration, @spec_names.length, @failures.length)
         @failures.length
       end
 

data/lib/spec/{tool → test_to_spec}/ruby2ruby.rb

@@ -5,7 +5,7 @@ begin
   require 'parse_tree'
   require 'sexp_processor'
 rescue LoadError
-  $stderr.puts "You must gem install ParseTree (and RubyInline)"
+  raise "You must gem install ParseTree (and RubyInline)"
 end
 
 class RubySource < String
@@ -482,5 +482,9 @@ class RubyToRuby < SexpProcessor
     end
     code.join("\n")
   end
-  
+
+  def process_bmethod(exp)
+    raise "FIXME"
+  end
+
 end

data/lib/spec/test_to_spec/sexp_transformer.rb

@@ -0,0 +1,189 @@
+require 'sexp_processor'
+
+module Spec
+  module TestToSpec
+    # Transforms a Sexp tree (produced by ParseTree) for a Test::Unit class
+    # to an Sexp tree representing an RSpec context
+    class SexpTransformer < SexpProcessor
+      TRANSLATIONS = {
+        :assert_equal          => :should_equal,
+        :assert_not_equal      => :should_not_equal,
+        :assert_same           => :should_be,
+        :assert_not_same       => :should_not_be,
+        :assert_instance_of    => :should_be_instance_of,
+        :assert_kind_of        => :should_be_kind_of,
+        :assert_match          => :should_match,
+        :assert_no_match       => :should_not_match,
+        :assert_respond_to     => :should_respond_to,
+        :assert                => :should_be,
+        :assert_nil            => :should_be,
+        :assert_not_nil        => :should_not_be,
+        :assert_in_delta       => :should_be_close,
+        :assert_block          => :should_be,
+        :assert_raise          => :should_raise,
+        :assert_raises         => :should_raise,
+        :assert_nothing_raised => :should_not_raise,
+        :assert_throws         => :should_throw,
+        :assert_nothing_thrown => :should_not_throw,
+      }
+
+      def initialize
+        super
+        self.expected = Array
+      end
+      
+      def process(exp)
+#puts "PROCESS:#{exp[0]}"
+super
+      end
+      
+      def process_class(exp)
+        # Get the class header
+        exp.shift
+        class_name = exp.shift.to_s.split("::").last
+        context_name = class_name.match(/(.*)Test/)[1]
+        exp.shift
+
+        # Partition all methods (and other stuff) into chunks, as we're
+        # going to handle them a bit differently
+        rest = exp
+        setup,    rest = rest.partition{|e| e[0] == :defn && e[1].to_s == "setup"}
+        teardown, rest = rest.partition{|e| e[0] == :defn && e[1].to_s == "teardown"}
+        tests,    rest = rest.partition{|e| e[0] == :defn && e[1].to_s =~ /^test/}
+        methods,  rest = rest.partition{|e| e[0] == :defn}
+        
+        if !methods.empty? && setup.empty?
+          # We have some methods, but no setup to put them in. Create empty setup
+          setup[0] = [:defn, :setup, [:scope, [:block, [:args], [:nil]]]]
+        end
+        
+        context_body = []
+        unless setup.empty?
+          setup_block = process(setup.shift)
+          unless methods.empty?
+            if setup_block.length == 3
+              setup_block += methods
+            else
+              setup_block[3] += methods
+            end
+          end
+          context_body << setup_block
+        end
+        context_body << process(teardown.shift) until teardown.empty?
+        context_body << process(tests.shift)    until tests.empty?
+        context_body << process(rest.shift)     until rest.empty?
+        exp.clear
+
+        result = [:iter, [:fcall, :context, [:array, [:str, context_name]]], nil]
+        if context_body.length > 1
+          result << [:block] + context_body 
+        else
+          result += context_body
+        end
+        [result]
+      end
+      
+      def process_defn(exp)
+        method_name = exp[1].to_s
+        if method_name =~ /^test_(.*)/
+          spec_name = $1.gsub(/_/, " ")
+
+          test_body = exp[2][1][2..-1]
+          exp.clear
+          block_body = []
+          @dasgn_decl = []
+          block_body << process(test_body.shift) until test_body.empty?
+          result = [:iter, [:fcall, :specify, [:array, [:str, spec_name]]], nil]
+          result << [:block] unless block_body == [[:nil]]
+          result[-1] += @dasgn_decl unless @dasgn_decl.empty?
+          result[-1] += block_body unless block_body == [[:nil]]
+          result
+        elsif method_name == "setup" || method_name == "teardown"
+          test_body = exp[2][1][2..-1]
+          exp.clear
+          block_body = []
+          @dasgn_decl = []
+          block_body << process(test_body.shift) until test_body.empty?
+          result = [:iter, [:fcall, method_name.to_sym], nil]
+          result << [:block] unless block_body == [[:nil]]
+          result[-1] += @dasgn_decl unless @dasgn_decl.empty?
+          result[-1] += block_body unless block_body == [[:nil]]
+          result
+        end
+      end
+      
+      def process_lasgn(exp)
+        result = exp.dup
+        result[0] = :dasgn_curr
+        decl = result[0..1].dup
+        if @dasgn_decl.empty?
+          @dasgn_decl += [decl]
+        else
+          @dasgn_decl_tail << decl
+        end
+        @dasgn_decl_tail = decl
+        exp.clear
+        result
+      end
+
+      # Handles 'block' assert_ calls
+      def process_iter(exp)
+        test_unit_fcall = exp[1][1]
+        rspec_should = TRANSLATIONS[test_unit_fcall]
+        unless rspec_should.nil?
+          body = exp[3]
+          args = exp[1][2]
+          args.delete_at(2) unless args.nil? # get rid of the message arg
+          result = [:call, [:iter, [:fcall, :lambda], nil, body], rspec_should]
+          result << args unless args.nil?
+          result << [:array, [:true]] if test_unit_fcall == :assert_block
+          exp.clear
+          result
+        else
+          exp.shift
+          result = [:iter]
+          result << process(exp.shift) until exp.empty?
+          result
+        end
+      end
+
+      # Handles regular assert_ calls
+      def process_fcall(exp)
+        test_unit_fcall = exp[1]
+        rspec_should = TRANSLATIONS[test_unit_fcall]
+        unless rspec_should.nil?
+          args = exp[2]
+          actual_index = [:assert, :assert_not_nil, :assert_nil, :assert_respond_to].index(test_unit_fcall) ? 1 : 2
+          actual = args.delete_at(actual_index)
+          expected = args
+          if test_unit_fcall == :assert_in_delta
+            expected.delete_at(3)
+            expected << args.delete_at(2)
+          else
+            msg_index = (test_unit_fcall == :assert_respond_to) ? 2 : actual_index
+            expected.delete_at(msg_index)
+          end
+          expected << [:true] if test_unit_fcall == :assert
+          expected << [:nil] if [:assert_not_nil, :assert_nil].index(test_unit_fcall)
+          
+          actual = process(actual)
+          
+          result = [:call, actual, rspec_should, expected]
+          exp.clear
+          result
+        else
+          result = exp.dup
+          exp.clear
+          result
+        end
+      end
+      
+      def process_lvar(exp)
+        result = exp.dup
+        result[0] = :dvar
+        exp.clear
+        result
+      end
+    end
+  end
+end