retest 0.6.0.pre → 0.8.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d366f005d9765a2da827543e444b70898d9a7f94f5fd8c2ca5782b3fa5a0058
-  data.tar.gz: de7a1863a92188221e05955fa518a54c4f73fe3468ca15c47b7a6aa36f1baa66
+  metadata.gz: 62ae62a28685056281a2e89c483ac3b16f7eaa11c486d764d5404ebcbbeb493a
+  data.tar.gz: 4f9b0a6be227cea4e858e0a36ebafadbc47385629c17fe568e194be99348edfa
 SHA512:
-  metadata.gz: 3277b79fce91040aac14f7e4980dc3687d6f02caed5ba47d629b106371780c65378e5dc1ecdcfa149c51e00f23022897aadb2c1cc249f3ca209ef267691f6f73
-  data.tar.gz: f8de2fc0468a666afe0e526b334147c5c32dbcb42a0621dbf7a0e7af084806500cba083dc19833174c6a3862715e2ed046dbe032576ef844823e1cdbd763153a
+  metadata.gz: be4c01100fdbb277eae592d26bfd1cddce64097a815418d042b746ea1b438f182e744718850fba1ee4cf79a62a6218bdb222d267b4a14f478ddb0dcc5e0f67a1
+  data.tar.gz: 9bd2dd59fead6115cd26df9f1b180b1cc432a568003bfff3469a016ceac7852ee561c5701c48778dfd430229d9e9122128740e0269c17e9bad54a05f213c8622

data/.github/workflows/ci.yml

@@ -15,14 +15,18 @@ on:
 
 jobs:
   test:
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
     strategy:
       matrix:
+        os: [ubuntu-latest]
         ruby:
           - 2.5
           - 2.6
           - 2.7
-    name: Ruby ${{ matrix.ruby }} test
+        include:
+          - os: macos-latest
+            ruby: 2.5
+    name: Ruby ${{ matrix.ruby }} test (${{ matrix.os }})
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby
@@ -32,4 +36,4 @@ jobs:
         bundler-cache: true
     - run: bundle install
     - run: bundle exec rake
-    - run: bundle exec cucumber
+    - run: CUCUMBER_PUBLISH_QUIET=true bundle exec cucumber

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    retest (0.6.0.pre)
+    retest (0.8.0.pre)
       listen (~> 3.2)
       string-similarity (~> 2.1)
+      tty-option (~> 0.1)
 
 GEM
   remote: https://rubygems.org/
@@ -61,7 +62,7 @@ GEM
     ffi (1.13.1)
     i18n (1.8.5)
       concurrent-ruby (~> 1.0)
-    listen (3.3.1)
+    listen (3.4.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     middleware (0.1.0)
@@ -85,6 +86,7 @@ GEM
       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)

data/README.md

@@ -16,29 +16,46 @@ For fully fledged solutions, some cli tools already exists: [autotest](https://g
 Install it on your machine with:
 
     $ gem install retest
+    $ retest 'bundle exec rspec <test>'
 
 ## Usage
 
 Launch `retest` in your terminal after accessing your ruby project folder.
 
-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.
+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.
 
-```bash
-# Let retest find the test file and replace the placeholder with the path of the test file
-$ retest 'bundle exec rake test TEST=<test>'
-$ retest 'rails test <test>'
-$ retest 'rspec <test>'
-$ retest 'ruby <test>'
-$ retest 'docker-compose exec web bundle exec rails test <test>'
-
-# Run the same command after a file change like all the spec files
-$ retest 'bundle exec rake test'
-$ retest 'rails test'
-$ retest 'rspec'
-$ retest 'docker-compose exec web bundle exec rails test'
-
-# Hardcode a test file to run independently from the file you change
-$ retest 'ruby all_tests.rb'
+Learn more by running `retest -h`
+
+```
+Usage: retest  [OPTIONS] [COMMAND]
+
+Watch a file change and run it matching spec.
+
+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
+  -h, --help   Print usage
+      --rails  Shortcut for 'bundle exec rails test <test>'
+      --rake   Shortcut for 'bundle exec rake test TEST=<test>'
+      --rspec  Shortcut for 'bundle exec rspec <test>'
+      --ruby   Shortcut for 'bundle exec ruby <test>'
+
+Examples:
+  Runs a matching rails test after a file change
+    $ retest 'bundle exec rails test <test>'
+    $ retest --rails
+
+  Runs all rails tests after a file change
+    $ retest 'bundle exec rails test'
+    $ retest --rails --all
+
+  Runs a hardcoded command after a file change
+    $ retest 'ruby lib/bottles_test.rb'
 ```
 
 The gem works as follows:
@@ -47,25 +64,23 @@ The gem works as follows:
 * 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 a Docker container seems to work
+Retest works in Docker too. You can install the gem and launch retest in your container while refactoring.
 ```bash
-$ docker-compose run web bash
+$ docker-compose run web bash # enter your container
 $ 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
 
 ## Ruby Support
 
-Retest supports ruby 2.5 and above.
+Retest supports ruby 2.4 and above.
 
 ## Roadmap
 

data/exe/retest

@@ -2,14 +2,12 @@
 
 require 'retest'
 
-Retest.logger = STDOUT
+$stdout.sync = true
 
-Retest.log "Launching Retest..."
+options = Retest::Options.new(ARGV)
 
-Retest
-  .build(command: Retest::Command.for(ARGV.join))
-  .start # not blocking
+return puts options.help if options.help?
 
-Retest.log "Ready to refactor! You can make file changes now"
+Retest.start(options.command) # not blocking
 
 sleep

data/lib/retest.rb

@@ -2,25 +2,44 @@ require 'listen'
 require 'string/similarity'
 
 require "retest/version"
-require "retest/command"
+require "retest/runner"
 require "retest/repository"
 require "retest/test_options"
-require "retest/listen_options"
-require "retest/concerns/configurable"
+require "retest/options"
+require "retest/version_control"
 
 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)
