rspec 1.1.3 → 1.1.4

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

@@ -0,0 +1,65 @@
+require 'spec/runner/formatter/base_text_formatter'
+
+module Spec
+  module Runner
+    module Formatter
+      class NestedTextFormatter < BaseTextFormatter
+        attr_reader :previous_nested_example_groups
+        def initialize(options, where)
+          super
+          @previous_nested_example_groups = []
+        end
+
+        def add_example_group(example_group)
+          super
+
+          current_nested_example_groups = described_example_group_chain
+          current_nested_example_groups.each_with_index do |nested_example_group, i|
+            unless nested_example_group == previous_nested_example_groups[i]
+              output.puts "#{'  ' * i}#{nested_example_group.description_args}"
+            end
+          end
+
+          @previous_nested_example_groups = described_example_group_chain
+        end
+
+        def example_failed(example, counter, failure)
+          message = if failure.expectation_not_met?
+            "#{current_indentation}#{example.description} (FAILED - #{counter})"
+          else
+            "#{current_indentation}#{example.description} (ERROR - #{counter})"
+          end
+
+          output.puts(failure.expectation_not_met? ? red(message) : magenta(message))
+          output.flush
+        end
+
+        def example_passed(example)
+          message = "#{current_indentation}#{example.description}"
+          output.puts green(message)
+          output.flush
+        end
+
+        def example_pending(example, message)
+          super
+          output.puts yellow("#{current_indentation}#{example.description} (PENDING: #{message})")
+          output.flush
+        end
+
+        def current_indentation
+          '  ' * previous_nested_example_groups.length
+        end
+
+        def described_example_group_chain
+          example_group_chain = []
+          example_group.send(:execute_in_class_hierarchy) do |parent_example_group|
+            if parent_example_group.description_args && !parent_example_group.description_args.empty?
+              example_group_chain << parent_example_group
+            end
+          end
+          example_group_chain
+        end
+      end
+    end
+  end
+end

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

@@ -41,6 +41,10 @@ module Spec
           end
           @output.flush
         end
+        
+        def method_missing(sym, *args)
+          # ignore
+        end
       end
     end
   end

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

@@ -14,7 +14,7 @@ module Spec
           @output.flush
         end
       
-        def example_pending(example_group_description, example, message)
+        def example_pending(example, message)
           super
           @output.print yellow('P')
           @output.flush
@@ -24,6 +24,10 @@ module Spec
           @output.puts
           @output.flush
         end
+        
+        def method_missing(sym, *args)
+          # ignore
+        end
       end
     end
   end

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

@@ -28,7 +28,7 @@ module Spec
           output.flush
         end
         
-        def example_pending(example_group_description, example, message)
+        def example_pending(example, message)
           super
           output.puts yellow("- #{example.description} (PENDING: #{message})")
           output.flush

data/lib/spec/runner/formatter/story/plain_text_formatter.rb

@@ -38,6 +38,7 @@ module Spec
             @scenario_already_failed = false
             @output.print "\n\n  Scenario: #{scenario_name}"
             @scenario_ok = true
+            @scenario_pending = false
           end
         
           def scenario_succeeded(story_title, scenario_name)
@@ -52,6 +53,7 @@ module Spec
         
           def scenario_pending(story_title, scenario_name, msg)
             @pending_scenario_count += 1 unless @scenario_already_failed
+            @scenario_pending = true
             @scenario_already_failed = true
           end
         
@@ -81,19 +83,24 @@ module Spec
           end
                   
           def step_succeeded(type, description, *args)
-            found_step(type, description, false, *args)
+            found_step(type, description, false, false, *args)
           end
         
           def step_pending(type, description, *args)
-            found_step(type, description, false, *args)
+            found_step(type, description, false, true, *args)
             @pending_steps << [@current_story_title, @current_scenario_name, description]
-            @output.print " (PENDING)"
+            @output.print yellow(" (PENDING)")
+            @scenario_pending = true
             @scenario_ok = false
           end
         
           def step_failed(type, description, *args)
