rspec-interactive 0.9.1 → 0.9.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbc1f295bcf16bf85e5d6a6281de27ea2b51aa08f373272fb7d9e472ec13f3e9
-  data.tar.gz: 36d80a0af500094c129970d522b2a3a3e6bbfc117549b9453f8a5f07ccbcbe33
+  metadata.gz: 58b63742b50c16f44d1cf19e2957e29ed07ef4a19c3ee91debed0624f519684a
+  data.tar.gz: 0217f523599d1ee0a104718bd3c2bd79aeaf9366d18a22f5abfdadb2ce1fc229
 SHA512:
-  metadata.gz: 11ba7e2f1e90ddc985f6154b7fec1b738b2477481eb40efe92a822d11a39970799ed147a4ae5da4736b226d1fcb25fe372083fbb7a2346754f5a771456a9a01f
-  data.tar.gz: e10376660d90bace5ea870d3b9f046780157c65e3ec489ca21aa409ae0dcbdacf60cfa11e49d9ba2ab947b06b71e9e3fd5d35b976346ee370b552e8fd07e0bb6
+  metadata.gz: 7d5dbf2e0ec74668264fee718f5e2edaa60f0bff510433f376ac8264a64afb61b2a3538e8604f3c8cc4e0c1e48b409bb4bccfaedb25e0b587145d7b9f4abbb11
+  data.tar.gz: 86bba6bf0ad9728ba06d9374a3efb7b74cb4736fb24f5a81799e7ed4d54c499c012153ca2e90096caf0ab3965098c38cccc28b2b9c0d031723e7cc698b0a4fcc

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rspec-interactive (0.9.0)
+    rspec-interactive (0.9.3)
       listen
       pry
       rspec-core

data/bin/rspec-interactive

