rspec-interactive 0.1.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cc41d7480a29852c93f700e92b70314e0b6e8fc70f73089ca419eae750f32bc
-  data.tar.gz: b7b3357dbf44d8dc21beef28a684950f148eac98aa40b4de53e2eb7faa9eb2e9
+  metadata.gz: 88fe45587c743f490177b20ef35c1a6372c56b22e631ca8d5bf24fb5836448bc
+  data.tar.gz: 23bd0531b2836fb9d3d6d86a462fe65b4f9ddde3b2671db608f1b76fbaf7989b
 SHA512:
-  metadata.gz: f6413fa767a8c4dd85e6f63129d35b9b341a264ae82183696d5c160f63cada92fe96b17972913246bea85b9fb5217b19d0bfd72c4dc1a0a3152a38861cb011de
-  data.tar.gz: 9a42fc226690f04ea027d5cf42403164cbd0cd7f3dae80a9eec4383ef1d3c5f36d40e4f9291432366f449e0651b19b91d1b54c88b6b455cd906b73ae2bad2c08
+  metadata.gz: a066316a818ebaf46096e655d5e20c87280ae47863aeae564e275b066647b004afad528e40e0cc4dbe56935f6bd3c9275541302893b2fbd77c2eb01c84cdbf9c
+  data.tar.gz: 45d608d8bf7524a575bf833be24bcd13ec3ea6d2612da9ef40d7da5f9366fb43474eb078ab56c88f61c45d67143515a140d9d8de094e418906895cb277393386

data/.gitignore

@@ -1 +1,3 @@
 rspec-interactive-*.gem
+.rspec_interactive_history
+.rspec_interactive_config

data/Gemfile

@@ -4,4 +4,6 @@ source "https://rubygems.org"
 
 gemspec
 
-gem 'rspec-core'
+group :test do
+  gem 'rspec-expectations'
+end

data/Gemfile.lock

@@ -1,29 +1,40 @@
 PATH
   remote: .
   specs:
-    rspec-console (0.1.0)
+    rspec-interactive (0.5.0)
       listen
+      pry
+      rspec-core
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ffi (1.15.0)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    ffi (1.15.3)
     listen (3.5.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
+    method_source (1.0.0)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     rb-fsevent (0.11.0)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
+    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.9.0)
+    rspec-support (3.9.4)
 
 PLATFORMS
   x86_64-darwin-20
 
 DEPENDENCIES
-  rspec-console!
-  rspec-core
+  rspec-expectations
+  rspec-interactive!
 
 BUNDLED WITH
    2.2.17

data/README.md

