rspec-core 2.12.2 → 2.13.0

data/features/configuration/run_all_when_everything_filtered.feature

@@ -0,0 +1,60 @@
+Feature: run all when everything filtered
+
+  Use the run_all_when_everything_filtered option to tell RSpec to run
+  all the specs in the case where you try to run a filtered list of
+  specs but no specs match that filter.
+
+    RSpec.configure { |c| c.run_all_when_everything_filtered = true }
+
+  Background:
+    Given a file named "spec/spec_helper.rb" with:
+      """ruby
+      RSpec.configure {|c| c.run_all_when_everything_filtered = true}
+      """
+
+  Scenario: by default, no specs are run if they are all filtered out
+    Given a file named "spec/example_spec.rb" with:
+      """ruby
+      describe "examples" do
+        it "with no tag" do
+        end
+
+        it "with no tag as well" do
+        end
+      end
+      """
+    When I run `rspec spec/example_spec.rb --tag some_tag`
+    Then the output should contain "0 examples, 0 failures"
+
+  Scenario: when the run_all_when_everything_filtered option is turned on, if there are any matches for the filtering tag, only those features are run
+    Given a file named "spec/example_spec.rb" with:
+      """ruby
+      require "spec_helper"
+      describe "examples" do
+        it "with no tag", :some_tag => true do
+        end
+
+        it "with no tag as well" do
+        end
+      end
+      """
+    When I run `rspec spec/example_spec.rb --tag some_tag`
+    Then the output should contain "1 example, 0 failures"
+    And the output should contain "Run options: include {:some_tag=>true}"
+
+  Scenario: when the run_all_when_everything_filtered option is turned on, all the specs are run when the tag has no matches
+    Given a file named "spec/example_spec.rb" with:
+      """ruby
+      require "spec_helper"
+      describe "examples" do
+        it "with no tag" do
+        end
+
+        it "with no tag as well" do
+        end
+      end
+      """
+    When I run `rspec spec/example_spec.rb --tag some_tag`
+    Then the output should contain "2 examples, 0 failures"
+    And the output should contain "All examples were filtered out; ignoring {:some_tag=>true}"
+

data/features/configuration/show_failures_in_pending_blocks.feature

@@ -0,0 +1,61 @@
+Feature: show_failures_in_pending_blocks
+
+  Use the show_failures_in_pending_blocks option to run the code in pending blocks while keeping the tests pending.
+
+    RSpec.configure { |c| c.show_failures_in_pending_blocks = true }
+
+  Background:
+    Given a file named "spec/spec_helper.rb" with:
+      """ruby
+      RSpec.configure {|c| c.show_failures_in_pending_blocks = true}
+      """
+
+  Scenario: by default, code in pending examples is not exercised
+    Given a file named "spec/example_spec.rb" with:
+      """ruby
+      describe "fails" do
+        pending "code will not be exercised" do
+          fail
+        end
+      end
+      """
+    When I run `rspec spec/example_spec.rb`
+    Then the output should not contain "Failure/Error: pending { fail }"
+
+  Scenario: by default, code in pending blocks inside examples is not exercised
+    Given a file named "spec/example_spec.rb" with:
+      """ruby
+      describe "fails" do
+        it "code will not be exercised" do
+          pending { fail }
+        end
+      end
+      """
+    When I run `rspec spec/example_spec.rb`
+    Then the output should not contain "Failure/Error: pending { fail }"
+
+  Scenario: when turned on, pending code blocks inside examples are exercised
+    Given a file named "spec/example_spec.rb" with:
+      """ruby
+      require "spec_helper"
+      describe "fails" do
+        it "code will be exercised" do
+          pending { fail }
+        end
+      end
+      """
+    When I run `rspec spec/example_spec.rb`
+    Then the output should contain "Failure/Error: pending { fail }"
+
+  Scenario: when turned on, code inside pending examples is not exercised
+    Given a file named "spec/example_spec.rb" with:
+      """ruby
+      require "spec_helper"
+      describe "fails" do
+        pending "code will not be exercised" do
+          fail
+        end
+      end
+      """
+    When I run `rspec spec/example_spec.rb`
+    Then the output should not contain "Failure/Error: pending { fail }"

