retest 0.8.0.pre2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29feb62794ace1a47231b253d503e737823254686ceaf0302a9fb71445e6dd50
-  data.tar.gz: d80255a8de63fb600352be63ddf86874646925778f9aa3fd8f4cad57869af6c3
+  metadata.gz: 8df33036507fe29259ef99ac9fa574fdece9af4e69911f21125a1c4bbad7778c
+  data.tar.gz: a4bb2606b7373fb304638125be08d94c79a5dfb5e324cbf433848730cf08abe6
 SHA512:
-  metadata.gz: 93deeb1a5c642cd2609a76ec757f075f8000a0000c1a5d8782e1f82ab1bd39ded13845470d65f15056def3c67af0fd5cc748b8471e2fca39490e3433604260d3
-  data.tar.gz: 2759bb6b19546f7e3751d1e0a8242ac3e0e7057e25d7b434ecd0c572570fdd8fed31ce1a85073d58617bd2bf074b319cb4bfb68ce07bd956c86bfb179a42f10f
+  metadata.gz: ba3f7823d9789965dbd44d92ac40aeb1f6d3dd9f35f6e634f317949adf72ba672abb231f4603acfe1da2c766d3158da81ca1c538868ab8be8955bfdf443651b0
+  data.tar.gz: 74f1a43fc0b23d48bd9a7cdd53c8a57206cbf9cc3546f1a6d2d0609d7f837744f1f74162ced9f57661f6008237b039f32ba2454289d839314ecfae5bc4ce011f

data/.github/workflows/ci.yml

@@ -14,7 +14,7 @@ on:
     branches: [ main ]
 
 jobs:
-  test:
+  unit-tests:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
@@ -36,4 +36,23 @@ jobs:
         bundler-cache: true
     - run: bundle install
     - run: bundle exec rake
-    - run: CUCUMBER_PUBLISH_QUIET=true bundle exec cucumber
+
+  app-tests:
+    name: ${{ matrix.repo }} feature specs
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        repo:
+          - ruby-app
+          - rails-app
+          - hanami-app
+          - rspec-rails
+          - rspec-ruby
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.5
+          bundler-cache: true
+      - run: bin/test/${{ matrix.repo }}

data/Gemfile

@@ -3,8 +3,6 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in retest.gemspec
 gemspec
 
-gem "cucumber", "~> 5.1"
-gem "aruba", "~> 1.0"
 gem "rake", "~> 12.0"
 gem "minitest", "~> 5.0"
 gem "byebug"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    retest (0.8.0.pre2)
+    retest (0.9.0)
       listen (~> 3.2)
       string-similarity (~> 2.1)
       tty-option (~> 0.1)
@@ -9,95 +9,24 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.3.2)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    aruba (1.0.3)
-      childprocess (>= 2.0, < 5.0)
-      contracts (~> 0.16.0)
-      cucumber (>= 2.4, < 6.0)
-      ffi (~> 1.9)
-      rspec-expectations (~> 3.4)
-      thor (~> 1.0)
-    builder (3.2.4)
     byebug (11.1.3)
