rspec-core 3.0.0.beta1 → 3.0.0.beta2

data/lib/rspec/core/memoized_helpers.rb

@@ -5,6 +5,8 @@ module RSpec
       #   syntax embraced by shoulda matchers:
       #
       #       describe Widget do
+      #         it { is_expected.to validate_presence_of(:name) }
+      #         # or
       #         it { should validate_presence_of(:name) }
       #       end
       #
@@ -31,8 +33,10 @@ module RSpec
       #     end
       #   end
       #
-      #   # one-liner syntax - should is invoked on subject
+      #   # one-liner syntax - expectation is set on the subject
       #   describe Person do
+      #     it { is_expected.to be_eligible_to_vote }
+      #     # or
       #     it { should be_eligible_to_vote }
       #   end
       #
@@ -64,6 +68,11 @@ module RSpec
       #   end
       #
       # @see #subject
+      # @see #is_expected
+      #
+      # @note This only works if you are using rspec-expectations.
+      # @note If you are using RSpec's newer expect-based syntax you may
+      #       want to use `is_expected.to` instead of `should`.
       def should(matcher=nil, message=nil)
         RSpec::Expectations::PositiveExpectationHandler.handle_matcher(subject, matcher, message)
       end
@@ -78,10 +87,34 @@ module RSpec
       #   end
       #
       # @see #subject
+      # @see #is_expected
+      #
+      # @note This only works if you are using rspec-expectations.
+      # @note If you are using RSpec's newer expect-based syntax you may
+      #       want to use `is_expected.to_not` instead of `should_not`.
       def should_not(matcher=nil, message=nil)
         RSpec::Expectations::NegativeExpectationHandler.handle_matcher(subject, matcher, message)
       end
 
+      # Wraps the `subject` in `expect` to make it the target of an expectation.
+      # Designed to read nicely for one-liners.
+      #
+      # @example
+      #
+      #   describe [1, 2, 3] do
+      #     it { is_expected.to be_an Array }
+      #     it { is_expected.not_to include 4 }
+      #   end
+      #
+      # @see #subject
+      # @see #should
+      # @see #should_not
+      #
+      # @note This only works if you are using rspec-expectations.
+      def is_expected
+        expect(subject)
+      end
+
       private
 
       # @private
@@ -196,7 +229,7 @@ EOS
           # We have to pass the block directly to `define_method` to
           # allow it to use method constructs like `super` and `return`.
           raise "#let or #subject called without a block" if block.nil?
-          MemoizedHelpers.module_for(self).send(:define_method, name, &block)
+          MemoizedHelpers.module_for(self).__send__(:define_method, name, &block)
 
           # Apply the memoization. The method has been defined in an ancestor
           # module so we can use `super` here to get the value.
@@ -265,8 +298,9 @@ EOS
           before { __send__(name) }
         end
 
-        # Declares a `subject` for an example group which can then be the
-        # implicit receiver (through delegation) of calls to `should`.
+        # Declares a `subject` for an example group which can then be wrapped
+        # with `expect` using `is_expected` to make it the target of an expectation
+        # in a concise, one-line example.
         #
         # Given a `name`, defines a method with that name which returns the
         # `subject`. This lets you declare the subject once and access it
@@ -281,13 +315,13 @@ EOS
         #
         #   describe CheckingAccount, "with $50" do
         #     subject { CheckingAccount.new(Money.new(50, :USD)) }
-        #     it { should have_a_balance_of(Money.new(50, :USD)) }
-        #     it { should_not be_overdrawn }
+        #     it { is_expected.to have_a_balance_of(Money.new(50, :USD)) }
+        #     it { is_expected.not_to be_overdrawn }
         #   end
         #
         #   describe CheckingAccount, "with a non-zero starting balance" do
         #     subject(:account) { CheckingAccount.new(Money.new(50, :USD)) }
-        #     it { should_not be_overdrawn }
+        #     it { is_expected.not_to be_overdrawn }
         #     it "has a balance equal to the starting balance" do
         #       account.balance.should eq(Money.new(50, :USD))
         #     end
@@ -299,7 +333,7 @@ EOS
             let(name, &block)
             alias_method :subject, name
 
-            self::NamedSubjectPreventSuper.send(:define_method, name) do
+            self::NamedSubjectPreventSuper.__send__(:define_method, name) do
               raise NotImplementedError, "`super` in named subjects is not supported"
             end
           else
@@ -393,7 +427,7 @@ EOS
 
       # @api private
       def self.define_helpers_on(example_group)
-        example_group.send(:include, module_for(example_group))
+        example_group.__send__(:include, module_for(example_group))
       end
 
       if Module.method(:const_defined?).arity == 1 # for 1.8

data/lib/rspec/core/mocking_adapters/flexmock.rb

@@ -0,0 +1,29 @@
+#  Created by Jim Weirich on 2007-04-10.
+#  Copyright (c) 2007. All rights reserved.
+
+require 'flexmock/rspec'
+
+module RSpec
+  module Core
+    module MockingAdapters
+      # @api private
+      module Flexmock
+        include ::FlexMock::MockContainer
+
+        def self.framework_name; :flexmock end
+
+        def setup_mocks_for_rspec
+          # No setup required
+        end
+
+        def verify_mocks_for_rspec
+          flexmock_verify
+        end
+
+        def teardown_mocks_for_rspec
+          flexmock_close
+        end
+      end
+    end
+  end
+end

data/lib/rspec/core/{mocking/with_mocha.rb → mocking_adapters/mocha.rb}

@@ -26,26 +26,29 @@ end
 
 module RSpec
   module Core
-    module MockFrameworkAdapter
-      def self.framework_name; :mocha end
+    module MockingAdapters
+      # @api private
+      module Mocha
+        def self.framework_name; :mocha end
 
-      # Mocha::Standalone was deprecated as of Mocha 0.9.7.
-      begin
-        include Mocha::API
-      rescue NameError
-        include Mocha::Standalone
-      end
+        # Mocha::Standalone was deprecated as of Mocha 0.9.7.
+        begin
+          include ::Mocha::API
+        rescue NameError
+          include ::Mocha::Standalone
+        end
 
-      def setup_mocks_for_rspec
-        mocha_setup
-      end
+        def setup_mocks_for_rspec
+          mocha_setup
+        end
 
-      def verify_mocks_for_rspec
-        mocha_verify
-      end
+        def verify_mocks_for_rspec
+          mocha_verify
+        end
 
-      def teardown_mocks_for_rspec
-        mocha_teardown
+        def teardown_mocks_for_rspec
+          mocha_teardown
+        end
       end
     end
   end

data/lib/rspec/core/mocking_adapters/null.rb

@@ -0,0 +1,12 @@
+module RSpec
+  module Core
+    module MockingAdapters
+      # @api private
+      module Null
+        def setup_mocks_for_rspec; end
+        def verify_mocks_for_rspec; end
+        def teardown_mocks_for_rspec; end
+      end
+    end
+  end
+end

data/lib/rspec/core/mocking_adapters/rr.rb

@@ -0,0 +1,28 @@
+require 'rr'
+
+RSpec.configuration.backtrace_exclusion_patterns.push(RR::Errors::BACKTRACE_IDENTIFIER)
+
+module RSpec
+  module Core
+    module MockingAdapters
+      # @api private
+      module RR
+        def self.framework_name; :rr end
+
+        include ::RR::Extensions::InstanceMethods
+
+        def setup_mocks_for_rspec
+          ::RR::Space.instance.reset
+        end
+
+        def verify_mocks_for_rspec
+          ::RR::Space.instance.verify_doubles
+        end
+
+        def teardown_mocks_for_rspec
+          ::RR::Space.instance.reset
+        end
+      end
+    end
+  end
+end

data/lib/rspec/core/mocking_adapters/rspec.rb

@@ -0,0 +1,30 @@
+require 'rspec/mocks'
+
+module RSpec
+  module Core
+    module MockingAdapters
+      # @api private
+      module RSpec
+        include ::RSpec::Mocks::ExampleMethods
+
+        def self.framework_name; :rspec end
+
+        def self.configuration
+          ::RSpec::Mocks.configuration
+        end
+
+        def setup_mocks_for_rspec
+          ::RSpec::Mocks.setup
+        end
+
+        def verify_mocks_for_rspec
+          ::RSpec::Mocks.verify
+        end
+
+        def teardown_mocks_for_rspec
+          ::RSpec::Mocks.teardown
+        end
+      end
+    end
+  end
+end

data/lib/rspec/core/notifications.rb

@@ -0,0 +1,100 @@
+require 'rspec/core/formatters/helpers'
+
+module RSpec::Core
+  module Notifications
+
+    # The `CountNotification` represents notifications sent by the formatter
+    # which a single numerical count attribute. Currently used to notify
+    # formatters of the expected number of examples.
+    #
+    # @attr [Fixnum] count the number counted
+    CountNotification = Struct.new(:count)
+
+    # The `ExampleNotification` represents notifications sent by the reporter
+    # which contain information about the current (or soon to be) example.
+    # It is used by formatters to access information about that example.
+    #
+    # @example
+    #   def example_started(notification)
+    #     puts "Hey I started #{notification.example.description}"
+    #   end
+    #
+    # @attr [RSpec::Core::Example] example the current example
+    ExampleNotification = Struct.new(:example)
+
+    # The `GroupNotification` represents notifications sent by the reporter which
+    # contain information about the currently running (or soon to be) example group
+    # It is used by formatters to access information about that group.
+    #
+    # @example
+    #   def example_group_started(notification)
+    #     puts "Hey I started #{notification.group.description}"
+    #   end
+    # @attr [RSpec::Core::ExampleGroup] group the current group
+    GroupNotification = Struct.new(:group)
+
+    # The `MessageNotification` encapsulates generic messages that the reporter
+    # sends to formatters.
+    #
+    # @attr [String] message the message
+    MessageNotification = Struct.new(:message)
+
+    # The `SeedNotification` holds the seed used to randomize examples and
+    # wether that seed has been used or not.
+    #
+    # @attr [Fixnum] seed the seed used to randomize ordering
+    SeedNotification = Struct.new(:seed, :used) do
+      # @api
+      # @return [Boolean] has the seed been used?
+      def seed_used?
+        !!used
+      end
+      private :used
+    end
+
+    # The `SummaryNotification` holds information about the results of running
+    # a test suite. It is used by formatters to provide information at the end
+    # of the test run.
+    #
+    # @attr [Float] duration the time taken (in seconds) to run the suite
+    # @attr [Fixnum] example_count the number of examples run
+    # @attr [Fixnum] failure_count the number of failed examples
+    # @attr [Fixnum] pending_count the number of pending examples
+    class SummaryNotification < Struct.new(:duration, :example_count, :failure_count, :pending_count)
+      include Formatters::Helpers
+
+      # @api
+      # @return [String] A line summarising the results of the spec run.
+      def summary_line
+        summary = pluralize(example_count, "example")
+        summary << ", " << pluralize(failure_count, "failure")
+        summary << ", #{pending_count} pending" if pending_count > 0
+        summary
+      end
+    end
+
+    # The `DeprecationNotification` is issued by the reporter when a deprecated
+    # part of RSpec is encountered. It represents information about the deprecated
+    # call site.
+    #
+    # @attr [String] message A custom message about the deprecation
+    # @attr [String] deprecated A custom message about the deprecation (alias of message)
+    # @attr [String] replacement An optional replacement for the deprecation
+    # @attr [String] call_site An optional call site from which the deprecation was issued
+    DeprecationNotification = Struct.new(:deprecated, :message, :replacement, :call_site) do
+      private_class_method :new
+
+      # @api
+      # Convenience way to initialize the notification
+      def self.from_hash(data)
+        new data[:deprecated], data[:message], data[:replacement], data[:call_site]
+      end
+    end
+
+    # `NullNotification` represents a placeholder value for notifications that
+    # currently require no information, but we may wish to extend in future.
+    class NullNotification
+    end
+
+  end
+end

data/lib/rspec/core/option_parser.rb

@@ -2,16 +2,13 @@
 require 'optparse'
 
 module RSpec::Core
+  # @api private
   class Parser
-    def self.parse!(args)
-      new.parse!(args)
+    def self.parse(args)
+      new.parse(args)
     end
 
-    class << self
-      alias_method :parse, :parse!
-    end
-
-    def parse!(args)
+    def parse(args)
       return {} if args.empty?
 
       convert_deprecated_args(args)
@@ -29,9 +26,6 @@ module RSpec::Core
     def convert_deprecated_args(args)
       args.map! { |arg|
         case arg
-        when "--formatter"
-          RSpec.deprecate("the --formatter option", :replacement => "-f or --format")
-          "--format"
         when "--default_path"
           "--default-path"
         when "--line_number"
@@ -42,8 +36,6 @@ module RSpec::Core
       }
     end
 
-    alias_method :parse, :parse!
-
     def parser(options)
       OptionParser.new do |parser|
         parser.banner = "Usage: rspec [options] [files or directories]\n\n"
@@ -101,12 +93,7 @@ module RSpec::Core
 
         parser.on('--init', 'Initialize your project with RSpec.') do |cmd|
           require 'rspec/core/project_initializer'
-          ProjectInitializer.new(cmd).run
-          exit
-        end
-
-        parser.on('--configure', 'Deprecated. Use --init instead.') do |cmd|
-          RSpec.warning "--configure is deprecated with no effect. Use --init instead.", :call_site => nil
+          ProjectInitializer.new.run
           exit
         end
 
@@ -228,6 +215,12 @@ FILTERING
           exit
         end
 
+        %w[-d --I].each do |option|
+          parser.on(option) do
+            raise OptionParser::InvalidOption.new
+          end
+        end
+
       end
     end
   end

data/lib/rspec/core/pending.rb

@@ -1,7 +1,13 @@
 module RSpec
   module Core
     module Pending
-      class PendingDeclaredInExample < StandardError; end
+      class SkipDeclaredInExample < StandardError
+        attr_reader :argument
+
+        def initialize(argument)
+          @argument = argument
+        end
+      end
 
       # If Test::Unit is loaed, we'll use its error as baseclass, so that Test::Unit
       # will report unmet RSpec expectations as failures rather than errors.
@@ -18,12 +24,11 @@ module RSpec
       # @overload pending(message)
       # @overload pending(message, &block)
       #
-      # Stops execution of an example, and reports it as pending. Takes an
-      # optional message and block.
+      # Marks an example as pending. The rest of the example will still be
+      # executed, and if it passes the example will fail to indicate that the
+      # pending can be removed.
       #
       # @param [String] message optional message to add to the summary report.
-      # @param [Block] block optional block. If it fails, the example is
-      #   reported as pending. If it executes cleanly the example fails.
       #
       # @example
       #
@@ -31,28 +36,13 @@ module RSpec
       #       # reported as "Pending: no reason given"
       #       it "is pending with no message" do
       #         pending
-      #         this_does_not_get_executed
+      #         raise "broken" 
       #       end
       #
       #       # reported as "Pending: something else getting finished"
       #       it "is pending with a custom message" do
       #         pending("something else getting finished")
-      #         this_does_not_get_executed
-      #       end
-      #
-      #       # reported as "Pending: something else getting finished"
-      #       it "is pending with a failing block" do
-      #         pending("something else getting finished") do
-      #           raise "this is the failure"
-      #         end
-      #       end
-      #
-      #       # reported as failure, saying we expected the block to fail but
-      #       # it passed.
-      #       it "is pending with a passing block" do
-      #         pending("something else getting finished") do
-      #           true.should be(true)
-      #         end
+      #         raise "broken"
       #       end
       #     end
       #
@@ -74,36 +64,77 @@ module RSpec
       def pending(*args)
         current_example = RSpec.current_example
 
-        return self.class.before(:each) { pending(*args) } unless current_example
+        if current_example
+          Pending.mark_pending! current_example, args.first
+        else
+          raise "`pending` may not be used outside of examples, such as in " +
+                "before(:all). Maybe you want `skip`?"
+        end
+      end
 
-        options = args.last.is_a?(Hash) ? args.pop : {}
-        message = args.first || NO_REASON_GIVEN
+      # @overload skip()
+      # @overload skip(message)
+      # @overload skip(message, &block)
+      #
+      # Marks an example as pending and skips execution when called without a
+      # block. When called with a block, skips just that block and does not
+      # mark the example as pending. The block form is provided as replacement
+      # for RSpec 2's pending-with-block feature, and is not recommended for
+      # new code. Use simple conditionals instead.
+      #
+      # @param [String] message optional message to add to the summary report.
+      # @block [Block] block optional block to be skipped
+      #
+      # @example
+      #
+      #     describe "an example" do
+      #       # reported as "Pending: no reason given"
+      #       it "is skipped with no message" do
+      #         skip
+      #       end
+      #
+      #       # reported as "Pending: something else getting finished"
+      #       it "is skipped with a custom message" do
+      #         skip "something else getting finished"
+      #       end
+      #
+      #       # Passes
+      #       it "contains a skipped statement" do
+      #         skip do
+      #           fail
+      #         end
+      #       end
+      #     end
+      def skip(*args)
+        current_example = RSpec.current_example
 
-        if options[:unless] || (options.has_key?(:if) && !options[:if])
-          return block_given? ? yield : nil
+        if current_example
+          Pending.mark_skipped! current_example, args.first
         end
 
-        current_example.metadata[:pending] = true
-        current_example.metadata[:execution_result][:pending_message] = message
-        current_example.execution_result[:pending_fixed] = false
-        if block_given?
-          begin
-            result = begin
-                       yield
-                       current_example.example_group_instance.instance_eval { verify_mocks_for_rspec }
-                     end
-            current_example.metadata[:pending] = false
-          rescue Exception => e
-            current_example.execution_result[:exception] = e
-          ensure
-            teardown_mocks_for_rspec
-          end
-          if result
-            current_example.execution_result[:pending_fixed] = true
-            raise PendingExampleFixedError.new
-          end
+        raise SkipDeclaredInExample.new(args.first)
+      end
+
+      def self.mark_skipped!(example, message_or_bool)
+        Pending.mark_pending! example, message_or_bool
+        example.metadata[:skip] = true
+      end
+
+      def self.mark_pending!(example, message_or_bool)
+        message = if !message_or_bool || !(String === message_or_bool)
+          NO_REASON_GIVEN
+        else
+          message_or_bool
         end
-        raise PendingDeclaredInExample.new(message)
+
+        example.metadata[:pending] = true
+        example.metadata[:execution_result][:pending_message] = message
+        example.execution_result[:pending_fixed] = false
+      end
+
+      def self.mark_fixed!(example)
+        example.metadata[:pending] = false
+        example.metadata[:execution_result][:pending_fixed] = true
       end
     end
   end