-            found_step(type, description, true, *args)
-            @output.print red(@scenario_ok ? " (FAILED)" : " (SKIPPED)")
+            found_step(type, description, true, @scenario_pending, *args)
+            if @scenario_pending
+              @output.print yellow(" (SKIPPED)")
+            else
+              @output.print red(@scenario_ok ? " (FAILED)" : " (SKIPPED)")
+            end
             @scenario_ok = false
           end
           
@@ -106,7 +113,7 @@ module Spec
 
         private
 
-          def found_step(type, description, failed, *args)
+          def found_step(type, description, failed, pending, *args)
             desc_string = description.step_name
             arg_regexp = description.arg_regexp
             text = if(type == @previous_type)
@@ -116,7 +123,11 @@ module Spec
             end
             i = -1
             text << desc_string.gsub(arg_regexp) { |param| args[i+=1] }
-            @output.print(failed ? red(text) : green(text))
+            if pending
+              @output.print yellow(text)
+            else
+              @output.print(failed ? red(text) : green(text))
+            end
 
             if type == :'given scenario'
               @previous_type = :given

data/lib/spec/runner/option_parser.rb

@@ -19,7 +19,7 @@ module Spec
                                                  "Separate multiple patterns with commas.",
                                                  "Applies only to directories named on the command line (files",
                                                  "named explicitly on the command line will be loaded regardless)."],
-        :diff =>    ["-D", "--diff [FORMAT]", "Show diff of objects that are expected to be equal when they are not",
+        :diff =>    ["-D", "--diff [FORMAT]","Show diff of objects that are expected to be equal when they are not",
                                              "Builtin formats: unified|u|context|c",
                                              "You can also specify a custom differ class",
                                              "(in which case you should also specify --require)"],
@@ -36,7 +36,7 @@ module Spec
         :specification => ["-s", "--specification [NAME]", "DEPRECATED - use -e instead", "(This will be removed when autotest works with -e)"],
         :line => ["-l", "--line LINE_NUMBER", Integer, "Execute behaviout or specification at given line.",
                                                        "(does not work for dynamically generated specs)"],
-        :format => ["-f", "--format FORMAT[:WHERE]",  "Specifies what format to use for output. Specify WHERE to tell",
+        :format => ["-f", "--format FORMAT[:WHERE]","Specifies what format to use for output. Specify WHERE to tell",
                                                     "the formatter where to write the output. All built-in formats",
                                                     "expect WHERE to be a file name, and will write to STDOUT if it's",
                                                     "not specified. The --format option may be specified several times",
@@ -46,6 +46,7 @@ module Spec
                                                     "progress|p               : Text progress",
                                                     "profile|o                : Text progress with profiling of 10 slowest examples",
                                                     "specdoc|s                : Example doc as text",
+                                                    "indented|i               : Example doc as indented text",
                                                     "html|h                   : A nice HTML report",
                                                     "failing_examples|e       : Write all failing examples - input for --example",
                                                     "failing_example_groups|g : Write all failing example groups - input for --example",
@@ -57,13 +58,13 @@ module Spec
                                                     "FORMAT can also be the name of a custom formatter class",
                                                     "(in which case you should also specify --require to load it)"],
         :require => ["-r", "--require FILE", "Require FILE before running specs",
-                                          "Useful for loading custom formatters or other extensions.",
-                                          "If this option is used it must come before the others"],
+                                             "Useful for loading custom formatters or other extensions.",
+                                             "If this option is used it must come before the others"],
         :backtrace => ["-b", "--backtrace", "Output full backtrace"],
         :loadby => ["-L", "--loadby STRATEGY", "Specify the strategy by which spec files should be loaded.",
-                                              "STRATEGY can currently only be 'mtime' (File modification time)",
-                                              "By default, spec files are loaded in alphabetical order if --loadby",
-                                              "is not specified."],
+                                               "STRATEGY can currently only be 'mtime' (File modification time)",
+                                               "By default, spec files are loaded in alphabetical order if --loadby",
+                                               "is not specified."],
         :reverse => ["-R", "--reverse", "Run examples in reverse order"],
         :timeout => ["-t", "--timeout FLOAT", "Interrupt and fail each example that doesn't complete in the",
                                               "specified time"],
