ageweke-rspec 1.2.9

data/lib/spec/runner/command_line.rb

@@ -0,0 +1,15 @@
+require 'spec/runner/option_parser'
+
+module Spec
+  module Runner
+    class CommandLine
+      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

data/lib/spec/runner/configuration.rb

@@ -0,0 +1,194 @@
+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
+      
+    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?(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

@@ -0,0 +1,33 @@
+require "drb/drb"
+
+module Spec
+  module Runner
+    # Facade to run specs by connecting to a DRB server
+    class DrbCommandLine
+      # port to run against
+      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(options)
+        begin
+          begin; \
+            DRb.start_service("druby://localhost:0"); \
+          rescue SocketError; \
+            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
+          options.error_stream.puts "No server is running"
+          false
+        end
+      end
+
+    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)
+        $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
+        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
+  end
+end

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

@@ -0,0 +1,9 @@
+module Kernel
+  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
+  end
+end

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

@@ -0,0 +1,139 @@
+module Spec
+  module Runner
+    module Formatter
+      # Formatter base-class, which implements all required methods as no-ops, with the exception
+      class BaseFormatter
+        # Formatters are initialized with <tt>options</tt> and <tt>output</tt>
+        # arguments. RSpec's built-in formatters already expect this, and any
+        # custom formatters should as well.
+        #
+        # ==== Parameters
+        # options::
+        #   A struct containing boolean values for colour, autospec,
+        #   and dry_run
+        # output::
+        #   Used by RSpec's built-in formatters to determine where to
+        #   write the output. Default is <tt>STDOUT</tt>, otherwise a
+        #   filename is expected.
+        #
+        # === Example
+        # If you invoke the <tt>spec</tt> command with:
+        #
+        #   --format progress:progress_report.txt
+        #
+        # ... the value of <tt>output</tt> will be progress_report.txt. If you
+        # don't identify an output destination, the default is STDOUT.
+        def initialize(options, output)
+        end
+        
+        # This method is invoked before any examples are run, right after
+        # they have all been collected. This can be useful for special
+        # 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 #example_group_started
+        #
+        # ==== Parameters
+        # example_count:: the total number of examples to be run
+        def start(example_count)
+        end
+
+        # This method is invoked at the beginning of the execution of each
+        # example_group. The next method to be invoked after this is
+        # #example_started
+        #
+        # ==== Parameters
+        # example_group_proxy:: instance of Spec::Example::ExampleGroupProxy
+        def example_group_started(example_group_proxy)
+        end
+        
+        # Deprecated - use example_group_started instead
+        def add_example_group(example_group_proxy)
+          Spec.deprecate("BaseFormatter#add_example_group", "BaseFormatter#example_group_started")
+          example_group_started(example_group_proxy)
+        end
+
+        # This method is invoked when an +example+ starts. The next method to be
+        # invoked after this is #example_passed, #example_failed, or
+        # #example_pending
+        #
+        # ==== Parameters
+        # example_proxy:: instance of Spec::Example::ExampleProxy
+        def example_started(example_proxy)
+        end
+
+        # This method is invoked when an +example+ passes.
+        # +example_proxy+ is the same instance of Spec::Example::ExampleProxy
+        # that was passed to example_started
+        #
+        # ==== Parameters
+        # example_proxy:: instance of Spec::Example::ExampleProxy
+        def example_passed(example_proxy)
+        end
+
+        # This method is invoked when an +example+ fails, i.e. an exception occurred
+        # inside it (such as a failed should or other exception).
+        #
+        # ==== Parameters
+        # example_proxy::
+        #   The same instance of Spec::Example::ExampleProxy that was passed
+        #   to <tt>example_started</tt>
+        #
+        # counter:: the sequential number of this failure
+        #
+        # failure:: instance of Spec::Runner::Reporter::Failure
+        def example_failed(example_proxy, counter, failure)
+        end
+        
+        # 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.
+        # +message+ is the message from the ExamplePendingError, if it exists, or the
+        # default value of "Not Yet Implemented". +deprecated_pending_location+ is
+        # deprecated - use example_proxy.location instead
+        #
+        # ==== Parameters
+        # example_proxy:: instance of Spec::Example::ExampleProxy
+        # message::
+        #   the message passed to the pending message, or an internal
+        #   default
+        #
+        def example_pending(example_proxy, message, deprecated_pending_location=nil)
+        end
+
+        # This method is invoked after all of the examples have executed. The next method
+        # to be invoked after this one is #dump_failure (once for each failed example)
+        def start_dump
+        end
+
+        # Dumps detailed information about an example failure.
+        # This method is invoked for each failed example after all examples have run. +counter+ is the sequence number
+        # of the associated example. +failure+ is a Failure object, which contains detailed
+        # information about the failure.
+        #
+        # ==== Parameters
+        # counter:: the sequential number of this failure
+        # failure:: instance of Spec::Runner::Reporter::Failure
+        def dump_failure(counter, failure)
+        end
+      
+        # This method is invoked after the dumping of examples and failures.
+        #
+        # ==== Parameters
+        # duration:: the total time for the entire run
+        # example_count:: the number of examples run
+        # failure_count:: the number of examples that failed
+        # pending_count:: the number of examples that are pending
+        def dump_summary(duration, example_count, failure_count, pending_count)
+        end
+        
+        # This gets invoked after the summary
+        def dump_pending
+        end
+
+        # This method is invoked at the very end. Allows the formatter to clean up, like closing open streams.
+        def close
+        end
+      end
+    end
+  end
+end