rspec-interactive 0.8.1 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 255c2aca56cb003fad2c6e7e5f72cb75b2ed82f1820edb42294ded182dbdd25c
-  data.tar.gz: afb9f469028aa3a4388585e6d34e281ce1bae8fe7227e73ba0939f2cf3585255
+  metadata.gz: 17f3d7cb90e4271d19e1eb1a835a9c759084d12baf1f7404bedc521d8ff54047
+  data.tar.gz: 98688109728bbaa18e0b64339987fc0d2320331095ad09f2761d2162254ad868
 SHA512:
-  metadata.gz: abae1515ca7dade3476088e21fef619f1cdda2b3b126f0a19db30b0aabd2f7250bee9874f11cccf5a836d39dd45d7b6a5848003a32637bf2eb925c4d229622dc
-  data.tar.gz: 90c4118df931f6e30c3af286f8fb9a1a382bd30dfcd3d052480943fa4f305975784c87e51fddba17de4343ef0748169c07831dc52e7f31190efefef516216efa
+  metadata.gz: f0fbe89b3308f29db1302f28b265c0374a6b5c586b32b5c2bee2351d035faaf82c5f5d0362bb95158966d5ea9354de404dc126efd7b899d1bb9d2f8bee40edde
+  data.tar.gz: a8bbeaf1ca9e8f51b975cde6bf51be7cc5c6a57b1266bc4ee527c1e1ffcf995b9ac8c78ac77fe1a8ca79b937c4c31d712c9d58119ca4283854da8a6c4f78ccc9

data/.gitignore

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

data/Gemfile.lock

@@ -1,33 +1,43 @@
 PATH
   remote: .
   specs:
-    rspec-interactive (0.8.0)
+    rspec-interactive (0.9.1)
       listen
       pry
       rspec-core