@@ -107,11 +108,8 @@ module Spec
         on(*OPTIONS[:heckle]) {|heckle| @options.load_heckle_runner(heckle)}
         on(*OPTIONS[:dry_run]) {@options.dry_run = true}
         on(*OPTIONS[:options_file]) {|options_file| parse_options_file(options_file)}
-        on(*OPTIONS[:generate_options]) do |options_file|
-        end
-        on(*OPTIONS[:runner]) do |runner|
-          @options.user_input_for_runner = runner
-        end
+        on(*OPTIONS[:generate_options]) {|options_file|}
+        on(*OPTIONS[:runner]) {|runner|  @options.user_input_for_runner = runner}
         on(*OPTIONS[:drb]) {}
         on(*OPTIONS[:version]) {parse_version}
         on_tail(*OPTIONS[:help]) {parse_help}
@@ -141,6 +139,10 @@ module Spec
       def parse_options_file(options_file)
         option_file_args = IO.readlines(options_file).map {|l| l.chomp.split " "}.flatten
         @argv.push(*option_file_args)
+        # TODO - this is a brute force solution to http://rspec.lighthouseapp.com/projects/5645/tickets/293.
+        # Let's look for a cleaner way. Might not be one. But let's look. If not, perhaps
+        # this can be moved to a different method to indicate the special handling for drb?
+        parse_drb(@argv)
       end
 
       def parse_generate_options
@@ -170,12 +172,12 @@ module Spec
         @options.examples_should_not_be_run
       end
 
-      def parse_drb
+      def parse_drb(argv = nil)
+        argv ||= @options.argv # TODO - see note about about http://rspec.lighthouseapp.com/projects/5645/tickets/293
         is_drb = false
-        argv = @options.argv
         is_drb ||= argv.delete(OPTIONS[:drb][0])
         is_drb ||= argv.delete(OPTIONS[:drb][1])
