dchelimsky-rspec 1.1.10

data/lib/spec/runner/reporter.rb

@@ -0,0 +1,167 @@
+module Spec
+  module Runner
+    class Reporter
+      attr_reader :options, :example_groups
+      
+      def initialize(options)
+        @options = options
+        @options.reporter = self
+        clear
+      end
+      
+      def add_example_group(example_group)
+        formatters.each do |f|
+          f.add_example_group(example_group)
+        end
+        example_groups << example_group
+      end
+      
+      def example_started(example)
+        formatters.each{|f| f.example_started(example)}
+      end
+      
+      def example_finished(example, error=nil)
+        @examples << example
+        
+        if error.nil?
+          example_passed(example)
+        elsif Spec::Example::ExamplePendingError === error
+          example_pending(example, error.pending_caller, error.message)
+        else
+          example_failed(example, error)
+        end
+      end
+
+      def failure(example, error)
+        backtrace_tweaker.tweak_backtrace(error)
+        failure = Failure.new(example, error)
+        @failures << failure
+        formatters.each do |f|
+          f.example_failed(example, @failures.length, failure)
+        end
+      end
+      alias_method :example_failed, :failure
+
+      def start(number_of_examples)
+        clear
+        @start_time = Time.new
+        formatters.each{|f| f.start(number_of_examples)}
+      end
+  
+      def end
+        @end_time = Time.new
+      end
+  
+      # Dumps the summary and returns the total number of failures
+      def dump
+        formatters.each{|f| f.start_dump}
+        dump_pending
+        dump_failures
+        formatters.each do |f|
+          f.dump_summary(duration, @examples.length, @failures.length, @pending_count)
+          f.close
+        end
+        @failures.length
+      end
+
+    private
+
+      def formatters
+        @options.formatters
+      end
+
+      def backtrace_tweaker
+        @options.backtrace_tweaker
+      end
+  
+      def clear
+        @example_groups = []
+        @failures = []
+        @pending_count = 0
+        @examples = []
+        @start_time = nil
+        @end_time = nil
+      end
+  
+      def dump_failures
+        return if @failures.empty?
+        @failures.inject(1) do |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(example)
+        formatters.each{|f| f.example_passed(example)}
+      end
+
+      EXAMPLE_PENDING_DEPRECATION_WARNING = <<-WARNING
+        DEPRECATION NOTICE: RSpec's formatters have changed example_pending
+        to accept three arguments instead of just two. Please see the rdoc
+        for Spec::Runner::Formatter::BaseFormatter#example_pending
+        for more information.
+          
+        Please update any custom formatters to accept the third argument
+        to example_pending. Support for example_pending with two arguments
+        and this warning message will be removed after the RSpec 1.1.5 release.
+      WARNING
+      
+      def example_pending(example, pending_caller, message="Not Yet Implemented")
+        @pending_count += 1
+        formatters.each do |formatter|
+          if formatter_uses_deprecated_example_pending_method?(formatter)
+            Kernel.warn EXAMPLE_PENDING_DEPRECATION_WARNING
+            formatter.example_pending(example, message)
+          else
+            formatter.example_pending(example, message, pending_caller)
+          end
+        end
+      end
+      
+      def formatter_uses_deprecated_example_pending_method?(formatter)
+        formatter.method(:example_pending).arity == 2
+      end
+      
+      class Failure
+        attr_reader :example, :exception
+        
+        def initialize(example, exception)
+          @example = example
+          @exception = exception
+        end
+
+        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?
+          @exception.is_a?(Spec::Example::PendingExampleFixedError)
+        end
+
+        def expectation_not_met?
+          @exception.is_a?(Spec::Expectations::ExpectationNotMetError)
+        end
+
+        protected
+        def example_name
+          @example.__full_description
+        end
+      end
+    end
+  end
+end

data/lib/spec/runner/spec_parser.rb

