retest 2.0.0.pre5 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 754751292557705217a2e6010b5fda60d10fffbdf5a1b66ffe48976841407e09
-  data.tar.gz: 2156346b0cd5caa0d5dcf329391a0b84a85fc88342a97fe2e3150ba196fdd7c5
+  metadata.gz: 772460d70195233b6c33f61abced4021e2f1d106aac1022a3a4514d773b5d32b
+  data.tar.gz: 6bfe550e9d14a25683e370bcb0be89f5053f3f0a354e02fe617688c207694c0d
 SHA512:
-  metadata.gz: 328df6d6fe4153956230bb4029337f68f20ef8a796337b7c423ce2cd07ddf01ce3c69d531e3daac5babe17dae6c266053919246f6f2e93e69ecf56704cf52cc1
-  data.tar.gz: ea86b8e02ddced2b484c780ca8ec673098d23a8e86cde6f0f11b15d903e7206bcb88840b61438aa947cbac4b72c34ad8831bc2d2c76f205c6bcf2f73ff75a97f
+  metadata.gz: 5eb9b44d3b77b657e00a9c126db20a20c5b63a7ab531e36d7653e29858a7f7a8f150530693c1863a687920e3e1097f6f43417530fe9b0180f6d2e0812929a6c1
+  data.tar.gz: '0584210958831b1223f8e068f05f2a6ebae28df0316eeca61900a0f1efdbe7c28ca4af1ca8ec4c777fffbf64aba7a2f2ebd892aaac601ab40ea71200451b37ed'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    retest (2.0.0.pre5)
+    retest (2.0.0)
       listen (~> 3.9)
       observer (~> 0.1)
       string-similarity (~> 2.1)

data/README.md

@@ -1,156 +1,101 @@
 [![Gem Version](https://badge.fury.io/rb/retest.svg)](https://badge.fury.io/rb/retest)
 
-# Retest
+# Retest: Your Go-To Testing Assistant for Ruby Projects
 
-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)
+Retest is the ultimate CLI tool for Ruby developers, designed to make your testing workflow seamless and efficient. It monitors file changes and automatically runs relevant tests, ensuring that your code remains solid as you refactor and develop.  
 
-## Demo
+With **zero setup required**, Retest works right out of the box on any Ruby project—no changes to your Gemfile, no unnecessary repo clutter, and no configuration headaches. It's lightweight, dev-centric, and ready to integrate into your workflow instantly.  
 
+## 🚀 **What Makes Retest Awesome?**
 
-https://user-images.githubusercontent.com/7149034/153734043-1d136f27-5c24-4676-868b-0fde76016b13.mp4
+- **Plug-and-Play:** Start testing immediately—no installation hassles or setup scripts.
+- **Project Independence:** Works with any Ruby project, no Gemfile modifications required.
+- **Time-Saving Automation:** Automatically identifies and runs relevant tests as you code.
+- **Customizable Workflows:** Tailor commands to your needs with placeholders, options, and interactive features.
+- **Sound Notifications:** Get audible feedback for test results.
 
-## Installation
+## 💡 **Why Use Retest?**
 
-Install it on your machine without adding it on a Gemfile:
+Testing frequently is the cornerstone of safe refactoring. Retest eliminates the friction of manual test execution by running tests after every file change, helping you stay just one `cmd + z` away from green tests.
 
-    $ gem install retest
+## 🔧 **Quick Installation**
 
-## Usage
+Install Retest globally in seconds:  
 
-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:
-
-    $ retest 'bundle exec rspec spec/features/posts_spec.rb'
-
-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 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.
-
-    $ retest --rspec
-    $ retest --rails
-    $ retest --rake --all
-
-#### 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 **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.
-
-### Pull request scans
-
-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
-
-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.
-
-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)
+```bash
+gem install retest
+```
 
-## Docker
+No need to add it to your Gemfile—just install and go!
 
-Retest works in Docker too. You can install the gem and launch retest in your container while refactoring.
+## 🛠️ **Key Features**
 
+### **Flexible Commands**  
+Run tests with your preferred commands, placeholders, or patterns:  
 ```bash
-# 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>'
+retest 'bin/rails test <test> && rubocop <changed>' # Flexible placeholders
+retest --all                                        # Run all tests on every file change
+retest --diff origin/main                           # Test changes from a branch
 ```
 
-## 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
+### **Interactive Companion**  
+Stay in control with an interactive shell for test management. Start Retest and enter `h` to explore available commands.  
 