+  class << self
+    def start(command)
+      puts "Launching Retest..."
+
+      build(
+        runner: Runner.for(command),
+        repository: Repository.new(files: VersionControl.files)
+      ).start
+
+      puts "Ready to refactor! You can make file changes now"
+    end
+
+    def build(runner:, repository:)
+      Listen.to('.', only: /\.rb$/, relative: true) do |modified, added, removed|
+        STDOUT.puts modified
+        STDOUT.puts added
+        STDOUT.puts removed
+        begin
+          if modified.any?
+            system('clear 2>/dev/null') || system('cls 2>/dev/null')
+            runner.run repository.find_test(modified.first.strip)
+          elsif added.any?
+            repository.add(added)
+            system('clear 2>/dev/null') || system('cls 2>/dev/null')
+            runner.run repository.find_test(added.first.strip)
+          end
+        rescue => e
+          puts "Something went wrong: #{e.message}"
         end
-      rescue => e
-        puts "Something went wrong: #{e.message}"
       end
     end
   end

data/lib/retest/options.rb

@@ -0,0 +1,114 @@
+require 'tty-option'
+
+module Retest
+  class Options
+    include TTY::Option
+
+    RSPEC_COMMAND = "bundle exec rspec <test>"
+    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"
+    ALL_RSPEC_COMMAND = "bundle exec rspec"
+
+    usage do
+      program "retest"
+
+      command nil
+
+      desc "Watch a file change and run it matching spec."
+
+      example <<~EOS
+      Runs a matching rails test after a file change
+        $ retest 'bundle exec rails test <test>'
+        $ retest --rails
+      EOS
+
+      example <<~EOS
+      Runs all rails tests after a file change
+        $ retest 'bundle exec rails test'
+        $ retest --rails --all
+      EOS
+
+      example <<~EOS
+      Runs a hardcoded command after a file change
+        $ retest 'ruby lib/bottles_test.rb'
+      EOS
+    end
+
+    argument :command do
+      optional
+      desc <<~EOS
+      The test command to rerun when a file changes.
+      Use <test> placeholder to tell retest where to put the matching spec.
+      EOS
+    end
+
+    flag :all do
+      long "--all"
+      desc "Run all the specs of a specificied ruby setup"
+    end
+
+    flag :help do
+      short "-h"
+      long "--help"
+      desc "Print usage"
+    end
+
+    flag :rspec do
+      long "--rspec"
+      desc "Shortcut for '#{RSPEC_COMMAND}'"
+    end
+
+    flag :rake do
+      long "--rake"
+      desc "Shortcut for '#{RAKE_COMMAND}'"
+    end
+
+    flag :rails do
+      long "--rails"
+      desc "Shortcut for '#{RAILS_COMMAND}'"
+    end
+
+    flag :ruby do
+      long "--ruby"
+      desc "Shortcut for '#{RUBY_COMMAND}'"
+    end
+
+    attr_reader :args
+
+    def self.command(args)
+      new(args).command
+    end
+
+    def initialize(args = [])
+      self.args = args
+    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
+      end
+    end
+
+    def args=(args)
+      @args = args
+      parse args
+    end
+
+    def help?
+      params[:help]
+    end
+  end
+end

data/lib/retest/repository.rb

@@ -1,17 +1,23 @@
 module Retest
   class Repository
-    attr_accessor :files, :cache, :input_stream
+    attr_accessor :files, :cache, :input_stream, :output_stream
 
