rspec 1.0.0 → 1.3.1

data/lib/spec/runner/reporter.rb

@@ -1,38 +1,53 @@
 module Spec
   module Runner
     class Reporter
+      attr_reader :options
       
-      def initialize(formatters, backtrace_tweaker)
-        @formatters = formatters
-        @backtrace_tweaker = backtrace_tweaker
-        clear!
+      def initialize(options)
+        @options = options
+        @options.reporter = self
+        @failures = []
+        @pending_count = 0
+        @example_count = 0
+        @start_time = nil
+        @end_time = nil
       end
       
-      def add_behaviour(name)
-        @formatters.each{|f| f.add_behaviour(name)}
-        @behaviour_names << name
+      def example_group_started(example_group)
+        @example_group = example_group
+        formatters.each do |f|
+          f.example_group_started(example_group)
+        end
       end
       
-      def example_started(name)
-        @formatters.each{|f| f.example_started(name)}
+      def example_started(example)
+        formatters.each{|f| f.example_started(example)}
       end
       
-      def example_finished(name, error=nil, failure_location=nil, not_implemented = false)
-        @example_names << name
+      def example_finished(example, error=nil)
+        @example_count += 1
         
-        if not_implemented
-          example_not_implemented(name)
-        elsif error.nil?
-          example_passed(name)
+        if error.nil?
+          example_passed(example)
+        elsif Spec::Example::ExamplePendingError === error
+          example_pending(example, example.location, error.message)
         else
-          example_failed(name, error, failure_location)
+          example_failed(example, error)
+        end
+      end
+
+      def example_failed(example, error)
+        backtrace_tweaker.tweak_backtrace(error)
+        failure = Failure.new(@example_group.description, example.description, error)
+        @failures << failure
+        formatters.each do |f|
+          f.example_failed(example, @failures.length, failure)
         end
       end
 
       def start(number_of_examples)
-        clear!
         @start_time = Time.new
-        @formatters.each{|f| f.start(number_of_examples)}
+        formatters.each{|f| f.start(number_of_examples)}
       end
   
       def end
@@ -41,74 +56,116 @@ module Spec
   
       # Dumps the summary and returns the total number of failures
       def dump
-        @formatters.each{|f| f.start_dump}
+        formatters.each{|f| f.start_dump}
+        dump_pending
         dump_failures
-        @formatters.each{|f| f.dump_summary(duration, @example_names.length, @failures.length, @not_implemented_count)}
+        formatters.each do |f|
+          f.dump_summary(duration, @example_count, @failures.length, @pending_count)
+          f.close
+        end
         @failures.length
       end
 
+      class Failure
+        def initialize(group_description, example_description, exception)  # :nodoc:
+          @example_name = "#{group_description} #{example_description}"
+          @exception = exception
+        end
+        
+        # The Exception object raised
+        attr_reader :exception
+        
+        # Header messsage for reporting this failure, including the name of the
+        # example and an indicator of the type of failure. FAILED indicates a
+        # failed expectation. FIXED indicates a pending example that passes, and
+        # no longer needs to be pending. RuntimeError indicates that a
+        # RuntimeError occured.
+        # 
+        # == Examples
+        #
+        #   'A new account should have a zero balance' FAILED
+        #   'A new account should have a zero balance' FIXED
+        #   RuntimeError in 'A new account should have a zero balance'
+        def header
+          if expectation_not_met?
+            "'#{@example_name}' FAILED"
+          elsif pending_fixed?
+            "'#{@example_name}' FIXED"
+          else
+            "#{@exception.class.name} in '#{@example_name}'"
+          end
+        end
+        
+        def pending_fixed? # :nodoc:
+          @exception.is_a?(Spec::Example::PendingExampleFixedError)
+        end
+
+        def expectation_not_met?  # :nodoc:
+          @exception.is_a?(Spec::Expectations::ExpectationNotMetError)
+        end
+      end
+
     private
-  
-      def clear!
-        @behaviour_names = []
-        @failures = []
-        @not_implemented_count = 0
-        @example_names = []
-        @start_time = nil
-        @end_time = nil
+
+      def formatters
+        @options.formatters
+      end
+
+      def backtrace_tweaker
+        @options.backtrace_tweaker
       end
   
       def dump_failures
         return if @failures.empty?
         @failures.inject(1) do |index, failure|
