rspec-core 3.0.0.beta1 → 3.0.0.beta2

data/features/pending_and_skipped_examples/skipped_examples.feature

@@ -0,0 +1,106 @@
+Feature: skipped examples
+
+  RSpec offers a number of ways to indicate that an example should be skipped
+  and not executed.
+
+  Scenario: no implementation provided
+    Given a file named "example_without_block_spec.rb" with:
+      """ruby
+      describe "an example" do
+        it "is a skipped example"
+      end
+      """
+    When I run `rspec example_without_block_spec.rb`
+    Then the exit status should be 0
+    And the output should contain "1 example, 0 failures, 1 pending"
+    And the output should contain "Not yet implemented"
+    And the output should contain "example_without_block_spec.rb:2"
+
+  Scenario: skipping using `skip`
+    Given a file named "skipped_spec.rb" with:
+      """ruby
+      describe "an example" do
+        skip "is skipped" do
+        end
+      end
+      """
+    When I run `rspec skipped_spec.rb`
+    Then the exit status should be 0
+    And the output should contain "1 example, 0 failures, 1 pending"
+    And the output should contain:
+      """
+      Pending:
+        an example is skipped
+          # No reason given
+          # ./skipped_spec.rb:2
+      """
+
+  Scenario: skipping using `skip` inside an example
+    Given a file named "skipped_spec.rb" with:
+      """ruby
+      describe "an example" do
+        it "is skipped" do
+          skip
+        end
+      end
+      """
+    When I run `rspec skipped_spec.rb`
+    Then the exit status should be 0
+    And the output should contain "1 example, 0 failures, 1 pending"
+    And the output should contain:
+      """
+      Pending:
+        an example is skipped
+          # No reason given
+          # ./skipped_spec.rb:2
+      """
+
+  Scenario: temporarily skipping by prefixing `it`, `specify`, or `example` with an x
+    Given a file named "temporarily_skipped_spec.rb" with:
+      """ruby
+      describe "an example" do
+        xit "is skipped using xit" do
+        end
+
+        xspecify "is skipped using xspecify" do
+        end
+
+        xexample "is skipped using xexample" do
+        end
+      end
+      """
+    When I run `rspec temporarily_skipped_spec.rb`
+    Then the exit status should be 0
+    And the output should contain "3 examples, 0 failures, 3 pending"
+    And the output should contain:
+      """
+      Pending:
+        an example is skipped using xit
+          # Temporarily skipped with xit
+          # ./temporarily_skipped_spec.rb:2
+        an example is skipped using xspecify
+          # Temporarily skipped with xspecify
+          # ./temporarily_skipped_spec.rb:5
+        an example is skipped using xexample
+          # Temporarily skipped with xexample
+          # ./temporarily_skipped_spec.rb:8
+      """
+
+  Scenario: skipping using metadata
+    Given a file named "skipped_spec.rb" with:
+      """ruby
+      describe "an example" do
+        example "is skipped", :skip => true do
+        end
+      end
+      """
+    When I run `rspec skipped_spec.rb`
+    Then the exit status should be 0
+    And the output should contain "1 example, 0 failures, 1 pending"
+    And the output should contain:
+      """
+      Pending:
+        an example is skipped
+          # No reason given
+          # ./skipped_spec.rb:2
+      """

data/features/step_definitions/additional_cli_steps.rb

@@ -41,9 +41,43 @@ Then /^the backtrace\-normalized output should contain:$/ do |partial_output|
   expect(normalized_output).to match(regexp(partial_output))
 end
 
