retest 1.2.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13ce5e74ba4682f3777259a6565c585271dd7db5f6d753c4e5d6836f5c457634
-  data.tar.gz: bfc62c5fd481982435b3ee8e372839b7678e489d8123bbcd629c5ba56c2b7012
+  metadata.gz: ce75120a1212540c1e510e4fd3d28e505f68d79e4e557b48e34cfda769d35613
+  data.tar.gz: ff2a3cc3644ce392adb38d8a87ffea711bbc6baaeb20f70099b2c0771cce3cf6
 SHA512:
-  metadata.gz: ef3ee2efb84b012c5b6ba340d81e578ec512960e7fc28516abbc23689c8ad43f3c3a5ecd1855d51df1bcee5a426fdd92aef3f460a65fbb7c39d35d83ad08c735
-  data.tar.gz: e5af1bbe78c6bfa347088fc0ec3c8e985a1dbad5393f47640b7885cf4a0bbdd5cbc8c8922f7b189794027af4e7091dc36fd81693e5d785cf11e330fd2ea78dc0
+  metadata.gz: 6741101b8345dfcba37002b1265d6ed5170c8b82eccc8a143b20a7fb77d196f05b9c4b4af142a7fed62952aa5251769523243c997884334cc8a3d484f93f3207
+  data.tar.gz: 3c4f2484eb2400a47d35c22a33f6db47ede1e0fc401dccdede644114f90bc2765f1e1e6df5b2fea7e761d77983a863f2c917cfb5afd71ffabd89e884f1ad85c6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    retest (1.2.0)
+    retest (1.5.0)
       listen (~> 3.2)
       string-similarity (~> 2.1)
       tty-option (~> 0.1)
@@ -10,8 +10,8 @@ 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)
@@ -20,7 +20,7 @@ GEM
     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

@@ -15,15 +15,38 @@ 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.
 
-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:
+### 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:
+
+    $ 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
+
+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.
 
@@ -31,72 +54,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
-  -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'
-
-  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.
@@ -108,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>'
 ```
@@ -128,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
@@ -146,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::Runners.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/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::Runners.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,15 +1,22 @@
 module Retest
   class Command
-    Rails = Struct.new(:all, :file_system) do
-      def self.command(all:, file_system: FileSystem)
-        new(all, file_system).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 format_batch(*files)
+        files.join(' ')
+      end
+
       private
 
       def root_command
@@ -19,4 +26,4 @@ module Retest
       end
     end
   end
-end
+end

data/lib/retest/command/rake.rb

@@ -1,15 +1,22 @@
 module Retest
   class Command
-    Rake = Struct.new(:all, :file_system) do
-      def self.command(all:, file_system: FileSystem)
-        new(all, file_system).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 format_batch(*files)
+        files.size > 1 ? "\"{#{files.join(',')}}\"" : files.first
+      end
+
       private
 
       def root_command
@@ -19,4 +26,4 @@ module Retest
       end
     end
   end
-end
+end

data/lib/retest/command/rspec.rb

@@ -1,15 +1,22 @@
 module Retest
   class Command
-    Rspec = Struct.new(:all, :file_system) do
-      def self.command(all:, file_system: FileSystem)
-        new(all, file_system).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 format_batch(*files)
+        files.join(' ')
+      end
+
       private
 
       def root_command

data/lib/retest/command/ruby.rb

@@ -1,9 +1,18 @@
 module Retest
   class Command
-    module Ruby
-      module_function
+    class Ruby
+      attr_reader :all, :file_system
 
-      def command(all: false, file_system: FileSystem)
+      def initialize(all:, file_system: FileSystem)
+        @file_system = file_system
+        @all = all
+      end
+
+      def format_batch(*files)
+        %Q{-e "#{files.map { |file| "require './#{file}';" }.join}"}
+      end
+
+      def to_s
         if file_system.exist? 'Gemfile.lock'
           'bundle exec ruby <test>'
         else

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/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,44 @@
+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..."
+      runner.run_all_tests command.format_batch(test_files)
+    end
+
+    private
+
+    def build
+      Listen.to('.', only: extension, relative: true) do |modified, added, removed|
+        begin
+          repository.sync(added: added, removed: removed)
+          runner.sync(added: added, removed: removed)
+          system('clear 2>/dev/null') || system('cls 2>/dev/null')
+
+          runner.run (modified + added).first, repository: repository
+        rescue => e
+          puts "Something went wrong: #{e.message}"
+        end
+      end
+    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 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,26 @@
+module Retest
+  module Runners
+    class Runner
+      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 command
+      end
+
+      def run_all_tests(tests_string)
+        puts "Test File Selected: #{tests_string}"
+        system command.gsub('<test>', tests_string)
+      end
+
+      def sync(added:, removed:)
+      end
+    end
+  end
+end

data/lib/retest/{runner.rb → runners/test_runner.rb}

@@ -1,25 +1,6 @@
 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
-      end
-
+  module Runners
+    class TestRunner < Runner
       def cached_test_file
         @cached_test_file
       end
@@ -28,8 +9,8 @@ module Retest
         @cached_test_file = value || @cached_test_file
       end
 
-      def run(test_file = nil)
-        self.cached_test_file = test_file
+      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}"
@@ -42,6 +23,12 @@ module Retest
         end
       end
 
+      def sync(added:, removed:)
+        remove(removed)
+      end
+
+      private
+
       def remove(purged)
         return if purged.empty?
 
@@ -52,35 +39,9 @@ module Retest
         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
+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 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/version.rb

@@ -1,3 +1,3 @@
 module Retest
-  VERSION = "1.2.0"
+  VERSION = "1.5.0"
 end

data/lib/retest.rb

@@ -2,7 +2,7 @@ require 'listen'
 require 'string/similarity'
 
 require "retest/version"
-require "retest/runner"
+require "retest/runners"
 require "retest/repository"
 require "retest/test_options"
 require "retest/options"
@@ -10,53 +10,8 @@ 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.2.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Alexandre Barret
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-18 00:00:00.000000000 Z
+date: 2021-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: string-similarity
@@ -88,8 +88,13 @@ files:
 - 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/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/test_options.rb
 - lib/retest/version.rb