retest 1.1.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7cec5f35b345630339ca56cfd0c1bc88be03596ca4d8369695f2e87f66e7c608
-  data.tar.gz: db0b1f966bb2ebe14183e17e93003c0d504881dc2a7d8fe2614f5c202b0fcf55
+  metadata.gz: 5c5dc87b26d27197158d859e17e179f9dc0b00ec2280dfefff165da388c77eb6
+  data.tar.gz: cffbfbf72ea1b51e7f63e288fba08727498ec582192536a54ad9d2b47f04d1d2
 SHA512:
-  metadata.gz: 2b191a17f73446b41fd5fdf9bc7495f4ea0535c05681e1d14e191cb62f6cadc83d09454ad501fc98ce503db6a169b628b6d205328ca4a236ddf56bbc75d78bff
-  data.tar.gz: e1089b2d8c64c380c2fd08935f8b0ded1dee4ccb2f265ff20c6f12eeea91942ef0e4c9a6a154b48a270a4c3281fa2e3edf981925f50c6767c98a2bbcbd1cd6f3
+  metadata.gz: ad4051278ba14ff9f7284de5f8f643bdec7512864bb330aac803f6e3c672cc24f5584eb4b26be9f4a2b533a229fd5366a0eece8b4aa53eb816ff3e9c6575f200
+  data.tar.gz: 3b52308adcef24e6098f40ee07d55848f39104838c4db404394ee33a8ffe38466478cd18f347aa73b3a0072fc0c263592a9eecf1ed98e459345be160c02ed30f

data/.github/workflows/ci.yml

@@ -44,11 +44,12 @@ jobs:
       matrix:
         repo:
           - ruby-app
-          - rails-app
+          - ruby-bare
+          - git-ruby
           - hanami-app
+          - rails-app
           - rspec-rails
           - rspec-ruby
-          - git-ruby
     steps:
       - uses: actions/checkout@v2
       - name: Set up Ruby

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    retest (1.1.0)
+    retest (1.4.0)
       listen (~> 3.2)
       string-similarity (~> 2.1)
       tty-option (~> 0.1)
@@ -10,17 +10,17 @@ GEM
   remote: https://rubygems.org/
   specs:
     byebug (11.1.3)
