retest 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ffe53d75f1b6c84ecdc5506c13a5798fba6e1c6801d816c98fec97912adf890
-  data.tar.gz: 3fd96dfa07a53ca007474b6dcbdfb7c1c542207c46b738736594b8a72e330d4f
+  metadata.gz: ea38c836b4be97b77f96d723e3b0e9baa2c123e9ce774ef903afab933c8b35e3
+  data.tar.gz: 863765b458c1f4dae039dd308152716fafaacc87a1cc81ad871dd1b18d86c093
 SHA512:
-  metadata.gz: abe51dbcf57d44462117ad547d5e084973e6b3efbcf9e2a4450458e9f24b6e1f6a42e9bb1ee1ef20b48de8f42e4b3f12808765a8830432bddc94809c5705f1eb
-  data.tar.gz: f0f018c5553e34ca7bcf10411f73b9e6008936b877454a2a90f1bca8f6fcd30d0f5c9158ae2cef71484b3faca2db68b4b43b1d53063cdcd07eae1609bd802b0a
+  metadata.gz: ed8aef268501000e89fc6547b5fcb7ea19bde847801ac6157342c649493d662767b7156ef1337ddb67e8e2863b7504736ecc8696f74da697e29f991a92bf085d
+  data.tar.gz: e1a5736f8a40d3288cfc586d5615d714919c1e1c9dc58f9b854bad02869639ecfbe9295d5ab51bd72cb615af4cfbcff5d0151b4d5c45e3bf5f498ac5b1495246

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    retest (0.2.0)
+    retest (0.5.0)
       listen (~> 3.2)
       string-similarity (~> 2.1)
 

data/README.md

@@ -1,15 +1,15 @@
 # Retest
 
-Retest is a small gem to help refactor code by watching a file change and running its matching spec. You don't need a configuration file to start refactoring. 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 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)
 
-This is my take on solving tests rerun. It is meant to be simple and follow testing conventions encountered in Ruby projects. It is probably unstable and unflexible but covers my need. Give it a go you can uninstall it easily. For stable, yet more and 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)
+## 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.
 
-This is a work in progress and the end goal is to have an executable that works as follow:
+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.
 
