rspec-interactive 0.7.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e56b91e4f1d28feae7da156d8e4f3ddec5aeffe5847f0ecf6c28150f9f2ac1d
-  data.tar.gz: 9b88b87a123b207b1478413b0e963bee0a25255163977cd2982cd8d9a0d21742
+  metadata.gz: 987faf5573f9ae7554f4983ee350beaf7ad9ef832544cea3b6f92114cf554788
+  data.tar.gz: 29e0c2b195497e1d2af2f7e8565ee64ae6039870f3bb685dc86e750c11342a71
 SHA512:
-  metadata.gz: a5acd4df05e27db03f66f66f96f9cc43692485abbfe04ee5e680589689c274bde396f07c893b2138cea6db745a4fcc2b9a127caaf7a8c0ccb7c5a2acedd60b6e
-  data.tar.gz: 534a6ba41f06820271a60a5844fc72e19bb92730067bda01d84ad791fd5c99ce35b4f94b60badb862a7f5de183dbc5a799bfb8280f07162660e99a1b186d74d1
+  metadata.gz: 2f3e0573bd9280ca150292045134b5eea34243661733aa68dda3ca03c086fc0275ecfecd919aaf022e5aeb943ca4523170e39e6d47c60f8ef59fc5b925fc60b4
+  data.tar.gz: 618437758587eb88be800508ef487960c1c760143e81594e89c3e80280a2eada7e3904e323c960b6dce2b40ec93eba6638e3dbda311d57144a95d6fef719a1d9

data/.gitignore

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

data/Gemfile.lock

@@ -1,10 +1,11 @@
 PATH
   remote: .
   specs:
-    rspec-interactive (0.7.1)
+    rspec-interactive (0.8.1)
       listen
       pry
       rspec-core
+      rspec-teamcity (= 1.0.0)
 
 GEM
   remote: https://rubygems.org/
@@ -22,12 +23,21 @@ GEM
     rb-fsevent (0.11.0)
     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: false,
+  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] [--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("-s", "--server", "Optional. Enable server used by IDEs.") do
+    @options[:server] = true
+  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[:port])

data/bin/rspec-interactive-run

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'rspec-interactive'
+require 'shellwords'
+require 'socket'
+
+@options = {
+  host: 'localhost',
+  port:   RSpec::Interactive::DEFAULT_PORT
+}
+
+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 #{RSpec::Interactive::DEFAULT_PORT}.") 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: #{response}"
+end
+server.close

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/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.7.2"
+    VERSION = "0.9.0"
   end
 end

data/lib/rspec-interactive.rb

@@ -4,18 +4,22 @@ 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/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/rspec_config_cache'
+require 'rspec-interactive/rubo_cop_command'
+require 'rspec-interactive/runner'
 
 module RSpec
   module Interactive
 
     DEFAULT_HISTORY_FILE = '.rspec_interactive_history'.freeze
+    DEFAULT_PORT = 5678
 
     class << self
       attr_accessor :configuration
@@ -25,11 +29,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
+      @rspec_mutex = Mutex.new
       @output_stream = output_stream
       @input_stream = input_stream
       @error_stream = error_stream
@@ -42,18 +55,25 @@ module RSpec
       trap_interrupt
       configure_pry
 
-      @init_thread = Thread.start {
-        @config_cache.record_configuration { @configuration.configure_rspec.call }
-        start_file_watcher
-      }
+      @config_cache.record_configuration { @configuration.configure_rspec.call }
+      start_file_watcher
+
+      if server
+        server_thread = Thread.start do
+          server = TCPServer.new 5678
 
-      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
 
@@ -65,10 +85,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
+       config.error_stream = error_stream
+       config.output_stream = output_stream
+       config.start_time = RSpec::Core::Time.now
       end
     end
 
@@ -78,9 +99,7 @@ module RSpec
           # 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)
+          raise Interrupt
         end
       end
     end
@@ -90,7 +109,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
@@ -114,7 +133,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|
@@ -130,8 +149,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
@@ -139,37 +158,71 @@ module RSpec
           [arg]
         end
       end
+    end
+
+    def self.rspec(args)
+      @rspec_mutex.synchronize do
 
-      # 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)
+        @runner = RSpec::Interactive::Runner.new(parse_args(args))
 
-      if @init_thread&.alive?
-        @init_thread.join
-        @init_thread = nil
+        refresh
+
+        # 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
+      ensure
+        @runner = nil
       end
+    end
 
-      refresh
+    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
 
-      # Stop saving history in case a new Pry session is started for debugging.
-      Pry.config.history_save = false
+        @runner = RSpec::Interactive::Runner.new(parse_args(args))
 
-      # RSpec::Interactive-specific RSpec configuration
-      configure_rspec
+        refresh
 
-      # Run.
-      exit_code = @runner.run
-      @runner = nil
+        # Stop saving history in case a new Pry session is started for debugging.
+        Pry.config.history_save = false
 
-      # Reenable history
-      Pry.config.history_save = true
+        # RSpec::Interactive-specific RSpec configuration
+        configure_rspec
+        RSpec.configuration.formatter = Spec::Runner::Formatter::TeamcityFormatter
 
-      # Reset
-      RSpec.clear_examples
-      RSpec.reset
-      @config_cache.replay_configuration
-    ensure
-      @runner = nil
+        # Run.
+        exit_code = @runner.run
+
+        # Reset
+        Spec::Runner::Formatter::TeamcityFormatter.client = nil
+        RSpec.clear_examples
+        RSpec.reset
+        @config_cache.replay_configuration
+      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
+
   end
 end

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

@@ -0,0 +1,18 @@
+require 'rspec/teamcity'
+
+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
+end

data/rspec-interactive.gemspec

@@ -23,9 +23,11 @@ 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'
+  spec.add_dependency 'rspec-teamcity', '1.0.0'
   spec.add_dependency 'listen'
   spec.add_dependency 'pry'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-interactive
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.9.0
 platform: ruby
 authors:
 - Nick Dower
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-25 00:00:00.000000000 Z
+date: 2022-02-24 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
@@ -57,6 +71,7 @@ email:
 - nicholasdower@gmail.com
 executables:
 - rspec-interactive
+- rspec-interactive-run
 extensions: []
 extra_rdoc_files: []
 files:
@@ -68,6 +83,7 @@ files:
 - Rakefile
 - bin/console
 - bin/rspec-interactive
+- bin/rspec-interactive-run
 - bin/setup
 - bin/test
 - examples/debugged_spec.rb
@@ -81,8 +97,10 @@ files:
 - 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
+- lib/teamcity/spec/runner/formatter/teamcity/formatter.rb
 - rspec-interactive.gemspec
 - scripts/release.sh
 - scripts/run-with-local-dep.sh