-          @formatters.each{|f| f.dump_failure(index, failure)}
+          formatters.each{|f| f.dump_failure(index, failure)}
           index + 1
         end
       end
 
+      def dump_pending
+        formatters.each{|f| f.dump_pending}
+      end
+
       def duration
         return @end_time - @start_time unless (@end_time.nil? or @start_time.nil?)
         return "0.0"
       end
       
-      def example_passed(name)
-        @formatters.each{|f| f.example_passed(name)}
+      def example_passed(example)
+        formatters.each{|f| f.example_passed(example)}
       end
 
-      def example_failed(name, error, failure_location)
-        @backtrace_tweaker.tweak_backtrace(error, failure_location)
-        example_name = "#{@behaviour_names.last} #{name}"
-        failure = Failure.new(example_name, error)
-        @failures << failure
-        @formatters.each{|f| f.example_failed(name, @failures.length, failure)}
-      end
-      
-      def example_not_implemented(name)
-        @not_implemented_count += 1
-        @formatters.each{|f| f.example_not_implemented(name)}
-      end
-      
-      class Failure
-        attr_reader :exception
-        
-        def initialize(example_name, exception)
-          @example_name = example_name
-          @exception = exception
-        end
+      EXAMPLE_PENDING_DEPRECATION_WARNING = <<-WARNING
 
-        def header
-          if expectation_not_met?
-            "'#{@example_name}' FAILED"
+*********************************************************************
+DEPRECATION WARNING: RSpec's formatters have changed example_pending
+to accept two arguments instead of three. Please see the rdoc
+for Spec::Runner::Formatter::BaseFormatter#example_pending
+for more information.
+  
+Please update any custom formatters to accept only two arguments
+to example_pending. Support for example_pending with two arguments
+and this warning message will be removed after the RSpec 2.0 release.
+*********************************************************************      
+WARNING
+      
+      def example_pending(example, ignore, message="Not Yet Implemented")
+        @pending_count += 1
+        formatters.each do |formatter|
+          if formatter_uses_deprecated_example_pending_method?(formatter)
+            Spec.warn EXAMPLE_PENDING_DEPRECATION_WARNING
+            formatter.example_pending(example, message, example.location)
           else
-            "#{@exception.class.name} in '#{@example_name}'"
+            formatter.example_pending(example, message)
           end
         end
-        
-        def expectation_not_met?
-          @exception.is_a?(Spec::Expectations::ExpectationNotMetError)
-        end
-
       end
+      
+      def formatter_uses_deprecated_example_pending_method?(formatter)
+        formatter.method(:example_pending).arity == 3
+      end
+      
     end
   end
 end

data/lib/spec/runner.rb

@@ -1,151 +1,31 @@
-require 'spec/runner/formatter'
-require 'spec/runner/behaviour_runner'
+require 'spec/runner/configuration'
 require 'spec/runner/options'
 require 'spec/runner/option_parser'
+require 'spec/runner/example_group_runner'
 require 'spec/runner/command_line'
 require 'spec/runner/drb_command_line'
 require 'spec/runner/backtrace_tweaker'
 require 'spec/runner/reporter'
-require 'spec/runner/extensions/object'
+require 'spec/runner/line_number_query'
+require 'spec/runner/class_and_arguments_parser'
 require 'spec/runner/extensions/kernel'
-require 'spec/runner/spec_parser'
 
 module Spec
