rspec-interactive 0.5.0 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88fe45587c743f490177b20ef35c1a6372c56b22e631ca8d5bf24fb5836448bc
-  data.tar.gz: 23bd0531b2836fb9d3d6d86a462fe65b4f9ddde3b2671db608f1b76fbaf7989b
+  metadata.gz: 4e56b91e4f1d28feae7da156d8e4f3ddec5aeffe5847f0ecf6c28150f9f2ac1d
+  data.tar.gz: 9b88b87a123b207b1478413b0e963bee0a25255163977cd2982cd8d9a0d21742
 SHA512:
-  metadata.gz: a066316a818ebaf46096e655d5e20c87280ae47863aeae564e275b066647b004afad528e40e0cc4dbe56935f6bd3c9275541302893b2fbd77c2eb01c84cdbf9c
-  data.tar.gz: 45d608d8bf7524a575bf833be24bcd13ec3ea6d2612da9ef40d7da5f9366fb43474eb078ab56c88f61c45d67143515a140d9d8de094e418906895cb277393386
+  metadata.gz: a5acd4df05e27db03f66f66f96f9cc43692485abbfe04ee5e680589689c274bde396f07c893b2138cea6db745a4fcc2b9a127caaf7a8c0ccb7c5a2acedd60b6e
+  data.tar.gz: 534a6ba41f06820271a60a5844fc72e19bb92730067bda01d84ad791fd5c99ce35b4f94b60badb862a7f5de183dbc5a799bfb8280f07162660e99a1b186d74d1

data/Gemfile

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+ruby '3.0.0'
+
 source "https://rubygems.org"
 
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rspec-interactive (0.5.0)
+    rspec-interactive (0.7.1)
       listen
       pry
       rspec-core
@@ -36,5 +36,8 @@ DEPENDENCIES
   rspec-expectations
   rspec-interactive!
 
+RUBY VERSION
+   ruby 3.0.0p0
+
 BUNDLED WITH
    2.2.17

data/README.md

@@ -1,6 +1,6 @@
 # RSpec Interactive
 
-An Pry console capable of running specs.
+A Pry console capable of running specs.
 
 ## Installation & Configuration
 
@@ -13,13 +13,11 @@ gem 'rspec-interactive'
 Add a config file which configures RSpec and RSpec::Interactive, for example `spec/rspec_interactive.rb`:
 
 ```ruby
-load 'spec/spec_helper.rb'
-
 RSpec::Interactive.configure do |config|
   # Directories to watch for file changes. When a file changes, it will be reloaded like `load 'path/to/file'`.
   config.watch_dirs += ["app", "lib", "config"]
 
-  # This block is invoked on startup. RSpec configuration must happen here so that it can be reloaded before each test run.
+  # This block is invoked on startup. RSpec configuration must happen here so that it can be cached and reloaded before each test run.
   config.configure_rspec do
     require './spec/spec_helper.rb'
   end
@@ -28,6 +26,13 @@ RSpec::Interactive.configure do |config|
   config.on_class_load do |clazz|
     clazz.clear_validators! if clazz < ApplicationRecord
   end
+
+  # Invoked before each invocation of RSpec. Can also be manually invoked by typing `refresh` in the console.
+  # Any modified/added files will be loaded via `load` before invoking.
+  config.refresh do
+    FactoryBot.reload
+    Rails.application.reloader.reload!
+  end
 end
 ```
 
@@ -37,12 +42,37 @@ Update `.gitignore`
 echo '.rspec_interactive_history' >> .gitignore
 ```
 
+### A Note About FactoryBot
+
+It is not possible to reload a file containing FactoryBot factory definitions via `load` because FactoryBot does not allow factories to be redefined. Be carefule not to add any directories to `watch_dirs` which contain factory definitions. Instead, you should configure the location of your factories like the following in your `spec_helper.rb`:
+
+```ruby
+FactoryBot.definition_file_paths = %w(spec/factories)
+FactoryBot.find_definitions # Only if not using Rails
+```
+
+Then add the following to your RSpec Interactive config
+
+```ruby
+RSpec::Interactive.configure do |config|
+  config.refresh do
+    FactoryBot.reload
+  end
+end
+```
+
+This will cause factories to be reloaded before each test run and also whenever the `refresh` command is invoked in the console.
+
+See: https://github.com/thoughtbot/factory_bot/blob/master/GETTING_STARTED.md#configure-your-test-suite
+
+See: https://github.com/thoughtbot/factory_bot/blob/master/GETTING_STARTED.md#rails-preloaders-and-rspec
+
 ## Usage
 
-See more examples below.
+Optionally, specify a config file with `--config <config-file>`. Optionally, specify arguments to an initial RSpec invocation with `--initial-rspec-args <initial-rspec-args>`.
 
 ```shell
-bundle exec rspec-interactive spec/rspec_interactive.rb
+bundle exec rspec-interactive [--config <config-file>] [--initial-rspec-args <initial-rspec-args>]
 ```
 
 ## Example Usage In This Repo
@@ -53,6 +83,12 @@ Start:
 bundle exec rspec-interactive
 ```
 
