rspec-core 3.8.2

data/lib/rspec/core/output_wrapper.rb

@@ -0,0 +1,29 @@
+module RSpec
+  module Core
+    # @private
+    class OutputWrapper
+      # @private
+      attr_accessor :output
+
+      # @private
+      def initialize(output)
+        @output = output
+      end
+
+      def respond_to?(name, priv=false)
+        output.respond_to?(name, priv)
+      end
+
+      def method_missing(name, *args, &block)
+        output.send(name, *args, &block)
+      end
+
+      # Redirect calls for IO interface methods
+      IO.instance_methods(false).each do |method|
+        define_method(method) do |*args, &block|
+          output.send(method, *args, &block)
+        end
+      end
+    end
+  end
+end

data/lib/rspec/core/pending.rb

@@ -0,0 +1,165 @@
+module RSpec
+  module Core
+    # Provides methods to mark examples as pending. These methods are available
+    # to be called from within any example or hook.
+    module Pending
+      # Raised in the middle of an example to indicate that it should be marked
+      # as skipped.
+      class SkipDeclaredInExample < StandardError
+        attr_reader :argument
+
+        def initialize(argument)
+          @argument = argument
+        end
+      end
+
+      # If Test::Unit is loaded, we'll use its error as baseclass, so that
+      # Test::Unit will report unmet RSpec expectations as failures rather than
+      # errors.
+      begin
+        class PendingExampleFixedError < Test::Unit::AssertionFailedError; end
+      rescue
+        class PendingExampleFixedError < StandardError; end
+      end
+
+      # @private
+      NO_REASON_GIVEN = 'No reason given'
+
+      # @private
+      NOT_YET_IMPLEMENTED = 'Not yet implemented'
+
+      # @overload pending()
+      # @overload pending(message)
+      #
+      # 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 message [String] optional message to add to the summary report.
+      #
+      # @example
+      #     describe "an example" do
+      #       # reported as "Pending: no reason given"
+      #       it "is pending with no message" do
+      #         pending
+      #         raise "broken"
+      #       end
+      #
+      #       # reported as "Pending: something else getting finished"
+      #       it "is pending with a custom message" do
+      #         pending("something else getting finished")
+      #         raise "broken"
+      #       end
+      #     end
+      #
+      # @note `before(:example)` hooks are eval'd when you use the `pending`
+      #   method within an example. If you want to declare an example `pending`
+      #   and bypass the `before` hooks as well, you can pass `:pending => true`
+      #   to the `it` method:
+      #
+      #       it "does something", :pending => true do
+      #         # ...
+      #       end
+      #
+      #   or pass `:pending => "something else getting finished"` to add a
+      #   message to the summary report:
+      #
+      #       it "does something", :pending => "something else getting finished" do
+      #         # ...
+      #       end
+      def pending(message=nil)
+        current_example = RSpec.current_example
+
+        if block_given?
+          raise ArgumentError, <<-EOS.gsub(/^\s+\|/, '')
+            |The semantics of `RSpec::Core::Pending#pending` have changed in
+            |RSpec 3. In RSpec 2.x, it caused the example to be skipped. In
+            |RSpec 3, the rest of the example is still run but is expected to
+            |fail, and will be marked as a failure (rather than as pending) if
+            |the example passes.
+            |
+            |Passing a block within an example is now deprecated. Marking the
+            |example as pending provides the same behavior in RSpec 3 which was
+            |provided only by the block in RSpec 2.x.
+            |
+            |Move the code in the block provided to `pending` into the rest of
+            |the example body.
+            |
+            |Called from #{CallerFilter.first_non_rspec_line}.
+            |
+          EOS
+        elsif current_example
+          Pending.mark_pending! current_example, message
+        else
+          raise "`pending` may not be used outside of examples, such as in " \
+                "before(:context). Maybe you want `skip`?"
+        end
+      end
+
+      # @overload skip()
+      # @overload skip(message)
+      #
+      # Marks an example as pending and skips execution.
+      #
+      # @param message [String] optional message to add to the summary report.
+      #
+      # @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
+      #     end
+      def skip(message=nil)
+        current_example = RSpec.current_example
+
+        Pending.mark_skipped!(current_example, message) if current_example
+
+        raise SkipDeclaredInExample.new(message)
+      end
+
+      # @private
+      #
+      # Mark example as skipped.
+      #
+      # @param example [RSpec::Core::Example] the example to mark as skipped
+      # @param message_or_bool [Boolean, String] the message to use, or true
+      def self.mark_skipped!(example, message_or_bool)
+        Pending.mark_pending! example, message_or_bool
+        example.metadata[:skip] = true
+      end
+
+      # @private
+      #
+      # Mark example as pending.
+      #
+      # @param example [RSpec::Core::Example] the example to mark as pending
+      # @param message_or_bool [Boolean, String] the message to use, or true
+      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
+
+        example.metadata[:pending] = true
+        example.execution_result.pending_message = message
+        example.execution_result.pending_fixed = false
+      end
+
+      # @private
+      #
+      # Mark example as fixed.
+      #
+      # @param example [RSpec::Core::Example] the example to mark as fixed
+      def self.mark_fixed!(example)
+        example.execution_result.pending_fixed = true
+      end
+    end
+  end
+end

