rspec 1.0.8 → 1.1.0

data/lib/spec/rake/spectask.rb

@@ -8,7 +8,7 @@ require 'rake/tasklib'
 module Spec
   module Rake
 
-    # A Rake task that runs a set of RSpec contexts.
+    # A Rake task that runs a set of specs.
     #
     # Example:
     #  
@@ -44,6 +44,17 @@ module Spec
     # Each attribute of this task may be a proc. This allows for lazy evaluation,
     # which is sometimes handy if you want to defer the evaluation of an attribute value
     # until the task is run (as opposed to when it is defined).
+    #
+    # This task can also be used to run existing Test::Unit tests and get RSpec
+    # output, for example like this:
+    #
+    #   require 'rubygems'
+    #   require 'spec/rake/spectask'
+    #   Spec::Rake::SpecTask.new do |t|
+    #     t.ruby_opts = ['-rtest/unit']
+    #     t.spec_files = FileList['test/**/*_test.rb']
+    #   end
+    #
     class SpecTask < ::Rake::TaskLib
       class << self
         def attr_accessor(*names)
@@ -106,6 +117,10 @@ module Spec
       # used, then the list of spec files is the union of the two.
       # Setting the SPEC environment variable overrides this.
       attr_accessor :spec_files
+      
+      # Use verbose output. If this is set to true, the task will print
+      # the executed spec command to stdout. Defaults to false.
+      attr_accessor :verbose
 
       # Defines a new task, using the name +name+.
       def initialize(name=:spec)
@@ -161,6 +176,9 @@ module Spec
                 cmd << %Q| > "#{out}"|
                 STDERR.puts "The Spec::Rake::SpecTask#out attribute is DEPRECATED and will be removed in a future version. Use --format FORMAT:WHERE instead."
               end
+              if verbose
+                puts cmd
+              end
               unless system(cmd)
                 STDERR.puts failure_message if failure_message
                 raise("Command #{cmd} failed") if fail_on_error

data/lib/spec/rake/verify_rcov.rb

@@ -38,7 +38,7 @@ module RCov
         total_coverage = nil
 
         File.open(index_html).each_line do |line|
-          if line =~ /<tt.*>(\d+\.\d+)%<\/tt>&nbsp;<\/td>/
+          if line =~ /<tt class='coverage_total'>(\d+\.\d+)%<\/tt>/
             total_coverage = eval($1)
             break
           end

data/lib/spec/runner.rb

@@ -1,14 +1,12 @@
-require 'spec/runner/formatter'
-require 'spec/runner/behaviour_runner'
 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/extensions/kernel'
 require 'spec/runner/spec_parser'
+require 'spec/runner/class_and_arguments_parser'
 
 module Spec
   # == Behaviours and Examples
@@ -16,7 +14,7 @@ module Spec
   # 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
+  # A Example 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
   # 
@@ -32,7 +30,7 @@ module Spec
   # 
   #   end
   # 
-  # We use the before block to set up the Behaviour (given), and then the #it method to
+  # We use the before block to set up the Example (given), and then the #it method to
   # hold the example code that expresses the event (when) and the expected outcome (then).
   # 
   # == Helper Methods
@@ -47,7 +45,7 @@ module Spec
   # 
   # == Setup and Teardown
   # 
-  # You can use before and after within a Behaviour. Both methods take an optional
+  # You can use before and after within a Example. Both methods take an optional
   # scope argument so you can run the block before :each example or before :all examples
   # 
   #   describe "..." do
@@ -140,10 +138,35 @@ module Spec
   #      ...
   #    end
   #  end
+  #
+  # You can also assign the shared behaviour to a module and include that
+  #
+  #  AllEditions = describe "All Editions", :shared => true do
+  #    it "should do all editions stuff" ...
+  #  end
+  #
+  #  describe SmallEdition do
+  #    it_should_behave_like AllEditions
+  #  
+  #    it "should do small edition stuff" do
+  #      ...
+  #    end
+  #  end
+  #
+  # And, for those of you who prefer to use something more like Ruby, you
+  # can just include the module directly
+  #
+  #  describe SmallEdition do
+  #    include AllEditions
+  #  
+  #    it "should do small edition stuff" do
+  #      ...
+  #    end
+  #  end
   module Runner
     class << self
       def configuration # :nodoc:
