rspec 0.8.2 → 0.9.0

data/lib/spec/runner/command_line.rb

@@ -10,24 +10,12 @@ module Spec
       # +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_context_runner = defined?($context_runner) ? $context_runner : nil
-        $context_runner = OptionParser.new.create_context_runner(argv, err, out, warn_if_no_files)
-        return if $context_runner.nil? # This is the case if we use --drb
+        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
 
-        # If ARGV is a glob, it will actually each over each one of the matching files.
-        argv.each do |file_or_dir|
-          if File.directory?(file_or_dir)
-            Dir["#{file_or_dir}/**/*.rb"].each do |file| 
-              load file
-            end
-          elsif File.file?(file_or_dir)
-            load file_or_dir
-          else
-            raise "File or directory not found: #{file_or_dir}"
-          end
-        end
-        $context_runner.run(exit)
-        $context_runner = old_context_runner
+        $behaviour_runner.run(argv, exit)
+        $behaviour_runner = old_behaviour_runner
       end
     end
   end

data/lib/spec/runner/drb_command_line.rb

@@ -9,8 +9,8 @@ module Spec
       def self.run(argv, stderr, stdout, exit=true, warn_if_no_files=true)
         begin
           DRb.start_service
-          rails_spec_server = DRbObject.new_with_uri("druby://localhost:8989")
-          rails_spec_server.run(argv, stderr, stdout)
+          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

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

@@ -1,17 +1,30 @@
 module Kernel
-  def context(name, &block)
-    context = Spec::Runner::Context.new(name, &block)
-    context_runner.add_context(context)
+  def describe(*args, &block)
+    raise ArgumentError if args.empty?
+    register_behaviour(Spec::DSL::BehaviourFactory.create(*args, &block))
   end
-
+  alias :context :describe
+  
+  def respond_to(*names)
+    Spec::Matchers::RespondTo.new(*names)
+  end
+  
 private
 
-  def context_runner
+  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 $context_runner; \
-      $context_runner = ::Spec::Runner::OptionParser.new.create_context_runner(ARGV.dup, STDERR, STDOUT, false); \
-      at_exit { $context_runner.run(false) }; \
+    unless $behaviour_runner; \
+      $behaviour_runner = ::Spec::Runner::OptionParser.new.create_behaviour_runner(ARGV.dup, STDERR, STDOUT, false); \
+      at_exit { $behaviour_runner.run(nil, false) }; \
     end
-    $context_runner
+    $behaviour_runner
   end
 end

data/lib/spec/runner/formatter.rb

@@ -1,5 +1,9 @@
+require 'spec/runner/formatter/base_formatter'
 require 'spec/runner/formatter/base_text_formatter'
 require 'spec/runner/formatter/progress_bar_formatter'
 require 'spec/runner/formatter/rdoc_formatter'
 require 'spec/runner/formatter/specdoc_formatter'
 require 'spec/runner/formatter/html_formatter'
+require 'spec/runner/formatter/failing_examples_formatter'
+require 'spec/runner/formatter/failing_behaviours_formatter'
+require 'spec/runner/formatter/snippet_extractor'

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

@@ -0,0 +1,63 @@
+module Spec
+  module Runner
+    module Formatter
+      # Baseclass for formatters that implements all required methods as no-ops. 
+      class BaseFormatter
+        def initialize(where)
+          @where = where
+        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 #add_behaviour
+        def start(example_count)
+        end
+
+        # This method is invoked at the beginning of the execution of each context.
+        # +name+ is the name of the context and +first+ is true if it is the
+        # first context - otherwise it's false.
+        #
+        # The next method to be invoked after this is #example_failed or #example_finished
+        def add_behaviour(name)
+        end
+
+        # This method is invoked when an example starts. +name+ is the name of the
+        # example.
+        def example_started(name)
+        end
+
+        # This method is invoked when an example passes. +name+ is the name of the
+        # example.
+        def example_passed(name)
+        end
+
+        # This method is invoked when an example fails, i.e. an exception occurred
+        # inside it (such as a failed should or other exception). +name+ is the name
+        # of the example. +counter+ is the sequence number of the failure
+        # (starting at 1) and +failure+ is the associated Failure object.
+        def example_failed(name, counter, failure)
+        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.
+        def dump_failure(counter, failure)
+        end
+      
+        # This method is invoked at the very end.
+        def dump_summary(duration, example_count, failure_count)
+        end
+
+      end
+    end
+  end
+end

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

@@ -4,58 +4,29 @@ module Spec
       # Baseclass for text-based formatters. Can in fact be used for
       # non-text based ones too - just ignore the +output+ constructor
       # argument.
-      class BaseTextFormatter
-        def initialize(output, dry_run=false, colour=false)
-          @output = output
-          @dry_run = dry_run
+      class BaseTextFormatter < BaseFormatter
+        attr_writer :dry_run
+        
+        # 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)
+          if where.is_a?(String)
+            @output = File.open(where, 'w')
+          else
+            @output = where
+          end
+          @colour = false
+          @dry_run = false
+          @snippet_extractor = SnippetExtractor.new
+        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
 