-    ffi (1.15.0)
-    listen (3.5.0)
+    ffi (1.15.4)
+    listen (3.7.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     minitest (5.14.1)
     rake (12.3.3)
-    rb-fsevent (0.10.4)
+    rb-fsevent (0.11.0)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     string-similarity (2.1.0)
-    tty-option (0.1.0)
+    tty-option (0.2.0)
 
 PLATFORMS
   ruby

data/README.md

@@ -1,3 +1,5 @@
+[![Gem Version](https://badge.fury.io/rb/retest.svg)](https://badge.fury.io/rb/retest)
+
 # Retest
 
 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)
@@ -14,13 +16,37 @@ Install it on your machine without adding it on a Gemfile:
 
 ## Usage
 
-Launch `retest` in your terminal after accessing your ruby repository.
+Retest is used in your terminal after accessing your ruby project folder.
+
+### Help
+
+Find out what retest can do anytime with
+
+    $ retest -h
+
+### For Refactoring
+
+#### 1. Run a hardcoded command
+
+This the most simple usage of retest: running the same command over and over after each file update.
 
-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:
+Example:
 
-    $ retest 'bundle exec rspec <test>'
+    $ retest 'bundle exec rspec spec/features/posts_spec.rb'
 
-When a file is changed, the gem will find its matching test and run the test command with it. 
+In this example, the feature spec `spec/features/posts_spec.rb` will be tested after any ruby file is updated.
+
+#### 2. Run a dynamic command
+
+You can use the placeholder `<test>` to tell the gem where to put the test file path in your command. When a file is changed, the gem will find its matching test and run the test command with it.
+
+Example:
+
+    $ retest 'bin/rails test <test>'
+ 
+In this example, if `app/models/post.rb` is changed then retest will run `bin/rails test test/models/post_test.rb`
+
+#### 3. Run a dynamic command with shortcuts
 
 Few shortcut flags exist to avoid writing the full test command.
 
@@ -28,65 +54,29 @@ Few shortcut flags exist to avoid writing the full test command.
     $ retest --rails
     $ retest --rake --all
 
-Finally let retest automatically find your ruby setup and run the appropriate command using:
+#### 4. Let retest figure it all out
+
+Let retest find your ruby setup and run the appropriate command using:
 
     $ retest
-    $ retest --auto
-    $ retest --auto --all
+    $ retest --all
+
+#### Running rules
 
 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 a **ruby file** is changed, retest will run its matching test.
+* When a **test file** 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`
+### Pull request scans
 
-```
-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
-      --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>'
-      --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
+You can diff a branch and test all the relevant test files before pushing your branch and trigger a full CI suite. 
 
-  Runs all rails tests after a file change
-    $ retest 'bundle exec rails test'
-    $ retest --rails --all
+    $ retest --diff origin/main
 
-  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
-
-  Run a sanity check on changed files from a branch
-    $ retest --diff origin/main --rails
-    $ retest --diff main --auto
-```
+In this example, retest lists all the files changed between `HEAD` and `origin/main`, finds all the relevant tests and only run those.
 
 ## 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.
@@ -98,8 +88,12 @@ For fully fledged solutions, some cli tools already exists: [autotest](https://g
 ## Docker
 
 Retest works in Docker too. You can install the gem and launch retest in your container while refactoring.
+
 ```bash
-$ docker-compose run web bash # enter your container
+# Enter your container. Ex:
+$ docker-compose run web bash
+
+# Install the gem and run retest in your container shell
 $ gem install retest
 $ retest 'bundle exec rails test <test>'
 ```
@@ -118,12 +112,13 @@ Retest supports ruby 2.4 and above.
 - [x] When multiple test files are found, ask which file to run and save the answer.
 - [x] When a test file is not found run the last command again.
 - [x] Run within Docker.
-- [ ] Handle main Ruby setups
+- [x] Handle main Ruby setups
   - [x] Bundler Gem
   - [x] Rails
   - [x] Ad-hoc scripts
   - [x] Hanami
-- [ ] Handle other languages: Elixir, Node, Python, PHP
+- [ ] Handle other languages: Go, Elixir, Node, Python, PHP
+  - [ ] Go (project started)
 - [ ] Aliases from oh-my-zsh and bash profiles?
 
 ## Development
@@ -136,7 +131,6 @@ To run integration tests on one setup (ex: hanami-app): `bin/test/hanami-app`
 
 To access an app container (ex: ruby-app): `docker-compose -f features/ruby-app/docker-compose.yml run retest sh`
 
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/alexb52/retest.

data/bin/debug

@@ -13,9 +13,15 @@ if options.help?
   return
 end
 
+repository = Retest::Repository.new(files: Retest::VersionControl.files)
+command    = Retest::Command.for_options(options)
+runner     = Retest::Runner.for(command.to_s)
+
 program = Retest::Program.new(
-  repository: Retest::Repository.new(files: Retest::VersionControl.files),
-  runner: Retest::Runner.for(Retest::Command.for_options(options))
+  extension: options.extension,
+  repository: repository,
+  command: command,
+  runner: runner
 )
 
 if options.params[:diff]

data/bin/test/ruby-bare

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

data/exe/retest

@@ -11,9 +11,15 @@ if options.help?
   return
 end
 
+repository = Retest::Repository.new(files: Retest::VersionControl.files)
+command    = Retest::Command.for_options(options)
+runner     = Retest::Runner.for(command.to_s)
+
 program = Retest::Program.new(
-  repository: Retest::Repository.new(files: Retest::VersionControl.files),
-  runner: Retest::Runner.for(Retest::Command.for_options(options))
+  extension: options.extension,
+  repository: repository,
+  command: command,
+  runner: runner
 )
 
 if options.params[:diff]

data/lib/retest/command/rails.rb

@@ -1,22 +1,29 @@
 module Retest
   class Command
-    Rails = Struct.new(:all, :bin_file) do
-      def self.command(all:, bin_file: File.exist?('bin/rails'))
-        new(all, bin_file).command
+    class Rails
+      attr_reader :all, :file_system
+
+      def initialize(all:, file_system: FileSystem)
+        @file_system = file_system
+        @all = all
       end
 
-      def command
+      def to_s
         return "#{root_command} <test>" unless all
         root_command
       end
 
+      def run_all(*files, runner:)
+        runner.run files.join(' ')
+      end
+
       private
 
       def root_command
-        return 'bin/rails test' if bin_file
+        return 'bin/rails test' if file_system.exist? 'bin/rails'
 
         'bundle exec rails test'
       end
     end
   end
-end
+end

data/lib/retest/command/rake.rb

@@ -1,22 +1,29 @@
 module Retest
   class Command
-    Rake = Struct.new(:all, :bin_file) do
-      def self.command(all:, bin_file: File.exist?('bin/rake'))
-        new(all, bin_file).command
+    class Rake
+      attr_reader :all, :file_system
+
+      def initialize(all:, file_system: FileSystem)
+        @file_system = file_system
+        @all = all
       end
 
-      def command
+      def to_s
         return "#{root_command} TEST=<test>" unless all
         root_command
       end
 
+      def run_all(*files, runner:)
+        runner.run files.size > 1 ? "\"{#{files.join(',')}}\"" : files.first
+      end
+
       private
 
       def root_command
-        return 'bin/rake test' if bin_file
+        return 'bin/rake test' if file_system.exist? 'bin/rake'
 
         'bundle exec rake test'
       end
     end
   end
-end
+end

data/lib/retest/command/rspec.rb

@@ -1,19 +1,26 @@
 module Retest
   class Command
-    Rspec = Struct.new(:all, :bin_file) do
-      def self.command(all:, bin_file: File.exist?('bin/rspec'))
-        new(all, bin_file).command
+    class Rspec
+      attr_reader :all, :file_system
+
+      def initialize(all:, file_system: FileSystem)
+        @file_system = file_system
+        @all = all
       end
 
-      def command
+      def to_s
         return "#{root_command} <test>" unless all
         root_command
       end
 
+      def run_all(*files, runner:)
+        runner.run files.join(' ')
+      end
+
       private
 
       def root_command
-        return 'bin/rspec' if bin_file
+        return 'bin/rspec' if file_system.exist? 'bin/rspec'
 
         'bundle exec rspec'
       end

data/lib/retest/command/ruby.rb

@@ -1,12 +1,24 @@
 module Retest
   class Command
-    Ruby = Struct.new(:all, :bin_file) do
-      def self.command(all: false, bin_file: false)
-        new(false, false).command
+    class Ruby
+      attr_reader :all, :file_system
+
+      def initialize(all:, file_system: FileSystem)
+        @file_system = file_system
+        @all = all
+      end
+
+      def run_all(*files, runner:)
+        paths = files.map { |file| "require './#{file}';" }.join
+        runner.run %Q{-e "#{paths}"}
       end
 
-      def command
-        'bundle exec ruby <test>'
+      def to_s
+        if file_system.exist? 'Gemfile.lock'
+          'bundle exec ruby <test>'
+        else
+          'ruby <test>'
+        end
       end
     end
   end

data/lib/retest/command.rb

@@ -59,19 +59,19 @@ module Retest
     private
 
     def rspec_command
-      Rspec.command(all: full_suite?)
+      Rspec.new(all: full_suite?)
     end
 
     def rails_command
-      Rails.command(all: full_suite?)
+      Rails.new(all: full_suite?)
     end
 
     def rake_command
-      Rake.command(all: full_suite?)
+      Rake.new(all: full_suite?)
     end
 
     def ruby_command
-      Ruby.command(all: full_suite?)
+      Ruby.new(all: full_suite?)
     end
   end
 end

data/lib/retest/file_system.rb

@@ -0,0 +1,9 @@
+module Retest
+  module FileSystem
+    module_function
+
+    def exist?(value)
+      File.exist? value
+    end
+  end
+end

data/lib/retest/options.rb

@@ -4,15 +4,6 @@ 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>"
-
-    ALL_RAKE_COMMAND  = "bundle exec rake test"
-    ALL_RAILS_COMMAND = "bundle exec rails test"
-    ALL_RSPEC_COMMAND = "bundle exec rspec"
-
     usage do
       program "retest"
 
@@ -69,6 +60,12 @@ module Retest
       long "--diff=git-branch"
     end
 
+    option :ext do
+      desc "Regex of file extensions to listen to"
+      long "--ext=regex"
+      default "\\.rb$"
+    end
+
     flag :all do
       long "--all"
       desc "Run all the specs of a specificied ruby setup"
@@ -87,22 +84,22 @@ module Retest
 
     flag :rspec do
       long "--rspec"
-      desc "Shortcut for '#{RSPEC_COMMAND}'"
+      desc "Shortcut for a standard RSpec setup"
     end
 
     flag :rake do
       long "--rake"
-      desc "Shortcut for '#{RAKE_COMMAND}'"
+      desc "Shortcut for a standard Rake setup"
     end
 
     flag :rails do
       long "--rails"
-      desc "Shortcut for '#{RAILS_COMMAND}'"
+      desc "Shortcut for a standard Rails setup"
     end
 
     flag :ruby do
       long "--ruby"
-      desc "Shortcut for '#{RUBY_COMMAND}'"
+      desc "Shortcut for a Ruby project"
     end
 
     attr_reader :args
@@ -133,10 +130,14 @@ module Retest
       params[:auto]
     end
 
+    def extension
+      Regexp.new(params[:ext])
+    end
+
     private
 
     def no_options_passed?
-      params.to_h.values.compact.uniq == [false]
+      params.to_h.values.compact.uniq == ["\\.rb$", false]
     end
   end
 end

data/lib/retest/program.rb

@@ -0,0 +1,49 @@
+module Retest
+  class Program
+    attr_accessor :runner, :repository, :command, :extension
+    def initialize(runner: nil, repository: nil, command: nil, extension: /\.rb$/)
+      @runner = runner
+      @repository = repository
+      @command = command
+      @extension = extension
+    end
+
+    def start
+      puts "Launching Retest..."
+      build.start
+      puts "Ready to refactor! You can make file changes now"
+    end
+
+    def diff(branch)
+      raise "Git not installed" unless VersionControl::Git.installed?
+      test_files = repository.find_tests VersionControl::Git.diff_files(branch)
+
+      puts "Tests found:"
+      test_files.each { |test_file| puts "  - #{test_file}" }
+
+      puts "Running tests..."
+      command.run_all *test_files, runner: runner
+    end
+
+    private
+
+    def build
+      Listen.to('.', only: extension, relative: true) do |modified, added, removed|
+        begin
+          repository.add(added)
+          repository.remove(removed)
+          runner.remove(removed)
+          system('clear 2>/dev/null') || system('cls 2>/dev/null')
+
+          runner.run test_file_to_run(modified + added)
+        rescue => e
+          puts "Something went wrong: #{e.message}"
+        end
+      end
+    end
+
+    def test_file_to_run(changed_files)
+      repository.find_test changed_files.first if runner.matching?
+    end
+  end
+end

data/lib/retest/runner.rb

@@ -17,7 +17,7 @@ module Retest
       end
 
       def ==(obj)
-        command == obj.command
+        command == obj.command && obj.class == self.class
       end
 
       def cached_test_file

data/lib/retest/version.rb

@@ -1,3 +1,3 @@
 module Retest
-  VERSION = "1.1.0"
+  VERSION = "1.4.0"
 end

data/lib/retest.rb

@@ -9,53 +9,9 @@ require "retest/options"
 require "retest/version_control"
 require "retest/setup"
 require "retest/command"
+require "retest/file_system"
+require "retest/program"
 
 module Retest
   class Error < StandardError; end
-
-  class Program
-    attr_accessor :runner, :repository
-    def initialize(runner: nil, repository: nil)
-      @runner = runner
-      @repository = repository
-    end
-
-    def start
-      puts "Launching Retest..."
-      build.start
-      puts "Ready to refactor! You can make file changes now"
-    end
-
-    def diff(branch)
-      raise "Git not installed" unless VersionControl::Git.installed?
-      test_files = repository.find_tests VersionControl::Git.diff_files(branch)
-
-      puts "Tests found:"
-      test_files.each { |test_file| puts "  - #{test_file}" }
-
-      puts "Running tests..."
-      test_files.each { |test_file| runner.run test_file }
-    end
-
-    private
-
-    def build
-      Listen.to('.', only: /\.rb$/, relative: true) do |modified, added, removed|
-        begin
-          repository.add(added)
-          repository.remove(removed)
-          runner.remove(removed)
-          system('clear 2>/dev/null') || system('cls 2>/dev/null')
-
-          runner.run test_file_to_run(modified + added)
-        rescue => e
-          puts "Something went wrong: #{e.message}"
-        end
-      end
-    end
-
-    def test_file_to_run(changed_files)
-      repository.find_test changed_files.first if runner.matching?
-    end
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: retest
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Alexandre Barret
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-27 00:00:00.000000000 Z
+date: 2021-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: string-similarity
@@ -78,6 +78,7 @@ files:
 - bin/test/rspec-rails
 - bin/test/rspec-ruby
 - bin/test/ruby-app
+- bin/test/ruby-bare
 - exe/retest
 - lib/retest.rb
 - lib/retest/command.rb
@@ -85,7 +86,9 @@ files:
 - lib/retest/command/rake.rb
 - lib/retest/command/rspec.rb
 - lib/retest/command/ruby.rb
+- lib/retest/file_system.rb
 - lib/retest/options.rb
+- lib/retest/program.rb
 - lib/retest/repository.rb
 - lib/retest/runner.rb
 - lib/retest/setup.rb