retest 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 222a1b9ba81351e756d91fc459876b8387783cdfbd67ae9013799c366bc5d422
+  data.tar.gz: a02c050894fd050defce526352325dfeeb35ef10086f907a92d6b6325a7e9e1b
+SHA512:
+  metadata.gz: a585e4efa6c818f209d14859e8a89ad69ed2f8fcb90dc008d4ef205ad8f608ff32a7f494e47127e31252792c183e88d284034887869da2e940dd5fa2c0ecc3ec
+  data.tar.gz: 53c849bb80a0943bd38ce15e4cb6f1dee1e88df02336f8d7c9321cbaf2e5777ed0fd1985e6f1e95b1d4b307fecb1a839826b35598b255db827988e77656d950f

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in retest.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: .
+  specs:
+    retest (0.1.1)
+      listen (~> 3.2)
+      string-similarity (~> 2.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ffi (1.13.1)
+    listen (3.2.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    minitest (5.14.1)
+    rake (12.3.3)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    string-similarity (2.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  rake (~> 12.0)
+  retest!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Alexandre Barret
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+# 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.
+
+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)
+
+This is a work in progress and the end goal is to have an executable that works as follow:
+
+* 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.
+
+## Installation
+
+Install it on your machine with:
+
+    $ gem install retest
+
+## Usage
+
+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.
+
+```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 'rails test <test>'
+$ retest 'rspec <test>'
+$ retest 'ruby <test>'
+
+# Run the same command after a file change like all the spec files
+$ retest 'bundle exec rake test'
+$ retest 'rails test'
+$ retest 'rspec'
+
+# Hardcode a test file to run indepdendently from the file you change
+$ retest 'ruby all_tests.rb'
+```
+
+**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
+
+## Roadmap
+
+- [x] MVP
+- [ ] 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.
+- [ ] Aliases from oh-my-zsh and bash profiles?
+
+## Development
+
+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.
+
+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
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/alexb52/retest.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "retest"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/retest

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+
+require 'retest'
+require 'open3'
+require 'listen'
+
+include Retest
+
+puts "Launching Retest..."
+command_to_run = ARGV.join(' ')
+
+listener = Listen.to('.', relative: true) do |modified, added, removed|
+  puts "modified absolute path: #{modified}"
+  system("clear") || system("cls")
+
+  if test_path = find_test(modified.first.strip, files: Dir.glob('**/**'))
+    puts ""
+    puts "Running: #{test_path}"
+    puts ""
+    system command_to_run.gsub('<test>', test_path)
+  else
+    puts "Could not find matching test to run"
+  end
+end
+listener.start # not blocking
+sleep

data/lib/retest/version.rb

@@ -0,0 +1,3 @@
+module Retest
+  VERSION = "0.1.1"
+end

data/lib/retest.rb

@@ -0,0 +1,20 @@
+require "retest/version"
+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/retest.gemspec

@@ -0,0 +1,30 @@
+require_relative 'lib/retest/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "retest"
+  spec.version       = Retest::VERSION
+  spec.authors       = ["Alexandre Barret"]
+  spec.email         = ["alex@abletech.nz"]
+
+  spec.summary       = "A simple command line too to watch file change and run its matching spec."
+  spec.homepage      = "https://github.com/AlexB52/retest"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/AlexB52/retest"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_runtime_dependency "string-similarity", ["~> 2.1"]
+  spec.add_runtime_dependency "listen", ["~> 3.2"]
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: retest
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Alexandre Barret
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-08-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: string-similarity
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description:
+email:
+- alex@abletech.nz
+executables:
+- retest
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/retest
+- lib/retest.rb
+- lib/retest/version.rb
+- retest.gemspec
+homepage: https://github.com/AlexB52/retest
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/AlexB52/retest
+  source_code_uri: https://github.com/AlexB52/retest
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: A simple command line too to watch file change and run its matching spec.
+test_files: []