data/lib/rspec/core/profiler.rb

@@ -0,0 +1,34 @@
+module RSpec
+  module Core
+    # @private
+    class Profiler
+      NOTIFICATIONS = [:example_group_started, :example_group_finished, :example_started]
+
+      def initialize
+        @example_groups = Hash.new { |h, k| h[k] = { :count => 0 } }
+      end
+
+      attr_reader :example_groups
+
+      def example_group_started(notification)
+        return unless notification.group.top_level?
+
+        @example_groups[notification.group][:start] = Time.now
+        @example_groups[notification.group][:description] = notification.group.top_level_description
+      end
+
+      def example_group_finished(notification)
+        return unless notification.group.top_level?
+
+        group = @example_groups[notification.group]
+        return unless group.key?(:start)
+        group[:total_time] = Time.now - group[:start]
+      end
+
+      def example_started(notification)
+        group = notification.example.example_group.parent_groups.last
+        @example_groups[group][:count] += 1
+      end
+    end
+  end
+end

data/lib/rspec/core/project_initializer.rb

@@ -0,0 +1,48 @@
+RSpec::Support.require_rspec_support "directory_maker"
+
+module RSpec
+  module Core
+    # @private
+    # Generates conventional files for an RSpec project.
+    class ProjectInitializer
+      attr_reader :destination, :stream, :template_path
+
+      DOT_RSPEC_FILE = '.rspec'
+      SPEC_HELPER_FILE =  'spec/spec_helper.rb'
+
+      def initialize(opts={})
+        @destination = opts.fetch(:destination, Dir.getwd)
+        @stream = opts.fetch(:report_stream, $stdout)
+        @template_path = opts.fetch(:template_path) do
+          File.expand_path("../project_initializer", __FILE__)
+        end
+      end
+
+      def run
+        copy_template DOT_RSPEC_FILE
+        copy_template SPEC_HELPER_FILE
+      end
+
+    private
+
+      def copy_template(file)
+        destination_file = File.join(destination, file)
+        return report_exists(file) if File.exist?(destination_file)
+
+        report_creating(file)
+        RSpec::Support::DirectoryMaker.mkdir_p(File.dirname(destination_file))
+        File.open(destination_file, 'w') do |f|
+          f.write File.read(File.join(template_path, file))
+        end
+      end
+
+      def report_exists(file)
+        stream.puts "   exist   #{file}"
+      end
+
+      def report_creating(file)
+        stream.puts "  create   #{file}"
+      end
+    end
+  end
+end

data/lib/rspec/core/project_initializer/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/lib/rspec/core/project_initializer/spec/spec_helper.rb

@@ -0,0 +1,100 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # 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
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/lib/rspec/core/rake_task.rb

