opal-rspec 0.4.3 → 0.5.0.beta1

data/rspec-core/lib/rspec/core/rake_task.rb

@@ -0,0 +1,187 @@
+require 'rake'
+require 'rake/tasklib'
+require 'rbconfig'
+
+module RSpec
+  module Core
+    # Rspec rake task
+    #
+    # @see Rakefile
+    class RakeTask < ::Rake::TaskLib
+      include ::Rake::DSL if defined?(::Rake::DSL)
+
+      # 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.
+      #
+      # default:
+      #   :spec
+      attr_accessor :name
+
+      # Files matching this pattern will be loaded.
+      #
+      # default:
+      #   'spec/**{,/*/**}/*_spec.rb'
+      attr_accessor :pattern
+
+      # Files matching this pattern will be excluded.
+      #
+      # default:
+      #   'spec/**/*_spec.rb'
+      attr_accessor :exclude_pattern
+
+      # Whether or not to fail Rake when an error occurs (typically when examples fail).
+      #
+      # default:
+      #   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.
+      #
+      # default:
+      #   true
+      attr_accessor :verbose
+
+      # Command line options to pass to ruby.
+      #
+      # default:
+      #   nil
+      attr_accessor :ruby_opts
+
+      # Path to rspec
+      #
+      # default:
+      #   'rspec'
+      attr_accessor :rspec_path
+
+      # Command line options to pass to rspec.
+      #
+      # default:
+      #   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
+
+        begin
+          puts command if verbose
+          success = system(command)
+        rescue
+          puts failure_message if failure_message
+        end
+
+        return unless fail_on_error && !success
+
+        $stderr.puts "#{command} failed"
+        exit $?.exitstatus
+      end
+
+    private
+
+      # @private
+      def define(args, &task_block)
+        desc "Run RSpec code examples" unless ::Rake.application.last_comment
+
+        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)
+          "--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
+
+      # Manaully comparing because in 3.2 we have RSpec::Support::OS.windows?
+      # but in 3.1 we don't and requiring rspec/world would be weighty here.
+      if RbConfig::CONFIG['host_os'] =~ /cygwin|mswin|mingw|bccwin|wince|emx/
+        def escape(shell_command)
+          "'#{shell_command.gsub("'", "\'")}'"
+        end
+      else
+        require 'shellwords'
+
+        def escape(shell_command)
+          shell_command.shellescape
+        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 << 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

data/rspec-core/lib/rspec/core/reporter.rb

@@ -0,0 +1,149 @@
+module RSpec::Core
+  # A reporter will send notifications to listeners, usually formatters for the
+  # spec suite run.
+  class Reporter
+    def initialize(configuration)
+      @configuration = configuration
+      @listeners = Hash.new { |h, k| h[k] = Set.new }
+      @examples = []
+      @failed_examples = []
+      @pending_examples = []
+      @duration = @start = @load_time = nil
+    end
+
+    # @private
+    attr_reader :examples, :failed_examples, :pending_examples
+
+    # Registers a listener to a list of notifications. The reporter will send notification of
+    # events to all registered listeners
+    #
+    # @param listener [Object] An obect that wishes to be notified of reporter events
+    # @param notifications [Array] Array of symbols represents the events a listener wishes to subscribe too
+    def register_listener(listener, *notifications)
+      notifications.each do |notification|
+        @listeners[notification.to_sym] << listener
+      end
+      true
+    end
+
+    # @private
+    def registered_listeners(notification)
+      @listeners[notification].to_a
+    end
+
+    # @api
+    # @overload report(count, &block)
+    # @overload report(count, &block)
+    # @param expected_example_count [Integer] the number of examples being run
+    # @yield [Block] block yields itself for further reporting.
+    #
+    # Initializes the report run and yields itself for further reporting. The
+    # block is required, so that the reporter can manage cleaning up after the
+    # run.
+    #
+    # @example
+    #
+    #     reporter.report(group.examples.size) do |r|
+    #       example_groups.map {|g| g.run(r) }
+    #     end
+    #
+    def report(expected_example_count)
+      start(expected_example_count)
+      begin
+        yield self
+      ensure
+        finish
+      end
+    end
+
+    # @private
+    def start(expected_example_count, time=RSpec::Core::Time.now)
+      @start = time
+      @load_time = (@start - @configuration.start_time).to_f
+      notify :start, Notifications::StartNotification.new(expected_example_count, @load_time)
+    end
+
+    # @private
+    def message(message)
+      notify :message, Notifications::MessageNotification.new(message)
+    end
+
+    # @private
+    def example_group_started(group)
+      notify :example_group_started, Notifications::GroupNotification.new(group) unless group.descendant_filtered_examples.empty?
+    end
+
+    # @private
+    def example_group_finished(group)
+      notify :example_group_finished, Notifications::GroupNotification.new(group) unless group.descendant_filtered_examples.empty?
+    end
+
+    # @private
+    def example_started(example)
+      @examples << example
+      notify :example_started, Notifications::ExampleNotification.for(example)
+    end
+
+    # @private
+    def example_passed(example)
+      notify :example_passed, Notifications::ExampleNotification.for(example)
+    end
+
+    # @private
+    def example_failed(example)
+      @failed_examples << example
+      notify :example_failed, Notifications::ExampleNotification.for(example)
+    end
+
+    # @private
+    def example_pending(example)
+      @pending_examples << example
+      notify :example_pending, Notifications::ExampleNotification.for(example)
+    end
+
+    # @private
+    def deprecation(hash)
+      notify :deprecation, Notifications::DeprecationNotification.from_hash(hash)
+    end
+
+    # @private
+    def finish
+      stop
+      notify :start_dump,    Notifications::NullNotification
+      notify :dump_pending,  Notifications::ExamplesNotification.new(self)
+      notify :dump_failures, Notifications::ExamplesNotification.new(self)
+      notify :deprecation_summary, Notifications::NullNotification
+      notify :dump_summary, Notifications::SummaryNotification.new(@duration, @examples, @failed_examples, @pending_examples, @load_time)
+      unless mute_profile_output?
+        notify :dump_profile, Notifications::ProfileNotification.new(@duration, @examples, @configuration.profile_examples)
+      end
+      notify :seed, Notifications::SeedNotification.new(@configuration.seed, seed_used?)
+    ensure
+      notify :close, Notifications::NullNotification
+    end
+
+    # @private
+    def stop
+      @duration = (RSpec::Core::Time.now - @start).to_f if @start
+      notify :stop, Notifications::ExamplesNotification.new(self)
+    end
+
+    # @private
+    def notify(event, notification)
+      registered_listeners(event).each do |formatter|
+        formatter.__send__(event, notification)
+      end
+    end
+
+  private
+
+    def mute_profile_output?
+      # Don't print out profiled info if there are failures and `--fail-fast` is used, it just clutters the output
+      !@configuration.profile_examples? || (@configuration.fail_fast? && @failed_examples.size > 0)
+    end
+
+    def seed_used?
+      @configuration.seed && @configuration.seed_used?
+    end
+  end
+end

