retest 0.8.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e058f016e23d459435e738ff0cf3406d65e39b5a504e19abfe3df6dcc695376
-  data.tar.gz: f8c6039063902c21e3b5917dc768b46abdf599c14368984892ba41624565ede0
+  metadata.gz: 8df33036507fe29259ef99ac9fa574fdece9af4e69911f21125a1c4bbad7778c
+  data.tar.gz: a4bb2606b7373fb304638125be08d94c79a5dfb5e324cbf433848730cf08abe6
 SHA512:
-  metadata.gz: 67b0d493529e376e1a0f439c618f3e0c8f208ad9ba7ea64c023d15d09fbd641f54106d6ece13be8941a586a924285d23e89940da5e271a559ba17286d33c0214
-  data.tar.gz: d880ee6039b6d0f11a6e420df26cf56358ed74291939717bc4e0db51db8c4b6e829e1bceee58af8490a9b506020c57cc0d4cde6fc7cde889691c61c5787a8956
+  metadata.gz: ba3f7823d9789965dbd44d92ac40aeb1f6d3dd9f35f6e634f317949adf72ba672abb231f4603acfe1da2c766d3158da81ca1c538868ab8be8955bfdf443651b0
+  data.tar.gz: 74f1a43fc0b23d48bd9a7cdd53c8a57206cbf9cc3546f1a6d2d0609d7f837744f1f74162ced9f57661f6008237b039f32ba2454289d839314ecfae5bc4ce011f

data/.github/workflows/ci.yml

@@ -46,6 +46,8 @@ jobs:
           - ruby-app
           - rails-app
           - hanami-app
+          - rspec-rails
+          - rspec-ruby
     steps:
       - uses: actions/checkout@v2
       - name: Set up Ruby

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    retest (0.8.2)
+    retest (0.9.0)
       listen (~> 3.2)
       string-similarity (~> 2.1)
       tty-option (~> 0.1)
@@ -10,7 +10,7 @@ GEM
   remote: https://rubygems.org/
   specs:
     byebug (11.1.3)
-    ffi (1.14.2)
+    ffi (1.15.0)
     listen (3.4.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)

data/README.md

@@ -2,29 +2,46 @@
 
 Retest is a small command-line tool to help you refactor code by watching a file change and running its matching spec. Designed to be dev-centric and project independent, it can be used on the fly. No Gemfile updates, no commits to a repo or configuration files required to start refactoring. Works with every Ruby projects (at least that is the end goal)
 