-        @configuration ||= Spec::DSL::Configuration.new
+        @configuration ||= Spec::Example::Configuration.new
       end
       
       # Use this to configure various configurable aspects of
@@ -154,11 +177,11 @@ module Spec
       #   end
       #
       # The yielded <tt>configuration</tt> object is a
-      # Spec::DSL::Configuration instance. See its RDoc
+      # Spec::Example::Configuration instance. See its RDoc
       # for details about what you can do with it.
       #
       def configure
-        yield configuration if @configuration.nil?
+        yield configuration
       end
     end
   end

data/lib/spec/runner/backtrace_tweaker.rb

@@ -7,7 +7,7 @@ module Spec
     end
 
     class NoisyBacktraceTweaker < BacktraceTweaker
-      def tweak_backtrace(error, spec_name)
+      def tweak_backtrace(error)
         return if error.backtrace.nil?
         error.backtrace.each do |line|
           clean_up_double_slashes(line)
@@ -19,7 +19,7 @@ module Spec
     class QuietBacktraceTweaker < BacktraceTweaker
       unless defined?(IGNORE_PATTERNS)
         root_dir = File.expand_path(File.join(__FILE__, '..', '..', '..', '..'))
-        spec_files = Dir["#{root_dir}/lib/spec/*"].map do |path| 
+        spec_files = Dir["#{root_dir}/lib/*"].map do |path| 
           subpath = path[root_dir.length..-1]
           /#{subpath}/
         end
@@ -38,7 +38,7 @@ module Spec
         ]
       end
       
-      def tweak_backtrace(error, spec_name)
+      def tweak_backtrace(error)
         return if error.backtrace.nil?
         error.backtrace.collect! do |line|
           clean_up_double_slashes(line)

data/lib/spec/runner/class_and_arguments_parser.rb

@@ -0,0 +1,16 @@
+module Spec
+  module Runner
+    class ClassAndArgumentsParser
+      class << self
+        def parse(s)
+          if s =~ /([a-zA-Z_]+(?:::[a-zA-Z_]+)*):?(.*)/
+            arg = $2 == "" ? nil : $2
+            [$1, arg]
+          else
+            raise "Couldn't parse #{s.inspect}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spec/runner/command_line.rb

@@ -4,18 +4,24 @@ module Spec
   module Runner
     # Facade to run specs without having to fork a new ruby process (using `spec ...`)
     class CommandLine
-      # Runs specs. +argv+ is the commandline args as per the spec commandline API, +err+ 
-      # and +out+ are the streams output will be written to. +exit+ tells whether or
-      # not a system exit should be called after the specs are run and
-      # +warn_if_no_files+ tells whether or not a warning (the help message)
-      # should be printed to +err+ in case no files are specified.
-      def self.run(argv, err, out, exit=true, warn_if_no_files=true)
-        old_behaviour_runner = defined?($behaviour_runner) ? $behaviour_runner : nil
-        $behaviour_runner = OptionParser.new.create_behaviour_runner(argv, err, out, warn_if_no_files)
-        return if $behaviour_runner.nil? # This is the case if we use --drb
-
-        $behaviour_runner.run(argv, exit)
-        $behaviour_runner = old_behaviour_runner
+      class << self
+        # Runs specs. +argv+ is the commandline args as per the spec commandline API, +err+
+        # and +out+ are the streams output will be written to.
+        def run(instance_rspec_options)
+          # NOTE - this call to init_rspec_options is not spec'd, but neither is any of this
+          # swapping of $rspec_options. That is all here to enable rspec to run against itself
+          # and maintain coverage in a single process. Therefore, DO NOT mess with this stuff
+          # unless you know what you are doing!
+          init_rspec_options(instance_rspec_options)
+          orig_rspec_options = rspec_options
+          begin
+            $rspec_options = instance_rspec_options
+            return $rspec_options.run_examples
+          ensure
+            ::Spec.run = true
+            $rspec_options = orig_rspec_options
+          end
+        end
       end
     end
   end