-## Ruby Support
+```
+Setup identified: [RAKE]. Using command: 'bundle exec rake test TEST=<test>'
+Watcher: [WATCHEXEC]
+Launching Retest...
+Ready to refactor! You can make file changes now
+
+Type interactive command and press enter. Enter 'h' for help.
+> h
+
+* 'h', 'help'              # Prints help.
+* 'p', 'pause'             # Pauses Retest. Tests aren't run on file change events until unpaused.
+* 'u', 'unpause'           # Unpauses Retest.
+* <ENTER>                  # Runs last changed triggered command.
+* 'ra, 'run all'           # Runs all tests.
+* 'f', 'force'             # Forces a selection of test to run on every file change.
+* 'r', 'reset'             # Disables forced selection.
+* 'd', 'diff' [GIT BRANCH] # Runs matching specs that changed from a target branch.
+* 'c'                      # Clears window.
+* 'e', 'exit'              # Exits Retest.
 
-Retest supports ruby 2.5 and above.
+```
+### **Supports Multiple Watchers**  
+Retest ships with [Listen](https://github.com/guard/listen) for file monitoring but can use the more performant [Watchexec](https://github.com/watchexec/watchexec) if installed.  
 
-## Roadmap
+To force a specific watcher:  
+```bash
+retest -w watchexec
+```
 
-- [x] MVP
-- [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.
-- [x] Handle main Ruby setups
-  - [x] Bundler Gem
-  - [x] Rails
-  - [x] Ad-hoc scripts
-  - [x] Hanami
-- [ ] Handle other languages: Go, Elixir, Node, Python, PHP
-  - [ ] Go (project started)
-- [ ] Aliases from oh-my-zsh and bash profiles?
+## 🐳 **Works with Docker**
 
-## Development
+Retest can run inside Docker containers, ensuring your testing workflow stays consistent across environments.  
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```bash
+# Inside your container shell
+gem install retest
+retest 'bundle exec rails test <test>'
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+## ❤️ **Contributing**
 
-To run integration tests on one setup (ex: hanami-app): `bin/test/hanami-app`
+Got feedback or ideas? Join the discussion for Retest 2.0 and share your thoughts:  
+[Discussion - Retest V2.0 - Interactive Panel](https://github.com/AlexB52/retest/discussions/216)
 
-To access an app container (ex: ruby-app): `docker-compose -f features/ruby-app/docker-compose.yml run retest sh`
+Bug reports and pull requests are welcome at [GitHub](https://github.com/alexb52/retest).  
 
-## Contributing
+## 🛠️ **Development**
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/alexb52/retest.
+Want to contribute to Retest? Follow these steps to set up your environment
 
+1. Clone the repo and install dependencies: `bin/setup`
+2. Run tests to ensure everything is working: `rake test`
+3. Experiment with an interactive console: `bin/console`
+4. To run integration tests (e.g., for a Hanami app): `bin/test/hanami-app`
 
-## License
+## 📜 **License**  
 
-The gem is available as open-source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+Retest is open-source and available under the [MIT License](https://opensource.org/licenses/MIT).

data/bin/test/bundler-app

@@ -1,7 +1,14 @@
 #!/usr/bin/env bash
 
+FOLDER="features/bundler-app"
+
 bundle install
 bundle exec rake build
 cp -R features/support features/bundler-app/retest
-ls -t pkg | head -n1 | xargs -I {} mv pkg/{} features/bundler-app/retest.gem
-docker compose -f features/bundler-app/docker-compose.yml up --build --exit-code-from retest
+ls -t pkg | head -n1 | xargs -I {} mv pkg/{} "$FOLDER/retest.gem"
+
+if [[ "$1" == "--no-build" ]]; then
+	docker compose -f "$FOLDER/docker-compose.yml" up --exit-code-from retest
+else
+	docker compose -f "$FOLDER/docker-compose.yml" up --build --exit-code-from retest
+fi

data/bin/test/ruby-app

@@ -2,6 +2,6 @@
 
 bundle install
 bundle exec rake build
-# cp -R features/support features/ruby-app/retest
+cp -R features/support features/ruby-app/retest
 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 --exit-code-from retest

data/exe/retest

@@ -46,7 +46,7 @@ end
 
 if watcher == Retest::Watcher::Watchexec
   puts "Watcher: [WATCHEXEC]"
-else Retest::Watcher::Default
+else
   puts "Watcher: [LISTEN]"
 end
 
@@ -71,7 +71,6 @@ end
 puts "Ready to refactor! You can make file changes now"
 
 def run_command(input:, program:)
-  program.clear_terminal
   case input.strip
   when /^file changed:\s(.*)$/
     puts "File changed: #{$1}"
@@ -104,6 +103,8 @@ def run_command(input:, program:)
     program.run_all
   when /^di?f?f?\s(.*)$/
     program.diff($1)
+  when 'c'
+    program.clear_terminal
   when 'h', 'help'
     puts <<~HELP
 
@@ -115,6 +116,7 @@ def run_command(input:, program:)
       * 'f', 'force'             # Forces a selection of test to run on every file change.
       * 'r', 'reset'             # Disables forced selection.
       * 'd', 'diff' [GIT BRANCH] # Runs matching specs that changed from a target branch.
+      * 'c'                      # Clears window.
       * 'e', 'exit'              # Exits Retest.
     HELP
   else

data/lib/retest/command/base.rb

@@ -21,22 +21,6 @@ module Retest
         to_s.include?('<test>')
       end
 
-      def changed_type?
-        !has_test? && has_changed?
-      end
-
-      def test_type?
-        has_test? && !has_changed?
-      end
-
-      def variable_type?
-        has_test? && has_changed?
-      end
-
-      def hardcoded_type?
-        !has_test? && !has_changed?
-      end
-
       def to_s
         @command
       end

data/lib/retest/command.rb

@@ -27,17 +27,20 @@ module Retest
       options_command || default_command
     end
 
+    private
+
     def options_command
-      if params[:command]
-        return hardcoded_command(params[:command])
+      if    params[:command] then hardcoded_command(params[:command])
+      elsif params[:rspec]   then rspec_command
+      elsif params[:rails]   then rails_command
+      elsif params[:ruby]    then ruby_command
+      elsif params[:rake]    then rake_command
       end
+    end
 
-      if    params[:rspec] then rspec_command
-      elsif params[:rails] then rails_command
-      elsif params[:ruby]  then ruby_command
-      elsif params[:rake]  then rake_command
-      else
-      end
+    def default_command
+      log "Setup identified: [#{type.upcase}]. Using command: '#{setup_command}'"
+      setup_command
     end
 
     def setup_command
@@ -50,13 +53,6 @@ module Retest
       end
     end
 
-    def default_command
-      log "Setup identified: [#{type.upcase}]. Using command: '#{setup_command}'"
-      setup_command
-    end
-
-    private
-
     def log(message)
       @stdout&.puts(message)
     end

data/lib/retest/program.rb

@@ -12,10 +12,9 @@ module Retest
     def_delegators :runner,
       :run_last_command, :last_command
 
-    def initialize(runner: nil, repository: nil, clear_window: true, stdout: $stdout)
+    def initialize(runner: nil, repository: nil, stdout: $stdout)
       @runner = runner
       @repository = repository
-      @clear_window = clear_window
       @stdout = stdout
       initialize_pause(false)
       initialize_forced_selection([])
@@ -61,8 +60,6 @@ module Retest
     end
 
     def clear_terminal
-      return unless @clear_window
-
       system('clear 2>/dev/null') || system('cls 2>/dev/null')
     end
   end

data/lib/retest/prompt.rb

@@ -9,27 +9,21 @@ module Retest
       @question_asked = false
     end
 
-    def question_asked?
-      @question_asked
-    end
-
     def ask_which_test_to_use(path, files)
-      ask_question do
-        changed
-        notify_observers(:question)
-        options = options(files)
+      changed
+      notify_observers(:question)
+      options = options(files)
 
-        output.puts(<<~QUESTION)
-          We found few tests matching: #{path}
+      output.puts(<<~QUESTION)
+        We found few tests matching: #{path}
 
-          #{list_options(options.keys)}
+        #{list_options(options.keys)}
 
-          Which file do you want to use?
-          Enter the file number now:
-        QUESTION
-        output.print("> ")
-        options.values[input.gets.to_s.chomp.to_i]
-      end
+        Which file do you want to use?
+        Enter the file number now:
+      QUESTION
+      output.print("> ")
+      options.values[input.gets.to_s.chomp.to_i]
     end
 
     def puts(*args)
@@ -40,14 +34,6 @@ module Retest
       output.tap(&:rewind).read
     end
 
-    def ask_question
-      old_question_asked = @question_asked
-      @question_asked = true
-      yield
-    ensure
-      @question_asked = old_question_asked
-    end
-
     private
 
     def options(files, blank_option: 'none')

data/lib/retest/runner.rb

@@ -6,9 +6,7 @@ module Retest
     include Observable
     include CachedTestFile
 
-    def_delegators :command,
-      :has_changed?, :has_test?,
-      :changed_type?, :test_type?, :variable_type?, :harcoded_type?
+    def_delegators :command, :has_changed?, :has_test?
 
     attr_accessor :command, :stdout, :last_command
     def initialize(command, stdout: $stdout)
@@ -30,7 +28,8 @@ module Retest
     end
 
     def run_all
-      system_run command.clone(all: true).to_s
+      self.last_command = command.clone(all: true).to_s
+      system_run last_command
     end
 
     def format_instruction(changed_files: [], test_files: [])

data/lib/retest/setup.rb

@@ -4,7 +4,7 @@ module Retest
       @type ||= begin
         return :ruby unless has_lock_file?
 
-        if rspec?    then :rspec
+        if    rspec? then :rspec
         elsif rails? then :rails
         elsif rake?  then :rake
         else              :ruby

data/lib/retest/version.rb

@@ -1,3 +1,3 @@
 module Retest
-  VERSION = "2.0.0.pre5"
+  VERSION = "2.0.0"
 end

data/lib/retest/watcher.rb

@@ -5,7 +5,7 @@ module Retest
         when 'listen'        then Default
         when 'watchexec'     then Watchexec
         when '', 'installed' then installed
-        else                  raise ArgumentError, "Unknown #{watcher}"
+        else                 raise ArgumentError, "Unknown #{watcher}"
         end
 
       unless tool.installed?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: retest
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre5
+  version: 2.0.0
 platform: ruby
 authors:
 - Alexandre Barret
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-05 00:00:00.000000000 Z
+date: 2024-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: string-similarity
@@ -156,11 +156,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
+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.