+Start with an initial RSpec invocation:
+
+```shell
+bundle exec rspec-interactive --initial-rspec-args examples/passing_spec.rb
+```
+
 Run a passing spec:
 
 ```shell
@@ -76,7 +112,6 @@ Run multiple specs:
 ```shell
 [6] pry(main)> rspec examples/passing_spec.rb examples/failing_spec.rb
 ```
-
 Debug a spec (use `exit` to resume while debugging):
 
 ```shell
@@ -100,3 +135,9 @@ Exit:
 ```shell
 bundle exec bin/test
 ```
+
+## Releasing
+
+```shell
+./scripts/release.sh <version>
+```

data/bin/rspec-interactive

@@ -1,14 +1,20 @@
 #!/usr/bin/env ruby
 
+require 'optparse'
 require 'rspec-interactive'
 
-if ARGV.size == 0
-  RSpec::Interactive.start
-elsif ARGV.size == 1
-  RSpec::Interactive.start(config_file: ARGV[0])
-else
-  STDERR.puts "expected 0 or 1 argument, got: #{args.join(', ')}"
-  STDERR.puts ''
-  STDOUT.puts 'usage: rspec-interactive [config-file]'
-  exit 1
-end
+@options = {}
+parser = OptionParser.new do |opts|
+  opts.banner = "Starts an interactive RSpec shell.\n\n"\
+    "Usage: bundle exec rspec-interactive [-c config-file] <initial-rspec-args>"
+
+  opts.on("-c", "--config <config-file>", String, "Optional. Path to the RSpec Interactive config file.") do |config_file|
+    @options[:config_file] = config_file
+  end
+
+  opts.on("-r", "--initial-rspec-args <initial-rspec-args>", String, "Optional. Arguments to pass to an initial invocation of RSpec.") do |initial_rspec_args|
+    @options[:initial_rspec_args] = initial_rspec_args
+  end
+end.parse!
+
+RSpec::Interactive.start(config_file: @options[:config_file], initial_rspec_args: @options[:initial_rspec_args])

data/lib/rspec-interactive.rb

@@ -3,11 +3,13 @@ require 'listen'
 require 'pry'
 require 'readline'
 require 'rspec/core'
+require 'shellwords'
 
 require 'rspec-interactive/runner'
 require 'rspec-interactive/config'
 require 'rspec-interactive/rspec_config_cache'
 require 'rspec-interactive/input_completer'
+require 'rspec-interactive/refresh_command'
 require 'rspec-interactive/rspec_command'
 
 module RSpec
@@ -23,7 +25,7 @@ module RSpec
       block.call(@configuration)
     end
 
-    def self.start(config_file: nil, history_file: DEFAULT_HISTORY_FILE, input_stream: STDIN, output_stream: STDOUT, error_stream: STDERR)
+    def self.start(config_file: nil, initial_rspec_args: nil, history_file: DEFAULT_HISTORY_FILE, input_stream: STDIN, output_stream: STDOUT, error_stream: STDERR)
       @history_file = history_file
       @updated_files = []
       @stty_save = %x`stty -g`.chomp
@@ -36,13 +38,20 @@ module RSpec
       @configuration = Configuration.new
       load config_file if config_file
 
-      @config_cache.record_configuration { @configuration.configure_rspec.call }
-
       check_rails
-      start_file_watcher
       trap_interrupt
       configure_pry
 
+      @init_thread = Thread.start {
+        @config_cache.record_configuration { @configuration.configure_rspec.call }
+        start_file_watcher
+      }
+
+      if initial_rspec_args
+        open(@history_file, 'a') { |f| f.puts "rspec #{initial_rspec_args.strip}" }
+        rspec Shellwords.split(initial_rspec_args)
+      end
+
       Pry.start
       @listener.stop if @listener
       0
@@ -80,7 +89,7 @@ module RSpec
       return if @configuration.watch_dirs.empty?
 
       # Only polling seems to work in Docker.
-      @listener = Listen.to(*@configuration.watch_dirs, only: /\.rb$/, force_polling: true) do |modified, added, removed|
+      @listener = Listen.to(*@configuration.watch_dirs, only: /\.rb$/, force_polling: true) do |modified, added|
         @mutex.synchronize do
           @updated_files.concat(added + modified)
         end
@@ -104,19 +113,10 @@ module RSpec
       Pry.config.history_file = @history_file
     end
 