@@ -0,0 +1,168 @@
+require 'rake'
+require 'rake/tasklib'
+require 'rspec/support'
+
+RSpec::Support.require_rspec_support "ruby_features"
+
+# :nocov:
+unless RSpec::Support.respond_to?(:require_rspec_core)
+  RSpec::Support.define_optimized_require_for_rspec(:core) { |f| require_relative "../#{f}" }
+end
+# :nocov:
+
+RSpec::Support.require_rspec_core "shell_escape"
+
+module RSpec
+  module Core
+    # RSpec rake task
+    #
+    # @see Rakefile
+    class RakeTask < ::Rake::TaskLib
+      include ::Rake::DSL if defined?(::Rake::DSL)
+      include RSpec::Core::ShellEscape
+
+      # Default path to the RSpec executable.
+      DEFAULT_RSPEC_PATH = File.expand_path('../../../../exe/rspec', __FILE__)
+
+      # Default pattern for spec files.
+      DEFAULT_PATTERN = 'spec/**{,/*/**}/*_spec.rb'
+
+      # Name of task. Defaults to `:spec`.
+      attr_accessor :name
+
+      # Files matching this pattern will be loaded.
+      # Defaults to `'spec/**{,/*/**}/*_spec.rb'`.
+      attr_accessor :pattern
+
+      # Files matching this pattern will be excluded.
+      # Defaults to `nil`.
+      attr_accessor :exclude_pattern
+
+      # Whether or not to fail Rake when an error occurs (typically when
+      # examples fail). Defaults to `true`.
+      attr_accessor :fail_on_error
+
+      # A message to print to stderr when there are failures.
+      attr_accessor :failure_message
+
+      # Use verbose output. If this is set to true, the task will print the
+      # executed spec command to stdout. Defaults to `true`.
+      attr_accessor :verbose
+
+      # Command line options to pass to ruby. Defaults to `nil`.
+      attr_accessor :ruby_opts
+
+      # Path to RSpec. Defaults to the absolute path to the
+      # rspec binary from the loaded rspec-core gem.
+      attr_accessor :rspec_path
+
+      # Command line options to pass to RSpec. Defaults to `nil`.
+      attr_accessor :rspec_opts
+
+      def initialize(*args, &task_block)
+        @name          = args.shift || :spec
+        @ruby_opts     = nil
+        @rspec_opts    = nil
+        @verbose       = true
+        @fail_on_error = true
+        @rspec_path    = DEFAULT_RSPEC_PATH
+        @pattern       = DEFAULT_PATTERN
+
+        define(args, &task_block)
+      end
+
+      # @private
+      def run_task(verbose)
+        command = spec_command
+        puts command if verbose
+
+        return if system(command)
+        puts failure_message if failure_message
+
+        return unless fail_on_error
+        $stderr.puts "#{command} failed" if verbose
+        exit $?.exitstatus || 1
+      end
+
+    private
+
+      # @private
+      def define(args, &task_block)
+        desc "Run RSpec code examples" unless ::Rake.application.last_description
+
+        task name, *args do |_, task_args|
+          RakeFileUtils.__send__(:verbose, verbose) do
+            task_block.call(*[self, task_args].slice(0, task_block.arity)) if task_block
+            run_task verbose
+          end
+        end
+      end
+
+      def file_inclusion_specification
+        if ENV['SPEC']
+          FileList[ENV['SPEC']].sort
+        elsif String === pattern && !File.exist?(pattern)
+          return if rspec_opts =~ /--pattern/
+          "--pattern #{escape pattern}"
+        else
+          # Before RSpec 3.1, we used `FileList` to get the list of matched
+          # files, and then pass that along to the `rspec` command. Starting
+          # with 3.1, we prefer to pass along the pattern as-is to the `rspec`
+          # command, for 3 reasons:
+          #
+          #   * It's *much* less verbose to pass one `--pattern` option than a
+          #     long list of files.
+          #   * It ensures `task.pattern` and `--pattern` have the same
+          #     behavior.
+          #   * It fixes a bug, where
+          #     `task.pattern = pattern_that_matches_no_files` would run *all*
+          #     files because it would cause no pattern or file args to get
+          #     passed to `rspec`, which causes all files to get run.
+          #
+          # However, `FileList` is *far* more flexible than the `--pattern`
+          # option. Specifically, it supports individual files and directories,
+          # as well as arrays of files, directories and globs, as well as other
+          # `FileList` objects.
+          #
+          # For backwards compatibility, we have to fall back to using FileList
+          # if the user has passed a `pattern` option that will not work with
+          # `--pattern`.
+          #
+          # TODO: consider deprecating support for this and removing it in
+          #   RSpec 4.
+          FileList[pattern].sort.map { |file| escape file }
+        end
+      end
+
+      def file_exclusion_specification
+        " --exclude-pattern #{escape exclude_pattern}" if exclude_pattern
+      end
+
+      def spec_command
+        cmd_parts = []
+        cmd_parts << RUBY
+        cmd_parts << ruby_opts
+        cmd_parts << rspec_load_path
+        cmd_parts << escape(rspec_path)
+        cmd_parts << file_inclusion_specification
+        cmd_parts << file_exclusion_specification
+        cmd_parts << rspec_opts
+        cmd_parts.flatten.reject(&blank).join(" ")
+      end
+
+      def blank
+        lambda { |s| s.nil? || s == "" }
+      end
+
+      def rspec_load_path
+        @rspec_load_path ||= begin
+          core_and_support = $LOAD_PATH.grep(
+            /#{File::SEPARATOR}rspec-(core|support)[^#{File::SEPARATOR}]*#{File::SEPARATOR}lib/
+          ).uniq
+
+          "-I#{core_and_support.map { |file| escape file }.join(File::PATH_SEPARATOR)}"
+        end
+      end
+    end
+  end
+end