+Then /^the output should not contain any error backtraces$/ do
+  step %q{the output should not contain "lib/rspec/core"}
+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
+
+Given /^I have a brand new project with no files$/ do
+  in_current_dir do
+    expect(Dir["**/*"]).to eq([])
+  end
+end
+
+Given /^I have run `([^`]*)`$/ do |cmd|
+  fail_on_error = true
+  run_simple(unescape(cmd), fail_on_error)
+end
+
+When "I accept the recommended settings by removing `=begin` and `=end` from `spec/spec_helper.rb`" do
+  in_current_dir do
+    spec_helper = File.read("spec/spec_helper.rb")
+    expect(spec_helper).to include("=begin", "=end")
+
+    to_keep = spec_helper.lines.reject do |line|
+      line.start_with?("=begin") || line.start_with?("=end")
+    end
+
+    File.open("spec/spec_helper.rb", "w") { |f| f.write(to_keep.join) }
+    expect(File.read("spec/spec_helper.rb")).not_to include("=begin", "=end")
+  end
+end
+
+When /^I create "([^"]*)" with the following content:$/ do |file_name, content|
+  write_file(file_name, content)
+end
+

data/features/subject/explicit_subject.feature

@@ -73,7 +73,7 @@ Feature: explicit subject
           context "with index out of bounds" do
             before { expect(Array).to receive(:one_two_three).once.and_return([1,2,3]) }
             subject { Array.one_two_three[42] }
-            it { should be_nil }
+            it { is_expected.to be_nil }
           end
         end
       end

data/features/subject/one_liner_syntax.feature

@@ -0,0 +1,71 @@
+Feature: One-liner syntax
+
+  RSpec supports a one-liner syntax for setting an expectation
+  on the `subject`. RSpec will give the examples a doc string
+  that is auto-generated from the matcher used in the example.
+  This is designed specifically to help avoid duplication in
+  situations where the doc string and the matcher used in the
+  example mirror each other exactly. When used excessively,
+  it can produce documentation output that does not read well
+  or contribute to understanding the object you are describing.
+
+  This comes in two flavors:
+
+    * `is_expected` is defined simply as `expect(subject)` and is
+      designed for when you are using rspec-expectations with its
+      newer expect-based syntax.
+    * `should` was designed back when rspec-expectations only had
+      a should-based syntax. However, it continues to be available
+      and work even if the `:should` syntax is disabled (since that
+      merely removes `Object#should` but this is
+      `RSpec::Core::ExampleGroup#should`).
+
+  Note: this feature is only available when using rspec-expectations.
+
+  Scenario: implicit subject
+    Given a file named "example_spec.rb" with:
+      """ruby
+      describe Array do
+        describe "when first created" do
+          # Rather than:
+          # it "should be empty" do
+          #   subject.should be_empty
+          # end
+
+          it { should be_empty }
+          # or
+          it { is_expected.to be_empty }
+        end
+      end
+      """
+    When I run `rspec example_spec.rb --format doc`
+    Then the examples should all pass
+     And the output should contain:
+       """
+       Array
+         when first created
+           should be empty
+           should be empty
+       """
+
+  Scenario: explicit subject
+    Given a file named "example_spec.rb" with:
+      """ruby
+      describe Array do
+        describe "with 3 items" do
+          subject { [1,2,3] }
+          it { should_not be_empty }
+          # or
+          it { is_expected.not_to be_empty }
+        end
+      end
+      """
+    When I run `rspec example_spec.rb --format doc`
+    Then the examples should all pass
+     And the output should contain:
+       """
+       Array
+         with 3 items
+           should not be empty
+           should not be empty
+       """

data/lib/rspec/core.rb

@@ -21,6 +21,7 @@ require 'rspec/support/warnings'
 require_rspec['core/flat_map']
 require_rspec['core/filter_manager']
 require_rspec['core/dsl']
+require_rspec['core/notifications']
 require_rspec['core/reporter']
 
 require_rspec['core/hooks']
@@ -85,21 +86,12 @@ module RSpec
   # @see RSpec.configure
   # @see Core::Configuration
   def self.configuration
-    if block_given?
-      RSpec.warn_deprecation <<-WARNING
+    @configuration ||= begin
+                         config = RSpec::Core::Configuration.new
+                         config.expose_dsl_globally = true
+                         config
+                       end
 
-*****************************************************************
-DEPRECATION WARNING
-
-* RSpec.configuration with a block is deprecated and has no effect.
-* please use RSpec.configure with a block instead.
-
-Called from #{CallerFilter.first_non_rspec_line}
-*****************************************************************
-
-WARNING
-    end
-    @configuration ||= RSpec::Core::Configuration.new
   end
 
   # @private