-        # This method is invoked before any specs 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 #add_context
-        def start(spec_count)
-        end
-
-        # This method is invoked at the beginning of the execution of each context.
-        # +name+ is the name of the context and +first+ is true if it is the
-        # first context - otherwise it's false.
-        #
-        # The next method to be invoked after this is #spec_started
-        def add_context(name, first)
-        end
-
-        # This method is invoked right before a spec is executed.
-        # The next method to be invoked after this one is one of #spec_failed
-        # or #spec_passed.
-        def spec_started(name)
-        end
-
-        # This method is invoked when a spec fails, i.e. an exception occurred
-        # inside it (such as a failed should or other exception). +name+ is the name
-        # of the specification. +counter+ is the sequence number of the failure
-        # (starting at 1) and +failure+ is the associated Failure object.
-        def spec_failed(name, counter, failure)
-        end
-
-        # This method is invoked when a spec passes. +name+ is the name of the
-        # specification.
-        def spec_passed(name)
-        end
-
-        # This method is invoked after all of the specs have executed. The next method
-        # to be invoked after this one is #dump_failure (once for each failed spec),
-        def start_dump
-        end
-
-        # Dumps detailed information about a spec failure.
-        # This method is invoked for each failed spec after all specs have run. +counter+ is the sequence number
-        # of the associated spec. +failure+ is a Failure object, which contains detailed
-        # information about the failure.
         def dump_failure(counter, failure)
           @output.puts
           @output.puts "#{counter.to_s})"
@@ -67,16 +38,15 @@ module Spec
             @output.puts magenta(failure.exception.message)
           end
           @output.puts format_backtrace(failure.exception.backtrace)
-          STDOUT.flush
+          @output.flush
         end
       
-        # This method is invoked at the very end.
-        def dump_summary(duration, spec_count, failure_count)
+        def dump_summary(duration, example_count, failure_count)
           return if @dry_run
           @output.puts
           @output.puts "Finished in #{duration} seconds"
           @output.puts
-          summary = "#{spec_count} specification#{'s' unless spec_count == 1}, #{failure_count} failure#{'s' unless failure_count == 1}"
+          summary = "#{example_count} example#{'s' unless example_count == 1}, #{failure_count} failure#{'s' unless failure_count == 1}"
           if failure_count == 0
             @output.puts green(summary)
           else

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

@@ -0,0 +1,25 @@
+module Spec
+  module Runner
+    module Formatter
+      class FailingBehavioursFormatter < BaseTextFormatter      
+        def add_behaviour(behaviour_name)
+          @behaviour_name = behaviour_name
+        end
+      
+        def example_failed(name, counter, failure)
+          unless @behaviour_name.nil?
+            @output.puts @behaviour_name 
+            @output.flush
+            @behaviour_name = nil
+          end
+        end
+
+        def dump_failure(counter, failure)
+        end
+
+        def dump_summary(duration, example_count, failure_count)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+module Spec
+  module Runner
+    module Formatter
+      class FailingExamplesFormatter < BaseTextFormatter      
+        def add_behaviour(behaviour_name)
+          @behaviour_name = behaviour_name
+        end
+      
+        def example_failed(name, counter, failure)
+          @output.puts "#{@behaviour_name} #{name}"
+          @output.flush
+        end
+
+        def dump_failure(counter, failure)
+        end
+
+        def dump_summary(duration, example_count, failure_count)
+        end
+      end
+    end
+  end
+end

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

@@ -2,65 +2,73 @@ module Spec
   module Runner
     module Formatter
       class HtmlFormatter < BaseTextFormatter
-        attr_reader :current_spec_number, :current_context_number
         
-        def initialize(output, dry_run=false, colour=false)
+        def initialize(output)
           super
-          @current_spec_number = 0
-          @current_context_number = 0
+          @current_behaviour_number = 0
+          @current_example_number = 0
         end
 
-        def start(spec_count)
-          @spec_count = spec_count
+        # The number of the currently running behaviour
+        def current_behaviour_number
+          @current_behaviour_number
+        end
+        
+        # The number of the currently running example
+        def current_example_number
+          @current_example_number
+        end
+        
+        def start(example_count)
+          @example_count = example_count
 
           @output.puts HEADER_1
           @output.puts extra_header_content unless extra_header_content.nil?
           @output.puts HEADER_2
-          STDOUT.flush
+          @output.flush
         end
 
-        def add_context(name, first)
-          @current_context_number += 1
-          unless first
+        def add_behaviour(name)
+          @current_behaviour_number += 1
+          unless current_behaviour_number == 1
             @output.puts "  </dl>"
             @output.puts "</div>"
           end
           @output.puts "<div class=\"context\">"
           @output.puts "  <dl>"
-          @output.puts "  <dt id=\"context_#{@current_context_number}\">#{name}</dt>"
-          STDOUT.flush
+          @output.puts "  <dt id=\"context_#{current_behaviour_number}\">#{escape(name)}</dt>"
+          @output.flush
         end
 
         def start_dump
           @output.puts "  </dl>"
           @output.puts "</div>"
