rspec 1.0.0 → 1.3.1

data/lib/spec/rake/verify_rcov.rb

@@ -35,11 +35,11 @@ module RCov
     def define
       desc "Verify that rcov coverage is at least #{threshold}%"
       task @name do
-        total_coverage = nil
+        total_coverage = 0
 
         File.open(index_html).each_line do |line|
-          if line =~ /<tt.*>(\d+\.\d+)%<\/tt>&nbsp;<\/td>/
-            total_coverage = eval($1)
+          if line =~ /<tt class='coverage_total'>\s*(\d+\.\d+)%\s*<\/tt>/
+            total_coverage = $1.to_f
             break
           end
         end
@@ -49,4 +49,4 @@ module RCov
       end
     end
   end
-end
+end

data/lib/spec/ruby.rb

@@ -0,0 +1,9 @@
+module Spec
+  module Ruby
+    class << self
+      def version
+        RUBY_VERSION
+      end
+    end
+  end
+end

data/lib/spec/runner/backtrace_tweaker.rb

@@ -1,56 +1,78 @@
 module Spec
   module Runner
     class BacktraceTweaker
+      def initialize(*patterns)
+        @ignore_patterns = []
+      end
+
       def clean_up_double_slashes(line)
         line.gsub!('//','/')
       end
-    end
 
-    class NoisyBacktraceTweaker < BacktraceTweaker
-      def tweak_backtrace(error, spec_name)
+      def ignore_patterns(*patterns)
+        # do nothing. Only QuietBacktraceTweaker ignores patterns.
+      end
+
+      def ignored_patterns
+        []
+      end
+
+      def tweak_backtrace(error)
         return if error.backtrace.nil?
-        error.backtrace.each do |line|
-          clean_up_double_slashes(line)
+        tweaked = error.backtrace.collect do |message|
+          clean_up_double_slashes(message)
+          kept_lines = message.split("\n").select do |line|
+            ignored_patterns.each do |ignore|
+              break if line =~ ignore
+            end
+          end
+          kept_lines.empty?? nil : kept_lines.join("\n")
         end
+        error.set_backtrace(tweaked.select {|line| line})
       end
     end
 
+    class NoisyBacktraceTweaker < BacktraceTweaker
+    end
+
     # Tweaks raised Exceptions to mask noisy (unneeded) parts of the backtrace
     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
         IGNORE_PATTERNS = spec_files + [
+          /\/rspec-[^\/]*\/lib\/spec\//,
+          /\/spork-[^\/]*\/lib\/spork\//,
           /\/lib\/ruby\//,
           /bin\/spec:/,
+          /bin\/spork:/,
           /bin\/rcov:/,
-          /lib\/rspec_on_rails/,
+          /lib\/rspec-rails/,
           /vendor\/rails/,
           # TextMate's Ruby and RSpec plugins
           /Ruby\.tmbundle\/Support\/tmruby.rb:/,
           /RSpec\.tmbundle\/Support\/lib/,
           /temp_textmate\./,
-          /mock_frameworks\/rspec/
+          /mock_frameworks\/rspec/,
+          /spec_server/
         ]
       end
-      
-      def tweak_backtrace(error, spec_name)
-        return if error.backtrace.nil?
-        error.backtrace.collect! do |line|
-          clean_up_double_slashes(line)
-          IGNORE_PATTERNS.each do |ignore|
-            if line =~ ignore
-              line = nil
-              break
-            end
-          end
-          line
-        end
-        error.backtrace.compact!
+
+      def initialize(*patterns)
+        super
+        ignore_patterns(*patterns)
+      end
+
+      def ignore_patterns(*patterns)
+        @ignore_patterns += patterns.flatten.map { |pattern| Regexp.new(pattern) }
+      end
+
+      def ignored_patterns
+        IGNORE_PATTERNS + @ignore_patterns
       end
     end
   end
-end
+end

data/lib/spec/runner/class_and_arguments_parser.rb

@@ -0,0 +1,14 @@
+module Spec
+  module Runner
+    class ClassAndArgumentsParser
+      def self.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

data/lib/spec/runner/command_line.rb

@@ -2,21 +2,14 @@ require 'spec/runner/option_parser'
 
 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
+      def self.run(tmp_options=Spec::Runner.options)
+        orig_options = Spec::Runner.options
+        Spec::Runner.use tmp_options
+        tmp_options.run_examples
+      ensure
+        Spec::Runner.use orig_options
       end
     end
   end
-end
+end

