retest 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4d1cb4047340b37f649a2348b98d8fac480169a09f6276a622ddd97d6a2439b
-  data.tar.gz: b08fa7303144c4385a45c0b3e38de202ccd9758703d97641262efbc242def2e8
+  metadata.gz: 5c5dc87b26d27197158d859e17e179f9dc0b00ec2280dfefff165da388c77eb6
+  data.tar.gz: cffbfbf72ea1b51e7f63e288fba08727498ec582192536a54ad9d2b47f04d1d2
 SHA512:
-  metadata.gz: e75eacbeea65ef118e764a4585b373cd30a0c1742763c00b8de9d896a8b83ef8cae27a7b54e3e07704692188b3d3efc6f25dd7d1471dcebaa36916d369a7f10f
-  data.tar.gz: bda74a90e34abd34e5d6dddac26faade5c2a3850a9cea456a4589e97096db880e3c7a8ed2ece1e1ec9174ee9ea0af4e8388173928b74b77dd4074b84efcd916f
+  metadata.gz: ad4051278ba14ff9f7284de5f8f643bdec7512864bb330aac803f6e3c672cc24f5584eb4b26be9f4a2b533a229fd5366a0eece8b4aa53eb816ff3e9c6575f200
+  data.tar.gz: 3b52308adcef24e6098f40ee07d55848f39104838c4db404394ee33a8ffe38466478cd18f347aa73b3a0072fc0c263592a9eecf1ed98e459345be160c02ed30f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    retest (1.3.0)
+    retest (1.4.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.3)
-    listen (3.6.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)

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,75 +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
-      --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 +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>'
 ```
@@ -131,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
@@ -149,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

@@ -18,6 +18,7 @@ command    = Retest::Command.for_options(options)
 runner     = Retest::Runner.for(command.to_s)
 
 program = Retest::Program.new(
+  extension: options.extension,
   repository: repository,
   command: command,
   runner: runner

data/exe/retest

@@ -16,6 +16,7 @@ command    = Retest::Command.for_options(options)
 runner     = Retest::Runner.for(command.to_s)
 
 program = Retest::Program.new(
+  extension: options.extension,
   repository: repository,
   command: command,
   runner: runner

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"
@@ -124,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

@@ -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
@@ -27,7 +28,7 @@ module Retest
     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)

data/lib/retest/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: retest
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Alexandre Barret
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-16 00:00:00.000000000 Z
+date: 2021-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: string-similarity