retest 0.3.0 → 0.6.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b785b5164606d944a470b42899d1a7c6d4fa77f3d0d3a3850e4adc1e81d61db6
-  data.tar.gz: d722fe7580cc3f24587322ee9d0dcc47efc4bded149d59461eb7408398f78b73
+  metadata.gz: 6d366f005d9765a2da827543e444b70898d9a7f94f5fd8c2ca5782b3fa5a0058
+  data.tar.gz: de7a1863a92188221e05955fa518a54c4f73fe3468ca15c47b7a6aa36f1baa66
 SHA512:
-  metadata.gz: 9e7ebd3a5dd1eb6d1a09bcae184d749ac59b49cd928f845c3fcbf5d47e067e9623388167ffad4e7dc186e0aec22178444409e0da3978083107e57e7b7abcd453
-  data.tar.gz: f0cd1516119abcc62c4dfb73d317097dc5f57d3ed741bc7ff44455c0518646c6c4ffcf44686e6ee939053a7bd435acd72fc8d4f6653123fa2816634e7abbb5a5
+  metadata.gz: 3277b79fce91040aac14f7e4980dc3687d6f02caed5ba47d629b106371780c65378e5dc1ecdcfa149c51e00f23022897aadb2c1cc249f3ca209ef267691f6f73
+  data.tar.gz: f8de2fc0468a666afe0e526b334147c5c32dbcb42a0621dbf7a0e7af084806500cba083dc19833174c6a3862715e2ed046dbe032576ef844823e1cdbd763153a

data/.github/workflows/ci.yml

@@ -0,0 +1,35 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby:
+          - 2.5
+          - 2.6
+          - 2.7
+    name: Ruby ${{ matrix.ruby }} test
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - run: bundle install
+    - run: bundle exec rake
+    - run: bundle exec cucumber

data/.ruby-version

@@ -0,0 +1 @@
+2.6.6

data/Gemfile

@@ -3,6 +3,8 @@ 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.3.0)
+    retest (0.6.0.pre)
       listen (~> 3.2)
       string-similarity (~> 2.1)
 
@@ -61,7 +61,7 @@ GEM
     ffi (1.13.1)
     i18n (1.8.5)
       concurrent-ruby (~> 1.0)