data/lib/rspec/core/backtrace_formatter.rb

@@ -12,14 +12,14 @@ module RSpec
 
       def initialize
         @full_backtrace = false
-        @exclusion_patterns = [] << Regexp.union(
+        @system_exclusion_patterns = [] << Regexp.union(
           *["/lib\d*/ruby/",
             "org/jruby/",
             "bin/",
             "/gems/",
             "lib/rspec/(core|expectations|matchers|mocks)"].
-          map {|s| Regexp.new(s.gsub("/", File::SEPARATOR))}
-        )
+          map {|s| Regexp.new(s.gsub("/", File::SEPARATOR))})
+        @exclusion_patterns = [] + @system_exclusion_patterns
         @inclusion_patterns = [Regexp.new(Dir.getwd)]
       end
 
@@ -58,8 +58,20 @@ module RSpec
       # @api private
       def exclude?(line)
         return false if @full_backtrace
-        @exclusion_patterns.any? {|p| p =~ line} && @inclusion_patterns.none? {|p| p =~ line}
+        matches_an_exclusion_pattern?(line) &&
+        doesnt_match_inclusion_pattern_unless_system_exclusion?(line)
       end
+
+    private
+
+      def matches_an_exclusion_pattern?(line)
+        @exclusion_patterns.any? { |p| line =~ p }
+      end
+
+      def doesnt_match_inclusion_pattern_unless_system_exclusion?(line)
+        @system_exclusion_patterns.any? { |p| line =~ p } || @inclusion_patterns.none? { |p| p =~ line }
+      end
+
     end
   end
 end

data/lib/rspec/core/command_line.rb

@@ -4,7 +4,6 @@ module RSpec
       def initialize(options, configuration=RSpec::configuration, world=RSpec::world)
         if Array === options
           options = ConfigurationOptions.new(options)
-          options.parse_options
         end
         @options       = options
         @configuration = configuration
@@ -24,10 +23,10 @@ module RSpec
 
         @configuration.reporter.report(@world.example_count) do |reporter|
           begin
-            @configuration.run_hook(:before, :suite)
+            @configuration.hooks.run(:before, :suite)
             @world.ordered_example_groups.map {|g| g.run(reporter) }.all? ? 0 : @configuration.failure_exit_code
           ensure
-            @configuration.run_hook(:after, :suite)
+            @configuration.hooks.run(:after, :suite)
           end
         end
       end

data/lib/rspec/core/configuration.rb

@@ -41,11 +41,6 @@ module RSpec
         end
       end
 
-      # @private
-      def self.deprecate_alias_key
-        RSpec.deprecate("add_setting with :alias option", :replacement => ":alias_with")
-      end
-
       # @private
       def self.define_aliases(name, alias_name)
         alias_method alias_name, name
@@ -64,19 +59,23 @@ module RSpec
       # `Configuration` instance rather than this class method.
       def self.add_setting(name, opts={})
         raise "Use the instance add_setting method if you want to set a default" if opts.has_key?(:default)
-        if opts[:alias]
-          deprecate_alias_key
-          define_aliases(opts[:alias], name)
-        else
-          attr_writer name
-          define_reader name
-          define_predicate_for name
-        end
+        attr_writer name
+        add_read_only_setting name
+
         Array(opts[:alias_with]).each do |alias_name|
           define_aliases(name, alias_name)
         end
       end
 
+      # @private
+      #
+      # As `add_setting` but only add the reader
+      def self.add_read_only_setting(name, opts={})
+        raise "Use the instance add_setting method if you want to set a default" if opts.has_key?(:default)
+        define_reader name
+        define_predicate_for name
+      end
+
       # @macro [attach] add_setting
       #   @attribute $1
       #
@@ -102,6 +101,26 @@ module RSpec
       # Default: `$stderr`.
       add_setting :error_stream
 
