rspec-interactive 0.2.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6034dc7e5c24528799a1fd53510f0eba5f0d2d599b9e9736371a8ee210319d68
-  data.tar.gz: 343e1fcaa3d42dbcfbb5b12dbfb8b6c33e7c44e80a2bfafdf22b9934ba63e986
+  metadata.gz: 065d25cbce32ef3f5639e793c9f5db6d99c31a0c536d717ee49f05457251e4f3
+  data.tar.gz: 8d981a7cf504ec21bb9f0fdd12606ee78e53d6461909b1d0f4ceb06084c616b6
 SHA512:
-  metadata.gz: 5af0bad059e46cd7933b3d83f48e2ebac13f6005817e5f7aee96ab3c27a153d89b136ba305881a76fd883c70b5f157534327c74608da4eeb28ed1158259f49c3
-  data.tar.gz: c2059760cf7053a80f3465f937bd8a69bff7e49740617c82f2663abe474454d7fee8317996b6ed07ea63618ab2b972b79527fab7bfa9f40e191825e3d79481e8
+  metadata.gz: f5fd3e74737908f45f9eef622e977a71c8adfac52fb1141548f1e3960ee9839a234a1d4afc60ee0859cdeca6eb23e57a60ab9e77d4ed5475ea1f2e6429f74e5a
+  data.tar.gz: 734f4c31df3dde4da275c7680364348a549997496abdcd8acaab8ab755fd922de1993b154d94e3646e8e723bc6057ad1766b5add826ac45e5307d25b440b3665

data/Gemfile.lock

@@ -1,17 +1,17 @@
 PATH
   remote: .
   specs:
-    rspec-interactive (0.1.0)
-      listen (~> 3.5, >= 3.5.1)
-      pry (~> 0.14.1)
-      rspec-core (~> 3.10, >= 3.10.1)
+    rspec-interactive (0.5.0)
+      listen
+      pry
+      rspec-core
 
 GEM
   remote: https://rubygems.org/
   specs:
     coderay (1.1.3)
     diff-lcs (1.4.4)
-    ffi (1.15.0)
+    ffi (1.15.3)
     listen (3.5.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
@@ -22,12 +22,12 @@ GEM
     rb-fsevent (0.11.0)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.4)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.4)
 
 PLATFORMS
   x86_64-darwin-20

data/README.md

@@ -1,7 +1,5 @@
 # RSpec Interactive
 
-**WARNING: New (or maybe old by now), experimental, untested and poorly documented. Use at your own risk.**
-
 An Pry console capable of running specs.
 
 ## Installation & Configuration
@@ -12,23 +10,23 @@ Install:
 gem 'rspec-interactive'
 ```
 
-Add a config file named `.rspec_interactive_config`:
-
-```json
-{
- "configs": [
-   {
-     "name": "spec",
-     "watch_dirs": ["app"],
-     "init_script": "spec/spec_helper.rb"
-   },
-   {
-     "name": "spec_integration",
-     "watch_dirs": ["app"],
-     "init_script": "spec_integration/integration_helper.rb"
-   }
- ]
-}
+Add a config file which configures RSpec and RSpec::Interactive, for example `spec/rspec_interactive.rb`:
+
+```ruby
+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.
+  config.configure_rspec do
+    require './spec/spec_helper.rb'
+  end
+
+  # Invoked whenever a class is loaded due to a file change in one of the watch_dirs.
+  config.on_class_load do |clazz|
+    clazz.clear_validators! if clazz < ApplicationRecord
+  end
+end
 ```
 
 Update `.gitignore`
@@ -39,10 +37,10 @@ echo '.rspec_interactive_history' >> .gitignore
 
 ## 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 name]
+bundle exec rspec-interactive [--config <config-file>] [--initial-rspec-args <initial-rspec-args>]
 ```
 
 ## Example Usage In This Repo
@@ -53,16 +51,16 @@ Start:
 bundle exec rspec-interactive
 ```
 
