rspec-instructure 1.3.3

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,32 @@
+require "drb/drb"
+
+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(options)
+        begin
+          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
+          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,62 @@
+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
+
+        if $rerun_success
+          success = true
+        end
+        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

@@ -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

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

@@ -0,0 +1,142 @@
+require 'spec/runner/formatter/base_formatter'
+require 'fileutils'
+
+module Spec
+  module Runner
+    module Formatter
+      # Baseclass for text-based formatters. Can in fact be used for
+      # non-text based ones too - just ignore the +output+ constructor
+      # argument.
+      class BaseTextFormatter < BaseFormatter
+        attr_reader :output, :example_group
+        # Creates a new instance that will write to +output+. If +output+ is a
+        # String, output will be written to the File with that name, otherwise
+        # +output+ is exected to be an IO (or an object that responds to #puts
+        # and #write).
+        def initialize(options, output)
+          @options = options
+          if String === output
+            FileUtils.mkdir_p(File.dirname(output))
+            @output = File.open(output, 'w')
+          else
+            @output = output
+          end
+          @pending_examples = []
+        end
+
+        def example_group_started(example_group_proxy)
+          @example_group = example_group_proxy
+        end
+        
+        def example_pending(example, message, deprecated_pending_location=nil)
+          @pending_examples << ["#{@example_group.description} #{example.description}", message, example.location]
+        end
+        
+        def dump_failure(counter, failure)
+          @output.puts
+          @output.puts "#{counter.to_s})"
+          @output.puts colorize_failure("#{failure.header}\n#{failure.exception.message}", failure)
+          @output.puts format_backtrace(failure.exception.backtrace)
+          @output.flush
+        end
+        
+        def colorize_failure(message, failure)
+          failure.pending_fixed? ? blue(message) : red(message)
+        end
+        
+        def colourise(message, failure)
+          Spec::deprecate("BaseTextFormatter#colourise", "colorize_failure")
+          colorize_failure(message, failure)
+        end
+        
+        def dump_summary(duration, example_count, failure_count, pending_count)
+          return if dry_run?
+          @output.puts
+          @output.puts "Finished in #{duration} seconds"
+          @output.puts
+
+          summary = "#{example_count} example#{'s' unless example_count == 1}, #{failure_count} failure#{'s' unless failure_count == 1}"
+          summary << ", #{pending_count} pending" if pending_count > 0  
+
+          if failure_count == 0
+            if pending_count > 0
+              @output.puts yellow(summary)
+            else
+              @output.puts green(summary)
+            end
+          else
+            @output.puts red(summary)
+          end
+          @output.flush
+        end
+
+        def dump_pending
+          unless @pending_examples.empty?
+            @output.puts
+            @output.puts "Pending:"
+            @pending_examples.each do |pending_example|
+              @output.puts "\n#{pending_example[0]} (#{pending_example[1]})"
+              @output.puts "#{pending_example[2]}\n"
+            end
+          end
+          @output.flush
+        end
+        
+        def close
+          @output.close  if (IO === @output) & (@output != $stdout)
+        end
+        
+        def format_backtrace(backtrace)
+          return "" if backtrace.nil?
+          backtrace.map { |line| backtrace_line(line) }.join("\n")
+        end
+      
+      protected
+
+        def colour?
+          !!@options.colour
+        end
+
+        def dry_run?
+          !!@options.dry_run
+        end
+        
+        def autospec?
+          !!@options.autospec || ENV.has_key?("AUTOTEST")
+        end
+        
+        def backtrace_line(line)
+          line.sub(/\A([^:]+:\d+)$/, '\\1:')
+        end
+
+        def colour(text, colour_code)
+          return text if output_to_file?
+          return text unless ENV['RSPEC_COLOR'] || (colour? & (autospec? || output_to_tty?)) 
+          "#{colour_code}#{text}\e[0m"
+        end
+
+        def output_to_file?
+          File === @output
+        end
+        
+        def output_to_tty?
+          begin
+            @output.tty?
+          rescue NoMethodError
+            false
+          end
+        end
+        
+        def green(text); colour(text, "\e[32m"); end
+        def red(text); colour(text, "\e[31m"); end
+        def yellow(text); colour(text, "\e[33m"); end
+        def blue(text); colour(text, "\e[34m"); end
+        
+        def magenta(text)
+          Spec::deprecate("BaseTextFormatter#magenta")
+          red(text)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+require 'spec/runner/formatter/base_text_formatter'
+
+module Spec
+  module Runner
+    module Formatter
+      class FailingExampleGroupsFormatter < BaseTextFormatter
+        def example_failed(example, counter, failure)
+          if @example_group
+            @output.puts @example_group.description.gsub(/ \(druby.*\)/,"")
+
+            @output.flush
+            @example_group = nil
+          end
+        end
+        
+        def dump_failure(counter, failure)
+        end
+
+        def dump_summary(duration, example_count, failure_count, pending_count)
+        end
+        
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+require 'spec/runner/formatter/base_text_formatter'
+
+module Spec
+  module Runner
+    module Formatter
+      class FailingExamplesFormatter < BaseTextFormatter      
+        def example_failed(example, counter, failure)
+          @output.puts "#{example_group.description} #{example.description}"
+          @output.flush
+        end
+
+        def dump_failure(counter, failure)
+        end
+
+        def dump_summary(duration, example_count, failure_count, pending_count)
+        end
+      end
+    end
+  end
+end