rspec 0.5.11 → 0.5.12

data/CHANGES

@@ -1,5 +1,17 @@
 = RSpec Changelog
 
+== Version 0.5.12
+This release adds diff support for failure messages, a HTML formatter plus some other
+minor enhancements.
+
+* Added HTML formatter.
+* Added fail_on_error option to spectask.
+* Added support for diffing, using the lcs-diff Rubygem (#2648).
+* Remove RSpec on Rails files from backtrace (#4694).
+* All of RSpec's own tests run successfully after translation with test2spec.
+* Added --verbose mode for test2spec - useful for debugging when classes fail to translate.
+* Output of various formatters is now flushed - to get more continuous output.
+
 == 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

data/README

@@ -1,4 +1,4 @@
-In order to run RSpec's tests and generate the website, you must have RubyGems.
+In order to run RSpec's tests and generate the gem and the website, you must have RubyGems.
 Then you must install the following gems:
 
 * rake
@@ -8,11 +8,13 @@ Then you must install the following gems:
 * webgen
 * RedCloth
 * syntax
+* lcs-diff
 
 Note that RSpec itself - once built - doesn't have any dependencies outside the Ruby core 
 and stdlib - with a few exceptions:
 
-* The test2spec command line uses ParseTree and RubyInline
+* The spec command line uses lcs-diff when --diff is specified.
+* 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

@@ -12,6 +12,7 @@ require 'rcov/rcovtask'
 load File.dirname(__FILE__) + '/test/tasks/examples.rake'
 load File.dirname(__FILE__) + '/test/tasks/examples_specdoc.rake'
 load File.dirname(__FILE__) + '/test/tasks/examples_with_rcov.rake'
+load File.dirname(__FILE__) + '/test/tasks/failing_examples_with_html.rake'
 load File.dirname(__FILE__) + '/test/tasks/rcov_verify.rake'
 
 PKG_NAME = "rspec"
@@ -21,8 +22,7 @@ PKG_FILES = FileList[
   '[A-Z]*',
   'lib/**/*.rb', 
   'test/**/*.rb', 
-  'examples/**/*.rb', 
-  'doc/**/*'
+  'examples/**/*'
 ]
 
 task :default => :test
@@ -45,7 +45,17 @@ end
 
 desc 'Translate our own tests to specs'
 task :test2spec do
+  rm_rf 'spec/translated'
   `bin/test2spec --force --template spec/test2spec.erb --specdir spec/translated test`
+  # Remove the spec translations that we don't care about.
+  rm 'spec/translated/spec/test_to_spec/sexp_transformer_assertion_spec.rb'
+  rm 'spec/translated/spec/test_to_spec/sexp_transformer_spec.rb'
+end
+
+desc 'Runs all RSpec specs - translated with test2spec from our own tests'
+Spec::Rake::SpecTask.new('test2spec_test' => :test2spec) do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.options = ['--diff']
 end
 
 desc 'Generate HTML documentation'
@@ -126,7 +136,7 @@ task :clobber do
   rm_rf 'spec/translated'
 end
 
-task :release => [:clobber, :verify_committed, :verify_user, :verify_password, :test, :publish_packages, :tag, :publish_website, :publish_news]
+task :release => [:clobber, :test2spec_test, :verify_committed, :verify_user, :verify_password, :test, :publish_packages, :tag, :publish_website, :publish_news]
 
 desc "Verifies that there is no uncommitted code"
 task :verify_committed do
@@ -145,7 +155,7 @@ task :tag do
 end
 
 desc "Build the website with rdoc and rcov, but do not publish it"
-task :website => [:clobber, :rcov_verify, :webgen, :examples_specdoc, :rdoc]
+task :website => [:clobber, :rcov_verify, :webgen, :failing_examples_with_html, :examples_specdoc, :rdoc]
 
 task :verify_user do
   raise "RUBYFORGE_USER environment variable not set!" unless ENV['RUBYFORGE_USER']

data/bin/spec

@@ -5,13 +5,13 @@ $context_runner = ::Spec::Runner::OptionParser.create_context_runner(ARGV, false
 
 # If ARGV is a glob, it will actually each over each one of the matching files.
 ARGV.each do |file_or_dir|
-	if File.directory?(file_or_dir)
-		Dir["#{file_or_dir}/**/*.rb"].each do |file| 
-		  require "#{file}"
-		end
-	else
-		require file_or_dir
-	end
+  if File.directory?(file_or_dir)
+    Dir["#{file_or_dir}/**/*.rb"].each do |file| 
+      require "#{file}"
+    end
+  else
+    require file_or_dir
+  end
 end
 
 $context_runner.run(true)

data/bin/test2spec

@@ -14,7 +14,8 @@ require 'spec/test_to_spec/translation_test_runner'
 require 'spec/version'
 
 $test2spec_options = {
-  :collision => :ask
+  :collision => :ask,
+  :verbose => false
 }
 
 opts = OptionParser.new do |opts|
@@ -51,6 +52,10 @@ opts = OptionParser.new do |opts|
     $test2spec_options[:quiet] = true
   end
 
+  opts.on("--verbose", "Be extra verbose (printing backtraces when classes can't be translated)") do
+    $test2spec_options[:verbose] = true
+  end
+
   opts.on("-v", "--version", "Show version") do
     puts "test2spec #{Spec::VERSION::DESCRIPTION}"
     exit
@@ -97,11 +102,11 @@ end
 
 # If ARGV is a glob, it will actually each over each one of the matching files.
 ARGV.each do |arg|
-	if File.directory?(arg)
-		Dir["#{arg}/**/*.rb"].each do |file| 
-		  require "#{file}"
-		end
-	else
-		require arg
-	end
+  if File.directory?(arg)
+    Dir["#{arg}/**/*.rb"].each do |file| 
+      require "#{file}"
+    end
+  else
+    require arg
+  end
 end

data/lib/spec/api/helper/diff.rb

@@ -0,0 +1,53 @@
+begin
+  require 'rubygems'
+  require 'diff/lcs/hunk'
+rescue LoadError
+  raise "You must gem install diff-lcs to use this feature"
+end
+
+module Spec
+  class ShouldBase
+    unless defined?(RSPEC_TESTING)
+      alias old_default_message default_message
+      def default_message(expectation, expected=:no_expectation_specified)
+        result = old_default_message(expectation, expected)
+        if expected.is_a?(String)
+          result << "\nDiff:" << diff_as_string(@target.to_s, expected)
+        end
+        result
+      end
+    end
+
+    # This is snagged from diff/lcs/ldiff.rb (which is a commandline tool)
+    def diff_as_string(data_old, data_new, format=:unified, context_lines=3)
+      data_old = data_old.split(/\n/).map! { |e| e.chomp }
+      data_new = data_new.split(/\n/).map! { |e| e.chomp }
+      output = ""
+      diffs = Diff::LCS.diff(data_old, data_new)
+      return output if diffs.empty?
+      oldhunk = hunk = nil  
+      file_length_difference = 0
+      diffs.each do |piece|
+        begin
+          hunk = Diff::LCS::Hunk.new(data_old, data_new, piece, context_lines,
+                                     file_length_difference)
+          file_length_difference = hunk.file_length_difference      
+          next unless oldhunk      
+          # Hunks may overlap, which is why we need to be careful when our
+          # diff includes lines of context. Otherwise, we might print
+          # redundant lines.
+          if (context_lines > 0) and hunk.overlaps?(oldhunk)
+            hunk.unshift(oldhunk)
+          else
+            output << oldhunk.diff(format)
+          end
+        ensure
+          oldhunk = hunk
+          output << "\n"
+        end
+      end  
+      #Handle the last remaining hunk
+      output << oldhunk.diff(format) << "\n"
+    end  
+  end
+end

data/lib/spec/api/helper/instance_helper.rb

@@ -1,15 +1,15 @@
 module Spec
 
-	class InstanceHelper < ShouldBase
-	
-		def initialize(target)
-			@target = target
-		end
-		
-		def of(expected_class)
-			fail_with_message(default_message("should be an instance of", expected_class)) unless @target.instance_of? expected_class
-		end
-		
-	end
+  class InstanceHelper < ShouldBase
+  
+    def initialize(target)
+      @target = target
+    end
+    
+    def of(expected_class)
+      fail_with_message(default_message("should be an instance of", expected_class)) unless @target.instance_of? expected_class
+    end
+    
+  end
 
 end

data/lib/spec/api/helper/instance_negator.rb

@@ -1,15 +1,15 @@
 module Spec
 
-	class InstanceNegator < ShouldBase
-	
-		def initialize(target)
-			@target = target
-		end
-		
-		def of(expected_class)
-			fail_with_message(default_message("should not be an instance of", expected_class)) if @target.instance_of? expected_class
-		end
-		
-	end
+  class InstanceNegator < ShouldBase
+  
+    def initialize(target)
+      @target = target
+    end
+    
+    def of(expected_class)
+      fail_with_message(default_message("should not be an instance of", expected_class)) if @target.instance_of? expected_class
+    end
+    
+  end
 
 end

data/lib/spec/api/helper/kind_helper.rb

@@ -1,15 +1,15 @@
 module Spec
 
-	class KindHelper < ShouldBase
-	
-		def initialize(target)
-			@target = target
-		end
-		
-		def of(expected_class)
-			fail_with_message(default_message("should be a kind of", expected_class)) unless @target.kind_of? expected_class
-		end
-		
-	end
+  class KindHelper < ShouldBase
+  
+    def initialize(target)
+      @target = target
+    end
+    
+    def of(expected_class)
+      fail_with_message(default_message("should be a kind of", expected_class)) unless @target.kind_of? expected_class
+    end
+    
+  end
 
 end

data/lib/spec/api/helper/kind_negator.rb

@@ -1,15 +1,15 @@
 module Spec
 
-	class KindNegator < ShouldBase
-	
-		def initialize(target)
-			@target = target
-		end
-		
-		def of(expected_class)
-			fail_with_message(default_message("should not be a kind of", expected_class)) if @target.kind_of? expected_class
-		end
-		
-	end
+  class KindNegator < ShouldBase
+  
+    def initialize(target)
+      @target = target
+    end
+    
+    def of(expected_class)
+      fail_with_message(default_message("should not be a kind of", expected_class)) if @target.kind_of? expected_class
+    end
+    
+  end
 
 end

data/lib/spec/api/helper/respond_helper.rb

@@ -1,15 +1,15 @@
 module Spec
 
-	class RespondHelper < ShouldBase
-	
-		def initialize(target)
-			@target = target
-		end
-		
-		def to(expected)
-			fail_with_message(default_message("should respond to", expected)) unless @target.respond_to? expected
-		end
-		
-	end
+  class RespondHelper < ShouldBase
+  
+    def initialize(target)
+      @target = target
+    end
+    
+    def to(expected)
+      fail_with_message(default_message("should respond to", expected)) unless @target.respond_to? expected
+    end
+    
+  end
 
 end

data/lib/spec/api/helper/respond_negator.rb

@@ -1,15 +1,15 @@
 module Spec
 
-	class RespondNegator < ShouldBase
-	
-		def initialize(target)
-			@target = target
-		end
-		
-		def to(expected)
-			fail_with_message(default_message("should not respond to", expected)) if @target.respond_to? expected
-		end
-		
-	end
+  class RespondNegator < ShouldBase
+  
+    def initialize(target)
+      @target = target
+    end
+    
+    def to(expected)
+      fail_with_message(default_message("should not respond to", expected)) if @target.respond_to? expected
+    end
+    
+  end
 
 end

data/lib/spec/api/helper/should_base.rb

@@ -16,18 +16,18 @@ module Spec
   
   class ShouldBase
 
-		def default_message(expectation, expected=:no_expectation_specified)
+    def default_message(expectation, expected=:no_expectation_specified)
       message = "#{@target.inspect_for_expectation_not_met_error} #{expectation}"
       if (expected != :no_expectation_specified)
         message << " " << expected.inspect_for_expectation_not_met_error
       end
       message
-   	end
+     end
 
-		def fail_with_message(message)
-			Kernel::raise(Spec::Api::ExpectationNotMetError.new(message))
-		end
-		
+    def fail_with_message(message)
+      Kernel::raise(Spec::Api::ExpectationNotMetError.new(message))
+    end
+    
   end
   
 end

data/lib/spec/api/helper/should_helper.rb

@@ -2,63 +2,63 @@ module Spec
 
   class ShouldHelper < ShouldBase
 
-	  def initialize(target)
-	  	@target = target
-		end
-		
-		def not
-		  ShouldNegator.new(@target)
-		end
+    def initialize(target)
+      @target = target
+    end
+    
+    def not
+      ShouldNegator.new(@target)
+    end
     
     def have(expected_number=nil)
       HaveHelper.new(@target, expected_number)
     end
-	
-		def satisfy(&block)
-		  return if block.call(@target)
+  
+    def satisfy(&block)
+      return if block.call(@target)
       fail_with_message "Supplied expectation was not satisfied"
     end
-				
-	  def equal(expected)
-    	fail_with_message(default_message("should equal", expected)) unless (@target == expected)
+        
+    def equal(expected)
+      fail_with_message(default_message("should equal", expected)) unless (@target == expected)
     end
 
     def be(expected = :___no_arg)
       return self if (expected == :___no_arg)
       return if (expected == false and @target.nil?)
-			return if (expected == true and (!@target.nil?) and (@target != false))
-    	fail_with_message(default_message("should be", expected)) unless (@target.equal?(expected))
+      return if (expected == true and (!@target.nil?) and (@target != false))
+      fail_with_message(default_message("should be", expected)) unless (@target.equal?(expected))
     end
 
-		def a
-			self
-		end
-		
-		alias an a
-		
-		def instance
-			InstanceHelper.new(@target)
-		end
-		
-		def kind
-			KindHelper.new(@target)
-		end
-		
-		def respond
-			RespondHelper.new(@target)
-		end
-		
+    def a
+      self
+    end
+    
+    alias an a
+    
+    def instance
+      InstanceHelper.new(@target)
+    end
+    
+    def kind
+      KindHelper.new(@target)
+    end
+    
+    def respond
+      RespondHelper.new(@target)
+    end
+    
     def method_missing(sym, *args)
       return if @target.send("#{sym}?", *args)
       fail_with_message(default_message("should be #{sym}" + (args.empty? ? '' : (' ' + args.join(', ')))))
     end
 
     def match(expected)
-     	fail_with_message(default_message("should match", expected)) unless (@target =~ expected)
+       fail_with_message(default_message("should match", expected)) unless (@target =~ expected)
     end
 
     def include(sub)
-	    fail_with_message(default_message("should include", sub)) unless (@target.include? sub)
+      fail_with_message(default_message("should include", sub)) unless (@target.include? sub)
     end
     
     def raise(exception=Exception)