-  # == Behaviours and Examples
-  # 
-  # Rather than expressing examples in classes, RSpec uses a custom domain specific language to 
-  # describe Behaviours and Examples of those behaviours.
-  # 
-  # A Behaviour is the equivalent of a fixture in xUnit-speak. It is a metaphor for the context
-  # in which you will run your executable example - a set of known objects in a known starting state.
-  # We begin be describing
-  # 
-  #   describe Account do
-  # 
-  #     before do
-  #       @account = Account.new
-  #     end
-  # 
-  #     it "should have a balance of $0" do
-  #       @account.balance.should == Money.new(0, :dollars)
-  #     end
-  # 
-  #   end
-  # 
-  # We use the before block to set up the Behaviour (given), and then the #it method to
-  # hold the example code that expresses the event (when) and the expected outcome (then).
-  # 
-  # == Helper Methods
-  # 
-  # A primary goal of RSpec is to keep the examples clear. We therefore prefer
-  # less indirection than you might see in xUnit examples and in well factored, DRY production code. We feel
-  # that duplication is OK if removing it makes it harder to understand an example without
-  # having to look elsewhere to understand its context.
-  # 
-  # That said, RSpec does support some level of encapsulating common code in helper
-  # methods that can exist within a context or within an included module.
-  # 
-  # == Setup and Teardown
-  # 
-  # You can use before and after within a Behaviour. Both methods take an optional
-  # scope argument so you can run the block before :each example or before :all examples
-  # 
-  #   describe "..." do
-  #     before :all do
-  #       ...
-  #     end
-  # 
-  #     before :each do
-  #       ...
-  #     end
-  # 
-  #     it "should do something" do
-  #       ...
-  #     end
-  # 
-  #     it "should do something else" do
-  #       ...
-  #     end
-  # 
-  #     after :each do
-  #       ...
-  #     end
-  # 
-  #     after :all do
-  #       ...
-  #     end
-  # 
-  #   end
-  # 
-  # The <tt>before :each</tt> block will run before each of the examples, once for each example. Likewise,
-  # the <tt>after :each</tt> block will run after each of the examples.
-  # 
-  # It is also possible to specify a <tt>before :all</tt> and <tt>after :all</tt>
-  # block that will run only once for each behaviour, respectively before the first <code>before :each</code>
-  # and after the last <code>after :each</code>. The use of these is generally discouraged, because it
-  # introduces dependencies between the examples. Still, it might prove useful for very expensive operations
-  # if you know what you are doing.
-  # 
-  # == Local helper methods
-  # 
-  # You can include local helper methods by simply expressing them within a context:
-  # 
-  #   describe "..." do
-  #   
-  #     it "..." do
-  #       helper_method
-  #     end
-  # 
-  #     def helper_method
-  #       ...
-  #     end
-  # 
-  #   end
-  # 
-  # == Included helper methods
-  # 
-  # You can include helper methods in multiple contexts by expressing them within
-  # a module, and then including that module in your context:
-  # 
-  #   module AccountExampleHelperMethods
-  #     def helper_method
-  #       ...
-  #     end
-  #   end
-  # 
-  #   describe "A new account" do
-  #     include AccountExampleHelperMethods
-  #     before do
-  #       @account = Account.new
-  #     end
-  # 
-  #     it "should have a balance of $0" do
-  #       helper_method
-  #       @account.balance.should eql(Money.new(0, :dollars))
-  #     end
-  #   end
-  # 
-  # == Shared behaviour
-  # 
-  # You can define a shared behaviour, that may be used on other behaviours
-  #
-  #  describe "All Editions", :shared => true do
-  #    it "all editions behaviour" ...
-  #  end
-  #
-  #  describe SmallEdition do
-  #    it_should_behave_like "All Editions"
-  #  
-  #    it "should do small edition stuff" do
-  #      ...
-  #    end
-  #  end
   module Runner
+    
+    class ExampleGroupCreationListener
+      def register_example_group(klass)
+        Spec::Runner.options.add_example_group klass
+      end
+    end
+    
+    Spec::Example::ExampleGroupFactory.example_group_creation_listeners << ExampleGroupCreationListener.new
+    
     class << self
       def configuration # :nodoc:
-        @configuration ||= Spec::DSL::Configuration.new
+        @configuration ||= Spec::Runner::Configuration.new
       end
-      
+
       # Use this to configure various configurable aspects of
       # RSpec:
       #
@@ -154,12 +34,33 @@ module Spec
       #   end
       #
       # The yielded <tt>configuration</tt> object is a
-      # Spec::DSL::Configuration instance. See its RDoc
+      # Spec::Runner::Configuration instance. See its RDoc
       # for details about what you can do with it.
       #
       def configure
-        yield configuration if @configuration.nil?
+        yield configuration
+      end
+      
+      def autorun # :nodoc:
+        at_exit {exit run unless $!}
       end
