rspec 0.5.8 → 0.5.9

data/CHANGES

@@ -1,5 +1,12 @@
 = RSpec Changelog
 
+== Version 0.5.9
+This release improves test2spec by allowing more control over the output
+
+* Added --template option to test2spec, which allows for custom output driven by ERB
+* Added --quiet option to test2spec
+* Removed unnecessary dependency on RubyToC
+
 == Version 0.5.8
 This release features a new Test::Unit to RSpec translation tool.
 Also note that the RubyGem of the previous release (0.5.7) was corrupt.

data/README

@@ -1 +1,17 @@
-See http://rspec.rubyforge.org for detailed documentation.
+In order to run RSpec's tests and generate the website, you must have RubyGems.
+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)
+* 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.
+
+See http://rspec.rubyforge.org for further documentation.

data/Rakefile

@@ -45,8 +45,13 @@ Rcov::RcovTask.new do |t|
   t.rcov_opts = []
 end
 
+desc 'Translate our own tests to specs'
+task :test2spec do
+  `bin/test2spec --template spec/test2spec.erb --specdir spec test`
+end
+
 desc 'Generate HTML documentation'
-task :doc do
+task :doc => :test2spec do
   sh %{pushd doc; webgen; popd}
 end
 
@@ -114,6 +119,7 @@ end
 
 task :clobber do
   rm_rf 'doc/output'
+  rm_rf 'spec/spec'
 end
 
 task :release => [:clobber, :verify_committed, :verify_user, :verify_password, :test, :publish_packages, :tag, :publish_website, :publish_news]

data/bin/test2spec

@@ -25,6 +25,18 @@ opts = OptionParser.new do |opts|
     $test2spec_options[:specdir] = dir
   end
 
+  opts.on("-t", "--template FILE", 
+    "ERB template that will be used to create each file. The template",
+    "has access toi 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 %>"
+  ) do |file|
+    $test2spec_options[:template] = file
+  end
+
   opts.on("-c", "--chmod MODIFIERS", Integer, "Change file modifiers on written files (POSIX only)") do |mods|
     $test2spec_options[:chmod] = mods
   end
@@ -37,13 +49,17 @@ opts = OptionParser.new do |opts|
     $test2spec_options[:collision] = :force
   end
 
+  opts.on("-q", "--quiet", "Don't print anything to stdout") do
+    $test2spec_options[:quiet] = true
+  end
+
   opts.on("-v", "--version", "Show version") do
     puts "test2spec #{Spec::VERSION::DESCRIPTION}"
     exit
   end
 
   opts.on("-d", "--dry-run", "Don't write anything - just verify that translation works") do
-    options.dry_run = true
+    $test2spec_options[:dry_run] = true
   end
 
   opts.on_tail("-h", "--help", "You're looking at it") do

data/doc/src/tools/test2spec.page

@@ -7,7 +7,7 @@ h2. Test::Unit migration
 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.
-RubyInline only work on systems that have a C compiler - i.e. most anything except Windows.
+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.
 Once translated they can run on any Ruby platform (including Windows). After all, it's
@@ -23,17 +23,24 @@ test2spec --help
 A typical invocation might look like this:
 
 <pre>
-test2spec --specdir spec test
+test2spec --template spec/test2spec.erb --specdir spec test
 </pre>
 
-h2. Sample output
+Where spec/test2spec.erb contains the following:
+
+<pre>
+{includeFile: {filename: ../../../spec/test2spec.erb, processOutput: false}}
+</pre>
+
+
+h2. Sample translation
 
 <notextile>
 <table>
   <thead>
     <tr>
-      <td>Test::Unit</td>
-      <td>RSpec (translated by test2spec)</td>
+      <td>Test::Unit (input)</td>
+      <td>RSpec (output)</td>
     </tr>
   </thead>
   <tbody>
@@ -42,13 +49,22 @@ h2. Sample output
         <ruby file="../test/spec/tool/test_unit_api_test.rb"/>
       </td>
       <td>
-        <ruby file="../test/spec/tool/test_unit_api_spec.rb"/>
+        <ruby file="../spec/spec/tool/test_unit_api_spec.rb"/>
       </td>
     </tr>
   </tbody>
 </table>
 </notextile>
 