+      # Indicates if the DSL has been exposed off of modules and `main`.
+      # Default: true
+      def expose_dsl_globally?
+        Core::DSL.exposed_globally?
+      end
+
+      # Use this to expose the core RSpec DSL via `Module` and the `main`
+      # object. It will be set automatically but you can override it to
+      # remove the DSL.
+      # Default: true
+      def expose_dsl_globally=(value)
+        if value
+          Core::DSL.expose_globally!
+          Core::SharedExampleGroup::TopLevelDSL.expose_globally!
+        else
+          Core::DSL.remove_globally!
+          Core::SharedExampleGroup::TopLevelDSL.remove_globally!
+        end
+      end
+
       # @macro add_setting
       # Default: `$stderr`.
       add_setting :deprecation_stream
@@ -193,16 +212,13 @@ module RSpec
       # @param [Symbol] color one of the following: [:black, :white, :red, :green, :yellow, :blue, :magenta, :cyan]
       add_setting :detail_color
 
-      # @macro add_setting
-      # When a block passed to pending fails (as expected), display the failure
-      # without reporting it as a failure (default: false).
-      add_setting :show_failures_in_pending_blocks
-
       # Deprecated. This config option was added in RSpec 2 to pave the way
       # for this being the default behavior in RSpec 3. Now this option is
       # a no-op.
       def treat_symbols_as_metadata_keys_with_true_values=(value)
-        RSpec.deprecate("RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values=")
+        RSpec.deprecate("RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values=",
+                        :message => "RSpec::Core::Configuration#treat_symbols_as_metadata_keys_with_true_values=" +
+                                    "is deprecated, it is now set to true as default and setting it to false has no effect.")
       end
 
       # @private
@@ -210,7 +226,7 @@ module RSpec
       # @private
       add_setting :include_or_extend_modules
       # @private
-      add_setting :files_to_run
+      attr_writer :files_to_run
       # @private
       add_setting :expecting_with_rspec
       # @private
@@ -227,8 +243,7 @@ module RSpec
         @expectation_frameworks = []
         @include_or_extend_modules = []
         @mock_framework = nil
-        @files_to_run = []
-        @formatters = []
+        @files_or_directories_to_run = []
         @color = false
         @pattern = '**/*_spec.rb'
         @failure_exit_code = 1
@@ -267,7 +282,7 @@ module RSpec
       def reset
         @spec_files_loaded = false
         @reporter = nil
-        @formatters.clear
+        @formatter_loader = nil
       end
 
       # @overload add_setting(name)
@@ -310,7 +325,7 @@ module RSpec
         (class << self; self; end).class_eval do
           add_setting(name, opts)
         end
-        send("#{name}=", default) if default
+        __send__("#{name}=", default) if default
       end
 
       # Returns the configured mock framework adapter module
@@ -359,6 +374,15 @@ module RSpec
         @backtrace_formatter.inclusion_patterns = patterns
       end
 
+      # @api private
+      MOCKING_ADAPTERS = {
+        :rspec    => :RSpec,
+        :flexmock => :Flexmock,
+        :rr       => :RR,
+        :mocha    => :Mocha,
+        :nothing  => :Null
+      }
+
       # Sets the mock framework adapter module.
       #
       # `framework` can be a Symbol or a Module.
@@ -389,23 +413,17 @@ module RSpec
       #       mod_config.custom_setting = true
       #     end
       def mock_with(framework)
-        framework_module = case framework
-        when Module
-          framework
-        when String, Symbol
-          require case framework.to_s
-                  when /rspec/i
-                    'rspec/core/mocking/with_rspec'
-                  when /mocha/i
-                    'rspec/core/mocking/with_mocha'
-                  when /rr/i
-                    'rspec/core/mocking/with_rr'
-                  when /flexmock/i
-                    'rspec/core/mocking/with_flexmock'
-                  else
-                    'rspec/core/mocking/with_absolutely_nothing'
-                  end
-          RSpec::Core::MockFrameworkAdapter
+        framework_module = if framework.is_a?(Module)
+           framework
+        else
+          const_name = MOCKING_ADAPTERS.fetch(framework) do
+            raise ArgumentError,
+              "Unknown mocking framework: #{framework.inspect}. " +
+              "Pass a module or one of #{MOCKING_ADAPTERS.keys.inspect}"
+          end
+
+          require "rspec/core/mocking_adapters/#{const_name.to_s.downcase}"
+          RSpec::Core::MockingAdapters.const_get(const_name)
         end
 
         new_name, old_name = [framework_module, @mock_framework].map do |mod|
