retest 1.3.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4d1cb4047340b37f649a2348b98d8fac480169a09f6276a622ddd97d6a2439b
-  data.tar.gz: b08fa7303144c4385a45c0b3e38de202ccd9758703d97641262efbc242def2e8
+  metadata.gz: 357f54e47d0b81d02f32e097cc6a0ed43b850a144bd3d368cd1a29d8d7db9b8a
+  data.tar.gz: e60ae5e97ffb0a75a4c75792d0ff04e8d79a3daab5ad8eaf30a300ce6ad0a858
 SHA512:
-  metadata.gz: e75eacbeea65ef118e764a4585b373cd30a0c1742763c00b8de9d896a8b83ef8cae27a7b54e3e07704692188b3d3efc6f25dd7d1471dcebaa36916d369a7f10f
-  data.tar.gz: bda74a90e34abd34e5d6dddac26faade5c2a3850a9cea456a4589e97096db880e3c7a8ed2ece1e1ec9174ee9ea0af4e8388173928b74b77dd4074b84efcd916f
+  metadata.gz: c33d9188ecedb9b19b73b9bd0c0f7e88096d94101aa1e213dae692c6e1fe6b431f081fa7da19fcadaef1fc8984e7e7167e7f0ea269fc055a0d773afa228d6c19
+  data.tar.gz: 3901346f228ce16d193407fcd47cabadad28989e5d32c4d89d59bbf3344871021033b340663d634e1b3dc4478dc7e479be7351a7a7b546ba914b7de06add19c3

data/.github/workflows/ci.yml

@@ -23,6 +23,8 @@ jobs:
           - 2.5
           - 2.6
           - 2.7
+          - '3.0'
+          - 3.1
         include:
           - os: macos-latest
             ruby: 2.5

data/.ruby-version

@@ -1 +1 @@
-2.6.6
+2.7.5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    retest (1.3.0)
+    retest (1.6.0)
       listen (~> 3.2)
       string-similarity (~> 2.1)
       tty-option (~> 0.1)
@@ -10,13 +10,13 @@ GEM
   remote: https://rubygems.org/
   specs:
     byebug (11.1.3)