@@ -0,0 +1,102 @@
+# RSpec Interactive
+
+An Pry console capable of running specs.
+
+## Installation & Configuration
+
+Install:
+
+```ruby
+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.
+  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`
+
+```shell
+echo '.rspec_interactive_history' >> .gitignore
+```
+
+## Usage
+
+See more examples below.
+
+```shell
+bundle exec rspec-interactive spec/rspec_interactive.rb
+```
+
+## Example Usage In This Repo
+
+Start:
+
+```shell
+bundle exec rspec-interactive
+```
+
+Run a passing spec:
+
+```shell
+[1] pry(main)> rspec examples/passing_spec.rb
+```
+
+Run a failing spec:
+
+```shell
+[3] pry(main)> rspec examples/failing_spec.rb
+```
+
+Run an example group:
+
+```shell
+[5] pry(main)> rspec examples/passing_spec.rb:4
+```
+
+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
+[7] pry(main)> rspec examples/debugged_spec.rb
+```
+
+Run multiple specs using globbing (use `exit` to resume while debugging):
+
+```shell
+[8] pry(main)> rspec examples/*_spec.rb
+```
+
+Exit:
+
+```shell
+[9] pry(main)> exit
+```
+
+## Running Tests
+
+```shell
+bundle exec bin/test
+```

data/bin/console

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 require "bundler/setup"
-require "repo"
+require 'rspec-interactive'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/bin/rspec-interactive

@@ -1,5 +1,14 @@
 #!/usr/bin/env ruby
 
-require 'rspec-interactive.rb'
+require 'rspec-interactive'
 
-RSpecInteractive::Console.new(ARGV).start()
+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

data/bin/test

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

data/examples/debugged_spec.rb

@@ -0,0 +1,9 @@
+require 'rspec/core'
+require 'pry'
+
+describe "example spec" do
+  it "gets debugged" do
+    binding.pry
+    expect(true).to eq(true)
+  end
+end

data/examples/failing_spec.rb

@@ -0,0 +1,7 @@
+require 'rspec/core'
+
+describe "example spec" do
+  it "fails" 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/passing_spec.rb

@@ -0,0 +1,11 @@
+require 'rspec/core'
+
+describe "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,205 +1,152 @@
-#!/usr/bin/env ruby
-
 require 'json'
 require 'listen'
+require 'pry'
 require 'readline'
 require 'rspec/core'
-require 'shellwords'
-
-require_relative 'rspec-interactive/runner.rb'
 
-module RSpecInteractive
-  class Console
+require 'rspec-interactive/runner'
+require 'rspec-interactive/config'
+require 'rspec-interactive/rspec_config_cache'
+require 'rspec-interactive/input_completer'
+require 'rspec-interactive/rspec_command'
 
-    HISTORY_FILE = '.rspec_interactive_history'.freeze
-    CONFIG_FILE = '.rspec_interactive_config'.freeze
-    MAX_HISTORY_ITEMS = 100
-    COMMANDS = ['help', 'rspec']
+module RSpec
+  module Interactive
 
-    def initialize(args)
-      if args.size > 1
-        STDERR.puts "expected 0 or 1 argument, got: #{args.join(', ')}"
-        exit!(1)
-      end
+    DEFAULT_HISTORY_FILE = '.rspec_interactive_history'.freeze
 
-      @stty_save = %x`stty -g`.chomp
-      @mutex = Mutex.new
-      @runner = nil
-      load_config(args[0])
+    class << self
+      attr_accessor :configuration
     end
 
-    def start()
-      start_file_watcher
-      load_history
-      configure_auto_complete
-      trap_interrupt
-      start_console
+    def self.configure(&block)
+      block.call(@configuration)
     end
 
-    private
+    def self.start(config_file: 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
+      @mutex = Mutex.new
+      @output_stream = output_stream
+      @input_stream = input_stream
+      @error_stream = error_stream
+      @config_cache = RSpec::Interactive::ConfigCache.new
 
-    def load_config(name = nil)
-      @config = get_config(name)
-      load @config["init_script"]
-    end
+      @configuration = Configuration.new
+      load config_file if config_file
 
-    def get_config(name = nil)
-      if !File.exists? CONFIG_FILE
-        STDERR.puts "file not found: #{CONFIG_FILE}"
-        exit!(1)
-      end
+      @config_cache.record_configuration { @configuration.configure_rspec.call }
 
-      configs = JSON.parse(File.read(CONFIG_FILE))["configs"]
-      if configs.empty?
-        STDERR.puts "no configs found in: #{CONFIG_FILE}"
-        exit!(1)
-      end
+      check_rails
+      start_file_watcher
+      trap_interrupt
+      configure_pry
 
-      # 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
+      Pry.start
+      @listener.stop if @listener
+      0
+    end
 
-      # If there is only one, use it.
-      if configs.size == 1
-        return configs[0]
+    def self.check_rails
+      if defined?(::Rails)
+        if ::Rails.application.config.cache_classes
+          @error_stream.puts "warning: Rails.application.config.cache_classes enabled. Disable to ensure code is reloaded."
+        end
       end
+    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
 
-    def trap_interrupt
+    def self.trap_interrupt
       trap('INT') do
-        @mutex.synchronize do
-          if @runner
-            @runner.quit
-          else
-            puts
-            system "stty", @stty_save
-            exit!(0)
-          end
+        if @runner
+          # We are on a different thread. There is a race here. Ignore nil.
+          @runner&.quit
+        else
+          @output_stream.puts
+          system "stty", @stty_save
+          exit!(0)
         end
       end
     end
 
-    def start_file_watcher
-      # Only polling seems to work in Docker.
-      listener = Listen.to(*@config["watch_dirs"], only: /\.rb$/, force_polling: true) do |modified, added, removed|
-        (added + modified).each { |filename| load filename } 
-      end
-    end
+    def self.start_file_watcher
+      return if @configuration.watch_dirs.empty?
 
-    def load_history
-      if File.exists? HISTORY_FILE
-        lines = File.readlines(HISTORY_FILE)
-        lines.each do |line|
-          Readline::HISTORY << line.strip
+      # Only polling seems to work in Docker.
+      @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
     end
 
-    def configure_auto_complete
-      Readline.completion_append_character = ""
-    end
+    def self.configure_pry
+      # Prevent Pry from trapping too. It will break ctrl-c handling.
+      Pry.config.should_trap_interrupts = false
 
-    def start_console
-      loop do
-        buffer = Readline.readline('> ', true)&.strip
+      # Set up IO.
+      Pry.config.input = Readline
+      Pry.config.output = @output_stream
+      Readline.output = @output_stream
+      Readline.input = @input_stream
 
-        # Exit on ctrl-D.
-        if !buffer
-          puts
-          system "stty", @stty_save
-          exit!(0)
-        end
-
-        # Ignore blank lines.
-        if buffer.empty?
-          Readline::HISTORY.pop
-          next
-        end
+      # Use custom completer to get file completion.
+      Pry.config.completer = RSpec::Interactive::InputCompleter
 
-        # Write history to file.
-        if Readline::HISTORY.size > 0
-          file = File.open(HISTORY_FILE, 'w')
-          lines = Readline::HISTORY.to_a
-          lines[-[MAX_HISTORY_ITEMS, lines.size].min..-1].each do |line|
-            file.write(line.strip + "\n")
-          end
-          file.close
-        end
-
-        # Handle quoting, etc.
-        args = Shellwords.shellsplit(buffer)
-        next if args.empty?
+      Pry.config.history_file = @history_file
+    end
 
-        command = args[0].strip
-        if COMMANDS.include?(command)
-          send command.to_sym, args[1..-1]
+    def self.rspec(args)
+      parsed_args = args.flat_map do |arg|
+        if arg.match(/[\*\?\[]/)
+          glob = Dir.glob(arg)
+          glob.empty? ? [arg] : glob
         else
-          STDERR.puts "command not found: #{args[0]}"
+          [arg]
         end
       end
-    end
-
-    def help(args)
-      if !args.empty?
-        STDERR.puts "invalid argument(s): #{args}"
-        return
-      end
-
-      print "commands:\n\n"
-      print "help  - print this message\n"
-      print "rspec - execute the specified spec file(s), wildcards allowed\n"
-    end
 
-    def rspec(args)
-      if args.empty?
-        STDERR.puts "you must specify one or more spec files"
-        return
+      @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
 
-      # Allow wildcards.
-      filenames = args.flat_map { |filename| Dir.glob(filename) }
+      @runner = RSpec::Interactive::Runner.new(parsed_args)
 
-      # Store formatters, if any, set by the init script. They will be cleared by RSpec below.
-      formatters = RSpec.configuration.formatters || []
+      # Stop saving history in case a new Pry session is started for debugging.
+      Pry.config.history_save = false
 
-      # Initialize the runner. Also accessed by the signal handler above.
-      # RSpecInteractive::Runner sets RSpec.world.wants_to_quit to false. The signal
-      # handler sets it to true. 
-      @mutex.synchronize { @runner = RSpecInteractive::Runner.new(filenames) }
+      # RSpec::Interactive-specific RSpec configuration
+      configure_rspec
 
-      # Run the specs.
-      @runner.run
+      # Run.
+      exit_code = @runner.run
+      @runner = nil
 
-      # Clear the runner.
-      @mutex.synchronize { @runner = nil }
+      # Reenable history
+      Pry.config.history_save = true
 
-      # Clear data from previous run.
+      # Reset
       RSpec.clear_examples
-
-      # Formatters get cleared by clear_examples. I don't understand why but the actual run
-      # also modifies the list of formatters. Reset them to whatever the init script set.
-      if !RSpec.configuration.formatters.empty?
-        raise "internal error. expected formatters to be cleared."
-      end
-      formatters.each { |f| RSpec.configuration.add_formatter(f) }
+      RSpec.reset
+      @config_cache.replay_configuration
     end
   end
 end