data/lib/spec/runner/drb_command_line.rb

@@ -6,14 +6,13 @@ module Spec
     class DrbCommandLine
       # Runs specs on a DRB server. Note that this API is similar to that of
       # CommandLine - making it possible for clients to use both interchangeably.
-      def self.run(argv, stderr, stdout, exit=true, warn_if_no_files=true)
+      def self.run(options)
         begin
           DRb.start_service
           spec_server = DRbObject.new_with_uri("druby://localhost:8989")
-          spec_server.run(argv, stderr, stdout)
-        rescue DRb::DRbConnError
-          stderr.puts "No server is running"
-          exit 1 if exit
+          spec_server.run(options.argv, options.error_stream, options.output_stream)
+        rescue DRb::DRbConnError => e
+          options.error_stream.puts "No server is running"
         end
       end
     end

data/lib/spec/runner/example_group_runner.rb

@@ -0,0 +1,59 @@
+module Spec
+  module Runner
+    class ExampleGroupRunner
+      def initialize(options)
+        @options = options
+      end
+
+      def load_files(files)
+        # It's important that loading files (or choosing not to) stays the
+        # responsibility of the ExampleGroupRunner. Some implementations (like)
+        # the one using DRb may choose *not* to load files, but instead tell
+        # someone else to do it over the wire.
+        files.each do |file|
+          load file
+        end
+      end
+
+      def run
+        prepare
+        success = true
+        example_groups.each do |example_group|
+          success = success & example_group.run
+        end
+        return success
+      ensure
+        finish
+      end
+
+      protected
+      def prepare
+        reporter.start(number_of_examples)
+        example_groups.reverse! if reverse
+      end
+
+      def finish
+        reporter.end
+        reporter.dump
+      end
+
+      def reporter
+        @options.reporter
+      end
+
+      def reverse
+        @options.reverse
+      end
+
+      def example_groups
+        @options.example_groups
+      end
+
+      def number_of_examples
+        @options.number_of_examples
+      end
+    end
+    # TODO: BT - Deprecate BehaviourRunner?
+    BehaviourRunner = ExampleGroupRunner
+  end
+end

data/lib/spec/runner/formatter/base_formatter.rb

@@ -3,7 +3,9 @@ module Spec
     module Formatter
       # Baseclass for formatters that implements all required methods as no-ops. 
       class BaseFormatter
-        def initialize(where)
+        attr_accessor :example_group, :options, :where
+        def initialize(options, where)
+          @options = options
           @where = where
         end
         
@@ -12,16 +14,17 @@ module Spec
         # formatters that need to provide progress on feedback (graphical ones)
         #
         # This method will only be invoked once, and the next one to be invoked
-        # is #add_behaviour
+        # is #add_example_group
         def start(example_count)
         end
 
-        # This method is invoked at the beginning of the execution of each behaviour.
-        # +name+ is the name of the behaviour and +first+ is true if it is the
-        # first behaviour - otherwise it's false.
+        # This method is invoked at the beginning of the execution of each example_group.
+        # +name+ is the name of the example_group and +first+ is true if it is the
+        # first example_group - otherwise it's false.
         #
         # The next method to be invoked after this is #example_failed or #example_finished
-        def add_behaviour(name)
+        def add_example_group(example_group)
+          @example_group = example_group
         end
 
         # This method is invoked when an +example+ starts.
@@ -41,10 +44,9 @@ module Spec
         
         # This method is invoked when an example is not yet implemented (i.e. has not
         # been provided a block), or when an ExamplePendingError is raised.