data/lib/spec/runner/configuration.rb

@@ -0,0 +1,202 @@
+module Spec
+  module Runner
+    class Configuration
+      include Spec::Example::ArgsAndOptions
+      
+      # Chooses what mock framework to use. Example:
+      #
+      #   Spec::Runner.configure do |config|
+      #     config.mock_with :rspec, :mocha, :flexmock, or :rr
+      #   end
+      #
+      # To use any other mock framework, you'll have to provide your own
+      # adapter. This is simply a module that responds to the following
+      # methods:
+      #
+      #   setup_mocks_for_rspec
+      #   verify_mocks_for_rspec
+      #   teardown_mocks_for_rspec.
+      #
+      # These are your hooks into the lifecycle of a given example. RSpec will
+      # call setup_mocks_for_rspec before running anything else in each
+      # Example. After executing the #after methods, RSpec will then call
+      # verify_mocks_for_rspec and teardown_mocks_for_rspec (this is
+      # guaranteed to run even if there are failures in
+      # verify_mocks_for_rspec).
+      #
+      # Once you've defined this module, you can pass that to mock_with:
+      #
+      #   Spec::Runner.configure do |config|
+      #     config.mock_with MyMockFrameworkAdapter
+      #   end
+      #
+      def mock_with(mock_framework)
+        @mock_framework = case mock_framework
+        when Symbol
+          mock_framework_path(mock_framework.to_s)
+        else
+          mock_framework
+        end
+      end
+      
+      def mock_framework # :nodoc:
+        @mock_framework ||= mock_framework_path("rspec")
+      end
+      
+      # :call-seq:
+      #   include(Some::Helpers)
+      #   include(Some::Helpers, More::Helpers)
+      #   include(My::Helpers, :type => :key)
+      #
+      # Declares modules to be included in multiple example groups
+      # (<tt>describe</tt> blocks). With no <tt>:type</tt>, the modules listed
+      # will be included in all example groups.
+      #
+      # Use <tt>:type</tt> to restrict
+      # the inclusion to a subset of example groups. The value assigned to
+      # <tt>:type</tt> should be a key that maps to a class that is either a
+      # subclass of Spec::Example::ExampleGroup or extends
+      # Spec::Example::ExampleGroupMethods and includes
+      # Spec::Example::ExampleMethods.
+      #
+      # For example, the rspec-rails gem/plugin extends Test::Unit::TestCase
+      # with Spec::Example::ExampleGroupMethods and includes
+      # Spec::Example::ExampleMethods in it. So if you have a module of helper
+      # methods for controller examples, you could do this:
+      #
+      #   config.include(ControllerExampleHelpers, :type => :controller)
+      #
+      # Only example groups that have that type will get the modules included:
+      #
+      #   describe Account, :type => :model do
+      #     # Will *not* include ControllerExampleHelpers
+      #   end
+      #
+      #   describe AccountsController, :type => :controller do
+      #     # *Will* include ControllerExampleHelpers
+      #   end
+      #
+      def include(*modules_and_options)
+        include_or_extend(:include, *modules_and_options)
+      end
+      
+      # :call-seq:
+      #   extend(Some::Helpers)
+      #   extend(Some::Helpers, More::Helpers)
+      #   extend(My::Helpers, :type => :key)
+      #
+      # Works just like #include, but extends the example groups
+      # with the modules rather than including them.
+      def extend(*modules_and_options)
+        include_or_extend(:extend, *modules_and_options)
+      end
+      
+      # Appends a global <tt>before</tt> block to all example groups.
+      # <tt>scope</tt> can be any of <tt>:each</tt> (default), <tt>:all</tt>, or
+      # <tt>:suite</tt>. When <tt>:each</tt>, the block is executed before each
+      # example. When <tt>:all</tt>, the block is executed once per example
+      # group, before any of its examples are run. When <tt>:suite</tt> the
+      # block is run once before the entire suite is run.
+      def append_before(scope = :each, options={}, &proc)
+        add_callback(:append_before, scope, options, &proc)
+      end
+      alias_method :before, :append_before
+
+      # Prepends a global <tt>before</tt> block to all example groups.
+      # 
+      # See <tt>append_before</tt> for scoping semantics.
+      def prepend_before(scope = :each, options={}, &proc)
+        add_callback(:prepend_before, scope, options, &proc)
+      end
+      
+      # Prepends a global <tt>after</tt> block to all example groups.
+      # 
+      # See <tt>append_before</tt> for scoping semantics.
+      def prepend_after(scope = :each, options={}, &proc)
+        add_callback(:prepend_after, scope, options, &proc)
+      end
+      alias_method :after, :prepend_after
+      
+      # Appends a global <tt>after</tt> block to all example groups.
+      # 
+      # See <tt>append_before</tt> for scoping semantics.
+      def append_after(scope = :each, options={}, &proc)
+        add_callback(:append_after, scope, options, &proc)
+      end
+
+      # DEPRECATED - use Spec::Matchers::DSL instead
+      #
+      # Defines global predicate matchers. Example:
+      #
+      #   config.predicate_matchers[:swim] = :can_swim?
+      #
+      # This makes it possible to say:
+      #
+      #   person.should swim # passes if person.can_swim? returns true
+      #
+      def predicate_matchers
+        @predicate_matchers ||= Spec::HashWithDeprecationNotice.new("predicate_matchers", "the new Matcher DSL")
+      end
+
+      # Adds patterns to the list of patterns ignored in the backtrace when a
+      # failure is output by rspec. Example:
+      #
+      #   config.ignore_backtrace_patterns /spork/, /shoulda/, "/some/weird/path/"
+      #
+      # When quiet backtraces are turned on (default), this will exclude any
+      # lines that match any of the Regexps and Strings passed.
+      #
+      def ignore_backtrace_patterns(*patterns)
+        @ignored_backtrace_patterns ||= []
+        @ignored_backtrace_patterns += patterns
+      end
+
+      def ignored_backtrace_patterns # :nodoc:
+        @ignored_backtrace_patterns ||= []
+      end
+
+      def suppress_deprecation_warnings!
+        @suppress_deprecation_warnings = true
+      end
+
+      def suppress_deprecation_warnings?
+        @suppress_deprecation_warnings ||= false
+      end
+      
+    private
+    
+      def include_or_extend(action, *args)
+        modules, options = args_and_options(*args)
+        [get_type_from_options(options)].flatten.each do |required_example_group|
+          required_example_group = required_example_group.to_sym if required_example_group
+          modules.each do |mod|
+            Spec::Example::ExampleGroupFactory[required_example_group].__send__(action, mod)
+          end
+        end
+      end
+
+      def add_callback(sym, *args, &proc)
+        scope, options = scope_and_options(*args)
+        example_group = Spec::Example::ExampleGroupFactory[get_type_from_options(options)]
+        example_group.__send__(sym, scope, &proc)
+      end
+
+      def get_type_from_options(options)
+        options[:type] || options[:behaviour_type]
+      end
+    
+      def mock_framework_path(framework_name)
+        "spec/adapters/mock_frameworks/#{framework_name}"
+      end
+
+      def scope_and_options(*args) # :nodoc:
+        args, options = args_and_options(*args)
+        return scope_from(*args), options
+      end
+
+      def scope_from(*args) # :nodoc:
+        args[0] || :each
+      end
+    end
+  end
+end

