rspec-daemon 0.1.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '009bb553fc685bd3c43c8317afa829b91927d113f4a82c3ba225a25c6b222b97'
-  data.tar.gz: 617b4b819820308641bdcbbdb1700b95a4b881cc531bc1b40f6333d1daca94ab
+  metadata.gz: 208bd76b8815eaf702f7b32c3cfd987551c122d49e63f8f7c2bd912c84e81b31
+  data.tar.gz: 96b0bae9c7f30441345b8e85419be284fdecb1d112e7ae842ccd76c26c1b476d
 SHA512:
-  metadata.gz: 8452ebf8fb216e146f5541c781f44b1d75ce9253c3d31bccf4578e63f7cad54858faff131dc3c133c359f797f25a9a7ee39f1fd6a85070662a2ead7bb5b5508f
-  data.tar.gz: bce7470abe76132de68bf3076678a82f1366bed74a0345c7a0617bdb9a9151d8d97b3d2474f24c06bf477fac442235566e51e0e17e2df9d3ac8943ebc6ce44bc
+  metadata.gz: 2fc0fc6bded50693fd5db0e9f8d05fb7cb9980a146467548a1889f7e1435623947b67b5decb5baea37e65b2c0c7fc99b9c224a16968020964a46f013542625b9
+  data.tar.gz: c22c13bd14953714bc393ea81423895a94a310be7c4e10d0d2ed49af3d021d179cb5335b6d505fa1cf22c481fd11f1cc26fb1a8cdab6628b2a1e70a9a8dce245

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## [Unreleased]
 
+## [1.0.0]
+
+- Make bind address and port configurable #7 @osyoyu
+- Remove pry dependency #6 @osyoyu
+- rspeccc, a client tool for rspec-daemon #5 @osyoyu
+- allow configuration of port via env #4 @felixRun
+
 ## [0.1.0] - 2023-04-11
 
 - Initial release

data/README.md

@@ -15,15 +15,85 @@ gem 'rspec-daemon', require: false
 
 ## Usage
 
+Start the daemon process by running `rspec-daemon` in the directory where you would run `rspec`.
+
 ```
 $ cd YOUR_PROJECT
 $ bundle ex rspec-daemon
+Listening on tcp://0.0.0.0:3002
+```
+
+To run specs, use the `rspeccc` client tool.
+
+```
+$ bundle ex rspeccc spec/models/user_spec.rb # arguments are passed to rspec
+
+User
+  is healthy
+
+Finished in 0.00136 seconds (files took 36.25 seconds to load)
+1 example, 0 failures
 ```
 
+Alternatively, standard utilites such as `nc` may be used.
+
 ```
 $ echo 'spec/models/user_spec.rb' | nc -v 0.0.0.0 3002
 ```
 