@@ -527,13 +545,6 @@ module RSpec
         end
       end
 
-      def requires=(paths)
-        RSpec.deprecate("RSpec::Core::Configuration#requires=(paths)",
-                        :replacement => "paths.each {|path| require path}")
-        paths.map {|path| require path}
-        @requires += paths
-      end
-
       # Run examples defined on `line_numbers` in all files to run.
       def line_numbers=(line_numbers)
         filter_run :line_numbers => line_numbers.map{|l| l.to_i}
@@ -563,27 +574,28 @@ module RSpec
       # and paths to use for output streams, but you should consider that a
       # private api that may change at any time without notice.
       def add_formatter(formatter_to_use, *paths)
-        formatter_class =
-          built_in_formatter(formatter_to_use) ||
-          custom_formatter(formatter_to_use) ||
-          (raise ArgumentError, "Formatter '#{formatter_to_use}' unknown - maybe you meant 'documentation' or 'progress'?.")
-
         paths << output_stream if paths.empty?
-        formatters << formatter_class.new(*paths.map {|p| String === p ? file_at(p) : p})
+        formatter_loader.add formatter_to_use, *paths
       end
-
       alias_method :formatter=, :add_formatter
 
+      # @api private
       def formatters
-        @formatters ||= []
+        formatter_loader.formatters
       end
 
+      # @api private
+      def formatter_loader
+        @formatter_loader ||= Formatters::Loader.new(Reporter.new(self))
+      end
+
+      # @api private
       def reporter
-        @reporter ||= begin
-                        add_formatter('progress') if formatters.empty?
-                        add_formatter(RSpec::Core::Formatters::DeprecationFormatter, deprecation_stream, output_stream)
-                        Reporter.new(self, *formatters)
-                      end
+        @reporter ||=
+          begin
+            formatter_loader.setup_default output_stream, deprecation_stream
+            formatter_loader.reporter
+          end
       end
 
       # @api private
@@ -603,7 +615,12 @@ module RSpec
       def files_or_directories_to_run=(*files)
         files = files.flatten
         files << default_path if (command == 'rspec' || Runner.running_in_drb?) && default_path && files.empty?
-        self.files_to_run = get_files_to_run(files)
+        @files_or_directories_to_run = files
+        @files_to_run = nil
+      end
+
+      def files_to_run
+        @files_to_run ||= get_files_to_run(@files_or_directories_to_run)
       end
 
       # Creates a method that delegates to `example` including the submitted
@@ -632,6 +649,35 @@ module RSpec
         RSpec::Core::ExampleGroup.alias_example_to(new_name, extra_options)
       end
 
+      # Creates a method that defines an example group with the provided
+      # metadata. Can be used to define example group/metadata shortcuts.
+      #
+      # @example
+      #     alias_example_group_to :describe_model, :type => :model
+      #     shared_context_for "model tests", :type => :model do
+      #       # define common model test helper methods, `let` declarations, etc
+      #     end
+      #
+      #     # This lets you do this:
+      #
+      #     RSpec.describe_model User do
+      #     end
+      #
+      #     # ... which is the equivalent of
+      #
+      #     RSpec.describe User, :type => :model do
+      #     end
+      #
+      # @note The defined aliased will also be added to the top level
+      #       (e.g. `main` and from within modules) if
+      #       `expose_dsl_globally` is set to true.
+      # @see #alias_example_to
+      # @see #expose_dsl_globally=
+      def alias_example_group_to(new_name, *args)
+        extra_options = Metadata.build_hash_from(args)
+        RSpec::Core::ExampleGroup.alias_example_group_to(new_name, extra_options)
+      end
+
       # Define an alias for it_should_behave_like that allows different
       # language (like "it_has_behavior" or "it_behaves_like") to be
       # employed when including shared examples.