data/features/configuration/treat_symbols_as_metadata_keys_with_true_values.feature

@@ -0,0 +1,52 @@
+Feature: treat symbols as metadata keys with true values
+
+  Use the treat_symbols_as_metadata_keys_with_true_values option to tell RSpec that :key is shorthand for :key => true.
+
+    RSpec.configure { |c| c.treat_symbols_as_metadata_keys_with_true_values = true }
+
+  Background:
+    Given a file named "spec/spec_helper.rb" with:
+      """ruby
+      RSpec.configure { |c| c.treat_symbols_as_metadata_keys_with_true_values = true }
+      """
+
+  Scenario: by default, symbols without values are ignored and the specs are filtered out
+    Given a file named "spec/example_spec.rb" with:
+      """ruby
+      describe "failed filtering" do
+        it "this will be filted out", :some_tag do
+          true
+        end
+
+        it "so will this" do
+          false
+        end
+      end
+      """
+      When I run `rspec spec/example_spec.rb --tag some_tag`
+      Then the output should contain "0 examples, 0 failures"
+      And the output should contain "All examples were filtered out"
+
+  Scenario: when treat_symbols_as_metadata_keys_with_true_values is true, specs can be tagged with only a symbol
+    Given a file named "spec/example_spec.rb" with:
+      """ruby
+      require "spec_helper"
+      describe "run me", :some_tag do
+        it "runs" do
+          true
+        end
+      end
+
+      describe "run one of these" do
+        it "run this one", :some_tag do
+          true
+        end
+
+        it "but not me" do
+          false
+        end
+      end
+      """
+      When I run `rspec spec/example_spec.rb --tag some_tag`
+      Then the output should contain "2 examples, 0 failures"
+      And the output should contain "Run options: include {:some_tag=>true}"

data/features/filtering/exclusion_filters.feature

@@ -81,8 +81,7 @@ Feature: exclusion filters
       end
       """
     When I run `rspec ./spec/sample_spec.rb --format doc`
-    Then the output should match /All examples were filtered out/
-    And  the examples should all pass
+    Then the process should succeed even though no examples were run
     And  the output should not contain "group 1"
     And  the output should not contain "group 2"
 

data/features/formatters/configurable_colors.feature

@@ -0,0 +1,31 @@
+Feature: Configurable colors
+
+  RSpec allows you to configure the terminal colors used in the text formatters.
+
+  * `failure_color`: Color used when tests fail (default: `:red`)
+  * `success_color`: Color used when tests pass (default: `:green`)
+  * `pending_color`: Color used when tests are pending (default: `:yellow`)
+  * `fixed_color`: Color used when a pending block inside an example passes, but was expected to fail (default: `:blue`)
+  * `detail_color`: Color used for miscellaneous test details (default: `:cyan`)
+
+  Colors are normally specified as symbols. Options are `:black`, `:red`,
+  `:green`, `:yellow`, `:blue`, `:magenta`, `:cyan`, and `:white`.
+
+  @ansi
+  Scenario: Customizing the failure color
+    Given a file named "custom_failure_color_spec.rb" with:
+      """ruby
+      RSpec.configure do |config|
+        config.failure_color = :magenta
+        config.tty = true
+        config.color = true
+      end
+
+      describe "failure" do
+        it "fails and uses the custom color" do
+          expect(2).to eq(4)
+        end
+      end
+      """
+      When I run `rspec custom_failure_color_spec.rb --format progress`
+      Then the failing example is printed in magenta

data/features/step_definitions/additional_cli_steps.rb

@@ -12,8 +12,22 @@ Then /^the output should not contain any of these:$/ do |table|
   end
 end
 
+Then /^the output should contain one of the following:$/ do |table|
+  matching_output = table.raw.flatten.select do |string|
+    all_output =~ regexp(string)
+  end
+
+  matching_output.should have(1).item
+end
+
 Then /^the example(?:s)? should(?: all)? pass$/ do
   step %q{the output should contain "0 failures"}
+  step %q{the output should not contain "0 examples"}
+  step %q{the exit status should be 0}
+end
+
+Then /^the process should succeed even though no examples were run$/ do
+  step %q{the output should contain "0 examples, 0 failures"}
   step %q{the exit status should be 0}
 end
 
@@ -30,3 +44,10 @@ Then /^the backtrace\-normalized output should contain:$/ do |partial_output|
 
   normalized_output.should =~ regexp(partial_output)
 end
+
+# This step can be generalized if it's ever used to test other colors
+Then /^the failing example is printed in magenta$/ do
+  # \e[35m = enable magenta
+  # \e[0m  = reset colors
+  expect(all_output).to include("\e[35m" + "F" + "\e[0m")
+end

data/features/subject/explicit_subject.feature

@@ -80,3 +80,22 @@ Feature: explicit subject
       """
     When I run `rspec nil_subject_spec.rb`
     Then the examples should all pass
