rspec-interactive 0.1.0 → 0.5.0

data/lib/rspec-interactive/config.rb

@@ -0,0 +1,23 @@
+module RSpec
+  module Interactive
+    class Configuration
+      attr_accessor :watch_dirs, :configure_rspec, :on_class_load
+
+      def initialize
+        @watch_dirs      = []
+        @configure_rspec = proc {}
+        @on_class_load   = proc {}
+      end
+
+      def configure_rspec(&block)
+        return @configure_rspec unless block
+        @configure_rspec = block
+      end
+
+      def on_class_load(&block)
+        return @on_class_load unless block
+        @on_class_load = block
+      end
+    end
+  end
+end

data/lib/rspec-interactive/input_completer.rb

@@ -0,0 +1,24 @@
+module RSpec::Interactive
+  class InputCompleter < Pry::InputCompleter
+
+    def rspec_completions(string)
+      line = Readline.line_buffer
+      before_current = Readline.point == string.length ? '' :  line[0..(Readline.point - string.length)]
+      before_cursor = line[0..(Readline.point - 1)]
+
+      if line.match(/^ *rspec +/)
+        Dir[string + '*'].map { |filename| File.directory?(filename) ? "#{filename}/" : filename }
+      elsif before_current.strip.empty? && "rspec".match(/^#{Regexp.escape(string)}/)
+        ["rspec "]
+      else
+        nil
+      end
+    end
+
+    def call(str, options = {})
+      rspec_completions = rspec_completions(str)
+      return rspec_completions if rspec_completions
+      super
+    end
+  end
+end

data/lib/rspec-interactive/rspec_command.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RSpec::Interactive
+  class RSpecCommand < Pry::ClassCommand
+    match 'rspec'
+    description "Invoke RSpec."
+
+    banner <<-BANNER
+      Usage: rspec [arguments]
+
+      See https://relishapp.com/rspec/rspec-core/docs/command-line.
+    BANNER
+
+    command_options(
+      :keep_retval => false
+    )
+
+    def process
+      RSpec::Interactive.rspec(args)
+    end
+
+    Pry::Commands.add_command(::RSpec::Interactive::RSpecCommand)
+  end
+end

data/lib/rspec-interactive/rspec_config_cache.rb

@@ -0,0 +1,96 @@
+# Copied from https://github.com/nviennot/rspec-console/blob/master/lib/rspec-console/config_cache.rb
+class RSpec::Interactive::ConfigCache
+  # We have to reset the RSpec.configuration, because it contains a lot of
+  # information related to the current test (what's running, what are the
+  # different test results, etc).
+  #
+  # RSpec.configuration gets also loaded with a bunch of stuff from the
+  # 'spec/spec_helper.rb' file. Often that instance is extended with other
+  # modules (FactoryGirl, Mocha,...) and we don't want to replace requires with
+  # load all around the place.
+  #
+  # Instead, we proxy and record whatever is done to RSpec.configuration during
+  # the first invocation of require('spec_helper').  This is done by interposing
+  # the RecordingProxy class on of RSpec.configuration.
+  attr_accessor :config_proxy, :root_shared_examples
+
+  class RecordingProxy < Struct.new(:target, :recorded_messages)
+    [:include, :extend].each do |method|
+      define_method(method) do |*args|
+        method_missing(method, *args)
+      end
+    end
+
+    def method_missing(method, *args, &block)
+      self.recorded_messages << [method, args, block]
+      self.target.send(method, *args, &block)
+    end
+  end
+
+  def record_configuration(&configuration_block)
+    ensure_configuration_setter!
+
+    original_config = ::RSpec.configuration
+    ::RSpec.configuration = RecordingProxy.new(original_config, [])
+
+    configuration_block.call # spec helper is called during this yield, see #reset
+
+    self.config_proxy = ::RSpec.configuration
+    ::RSpec.configuration = original_config
+
+    stash_shared_examples
+
+    forward_rspec_config_singleton_to(self.config_proxy)
+  end
+
+  def replay_configuration
+    ::RSpec.configure do |config|
+      self.config_proxy.recorded_messages.each do |method, args, block|
+        # reporter caches config.output_stream which is not good as it
+        # prevents the runner to use a custom stdout.
+        next if method == :reporter
+        config.send(method, *args, &block)
+      end
+    end
+
+    restore_shared_examples
+
+    forward_rspec_config_singleton_to(self.config_proxy)
+  end
+
+  def has_recorded_config?
+    !!self.config_proxy
+  end
+
+  def forward_rspec_config_singleton_to(config_proxy)
+    # an old version of rspec-rails/lib/rspec/rails/view_rendering.rb adds
+    # methods on the configuration singleton. This takes care of that.
+    ::RSpec.configuration.singleton_class
+      .send(:define_method, :method_missing, &config_proxy.method(:send))
+  end
+
+  def stash_shared_examples
+    self.root_shared_examples = ::RSpec.world.shared_example_group_registry.send(:shared_example_groups).dup
+  end
+
+  def restore_shared_examples
+    shared_example_groups = ::RSpec.world.shared_example_group_registry.send(:shared_example_groups)
+    shared_example_groups.clear
+
+    self.root_shared_examples.each do |context, hash|
+      hash.each do |name, shared_module|
+        shared_example_groups[context][name] = shared_module
+      end
+    end
+  end
+
+  def ensure_configuration_setter!
+    return if RSpec.respond_to?(:configuration=)
+
+    ::RSpec.instance_eval do
+      def self.configuration=(value)
+        @configuration = value
+      end
+    end
+  end
+end

data/lib/rspec-interactive/runner.rb

@@ -1,46 +1,69 @@
 require 'rspec/core'
 
-module RSpecInteractive
-  class Runner
-    def initialize(args)
-      RSpec.world.wants_to_quit = false
-      @options = RSpec::Core::ConfigurationOptions.new(args)
-    end
+module RSpec
+  module Interactive
+    class Runner
+      def initialize(args)
+        ::RSpec.world.wants_to_quit = false
+        @options = ::RSpec::Core::ConfigurationOptions.new(args)
+      end
 
-    def run()
-      begin
-        @options.configure(RSpec.configuration)
-        return if RSpec.world.wants_to_quit
+      def run()
+        begin
+          @options.configure(::RSpec.configuration)
+          return if ::RSpec.world.wants_to_quit
 
-        RSpec.configuration.load_spec_files
-      ensure
-        RSpec.world.announce_filters
-      end
+          ::RSpec.configuration.load_spec_files
+        ensure
+          ::RSpec.world.announce_filters
+        end
 
-      return RSpec.configuration.reporter.exit_early(RSpec.configuration.failure_exit_code) if RSpec.world.wants_to_quit
+        return ::RSpec.configuration.reporter.exit_early(::RSpec.configuration.failure_exit_code) if ::RSpec.world.wants_to_quit
 
-      example_groups = RSpec.world.ordered_example_groups
-      examples_count = RSpec.world.example_count(example_groups)
+        example_groups = ::RSpec.world.ordered_example_groups
+        examples_count = ::RSpec.world.example_count(example_groups)
 
-      success = RSpec.configuration.reporter.report(examples_count) do |reporter|
-        RSpec.configuration.with_suite_hooks do
-          if examples_count == 0 && RSpec.configuration.fail_if_no_examples
-            return RSpec.configuration.failure_exit_code
-          end
+        exit_code = ::RSpec.configuration.reporter.report(examples_count) do |reporter|
+          ::RSpec.configuration.with_suite_hooks do
+            if examples_count == 0 && ::RSpec.configuration.fail_if_no_examples
+              return ::RSpec.configuration.failure_exit_code
+            end
+
+            group_results = example_groups.map do |example_group|
+              example_group.run(reporter)
+            end
 
-          result = example_groups.map do |example_group|
-            example_group.run(reporter)
+            success = group_results.all?
+            exit_code = success ? 0 : 1
+            if ::RSpec.world.non_example_failure
+              success = false
+              exit_code = ::RSpec.configuration.failure_exit_code
+            end
+            persist_example_statuses
+            exit_code
           end
+        end
 
-          result.all?
+        if exit_code != 0 && ::RSpec.configuration.example_status_persistence_file_path
+          ::RSpec.configuration.output_stream.puts "Rerun failures by executing the previous command with --only-failures or --next-failure."
+          ::RSpec.configuration.output_stream.puts
         end
+
+        exit_code
       end
 
-      success && !RSpec.world.non_example_failure ? 0 : RSpec.configuration.failure_exit_code
-    end
+      def quit
+        ::RSpec.world.wants_to_quit = true
+      end
+
+      def persist_example_statuses
+        return if ::RSpec.configuration.dry_run
+        return unless (path = ::RSpec.configuration.example_status_persistence_file_path)
 
-    def quit
-      RSpec.world.wants_to_quit = true
+        ::RSpec::Core::ExampleStatusPersister.persist(::RSpec.world.all_examples, path)
+      rescue SystemCallError => e
+        ::RSpec.configuration.error_stream.puts "warning: failed to write results to #{path}"
+      end
     end
   end
 end

data/lib/rspec-interactive/version.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
-module RSpecInteractive
-  VERSION = "0.1.0"
+module RSpec
+  module Interactive
+    VERSION = "0.5.0"
+  end
 end

data/rspec-interactive.gemspec

@@ -4,7 +4,7 @@ require_relative "lib/rspec-interactive/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "rspec-interactive"
-  spec.version       = RSpecInteractive::VERSION
+  spec.version       = RSpec::Interactive::VERSION
   spec.authors       = ["Nick Dower"]
   spec.email         = ["nicholasdower@gmail.com"]
 
@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/nicholasdower/rspec-interactive"
-  spec.metadata["changelog_uri"] = "https://github.com/nicholasdower/rspec-interactive"
+  spec.metadata["changelog_uri"] = "https://github.com/nicholasdower/rspec-interactive/releases"
 
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
@@ -25,5 +25,7 @@ Gem::Specification.new do |spec|
   spec.executables   << 'rspec-interactive'
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "listen"
+  spec.add_dependency 'rspec-core'
+  spec.add_dependency 'listen'
+  spec.add_dependency 'pry'
 end

data/run-with-local-dep.sh

@@ -0,0 +1,36 @@
+#!/usr/bin/env bash
+
+# Used to quickly test a development version of a gem in the current
+# directory. Adds a local copy of the specified gem, at the specified
+# path, to the current directory's Gemfile and executes the specified
+# command. Upon completion, the Gemfile will be returned to its
+# previous state.
+
+if [ $# -ne 3 ]; then
+  echo "usage: $0 <gem-name> <path> <command>" >&2
+  exit 1
+fi
+
+GEM_NAME=$1
+GEM_PATH=$2
+COMMAND=$3
+
+if [ -d $GEM_NAME ]; then
+  echo "directory exists: $GEM_NAME" >&2
+  exit 1
+fi
+
+OLD_DEP=$(grep "'$GEM_NAME'" Gemfile)
+if [ $? -ne 0 ]; then
+  echo "$GEM_NAME not found in Gemfile" >&2
+  exit 1
+fi
+
+cp Gemfile Gemfile.save
+cp Gemfile.lock Gemfile.lock.save
+cp -R $GEM_PATH $GEM_NAME
+sed -i '' -E "s/^( *gem '$GEM_NAME').*/\1, path: '$GEM_NAME'/g" Gemfile
+$COMMAND
+rm -rf $GEM_NAME
+mv Gemfile.lock.save Gemfile.lock
+mv Gemfile.save Gemfile

data/tests/debugged_spec_test.rb

@@ -0,0 +1,75 @@
+require_relative 'support/test_helper'
+
+Test.test "debugged spec" do
+  await_prompt
+  input "rspec examples/debugged_spec.rb"
+  await_prompt
+  input "exit"
+  await_prompt
+  input "exit"
+  await_termination
+  expect_output <<~EOF
+    [1] pry(main)> rspec examples/debugged_spec.rb
+
+    From: /Users/nickdower/Development/rspec-interactive/examples/debugged_spec.rb:6 :
+
+        1: require 'rspec/core'
+        2: require 'pry'
+        3: 
+        4: describe "example spec" do
+        5:   it "gets debugged" do
+     => 6:     binding.pry
+        7:     expect(true).to eq(true)
+        8:   end
+        9: end
+
+    [1] pry(#<RSpec::ExampleGroups::ExampleSpec>)> exit
+    .
+
+    Finished in 0 seconds (files took 0 seconds to load)
+    1 example, 0 failures
+
+    [2] pry(main)> exit
+  EOF
+end
+
+Test.test "debugger does not add to history" do
+  await_prompt
+  input "rspec examples/debugged_spec.rb"
+  await_prompt
+  input '"this should not show up in history"'
+  await_prompt
+  input "exit"
+  await_prompt
+  input "exit"
+  await_termination
+  expect_output <<~EOF
+    [1] pry(main)> rspec examples/debugged_spec.rb
+
+    From: /Users/nickdower/Development/rspec-interactive/examples/debugged_spec.rb:6 :
+
+        1: require 'rspec/core'
+        2: require 'pry'
+        3: 
+        4: describe "example spec" do
+        5:   it "gets debugged" do
+     => 6:     binding.pry
+        7:     expect(true).to eq(true)
+        8:   end
+        9: end
+
+    [1] pry(#<RSpec::ExampleGroups::ExampleSpec>)> "this should not show up in history"
+    => "this should not show up in history"
+    [2] pry(#<RSpec::ExampleGroups::ExampleSpec>)> exit
+    .
+
+    Finished in 0 seconds (files took 0 seconds to load)
+    1 example, 0 failures
+
+    [2] pry(main)> exit
+  EOF
+
+  expect_history <<~EOF
+    rspec examples/debugged_spec.rb
+  EOF
+end

data/tests/eof_test.rb

@@ -0,0 +1,10 @@
+require_relative 'support/test_helper'
+
+Test.test "exiting via ctrl-d" do
+  await_prompt
+  ctrl_d
+  await_termination
+  # No newlines in tests because we return false from tty? in test_helper.rb.
+  # In the real app, Pry will add a newline because tty? is true.
+  expect_output '[1] pry(main)> '
+end

data/tests/example_file_test.rb

@@ -0,0 +1,54 @@
+require_relative 'support/test_helper'
+
+RSpec.configuration.backtrace_exclusion_patterns = [ /.*/ ]
+RSpec.configuration.backtrace_inclusion_patterns = [ /examples\/failing_spec.rb/ ]
+
+examples = Tempfile.new('examples')
+
+config = Tempfile.new('config')
+config.write <<~EOF
+  RSpec.configuration.example_status_persistence_file_path = "#{examples.path}"
+EOF
+config.rewind
+
+Test.test "failing spec with example file", config_path: config.path do
+  await_prompt
+  input "rspec examples/failing_spec.rb"
+  await_prompt
+  input "exit"
+  await_termination
+  expect_output <<~EOF
+    [1] pry(main)> rspec examples/failing_spec.rb
+    F
+
+    Failures:
+
+      1) example spec fails
+         Failure/Error: expect(true).to eq(false)
+
+           expected: false
+                got: true
+
+           (compared using ==)
+
+           Diff:
+           @@ -1 +1 @@
+           -false
+           +true
+         # ./examples/failing_spec.rb:5:in `block (2 levels) in <top (required)>'
+
+    Finished in 0 seconds (files took 0 seconds to load)
+    1 example, 1 failure
+
+    Failed examples:
+
+    rspec ./examples/failing_spec.rb:4 # example spec fails
+
+    Rerun failures by executing the previous command with --only-failures or --next-failure.
+
+    [2] pry(main)> exit
+  EOF
+end
+
+config.close
+examples.close