data/{vendor_lib → rspec-core/lib}/rspec/core/ruby_project.rb

@@ -6,9 +6,10 @@ require 'pathname'
 
 module RSpec
   module Core
+    # @private
     module RubyProject
       def add_to_load_path(*dirs)
-        dirs.map {|dir| add_dir_to_load_path(File.join(root, dir))}
+        dirs.map { |dir| add_dir_to_load_path(File.join(root, dir)) }
       end
 
       def add_dir_to_load_path(dir)
@@ -24,7 +25,7 @@ module RSpec
       end
 
       def find_first_parent_containing(dir)
-        ascend_until {|path| File.exists?(File.join(path, dir))}
+        ascend_until { |path| File.exist?(File.join(path, dir)) }
       end
 
       def ascend_until

data/rspec-core/lib/rspec/core/runner.rb

@@ -0,0 +1,158 @@
+module RSpec
+  module Core
+    # Provides the main entry point to run a suite of RSpec examples.
+    class Runner
+      # Register an `at_exit` hook that runs the suite when the process exits.
+      #
+      # @note This is not generally needed. The `rspec` command takes care
+      #       of running examples for you without involving an `at_exit`
+      #       hook. This is only needed if you are running specs using
+      #       the `ruby` command, and even then, the normal way to invoke
+      #       this is by requiring `rspec/autorun`.
+      def self.autorun
+        if autorun_disabled?
+          RSpec.deprecate("Requiring `rspec/autorun` when running RSpec via the `rspec` command")
+          return
+        elsif installed_at_exit? || running_in_drb?
+          return
+        end
+
+        at_exit do
+          # Don't bother running any specs and just let the program terminate
+          # if we got here due to an unrescued exception (anything other than
+          # SystemExit, which is raised when somebody calls Kernel#exit).
+          next unless $!.nil? || $!.is_a?(SystemExit)
+
+          # We got here because either the end of the program was reached or
+          # somebody called Kernel#exit.  Run the specs and then override any
+          # existing exit status with RSpec's exit status if any specs failed.
+          invoke
+        end
+        @installed_at_exit = true
+      end
+
+      # Runs the suite of specs and exits the process with an appropriate exit code.
+      def self.invoke
+        disable_autorun!
+        status = run(ARGV, $stderr, $stdout).to_i
+        exit(status) if status != 0
+      end
+
+      # Run a suite of RSpec examples. Does not exit.
+      #
+      # This is used internally by RSpec to run a suite, but is available
+      # for use by any other automation tool.
+      #
+      # If you want to run this multiple times in the same process, and you
+      # want files like `spec_helper.rb` to be reloaded, be sure to load `load`
+      # instead of `require`.
+      #
+      # @param args [Array] command-line-supported arguments
+      # @param err [IO] error stream
+      # @param out [IO] output stream
+      # @return [Fixnum] exit status code. 0 if all specs passed,
+      #   or the configured failure exit code (1 by default) if specs
+      #   failed.
+      def self.run(args, err=$stderr, out=$stdout)
+        trap_interrupt
+        options = ConfigurationOptions.new(args)
+
+        if options.options[:drb]
+          require 'rspec/core/drb'
+          begin
+            DRbRunner.new(options).run(err, out)
+          rescue DRb::DRbConnError
+            err.puts "No DRb server is running. Running in local process instead ..."
+            new(options).run(err, out)
+          end
+        else
+          new(options).run(err, out)
+        end
+      end
+
+      def initialize(options, configuration=RSpec.configuration, world=RSpec.world)
+        @options       = options
+        @configuration = configuration
+        @world         = world
+      end
+
+      # Configures and runs a spec suite.
+      #
+      # @param err [IO] error stream
+      # @param out [IO] output stream
+      def run(err, out)
+        setup(err, out)
+        run_specs(@world.ordered_example_groups)
+      end
+
+      # Wires together the various configuration objects and state holders.
+      #
+      # @param err [IO] error stream
+      # @param out [IO] output stream
+      def setup(err, out)
+        @configuration.error_stream = err
+        @configuration.output_stream = out if @configuration.output_stream == $stdout
+        @options.configure(@configuration)
+        @configuration.load_spec_files
+        @world.announce_filters
+      end
+
+      # Runs the provided example groups.
+      #
+      # @param example_groups [Array<RSpec::Core::ExampleGroup>] groups to run
+      # @return [Fixnum] exit status code. 0 if all specs passed,
+      #   or the configured failure exit code (1 by default) if specs
+      #   failed.
+      def run_specs(example_groups)
+        @configuration.reporter.report(@world.example_count(example_groups)) do |reporter|
+          begin
+            hook_context = SuiteHookContext.new
+            @configuration.hooks.run(:before, :suite, hook_context)
+            example_groups.map { |g| g.run(reporter) }.all? ? 0 : @configuration.failure_exit_code
+          ensure
+            @configuration.hooks.run(:after, :suite, hook_context)
+          end
+        end
+      end
+
+      # @private
+      def self.disable_autorun!
+        @autorun_disabled = true
+      end
+
+      # @private
+      def self.autorun_disabled?
+        @autorun_disabled ||= false
+      end
+
+      # @private
+      def self.installed_at_exit?
+        @installed_at_exit ||= false
+      end
+
+      # @private
+      # rubocop:disable Lint/EnsureReturn
+      def self.running_in_drb?
+        if defined?(DRb) && DRb.current_server
+          require 'socket'
+          require 'uri'
+          local_ipv4 = IPSocket.getaddress(Socket.gethostname)
+          local_drb = ["127.0.0.1", "localhost", local_ipv4].any? { |addr| addr == URI(DRb.current_server.uri).host }
+        end
+      rescue DRb::DRbServerNotFound
+      ensure
+        return local_drb || false
+      end
+      # rubocop:enable Lint/EnsureReturn
+
+      # @private
+      def self.trap_interrupt
+        trap('INT') do
+          exit!(1) if RSpec.world.wants_to_quit
+          RSpec.world.wants_to_quit = true
+          STDERR.puts "\nExiting... Interrupt again to exit immediately."
+        end
+      end
+    end
+  end
+end

data/{vendor_lib → rspec-core/lib}/rspec/core/shared_context.rb

@@ -7,7 +7,7 @@ module RSpec
     #
     #     module LoggedInAsAdmin
     #       extend RSpec::Core::SharedContext
-    #       before(:each) do
+    #       before(:example) do
     #         log_in_as :admin
     #       end
     #     end
@@ -17,25 +17,26 @@ module RSpec
     #       # ...
     #     end
     module SharedContext
-      # @api private
+      # @private
       def included(group)
         __shared_context_recordings.each do |recording|
           recording.playback_onto(group)
         end
       end
 
-      # @api private
+      # @private
       def __shared_context_recordings
         @__shared_context_recordings ||= []
       end
 
+      # @private
       Recording = Struct.new(:method_name, :args, :block) do
         def playback_onto(group)
           group.__send__(method_name, *args, &block)
         end
       end
 
-      # @api private
+      # @private
       def self.record(methods)
         methods.each do |meth|
           define_method(meth) do |*args, &block|
@@ -44,10 +45,11 @@ module RSpec
         end
       end
 
+      # @private
       record [:describe, :context] + Hooks.instance_methods(false) +
         MemoizedHelpers::ClassMethods.instance_methods(false)
     end
   end
-
+  # @private
   SharedContext = Core::SharedContext
 end