+
+  Scenario: subject bang method
+    Given a file named "subject_bang_spec.rb" with:
+      """ruby
+      describe Array do
+        describe '#pop' do
+          let(:prepared_array) { [1,2,3] }
+          subject! { prepared_array.pop }
+          it "removes the last value from the array" do
+            prepared_array.should eq([1,2])
+          end
+          it "returns the last value of the array" do
+            subject.should eq(3)
+          end
+        end
+      end
+      """
+    When I run `rspec subject_bang_spec.rb`
+    Then the examples should all pass

data/lib/autotest/rspec2.rb

@@ -47,7 +47,7 @@ class Autotest::Rspec2 < Autotest
   # Overrides Autotest's implementation to generate the rspec command to run
   def make_test_cmd(files_to_test)
     files_to_test.empty? ? '' :
-      "#{prefix}'#{ruby}'#{suffix} -S '#{RSPEC_EXECUTABLE}' --tty #{normalize(files_to_test).keys.flatten.map { |f| "'#{f}'"}.join(' ')}"
+      %|#{prefix}"#{ruby}"#{suffix} -S "#{RSPEC_EXECUTABLE}" --tty #{normalize(files_to_test).keys.flatten.map { |f| %|"#{f}"|}.join(' ')}|
   end
 
   # Generates a map of filenames to Arrays for Autotest

data/lib/rspec/core.rb

@@ -23,8 +23,7 @@ require_rspec['core/reporter']
 
 require_rspec['core/metadata_hash_builder']
 require_rspec['core/hooks']
-require_rspec['core/subject']
-require_rspec['core/let']
+require_rspec['core/memoized_helpers']
 require_rspec['core/metadata']
 require_rspec['core/pending']
 require_rspec['core/formatters']

data/lib/rspec/core/configuration.rb

@@ -99,7 +99,7 @@ MESSAGE
       # server, but you can use tools like spork.
       add_setting :drb
 
-      # The drb_port (default: `8989`).
+      # The drb_port (default: nil).
       add_setting :drb_port
 
       # Default: `$stderr`.
@@ -122,12 +122,22 @@ MESSAGE
       # Load files matching this pattern (default: `'**/*_spec.rb'`)
       add_setting :pattern, :alias_with => :filename_pattern
 
-      # Report the times for the 10 slowest examples (default: `false`).
+      # Report the times for the slowest examples (default: `false`).
+      # Use this to specify the number of examples to include in the profile.
       add_setting :profile_examples
 
       # Run all examples if none match the configured filters (default: `false`).
       add_setting :run_all_when_everything_filtered
 
+      # Allow user to configure their own success/pending/failure colors
+      # @param [Symbol] should be one of the following: [:black, :white, :red, :green, :yellow, :blue, :magenta, :cyan]
+      add_setting :success_color
+      add_setting :pending_color
+      add_setting :failure_color
+      add_setting :default_color
+      add_setting :fixed_color
+      add_setting :detail_color
+
       # Seed for random ordering (default: generated randomly each run).
       #
       # When you run specs with `--order random`, RSpec generates a random seed
