retest 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1d5cde47e268fbb49f94510bb8bde3398974672fae9ad770dbe85f542764e6d
-  data.tar.gz: db1d76a1b2329a2e1619a34778c305280cbc50d2b99fd87998ae0c1b3406fb1b
+  metadata.gz: 0e161cc74886493796c719db9fae3f3d7b7dc31dfedc701539383e406d97336f
+  data.tar.gz: dd6489fed59acfa0ccede581cae6a6e719a6c803a83214536e1aeed3173d6565
 SHA512:
-  metadata.gz: 9ed11c05236d2f50d54b644d02fa1c37c9d928f7a6b452e60a5ea9c23deab95d6e7a3e178f3047b3dcbce945c0cf9bee3e31682fd9b53d1f7df4b01a2303d476
-  data.tar.gz: 417d8fb0439869a1be651efa2daece0cf1a1fab705495a4bc72b9827355fb054f34e3c93d92177be8a43aba028b36c2c876bc70801ba71083ca832da9efda731
+  metadata.gz: 9b4a4c521cc8f24d4f03e496aff11dee753e57e33e072e05dd24e01be82e300ad01a0d4f895f65115904395dde3833ee927932ba9b94a03f69fcbefe39e7c6ae
+  data.tar.gz: a9d7acc12519dc1be69be17c36f504035a7a2505d248636090e008ae1555e1d69eca7f85c0ceb9fdc6b5b8868a1f79083ae06673f762315a7f88dffd22f00009

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    retest (0.6.0)
+    retest (0.7.0)
       listen (~> 3.2)
       string-similarity (~> 2.1)
+      tty-option (~> 0.1)
 
 GEM
   remote: https://rubygems.org/
@@ -61,7 +62,7 @@ GEM
     ffi (1.13.1)
     i18n (1.8.5)
       concurrent-ruby (~> 1.0)
-    listen (3.3.1)
+    listen (3.3.3)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     middleware (0.1.0)
@@ -85,6 +86,7 @@ GEM
       ffi (>= 1.0.0)
     thor (1.0.1)
     thread_safe (0.3.6)
+    tty-option (0.1.0)
     tzinfo (1.2.7)
       thread_safe (~> 0.1)
     zeitwerk (2.4.0)

data/README.md