-Run a passing spec:
+Start with an initial RSpec invocation:
 
 ```shell
-[1] pry(main)> rspec examples/passing_spec.rb
+bundle exec rspec-interactive --initial-rspec-args examples/passing_spec.rb
 ```
 
-Inspect the result:
+Run a passing spec:
 
 ```shell
-[2] pry(main)> result
+[1] pry(main)> rspec examples/passing_spec.rb
 ```
 
 Run a failing spec:
@@ -71,12 +69,6 @@ Run a failing spec:
 [3] pry(main)> rspec examples/failing_spec.rb
 ```
 
-Inspect result history:
-
-```shell
-[4] pry(main)> results
-```
-
 Run an example group:
 
 ```shell
@@ -106,3 +98,15 @@ Exit:
 ```shell
 [9] pry(main)> exit
 ```
+
+## Running Tests
+
+```shell
+bundle exec bin/test
+```
+
+## Releasing
+
+```shell
+./scripts/release.sh <version>
+```

data/bin/rspec-interactive

@@ -1,5 +1,21 @@
 #!/usr/bin/env ruby
 
+require 'optparse'
 require 'rspec-interactive'
+require 'shellwords'
 
-RSpec::Interactive.start(ARGV)
+@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] = Shellwords.split(initial_rspec_args)
+  end
+end.parse!
+
+RSpec::Interactive.start(config_file: @options[:config_file], initial_rspec_args: @options[:initial_rspec_args])

data/bin/test

@@ -0,0 +1,2 @@
+#!/usr/bin/env ruby
+Dir["tests/*.rb"].each {|file| load file }

data/examples/failing_spec.rb

@@ -4,8 +4,4 @@ describe "example spec" do
   it "fails" do
     expect(true).to eq(false)
   end
-
-  it "fails again" do
-    expect(true).to eq(false)
-  end
 end

data/examples/other_passing_spec.rb

@@ -0,0 +1,11 @@
+require 'rspec/core'
+
+describe "other example spec" do
+  it "succeeds" do
+    expect(true).to eq(true)
+  end
+
+  it "succeeds again" do
+    expect(true).to eq(true)
+  end
+end

data/examples/spec_with_syntax_error.rb

@@ -0,0 +1,5 @@
+require 'rspec/core'
+
+describe "spec with syntax error" do
+  it "succeeds
+end

data/lib/rspec-interactive.rb

@@ -1,106 +1,69 @@
-#!/usr/bin/env ruby
-
 require 'json'
 require 'listen'
+require 'pry'
 require 'readline'
 require 'rspec/core'
-require 'pry'
 
 require 'rspec-interactive/runner'
-require 'rspec-interactive/config_cache'
+require 'rspec-interactive/config'
+require 'rspec-interactive/rspec_config_cache'
 require 'rspec-interactive/input_completer'
 require 'rspec-interactive/rspec_command'
 
 module RSpec
   module Interactive
 
-    HISTORY_FILE = '.rspec_interactive_history'.freeze
-    CONFIG_FILE = '.rspec_interactive_config'.freeze
+    DEFAULT_HISTORY_FILE = '.rspec_interactive_history'.freeze
 
-    class <<self
-      attr_accessor :config, :stty_save, :mutex, :config_cache, :runner, :results, :result, :updated_files
+    class << self
+      attr_accessor :configuration
     end
 
-    def self.start(args)
-      if args.size > 1
-        STDERR.puts "expected 0 or 1 argument, got: #{args.join(', ')}"
-        exit!(1)
-      end
+    def self.configure(&block)
+      block.call(@configuration)
+    end
 
+    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 = []
-      @results = []
-      @config = get_config(args[0])
       @stty_save = %x`stty -g`.chomp
       @mutex = Mutex.new
+      @output_stream = output_stream
+      @input_stream = input_stream
+      @error_stream = error_stream
       @config_cache = RSpec::Interactive::ConfigCache.new
 
-      load_rspec_config
+      @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
 
+      if initial_rspec_args
+        rspec initial_rspec_args
+      end
+
       Pry.start