@@ -176,7 +186,7 @@ MESSAGE
         /\/lib\d*\/ruby\//,
         /org\/jruby\//,
         /bin\//,
-        /gems/,
+        %r|/gems/|,
         /spec\/spec_helper\.rb/,
         /lib\/rspec\/(core|expectations|matchers|mocks)/
       ]
@@ -195,6 +205,13 @@ MESSAGE
         @filter_manager = FilterManager.new
         @preferred_options = {}
         @seed = srand % 0xFFFF
+        @failure_color = :red
+        @success_color = :green
+        @pending_color = :yellow
+        @default_color = :white
+        @fixed_color = :blue
+        @detail_color = :cyan
+        @profile_examples = false
       end
 
       # @private
@@ -506,6 +523,19 @@ EOM
                       end
       end
 
+      # @api private
+      #
+      # Defaults `profile_examples` to 10 examples when `@profile_examples` is `true`.
+      #
+      def profile_examples
+        profile = value_for(:profile_examples, @profile_examples)
+        if profile && !profile.is_a?(Integer)
+          10
+        else
+          profile
+        end
+      end
+
       # @private
       def files_or_directories_to_run=(*files)
         files = files.flatten

data/lib/rspec/core/configuration_options.rb

@@ -8,13 +8,13 @@ module RSpec
       attr_reader :options
 
       def initialize(args)
-        @args = args
-        if args.include?("--default_path")
-          args[args.index("--default_path")] = "--default-path"
+        @args = args.dup
+        if @args.include?("--default_path")
+          @args[@args.index("--default_path")] = "--default-path"
         end
 
-        if args.include?("--line_number")
-          args[args.index("--line_number")] = "--line-number"
+        if @args.include?("--line_number")
+          @args[@args.index("--line_number")] = "--line-number"
         end
       end
 

data/lib/rspec/core/deprecation.rb

@@ -30,7 +30,7 @@ ADDITIONAL
     #
     # Used internally to print deprecation warnings
     def warn_deprecation(message)
-      send :warn, message
+      warn message
     end
   end
 end

data/lib/rspec/core/example.rb

@@ -233,8 +233,8 @@ An error occurred #{context}
       end
 
       # @private
-      def instance_eval(&block)
-        @example_group_instance.instance_eval(&block)
+      def instance_eval(*args, &block)
+        @example_group_instance.instance_eval(*args, &block)
       end
 
       # @private

data/lib/rspec/core/example_group.rb

@@ -15,13 +15,11 @@ module RSpec
     class ExampleGroup
       extend  MetadataHashBuilder::WithDeprecationWarning
       extend  Extensions::ModuleEvalWithArgs
-      extend  Subject::ExampleGroupMethods
       extend  Hooks
 
+      include MemoizedHelpers
       include Extensions::InstanceEvalWithArgs
-      include Subject::ExampleMethods
       include Pending
-      include Let
       include SharedExampleGroup
 
       # @private

data/lib/rspec/core/formatters/base_text_formatter.rb

@@ -33,18 +33,17 @@ module RSpec
         # @param [String] string
         def colorise_summary(summary)
           if failure_count > 0
-            red(summary)
+            color(summary, RSpec.configuration.failure_color)
           elsif pending_count > 0
-            yellow(summary)
+            color(summary, RSpec.configuration.pending_color)
           else
-            green(summary)
+            color(summary, RSpec.configuration.success_color)
           end
         end
 
         def dump_summary(duration, example_count, failure_count, pending_count)
           super(duration, example_count, failure_count, pending_count)
-          # Don't print out profiled info if there are failures, it just clutters the output
-          dump_profile if profile_examples? && failure_count == 0
+          dump_profile if profile_examples?
           output.puts "\nFinished in #{format_duration(duration)}\n"
           output.puts colorise_summary(summary_line(example_count, failure_count, pending_count))
           dump_commands_to_rerun_failed_examples