-    ffi (1.15.3)
-    listen (3.6.0)
+    ffi (1.15.5)
+    listen (3.7.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    minitest (5.14.1)
+    minitest (5.15.0)
     rake (12.3.3)
-    rb-fsevent (0.11.0)
+    rb-fsevent (0.11.1)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     string-similarity (2.1.0)

data/README.md

@@ -6,7 +6,8 @@ Retest is a small command-line tool to help you refactor code by watching a file
 
 ## Demo
 
-![demo](https://alexbarret.com/images/external/retest-demo-26bcad04.gif)
+
+https://user-images.githubusercontent.com/7149034/153734043-1d136f27-5c24-4676-868b-0fde76016b13.mp4
 
 ## Installation
 
@@ -15,15 +16,52 @@ Install it on your machine without adding it on a Gemfile:
     $ gem install retest
 
 ## Usage
-### Refactoring
 
-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.
+
+Example:
 
-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:
+    $ retest 'bundle exec rspec spec/features/posts_spec.rb'
 
-    $ retest 'bundle exec rspec <test>'
+In this example, the feature spec `spec/features/posts_spec.rb` will be tested after any ruby file is updated.
 
-When a file is changed, the gem will find its matching test and run the test command with it. 
+#### 2. Run a dynamic command with placeholders
+
+Retest provides few placeholders to help you run a command after every file change. The placeholders can be used on their own or together.
+
+1. `<test>` placeholder 
+
+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`
+    
+2. `<changed>` placeholder
+    
+You can use the placeholder `<changed>` to tell the gem where to put the changed file path in your command. When a file is changed, the gem will run the command with it.
+
+Example:
+
+    $ retest 'rubocop <changed>'
+ 
+In this example, if `app/models/post.rb` is changed then retest will run `rubocop app/models/post.rb`  
+
+#### 3. Run a dynamic command with shortcuts
 
 Few shortcut flags exist to avoid writing the full test command.
 
@@ -31,75 +69,29 @@ Few shortcut flags exist to avoid writing the full test command.
     $ retest --rails
     $ retest --rake --all
 
-Or let retest 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 --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.
 
-### Diff Check
+### Pull request scans
 
-You can diff a branch and test all the relevant test files before pushing your branch and trigger the full CI suite. 
+You can diff a branch and test all the relevant test files before pushing your branch and trigger a full CI suite. 
 
     $ retest --diff origin/main
 
-### Help
-
-See more examples with `retest -h`
-
-```
-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
-      --diff=git-branch  Pipes all matching tests from diffed branch to test
-                         command
-  -h, --help             Print usage
-      --rails            Shortcut for a standard Rails setup
-      --rake             Shortcut for a standard Rake setup
-      --rspec            Shortcut for a standard RSpec setup
-      --ruby             Shortcut for a Ruby project
-
-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'
-
-  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.
@@ -111,8 +103,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>'
 ```
@@ -131,12 +127,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
@@ -149,7 +146,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

@@ -15,9 +15,14 @@ end
 
 repository = Retest::Repository.new(files: Retest::VersionControl.files)
 command    = Retest::Command.for_options(options)
-runner     = Retest::Runner.for(command.to_s)
+runner     = Retest::Runners.runner_for(command.to_s)
+sounds     = Retest::Sounds.for(options)
+
+sounds.play(:tests_pass)
+runner.add_observer(sounds)
 
 program = Retest::Program.new(
+  extension: options.extension,
   repository: repository,
   command: command,
   runner: runner

data/exe/retest

@@ -13,9 +13,14 @@ end
 
 repository = Retest::Repository.new(files: Retest::VersionControl.files)
 command    = Retest::Command.for_options(options)
-runner     = Retest::Runner.for(command.to_s)
+runner     = Retest::Runners.runner_for(command.to_s)
+sounds     = Retest::Sounds.for(options)
+
+sounds.play(:tests_pass)
+runner.add_observer(sounds)
 
 program = Retest::Program.new(
+  extension: options.extension,
   repository: repository,
   command: command,
   runner: runner

data/lib/retest/command/rails.rb

@@ -13,8 +13,8 @@ module Retest
         root_command
       end
 
-      def run_all(*files, runner:)
-        runner.run files.join(' ')
+      def format_batch(*files)
+        files.join(' ')
       end
 
       private

data/lib/retest/command/rake.rb

@@ -13,8 +13,8 @@ module Retest
         root_command
       end
 
-      def run_all(*files, runner:)
-        runner.run files.size > 1 ? "\"{#{files.join(',')}}\"" : files.first
+      def format_batch(*files)
+        files.size > 1 ? "\"{#{files.join(',')}}\"" : files.first
       end
 
       private

data/lib/retest/command/rspec.rb

@@ -13,8 +13,8 @@ module Retest
         root_command
       end
 
-      def run_all(*files, runner:)
-        runner.run files.join(' ')
+      def format_batch(*files)
+        files.join(' ')
       end
 
       private

data/lib/retest/command/ruby.rb

@@ -8,9 +8,8 @@ module Retest
         @all = all
       end
 
-      def run_all(*files, runner:)
-        paths = files.map { |file| "require './#{file}';" }.join
-        runner.run %Q{-e "#{paths}"}
+      def format_batch(*files)
+        %Q{-e "#{files.map { |file| "require './#{file}';" }.join}"}
       end
 
       def to_s

data/lib/retest/options.rb

@@ -60,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"
@@ -70,6 +76,11 @@ module Retest
       desc "Indentify repository setup and runs appropriate command"
     end
 
+    flag :notify do
+      long "--notify"
+      desc "Play a sound when specs pass or fail (macOS only)"
+    end
+
     flag :help do
       short "-h"
       long "--help"
@@ -124,10 +135,18 @@ module Retest
       params[:auto]
     end
 
+    def notify?
+      params[:notify]
+    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

@@ -1,10 +1,11 @@
 module Retest
   class Program
-    attr_accessor :runner, :repository, :command
-    def initialize(runner: nil, repository: nil, command: nil)
+    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
@@ -21,28 +22,23 @@ module Retest
       test_files.each { |test_file| puts "  - #{test_file}" }
 
       puts "Running tests..."
-      command.run_all *test_files, runner: runner
+      runner.run_all_tests command.format_batch(test_files)
     end
 
     private
 
     def build
-      Listen.to('.', only: /\.rb$/, relative: true) do |modified, added, removed|
+      Listen.to('.', only: extension, relative: true) do |modified, added, removed|
         begin
-          repository.add(added)
-          repository.remove(removed)
-          runner.remove(removed)
+          repository.sync(added: added, removed: removed)
+          runner.sync(added: added, removed: removed)
           system('clear 2>/dev/null') || system('cls 2>/dev/null')
 
-          runner.run test_file_to_run(modified + added)
+          runner.run (modified + added).first, repository: repository
         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/repository.rb

@@ -26,6 +26,11 @@ module Retest
         .sort
     end
 
+    def sync(added:, removed:)
+      add(added)
+      remove(removed)
+    end
+
     def add(added)
       return if added&.empty?
 
@@ -56,7 +61,7 @@ module Retest
     end
 
     def ask_question(tests)
-      output_stream.puts <<~QUESTION
+      output_stream.puts(<<~QUESTION)
         We found few tests matching: #{@path}
         #{list_options(tests)}
 

data/lib/retest/runners/change_runner.rb

@@ -0,0 +1,17 @@
+module Retest
+  module Runners
+    class ChangeRunner < Runner
+      def run(changed_file = nil, repository: nil)
+        if changed_file
+          puts "Changed File Selected: #{changed_file}"
+          system_run command.gsub('<changed>', changed_file)
+        else
+          puts <<~ERROR
+            404 - Test File Not Found
+            Retest could not find a changed file to run.
+          ERROR
+        end
+      end
+    end
+  end
+end

data/lib/retest/runners/runner.rb

@@ -0,0 +1,36 @@
+module Retest
+  module Runners
+    class Runner
+      include Observable
+
+      attr_accessor :command
+      def initialize(command)
+        @command = command
+      end
+
+      def ==(obj)
+        command == obj.command && obj.class == self.class
+      end
+
+      def run(changed_file = nil, repository: nil)
+        system_run command
+      end
+
+      def run_all_tests(tests_string)
+        puts "Test File Selected: #{tests_string}"
+        system_run command.gsub('<test>', tests_string)
+      end
+
+      def sync(added:, removed:)
+      end
+
+      private
+
+      def system_run(command)
+        result = system(command) ? :tests_pass : :tests_fail
+        changed
+        notify_observers(result)
+      end
+    end
+  end
+end

data/lib/retest/runners/test_runner.rb

@@ -0,0 +1,47 @@
+module Retest
+  module Runners
+    class TestRunner < Runner
+      def cached_test_file
+        @cached_test_file
+      end
+
+      def cached_test_file=(value)
+        @cached_test_file = value || @cached_test_file
+      end
+
+      def run(changed_file, repository:)
+        self.cached_test_file = repository.find_test(changed_file)
+
+        if cached_test_file
+          puts "Test File Selected: #{cached_test_file}"
+          system_run command.gsub('<test>', cached_test_file)
+        else
+          puts <<~ERROR
+            404 - Test File Not Found
+            Retest could not find a matching test file to run.
+          ERROR
+        end
+      end
+
+      def sync(added:, removed:)
+        remove(removed)
+      end
+
+      private
+
+      def remove(purged)
+        return if purged.empty?
+
+        if purged.is_a? Array
+          purge_cache if purged.include? cached_test_file
+        elsif purged.is_a? String
+          purge_cache if purged == cached_test_file
+        end
+      end
+
+      def purge_cache
+        @cached_test_file = nil
+      end
+    end
+  end
+end

data/lib/retest/runners/variable_runner.rb

@@ -0,0 +1,57 @@
+module Retest
+  module Runners
+    class VariableRunner < Runner
+      def cached_test_file
+        @cached_test_file
+      end
+
+      def cached_test_file=(value)
+        @cached_test_file = value || @cached_test_file
+      end
+
+      def run(changed_file, repository:)
+        self.cached_test_file = repository.find_test(changed_file)
+
+        return print_test_file_not_found unless cached_test_file
+
+        puts(<<~FILES)
+          Files Selected:
+            - file: #{changed_file}
+            - test: #{cached_test_file}
+
+        FILES
+
+        system_run command
+          .gsub('<test>', cached_test_file)
+          .gsub('<changed>', changed_file)
+      end
+
+      def sync(added:, removed:)
+        remove(removed)
+      end
+
+      private
+
+      def print_test_file_not_found
+        puts <<~ERROR
+          404 - Test File Not Found
+          Retest could not find a matching test file to run.
+        ERROR
+      end
+
+      def remove(purged)
+        return if purged.empty?
+
+        if purged.is_a? Array
+          purge_cache if purged.include? cached_test_file
+        elsif purged.is_a? String
+          purge_cache if purged == cached_test_file
+        end
+      end
+
+      def purge_cache
+        @cached_test_file = nil
+      end
+    end
+  end
+end

data/lib/retest/runners.rb

@@ -0,0 +1,22 @@
+require_relative 'runners/runner'
+require_relative 'runners/test_runner'
+require_relative 'runners/change_runner'
+require_relative 'runners/variable_runner'
+
+module Retest
+  module Runners
+    module_function
+
+    def runner_for(command)
+      if command.include?('<test>') && command.include?('<changed>')
+        VariableRunner
+      elsif command.include?('<test>')
+        TestRunner
+      elsif command.include?('<changed>')
+        ChangeRunner
+      else
+        Runner
+      end.new command
+    end
+  end
+end

data/lib/retest/sounds.rb

@@ -0,0 +1,36 @@
+module Retest
+  module Sounds
+    module_function
+
+    def for(options)
+      options.notify? ? MacOS.new : Mute.new
+    end
+
+    class Mute
+      def play(_)
+      end
+      alias update play
+    end
+
+    class MacOS
+      def initialize(kernel: Kernel, thread: Thread)
+        @kernel = kernel
+        @thread = thread
+      end
+
+      def play(sound)
+        args = case sound
+        when :tests_fail
+          ['afplay', '/System/Library/Sounds/Sosumi.aiff']
+        when :tests_pass
+          ['afplay', '/System/Library/Sounds/Funk.aiff']
+        else
+          raise ArgumentError.new("No sounds were found for type: #{sound}.")
+        end
+
+        @thread.new { @kernel.system(*args) }
+      end
+      alias update play
+    end
+  end
+end

data/lib/retest/version.rb

@@ -1,3 +1,3 @@
 module Retest
-  VERSION = "1.3.0"
+  VERSION = "1.6.0"
 end

data/lib/retest.rb

@@ -1,8 +1,9 @@
 require 'listen'
 require 'string/similarity'
+require 'observer'
 
 require "retest/version"
-require "retest/runner"
+require "retest/runners"
 require "retest/repository"
 require "retest/test_options"
 require "retest/options"
@@ -11,6 +12,7 @@ require "retest/setup"
 require "retest/command"
 require "retest/file_system"
 require "retest/program"
+require "retest/sounds"
 
 module Retest
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: retest
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Alexandre Barret
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-16 00:00:00.000000000 Z
+date: 2022-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: string-similarity
@@ -52,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
-description:
+description: 
 email:
 - alex@abletech.nz
 executables:
@@ -90,8 +90,13 @@ files:
 - lib/retest/options.rb
 - lib/retest/program.rb
 - lib/retest/repository.rb
-- lib/retest/runner.rb
+- lib/retest/runners.rb
+- lib/retest/runners/change_runner.rb
+- lib/retest/runners/runner.rb
+- lib/retest/runners/test_runner.rb
+- lib/retest/runners/variable_runner.rb
 - lib/retest/setup.rb
+- lib/retest/sounds.rb
 - lib/retest/test_options.rb
 - lib/retest/version.rb
 - lib/retest/version_control.rb
@@ -104,7 +109,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
@@ -119,8 +124,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: A simple command line tool to watch file change and run its matching spec.
 test_files: []

data/lib/retest/runner.rb

@@ -1,86 +0,0 @@
-module Retest
-  class Runner
-    def self.for(test_command)
-      if test_command.include? '<test>'
-        VariableRunner
-      else
-        HardcodedRunner
-      end.new test_command
-    end
-
-    class VariableRunner
-      attr_reader :command
-
-      def initialize(command)
-        @command = command
-        @cached_test_file = nil
-      end
-
-      def ==(obj)
-        command == obj.command && obj.class == self.class
-      end
-
-      def cached_test_file
-        @cached_test_file
-      end
-
-      def cached_test_file=(value)
-        @cached_test_file = value || @cached_test_file
-      end
-
-      def run(test_file = nil)
-        self.cached_test_file = test_file
-
-        if cached_test_file
-          puts "Test File Selected: #{cached_test_file}"
-          system command.gsub('<test>', cached_test_file)
-        else
-          puts <<~ERROR
-            404 - Test File Not Found
-            Retest could not find a matching test file to run.
-          ERROR
-        end
-      end
-
-      def remove(purged)
-        return if purged.empty?
-
-        if purged.is_a? Array
-          purge_cache if purged.include? cached_test_file
-        elsif purged.is_a? String
-          purge_cache if purged == cached_test_file
-        end
-      end
-
-      def unmatching?
-        !matching?
-      end
-
-      def matching?
-        true
-      end
-
-      private
-
-      def purge_cache
-        @cached_test_file = nil
-      end
-    end
-
-    HardcodedRunner = Struct.new(:command) do
-      def run(_ = nil)
-        system command
-      end
-
-      def remove(_ = nil); end
-
-      def unmatching?
-        !matching?
-      end
-
-      def matching?
-        false
-      end
-    end
-  end
-end