-    childprocess (4.0.0)
-    concurrent-ruby (1.1.7)
-    contracts (0.16.0)
-    cucumber (5.1.0)
-      builder (~> 3.2, >= 3.2.4)
-      cucumber-core (~> 8.0, >= 8.0.1)
-      cucumber-create-meta (~> 2.0, >= 2.0.1)
-      cucumber-cucumber-expressions (~> 10.3, >= 10.3.0)
-      cucumber-gherkin (~> 15.0, >= 15.0.2)
-      cucumber-html-formatter (~> 9.0, >= 9.0.0)
-      cucumber-messages (~> 13.0, >= 13.0.1)
-      cucumber-wire (~> 4.0, >= 4.0.1)
-      diff-lcs (~> 1.4, >= 1.4.4)
-      multi_test (~> 0.1, >= 0.1.2)
-      sys-uname (~> 1.2, >= 1.2.1)
-    cucumber-core (8.0.1)
-      cucumber-gherkin (~> 15.0, >= 15.0.2)
-      cucumber-messages (~> 13.0, >= 13.0.1)
-      cucumber-tag-expressions (~> 2.0, >= 2.0.4)
-    cucumber-create-meta (2.0.1)
-      cucumber-messages (~> 13.0, >= 13.0.1)
-      sys-uname (~> 1.2, >= 1.2.1)
-    cucumber-cucumber-expressions (10.3.0)
-    cucumber-gherkin (15.0.2)
-      cucumber-messages (~> 13.0, >= 13.0.1)
-    cucumber-html-formatter (9.0.0)
-      cucumber-messages (~> 13.0, >= 13.0.1)
-    cucumber-messages (13.0.1)
-      protobuf-cucumber (~> 3.10, >= 3.10.8)
-    cucumber-tag-expressions (2.0.4)
-    cucumber-wire (4.0.1)
-      cucumber-core (~> 8.0, >= 8.0.1)
-      cucumber-cucumber-expressions (~> 10.3, >= 10.3.0)
-      cucumber-messages (~> 13.0, >= 13.0.1)
-    diff-lcs (1.4.4)
-    ffi (1.13.1)
-    i18n (1.8.5)
-      concurrent-ruby (~> 1.0)
+    ffi (1.15.0)
     listen (3.4.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    middleware (0.1.0)
     minitest (5.14.1)
-    multi_test (0.1.2)
-    protobuf-cucumber (3.10.8)
-      activesupport (>= 3.2)
-      middleware
-      thor
-      thread_safe
     rake (12.3.3)
     rb-fsevent (0.10.4)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rspec-expectations (3.9.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
     string-similarity (2.1.0)
-    sys-uname (1.2.1)
-      ffi (>= 1.0.0)
-    thor (1.0.1)
-    thread_safe (0.3.6)
     tty-option (0.1.0)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    zeitwerk (2.4.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  aruba (~> 1.0)
   byebug
-  cucumber (~> 5.1)
   minitest (~> 5.0)
   rake (~> 12.0)
   retest!

data/README.md

@@ -2,29 +2,46 @@
 
 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)
 
-## 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)
+## Demo
 
 ![demo](https://alexbarret.com/images/external/retest-demo-26bcad04.gif)
 
 ## Installation
 
-Install it on your machine with:
+Install it on your machine without adding it on a Gemfile:
 
     $ gem install retest
-    $ retest 'bundle exec rspec <test>'
 
 ## Usage
 
-Launch `retest` in your terminal after accessing your ruby project folder.
+Launch `retest` in your terminal after accessing your ruby repository.
+
+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 <test>'
+
+When a file is changed, the gem will find its matching test and run the test command with it. 
+
+Few shortcut flags exist to avoid writing the full test command.
+
+    $ retest --rspec
+    $ retest --rails
+    $ retest --rake --all
+
+Finally let retest automatically find your ruby setup and run the appropriate command using:
+
+    $ retest
+    $ retest --auto
+    $ retest --auto --all
+
+The gem works as follows:
 
-Pass the test command surrounded by quotes. Use the placeholder `<test>` in your command to tell `retest` where to put the path of the test file in your command. Example: `retest 'bundle exec rspec <test>'`. When a file is changed `retest` will find its matching test and run it.
+* When a file is changed, retest will run its matching test.
+* When a test files 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.
 
-Learn more by running `retest -h`
+See more example with `retest -h`
 
 ```
 Usage: retest  [OPTIONS] [COMMAND]
@@ -35,10 +52,11 @@ 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>'
@@ -56,16 +74,24 @@ Examples:
 
   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
 ```
 
-The gem works as follows:
+## 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.
 
-* When a file is changed, retest will run its matching file test.
-* When a test file is changed, retest will run the file test.
-* 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.
+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)
 
-### Docker
+## Docker
 
 Retest works in Docker too. You can install the gem and launch retest in your container while refactoring.
 ```bash
@@ -74,7 +100,7 @@ $ gem install retest
 $ retest 'bundle exec rails test <test>'
 ```
 
-### Disclaimer
+## 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
 
@@ -93,8 +119,6 @@ Retest supports ruby 2.4 and above.
   - [x] Rails
   - [x] Ad-hoc scripts
   - [x] Hanami
-  - [ ] Sinatra
-  - [ ] Cuba? Padrino?
 - [ ] Handle other languages: Elixir, Node, Python, PHP
 - [ ] Aliases from oh-my-zsh and bash profiles?
 
@@ -104,6 +128,11 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 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).
 
+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

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "retest"
+require "byebug"
+
+$stdout.sync = true
+
+options = Retest::Options.new(ARGV)
+
+if options.help?
+  $stdout.puts options.help
+  return
+end
+
+Retest.start(options.command) # not blocking
+
+sleep

data/bin/test/hanami-app

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

data/bin/test/rails-app

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

data/bin/test/rspec-rails

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

data/bin/test/rspec-ruby

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

data/bin/test/ruby-app

@@ -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-app/retest.gem
+docker-compose -f features/ruby-app/docker-compose.yml up --build --exit-code-from retest

data/exe/retest

@@ -6,7 +6,10 @@ $stdout.sync = true
 
 options = Retest::Options.new(ARGV)
 
-return puts options.help if options.help?
+if options.help?
+  $stdout.puts options.help
+  return
+end
 
 Retest.start(options.command) # not blocking
 

data/lib/retest.rb

@@ -7,6 +7,7 @@ require "retest/repository"
 require "retest/test_options"
 require "retest/options"
 require "retest/version_control"
+require "retest/setup"
 
 module Retest
   class Error < StandardError; end
@@ -26,11 +27,12 @@ module Retest
     def build(runner:, repository:)
       Listen.to('.', only: /\.rb$/, relative: true) do |modified, added, removed|
         begin
-          repository.remove(removed)
           repository.add(added)
+          repository.remove(removed)
+          runner.remove(removed)
           system('clear 2>/dev/null') || system('cls 2>/dev/null')
 
-          runner.run repository.find_test (modified + added).first.strip
+          runner.run repository.find_test (modified + added).first
         rescue => e
           puts "Something went wrong: #{e.message}"
         end

data/lib/retest/options.rb

@@ -8,7 +8,6 @@ module Retest
     RAILS_COMMAND = "bundle exec rails test <test>"
     RAKE_COMMAND  = "bundle exec rake test TEST=<test>"
     RUBY_COMMAND  = "bundle exec ruby <test>"
-    NO_COMMAND    = "echo You have no command assigned"
 
     ALL_RAKE_COMMAND  = "bundle exec rake test"
     ALL_RAILS_COMMAND = "bundle exec rails test"
@@ -37,6 +36,18 @@ module Retest
       Runs a hardcoded command after a file change
         $ retest 'ruby lib/bottles_test.rb'
       EOS
+
+      example <<~EOS
+      Let retest identify which command to run
+        $ retest
+        $ retest --auto
+      EOS
+
+      example <<~EOS
+      Let retest identify which command to run for all tests
+        $ retest --all
+        $ retest --auto --all
+      EOS
     end
 
     argument :command do
@@ -52,6 +63,11 @@ module Retest
       desc "Run all the specs of a specificied ruby setup"
     end
 
+    flag :auto do
+      long "--auto"
+      desc "Indentify repository setup and runs appropriate command"
+    end
+
     flag :help do
       short "-h"
       long "--help"
@@ -84,21 +100,21 @@ module Retest
       new(args).command
     end
 
-    def initialize(args = [])
+    def initialize(args = [], output_stream: STDOUT, setup: Setup)
       self.args = args
+      @output_stream = output_stream
+      @setup = setup
     end
 
     def command
-      if params[:rspec]
-        params[:all] ? ALL_RSPEC_COMMAND : RSPEC_COMMAND
-      elsif params[:rake]
-        params[:all] ? ALL_RAKE_COMMAND : RAKE_COMMAND
-      elsif params[:rails]
-        params[:all] ? ALL_RAILS_COMMAND : RAILS_COMMAND
-      elsif params[:ruby]
-        params[:all] ? NO_COMMAND : RUBY_COMMAND
-      else
-        params[:command] || NO_COMMAND
+      return params[:command] if params[:command]
+
+      if    params[:rspec] then rspec_command
+      elsif params[:rake]  then rake_command
+      elsif params[:rails] then rails_command
+      elsif params[:ruby]  then ruby_command
+      elsif params[:auto]  then default_command
+      else                      default_command
       end
     end
 
@@ -110,5 +126,46 @@ module Retest
     def help?
       params[:help]
     end
+
+    private
+
+    def full_suite?
+      params[:all]
+    end
+
+    def default_command
+      choose_command @setup.type, command_for(@setup.type)
+    end
+
+    def command_for(type)
+      case type
+      when :rspec then rspec_command
+      when :rails then rails_command
+      when :rake  then rake_command
+      when :ruby  then ruby_command
+      else             ruby_command
+      end
+    end
+
+    def choose_command(type, command)
+      @output_stream.puts "Setup identified: [#{type.upcase}]. Using command: '#{command}'"
+      command
+    end
+
+    def rspec_command
+      full_suite? ? ALL_RSPEC_COMMAND : RSPEC_COMMAND
+    end
+
+    def rails_command
+      full_suite? ? ALL_RAILS_COMMAND : RAILS_COMMAND
+    end
+
+    def rake_command
+      full_suite? ? ALL_RAKE_COMMAND : RAKE_COMMAND
+    end
+
+    def ruby_command
+      RUBY_COMMAND
+    end
   end
 end

data/lib/retest/repository.rb

@@ -10,18 +10,21 @@ module Retest
     end
 
     def find_test(path)
+      return unless path
+      return if path.empty?
+
       cache[path] ||= select_from TestOptions.for(path, files: files)
     end
 
     def add(added)
-      return if added && added.empty?
+      return if added&.empty?
 
       files.push(*added)
       files.sort!
     end
 
     def remove(removed)
-      return if removed && removed.empty?
+      return if removed&.empty?
 
       if removed.is_a?(Array)
         removed.each { |file| files.delete(file) }

data/lib/retest/runner.rb

@@ -20,10 +20,20 @@ module Retest
         command == obj.command
       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)