+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*.
+
+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.
+
 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/tool/ruby2ruby.rb

@@ -1,10 +1,12 @@
 # Taken from http://dark.fhtr.org/ruby2ruby.rb
 
 require 'rubygems'
-require 'parse_tree'
-require 'support'
-require 'sexp_processor'
-
+begin
+  require 'parse_tree'
+  require 'sexp_processor'
+rescue LoadError
+  $stderr.puts "You must gem install ParseTree (and RubyInline)"
+end
 
 class RubySource < String
 
@@ -72,7 +74,6 @@ class RubyToRuby < SexpProcessor
 
   def initialize
     super
-    @env = Environment.new
     @indent = "  "
     self.auto_shift_type = true
     self.strict = true

data/lib/spec/tool/translation_test_runner.rb

@@ -1,5 +1,6 @@
 require 'spec/tool/test_unit_translator'
 require 'fileutils'
+require 'erb'
 
 module Spec
   module Tool
@@ -12,7 +13,7 @@ module Spec
       end
       
       def initialize(suite)
-        puts "Writing translated specs to #{$test2spec_options[:specdir]}"
+        log "Writing translated specs to #{$test2spec_options[:specdir]}"
         translator = TestUnitTranslator.new
         ObjectSpace.each_object(Class) do |klass|
           if klass < ::Test::Unit::TestCase
@@ -21,14 +22,17 @@ module Spec
               
               unless $test2spec_options[:dry_run]
                 relative_path = underscore(klass.name)
+                template = $test2spec_options[:template] ? IO.read($test2spec_options[:template]) : nil
+                source = render(translation, relative_path, template)
+
                 relative_path.gsub! /_test$/, "_spec"
                 relative_path += ".rb"
-                write(translation, relative_path)
+                write(source, relative_path)
               else
-                puts "Successfully translated #{klass}"
+                log "Successfully translated #{klass}"
               end
             rescue SexpProcessorError => e
-              puts "Failed to translate     #{klass}"
+              log "Failed to translate     #{klass}"
             end
           end
         end
@@ -40,6 +44,24 @@ module Spec
       end
 
     private
+    
+      def render(translation, relative_path, template)
+        unless template.nil?
+          depth = relative_path.split('/').length-1
+          erb = ERB.new(template)
+          erb.result(binding)
+        else
+          translation
+        end
+      end
+
+      def log(msg)
+        puts msg unless quiet?
+      end
+
+      def quiet?
+        $test2spec_options[:quiet] == true
+      end
 
       def destination_path(relative_destination)
         File.join($test2spec_options[:specdir], relative_destination)
@@ -49,7 +71,7 @@ module Spec
         destination         = destination_path(relative_destination)
         destination_exists  = File.exists?(destination)
         if destination_exists and identical?(source, destination)
-          return puts("Identical : #{relative_destination}")
+          return log("Identical : #{relative_destination}")
         end
 
         if destination_exists
@@ -57,21 +79,19 @@ module Spec
             when :ask   then force_file_collision?(relative_destination)
             when :force then :force
             when :skip  then :skip
-            else raise "Invalid collision option: #{$test2spec_options[:collision].inspect}"
           end
 
           case choice
-            when :force then puts("Forcing   : #{relative_destination}")
-            when :skip  then return(puts("Skipping  : #{relative_destination}"))
-            else raise "Invalid collision choice: #{choice}.inspect"
+            when :force then log("Forcing   : #{relative_destination}")
+            when :skip  then return(log("Skipping  : #{relative_destination}"))
           end
         else
           dir = File.dirname(destination)
           unless File.directory?(dir)
-            puts "Creating  : #{dir}"
+            log "Creating  : #{dir}"
             mkdir_p dir
           end
-          puts "Creating  : #{destination}"
+          log "Creating  : #{destination}"
         end
 
         File.open(destination, 'w') do |df|
@@ -96,10 +116,10 @@ module Spec
         case $stdin.gets
           when /a/i
             $test2spec_options[:collision] = :force
-            $stdout.puts "Forcing ALL"
+            log "Forcing ALL"
             :force
           when /q/i
-            $stdout.puts "Quitting"
+            puts "Quitting"
             raise SystemExit
           when /n/i then :skip
           else :force

data/lib/spec/version.rb

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

metadata

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