data/lib/spec/runner/differs/default.rb

@@ -0,0 +1,93 @@
+require 'spec/runner/differs/load-diff-lcs'
+require 'pp'
+
+module Spec
+  module Expectations
+    module Differs
+      unless defined?(Spec::Expectations::Differs::Default)
+        class Default
+          def initialize(options)
+            @options = options
+          end
+
+          # This is snagged from diff/lcs/ldiff.rb (which is a commandline tool)
+          def diff_as_string(data_new, data_old)
+            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  
+
+          def diff_as_object(target,expected)
+            diff_as_string(PP.pp(target,""), PP.pp(expected,""))
+          end
+          
+          def diff_as_hash(target, expected)
+            contains_hash = false
+            contains_array = false
+            
+            extra_expected_keys = expected.keys - target.keys
+            extra_target_keys = target.keys - expected.keys
+            
+            o = "\n"
+            
+            o << "Expected hash contains keys that target hash does not: " << extra_expected_keys.inspect << "\n" if !extra_expected_keys.empty?
+            o << "Target hash contains keys that expected hash does not: " << extra_target_keys.inspect << "\n" if !extra_target_keys.empty?
+            
+            expected.delete_if do |key, value|
+              contains_hash = true if value.is_a?(Hash)
+              contains_array = true if value.is_a?(Array)
+              target[key]  == value
+            end
+            
+            expected.keys.sort { |a,b| a.to_s <=> b.to_s }.each do |key|
+              o << "Expected the key #{key.inspect} to be #{expected[key].inspect}, but was #{target[key].inspect}\n"
+            end
+            
+            o << "\n"
+
+            if contains_hash || contains_array
+              o << diff_as_object(target, expected)
+            else
+              o
+            end
+          end
+
+          protected
+          def format
+            @options.diff_format
+          end
+
+          def context_lines
+            @options.context_lines
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/spec/runner/differs/load-diff-lcs.rb

