rspec 0.5.10 → 0.5.11

data/CHANGES

@@ -1,5 +1,12 @@
 = RSpec Changelog
 
+== Version 0.5.11
+This release makes test2spec usable with Rails (with some manual steps). 
+See http://rspec.rubyforge.org/tools/rails.html for more details
+
+* test2spec now correctly translates bodies of helper methods (non- test_*, setup and teardown ones).
+* Added more documentation about how to get test2spec to work with Rails.
+
 == Version 0.5.10
 This version features a second rewrite of test2spec - hopefully better than the previous one.
 

data/doc/src/tools/rails.page

@@ -84,3 +84,49 @@ Model:
 
 Controller:
 <ruby file="../vendor/rspec_on_rails/spec/controllers/person_controller_spec.rb"/>
+
+h3. Translating existing Test::Unit tests
+
+The test2spec tool that ships with RSpec translates existing tests into RSpec specs. 
+Translating tests to specs in a Rails environment requires some manual steps...
+
+h4. Install the rspec_generator
+How to do this is described above
+
+h4. Modify your test/test_helper.rb
+In order to be able to translate any Rails tests, you must modify your test/test_helper.rb file:
+<pre>
+# This line must be commented out in order for test2spec to work.
+# require 'test_help'
+require 'test2spec_help'
+</pre>
+
+The reason for this is that the <tt>test_help</tt> mixin confuses test2spec to the point
+where it's unable to perform the translation. The <tt>test2spec_help</tt> addresses this
+shortcoming.
+
+h4. Perform the translations
+Now you can translate your unit tests (model tests) with:
+<pre>
+test2spec --template spec/test2spec.erb --specdir spec/models test/unit
+</pre>
+and your functional tests (controller tests) with:
+<pre>
+test2spec --template spec/test2spec.erb --specdir spec/controllers test/functional
+</pre>
+
+h4. Edit your translated specs
+test2spec currently doesn't translate class-level statements such as <tt>fixtures</tt>, so you have to do this yourself.
+Copy all the <tt>fixtures</tt> statements in your tests to the corresponding contexts. Example:
+
+<ruby>
+context "The Foo Model" do
+  fixtures :foo
+end
+</ruby>
+
+h4. Make sure fixtures are found.
+By default, RSpec on Rails expects to find fixtures under <tt>spec/fixtures</tt>. You should either move your
+existing <tt>test/fixtures/*.yml</tt> files to <tt>spec/fixtures</tt> or edit your <tt>spec/spec_helper.rb</tt>
+to point to the old <tt>test/fixtures</tt> location. Beware that every time you do a <tt>script/generate rspec_model</tt>,
+new fixstures will always be written to <tt>spec/fixtures</tt>.

data/doc/src/tools/test2spec.page

@@ -59,12 +59,23 @@ h2. Sample translation
 h2. What's translated?
 
 test2spec only translates classes that extend from Test::Unit - and their methods. It will not bring over any 
-code that isn't inside a Test::Unit class. This means that require statements at the top of your file, any other
-classes in the same file as the test class etc *will not be translated*.
+code that isn't inside a Test::Unit class. This means that require statements at the top of your file, any 
+non-Test::Unit classes (even if they are in in the same file as the test class) *will not be translated*.
+
+We recommend that you manually write a spec_helper.rb file with require statements and put it at the top 
+of your spec directory. Also, write a test2spec.erb file that will put a <tt>require</tt> of that file at 
+the top of each translated spec. Use the <tt>--template</tt> option to specify this erb file when you run test2spec.
+
+Sometimes, test classes have helper methods that don't start with test_ (and that are not setup or teardown).
+These methods will be moved inside the setup block, and will also have any core Test::Unit assert_* methods
+translated. (Non-Test::Unit core assert_ methods will not be translated.)
 
 So, there is a fair chance that you will have to do some manual editing after test2spec has run. We're only
 aiming to get most of the translation job done for you - not all of it.
 
+If you're translating Rails tests, please refer to the RSpec on Rails page for more detail of what needs to 
+be done.
+
 h2. Troubleshooting
 
 In some cases, test2spec will not be able to translate a test class. In that case, please submit a bug report

data/lib/spec/test_to_spec/ruby2ruby.rb

@@ -1,5 +1,6 @@
 # Taken from http://dark.fhtr.org/ruby2ruby.rb
 
+require 'pp'
 require 'rubygems'
 begin
   require 'parse_tree'
@@ -484,7 +485,8 @@ class RubyToRuby < SexpProcessor
   end
 
   def process_bmethod(exp)
-    raise "FIXME"
+    exp.clear
+    ""
   end
 
 end

data/lib/spec/test_to_spec/sexp_transformer.rb

@@ -30,11 +30,7 @@ module Spec
       def initialize
         super
         self.expected = Array
-      end
-      
-      def process(exp)
-#puts "PROCESS:#{exp[0]}"
-super
+        @regular_method = false
       end
       
       def process_class(exp)
@@ -61,10 +57,15 @@ super
         unless setup.empty?
           setup_block = process(setup.shift)
           unless methods.empty?
+            translated_methods = []
+            # At this stage we don't want to translate :lvar to :dvar
+            @regular_method = true
+            translated_methods << process(methods.shift) until methods.empty?
+            @regular_method = false
             if setup_block.length == 3
-              setup_block += methods
+              setup_block += translated_methods
             else
-              setup_block[3] += methods
+              setup_block[3] += translated_methods
             end
           end
           context_body << setup_block
@@ -109,20 +110,26 @@ super
           result[-1] += @dasgn_decl unless @dasgn_decl.empty?
           result[-1] += block_body unless block_body == [[:nil]]
           result
+        else
+          # Return the same method, but process the innards
+          result = [exp.shift, exp.shift] + process(exp)
+          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
+        unless @regular_method
+          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
+        end
         result
       end
 
@@ -180,8 +187,10 @@ super
       
       def process_lvar(exp)
         result = exp.dup
-        result[0] = :dvar
         exp.clear
+        unless @regular_method
+          result[0] = :dvar
+        end
         result
       end
     end

data/lib/spec/test_to_spec/translation_test_runner.rb

@@ -30,8 +30,10 @@ module Spec
               else
                 log "Successfully translated #{klass}"
               end
-            rescue SexpProcessorError => e
+            rescue => e
               log "Failed to translate     #{klass}"
+              log "Message: #{e.message}"
+              log e.backtrace.join("\n")
             end
           end
         end

data/lib/spec/version.rb

@@ -3,7 +3,7 @@ module Spec
     unless defined? MAJOR
       MAJOR  = 0
       MINOR  = 5
-      TINY   = 10
+      TINY   = 11
 
       STRING = [MAJOR, MINOR, TINY].join('.')
       TAG    = "REL_" + [MAJOR, MINOR, TINY].join('_')

data/test/spec/test_to_spec/sexp_transformer_test.rb

@@ -168,6 +168,32 @@ module Spec
         end
       end
     end
+    
+    class NinthTest < Test::Unit::TestCase
+      def test_2_should_be_pair
+        foo = 1
+        assert_pair(2)
+      end
+      
+      def assert_pair(n)
+        assert_equal 0, n%2
+      end
+    end
+    class NinthContext
+      def wrapper
+        context "Ninth" do
+          setup do
+            def assert_pair(n)
+              (n%2).should_equal 0
+            end
+          end
+          specify "2 should be pair" do
+            foo = 1
+            assert_pair(2)
+          end
+        end
+      end
+    end
 
     class SexpTransformerTest < Test::Unit::TestCase
       def test_first
@@ -202,13 +228,59 @@ module Spec
         should_translate_class_to_context('Eighth')
       end
 
-      def should_translate_class_to_context(name)
-        t = test_class_exp(eval("#{name}Test"))
-        c = context_exp(eval("#{name}Context"))
+      def test_ninth
+        should_translate_class_to_context('Ninth')
+      end
+
+      class Something
+        def method_with_asserts
+          assert_equal 2, 3
+        end
+      end
+      class SomethingTranslated
+        def method_with_asserts
+          3.should_equal 2
+        end
+      end
+      def test_translates_regular_method_bodies
+        something = ParseTree.new.parse_tree_for_method(Something, :method_with_asserts)
+        expected_something_translated = ParseTree.new.parse_tree_for_method(SomethingTranslated, :method_with_asserts)
+        actual_something_translated = @t.process(something)
+        verify_sexp_equal expected_something_translated, actual_something_translated
+      end
+
+      def should_translate_class_to_context(name, debug=false)
+        test_class_name = "#{name}Test"
+        context_class_name = "#{name}Context"
+        t = test_class_exp(eval(test_class_name))
+        if(debug)
+          puts "ORIGINAL"
+          pp t
+        end
+        c = wrapper_exp(eval(context_class_name))
 
         trans = @t.process(t)
+
         verify_sexp_equal c, trans
-        
+
+=begin
+        if c != trans
+          # Try to print out the Ruby2Ruby of the trans
+          begin
+            trans2ruby = @r2r.process(trans.dup[0])
+            # Parse the translation again
+            retranslated_class_name = "#{context_class_name}Retranslated"
+            eval "class #{retranslated_class_name}\ndef wrapper\n#{trans2ruby}\nend\nend"
+            retranslated_class = eval(retranslated_class_name)
+            retranslated_tree = wrapper_exp(retranslated_class)
+            retranslated_tree
+            verify_sexp_equal c, retranslated_tree
+          rescue SexpProcessorError => e
+            # That didn't work, just print the tree
+            verify_sexp_equal c, trans
+          end
+        end
+=end        
         # Verify that we can evaluate it after translated by R2R
         eval(@r2r.process(trans[0]))
       end
@@ -217,9 +289,7 @@ module Spec
         ParseTree.new.parse_tree(klass)[0]
       end
 
-      def context_exp(klass)
-#pp ParseTree.new.parse_tree_for_method(klass, :wrapper)
-#exit
+      def wrapper_exp(klass)
         ParseTree.new.parse_tree_for_method(klass, :wrapper)[2][1][2..-1]
       end
 

data/test/spec/test_to_spec/testfiles/test_unit_api_test.rb

@@ -9,10 +9,16 @@ class TestUnitApiTest < Test::Unit::TestCase
   def teardown
   end
 
+  def assert_pair(n)
+    assert_equal 0, n%2
+  end
+
   def test_can_be_translated_to_rspec
     a_float = 123.45
     a_nil = nil
 
+    assert_pair(2)
+
     assert true
     assert_not_nil @an_int
     assert_block { true }

metadata

@@ -3,9 +3,9 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: rspec
 version: !ruby/object:Gem::Version 
-  version: 0.5.10
-date: 2006-06-14 00:00:00 -05:00
-summary: RSpec-0.5.10 - BDD for Ruby http://rspec.rubyforge.org/
+  version: 0.5.11
+date: 2006-06-15 00:00:00 -05:00
+summary: RSpec-0.5.11 - BDD for Ruby http://rspec.rubyforge.org/
 require_paths: 
 - lib
 email: rspec-devel@rubyforge.org