-## Why?
-It is advised to be one `cmd + z` away from green tests when refactoring. This means running tests after every line change. Let Retest rerun your tests after every file change you make.
-
-Retest gem is meant to be simple and follow testing conventions encountered in Ruby projects. Give it a go you can uninstall it easily. If you think the matching pattern could be improved please raise an issue.
-
-For fully fledged solutions, some cli tools already exists: [autotest](https://github.com/grosser/autotest), [guard](https://github.com/guard/guard), [zentest](https://github.com/seattlerb/zentest)
+## Demo
 
 ![demo](https://alexbarret.com/images/external/retest-demo-26bcad04.gif)
 
 ## Installation
 
-Install it on your machine with:
+Install it on your machine without adding it on a Gemfile:
 
     $ gem install retest
-    $ retest 'bundle exec rspec <test>'
 
 ## Usage
 
-Launch `retest` in your terminal after accessing your ruby project folder.
+Launch `retest` in your terminal after accessing your ruby repository.
+
+You can pass the test command surrounded by quotes and use the placeholder `<test>` to tell `retest` where to put test file in your command. Example:
 
-Pass the test command surrounded by quotes. Use the placeholder `<test>` in your command to tell `retest` where to put the path of the test file in your command. Example: `retest 'bundle exec rspec <test>'`. When a file is changed `retest` will find its matching test and run it.
+    $ retest 'bundle exec rspec <test>'
+
+When a file is changed, the gem will find its matching test and run the test command with it. 
+
+Few shortcut flags exist to avoid writing the full test command.
+
+    $ retest --rspec
+    $ retest --rails
+    $ retest --rake --all
+
+Finally let retest automatically find your ruby setup and run the appropriate command using:
 
-Learn more by running `retest -h`
+    $ retest
+    $ retest --auto
+    $ retest --auto --all
+
+The gem works as follows:
+
+* When a file is changed, retest will run its matching test.
+* When a test files is changed, retest will run the test file.
+* 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.
+
+See more example with `retest -h`
 
 ```
 Usage: retest  [OPTIONS] [COMMAND]
@@ -35,10 +52,11 @@ 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
+      --auto   Indentify repository setup and runs appropriate command
   -h, --help   Print usage
       --rails  Shortcut for 'bundle exec rails test <test>'
       --rake   Shortcut for 'bundle exec rake test TEST=<test>'
@@ -56,16 +74,24 @@ Examples:
 
   Runs a hardcoded command after a file change
     $ retest 'ruby lib/bottles_test.rb'
+
+  Let retest identify which command to run
+    $ retest
+    $ retest --auto
+
+  Let retest identify which command to run for all tests
+    $ retest --all
+    $ retest --auto --all
 ```
 
-The gem works as follows:
+## Why?
+It is advised to be one `cmd + z` away from green tests when refactoring. This means running tests after every line change. Let Retest rerun your tests after every file change you make.
 
-* When a file is changed, retest will run its matching file test.
-* 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.
+Retest gem is meant to be simple and follow testing conventions encountered in Ruby projects. Give it a go you can uninstall it easily. If you think the matching pattern could be improved please raise an issue.
+
+For fully fledged solutions, some cli tools already exists: [autotest](https://github.com/grosser/autotest), [guard](https://github.com/guard/guard), [zentest](https://github.com/seattlerb/zentest)
 
-### Docker
+## Docker
 
 Retest works in Docker too. You can install the gem and launch retest in your container while refactoring.
 ```bash
@@ -74,7 +100,7 @@ $ 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
 
@@ -93,8 +119,6 @@ Retest supports ruby 2.4 and above.
   - [x] Rails
   - [x] Ad-hoc scripts
   - [x] Hanami
-  - [ ] Sinatra
-  - [ ] Cuba? Padrino?
 - [ ] Handle other languages: Elixir, Node, Python, PHP
 - [ ] Aliases from oh-my-zsh and bash profiles?
 

data/bin/debug

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "retest"
+require "byebug"
+
+$stdout.sync = true
+
+options = Retest::Options.new(ARGV)
+
+if options.help?
+  $stdout.puts options.help
+  return
+end
+
+Retest.start(options.command) # not blocking
+
+sleep

data/bin/test/hanami-app

@@ -3,4 +3,6 @@
 bundle install
 bundle exec rake build
 ls -t pkg | head -n1 | xargs -I {} mv pkg/{} features/hanami-app/retest.gem
-docker-compose -f features/hanami-app/docker-compose.yml up --build
+docker-compose -f features/hanami-app/docker-compose.yml build
+docker-compose -f features/hanami-app/docker-compose.yml run retest sh bin/test_setup
+docker-compose -f features/hanami-app/docker-compose.yml up --exit-code-from retest

data/bin/test/rails-app

@@ -3,4 +3,4 @@
 bundle install
 bundle exec rake build
 ls -t pkg | head -n1 | xargs -I {} mv pkg/{} features/rails-app/retest.gem
-docker-compose -f features/rails-app/docker-compose.yml up --build
+docker-compose -f features/rails-app/docker-compose.yml up --build --exit-code-from retest

data/bin/test/rspec-rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+bundle install
+bundle exec rake build
+ls -t pkg | head -n1 | xargs -I {} mv pkg/{} features/rspec-rails/retest.gem
+docker-compose -f features/rspec-rails/docker-compose.yml up --build --exit-code-from retest

data/bin/test/rspec-ruby

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+bundle install
+bundle exec rake build
+ls -t pkg | head -n1 | xargs -I {} mv pkg/{} features/rspec-ruby/retest.gem
+docker-compose -f features/rspec-ruby/docker-compose.yml up --build --exit-code-from retest

data/bin/test/ruby-app

@@ -3,4 +3,4 @@
 bundle install
 bundle exec rake build
 ls -t pkg | head -n1 | xargs -I {} mv pkg/{} features/ruby-app/retest.gem
-docker-compose -f features/ruby-app/docker-compose.yml up --build
+docker-compose -f features/ruby-app/docker-compose.yml up --build --exit-code-from retest

data/lib/retest.rb

@@ -7,6 +7,7 @@ require "retest/repository"
 require "retest/test_options"
 require "retest/options"
 require "retest/version_control"
+require "retest/setup"
 
 module Retest
   class Error < StandardError; end

data/lib/retest/options.rb

@@ -8,7 +8,6 @@ module Retest
     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"
@@ -37,6 +36,18 @@ module Retest
       Runs a hardcoded command after a file change
         $ retest 'ruby lib/bottles_test.rb'
       EOS
+
+      example <<~EOS
+      Let retest identify which command to run
+        $ retest
+        $ retest --auto
+      EOS
+
+      example <<~EOS
+      Let retest identify which command to run for all tests
+        $ retest --all
+        $ retest --auto --all
+      EOS
     end
 
     argument :command do
@@ -52,6 +63,11 @@ module Retest
       desc "Run all the specs of a specificied ruby setup"
     end
 
+    flag :auto do
+      long "--auto"
+      desc "Indentify repository setup and runs appropriate command"
+    end
+
     flag :help do
       short "-h"
       long "--help"
@@ -84,21 +100,21 @@ module Retest
       new(args).command
     end
 
-    def initialize(args = [])
+    def initialize(args = [], output_stream: STDOUT, setup: Setup)
       self.args = args
+      @output_stream = output_stream
+      @setup = setup
     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
+      return params[:command] if params[:command]
+
+      if    params[:rspec] then rspec_command
+      elsif params[:rake]  then rake_command
+      elsif params[:rails] then rails_command
+      elsif params[:ruby]  then ruby_command
+      elsif params[:auto]  then default_command
+      else                      default_command
       end
     end
 
@@ -110,5 +126,46 @@ module Retest
     def help?
       params[:help]
     end
+
+    private
+
+    def full_suite?
+      params[:all]
+    end
+
+    def default_command
+      choose_command @setup.type, command_for(@setup.type)
+    end
+
+    def command_for(type)
+      case type
+      when :rspec then rspec_command
+      when :rails then rails_command
+      when :rake  then rake_command
+      when :ruby  then ruby_command
+      else             ruby_command
+      end
+    end
+
+    def choose_command(type, command)
+      @output_stream.puts "Setup identified: [#{type.upcase}]. Using command: '#{command}'"
+      command
+    end
+
+    def rspec_command
+      full_suite? ? ALL_RSPEC_COMMAND : RSPEC_COMMAND
+    end
+
+    def rails_command
+      full_suite? ? ALL_RAILS_COMMAND : RAILS_COMMAND
+    end
+
+    def rake_command
+      full_suite? ? ALL_RAKE_COMMAND : RAKE_COMMAND
+    end
+
+    def ruby_command
+      RUBY_COMMAND
+    end
   end
 end

data/lib/retest/repository.rb

@@ -17,14 +17,14 @@ module Retest
     end
 
     def add(added)
-      return if added && added.empty?
+      return if added&.empty?
 
       files.push(*added)
       files.sort!
     end
 
     def remove(removed)
-      return if removed && removed.empty?
+      return if removed&.empty?
 
       if removed.is_a?(Array)
         removed.each { |file| files.delete(file) }

data/lib/retest/setup.rb

@@ -0,0 +1,45 @@
+module Retest
+  class Setup
+    def self.type
+      new.type
+    end
+
+    def type
+      @type ||= begin
+        return :ruby unless has_gemfile?
+
+        if rspec?
+          :rspec
+        elsif rails?
+          :rails
+        elsif rake?
+          :rake
+        else
+          :ruby
+        end
+      end
+    end
+
+    private
+
+    def has_gemfile?
+      File.exist? 'Gemfile'
+    end
+
+    def rspec?
+      has_gem? 'rspec'
+    end
+
+    def rails?
+      File.exist? 'bin/rails'
+    end
+
+    def rake?
+      has_gem? 'rake'
+    end
+
+    def has_gem?(gem_name)
+      !`cat Gemfile | grep #{gem_name}`.empty?
+    end
+  end
+end

data/lib/retest/version.rb

@@ -1,3 +1,3 @@
 module Retest
-  VERSION = "0.8.2"
+  VERSION = "0.9.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: retest
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.9.0
 platform: ruby
 authors:
 - Alexandre Barret
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-11 00:00:00.000000000 Z
+date: 2021-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: string-similarity
@@ -70,15 +70,19 @@ files:
 - README/demo.gif
 - Rakefile
 - bin/console
+- bin/debug
 - bin/setup
 - bin/test/hanami-app
 - bin/test/rails-app
+- bin/test/rspec-rails
+- bin/test/rspec-ruby
 - bin/test/ruby-app
 - exe/retest
 - lib/retest.rb
 - lib/retest/options.rb
 - lib/retest/repository.rb
 - lib/retest/runner.rb
+- lib/retest/setup.rb
 - lib/retest/test_options.rb
 - lib/retest/version.rb
 - lib/retest/version_control.rb