-        if @cached_test_file = test_file || @cached_test_file
-          puts "Test File Selected: #{@cached_test_file}"
-          system command.gsub('<test>', @cached_test_file)
+        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
@@ -31,12 +41,30 @@ module Retest
           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
+
+      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
     end
   end
 end

data/lib/retest/setup.rb

@@ -0,0 +1,45 @@
+module Retest
+  class Setup
+    def self.type
+      new.type
+    end
+
+    def type
+      @type ||= begin
+        return :ruby unless has_gemfile?
+
+        if rspec?
+          :rspec
+        elsif rails?
+          :rails
+        elsif rake?
+          :rake
+        else
+          :ruby
+        end
+      end
+    end
+
+    private
+
+    def has_gemfile?
+      File.exist? 'Gemfile'
+    end
+
+    def rspec?
+      has_gem? 'rspec'
+    end
+
+    def rails?
+      File.exist? 'bin/rails'
+    end
+
+    def rake?
+      has_gem? 'rake'
+    end
+
+    def has_gem?(gem_name)
+      !`cat Gemfile | grep #{gem_name}`.empty?
+    end
+  end
+end

data/lib/retest/version.rb

@@ -1,3 +1,3 @@
 module Retest
-  VERSION = "0.8.0.pre2"
+  VERSION = "0.9.0"
 end