-    listen (3.2.1)
+    listen (3.3.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     middleware (0.1.0)
@@ -93,9 +93,9 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  aruba
+  aruba (~> 1.0)
   byebug
-  cucumber
+  cucumber (~> 5.1)
   minitest (~> 5.0)
   rake (~> 12.0)
   retest!

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,7 +21,7 @@ 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
@@ -37,15 +37,24 @@ $ 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 
+$ docker-compose run web bash
 $ gem install retest
 $ retest 'bundle exec rails test <test>'
 ```
@@ -54,12 +63,24 @@ $ retest 'bundle exec rails test <test>'
 * 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
 
+## Ruby Support
+
+Retest supports ruby 2.5 and above.
+
 ## 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
+  - [x] Hanami
+  - [ ] Sinatra
+  - [ ] Cuba? Padrino?
+- [ ] Handle other languages: Elixir, Node, Python, PHP
 - [ ] Aliases from oh-my-zsh and bash profiles?
 
 ## Development
@@ -75,4 +96,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

@@ -1,21 +1,15 @@
 #!/usr/bin/env ruby
 
 require 'retest'
-require 'listen'
 
-puts "Launching Retest..."
+Retest.logger = STDOUT
 
-command = Retest::Command.for(ARGV.join)
+Retest.log "Launching Retest..."
 
-listener = Listen.to('.', ignore: /node_modules|tmp/, relative: true) 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
+Retest
+  .build(command: Retest::Command.for(ARGV.join))
+  .start # not blocking
+
+Retest.log "Ready to refactor! You can make file changes now"
 
-listener.start # not blocking
-puts "Ready to refactor! You can make file changes now"
 sleep

data/lib/retest.rb

@@ -1,8 +1,27 @@
+require 'listen'
+require 'string/similarity'
+
 require "retest/version"
 require "retest/command"
 require "retest/repository"
-require 'string/similarity'
+require "retest/test_options"
+require "retest/listen_options"
+require "retest/concerns/configurable"
 
 module Retest
+  include Configurable
   class Error < StandardError; end
+
+  def self.build(command:, clear_window: true)
+    Listen.to('.', ListenOptions.to_h) do |modified, added, removed|
+      begin
+        if modified.any?
+          system("clear") || system("cls") if clear_window
+          command.run(modified.first.strip)
+        end
+      rescue => e
+        puts "Something went wrong: #{e.message}"
+      end
+    end
+  end
 end

data/lib/retest/command.rb

@@ -1,13 +1,13 @@
+require 'open3'
+
 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
@@ -24,10 +24,14 @@ module Retest
 
       def run(file_changed)
         if @cached_test_file = test_file(file_changed)
-          puts "Test File Selected: #{cached_test_file}"
-          system command.gsub('<test>', cached_test_file)
+          stdout_and_stderr_str, _ = Open3.capture2e command.gsub('<test>', cached_test_file)
+          Retest.log "Test File Selected: #{cached_test_file}"
+          Retest.log stdout_and_stderr_str
         else
-          puts 'Could not find a file test matching'
+          Retest.log <<~ERROR
+            404 - Test File Not Found
+            Retest could not find a matching test file to run.
+          ERROR
         end
       end
 
@@ -38,7 +42,8 @@ module Retest
 
     HardcodedCommand = Struct.new(:command) do
       def run(_)
-        system command
+        stdout_and_stderr_str, _ = Open3.capture2e(command)
+        Retest.log stdout_and_stderr_str
       end
     end
   end

data/lib/retest/concerns/configurable.rb

@@ -0,0 +1,30 @@
+module Configurable
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  class Configuration
+    extend Forwardable
+
+    attr_accessor :logger
+
+    def_delegator :logger, :puts
+    alias :log :puts
+  end
+
+  module ClassMethods
+    extend Forwardable
+
+    attr_writer :configuration
+
+    def_delegators :configuration, :log, :logger, :logger=
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield configuration
+    end
+  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?
+      system "git -C . rev-parse 2>&1"
+    end
+
+    def files
+      `git ls-files`
+    end
+  end
+end

data/lib/retest/repository.rb

@@ -1,30 +1,25 @@
 module Retest
   class Repository
-    attr_accessor :files, :cache, :input_stream, :output_stream
+    attr_accessor :files, :cache, :input_stream
 
-    def initialize(files: nil, cache: {}, input_stream: nil, output_stream: nil)
+    def initialize(files: nil, cache: {}, input_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_test(path)
+      cache[path] ||= select_from TestOptions.for(path, files: files)
     end
 
     private
 
-    def select_test(path)
-      tests = files.select { |file| regex(path) =~ file }
-        .sort_by { |file| String::Similarity.levenshtein(path, file) }
-        .reverse
-
+    def select_from(tests)
       case tests.count
       when 0, 1
         tests.first
       else
-        ask_question tests.first(5)
+        ask_question tests
         tests[get_input]
       end
     end
@@ -33,19 +28,13 @@ module Retest
       @default_files ||= Dir.glob('**/*') - Dir.glob('{tmp,node_modules}/**/*')
     end
 
-    def regex(path)
-     extname  = File.extname(path)
-     basename = File.basename(path, extname)
-     Regexp.new(".*#{basename}_(?:spec|test)#{extname}")
-    end
-
     def ask_question(tests)
-      output_stream.puts <<~QUESTION
-      We found few tests matching:
-      #{list_options(tests)}
+      Retest.log <<~QUESTION
+        We found few tests matching:
+        #{list_options(tests)}
 
-      Which file do you want to use?
-      Enter the file number now:
+        Which file do you want to use?
+        Enter the file number now:
       QUESTION
     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.3.0"
+  VERSION = "0.6.0.pre"
 end

data/retest.gemspec

@@ -27,6 +27,4 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.add_runtime_dependency "string-similarity", ["~> 2.1"]
   spec.add_runtime_dependency "listen", ["~> 3.2"]
-  spec.add_development_dependency "cucumber"
-  spec.add_development_dependency "aruba"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: retest
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.6.0.pre
 platform: ruby
 authors:
 - Alexandre Barret
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-06 00:00:00.000000000 Z
+date: 2020-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: string-similarity
@@ -38,35 +38,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
-- !ruby/object:Gem::Dependency
-  name: cucumber
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: aruba
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description: 
+description:
 email:
 - alex@abletech.nz
 executables:
@@ -74,20 +46,26 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
+- ".ruby-version"
 - Gemfile
 - 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/concerns/configurable.rb
+- lib/retest/listen_options.rb
 - lib/retest/repository.rb
+- lib/retest/test_options.rb
 - lib/retest/version.rb
+- output.log
 - retest.gemspec
 homepage: https://github.com/AlexB52/retest
 licenses:
@@ -95,7 +73,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
@@ -106,12 +84,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A simple command line tool to watch file change and run its matching spec.
 test_files: []

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.7.0
-before_install: gem install bundler -v 2.1.4