-* Works with RSpec, MiniTest, Rake commands & bash commands (not aliases).
-* Works when run in a Docker container.
-* When a test file is not found run the last command again.
-* When multiple test files are found, ask  which file to run and save the answer.
+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](https://alexbarret.com/images/external/retest-demo-26bcad04.gif)
 
 ## Installation
 
@@ -21,11 +21,11 @@ Install it on your machine with:
 
 Launch `retest` in your terminal after accessing your ruby project folder.
 
-Pass the test command surrounded with quotes. Use the placeholder `<test>` in your command to let `retest` find the matching test and replace the placeholder with the path of the test file.
+Pass the test command surrounded by quotes. Use the placeholder `<test>` in your command to let `retest` find the matching test and replace the placeholder with the path of the test file.
 
 ```bash
 # Let retest find the test file and replace the placeholder with the path of the test file
-$ retest 'bundle exec rake test <test>'
+$ retest 'bundle exec rake test TEST=<test>'
 $ retest 'rails test <test>'
 $ retest 'rspec <test>'
 $ retest 'ruby <test>'
@@ -37,16 +37,25 @@ $ retest 'rails test'
 $ retest 'rspec'
 $ retest 'docker-compose exec web bundle exec rails test'
 
-# Hardcode a test file to run indepdendently from the file you change
+# Hardcode a test file to run independently from the file you change
 $ retest 'ruby all_tests.rb'
 ```
 
+The gem works as follows:
+
+* 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.
+* Works with RSpec, MiniTest, Rake commands & bash commands (not aliases).
+* Works when installed and run in a Docker container.
+
 ### Docker
 
-Installing & launching the gem in the Docker container seem to work
+Installing & launching the gem in a Docker container seems to work
 ```bash
-$ docker-compose run web bash 
-$ gem install retests
+$ docker-compose run web bash
+$ gem install retest
 $ retest 'bundle exec rails test <test>'
 ```
 
@@ -57,9 +66,17 @@ $ retest 'bundle exec rails test <test>'
 ## Roadmap
 
 - [x] MVP
-- [x] Run withing Docker.
-- [ ] When a test file is not found run the last command again.
-- [ ] When multiple test files are found, ask  which file to run and save the answer.
+- [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] Bundler Gem
+  - [x] Rails
+  - [x] Ad-hoc scripts
+  - [ ] Hanami
+  - [ ] Sinatra
+  - [ ] Cuba? Padrino?
+- [ ] Handle other languages: Elixir, Node, Python, PHP
 - [ ] Aliases from oh-my-zsh and bash profiles?
 
 ## Development
@@ -75,4 +92,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/alexb5
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open-source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/exe/retest

@@ -7,9 +7,13 @@ puts "Launching Retest..."
 
 command = Retest::Command.for(ARGV.join)
 
-listener = Listen.to('.', ignore: /node_modules|tmp/, relative: true) do |modified, added, removed|
-  system("clear") || system("cls")
-  command.run(modified.first.strip)
+listener = Listen.to('.', Retest::ListenOptions.to_h) do |modified, added, removed|
+  if modified.any?
+    system("clear") || system("cls")
+    command.run(modified.first.strip)
+  end
+rescue => e
+  puts "Something went wrong: #{e.message}"
 end
 
 listener.start # not blocking

data/lib/retest.rb

@@ -1,21 +1,10 @@
 require "retest/version"
 require "retest/command"
+require "retest/repository"
+require "retest/test_options"
+require "retest/listen_options"
 require 'string/similarity'
 
 module Retest
   class Error < StandardError; end
-
-  def find_test(path, files: nil)
-    files
-      .select { |file| regex(path) =~ file }
-      .max_by { |file| String::Similarity.cosine(path, file) }
-  end
-
-  private
-
-  def regex(path)
-    extname = File.extname(path)
-    basename = File.basename(path, extname)
-    Regexp.new(".*#{basename}_(?:spec|test)#{extname}")
-  end
 end

data/lib/retest/command.rb

@@ -1,22 +1,19 @@
 module Retest
   class Command
     def self.for(test_command)
-      command_class = if test_command.include? '<test>'
+      if test_command.include? '<test>'
         VariableCommand
       else
         HardcodedCommand
-      end
-
-      command_class.new test_command
+      end.new test_command
     end
 
     class VariableCommand
-      attr_reader :command, :files, :cache
+      attr_reader :command, :repository, :cached_test_file
 
-      def initialize(command, files: nil, cache: {})
+      def initialize(command, repository: nil)
+        @repository = repository || Repository.new
         @command = command
-        @cache = cache
-        @files = files || default_files
       end
 
       def ==(obj)
@@ -24,34 +21,24 @@ module Retest
       end
 
       def run(file_changed)
-        if find_test(file_changed)
-          system command.gsub('<test>', find_test(file_changed))
+        if @cached_test_file = test_file(file_changed)
+          puts "Test File Selected: #{cached_test_file}"
+          system command.gsub('<test>', cached_test_file)
         else
-          puts 'Could not find a file test matching'
+          puts <<~ERROR
+            404 - Test File Not Found
+            Retest could not find a matching test file to run.
+          ERROR
         end
       end
 
-      private
-
-      def find_test(path)
-        cache[path] ||= files
-          .select { |file| regex(path) =~ file }
-          .max_by { |file| String::Similarity.cosine(path, file) }
-      end
-
-      def regex(path)
-        extname = File.extname(path)
-        basename = File.basename(path, extname)
-        Regexp.new(".*#{basename}_(?:spec|test)#{extname}")
-      end
-
-      def default_files
-        @default_files ||= Dir.glob('**/*') - Dir.glob('{tmp,node_modules}/**/*')
+      def test_file(file_changed)
+        repository.find_test(file_changed) || cached_test_file
       end
     end
 
     HardcodedCommand = Struct.new(:command) do
-      def run(file_changed)
+      def run(_)
         system command
       end
     end

data/lib/retest/listen_options.rb

@@ -0,0 +1,36 @@
+module Retest
+  class ListenOptions
+    IGNORE_REGEX = /node_modules|tmp|\.sqlite|\.byebug_history/
+
+    class << self
+      def to_h(tool = GitTool.new)
+        return {ignore: IGNORE_REGEX, relative: true} unless tool.installed?
+
+        {only: regex_for(tool.files), relative: true}
+      end
+
+      private
+
+      def regex_for(files)
+        Regexp.new files.split("\n").join('|')
+      end
+    end
+  end
+
+  class GitTool
+    attr_reader :name
+    alias :to_s :name
+
+    def initialize
+      @name = 'git'
+    end
+
+    def installed?
+      !`command -v #{self}`.empty?
+    end
+
+    def files
+      `git ls-files`
+    end
+  end
+end

data/lib/retest/repository.rb

@@ -0,0 +1,52 @@
+module Retest
+  class Repository
+    attr_accessor :files, :cache, :input_stream, :output_stream
+
+    def initialize(files: nil, cache: {}, input_stream: nil, output_stream: nil)
+      @cache         = cache
+      @files         = files || default_files
+      @input_stream  = input_stream || STDIN
+      @output_stream = output_stream|| STDOUT
+    end
+
+    def find_test(path)
+      cache[path] ||= select_from TestOptions.for(path, files: files)
+    end
+
+    private
+
+    def select_from(tests)
+      case tests.count
+      when 0, 1
+        tests.first
+      else
+        ask_question tests
+        tests[get_input]
+      end
+    end
+
+    def default_files
+      @default_files ||= Dir.glob('**/*') - Dir.glob('{tmp,node_modules}/**/*')
+    end
+
+    def ask_question(tests)
+      output_stream.puts <<~QUESTION
+        We found few tests matching:
+        #{list_options(tests)}
+
+        Which file do you want to use?
+        Enter the file number now:
+      QUESTION
+    end
+
+    def list_options(tests)
+      tests.map.with_index do |file, index|
+        "[#{index}] - #{file}"
+      end.join("\n")
+    end
+
+    def get_input
+      input_stream.gets.chomp.to_i
+    end
+  end
+end

data/lib/retest/test_options.rb

@@ -0,0 +1,87 @@
+require 'forwardable'
+
+module Retest
+  class TestOptions
+    def self.for(path, files: [])
+      new(path, files: files).filtered_results
+    end
+
+    attr_reader :path, :files
+
+    def initialize(path, files: [])
+      @path = Path.new(path)
+      @files = files
+    end
+
+    def filtered_results
+      if path.test?
+        [path]
+      elsif namespace_screens.any?
+        namespace_screens
+      else
+        possible_tests
+      end.map(&:to_s)
+    end
+
+    private
+
+    def possible_tests
+      @possible_tests ||= filter_by_string_similarities(path, files)
+        .last(5)
+        .reverse
+    end
+
+    def filter_by_string_similarities(path, files)
+      files.select  { |file| path.possible_test?(file) }
+           .sort_by { |file| [path.similarity_score(file), file] }
+    end
+
+    def namespace_screens
+      @namespace_screens ||= path
+        .reversed_dirnames
+        .each_with_index
+        .with_object(possible_tests.map { |file| Path.new(file) }) do |(reference, index), result|
+          unless [1, 0].include? result.count
+            result.keep_if { |path| path.reversed_dirnames[index] == reference }
+          end
+        end
+    end
+
+    class Path
+      extend Forwardable
+
+      def_delegators :pathname, :to_s, :basename, :extname, :dirname
+
+      attr_reader :pathname
+      def initialize(path)
+        @pathname = Pathname(path)
+      end
+
+      def reversed_dirnames
+        @reversed_dirnames ||= dirname.each_filename.to_a.reverse
+      end
+
+      def test?
+        test_regex =~ to_s
+      end
+
+      def possible_test?(file)
+        possible_test_regex =~ file
+      end
+
+      def similarity_score(file)
+        String::Similarity.levenshtein(to_s, file)
+      end
+
+      private
+
+      def test_regex
+        Regexp.new(".*(?:spec|test)#{extname}")
+      end
+
+      def possible_test_regex
+        Regexp.new(".*#{basename(extname)}_(?:spec|test)#{extname}")
+      end
+    end
+  end
+end

data/lib/retest/version.rb

@@ -1,3 +1,3 @@
 module Retest
-  VERSION = "0.2.0"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: retest
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Alexandre Barret
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-03 00:00:00.000000000 Z
+date: 2020-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: string-similarity
@@ -66,7 +66,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - alex@abletech.nz
 executables:
@@ -80,12 +80,16 @@ files:
 - Gemfile.lock
 - LICENSE.txt
 - README.md
+- README/demo.gif
 - Rakefile
 - bin/console
 - bin/setup
 - exe/retest
 - lib/retest.rb
 - lib/retest/command.rb
+- lib/retest/listen_options.rb
+- lib/retest/repository.rb
+- lib/retest/test_options.rb
 - lib/retest/version.rb
 - retest.gemspec
 homepage: https://github.com/AlexB52/retest
@@ -94,7 +98,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
@@ -109,8 +113,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.2
+signing_key:
 specification_version: 4
 summary: A simple command line tool to watch file change and run its matching spec.
 test_files: []