-    def initialize(files: nil, cache: {}, input_stream: nil)
+    def initialize(files: [], cache: {}, input_stream: nil, output_stream: nil)
       @cache         = cache
-      @files         = files || default_files
+      @files         = 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
 
+    def add(new_files)
+      files.push(*new_files)
+      files.sort!
+    end
+
     private
 
     def select_from(tests)
@@ -24,12 +30,8 @@ module Retest
       end
     end
 
-    def default_files
-      @default_files ||= Dir.glob('**/*') - Dir.glob('{tmp,node_modules}/**/*')
-    end
-
     def ask_question(tests)
-      Retest.log <<~QUESTION
+      output_stream.puts <<~QUESTION
         We found few tests matching:
         #{list_options(tests)}
 

data/lib/retest/runner.rb

@@ -0,0 +1,42 @@
+module Retest
+  class Runner
+    def self.for(test_command)
+      if test_command.include? '<test>'
+        VariableRunner
+      else
+        HardcodedRunner
+      end.new test_command
+    end
+
+    class VariableRunner
+      attr_reader :command
+
+      def initialize(command)
+        @command = command
+        @cached_test_file = nil
+      end
+
+      def ==(obj)
+        command == obj.command
+      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)
+        else
+          puts <<~ERROR
+            404 - Test File Not Found
+            Retest could not find a matching test file to run.
+          ERROR
+        end
+      end
+    end
+
+    HardcodedRunner = Struct.new(:command) do
+      def run(_ = nil)
+        system command
+      end
+    end
+  end
+end

data/lib/retest/version.rb

@@ -1,3 +1,3 @@
 module Retest
-  VERSION = "0.6.0.pre"
+  VERSION = "0.8.0.pre"
 end

data/lib/retest/version_control.rb

@@ -0,0 +1,38 @@
+module Retest
+  class VersionControl
+    def self.files
+      [Git, NoVersionControl].select(&:installed?).first.new.files
+    end
+
+    def name; end
+    alias :to_s :name
+
+    class NoVersionControl
+      def self.installed?
+        true
+      end
+
+      def name
+        'default'
+      end
+
+      def files
+        Dir.glob('**/*') - Dir.glob('{tmp,node_modules}/**/*')
+      end
+    end
+
+    class Git
+      def self.installed?
+        system "git -C . rev-parse 2>/dev/null"
+      end
+
+      def name
+        'git'
+      end
+
+      def files
+        `git ls-files`.split("\n")
+      end
+    end
+  end
+end

data/retest.gemspec

@@ -27,4 +27,5 @@ 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_runtime_dependency "tty-option", ["~> 0.1"]
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: retest
 version: !ruby/object:Gem::Version
-  version: 0.6.0.pre
+  version: 0.8.0.pre
 platform: ruby
 authors:
 - Alexandre Barret
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-16 00:00:00.000000000 Z
+date: 2021-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: string-similarity
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: tty-option
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 description:
 email:
 - alex@abletech.nz
@@ -59,13 +73,12 @@ files:
 - bin/setup
 - exe/retest
 - lib/retest.rb
-- lib/retest/command.rb
-- lib/retest/concerns/configurable.rb
-- lib/retest/listen_options.rb
+- lib/retest/options.rb
 - lib/retest/repository.rb
+- lib/retest/runner.rb
 - lib/retest/test_options.rb
 - lib/retest/version.rb
-- output.log
+- lib/retest/version_control.rb
 - retest.gemspec
 homepage: https://github.com/AlexB52/retest
 licenses:

data/lib/retest/command.rb

@@ -1,50 +0,0 @@
-require 'open3'
-
-module Retest
-  class Command
-    def self.for(test_command)
-      if test_command.include? '<test>'
-        VariableCommand
-      else
-        HardcodedCommand
-      end.new test_command
-    end
-
-    class VariableCommand
-      attr_reader :command, :repository, :cached_test_file
-
-      def initialize(command, repository: nil)
-        @repository = repository || Repository.new
-        @command = command
-      end
-
-      def ==(obj)
-        command == obj.command
-      end
-
-      def run(file_changed)
-        if @cached_test_file = test_file(file_changed)
-          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
-          Retest.log <<~ERROR
-            404 - Test File Not Found
-            Retest could not find a matching test file to run.
-          ERROR
-        end
-      end
-
-      def test_file(file_changed)
-        repository.find_test(file_changed) || cached_test_file
-      end
-    end
-
-    HardcodedCommand = Struct.new(:command) do
-      def run(_)
-        stdout_and_stderr_str, _ = Open3.capture2e(command)
-        Retest.log stdout_and_stderr_str
-      end
-    end
-  end
-end

data/lib/retest/concerns/configurable.rb

@@ -1,30 +0,0 @@
-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

@@ -1,36 +0,0 @@
-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