@@ -4,20 +4,20 @@ require 'optparse'
 require 'rspec-interactive'
 
 @options = {
-  server: false,
-  port:   RSpec::Interactive::DEFAULT_PORT
+  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 [--config config-file] [--server [--port <port>]]"
+    "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("-s", "--server", "Optional. Enable server used by IDEs.") do
-    @options[:server] = true
+  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|
@@ -26,4 +26,4 @@ parser = OptionParser.new do |opts|
 
 end.parse!
 
-RSpec::Interactive.start(config_file: @options[:config_file], server: @options[:server], port: @options[:port])
+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 print(str = "")
+        @client.print(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,44 @@
+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
+
+            stdout_thread = Thread.new do
+              while line = stdout_read.gets do
+                output.print(line)
+              end
+            end
+
+            stderr_thread = Thread.new do
+              while line = stderr_read.gets do
+                output.print(line)
+              end
+            end
+
+            begin
+              yield
+            ensure
+              # TODO: should the threads be killed here?
+              STDOUT.reopen stdout
+              STDERR.reopen stderr
+            end
+
+            stdout_thread.join
+            stderr_thread.join
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rspec-interactive/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module Interactive
-    VERSION = "0.9.1"
+    VERSION = "0.9.4"
   end
 end

data/lib/rspec-interactive.rb

@@ -7,13 +7,17 @@ require 'shellwords'
 require 'socket'
 require 'teamcity/spec/runner/formatter/teamcity/formatter'
 
+require 'rspec-interactive/client_output'
 require 'rspec-interactive/config'
 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
@@ -42,7 +46,7 @@ module RSpec
       @updated_files = []
       @stty_save = %x`stty -g`.chomp
       @file_change_mutex = Mutex.new
-      @rspec_mutex = Mutex.new
+      @command_mutex = Mutex.new
       @output_stream = output_stream
       @input_stream = input_stream
       @error_stream = error_stream
@@ -52,14 +56,16 @@ module RSpec
       load config_file if config_file
 
       check_rails
+      trap_interrupt
       configure_pry
+      load_rspec_configuration
 
-      @config_cache.record_configuration { @configuration.configure_rspec.call }
       start_file_watcher
 
       if server
+        @output_stream.puts "listening on port #{port}"
         server_thread = Thread.start do
-          server = TCPServer.new 5678
+          server = TCPServer.new port
 
           while client = server.accept
             request = client.gets
@@ -84,11 +90,14 @@ module RSpec
       end
     end
 
-    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
-       config.start_time = RSpec::Core::Time.now
+    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
+          raise Interrupt
+        end
       end
     end
 
@@ -104,7 +113,24 @@ module RSpec
       @listener.start
     end
 
+    def self.load_rspec_configuration
+      start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      config_thread = Thread.start do
+        @config_cache.record_configuration { @configuration.configure_rspec.call }
+      end
+      unless config_thread.join(3)
+        @output_stream.puts "executing configure_rspec hook..."
+      end
+      config_thread.join
+
+      end_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      @output_stream.puts "configure_rspec hook took #{(end_time - start_time).round} seconds" if end_time - start_time > 5
+    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
@@ -146,63 +172,75 @@ module RSpec
     end
 
     def self.rspec(args)
-      @rspec_mutex.synchronize do
+      @runner = RSpec::Interactive::Runner.new(parse_args(args))
 
-        @runner = RSpec::Interactive::Runner.new(parse_args(args))
+      refresh
 
-        refresh
+      # Stop saving history in case a new Pry session is started for debugging.
+      Pry.config.history_save = false
 
-        # 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
+      # RSpec::Interactive-specific RSpec configuration
+      RSpec.configure do |config|
+       config.error_stream = @error_stream
+       config.output_stream = @output_stream
+       config.start_time = RSpec::Core::Time.now
+      end
 
-        # Run.
-        exit_code = @runner.run
-        @runner = nil
+      # Run.
+      exit_code = @runner.run
+      @runner = nil
 
-        # Reenable history
-        Pry.config.history_save = true
+      # Reenable history
+      Pry.config.history_save = true
 
-        # Reset
-        RSpec.clear_examples
-        RSpec.reset
-        @config_cache.replay_configuration
-      rescue Interrupt
-        @runner&.quit
-      ensure
-        @runner = nil
-      end
+      # Reset
+      RSpec.clear_examples
+      RSpec.reset
+      @config_cache.replay_configuration
+    ensure
+      @runner = nil
     end
 
     def self.rspec_for_server(client, args)
-      @rspec_mutex.synchronize do
-        # Set the client so that logs are written to the client rathe than STDOUT.
-        Spec::Runner::Formatter::TeamcityFormatter.client = client
-
-        @runner = RSpec::Interactive::Runner.new(parse_args(args))
-
-        refresh
+      @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
+          RSpec.configure do |config|
+           config.error_stream = @error_stream
+           config.output_stream = @output_stream
+           config.start_time = RSpec::Core::Time.now
+          end
 
-        # Stop saving history in case a new Pry session is started for debugging.
-        Pry.config.history_save = false
+          # 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)))
 
-        # RSpec::Interactive-specific RSpec configuration
-        configure_rspec
-        RSpec.configuration.instance_variable_set(
-          :@formatter_loader,
-          RSpec::Core::Formatters::Loader.new(RSpec::Core::Reporter.new(RSpec.configuration)))
-        RSpec.configuration.formatter = Spec::Runner::Formatter::TeamcityFormatter
+          # 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
+          # Run.
+          exit_code = @runner.run
 
-        # Reset
-        Spec::Runner::Formatter::TeamcityFormatter.client = nil
-        RSpec.clear_examples
-        RSpec.reset
-        @config_cache.replay_configuration
+          # Reset
+          RSpec.clear_examples
+          RSpec.reset
+          @config_cache.replay_configuration
+        end
+      ensure
+        ENV['DISABLE_PRY'] = disable_pry
       end
     end
 
@@ -214,5 +252,17 @@ module RSpec
       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

@@ -4,14 +4,6 @@ module Spec
   module Runner
     module Formatter
       class TeamcityFormatter
-        class << self
-          attr_accessor :client
-        end
-
-        def log(msg)
-          TeamcityFormatter.client.puts(msg)
-          msg
-        end
       end
     end
   end

data/rspec-interactive.gemspec

@@ -23,7 +23,6 @@ Gem::Specification.new do |spec|
   end
   spec.bindir        = 'bin'
   spec.executables   << 'rspec-interactive'
-  spec.executables   << 'rspec-interactive-run'
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'rspec-core'

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/README.md

@@ -0,0 +1,3 @@
+# RSpec Interactive Runner
+
+Use this directory as the working directory in RubyMine run configurations.

data/{bin → runner}/rspec-interactive-run

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
 
 require 'optparse'
-require 'rspec-interactive'
 require 'shellwords'
 require 'socket'
 
@@ -25,8 +24,8 @@ parser = OptionParser.new do |opts|
 end.parse
 
 server = TCPSocket.open(@options[:host], @options[:port])
-server.puts ARGV.map{|arg| Shellwords.escape arg}.join(' ')
+server.puts ARGV.map{ |arg| Shellwords.escape arg }.join(' ')
 while response = server.gets do
-  puts "response: #{response}"
+  puts response
 end
 server.close

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-interactive
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.4
 platform: ruby
 authors:
 - Nick Dower
@@ -71,7 +71,6 @@ email:
 - nicholasdower@gmail.com
 executables:
 - rspec-interactive
-- rspec-interactive-run
 extensions: []
 extra_rdoc_files: []
 files:
@@ -83,25 +82,33 @@ files:
 - Rakefile
 - bin/console
 - bin/rspec-interactive
-- bin/rspec-interactive-run
 - 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/README.md
+- runner/rspec-interactive-run
 - scripts/release.sh
 - scripts/run-with-local-dep.sh
 - tests/debugged_spec_test.rb