@@ -0,0 +1,71 @@
+module Spec
+  module Runner
+    # Parses a spec file and finds the nearest example for a given line number.
+    class SpecParser
+      attr_reader :best_match
+
+      def initialize
+        @best_match = {}
+      end
+
+      def spec_name_for(file, line_number)
+        best_match.clear
+        file = File.expand_path(file)
+        Spec::Runner.options.example_groups.each do |example_group|
+          consider_example_groups_for_best_match example_group, file, line_number
+
+          example_group.examples.each do |example|
+            consider_example_for_best_match example, example_group, file, line_number
+          end
+        end
+        if best_match[:example_group]
+          if best_match[:example]
+            "#{best_match[:example_group].description} #{best_match[:example].description}"
+          else
+            best_match[:example_group].description
+          end
+        else
+          nil
+        end
+      end
+
+    protected
+
+      def consider_example_groups_for_best_match(example_group, file, line_number)
+        parsed_backtrace = parse_backtrace(example_group.registration_backtrace)
+        parsed_backtrace.each do |example_file, example_line|
+          if is_best_match?(file, line_number, example_file, example_line)
+            best_match.clear
+            best_match[:example_group] = example_group
+            best_match[:line] = example_line
+          end
+        end
+      end
+
+      def consider_example_for_best_match(example, example_group, file, line_number)
+        parsed_backtrace = parse_backtrace(example.implementation_backtrace)
+        parsed_backtrace.each do |example_file, example_line|
+          if is_best_match?(file, line_number, example_file, example_line)
+            best_match.clear
+            best_match[:example_group] = example_group
+            best_match[:example] = example
+            best_match[:line] = example_line
+          end
+        end
+      end
+
+      def is_best_match?(file, line_number, example_file, example_line)
+        file == File.expand_path(example_file) &&
+        example_line <= line_number &&
+        example_line > best_match[:line].to_i
+      end
+
+      def parse_backtrace(backtrace)
+        backtrace.collect do |trace_line|
+          split_line = trace_line.split(':')
+          [split_line[0], Integer(split_line[1])]
+        end
+      end
+    end
+  end
+end

data/lib/spec/runner.rb

@@ -0,0 +1,213 @@
+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/spec_parser'
+require 'spec/runner/class_and_arguments_parser'
+
+module Spec
+  # == ExampleGroups and Examples
+  # 
+  # Rather than expressing examples in classes, RSpec uses a custom DSLL (DSL light) to 
+  # describe groups of examples.
+  # 
+  # A ExampleGroup 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 Example (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 Example. 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 Example Groups
+  # 
+  # You can define a shared Example Group, that may be used on other groups
+  #
+  #  share_examples_for "All Editions" do
+  #    it "all editions behaviour" ...
+  #  end
+  #
+  #  describe SmallEdition do
+  #    it_should_behave_like "All Editions"
+  #  
+  #    it "should do small edition stuff" do
+  #      ...
+  #    end
+  #  end
+  #
+  # You can also assign the shared group to a module and include that
+  #
+  #  share_as :AllEditions 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::Example::Configuration.new
+      end
+      
+      # Use this to configure various configurable aspects of
+      # RSpec:
+      #
+      #   Spec::Runner.configure do |configuration|
+      #     # Configure RSpec here
+      #   end
+      #
+      # The yielded <tt>configuration</tt> object is a
+      # Spec::Example::Configuration instance. See its RDoc
+      # for details about what you can do with it.
+      #
+      def configure
+        yield configuration
+      end
+      
+      def register_at_exit_hook # :nodoc:
+        unless @already_registered_at_exit_hook
+          at_exit do
+            unless $! || Spec.run? || Spec::Example::ExampleGroupFactory.all_registered?(options.example_groups)
+              success = Spec.run
+              exit success if Spec.exit?
+            end
+          end
+          @already_registered_at_exit_hook = true
+        end
+      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
+
+    end
+  end
+end