-    def self.rspec(args)
-      parsed_args = args.flat_map do |arg|
-        if arg.match(/[\*\?\[]/)
-          glob = Dir.glob(arg)
-          glob.empty? ? [arg] : glob
-        else
-          [arg]
-        end
-      end
-
+    def self.refresh
       @mutex.synchronize do
         @updated_files.uniq.each do |filename|
-          @output_stream.puts "modified: #{filename}"
+          @output_stream.puts "changed: #{filename}"
           trace = TracePoint.new(:class) do |tp|
             @configuration.on_class_load.call(tp.self)
           end
@@ -127,9 +127,30 @@ module RSpec
         end
         @updated_files.clear
       end
+      @configuration.refresh.call
+    end
 
+    def self.rspec(args)
+      parsed_args = args.flat_map do |arg|
+        if arg.match(/[\*\?\[]/)
+          glob = Dir.glob(arg)
+          glob.empty? ? [arg] : glob
+        else
+          [arg]
+        end
+      end
+
+      # Initialize the runner before waiting for the init thread so that the interrupt
+      # handler will cancel the RSpec invocation rather than kill the app.
       @runner = RSpec::Interactive::Runner.new(parsed_args)
 
+      if @init_thread&.alive?
+        @init_thread.join
+        @init_thread = nil
+      end
+
+      refresh
+
       # Stop saving history in case a new Pry session is started for debugging.
       Pry.config.history_save = false
 
@@ -147,6 +168,8 @@ module RSpec
       RSpec.clear_examples
       RSpec.reset
       @config_cache.replay_configuration
+    ensure
+      @runner = nil
     end
   end
 end

data/lib/rspec-interactive/config.rb

@@ -1,12 +1,13 @@
 module RSpec
   module Interactive
     class Configuration
-      attr_accessor :watch_dirs, :configure_rspec, :on_class_load
+      attr_accessor :watch_dirs, :configure_rspec, :on_class_load, :refresh
 
       def initialize
         @watch_dirs      = []
         @configure_rspec = proc {}
         @on_class_load   = proc {}
+        @refresh         = proc {}
       end
 
       def configure_rspec(&block)
@@ -18,6 +19,11 @@ module RSpec
         return @on_class_load unless block
         @on_class_load = block
       end
+
+      def refresh(&block)
+        return @refresh unless block
+        @refresh = block
+      end
     end
   end
 end

data/lib/rspec-interactive/refresh_command.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module RSpec::Interactive
+  class RefreshCommand < Pry::ClassCommand
+    match 'refresh'
+    description "Load any files in watched directories which have changed since the last refresh or rspec invocation."
+
+    banner <<-BANNER
+      Usage: refresh
+    BANNER
+
+    command_options(
+      :keep_retval => false
+    )
+
+    def process
+      RSpec::Interactive.refresh
+    end
+
+    Pry::Commands.add_command(::RSpec::Interactive::RefreshCommand)
+  end
+end

data/lib/rspec-interactive/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module Interactive
-    VERSION = "0.5.0"
+    VERSION = "0.7.2"
   end
 end

data/scripts/release.sh

@@ -0,0 +1,28 @@
+#!/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)
+
+bundle exec bin/test
+
+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"
+open "https://github.com/nicholasdower/rspec-interactive/releases/new?title=v$NEW_VERSION%20Release&tag=v$NEW_VERSION&target=$(git rev-parse HEAD)"

data/tests/example_file_test.rb

@@ -7,7 +7,11 @@ examples = Tempfile.new('examples')
 
 config = Tempfile.new('config')
 config.write <<~EOF
-  RSpec.configuration.example_status_persistence_file_path = "#{examples.path}"
+  RSpec::Interactive.configure do |config|
+    config.configure_rspec do
+      RSpec.configuration.example_status_persistence_file_path = "#{examples.path}"
+    end
+  end
 EOF
 config.rewind
 

data/tests/rerun_failed_specs_test.rb

@@ -4,11 +4,15 @@ examples = Tempfile.new('examples')
 
 config = Tempfile.new('config')
 config.write <<~EOF
-  RSpec.configuration.example_status_persistence_file_path = "#{examples.path}"
+  RSpec::Interactive.configure do |config|
+    config.configure_rspec do
+      RSpec.configuration.example_status_persistence_file_path = "#{examples.path}"
+    end
+  end
 EOF
 config.rewind
 
-Test.test "failing spec with example file", config_path: config.path do
+Test.test "rerun failing spec with example file", config_path: config.path do
   await_prompt
 
   RSpec.configuration.backtrace_exclusion_patterns = [ /.*/ ]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-interactive
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.2
 platform: ruby
 authors:
 - Nick Dower
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-20 00:00:00.000000000 Z
+date: 2021-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core
@@ -78,12 +78,14 @@ files:
 - lib/rspec-interactive.rb
 - lib/rspec-interactive/config.rb
 - lib/rspec-interactive/input_completer.rb
+- lib/rspec-interactive/refresh_command.rb
 - lib/rspec-interactive/rspec_command.rb
 - lib/rspec-interactive/rspec_config_cache.rb
 - lib/rspec-interactive/runner.rb
 - lib/rspec-interactive/version.rb
 - rspec-interactive.gemspec
-- run-with-local-dep.sh
+- scripts/release.sh
+- scripts/run-with-local-dep.sh
 - tests/debugged_spec_test.rb
 - tests/eof_test.rb
 - tests/example_file_test.rb