rspec-interactive 0.6.1 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 858197f05a88cbac9b4acf36c6220a79c15bc008945fa87cef7c008e20ca172d
-  data.tar.gz: b9a34852edc5bc544e9117ebfef1c6190e7ecae73cb7a29e2929f82743e72ed5
+  metadata.gz: 255c2aca56cb003fad2c6e7e5f72cb75b2ed82f1820edb42294ded182dbdd25c
+  data.tar.gz: afb9f469028aa3a4388585e6d34e281ce1bae8fe7227e73ba0939f2cf3585255
 SHA512:
-  metadata.gz: ec6835e7baeb24d4126edb542629529e308ab9ecd79a28697c03f8290a8c6b5d15bbe6fd645338e870df124a073638c45bab0f790f8bb09becfd4a613d995cc0
-  data.tar.gz: cbf961a6c0a60cfc3cced32778f34ebbf7ae3e97399c017148cbe88e1229f5d96b2ab6f374ad4bc68e6eaaf9e7f18013e5510cab76521f4d70c0e90cb485b126
+  metadata.gz: abae1515ca7dade3476088e21fef619f1cdda2b3b126f0a19db30b0aabd2f7250bee9874f11cccf5a836d39dd45d7b6a5848003a32637bf2eb925c4d229622dc
+  data.tar.gz: 90c4118df931f6e30c3af286f8fb9a1a382bd30dfcd3d052480943fa4f305975784c87e51fddba17de4343ef0748169c07831dc52e7f31190efefef516216efa

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.0)
+    rspec-interactive (0.8.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,31 @@ 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
 
 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 +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

data/lib/rspec-interactive.rb

@@ -9,7 +9,9 @@ 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'
+require 'rspec-interactive/rubo_cop_command'
 
 module RSpec
   module Interactive
@@ -37,13 +39,15 @@ 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)
@@ -86,7 +90,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
@@ -110,19 +114,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
@@ -133,9 +128,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
 
@@ -153,6 +169,21 @@ module RSpec
       RSpec.clear_examples
       RSpec.reset
       @config_cache.replay_configuration
+    ensure
+      @runner = nil
+    end
+
+    def self.rubo_cop(args)
+      if @init_thread&.alive?
+        @init_thread.join
+        @init_thread = nil
+      end
+
+      if defined?(RuboCop)
+        RuboCop::CLI.new.run args
+      else
+        @error_stream.puts "fatal: RuboCop not found. Is the gem installed in this project?"
+      end
     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/input_completer.rb

@@ -1,23 +1,27 @@
 module RSpec::Interactive
   class InputCompleter < Pry::InputCompleter
 
-    def rspec_completions(string)
+    def cli_completions(command, 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 +/)
+      if line.match(/^ *#{command} +/)
         Dir[string + '*'].map { |filename| File.directory?(filename) ? "#{filename}/" : filename }
-      elsif before_current.strip.empty? && "rspec".match(/^#{Regexp.escape(string)}/)
-        ["rspec "]
+      elsif before_current.strip.empty? && command.match(/^#{Regexp.escape(string)}/)
+        ["#{command} "]
       else
         nil
       end
     end
 
     def call(str, options = {})
-      rspec_completions = rspec_completions(str)
+      rspec_completions = cli_completions('rspec', str)
       return rspec_completions if rspec_completions
+
+      rubocop_completions = cli_completions('rubocop', str)
+      return rubocop_completions if rubocop_completions
+
       super
     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/rubo_cop_command.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RSpec::Interactive
+  class RuboCopCommand < Pry::ClassCommand
+    match 'rubocop'
+    description "Invoke RuboCop."
+
+    banner <<-BANNER
+      Usage: rubocop [arguments]
+
+      See https://docs.rubocop.org/rubocop/usage/basic_usage.html
+    BANNER
+
+    command_options(
+      :keep_retval => false
+    )
+
+    def process
+      RSpec::Interactive.rubo_cop(args)
+    end
+
+    Pry::Commands.add_command(::RSpec::Interactive::RuboCopCommand)
+  end
+end

data/lib/rspec-interactive/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module Interactive
-    VERSION = "0.6.1"
+    VERSION = "0.8.1"
   end
 end

data/scripts/release.sh

@@ -15,6 +15,8 @@ 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
 
@@ -23,3 +25,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)"

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.6.1
+  version: 0.8.1
 platform: ruby
 authors:
 - Nick Dower
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-20 00:00:00.000000000 Z
+date: 2021-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core
@@ -78,8 +78,10 @@ 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/rubo_cop_command.rb
 - lib/rspec-interactive/runner.rb
 - lib/rspec-interactive/version.rb
 - rspec-interactive.gemspec