-          STDOUT.flush
-        end
-
-        def spec_started(name)
-          @current_spec_number += 1
-          STDOUT.flush
+          @output.flush
         end
 
-        def spec_passed(name)
+        def example_passed(name)
+          @current_example_number += 1
           move_progress
           @output.puts "    <dd class=\"spec passed\"><span class=\"passed_spec_name\">#{escape(name)}</span></dd>"
-          STDOUT.flush
+          @output.flush
         end
 
-        def spec_failed(name, counter, failure)
+        def example_failed(name, counter, failure)
+          extra = extra_failure_content(failure)
+          
+          @current_example_number += 1
           @output.puts "    <script type=\"text/javascript\">makeRed('header');</script>"
-          @output.puts "    <script type=\"text/javascript\">makeRed('context_#{@current_context_number}');</script>"
+          @output.puts "    <script type=\"text/javascript\">makeRed('context_#{current_behaviour_number}');</script>"
           move_progress
           @output.puts "    <dd class=\"spec failed\">"
           @output.puts "      <span class=\"failed_spec_name\">#{escape(name)}</span>"
           @output.puts "      <div class=\"failure\" id=\"failure_#{counter}\">"
           @output.puts "        <div class=\"message\"><pre>#{escape(failure.exception.message)}</pre></div>" unless failure.exception.nil?
           @output.puts "        <div class=\"backtrace\"><pre>#{format_backtrace(failure.exception.backtrace)}</pre></div>" unless failure.exception.nil?
-          @output.puts extra_failure_content unless extra_failure_content.nil?
+          @output.puts extra unless extra == ""
           @output.puts "      </div>"
           @output.puts "    </dd>"
-          STDOUT.flush
+          @output.flush
         end
         
         # Override this method if you wish to output extra HTML in the header
@@ -71,11 +79,12 @@ module Spec
         # Override this method if you wish to output extra HTML for a failed spec. For example, you
         # could output links to images or other files produced during the specs.
         #
-        def extra_failure_content
+        def extra_failure_content(failure)
+          "    <pre class=\"ruby\"><code>#{@snippet_extractor.snippet(failure.exception)}</code></pre>"
         end
         
         def move_progress
-          percent_done = @spec_count == 0 ? 100.0 : (@current_spec_number.to_f / @spec_count.to_f * 1000).to_i / 10.0
+          percent_done = @example_count == 0 ? 100.0 : (current_example_number.to_f / @example_count.to_f * 1000).to_i / 10.0
           @output.puts "    <script type=\"text/javascript\">moveProgressBar('#{percent_done}');</script>"
         end
         
@@ -86,18 +95,18 @@ module Spec
         def dump_failure(counter, failure)
         end
 
-        def dump_summary(duration, spec_count, failure_count)
+        def dump_summary(duration, example_count, failure_count)
           if @dry_run
             totals = "This was a dry-run"
           else
-            totals = "#{spec_count} specification#{'s' unless spec_count == 1}, #{failure_count} failure#{'s' unless failure_count == 1}"
+            totals = "#{example_count} example#{'s' unless example_count == 1}, #{failure_count} failure#{'s' unless failure_count == 1}"
           end
           @output.puts "<script type=\"text/javascript\">document.getElementById('duration').innerHTML = \"Finished in <strong>#{duration} seconds</strong>\";</script>"
           @output.puts "<script type=\"text/javascript\">document.getElementById('totals').innerHTML = \"#{totals}\";</script>"
           @output.puts "</div>"
           @output.puts "</body>"
           @output.puts "</html>"
-          STDOUT.flush
+          @output.flush
         end
 
         HEADER_1 = <<-EOF
@@ -198,6 +207,42 @@ EOF
   a {
     color: #BE5C00;
   }
+
+  /* Ruby code, style similar to vibrant ink */
+  pre.ruby {
+    font-size: 12px;
+    font-family: monospace;
+    color: white;
+    background-color: black;
+    padding: 0.1em 0 0.2em 0;
+  }
+
+  .keyword { color: #FF6600; }
+  .constant { color: #339999; }
+  .attribute { color: white; }
+  .global { color: white; }
+  .module { color: white; }
+  .class { color: white; }
+  .string { color: #66FF00; }
+  .ident { color: white; }
+  .method { color: #FFCC00; }
+  .number { color: white; }
+  .char { color: white; }
+  .comment { color: #9933CC; }
+  .symbol { color: white; }
+  .regex { color: #44B4CC; }
+  .punct { color: white; }
+  .escape { color: white; }
+  .interp { color: white; }
+  .expr { color: white; }
+
+  .offending { background-color: gray; }
+  .linenum {
+  	width: 75px;
+  	padding: 0.1em 1em 0.2em 0;
+  	color: #000000;
+  	background-color: #FFFBD3;
+  }
   </style>
 </head>
 <body>