rspec-daemon 0.1.5 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 332670cb33819b09dca4a799b6722302590e2a93bf117e67c139df6620dce631
-  data.tar.gz: 25d20f6af3c779f47e4f7ece5958decd92b507cb26c7b3cad1e9a4d92d15b719
+  metadata.gz: 89e342dbe33448b2a4321d6425f22924ef2e2ffca0da9c62b9b9dfe85b30df24
+  data.tar.gz: c73ef7dc9be41b613ab443f9c3bde415afe4689bf4114bbb98fc137429b7128c
 SHA512:
-  metadata.gz: eb893963a5271217535c44e6d424407531862a2294a465a97dfda71c5dedaad10d2b6ed6670fdeeb863dcc1cc73182653ae7303c0b36fc974596de8341d67f7f
-  data.tar.gz: 19ea2227333640e94a0daf2b5da340be0eece42e8d856420dc7d048ae909a415e54511cc1287a564aaf16a345bdd1c4490382eb06cb5155398d652dbbefc35d3
+  metadata.gz: b40f70439941100811fbcf34906e077be7d8172399ecd5a046b0815dbc3ec786a87b280a6332a97dced543d4a65e13ad924b93f902ed524f9eb700ff5bea2c1a
+  data.tar.gz: 5951972b8a86979b652a757a0ca36f41daee408728e512125230c02ee90a73088f1dd2fb064f89540fe8724ff3754ef04ce416e47b8cc7a1b3730c3525e22f6b

data/CHANGELOG.md

@@ -1,4 +1,13 @@
-## [Unreleased]
+## [1.0.1] - 2023-12-16
+
+-  Fix the method to start the test #9 @ta1kt0me
+
+## [1.0.0] - 2023-12-15
+
+- 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
 

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.start(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.5"
+    VERSION = "1.0.1"
   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)

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.5
+  version: 1.0.1
 platform: ruby
 authors:
 - Yuya Fujiwara
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-11 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
@@ -71,7 +74,7 @@ metadata:
   homepage_uri: https://github.com/asonas/rspec-daemon
   source_code_uri: https://github.com/asonas/rspec-daemon
   changelog_uri: https://github.com/asonas/rspec-daemon/blob/master/CHANGELOG.md
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -86,8 +89,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
-signing_key:
+rubygems_version: 3.4.10
+signing_key: 
 specification_version: 4
 summary: rspec-daemon is a mechanism to run tests at super faster speed
 test_files: []