data/lib/retest/version_control.rb

@@ -31,7 +31,17 @@ module Retest
       end
 
       def files
-        `git ls-files`.split("\n")
+        (untracked_files + tracked_files).sort
+      end
+
+      private
+
+      def untracked_files
+        `git ls-files --other --exclude-standard -z`.split("\x0")
+      end
+
+      def tracked_files
+        `git ls-files -z`.split("\x0")
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: retest
 version: !ruby/object:Gem::Version
-  version: 0.8.0.pre2
+  version: 0.9.0
 platform: ruby
 authors:
 - Alexandre Barret
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-25 00:00:00.000000000 Z
+date: 2021-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: string-similarity
@@ -70,12 +70,19 @@ files:
 - README/demo.gif
 - Rakefile
 - bin/console
+- bin/debug
 - bin/setup
+- bin/test/hanami-app
+- bin/test/rails-app
+- bin/test/rspec-rails
+- bin/test/rspec-ruby
+- bin/test/ruby-app
 - exe/retest
 - lib/retest.rb
 - lib/retest/options.rb
 - lib/retest/repository.rb
 - lib/retest/runner.rb
+- lib/retest/setup.rb
 - lib/retest/test_options.rb
 - lib/retest/version.rb
 - lib/retest/version_control.rb
@@ -97,9 +104,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.3.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
 signing_key: