rspec-core 2.99.2 → 3.0.0.beta1

data/lib/rspec/core/ordering.rb

@@ -0,0 +1,154 @@
+module RSpec
+  module Core
+    if defined?(::Random)
+      RandomNumberGenerator = ::Random
+    else
+      require 'rspec/core/backport_random'
+      RandomNumberGenerator = RSpec::Core::Backports::Random
+    end
+
+    # @private
+    module Ordering
+      # @private
+      # The default global ordering (defined order).
+      class Identity
+        def order(items)
+          items
+        end
+      end
+
+      # @private
+      # Orders items randomly.
+      class Random
+        def initialize(configuration)
+          @configuration = configuration
+          @used = false
+        end
+
+        def used?
+          @used
+        end
+
+        def order(items)
+          @used = true
+          rng = RandomNumberGenerator.new(@configuration.seed)
+          shuffle items, rng
+        end
+
+        if RUBY_VERSION > '1.9.3'
+          def shuffle(list, rng)
+            list.shuffle(:random => rng)
+          end
+        else
+          def shuffle(list, rng)
+            shuffled = list.dup
+            shuffled.size.times do |i|
+              j = i + rng.rand(shuffled.size - i)
+              next if i == j
+              shuffled[i], shuffled[j] = shuffled[j], shuffled[i]
+            end
+
+            shuffled
+          end
+        end
+      end
+
+      # @private
+      # Orders items based on a custom block.
+      class Custom
+        def initialize(callable)
+          @callable = callable
+        end
+
+        def order(list)
+          @callable.call(list)
+        end
+      end
+
+      # @private
+      # Stores the different ordering strategies.
+      class Registry
+        def initialize(configuration)
+          @configuration = configuration
+          @strategies    = {}
+
+          register(:random,  Random.new(configuration))
+
+          identity = Identity.new
+          register(:defined, identity)
+
+          # The default global ordering is --defined.
+          register(:global, identity)
+        end
+
+        def fetch(name, &fallback)
+          @strategies.fetch(name, &fallback)
+        end
+
+        def register(sym, strategy)
+          @strategies[sym] = strategy
+        end
+
+        def used_random_seed?
+          @strategies[:random].used?
+        end
+      end
+
+      # @private
+      # Manages ordering configuration.
+      #
+      # @note This is not intended to be used externally. Use
+      #       the APIs provided by `RSpec::Core::Configuration` instead.
+      class ConfigurationManager
+        attr_reader :seed, :ordering_registry
+
+        def initialize
+          @ordering_registry = Registry.new(self)
+          @seed = rand(0xFFFF)
+          @seed_forced = false
+          @order_forced = false
+        end
+
+        def seed_used?
+          ordering_registry.used_random_seed?
+        end
+
+        def seed=(seed)
+          return if @seed_forced
+          register_ordering(:global, ordering_registry.fetch(:random))
+          @seed = seed.to_i
+        end
+
+        def order=(type)
+          order, seed = type.to_s.split(':')
+          @seed = seed = seed.to_i if seed
+
+          ordering_name = if order.include?('rand')
+            :random
+          elsif order == 'defined'
+            :defined
+          end
+
+          register_ordering(:global, ordering_registry.fetch(ordering_name)) if ordering_name
+        end
+
+        def force(hash)
+          if hash.has_key?(:seed)
+            self.seed = hash[:seed]
+            @seed_forced  = true
+            @order_forced = true
+          elsif hash.has_key?(:order)
+            self.order = hash[:order]
+            @order_forced = true
+          end
+        end
+
+        def register_ordering(name, strategy = Custom.new(Proc.new { |l| yield l }))
+          return if @order_forced && name == :global
+          ordering_registry.register(name, strategy)
+        end
+      end
+    end
+  end
+end
+

data/lib/rspec/core/pending.rb

@@ -1,14 +1,7 @@
 module RSpec
   module Core
     module Pending
-      class SkipDeclaredInExample < StandardError
-        attr_reader :argument
-
-        def initialize(argument)
-          super(argument.to_s)
-          @argument = argument
-        end
-      end
+      class PendingDeclaredInExample < StandardError; 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.
@@ -78,33 +71,10 @@ module RSpec
       #       it "does something", :pending => "something else getting finished" do
       #         # ...
       #       end
-      def pending(*args, &block)
-        RSpec.warn_deprecation(<<-EOS.gsub(/^\s+\|/, ''))
-          |The semantics of `RSpec::Core::Pending#pending` are changing in
-          |RSpec 3.  In RSpec 2.x, it caused the example to be skipped. In
-          |RSpec 3, the rest of the example will still be run but is expected
-          |to fail, and will be marked as a failure (rather than as pending)
-          |if the example passes.
-          |
-          |Any passed block will no longer be executed. This feature is being
-          |removed since it was semantically inconsistent, and the behaviour it
-          |offered is being made available with the other ways of marking an
-          |example pending.
-          |
-          |To keep the same skip semantics, change `pending` to `skip`.
-          |Otherwise, if you want the new RSpec 3 behavior, you can safely
-          |ignore this warning and continue to upgrade to RSpec 3 without
-          |addressing it.
-          |
-          |Called from #{CallerFilter.first_non_rspec_line}.
-          |
-        EOS
-
-        pending_no_warning(*args, &block)
-      end
+      def pending(*args)
+        current_example = RSpec.current_example
 
-      def pending_no_warning(*args)
-        return self.class.before(:each) { pending(*args) } unless RSpec.current_example
+        return self.class.before(:each) { pending(*args) } unless current_example
 
         options = args.last.is_a?(Hash) ? args.pop : {}
         message = args.first || NO_REASON_GIVEN
@@ -113,55 +83,28 @@ module RSpec
           return block_given? ? yield : nil
         end
 
-        RSpec.current_example.metadata[:pending] = true
-        RSpec.current_example.metadata[:execution_result][:pending_message] = message
-        RSpec.current_example.execution_result[:pending_fixed] = false
+        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
-                       RSpec.current_example.example_group_instance.instance_eval { verify_mocks_for_rspec }
+                       current_example.example_group_instance.instance_eval { verify_mocks_for_rspec }
                      end
-            RSpec.current_example.metadata[:pending] = false
+            current_example.metadata[:pending] = false
           rescue Exception => e
-            RSpec.current_example.execution_result[:exception] = e
+            current_example.execution_result[:exception] = e
           ensure
             teardown_mocks_for_rspec
           end
           if result
-            RSpec.current_example.execution_result[:pending_fixed] = true
+            current_example.execution_result[:pending_fixed] = true
             raise PendingExampleFixedError.new
           end
         end
-        raise SkipDeclaredInExample.new(message)
-      end
-
-      # Backport from RSpec 3 to aid in upgrading.
-      #
-      # Not using alias method because we explictly want to discard any block.
-      def skip(*args)
-        pending_no_warning(*args)
+        raise PendingDeclaredInExample.new(message)
       end
-
-      def self.const_missing(name)
-        return super unless name == :PendingDeclaredInExample
-
-        RSpec.deprecate("RSpec::Core::PendingDeclaredInExample",
-          :replacement => "RSpec::Core::Pending::SkipDeclaredInExample")
-
-        SkipDeclaredInExample
-      end
-    end
-
-    # Alias the error for compatibility with extension gems (e.g. formatters)
-    # that depend on the const name of the error in RSpec <= 2.8.
-    def self.const_missing(name)
-      return super unless name == :PendingExampleFixedError
-
-      RSpec.deprecate("RSpec::Core::PendingExampleFixedError",
-        :replacement => "RSpec::Core::Pending::PendingExampleFixedError")
-
-      Pending::PendingExampleFixedError
     end
   end
 end

data/lib/rspec/core/project_initializer.rb

@@ -8,10 +8,6 @@ module RSpec
       def run
         create_spec_helper_file
         create_dot_rspec_file
-        delete_if_confirmed("autotest/discover.rb", <<-MESSAGE)
-  RSpec registers its own discover.rb with Autotest, so autotest/discover.rb is
-  no longer needed.
-        MESSAGE
 
         delete_if_confirmed("lib/tasks/rspec.rake", <<-MESSAGE)
   If the file in lib/tasks/rspec.rake is the one generated by rspec-rails-1x,
@@ -35,9 +31,9 @@ CONTENT
 
       def create_spec_helper_file
         if File.exist?('spec/spec_helper.rb')
-          report_exists("spec/spec_helper.rb")
+          report_exists('spec/spec_helper.rb')
         else
-          report_creating("spec/spec_helper.rb")
+          report_creating('spec/spec_helper.rb')
           FileUtils.mkdir_p('spec')
           File.open('spec/spec_helper.rb','w') do |f|
             f.write <<-CONTENT
@@ -48,15 +44,21 @@ CONTENT
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
-  config.run_all_when_everything_filtered = true
-  config.filter_run :focus
+  # Limit the spec run to only specs with the focus metadata. If no specs have
+  # the filtering metadata and `run_all_when_everything_filtered = true` then
+  # all specs will run.
+  #config.filter_run :focus
+
+  # Run all specs when none match the provided filter. This works well in
+  # conjunction with `config.filter_run :focus`, as it will run the entire
+  # suite when no specs have `:filter` metadata.
+  #config.run_all_when_everything_filtered = true
 
   # Run specs in random order to surface order dependencies. If you find an
   # order dependency and want to debug it, you can fix the order by providing
   # the seed, which is printed after each run.
   #     --seed 1234
-  config.order = 'random'
+  #config.order = 'random'
 end
 CONTENT
           end

data/lib/rspec/core/rake_task.rb

@@ -1,5 +1,4 @@
-require 'rspec/core'
-require 'rspec/core/backward_compatibility'
+require 'rspec/support/warnings'
 require 'rake'
 require 'rake/tasklib'
 require 'shellwords'
@@ -21,31 +20,6 @@ module RSpec
       #   'spec/**/*_spec.rb'
       attr_accessor :pattern
 
-      # @deprecated
-      # Has no effect. The rake task now checks ENV['BUNDLE_GEMFILE'] instead.
-      def skip_bundler=(*)
-        deprecate("RSpec::Core::RakeTask#skip_bundler=")
-      end
-
-      # @deprecated
-      # Has no effect. The rake task now checks ENV['BUNDLE_GEMFILE'] instead.
-      def gemfile=(*)
-        deprecate("RSpec::Core::RakeTask#gemfile=", :replacement => 'ENV["BUNDLE_GEMFILE"]')
-      end
-
-      # @deprecated
-      # Use ruby_opts="-w" instead.
-      #
-      # When true, requests that the specs be run with the warning flag set.
-      # e.g. "ruby -w"
-      #
-      # default:
-      #   false
-      def warning=(true_or_false)
-        deprecate("RSpec::Core::RakeTask#warning=", :replacement => 'ruby_opts="-w"')
-        @warning = true_or_false
-      end
-
       # Whether or not to fail Rake when an error occurs (typically when examples fail).
       #
       # default:
@@ -62,51 +36,6 @@ module RSpec
       #   true
       attr_accessor :verbose
 
-      # Use rcov for code coverage?
-      #
-      # Due to the many ways `rcov` can run, if this option is enabled, it is
-      # required that `require 'rspec/autorun'` appears in `spec_helper`.rb
-      #
-      # default:
-      #   false
-      def rcov
-        deprecate("RSpec::Core::RakeTask#rcov")
-        @rcov
-      end
-
-      def rcov=(true_or_false)
-        deprecate("RSpec::Core::RakeTask#rcov=")
-        @rcov = true_or_false
-      end
-
-      # Path to rcov.
-      #
-      # default:
-      #   'rcov'
-      def rcov_path
-        deprecate("RSpec::Core::RakeTask#rcov_path")
-        @rcov_path
-      end
-
-      def rcov_path=(path)
-        deprecate("RSpec::Core::RakeTask#rcov_path=")
-        @rcov_path = path
-      end
-
-      # Command line options to pass to rcov.
-      #
-      # default:
-      #   nil
-      def rcov_opts
-        deprecate("RSpec::Core::RakeTask#rcov_opts")
-        @rcov_opts
-      end
-
-      def rcov_opts=(opts)
-        deprecate("RSpec::Core::RakeTask#rcov_opts=")
-        @rcov_opts = opts
-      end
-
       # Command line options to pass to ruby.
       #
       # default:
@@ -133,7 +62,7 @@ module RSpec
       # default:
       #   nil
       def spec_opts=(opts)
-        deprecate('RSpec::Core::RakeTask#spec_opts=', :replacement => 'rspec_opts=')
+        RSpec.deprecate('RSpec::Core::RakeTask#spec_opts=', :replacement => 'rspec_opts=')
         @rspec_opts = opts
       end
 
@@ -152,11 +81,9 @@ module RSpec
 
       def setup_ivars(args)
         @name = args.shift || :spec
-        @rcov_opts, @ruby_opts, @rspec_opts = nil, nil, nil
-        @warning, @rcov = false, false
+        @ruby_opts, @rspec_opts = nil, nil, nil
         @verbose, @fail_on_error = true, true
 
-        @rcov_path  = 'rcov'
         @rspec_path = 'rspec'
         @pattern    = './spec{,/*/**}/*_spec.rb'
       end
@@ -175,21 +102,11 @@ module RSpec
 
     private
 
-      if "".respond_to?(:shellescape)
-        def shellescape(string)
-          string.shellescape
-        end
-      else # 1.8.6's shellwords doesn't provide shellescape :(.
-        def shellescape(string)
-          string.gsub(/"/, '\"').gsub(/'/, "\\\\'")
-        end
-      end
-
       def files_to_run
         if ENV['SPEC']
           FileList[ ENV['SPEC'] ].sort
         else
-          FileList[ pattern ].sort.map { |f| shellescape(f) }
+          FileList[ pattern ].sort.map(&:shellescape)
         end
       end
 
@@ -197,35 +114,15 @@ module RSpec
         cmd_parts = []
         cmd_parts << RUBY
         cmd_parts << ruby_opts
-        cmd_parts << "-w" if @warning
-        cmd_parts << "-S" << runner
-        cmd_parts << "-Ispec:lib" << @rcov_opts if @rcov
+        cmd_parts << "-S" << rspec_path
         cmd_parts << files_to_run
-        cmd_parts << "--" if @rcov && rspec_opts
         cmd_parts << rspec_opts
         cmd_parts.flatten.reject(&blank).join(" ")
       end
 
-      def runner
-        @rcov ? @rcov_path : rspec_path
-      end
-
       def blank
         lambda {|s| s.nil? || s == ""}
       end
-
-      def deprecate deprecated, opts = {}
-        # unless RSpec is loaded, deprecate won't work (simply requiring the
-        # deprecate file isn't enough) so this is a check for "is rspec already
-        # loaded?" "ok use the main deprecate hook" otherwise "simple fallback"
-        # Note that we don't need rspec to be loaded for the rake task to work
-        if RSpec.respond_to?(:deprecate)
-          RSpec.deprecate deprecated, opts
-        else
-          warn "DEPRECATION: #{deprecated} is deprecated."
-        end
-      end
-
     end
   end
 end