+      rspec-teamcity (= 1.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     coderay (1.1.3)
     diff-lcs (1.4.4)
-    ffi (1.15.3)
-    listen (3.5.1)
+    ffi (1.15.5)
+    listen (3.7.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-fsevent (0.11.1)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
     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-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
     rspec-support (3.9.4)
+    rspec-teamcity (1.0.0)
+      rspec (>= 2.99, >= 2.14.2, < 4)
 
 PLATFORMS
   x86_64-darwin-20

data/README.md

@@ -69,10 +69,10 @@ See: https://github.com/thoughtbot/factory_bot/blob/master/GETTING_STARTED.md#ra
 
 ## 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>`.
+Optionally, specify a config file with `--config <config-file>`.
 
 ```shell
-bundle exec rspec-interactive [--config <config-file>] [--initial-rspec-args <initial-rspec-args>]
+bundle exec rspec-interactive [--config <config-file>]
 ```
 
 ## Example Usage In This Repo
@@ -83,12 +83,6 @@ 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

data/bin/rspec-interactive

@@ -3,18 +3,27 @@
 require 'optparse'
 require 'rspec-interactive'
 
-@options = {}
+@options = {
+  server: true,
+  server_port: RSpec::Interactive::DEFAULT_PORT
+}
+
 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>"
+    "Usage: bundle exec rspec-interactive [--config config-file] [--no-server] [--port <port>]"
 
   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
+  opts.on("--no-server", "Optional. Disable server.") do
+    @options[:server] = false
+  end
+
+  opts.on("-p", "--port <port>", Integer, "Optional. Server port. Defaults to #{RSpec::Interactive::DEFAULT_PORT}.") do |port|
+    @options[:port] = port
   end
+
 end.parse!
 
-RSpec::Interactive.start(config_file: @options[:config_file], initial_rspec_args: @options[:initial_rspec_args])
+RSpec::Interactive.start(config_file: @options[:config_file], server: @options[:server], port: @options[:server_port])

data/examples/config.rb

@@ -0,0 +1,7 @@
+RSpec::Interactive.configure do |config|
+  config.watch_dirs += ['lib']
+
+  config.configure_rspec do
+    RSpec.configuration.formatter = :documentation
+  end
+end

data/lib/rspec-interactive/client_output.rb

@@ -0,0 +1,17 @@
+module RSpec
+  module Interactive
+    class ClientOutput
+      def initialize(client)
+        @client = client
+      end
+
+      def puts(str = "")
+        @client.puts(str&.to_s || '')
+      end
+
+      def string
+        @output
+      end
+    end
+  end
+end

data/lib/rspec-interactive/pry.rb

@@ -0,0 +1,12 @@
+require 'pry'
+
+class Pry
+  alias_method :old_eval, :eval
+
+  def eval(line, options = {})
+    RSpec::Interactive.eval do
+      old_eval(line, options)
+    end
+  end
+end
+

data/lib/rspec-interactive/rspec_core_example.rb

@@ -0,0 +1,15 @@
+require 'rspec/core'
+
+module RSpec
+  module Core
+    class Example
+      alias_method :old_run, :run
+
+      def run(example_group_instance, reporter)
+        execution_result.started_at = RSpec::Core::Time.now
+        old_run(example_group_instance, reporter)
+      end
+    end
+  end
+end
+

data/lib/rspec-interactive/stdio.rb

@@ -0,0 +1,39 @@
+module RSpec
+  module Interactive
+    class Stdio
+      def self.capture(output)
+        raise ArgumentError, 'missing block' unless block_given?
+
+        stdout, stderr = STDOUT.dup, STDERR.dup
+
+        IO.pipe do |stdout_read, stdout_write|
+          IO.pipe do |stderr_read, stderr_write|
+            STDOUT.reopen(stdout_write)
+            STDERR.reopen(stderr_write)
+
+            stdout_write.close
+            stderr_write.close
+
+            thread = Thread.new do
+              until stdout_read.eof? && stderr_read.eof? do
+                line = stdout_read.gets
+                output.puts line if line
+                line = stderr_read.gets
+                output.puts if line
+              end
+            end
+
+            begin
+              yield
+            ensure
+              STDOUT.reopen stdout
+              STDERR.reopen stderr
+            end
+
+            thread.join
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rspec-interactive/version.rb

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

data/lib/rspec-interactive.rb

@@ -4,19 +4,26 @@ require 'pry'
 require 'readline'
 require 'rspec/core'
 require 'shellwords'
+require 'socket'
+require 'teamcity/spec/runner/formatter/teamcity/formatter'
 
-require 'rspec-interactive/runner'
+require 'rspec-interactive/client_output'
 require 'rspec-interactive/config'
-require 'rspec-interactive/rspec_config_cache'
 require 'rspec-interactive/input_completer'
+require 'rspec-interactive/pry'
 require 'rspec-interactive/refresh_command'
 require 'rspec-interactive/rspec_command'
+require 'rspec-interactive/rspec_config_cache'
+require 'rspec-interactive/rspec_core_example'
 require 'rspec-interactive/rubo_cop_command'
+require 'rspec-interactive/runner'
+require 'rspec-interactive/stdio'
 
 module RSpec
   module Interactive
 
     DEFAULT_HISTORY_FILE = '.rspec_interactive_history'.freeze
+    DEFAULT_PORT = 5678
 
     class << self
       attr_accessor :configuration
@@ -26,11 +33,20 @@ module RSpec
       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)
+    def self.start(
+      config_file:   nil,
+      server:        false,
+      port:          DEFAULT_PORT,
+      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
+      @file_change_mutex = Mutex.new
+      @command_mutex = Mutex.new
       @output_stream = output_stream
       @input_stream = input_stream
       @error_stream = error_stream
@@ -40,21 +56,34 @@ module RSpec
       load config_file if config_file
 
       check_rails
-      trap_interrupt
       configure_pry
 
-      @init_thread = Thread.start {
-        @config_cache.record_configuration { @configuration.configure_rspec.call }
-        start_file_watcher
-      }
+      start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      @config_cache.record_configuration { @configuration.configure_rspec.call }
+      end_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      if end_time - start_time > 5
+        @output_stream.puts "Configuring RSpec took #{(end_time - start_time).round} seconds."
+      end
+
+      start_file_watcher
+
+      if server
+        @output_stream.puts "Listening on port #{port}."
+        server_thread = Thread.start do
+          server = TCPServer.new port
 
-      if initial_rspec_args
-        open(@history_file, 'a') { |f| f.puts "rspec #{initial_rspec_args.strip}" }
-        rspec Shellwords.split(initial_rspec_args)
+          while client = server.accept
+            request = client.gets
+            args = Shellwords.split(request)
+            rspec_for_server(client, args)
+            client.close
+          end
+        end
       end
 
       Pry.start
       @listener.stop if @listener
+      server_thread.exit if server_thread
       0
     end
 
@@ -66,23 +95,11 @@ module RSpec
       end
     end
 
-    def self.configure_rspec
+    def self.configure_rspec(error_stream: @error_stream, output_stream: @output_stream)
       RSpec.configure do |config|
-       config.error_stream = @error_stream
-       config.output_stream = @output_stream
-      end
-    end
-
-    def self.trap_interrupt
-      trap('INT') do
-        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
+       config.error_stream = error_stream
+       config.output_stream = output_stream
+       config.start_time = RSpec::Core::Time.now
       end
     end
 
@@ -91,7 +108,7 @@ module RSpec
 
       # Only polling seems to work in Docker.
       @listener = Listen.to(*@configuration.watch_dirs, only: /\.rb$/, force_polling: true) do |modified, added|
-        @mutex.synchronize do
+        @file_change_mutex.synchronize do
           @updated_files.concat(added + modified)
         end
       end
@@ -99,9 +116,6 @@ module RSpec
     end
 
     def self.configure_pry
-      # Prevent Pry from trapping too. It will break ctrl-c handling.
-      Pry.config.should_trap_interrupts = false
-
       # Set up IO.
       Pry.config.input = Readline
       Pry.config.output = @output_stream
@@ -115,7 +129,7 @@ module RSpec
     end
 
     def self.refresh
-      @mutex.synchronize do
+      @file_change_mutex.synchronize do
         @updated_files.uniq.each do |filename|
           @output_stream.puts "changed: #{filename}"
           trace = TracePoint.new(:class) do |tp|
@@ -131,8 +145,8 @@ module RSpec
       @configuration.refresh.call
     end
 
-    def self.rspec(args)
-      parsed_args = args.flat_map do |arg|
+    def self.parse_args(args)
+      args.flat_map do |arg|
         if arg.match(/[\*\?\[]/)
           glob = Dir.glob(arg)
           glob.empty? ? [arg] : glob
@@ -140,15 +154,10 @@ module RSpec
           [arg]
         end
       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
+    def self.rspec(args)
+      @runner = RSpec::Interactive::Runner.new(parse_args(args))
 
       refresh
 
@@ -169,21 +178,71 @@ module RSpec
       RSpec.clear_examples
       RSpec.reset
       @config_cache.replay_configuration
+    rescue Interrupt => e
+      @runner&.quit
+      raise e
     ensure
       @runner = nil
     end
 
-    def self.rubo_cop(args)
-      if @init_thread&.alive?
-        @init_thread.join
-        @init_thread = nil
+    def self.rspec_for_server(client, args)
+      @command_mutex.synchronize do
+        # Prevent the debugger from being used. The server isn't interactive.
+        disable_pry = ENV['DISABLE_PRY']
+        ENV['DISABLE_PRY'] = 'true'
+
+        output = ClientOutput.new(client)
+        Stdio.capture(ClientOutput.new(client)) do
+          @runner = RSpec::Interactive::Runner.new(parse_args(args))
+
+          refresh
+
+          # RSpec::Interactive-specific RSpec configuration
+          configure_rspec
+
+          # RubyMine specifies --format. That causes a formatter to be added. It does not override
+          # the existing formatter (if one is set by default). Clear any formatters but resetting
+          # the loader.
+          RSpec.configuration.instance_variable_set(
+            :@formatter_loader,
+            RSpec::Core::Formatters::Loader.new(RSpec::Core::Reporter.new(RSpec.configuration)))
+
+          # Always use the teamcity formatter, even though RubyMine always specifies it.
+          # This make manual testing of rspec-interactive easier.
+          RSpec.configuration.formatter = Spec::Runner::Formatter::TeamcityFormatter
+
+          # Run.
+          exit_code = @runner.run
+
+          # Reset
+          RSpec.clear_examples
+          RSpec.reset
+          @config_cache.replay_configuration
+        end
+      ensure
+        ENV['DISABLE_PRY'] = disable_pry
       end
+    end
 
+    def self.rubo_cop(args)
       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
+
+    def self.eval(&block)
+      if Thread.current.thread_variable_get('holding_lock')
+        yield
+      else
+        @command_mutex.synchronize do
+          Thread.current.thread_variable_set('holding_lock', true)
+          yield
+        ensure
+          Thread.current.thread_variable_set('holding_lock', false)
+        end
+      end
+    end
   end
 end

data/lib/teamcity/spec/runner/formatter/teamcity/formatter.rb

@@ -0,0 +1,10 @@
+require 'rspec/teamcity'
+
+module Spec
+  module Runner
+    module Formatter
+      class TeamcityFormatter
+      end
+    end
+  end
+end

data/rspec-interactive.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'rspec-core'
+  spec.add_dependency 'rspec-teamcity', '1.0.0'
   spec.add_dependency 'listen'
   spec.add_dependency 'pry'
 end

data/runner/Gemfile

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

data/runner/Gemfile.lock

@@ -0,0 +1,14 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+
+RUBY VERSION
+   ruby 3.0.0p0
+
+BUNDLED WITH
+   2.3.6

data/runner/rspec-interactive-run

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'shellwords'
+require 'socket'
+
+@options = {
+  host: 'localhost',
+  port: 5678
+}
+
+parser = OptionParser.new do |opts|
+  opts.banner = "Executes RSpec by connecting to a running RSpec Interactive shell.\n\n"\
+    "Usage: bundle exec rspec-interactive-run [--host <host>] [--port <port>] [rspec-args]"
+
+  opts.on("-h", "--host <host>", String, "Optional. Server host. Defaults to localhost.") do |host|
+    @options[:host] = host
+  end
+
+  opts.on("-p", "--port <port>", Integer, "Optional. Server port. Defaults to 5678.") do |port|
+    @options[:port] = port
+  end
+
+end.parse
+
+server = TCPSocket.open(@options[:host], @options[:port])
+server.puts ARGV.map{ |arg| Shellwords.escape arg }.join(' ')
+while response = server.gets do
+  puts response
+end
+server.close

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-interactive
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.2
 platform: ruby
 authors:
 - Nick Dower
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-28 00:00:00.000000000 Z
+date: 2022-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-teamcity
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: listen
   requirement: !ruby/object:Gem::Requirement
@@ -70,21 +84,30 @@ files:
 - bin/rspec-interactive
 - bin/setup
 - bin/test
+- examples/config.rb
 - examples/debugged_spec.rb
 - examples/failing_spec.rb
 - examples/other_passing_spec.rb
 - examples/passing_spec.rb
 - examples/spec_with_syntax_error.rb
 - lib/rspec-interactive.rb
+- lib/rspec-interactive/client_output.rb
 - lib/rspec-interactive/config.rb
 - lib/rspec-interactive/input_completer.rb
+- lib/rspec-interactive/pry.rb
 - lib/rspec-interactive/refresh_command.rb
 - lib/rspec-interactive/rspec_command.rb
 - lib/rspec-interactive/rspec_config_cache.rb
+- lib/rspec-interactive/rspec_core_example.rb
 - lib/rspec-interactive/rubo_cop_command.rb
 - lib/rspec-interactive/runner.rb
+- lib/rspec-interactive/stdio.rb
 - lib/rspec-interactive/version.rb
+- lib/teamcity/spec/runner/formatter/teamcity/formatter.rb
 - rspec-interactive.gemspec
+- runner/Gemfile
+- runner/Gemfile.lock
+- runner/rspec-interactive-run
 - scripts/release.sh
 - scripts/run-with-local-dep.sh
 - tests/debugged_spec_test.rb