+
+      def options # :nodoc:
+        @options ||= begin
+          parser = ::Spec::Runner::OptionParser.new($stderr, $stdout)
+          parser.order!(ARGV)
+          parser.options
+        end
+      end
+    
+      def use options
+        @options = options
+      end
+
+      def run
+        options.examples_run? || options.run_examples
+      end
+
     end
   end
-end
+end

data/lib/spec/stubs/cucumber.rb

@@ -0,0 +1,5 @@
+# This plugs RSpec's mocking/stubbing framework into cucumber
+require 'spec/mocks'
+Before {$rspec_mocks ||= Spec::Mocks::Space.new}
+After  {$rspec_mocks.reset_all}
+World(Spec::Mocks::ExampleMethods)

data/lib/spec/test/unit.rb

@@ -0,0 +1,10 @@
+require 'spec/interop/test'
+
+# Hack to stop active_support/dependencies from complaining about
+# 'spec/test/unit' not defining Spec::Test::Unit
+module Spec
+  module Test
+    module Unit
+    end
+  end
+end

data/lib/spec/version.rb

@@ -1,22 +1,14 @@
-module Spec
-  module VERSION
-    unless defined? MAJOR
-      MAJOR  = 1
-      MINOR  = 0
-      TINY   = 0
-      RELEASE_CANDIDATE = nil
-      
-      # RANDOM_TOKEN: 0.805184248412641
-      REV = "$LastChangedRevision: 1986 $".match(/LastChangedRevision: (\d+)/)[1]
-
-      STRING = [MAJOR, MINOR, TINY].join('.')
-      TAG = "REL_#{[MAJOR, MINOR, TINY, RELEASE_CANDIDATE].compact.join('_')}".upcase.gsub(/\.|-/, '_')
-      FULL_VERSION = "#{[MAJOR, MINOR, TINY, RELEASE_CANDIDATE].compact.join('.')} (r#{REV})"
-
-      NAME   = "RSpec"
-      URL    = "http://rspec.rubyforge.org/"  
-    
-      DESCRIPTION = "#{NAME}-#{FULL_VERSION} - BDD for Ruby\n#{URL}"
-    end
-  end
-end
+module Spec # :nodoc:
+  module VERSION # :nodoc:
+    unless defined? MAJOR
+      MAJOR  = 1
+      MINOR  = 3
+      TINY   = 1
+      PRE    = nil
+
+      STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')
+
+      SUMMARY = "rspec #{STRING}"
+    end
+  end
+end

data/lib/spec.rb

@@ -1,13 +1,8 @@
-require 'spec/extensions'
-require 'spec/version'
+require 'spec/deprecation'
+require 'spec/ruby'
 require 'spec/matchers'
 require 'spec/expectations'
-require 'spec/translator'
-require 'spec/dsl'
+require 'spec/example'
 require 'spec/runner'
-
-class Object
-  def metaclass
-    class << self; self; end
-  end
-end
+require 'spec/version'
+require 'spec/dsl'

data/resources/helpers/cmdline.rb

@@ -0,0 +1,8 @@
+require 'spec'
+
+# Uncommenting next line will break the output feature (no output!!)
+# rspec_options
+options = Spec::Runner::OptionParser.parse(
+  ARGV, $stderr, $stdout
+)
+Spec::Runner::CommandLine.run(options)

data/resources/rake/examples.rake

@@ -0,0 +1,7 @@
+require 'rake'
+require 'spec/rake/spectask'
+
+desc "Run all examples"
+Spec::Rake::SpecTask.new('examples') do |t|
+  t.spec_files = FileList['examples/**/*.rb']
+end

data/resources/rake/examples_with_rcov.rake

@@ -0,0 +1,9 @@
+require 'rake'
+require 'spec/rake/spectask'
+
+desc "Run all examples with RCov"
+Spec::Rake::SpecTask.new('examples_with_rcov') do |t|
+  t.spec_files = FileList['examples/**/*.rb']
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'examples']
+end

data/resources/rake/failing_examples_with_html.rake