+      @listener.stop if @listener
+      0
     end
 
     def self.check_rails
       if defined?(::Rails)
         if ::Rails.application.config.cache_classes
-          STDERR.puts "warning: Rails.application.config.cache_classes enabled. Disable to ensure code is reloaded."
+          @error_stream.puts "warning: Rails.application.config.cache_classes enabled. Disable to ensure code is reloaded."
         end
       end
     end
 
-    def self.load_rspec_config
-      @config_cache.record_configuration(&rspec_configuration)
-    end
-
-    def self.rspec_configuration
-      proc do
-        if @config["init_script"]
-          $LOAD_PATH << '.'
-          require @config["init_script"]
-        end
-      end
-    end
-
-    def self.get_config(name = nil)
-      unless File.exists? CONFIG_FILE
-        STDERR.puts "warning: #{CONFIG_FILE} not found, using default config"
-        return {}
-      end
-
-      configs = JSON.parse(File.read(CONFIG_FILE))["configs"] || []
-      if configs.empty?
-        STDERR.puts "no configs found in: #{CONFIG_FILE}"
-        exit!(1)
-      end
-
-      # If a specific config was specified, use it.
-      if name
-        config = configs.find { |e| e["name"] == name }
-        return config if config
-        STDERR.puts "invalid config: #{name}"
-        exit!(1)
-      end
-
-      # If there is only one, use it.
-      if configs.size == 1
-        return configs[0]
-      end
-
-      # Ask the user which to use.
-      loop do
-        names = configs.map { |e| e["name"] }
-        names[0] = "#{names[0]} (default)"
-        print "Multiple simultaneous configs not yet supported. Please choose a config. #{names.join(', ')}: "
-        answer = STDIN.gets.chomp
-        if answer.strip.empty?
-          return configs[0]
-        end
-        config = configs.find { |e| e["name"] == answer }
-        return config if config
-        STDERR.puts "invalid config: #{answer}"
+    def self.configure_rspec
+      RSpec.configure do |config|
+       config.error_stream = @error_stream
+       config.output_stream = @output_stream
       end
     end
 
@@ -110,7 +73,7 @@ module RSpec
           # We are on a different thread. There is a race here. Ignore nil.
           @runner&.quit
         else
-          puts
+          @output_stream.puts
           system "stty", @stty_save
           exit!(0)
         end
@@ -118,28 +81,76 @@ module RSpec
     end
 
     def self.start_file_watcher
-      return unless @config["watch_dirs"]
+      return if @configuration.watch_dirs.empty?
 
       # Only polling seems to work in Docker.
-      listener = Listen.to(*@config["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, removed|
         @mutex.synchronize do
           @updated_files.concat(added + modified)
         end
       end
-      listener.start
+      @listener.start
     end
 
     def self.configure_pry
       # Prevent Pry from trapping too. It will break ctrl-c handling.
       Pry.config.should_trap_interrupts = false
 
-      # Set Pry to use Readline. This is the default anyway.
+      # Set up IO.
       Pry.config.input = Readline
+      Pry.config.output = @output_stream
+      Readline.output = @output_stream
+      Readline.input = @input_stream
 
       # Use custom completer to get file completion.
       Pry.config.completer = RSpec::Interactive::InputCompleter
 
-      Pry.config.history_file = HISTORY_FILE
+      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
+
+      @mutex.synchronize do
+        @updated_files.uniq.each do |filename|
+          @output_stream.puts "modified: #{filename}"
+          trace = TracePoint.new(:class) do |tp|
+            @configuration.on_class_load.call(tp.self)
+          end
+          trace.enable
+          load filename
+          trace.disable
+          @output_stream.puts
+        end
+        @updated_files.clear
+      end
+
+      @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
+
+      # RSpec::Interactive-specific RSpec configuration
+      configure_rspec
+
+      # Run.
+      exit_code = @runner.run
+      @runner = nil
+
+      # Reenable history
+      Pry.config.history_save = true
+
+      # Reset
+      RSpec.clear_examples
+      RSpec.reset
+      @config_cache.replay_configuration
     end
   end
 end