rspec-interactive 0.2.0 → 0.6.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/rspec_command.rb

@@ -12,54 +12,11 @@ module RSpec::Interactive
     BANNER
 
     command_options(
-      :keep_retval => true
+      :keep_retval => false
     )
 
     def process
-      parsed_args = args.flat_map do |arg|
-        if arg.match(/[\*\?\[]/)
-          glob = Dir.glob(arg)
-          glob.empty? ? [arg] : glob
-        else
-          [arg]
-        end
-      end
-
-      RSpec::Interactive.mutex.synchronize do
-        RSpec::Interactive.updated_files.uniq.each do |filename|
-          load filename
-        end
-        RSpec::Interactive.updated_files.clear
-      end
-
-      RSpec::Interactive.runner = RSpec::Interactive::Runner.new(parsed_args)
-
-      # Stop saving history in case a new Pry session is started for debugging.
-      Pry.config.history_save = false
-
-      # Run.
-      result = RSpec::Interactive.runner.run
-      RSpec::Interactive.runner = nil
-
-      # Save results
-      RSpec::Interactive.results << result
-      RSpec::Interactive.result = result
-
-      # Reenable history
-      Pry.config.history_save = true
-
-      # Reset
-      RSpec.clear_examples
-      RSpec.reset
-      RSpec::Interactive.config_cache.replay_configuration
-
-      Object.define_method :results do RSpec::Interactive.results end
-      Object.define_method :result do RSpec::Interactive.result end
-
-      puts "Result available at `result`. Result history available at `results`."
-      puts
-
-      result
+      RSpec::Interactive.rspec(args)
     end
 
     Pry::Commands.add_command(::RSpec::Interactive::RSpecCommand)

data/lib/rspec-interactive/runner.rb

@@ -2,75 +2,67 @@ require 'rspec/core'
 
 module RSpec
   module Interactive
-    class ExampleGroupResult
-      attr_accessor :group, :success
-
-      def initialize(group, success)
-        @group = group
-        @success = success
-      end
-    end
-
-    class Result
-      attr_accessor :groups, :success, :exit_code
-
-      def initialize(groups, success, exit_code)
-        @groups = groups
-        @success = success
-        @exit_code = exit_code
-      end
-
-      def inspect(original = false)
-        original ? super() : "<RSpec::Interactive::Result @success=#{@success}, @groups=[...]>"
-      end
-    end
-
     class Runner
       def initialize(args)
-        RSpec.world.wants_to_quit = false
-        @options = RSpec::Core::ConfigurationOptions.new(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
+          @options.configure(::RSpec.configuration)
+          return if ::RSpec.world.wants_to_quit
 
-          RSpec.configuration.load_spec_files
+          ::RSpec.configuration.load_spec_files
         ensure
-          RSpec.world.announce_filters
+          ::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)
 
-        result = 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
+        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
 
-            results = example_groups.map do |example_group|
-              group_success = example_group.run(reporter)
-              ExampleGroupResult.new(example_group, group_success)
+            group_results = example_groups.map do |example_group|
+              example_group.run(reporter)
             end
 
-            success = results.all?(&:success)
+            success = group_results.all?
             exit_code = success ? 0 : 1
-            if RSpec.world.non_example_failure
+            if ::RSpec.world.non_example_failure
               success = false
-              exit_code = RSpec.configuration.failure_exit_code
+              exit_code = ::RSpec.configuration.failure_exit_code
             end
-            Result.new(results, success, exit_code)
+            persist_example_statuses
+            exit_code
           end
         end
-        result
+
+        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
 
       def quit
-        RSpec.world.wants_to_quit = true
+        ::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)
+
+        ::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

data/lib/rspec-interactive/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module Interactive
-    VERSION = "0.2.0"
+    VERSION = "0.6.0"
   end
 end

data/rspec-interactive.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.executables   << 'rspec-interactive'
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'rspec-core', '~> 3.9.2', '>= 3.9.2'
-  spec.add_dependency 'listen', '~> 3.5', '>= 3.5.1'
-  spec.add_dependency 'pry', '~> 0.14.1'
+  spec.add_dependency 'rspec-core'
+  spec.add_dependency 'listen'
+  spec.add_dependency 'pry'
 end

data/scripts/release.sh

@@ -0,0 +1,25 @@
+#!/bin/bash
+
+set -e
+
+if [ $# -ne 1 ]; then
+  echo "usage: $0 <version>" >&2
+  exit 1
+fi
+
+if [ -n "$(git status --porcelain)" ]; then
+  echo "error: stage or commit your changes." >&2
+  exit 1;
+fi
+
+NEW_VERSION=$1
+CURRENT_VERSION=$(grep VERSION lib/rspec-interactive/version.rb | cut -d'"' -f 2)
+
+echo "Updating from v$CURRENT_VERSION to v$NEW_VERSION. Press enter to continue."
+read
+
+sed -E -i '' "s/VERSION = \"[^\"]+\"/VERSION = \"$NEW_VERSION\"/g" lib/rspec-interactive/version.rb
+gem build
+gem push rspec-interactive-$NEW_VERSION.gem
+bundle install
+git commit -a -m "v$NEW_VERSION Release"

data/scripts/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

data/tests/failing_spec_test.rb

@@ -0,0 +1,41 @@
+require_relative 'support/test_helper'
+
+RSpec.configuration.backtrace_exclusion_patterns = [ /.*/ ]
+RSpec.configuration.backtrace_inclusion_patterns = [ /examples\/failing_spec.rb/ ]
+
+Test.test "failing spec" 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
+
+    [2] pry(main)> exit
+  EOF
+end