+By default, `rspec-daemon` will run on port `3002`. You can adjust the port by passing `--port` to `rspec-daemon` or setting the `RSPEC_DAEMON_PORT` environment variable.
+
+## Editor integration
+
+### Vim/Neovim
+
+Add a key binding of your preference to your `.vimrc` or `init.vim`.
+
+```vim
+" Run specs under the current cursor line
+nnoremap <Leader>h :execute '!bundle exec rspeccc ' . expand('%:p') . ':' . line('.')<CR>
+```
+
+If you are using [rspec.vim](https://github.com/thoughtbot/vim-rspec), you may want to configure `g:rspec_command`.
+
+```vim
+" For rspec.vim users
+let g:rspec_command = "!bundle exec rspeccc {spec}"
+```
+
+### Visual Studio Code
+
+Tasks are a nice way to launch `rspeccc`.
+Here is an example `tasks.json` configuration which runs specs under the current cursor location:
+
+```json
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "rspec-remote: Cursor context",
+      "group": "test",
+      "type": "shell",
+      "command": "bundle exec rspeccc ${relativeFile}:${lineNumber}"
+    }
+  ]
+}
+```
+
+Adding a keybindings.json entry for your Task is also recommendable.
+
+```json
+[
+  {
+    "key": "cmd+h",
+    "command": "workbench.action.tasks.runTask",
+    "args": "rspec-remote: Cursor context"
+  }
+]
+```
+
+Refer to Visual Studio Code's documentation ([Integrate with External Tools via Tasks](https://go.microsoft.com/fwlink/?LinkId=733558)) for further customization.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/exe/rspec-daemon

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
 
 require 'rspec/daemon/cli'
-RSpec::Daemon::Cli.start
+RSpec::Daemon::Cli.start(ARGV)

data/exe/rspeccc

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'rspec/daemon/client_cli'
+exit RSpec::Daemon::ClientCli.run(ARGV)

data/lib/rspec/daemon/cli.rb

@@ -3,8 +3,42 @@ require_relative '../daemon'
 module RSpec
   class Daemon
     class Cli
-      def self.start
-        RSpec::Daemon.start
+      DEFAULT_OPTIONS = {
+        bind_address: "0.0.0.0",
+        port: 3002,
+      }
+
+      def self.start(...)
+        new.start(...)
+      end
+
+      def start(argv)
+        options = DEFAULT_OPTIONS.dup
+        if ENV['RSPEC_DAEMON_BIND_ADDRESS']
+          options[:bind_address] = ENV['RSPEC_DAEMON_BIND_ADDRESS']
+        end
+        if ENV['RSPEC_DAEMON_PORT']
+          options[:port] = ENV['RSPEC_DAEMON_PORT'].to_i
+        end
+
+        option_parser = OptionParser.new do |opts|
+          opts.on('-v', '--version', 'Prints version') do
+            puts RSpec::Daemon::VERSION
+            exit
+          end
+
+          opts.on('-b', '--bind ADDRESS', 'address to bind (default: 0.0.0.0)') do |address|
+            options[:bind_address] = address
+          end
+
+          opts.on('-p', '--port PORT', 'port to listen on (default: 3002)') do |port|
+            options[:port] = port
+          end
+        end
+        option_parser.parse!(argv)
+
+        RSpec::Daemon.new(options[:bind_address], options[:port]).start
+        0
       end
     end
   end

data/lib/rspec/daemon/client_cli.rb

@@ -0,0 +1,52 @@
+require_relative '../daemon'
+
+module RSpec
+  class Daemon
+    class ClientCli
+      DEFAULT_OPTIONS = {
+        host: "localhost",
+        port: 3002,
+      }
+
+      def self.start(...)
+        new.start(...)
+      end
+
+      def start(argv)
+        options = DEFAULT_OPTIONS.dup
+        option_parser = OptionParser.new do |opts|
+          opts.on('-v', '--version', 'Prints version') do
+            puts RSpec::Daemon::VERSION
+            exit
+          end
+
+          opts.on('-h', '--host HOST', 'rspec-daemon host (default: localhost)') do |host|
+            options[:host] = host
+          end
+
+          opts.on('-p', '--port PORT', 'rspec-daemon port (default: 3002)') do |port|
+            options[:port] = port
+          end
+        end
+        option_parser.parse!(argv)
+        # Send all other arguments to rspec via the daemon
+        command = argv.join(' ') + "\n"
+
+        begin
+          # Open connection to rspec-daemon
+          socket = TCPSocket.open(options[:host], options[:port])
+          socket.write(command)
+          while line = socket.gets # rubocop:disable Lint/AssignmentInCondition
+            print line
+          end
+          socket.close
+        rescue Errno::ECONNREFUSED => e
+          STDERR.puts "Failed to connect to #{options[:host]}:#{options[:port]} (#{e})"
+          return 1
+        end
+
+        0
+      end
+    end
+  end
+end

data/lib/rspec/daemon/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   class Daemon
-    VERSION = "0.1.4"
+    VERSION = "1.0.0"
   end
 end

data/lib/rspec/daemon.rb

@@ -6,7 +6,6 @@ require_relative "daemon/configuration"
 require "socket"
 require "stringio"
 require "rspec"
-require "pry"
 
 module RSpec
   class Daemon
@@ -14,20 +13,17 @@ module RSpec
 
     class Error < StandardError; end
 
-    def self.start
-      self.new.start
+    def initialize(bind_address, port)
+      @bind_address = bind_address
+      @port = port
     end
 
     def start
-      entry_point
-    end
-
-    def entry_point
       $LOAD_PATH << "./spec"
 
       RSpec::Core::Runner.disable_autorun!
-      server = TCPServer.open("0.0.0.0", 3002)
-      puts "start tcp server"
+      server = TCPServer.open(@bind_address, @port)
+      puts "Listening on tcp://#{server.addr[2]}:#{server.addr[1]}"
 
       loop do
         handle_request(server.accept)
@@ -39,7 +35,7 @@ module RSpec
     end
 
     def handle_request(socket)
-      status, out = run(socket.read)
+      status, out = run(socket.gets)
 
       socket.puts(status)
       socket.puts(out)
@@ -76,7 +72,7 @@ module RSpec
 
     def rspec_configuration
       proc do
-        if defined?(::Rails)
+        if File.exist? "spec/rails_helper.rb"
           require "rails_helper"
         end
       end

data/rspec-daemon.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
 
   # Uncomment to register a new dependency of your gem
   spec.add_dependency "rspec"
-  spec.add_dependency "pry"
+  spec.add_development_dependency "pry"
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-daemon
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 1.0.0
 platform: ruby
 authors:
 - Yuya Fujiwara
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-06 00:00:00.000000000 Z
+date: 2023-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -31,7 +31,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -43,6 +43,7 @@ email:
 - asonas@cookpad.com
 executables:
 - rspec-daemon
+- rspeccc
 extensions: []
 extra_rdoc_files: []
 files:
@@ -58,8 +59,10 @@ files:
 - example/Gemfile.lock
 - example/user_spec.rb
 - exe/rspec-daemon
+- exe/rspeccc
 - lib/rspec/daemon.rb
 - lib/rspec/daemon/cli.rb
+- lib/rspec/daemon/client_cli.rb
 - lib/rspec/daemon/configuration.rb
 - lib/rspec/daemon/version.rb
 - rspec-daemon.gemspec
@@ -86,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: rspec-daemon is a mechanism to run tests at super faster speed