-        return nil unless is_drb
+        return false unless is_drb
         @options.examples_should_not_be_run
         DrbCommandLine.run(
           self.class.parse(argv, @error_stream, @out_stream)

data/lib/spec/runner/options.rb

@@ -8,6 +8,8 @@ module Spec
       EXAMPLE_FORMATTERS = { # Load these lazily for better speed
                'specdoc' => ['spec/runner/formatter/specdoc_formatter',                'Formatter::SpecdocFormatter'],
                      's' => ['spec/runner/formatter/specdoc_formatter',                'Formatter::SpecdocFormatter'],
+                'nested' => ['spec/runner/formatter/nested_text_formatter',          'Formatter::NestedTextFormatter'],
+                     'n' => ['spec/runner/formatter/nested_text_formatter',            'Formatter::NestedTextFormatter'],
                   'html' => ['spec/runner/formatter/html_formatter',                   'Formatter::HtmlFormatter'],
                      'h' => ['spec/runner/formatter/html_formatter',                   'Formatter::HtmlFormatter'],
               'progress' => ['spec/runner/formatter/progress_bar_formatter',           'Formatter::ProgressBarFormatter'],
@@ -46,6 +48,8 @@ module Spec
         :user_input_for_runner,
         :error_stream,
         :output_stream,
+        :before_suite_parts,
+        :after_suite_parts,
         # TODO: BT - Figure out a better name
         :argv
       )
@@ -65,9 +69,12 @@ module Spec
         @diff_format  = :unified
         @files = []
         @example_groups = []
+        @result = nil
         @examples_run = false
         @examples_should_be_run = nil
         @user_input_for_runner = nil
+        @before_suite_parts = []
+        @after_suite_parts = []
       end
 
       def add_example_group(example_group)
@@ -80,17 +87,31 @@ module Spec
 
       def run_examples
         return true unless examples_should_be_run?
-        runner = custom_runner || ExampleGroupRunner.new(self)
+        success = true
+        begin
+          before_suite_parts.each do |part|
+            part.call
+          end
+          runner = custom_runner || ExampleGroupRunner.new(self)
 
-        runner.load_files(files_to_load)
-        if example_groups.empty?
-          true
-        else
-          set_spec_from_line_number if line_number
-          success = runner.run
-          @examples_run = true
-          heckle if heckle_runner
-          success
+          unless @files_loaded
+            runner.load_files(files_to_load)
+            @files_loaded = true
+          end
+
+          if example_groups.empty?
+            true
+          else
+            set_spec_from_line_number if line_number
+            success = runner.run
+            @examples_run = true
+            heckle if heckle_runner
+            success
+          end
+        ensure
+          after_suite_parts.each do |part|
+            part.call(success)
+          end
         end
       end
 
@@ -177,9 +198,11 @@ module Spec
       end
 
       def number_of_examples
-        @example_groups.inject(0) do |sum, example_group|
-          sum + example_group.number_of_examples
+        total = 0
+        @example_groups.each do |example_group|
+          total += example_group.number_of_examples
         end
+        total
       end
 
       def files_to_load
@@ -240,9 +263,9 @@ module Spec
       end
       
       def heckle
-        returns = self.heckle_runner.heckle_with
+        heckle_runner = self.heckle_runner
         self.heckle_runner = nil
-        returns
+        heckle_runner.heckle_with
       end
       
       def sorted_files

data/lib/spec/runner/reporter.rb

@@ -26,7 +26,7 @@ module Spec
         if error.nil?
           example_passed(example)
         elsif Spec::Example::ExamplePendingError === error
-          example_pending(example_groups.last, example, error.message)
+          example_pending(example, error.message)
         else
           example_failed(example, error)
         end
@@ -34,8 +34,7 @@ module Spec
 
       def failure(example, error)
         backtrace_tweaker.tweak_backtrace(error)
-        example_name = "#{example_groups.last.description} #{example.description}"
-        failure = Failure.new(example_name, error)
+        failure = Failure.new(example, error)
         @failures << failure
         formatters.each do |f|
           f.example_failed(example, @failures.length, failure)
@@ -91,6 +90,7 @@ module Spec
           index + 1
         end
       end
+
       def dump_pending
         formatters.each{|f| f.dump_pending}
       end
@@ -104,28 +104,28 @@ module Spec
         formatters.each{|f| f.example_passed(example)}
       end
       
-      def example_pending(example_group, example, message="Not Yet Implemented")
+      def example_pending(example, message="Not Yet Implemented")
         @pending_count += 1
         formatters.each do |f|
-          f.example_pending(example_group.description, example, message)
+          f.example_pending(example, message)
         end
       end
       
       class Failure
-        attr_reader :exception
+        attr_reader :example, :exception
         
-        def initialize(example_name, exception)
-          @example_name = example_name
+        def initialize(example, exception)
+          @example = example
           @exception = exception
         end
 
         def header
           if expectation_not_met?
-            "'#{@example_name}' FAILED"
+            "'#{example_name}' FAILED"
           elsif pending_fixed?
-            "'#{@example_name}' FIXED"
+            "'#{example_name}' FIXED"
           else
-            "#{@exception.class.name} in '#{@example_name}'"
+            "#{@exception.class.name} in '#{example_name}'"
           end
         end
         
@@ -137,6 +137,10 @@ module Spec
           @exception.is_a?(Spec::Expectations::ExpectationNotMetError)
         end
 
+        protected
+        def example_name
+          @example.__full_description
+        end
       end
     end
   end

data/lib/spec/story/extensions/regexp.rb

@@ -1,9 +1,9 @@
 class Regexp
   def step_name
-    self.source
+    self.source.gsub '\\$', '$$'
   end
   
   def arg_regexp
     ::Spec::Story::Step::PARAM_OR_GROUP_PATTERN
   end
-end
+end

data/lib/spec/story/extensions/string.rb

@@ -4,6 +4,6 @@ class String
   end
   
   def arg_regexp
-    ::Spec::Story::Step::PARAM_PATTERN
+    ::Spec::Story::Step::PARAM_OR_GROUP_PATTERN
   end
-end
+end