-        # +name+ is the name of the example.
         # +message+ is the message from the ExamplePendingError, if it exists, or the
         # default value of "Not Yet Implemented"
-        def example_pending(behaviour_name, example_name, message)
+        def example_pending(example_group_description, example, message)
         end
 
         # This method is invoked after all of the examples have executed. The next method

data/lib/spec/runner/formatter/base_text_formatter.rb

@@ -1,3 +1,5 @@
+require 'spec/runner/formatter/base_formatter'
+
 module Spec
   module Runner
     module Formatter
@@ -5,13 +7,12 @@ module Spec
       # non-text based ones too - just ignore the +output+ constructor
       # argument.
       class BaseTextFormatter < BaseFormatter
-        attr_writer :dry_run
-        
+        attr_reader :output, :pending_examples
         # Creates a new instance that will write to +where+. If +where+ is a
         # String, output will be written to the File with that name, otherwise
         # +where+ is exected to be an IO (or an object that responds to #puts and #write).
-        def initialize(where)
-          super(where)
+        def initialize(options, where)
+          super
           if where.is_a?(String)
             @output = File.open(where, 'w')
           elsif where == STDOUT
@@ -22,21 +23,13 @@ module Spec
           else
             @output = where
           end
-          @colour = false
-          @dry_run = false
-          @snippet_extractor = SnippetExtractor.new
           @pending_examples = []
         end
         
-        def example_pending(behaviour_name, example_name, message)
-          @pending_examples << ["#{behaviour_name} #{example_name}", message]
+        def example_pending(example_group_description, example, message)
+          @pending_examples << ["#{example_group_description} #{example.description}", message]
         end
         
-        def colour=(colour)
-          @colour = colour
-          begin ; require 'Win32/Console/ANSI' if @colour && PLATFORM =~ /win32/ ; rescue LoadError ; raise "You must gem install win32console to use colour on Windows" ; end
-        end
-
         def dump_failure(counter, failure)
           @output.puts
           @output.puts "#{counter.to_s})"
@@ -56,7 +49,7 @@ module Spec
         end
       
         def dump_summary(duration, example_count, failure_count, pending_count)
-          return if @dry_run
+          return if dry_run?
           @output.puts
           @output.puts "Finished in #{duration} seconds"
           @output.puts
@@ -74,7 +67,6 @@ module Spec
             @output.puts red(summary)
           end
           @output.flush
-          dump_pending
         end
 
         def dump_pending
@@ -100,13 +92,21 @@ module Spec
         end
       
       protected
-      
+
+        def colour?
+          @options.colour ? true : false
+        end
+
+        def dry_run?
+          @options.dry_run ? true : false
+        end
+        
         def backtrace_line(line)
           line.sub(/\A([^:]+:\d+)$/, '\\1:')
         end
 
         def colour(text, colour_code)
-          return text unless @colour && output_to_tty?
+          return text unless colour? && output_to_tty?
           "#{colour_code}#{text}\e[0m"
         end
 

data/lib/spec/runner/formatter/failing_example_groups_formatter.rb

@@ -0,0 +1,31 @@
+require 'spec/runner/formatter/base_text_formatter'
+
+module Spec
+  module Runner
+    module Formatter
+      class FailingExampleGroupsFormatter < BaseTextFormatter
+        def add_example_group(example_group)
+          super
+          @example_group_description_parts = example_group.description_parts
+        end
+
+        def example_failed(example, counter, failure)
+          if @example_group_description_parts
+            description_parts = @example_group_description_parts.collect do |description|
+              description =~ /(.*) \(druby.*\)$/ ? $1 : description
+            end
+            @output.puts ::Spec::Example::ExampleGroupMethods.description_text(*description_parts)
+            @output.flush
+            @example_group_description_parts = nil
+          end
+        end
+
+        def dump_failure(counter, failure)
+        end
+
+        def dump_summary(duration, example_count, failure_count, pending_count)
+        end
+      end
+    end
+  end
+end