@@ -61,17 +60,18 @@ module RSpec
           output.puts
 
           failed_examples.each do |example|
-            output.puts(red("rspec #{RSpec::Core::Metadata::relative_path(example.location)}") + " " + cyan("# #{example.full_description}"))
+            output.puts(failure_color("rspec #{RSpec::Core::Metadata::relative_path(example.location)}") + " " + detail_color("# #{example.full_description}"))
           end
         end
 
         # @api public
         #
-        # Outputs the 10 slowest examples in a report when using `--profile`.
+        # Outputs the slowest examples in a report when using `--profile COUNT` (default 10).
         #
         def dump_profile
+          number_of_examples = RSpec.configuration.profile_examples
           sorted_examples = examples.sort_by {|example|
-            example.execution_result[:run_time] }.reverse.first(10)
+            example.execution_result[:run_time] }.reverse.first(number_of_examples)
 
           total, slows = [examples, sorted_examples].map {|exs|
             exs.inject(0.0) {|i, e| i + e.execution_result[:run_time] }}
@@ -83,7 +83,7 @@ module RSpec
 
           sorted_examples.each do |example|
             output.puts "  #{example.full_description}"
-            output.puts cyan("    #{red(format_seconds(example.execution_result[:run_time]))} #{red("seconds")} #{format_caller(example.location)}")
+            output.puts detail_color("    #{failure_color(format_seconds(example.execution_result[:run_time]))} #{failure_color("seconds")} #{format_caller(example.location)}")
           end
         end
 
@@ -103,9 +103,9 @@ module RSpec
             output.puts
             output.puts "Pending:"
             pending_examples.each do |pending_example|
-              output.puts yellow("  #{pending_example.full_description}")
-              output.puts cyan("    # #{pending_example.execution_result[:pending_message]}")
-              output.puts cyan("    # #{format_caller(pending_example.location)}")
+              output.puts pending_color("  #{pending_example.full_description}")
+              output.puts detail_color("    # #{pending_example.execution_result[:pending_message]}")
+              output.puts detail_color("    # #{format_caller(pending_example.location)}")
               if pending_example.execution_result[:exception] \
                 && RSpec.configuration.show_failures_in_pending_blocks?
                 dump_failure_info(pending_example)
@@ -125,42 +125,100 @@ module RSpec
           output.close if IO === output && output != $stdout
         end
 
+        VT100_COLORS = {
+          :black => 30,
+          :red => 31,
+          :green => 32,
+          :yellow => 33,
+          :blue => 34,
+          :magenta => 35,
+          :cyan => 36,
+          :white => 37
+        }
+
+        VT100_COLOR_CODES = VT100_COLORS.values.to_set
+
+        def color_code_for(code_or_symbol)
+          if VT100_COLOR_CODES.include?(code_or_symbol)
+            code_or_symbol
+          else
+            VT100_COLORS.fetch(code_or_symbol) do
+              color_code_for(:white)
+            end
+          end
+        end
+
+        def colorize(text, code_or_symbol)
+          "\e[#{color_code_for(code_or_symbol)}m#{text}\e[0m"
+        end
+
       protected
 
+        def bold(text)
+          color_enabled? ? "\e[1m#{text}\e[0m" : text
+        end
+
         def color(text, color_code)
-          color_enabled? ? "#{color_code}#{text}\e[0m" : text
+          color_enabled? ? colorize(text, color_code) : text
         end
 
-        def bold(text)
-          color(text, "\e[1m")
+        def failure_color(text)
+          color(text, RSpec.configuration.failure_color)
+        end
+
+        def success_color(text)
+          color(text, RSpec.configuration.success_color)
+        end
+
+        def pending_color(text)
+          color(text, RSpec.configuration.pending_color)
+        end
+
+        def fixed_color(text)
+          color(text, RSpec.configuration.fixed_color)
+        end
+
+        def detail_color(text)
+          color(text, RSpec.configuration.detail_color)
+        end
+
+        def default_color(text)
+          color(text, RSpec.configuration.default_color)
         end
 
         def red(text)