@@ -16,6 +16,7 @@ For fully fledged solutions, some cli tools already exists: [autotest](https://g
 Install it on your machine with:
 
     $ gem install retest
+    $ retest 'bundle exec rspec <test>'
 
 ## Usage
 
@@ -23,22 +24,38 @@ Launch `retest` in your terminal after accessing your ruby project folder.
 
 Pass the test command surrounded by quotes. Use the placeholder `<test>` in your command to let `retest` find the matching test and replace the placeholder with the path of the test file.
 
+Learn more by running `retest -h`
+
 ```bash
-# Let retest find the test file and replace the placeholder with the path of the test file
-$ retest 'bundle exec rake test TEST=<test>'
-$ retest 'rails test <test>'
-$ retest 'rspec <test>'
-$ retest 'ruby <test>'
-$ retest 'docker-compose exec web bundle exec rails test <test>'
-
-# Run the same command after a file change like all the spec files
-$ retest 'bundle exec rake test'
-$ retest 'rails test'
-$ retest 'rspec'
-$ retest 'docker-compose exec web bundle exec rails test'
-
-# Hardcode a test file to run independently from the file you change
-$ retest 'ruby all_tests.rb'
+Usage: retest  [OPTIONS] [COMMAND]
+
+Watch a file change and run it matching spec.
+
+Arguments:
+  COMMAND  The test command to rerun when a file changes.
+           Use <test> placeholder to tell retest where to put the matching
+           spec.
+
+
+Options:
+      --all    Run all the specs of a specificied ruby setup
+  -h, --help   Print usage
+      --rails  Shortcut for 'bundle exec rails test <test>'
+      --rake   Shortcut for 'bundle exec rake test TEST=<test>'
+      --rspec  Shortcut for 'bundle exec rspec <test>'
+      --ruby   Shortcut for 'bundle exec ruby <test>'
+
+Examples:
+  Runs a matching rails test after a file change
+    $ retest 'bundle exec rails test <test>'
+    $ retest --rails
+
+  Runs all rails tests after a file change
+    $ retest 'bundle exec rails test'
+    $ retest --rails --all
+
+  Runs a hardcoded command after a file change
+    $ retest 'ruby lib/bottles_test.rb'
 ```
 
 The gem works as follows:
@@ -47,25 +64,23 @@ The gem works as follows:
 * When a test file is changed, retest will run the file test.
 * When multiple matching test files are found, retest asks you to confirm the file and save the answer.
 * When a test file is not found, retest runs the last run command or throw a 404.
-* Works with RSpec, MiniTest, Rake commands & bash commands (not aliases).
-* Works when installed and run in a Docker container.
 
 ### Docker
 
-Installing & launching the gem in a Docker container seems to work
+Retest works in Docker too. You can install the gem and launch retest in your container while refactoring.
 ```bash
-$ docker-compose run web bash
+$ docker-compose run web bash # enter your container
 $ gem install retest
 $ retest 'bundle exec rails test <test>'
 ```
 
-**Disclaimer:**
+### Disclaimer
 * If an error comes in try using `bundle exec` like so: `$ retest 'bundle exec rake test <test>'`
 * Aliases saved on ~/.bashrc or ~/.zshrc cannot be run that way with the `retest` command
 
 ## Ruby Support
 
-Retest supports ruby 2.5 and above.
+Retest supports ruby 2.4 and above.
 
 ## Roadmap
 

data/exe/retest

@@ -4,12 +4,10 @@ require 'retest'
 
 $stdout.sync = true
 
-puts "Launching Retest..."
+options = Retest::Options.new(ARGV)
 
-Retest
-  .build(command: Retest::Command.for(ARGV.join))
-  .start # not blocking
+return puts options.help if options.help?
 
-puts "Ready to refactor! You can make file changes now"
+Retest.start(options.command) # not blocking
 
 sleep

data/lib/retest.rb

@@ -2,20 +2,30 @@ require 'listen'
 require 'string/similarity'
 
 require "retest/version"
-require "retest/command"
+require "retest/runner"
 require "retest/repository"
 require "retest/test_options"
 require "retest/listen_options"
+require "retest/options"
 
 module Retest
   class Error < StandardError; end
 
-  def self.build(command:)
+  def self.start(command)
+    puts "Launching Retest..."
+
+    build(runner: Retest::Runner.for(command))
+      .start
+
+    puts "Ready to refactor! You can make file changes now"
+  end
+
+  def self.build(runner:)
     Listen.to('.', ListenOptions.to_h) do |modified, added, removed|
       begin
         if modified.any?
           system('clear 2>/dev/null') || system('cls 2>/dev/null')
-          command.run(modified.first.strip)
+          runner.run(modified.first.strip)
         end
       rescue => e
         puts "Something went wrong: #{e.message}"

data/lib/retest/options.rb

@@ -0,0 +1,114 @@
+require 'tty-option'
+
+module Retest
+  class Options
+    include TTY::Option
+
+    RSPEC_COMMAND = "bundle exec rspec <test>"
+    RAILS_COMMAND = "bundle exec rails test <test>"
+    RAKE_COMMAND  = "bundle exec rake test TEST=<test>"
+    RUBY_COMMAND  = "bundle exec ruby <test>"
+    NO_COMMAND    = "echo You have no command assigned"
+
+    ALL_RAKE_COMMAND  = "bundle exec rake test"
+    ALL_RAILS_COMMAND = "bundle exec rails test"
+    ALL_RSPEC_COMMAND = "bundle exec rspec"
+
+    usage do
+      program "retest"
+
+      command nil
+
+      desc "Watch a file change and run it matching spec."
+
+      example <<~EOS
+      Runs a matching rails test after a file change
+        $ retest 'bundle exec rails test <test>'
+        $ retest --rails
+      EOS
+
+      example <<~EOS
+      Runs all rails tests after a file change
+        $ retest 'bundle exec rails test'
+        $ retest --rails --all
+      EOS
+
+      example <<~EOS
+      Runs a hardcoded command after a file change
+        $ retest 'ruby lib/bottles_test.rb'
+      EOS
+    end
+
+    argument :command do
+      optional
+      desc <<~EOS
+      The test command to rerun when a file changes.
+      Use <test> placeholder to tell retest where to put the matching spec.
+      EOS
+    end
+
+    flag :all do
+      long "--all"
+      desc "Run all the specs of a specificied ruby setup"
+    end
+
+    flag :help do
+      short "-h"
+      long "--help"
+      desc "Print usage"
+    end
+
+    flag :rspec do
+      long "--rspec"
+      desc "Shortcut for '#{RSPEC_COMMAND}'"
+    end
+
+    flag :rake do
+      long "--rake"
+      desc "Shortcut for '#{RAKE_COMMAND}'"
+    end
+
+    flag :rails do
+      long "--rails"
+      desc "Shortcut for '#{RAILS_COMMAND}'"
+    end
+
+    flag :ruby do
+      long "--ruby"
+      desc "Shortcut for '#{RUBY_COMMAND}'"
+    end
+
+    attr_reader :args
+
+    def self.command(args)
+      new(args).command
+    end
+
+    def initialize(args = [])
+      self.args = args
+    end
+
+    def command
+      if params[:rspec]
+        params[:all] ? ALL_RSPEC_COMMAND : RSPEC_COMMAND
+      elsif params[:rake]
+        params[:all] ? ALL_RAKE_COMMAND : RAKE_COMMAND
+      elsif params[:rails]
+        params[:all] ? ALL_RAILS_COMMAND : RAILS_COMMAND
+      elsif params[:ruby]
+        params[:all] ? NO_COMMAND : RUBY_COMMAND
+      else
+        params[:command] || NO_COMMAND
+      end
+    end
+
+    def args=(args)
+      @args = args
+      parse args
+    end
+
+    def help?
+      params[:help]
+    end
+  end
+end

data/lib/retest/{command.rb → runner.rb}

@@ -1,14 +1,14 @@
 module Retest
-  class Command
+  class Runner
     def self.for(test_command)
       if test_command.include? '<test>'
-        VariableCommand
+        VariableRunner
       else
-        HardcodedCommand
+        HardcodedRunner
       end.new test_command
     end
 
-    class VariableCommand
+    class VariableRunner
       attr_reader :command, :repository, :cached_test_file
 
       def initialize(command, repository: nil)
@@ -37,7 +37,7 @@ module Retest
       end
     end
 
-    HardcodedCommand = Struct.new(:command) do
+    HardcodedRunner = Struct.new(:command) do
       def run(_)
         system command
       end

data/lib/retest/version.rb

@@ -1,3 +1,3 @@
 module Retest
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/retest.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.add_runtime_dependency "string-similarity", ["~> 2.1"]
   spec.add_runtime_dependency "listen", ["~> 3.2"]
+  spec.add_runtime_dependency "tty-option", ["~> 0.1"]
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: retest
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Alexandre Barret
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-18 00:00:00.000000000 Z
+date: 2020-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: string-similarity
@@ -38,7 +38,21 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
-description: 
+- !ruby/object:Gem::Dependency
+  name: tty-option
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description:
 email:
 - alex@abletech.nz
 executables:
@@ -59,9 +73,10 @@ files:
 - bin/setup
 - exe/retest
 - lib/retest.rb
-- lib/retest/command.rb
 - lib/retest/listen_options.rb
+- lib/retest/options.rb
 - lib/retest/repository.rb
+- lib/retest/runner.rb
 - lib/retest/test_options.rb
 - lib/retest/version.rb
 - retest.gemspec
@@ -71,7 +86,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/AlexB52/retest
   source_code_uri: https://github.com/AlexB52/retest
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -87,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A simple command line tool to watch file change and run its matching spec.
 test_files: []