retest 0.3.1 → 0.6.0.pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56507242c2a092f077dbad839369ce929e59bdc8e0b6c0e29436a9893d12ca79
-  data.tar.gz: 27eb3934eba008e23834ebec21bb42e680a143c349d33bb42c56d9b396bfed5a
+  metadata.gz: d55eddf3b57a090756f298ddef8ee56e5fb1fda5cf418eeef09e439ef17735a4
+  data.tar.gz: 0a24792e30b8954c09614460d0bb5a94ff1ae796da17fe66da1a499bfac7422c
 SHA512:
-  metadata.gz: a0fc4a62969f81110fef3630ae11a0badc4436c93cbc0502922f4f342c2ff050e449b15c5b4f949f37a6a8e755702e1b5c03741c3dccb7870401d95a67c8702e
-  data.tar.gz: 6042dcced199dd65e4b276f2eecc56c487f482216529079c35a84b5c133525c169dd7695d6f2d92d6c3074f6edeac50f7818a4f75ec1d1c179eca65727b5a581
+  metadata.gz: 335d9c2089ee743e55d3e2f16494cdb566314f072cfea689c03f2c08f7e8df08d9911eebce490fa621aaa654ebbcac61e9972d69eee24e9d660bb6093a17ef82
+  data.tar.gz: 433796d6539aca269288e5d7923207fbc96f3ab70fdea5ac8464f8f179973c5cf106786cb507c5bc4e6dabba242b201b18197911dc8899a11d3c038dd64f5cf1

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: CUCUMBER_PUBLISH_QUIET=true 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.1)
+    retest (0.6.0.pre2)
       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,13 +1,15 @@
 # Retest
 
-Retest is a small command line tool to help refactor code by watching a file change and running its matching spec. You don't need a configuration file to start refactoring.
+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. It is probably unstable and unflexible. Give it a go you can uninstall it easily. If you think the matching pattern could be improved please raise an issue.
+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 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)
+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
 
@@ -19,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
@@ -35,14 +37,16 @@ $ 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 multiple matching test files are found, the tool asks you to confirm the file and save the answer.
-* When a test file is not found run the last command again. If no command was run before nothing gets run.
+* 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.
 
@@ -59,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] 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 withing Docker.
+- [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
@@ -80,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..."
+$stdout.sync = true
 
-command = Retest::Command.for(ARGV.join)
+puts "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
 
-listener.start # not blocking
 puts "Ready to refactor! You can make file changes now"
+
 sleep

data/lib/retest.rb

@@ -1,8 +1,25 @@
+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"
 
 module Retest
   class Error < StandardError; end
+
+  def self.build(command:)
+    Listen.to('.', ListenOptions.to_h) do |modified, added, removed|
+      begin
+        if modified.any?
+          `clear 2>&1` || `cls 2>&1`
+          command.run(modified.first.strip)
+        end
+      rescue => e
+        puts "Something went wrong: #{e.message}"
+      end
+    end
+  end
 end

data/lib/retest/command.rb

@@ -25,7 +25,10 @@ module Retest
           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
 

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

@@ -10,7 +10,7 @@ module Retest
     end
 
     def find_test(path)
-      cache[path] ||= select_from test_options(path)
+      cache[path] ||= select_from TestOptions.for(path, files: files)
     end
 
     private
@@ -25,23 +25,10 @@ module Retest
       end
     end
 
-    def test_options(path)
-      files.select { |file| regex(path) =~ file }
-        .sort_by { |file| String::Similarity.levenshtein(path, file) }
-        .last(5)
-        .reverse
-    end
-
     def default_files
       @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:

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.1"
+  VERSION = "0.6.0.pre2"
 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.1
+  version: 0.6.0.pre2
 platform: ruby
 authors:
 - Alexandre Barret
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-06 00:00:00.000000000 Z
+date: 2020-11-17 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,8 +46,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
+- ".ruby-version"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -87,7 +60,9 @@ files:
 - 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
@@ -96,7 +71,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
@@ -107,12 +82,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.1.2
-signing_key:
+rubygems_version: 3.0.3
+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