@@ -0,0 +1,12 @@
+begin
+  require 'diff/lcs'
+rescue LoadError
+  begin
+    require 'rubygems' unless ENV['NO_RUBYGEMS']
+    require 'diff/lcs'
+  rescue LoadError
+    raise "You must gem install diff-lcs to use diffing"
+  end
+end
+
+require 'diff/lcs/hunk'

data/lib/spec/runner/drb_command_line.rb

@@ -4,18 +4,29 @@ module Spec
   module Runner
     # Facade to run specs by connecting to a DRB server
     class DrbCommandLine
+
+      def self.port(options)
+        (options.drb_port || ENV["RSPEC_DRB"] || 8989).to_i
+      end
+
       # 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)
+          begin; \
+            DRb.start_service("druby://localhost:0"); \
+          rescue SocketError, Errno::EADDRNOTAVAIL; \
+            DRb.start_service("druby://:0"); \
+          end
+          spec_server = DRbObject.new_with_uri("druby://127.0.0.1:#{port(options)}")
+          spec_server.run(options.argv, options.error_stream, options.output_stream)
+          true
         rescue DRb::DRbConnError
-          stderr.puts "No server is running"
-          exit 1 if exit
+          options.error_stream.puts "No server is running"
+          false
         end
       end
+
     end
   end
-end
+end

data/lib/spec/runner/example_group_runner.rb

@@ -0,0 +1,58 @@
+module Spec
+  module Runner
+    class ExampleGroupRunner
+      def initialize(options)
+        @options = options
+      end
+
+      def load_files(files)
+        $KCODE = 'u' if RUBY_VERSION.to_f < 1.9
+        # 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(@options)
+        end
+        finish
+        success
+      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
+  end
+end

data/lib/spec/runner/extensions/kernel.rb

@@ -1,50 +1,9 @@
 module Kernel
-  # Creates and registers an instance of a Spec::DSL::Behaviour (or a subclass).
-  # The instantiated behaviour class depends on the directory of the file
-  # calling this method. For example, Spec::Rails will use different
-  # classes for specs living in <tt>spec/models</tt>, <tt>spec/helpers</tt>, 
-  # <tt>spec/views</tt> and <tt>spec/controllers</tt>.
-  #
-  # It is also possible to override autodiscovery of the behaviour class 
-  # with an options Hash as the last argument:
-  #
-  #   describe "name", :behaviour_type => :something_special do ...
-  #
-  # The reason for using different behaviour classes is to have
-  # different matcher methods available from within the <tt>describe</tt>
-  # block.
-  #
-  # See Spec::DSL::BehaviourFactory#add_behaviour_class for details about 
-  # how to register special Spec::DSL::Behaviour implementations.
-  #
-  def describe(*args, &block)
-    raise ArgumentError if args.empty?
-    args << {} unless Hash === args.last
-    args.last[:spec_path] = caller(0)[1]
-    register_behaviour(Spec::DSL::BehaviourFactory.create(*args, &block))
-  end
-  alias :context :describe
-  
-  def respond_to(*names)
-    Spec::Matchers::RespondTo.new(*names)
-  end
-  
-private
-
-  def register_behaviour(behaviour)
-    if behaviour.shared?
-      Spec::DSL::Behaviour.add_shared_behaviour(behaviour)
-    else
-      behaviour_runner.add_behaviour(behaviour)
-    end
-  end
-
-  def behaviour_runner
-    # TODO: Figure out a better way to get this considered "covered" and keep this statement on multiple lines 
-    unless $behaviour_runner; \
-      $behaviour_runner = ::Spec::Runner::OptionParser.new.create_behaviour_runner(ARGV.dup, STDERR, STDOUT, false); \
-      at_exit { $behaviour_runner.run(nil, false) }; \
+  unless respond_to?(:debugger)
+    # Start a debugging session if ruby-debug is loaded with the -u/--debugger option
+    def debugger(steps=1)
+      # If not then just comment and proceed
+      $stderr.puts "debugger statement ignored, use -u or --debugger option on rspec to enable debugging"
     end
-    $behaviour_runner
   end
 end