@@ -841,17 +887,17 @@ module RSpec
       def configure_group(group)
         include_or_extend_modules.each do |include_or_extend, mod, filters|
           next unless filters.empty? || group.any_apply?(filters)
-          send("safe_#{include_or_extend}", mod, group)
+          __send__("safe_#{include_or_extend}", mod, group)
         end
       end
 
       # @private
       def safe_include(mod, host)
-        host.send(:include,mod) unless host < mod
+        host.__send__(:include, mod) unless host < mod
       end
 
       # @private
-      def setup_load_path_and_require(paths)
+      def requires=(paths)
         directories = ['lib', default_path].select { |p| File.directory? p }
         RSpec::Core::RubyProject.add_to_load_path(*directories)
         paths.each {|path| require path}
@@ -861,7 +907,7 @@ module RSpec
       # @private
       if RUBY_VERSION.to_f >= 1.9
         def safe_extend(mod, host)
-          host.extend(mod) unless (class << host; self; end) < mod
+          host.extend(mod) unless host.singleton_class < mod
         end
       else
         def safe_extend(mod, host)
@@ -871,13 +917,13 @@ module RSpec
 
       # @private
       def configure_mock_framework
-        RSpec::Core::ExampleGroup.send(:include, mock_framework)
+        RSpec::Core::ExampleGroup.__send__(:include, mock_framework)
       end
 
       # @private
       def configure_expectation_framework
         expectation_frameworks.each do |framework|
-          RSpec::Core::ExampleGroup.send(:include, framework)
+          RSpec::Core::ExampleGroup.__send__(:include, framework)
         end
       end
 
@@ -1067,63 +1113,6 @@ module RSpec
       def output_to_tty?(output=output_stream)
         tty? || (output.respond_to?(:tty?) && output.tty?)
       end
-
-      def built_in_formatter(key)
-        case key.to_s
-        when 'd', 'doc', 'documentation', 's', 'n', 'spec', 'nested'
-          require 'rspec/core/formatters/documentation_formatter'
-          RSpec::Core::Formatters::DocumentationFormatter
-        when 'h', 'html'
-          require 'rspec/core/formatters/html_formatter'
-          RSpec::Core::Formatters::HtmlFormatter
-        when 'p', 'progress'
-          require 'rspec/core/formatters/progress_formatter'
-          RSpec::Core::Formatters::ProgressFormatter
-        when 'j', 'json'
-          require 'rspec/core/formatters/json_formatter'
-          RSpec::Core::Formatters::JsonFormatter
-        end
-      end
-
-      def custom_formatter(formatter_ref)
-        if Class === formatter_ref
-          formatter_ref
-        elsif string_const?(formatter_ref)
-          begin
-            formatter_ref.gsub(/^::/,'').split('::').inject(Object) { |const,string| const.const_get string }
-          rescue NameError
-            require( path_for(formatter_ref) ) ? retry : raise
-          end
-        end
-      end
-
-      def string_const?(str)
-        str.is_a?(String) && /\A[A-Z][a-zA-Z0-9_:]*\z/ =~ str
-      end
-
-      def path_for(const_ref)
-        underscore_with_fix_for_non_standard_rspec_naming(const_ref)
-      end
-
-      def underscore_with_fix_for_non_standard_rspec_naming(string)
-        underscore(string).sub(%r{(^|/)r_spec($|/)}, '\\1rspec\\2')
-      end
-
-      # activesupport/lib/active_support/inflector/methods.rb, line 48
-      def underscore(camel_cased_word)
-        word = camel_cased_word.to_s.dup
-        word.gsub!(/::/, '/')
-        word.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
-        word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
-        word.tr!("-", "_")
-        word.downcase!
-        word
-      end
-
-      def file_at(path)
-        FileUtils.mkdir_p(File.dirname(path))
-        File.new(path, 'w')
-      end
     end
   end
 end