-          color(text, "\e[31m")
+          RSpec.deprecate("RSpec::Core::Formatters::BaseTextFormatter#red", "#failure_color", "3.0")
+          color(text, :red)
         end
 
         def green(text)
-          color(text, "\e[32m")
+          RSpec.deprecate("RSpec::Core::Formatters::BaseTextFormatter#green", "#success_color", "3.0")
+          color(text, :green)
         end
 
         def yellow(text)
-          color(text, "\e[33m")
+          RSpec.deprecate("RSpec::Core::Formatters::BaseTextFormatter#yellow", "#pending_color", "3.0")
+          color(text, :yellow)
         end
 
         def blue(text)
-          color(text, "\e[34m")
+          RSpec.deprecate("RSpec::Core::Formatters::BaseTextFormatter#blue", "#fixed_color", "3.0")
+          color(text, :blue)
         end
 
         def magenta(text)
-          color(text, "\e[35m")
+          RSpec.deprecate("RSpec::Core::Formatters::BaseTextFormatter#magenta", nil, "3.0")
+          color(text, :magenta)
         end
 
         def cyan(text)
-          color(text, "\e[36m")
+          RSpec.deprecate("RSpec::Core::Formatters::BaseTextFormatter#cyan", "#detail_color", "3.0")
+          color(text, :cyan)
         end
 
         def white(text)
-          color(text, "\e[37m")
+          RSpec.deprecate("RSpec::Core::Formatters::BaseTextFormatter#white", "#default_color", "3.0")
+          color(text, :white)
         end
 
         def short_padding
@@ -179,13 +237,13 @@ module RSpec
 
         def dump_backtrace(example)
           format_backtrace(example.execution_result[:exception].backtrace, example).each do |backtrace_info|
-            output.puts cyan("#{long_padding}# #{backtrace_info}")
+            output.puts detail_color("#{long_padding}# #{backtrace_info}")
           end
         end
 
         def dump_pending_fixed(example, index)
           output.puts "#{short_padding}#{index.next}) #{example.full_description} FIXED"
-          output.puts blue("#{long_padding}Expected pending '#{example.metadata[:execution_result][:pending_message]}' to fail. No Error was raised.")
+          output.puts fixed_color("#{long_padding}Expected pending '#{example.metadata[:execution_result][:pending_message]}' to fail. No Error was raised.")
         end
 
         def pending_fixed?(example)
@@ -199,14 +257,22 @@ module RSpec
 
         def dump_failure_info(example)
           exception = example.execution_result[:exception]
-          output.puts "#{long_padding}#{red("Failure/Error:")} #{red(read_failed_line(exception, example).strip)}"
-          output.puts "#{long_padding}#{red(exception.class.name << ":")}" unless exception.class.name =~ /RSpec/
-          exception.message.to_s.split("\n").each { |line| output.puts "#{long_padding}  #{red(line)}" } if exception.message
+          exception_class_name = exception_class_name_for(exception)
+          output.puts "#{long_padding}#{failure_color("Failure/Error:")} #{failure_color(read_failed_line(exception, example).strip)}"
+          output.puts "#{long_padding}#{failure_color(exception_class_name)}:" unless exception_class_name =~ /RSpec/
+          exception.message.to_s.split("\n").each { |line| output.puts "#{long_padding}  #{failure_color(line)}" } if exception.message
+
           if shared_group = find_shared_group(example)
             dump_shared_failure_info(shared_group)
           end
         end
 
+        def exception_class_name_for(exception)
+          name = exception.class.name.to_s
+          name ="(anonymous error class)" if name == ''
+          name
+        end
+
         def dump_shared_failure_info(group)
           output.puts "#{long_padding}Shared Example Group: \"#{group.metadata[:shared_group_name]}\" called from " +
             "#{backtrace_line(group.metadata[:example_group][:location])}"