@@ -0,0 +1,9 @@
+require 'rake'
+require 'spec/rake/spectask'
+
+desc "Generate HTML report for failing examples"
+Spec::Rake::SpecTask.new('failing_examples_with_html') do |t|
+  t.spec_files = FileList['failing_examples/**/*.rb']
+  t.spec_opts = ["--format", "html:doc/reports/tools/failing_examples.html", "--diff"]
+  t.fail_on_error = false
+end

data/resources/rake/verify_rcov.rake

@@ -0,0 +1,7 @@
+require 'rake'
+require 'spec/rake/verify_rcov'
+
+RCov::VerifyTask.new(:verify_rcov => 'spec:rcov') do |t|
+  t.threshold = 100.0
+  t.index_html = 'coverage/index.html'
+end

data/spec/README.jruby

@@ -0,0 +1,15 @@
+= Running specs on JRuby =
+
+svn co http://svn.codehaus.org/jruby/trunk jruby
+cd jruby/jruby
+ant clean
+ant
+# put JRuby's bin dir on your PATH
+jruby -S gem install rake --no-ri --no-rdoc
+jruby -S gem install diff-lcs
+jruby -S gem install syntax
+cd ../testsuites/rspec
+mkdir target
+jruby -S rake checkout_code
+cd target/rspec
+jruby bin/spec spec -c

data/spec/autotest/autotest_helper.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+begin
+  require 'autotest'
+rescue LoadError
+  raise "You must install ZenTest to use autotest"
+end
+require 'autotest/rspec'
+require 'autotest/autotest_matchers'

data/spec/autotest/autotest_matchers.rb

@@ -0,0 +1,38 @@
+module Spec
+  module Matchers
+    class AutotestMappingMatcher
+      def initialize(specs)
+        @specs = specs
+      end
+  
+      def to(file)
+        @file = file
+        self
+      end
+  
+      def matches?(autotest)
+        @autotest = prepare(autotest)
+        @actual = autotest.test_files_for(@file)
+        @actual == @specs
+      end
+  
+      def failure_message
+        "expected #{@autotest.class} to map #{@specs.inspect} to #{@file.inspect}\ngot #{@actual.inspect}"
+      end
+  
+    private
+
+      def prepare(autotest)
+        find_order = @specs.dup << @file
+        autotest.instance_eval { @find_order = find_order }
+        autotest
+      end
+
+    end
+    
+    def map_specs(specs)
+      AutotestMappingMatcher.new(specs)
+    end
+    
+  end
+end

data/spec/autotest/discover_spec.rb

@@ -0,0 +1,8 @@
+require 'autotest/autotest_helper'
+
+describe Autotest::Rspec, "discovery" do
+  it "adds the rspec autotest plugin" do
+    Autotest.should_receive(:add_discovery)
+    load File.expand_path("../../../lib/autotest/discover.rb", __FILE__)
+  end
+end  

data/spec/autotest/failed_results_re_spec.rb

@@ -0,0 +1,31 @@
+require 'autotest/autotest_helper'
+
+describe "failed_results_re" do
+  it "should match a failure" do
+    re = Autotest::Rspec.new.failed_results_re
+    re =~ "1)\n'this example' FAILED\nreason\n/path.rb:37:\n\n"
+    $1.should == "this example"
+    $2.should == "reason\n/path.rb:37:"
+  end
+
+  it "should match a failure when matcher outputs multiple lines" do
+    re = Autotest::Rspec.new.failed_results_re
+    re =~ "1)\n'other example' FAILED\n\nreason line 1\nreason line 2\n\n(additional info)\n/path.rb:37:\n\n"
+    $1.should == "other example"
+    $2.should == "reason line 1\nreason line 2\n\n(additional info)\n/path.rb:37:"
+  end
+
+  it "should match an Error" do
+    re = Autotest::Rspec.new.failed_results_re
+    re =~ "1)\nRuntimeError in 'this example'\nreason\n/path.rb:37:\n\n"
+    $1.should == "this example"
+    $2.should == "reason\n/path.rb:37:"
+  end
+
+  it "should match an Error that doesn't end in Error" do
+    re = Autotest::Rspec.new.failed_results_re
+    re =~ "1)\nInvalidArgument in 'this example'\nreason\n/path.rb:37:\n\n"
+    $1.should == "this example"
+    $2.should == "reason\n/path.rb:37:"
+  end
+end