rspec-interactive 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1f9390c00756ace39f74e3af9d78410cf2890000285035537c2ec6ce6b9e861
-  data.tar.gz: 8d07aec8a3fb5bc78849dbf403a3d30aeb1fec9bdbb38cef2204672e84ba3e9d
+  metadata.gz: ad5fba3e662512b5cce97181a4495493a2a4c04a302e616a02a8b8ab71361cd8
+  data.tar.gz: 28d14de9e9e05607adc35f5a03823cb11f9f93f87252316e3c6ee16d2655d9ff
 SHA512:
-  metadata.gz: 8f585f27c12cc58f2ccb1f8a9d1baf5c05139b58244cba1daf0228c7a9ff8bff71bc0ad79bc0d87ae27ac7580138cb3607ae51c84f3a11d2443fe03f8eaff183
-  data.tar.gz: d8bd001d9bd1be1b3cfa21ec69bcd70b9cb55f3d684bcc336f71e458aa20483a30ced6977c40e4055e9871698246e6e494f805a3fd210a3ec0310dfe72ef25e4
+  metadata.gz: 00f3ddf1f4e82d8a2590bb6b899ddacd470a7473c1aa32038b82cadd0ac664be5b8b86d96b13160cd8182f18d9a25843b948d694fa98cf6363fc49632c05b9b2
+  data.tar.gz: 8368023eb258fcd9df41b7497ca16112733f7a9513dc7a0830967652d52c5faec4ad61d613c9b9d5141945a0312db6a53a7981564cc76532befe512d0e4a3dbf

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.6.1)
+    rspec-interactive (0.7.0)
       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
 
@@ -17,7 +17,7 @@ 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
@@ -26,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
 ```
 
@@ -35,6 +42,27 @@ 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
+```
+
+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.
+
 ## Usage
 
 Optionally, specify a config file with `--config <config-file>`. Optionally, specify arguments to an initial RSpec invocation with `--initial-rspec-args <initial-rspec-args>`.
@@ -80,7 +108,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

data/lib/rspec-interactive.rb

@@ -9,6 +9,7 @@ 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
@@ -38,12 +39,12 @@ module RSpec
       load config_file if config_file
 
       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
@@ -88,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
@@ -112,24 +113,10 @@ module RSpec
       Pry.config.history_file = @history_file
     end
 
-    def self.rspec(args)
-      if @init_thread&.alive?
-        @init_thread.join
-        @init_thread = nil
-      end
-
-      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
@@ -140,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
 

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.7.0"
+    VERSION = "0.7.1"
   end
 end

data/scripts/release.sh

@@ -23,3 +23,4 @@ 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)"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-interactive
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Nick Dower
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-23 00:00:00.000000000 Z
+date: 2021-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core
@@ -78,6 +78,7 @@ 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