retest 1.4.0 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c5dc87b26d27197158d859e17e179f9dc0b00ec2280dfefff165da388c77eb6
-  data.tar.gz: cffbfbf72ea1b51e7f63e288fba08727498ec582192536a54ad9d2b47f04d1d2
+  metadata.gz: 1574e44c17347c9a6e737481bfcbff782800cf68baef56f7f1dc2e1006f4f5b6
+  data.tar.gz: abe7fda8889c342859457f87b44a91e6e9e4a8cd0d8c764d6738422a8c9ed087
 SHA512:
-  metadata.gz: ad4051278ba14ff9f7284de5f8f643bdec7512864bb330aac803f6e3c672cc24f5584eb4b26be9f4a2b533a229fd5366a0eece8b4aa53eb816ff3e9c6575f200
-  data.tar.gz: 3b52308adcef24e6098f40ee07d55848f39104838c4db404394ee33a8ffe38466478cd18f347aa73b3a0072fc0c263592a9eecf1ed98e459345be160c02ed30f
+  metadata.gz: 9732e40769bbdc74ec7783dede4255c6cfb64a2517a8a92cffcbb838b54b714cd71f4244f7c06c6e238ce008facbd4e49f5fd0e6a4c5d73e2c225328254cf427
+  data.tar.gz: 791f6b3bf4d6b8b1eec931bff738bd6e795d51a41c17263c9ab6c0e47d15e1acfd70d18679387ce40520b871c8aabb184f4298f84a965c8e4c43b0b990465b62

data/.github/workflows/ci.yml

@@ -23,6 +23,8 @@ jobs:
           - 2.5
           - 2.6
           - 2.7
+          - '3.0'
+          - 3.1
         include:
           - os: macos-latest
             ruby: 2.5

data/.ruby-version

@@ -1 +1 @@
-2.6.6
+2.7.5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    retest (1.4.0)
+    retest (1.6.0)
       listen (~> 3.2)
       string-similarity (~> 2.1)
       tty-option (~> 0.1)
@@ -10,13 +10,13 @@ GEM
   remote: https://rubygems.org/
   specs:
     byebug (11.1.3)
-    ffi (1.15.4)
-    listen (3.7.0)
+    ffi (1.15.5)
+    listen (3.7.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    minitest (5.14.1)
+    minitest (5.15.0)
     rake (12.3.3)
-    rb-fsevent (0.11.0)
+    rb-fsevent (0.11.1)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     string-similarity (2.1.0)

data/README.md

@@ -6,7 +6,8 @@ Retest is a small command-line tool to help you refactor code by watching a file
 
 ## Demo
 
-![demo](https://alexbarret.com/images/external/retest-demo-26bcad04.gif)
+
+https://user-images.githubusercontent.com/7149034/153734043-1d136f27-5c24-4676-868b-0fde76016b13.mp4
 
 ## Installation
 
@@ -36,7 +37,11 @@ Example:
 
 In this example, the feature spec `spec/features/posts_spec.rb` will be tested after any ruby file is updated.
 
-#### 2. Run a dynamic command
+#### 2. Run a dynamic command with placeholders
+
+Retest provides few placeholders to help you run a command after every file change. The placeholders can be used on their own or together.
+
+1. `<test>` placeholder 
 
 You can use the placeholder `<test>` to tell the gem where to put the test file path in your command. When a file is changed, the gem will find its matching test and run the test command with it.
 
@@ -45,6 +50,16 @@ Example:
     $ retest 'bin/rails test <test>'
  
 In this example, if `app/models/post.rb` is changed then retest will run `bin/rails test test/models/post_test.rb`
+    
+2. `<changed>` placeholder
+    
+You can use the placeholder `<changed>` to tell the gem where to put the changed file path in your command. When a file is changed, the gem will run the command with it.
+
+Example:
+
+    $ retest 'rubocop <changed>'
+ 
+In this example, if `app/models/post.rb` is changed then retest will run `rubocop app/models/post.rb`  
 
 #### 3. Run a dynamic command with shortcuts
 

data/bin/debug

@@ -1,32 +1,6 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "retest"
 require "byebug"
 
-$stdout.sync = true
-
-options = Retest::Options.new(ARGV)
-
-if options.help?
-  $stdout.puts options.help
-  return
-end
-
-repository = Retest::Repository.new(files: Retest::VersionControl.files)
-command    = Retest::Command.for_options(options)
-runner     = Retest::Runner.for(command.to_s)
-
-program = Retest::Program.new(
-  extension: options.extension,
-  repository: repository,
-  command: command,
-  runner: runner
-)
-
-if options.params[:diff]
-  program.diff(options.params[:diff])
-else
-  program.start # not blocking
-  sleep
-end
+eval(File.read("exe/retest"))

data/exe/retest

@@ -13,10 +13,13 @@ end
 
 repository = Retest::Repository.new(files: Retest::VersionControl.files)
 command    = Retest::Command.for_options(options)
-runner     = Retest::Runner.for(command.to_s)
+runner     = Retest::Runners.runner_for(command.to_s)
+sounds     = Retest::Sounds.for(options)
+
+sounds.play(:tests_pass)
+runner.add_observer(sounds)
 
 program = Retest::Program.new(
-  extension: options.extension,
   repository: repository,
   command: command,
   runner: runner
@@ -24,7 +27,21 @@ program = Retest::Program.new(
 
 if options.params[:diff]
   program.diff(options.params[:diff])
-else
-  program.start # not blocking
-  sleep
+  return
 end
+
+# Main action
+
+$stdout.puts "Launching Retest..."
+Listen.to('.', only: options.extension, relative: true) do |modified, added, removed|
+  begin
+    program.run(modified, added, removed)
+  rescue => e
+    $stdout.puts "Something went wrong: #{e.message}"
+  end
+end.start
+$stdout.puts "Ready to refactor! You can make file changes now"
+
+# not blocking
+
+sleep

data/lib/retest/command/rails.rb

@@ -13,8 +13,8 @@ module Retest
         root_command
       end
 
-      def run_all(*files, runner:)
-        runner.run files.join(' ')
+      def format_batch(*files)
+        files.join(' ')
       end
 
       private

data/lib/retest/command/rake.rb

@@ -13,8 +13,8 @@ module Retest
         root_command
       end
 
-      def run_all(*files, runner:)
-        runner.run files.size > 1 ? "\"{#{files.join(',')}}\"" : files.first
+      def format_batch(*files)
+        files.size > 1 ? "\"{#{files.join(',')}}\"" : files.first
       end
 
       private

data/lib/retest/command/rspec.rb

@@ -13,8 +13,8 @@ module Retest
         root_command
       end
 
-      def run_all(*files, runner:)
-        runner.run files.join(' ')
+      def format_batch(*files)
+        files.join(' ')
       end
 
       private

data/lib/retest/command/ruby.rb

@@ -8,9 +8,8 @@ module Retest
         @all = all
       end
 
-      def run_all(*files, runner:)
-        paths = files.map { |file| "require './#{file}';" }.join
-        runner.run %Q{-e "#{paths}"}
+      def format_batch(*files)
+        %Q{-e "#{files.map { |file| "require './#{file}';" }.join}"}
       end
 
       def to_s

data/lib/retest/command.rb

@@ -19,10 +19,10 @@ module Retest
     def_delegators :options, :params, :full_suite?, :auto?
 
     attr_accessor :options, :setup
-    def initialize(options: Options.new, setup: Setup.new, output_stream: STDOUT)
+    def initialize(options: Options.new, setup: Setup.new, stdout: $stdout)
       @options = options
       @setup = setup
-      @output_stream = output_stream
+      @stdout = stdout
     end
 
     def command
@@ -52,7 +52,7 @@ module Retest
     end
 
     def default_command
-      @output_stream.puts "Setup identified: [#{type.upcase}]. Using command: '#{setup_command}'"
+      @stdout.puts "Setup identified: [#{type.upcase}]. Using command: '#{setup_command}'"
       setup_command
     end
 

data/lib/retest/options.rb

@@ -76,6 +76,11 @@ module Retest
       desc "Indentify repository setup and runs appropriate command"
     end
 
+    flag :notify do
+      long "--notify"
+      desc "Play a sound when specs pass or fail (macOS only)"
+    end
+
     flag :help do
       short "-h"
       long "--help"
@@ -130,6 +135,10 @@ module Retest
       params[:auto]
     end
 
+    def notify?
+      params[:notify]
+    end
+
     def extension
       Regexp.new(params[:ext])
     end

data/lib/retest/program.rb

@@ -1,17 +1,18 @@
 module Retest
   class Program
-    attr_accessor :runner, :repository, :command, :extension
-    def initialize(runner: nil, repository: nil, command: nil, extension: /\.rb$/)
+    attr_accessor :runner, :repository, :command
+    def initialize(runner: nil, repository: nil, command: nil)
       @runner = runner
       @repository = repository
       @command = command
-      @extension = extension
     end
 
-    def start
-      puts "Launching Retest..."
-      build.start
-      puts "Ready to refactor! You can make file changes now"
+    def run(modified, added, removed)
+      repository.sync(added: added, removed: removed)
+      runner.sync(added: added, removed: removed)
+      system('clear 2>/dev/null') || system('cls 2>/dev/null')
+
+      runner.run (modified + added).first, repository: repository
     end
 
     def diff(branch)
@@ -22,28 +23,7 @@ module Retest
       test_files.each { |test_file| puts "  - #{test_file}" }
 
       puts "Running tests..."
-      command.run_all *test_files, runner: runner
-    end
-
-    private
-
-    def build
-      Listen.to('.', only: extension, relative: true) do |modified, added, removed|
-        begin
-          repository.add(added)
-          repository.remove(removed)
-          runner.remove(removed)
-          system('clear 2>/dev/null') || system('cls 2>/dev/null')
-
-          runner.run test_file_to_run(modified + added)
-        rescue => e
-          puts "Something went wrong: #{e.message}"
-        end
-      end
-    end
-
-    def test_file_to_run(changed_files)
-      repository.find_test changed_files.first if runner.matching?
+      runner.run_all_tests command.format_batch(test_files)
     end
   end
 end

data/lib/retest/repository.rb

@@ -1,12 +1,12 @@
 module Retest
   class Repository
-    attr_accessor :files, :cache, :input_stream, :output_stream
+    attr_accessor :files, :cache, :stdin, :stdout
 
-    def initialize(files: [], cache: {}, input_stream: nil, output_stream: nil)
-      @cache         = cache
-      @files         = files
-      @input_stream  = input_stream || STDIN
-      @output_stream = output_stream|| STDOUT
+    def initialize(files: [], cache: {}, stdin: $stdin, stdout: $stdout)
+      @cache  = cache
+      @files  = files
+      @stdin  = stdin
+      @stdout = stdout
     end
 
     def find_test(path)
@@ -26,6 +26,11 @@ module Retest
         .sort
     end
 
+    def sync(added:, removed:)
+      add(added)
+      remove(removed)
+    end
+
     def add(added)
       return if added&.empty?
 
@@ -56,7 +61,7 @@ module Retest
     end
 
     def ask_question(tests)
-      output_stream.puts <<~QUESTION
+      stdout.puts(<<~QUESTION)
         We found few tests matching: #{@path}
         #{list_options(tests)}
 
@@ -72,7 +77,7 @@ module Retest
     end
 
     def get_input
-      input_stream.gets.chomp.to_i
+      stdin.gets.chomp.to_i
     end
   end
 end

data/lib/retest/runners/change_runner.rb

@@ -0,0 +1,17 @@
+module Retest
+  module Runners
+    class ChangeRunner < Runner
+      def run(changed_file = nil, repository: nil)
+        if changed_file
+          log("Changed File Selected: #{changed_file}")
+          system_run command.gsub('<changed>', changed_file)
+        else
+          log(<<~ERROR)
+            404 - Test File Not Found
+            Retest could not find a changed file to run.
+          ERROR
+        end
+      end
+    end
+  end
+end

data/lib/retest/runners/runner.rb

@@ -0,0 +1,41 @@
+module Retest
+  module Runners
+    class Runner
+      include Observable
+
+      attr_accessor :command, :stdout
+      def initialize(command, stdout: $stdout)
+        @stdout  = stdout
+        @command = command
+      end
+
+      def ==(obj)
+        command == obj.command && obj.class == self.class
+      end
+
+      def run(changed_file = nil, repository: nil)
+        system_run command
+      end
+
+      def run_all_tests(tests_string)
+        log("Test File Selected: #{tests_string}")
+        system_run command.gsub('<test>', tests_string)
+      end
+
+      def sync(added:, removed:)
+      end
+
+      private
+
+      def system_run(command)
+        result = system(command) ? :tests_pass : :tests_fail
+        changed
+        notify_observers(result)
+      end
+
+      def log(message)
+        stdout.puts(message)
+      end
+    end
+  end
+end

data/lib/retest/runners/test_runner.rb

@@ -0,0 +1,47 @@
+module Retest
+  module Runners
+    class TestRunner < Runner
+      def cached_test_file
+        @cached_test_file
+      end
+
+      def cached_test_file=(value)
+        @cached_test_file = value || @cached_test_file
+      end
+
+      def run(changed_file, repository:)
+        self.cached_test_file = repository.find_test(changed_file)
+
+        if cached_test_file
+          log("Test File Selected: #{cached_test_file}")
+          system_run command.gsub('<test>', cached_test_file)
+        else
+          log(<<~ERROR)
+            404 - Test File Not Found
+            Retest could not find a matching test file to run.
+          ERROR
+        end
+      end
+
+      def sync(added:, removed:)
+        remove(removed)
+      end
+
+      private
+
+      def remove(purged)
+        return if purged.empty?
+
+        if purged.is_a? Array
+          purge_cache if purged.include? cached_test_file
+        elsif purged.is_a? String
+          purge_cache if purged == cached_test_file
+        end
+      end
+
+      def purge_cache
+        @cached_test_file = nil
+      end
+    end
+  end
+end

data/lib/retest/runners/variable_runner.rb

@@ -0,0 +1,57 @@
+module Retest
+  module Runners
+    class VariableRunner < Runner
+      def cached_test_file
+        @cached_test_file
+      end
+
+      def cached_test_file=(value)
+        @cached_test_file = value || @cached_test_file
+      end
+
+      def run(changed_file, repository:)
+        self.cached_test_file = repository.find_test(changed_file)
+
+        return print_test_file_not_found unless cached_test_file
+
+        log(<<~FILES)
+          Files Selected:
+            - file: #{changed_file}
+            - test: #{cached_test_file}
+
+        FILES
+
+        system_run command
+          .gsub('<test>', cached_test_file)
+          .gsub('<changed>', changed_file)
+      end
+
+      def sync(added:, removed:)
+        remove(removed)
+      end
+
+      private
+
+      def print_test_file_not_found
+        log(<<~ERROR)
+          404 - Test File Not Found
+          Retest could not find a matching test file to run.
+        ERROR
+      end
+
+      def remove(purged)
+        return if purged.empty?
+
+        if purged.is_a? Array
+          purge_cache if purged.include? cached_test_file
+        elsif purged.is_a? String
+          purge_cache if purged == cached_test_file
+        end
+      end
+
+      def purge_cache
+        @cached_test_file = nil
+      end
+    end
+  end
+end

data/lib/retest/runners.rb

@@ -0,0 +1,22 @@
+require_relative 'runners/runner'
+require_relative 'runners/test_runner'
+require_relative 'runners/change_runner'
+require_relative 'runners/variable_runner'
+
+module Retest
+  module Runners
+    module_function
+
+    def runner_for(command)
+      if command.include?('<test>') && command.include?('<changed>')
+        VariableRunner
+      elsif command.include?('<test>')
+        TestRunner
+      elsif command.include?('<changed>')
+        ChangeRunner
+      else
+        Runner
+      end.new command
+    end
+  end
+end

data/lib/retest/sounds.rb

@@ -0,0 +1,36 @@
+module Retest
+  module Sounds
+    module_function
+
+    def for(options)
+      options.notify? ? MacOS.new : Mute.new
+    end
+
+    class Mute
+      def play(_)
+      end
+      alias update play
+    end
+
+    class MacOS
+      def initialize(kernel: Kernel, thread: Thread)
+        @kernel = kernel
+        @thread = thread
+      end
+
+      def play(sound)
+        args = case sound
+        when :tests_fail
+          ['afplay', '/System/Library/Sounds/Sosumi.aiff']
+        when :tests_pass
+          ['afplay', '/System/Library/Sounds/Funk.aiff']
+        else
+          raise ArgumentError.new("No sounds were found for type: #{sound}.")
+        end
+
+        @thread.new { @kernel.system(*args) }
+      end
+      alias update play
+    end
+  end
+end

data/lib/retest/version.rb

@@ -1,3 +1,3 @@
 module Retest
-  VERSION = "1.4.0"
+  VERSION = "1.6.1"
 end

data/lib/retest.rb

@@ -1,8 +1,9 @@
 require 'listen'
 require 'string/similarity'
+require 'observer'
 
 require "retest/version"
-require "retest/runner"
+require "retest/runners"
 require "retest/repository"
 require "retest/test_options"
 require "retest/options"
@@ -11,6 +12,7 @@ require "retest/setup"
 require "retest/command"
 require "retest/file_system"
 require "retest/program"
+require "retest/sounds"
 
 module Retest
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: retest
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.6.1
 platform: ruby
 authors:
 - Alexandre Barret
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-07 00:00:00.000000000 Z
+date: 2022-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: string-similarity
@@ -52,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
-description:
+description: 
 email:
 - alex@abletech.nz
 executables:
@@ -90,8 +90,13 @@ files:
 - lib/retest/options.rb
 - lib/retest/program.rb
 - lib/retest/repository.rb
-- lib/retest/runner.rb
+- lib/retest/runners.rb
+- lib/retest/runners/change_runner.rb
+- lib/retest/runners/runner.rb
+- lib/retest/runners/test_runner.rb
+- lib/retest/runners/variable_runner.rb
 - lib/retest/setup.rb
+- lib/retest/sounds.rb
 - lib/retest/test_options.rb
 - lib/retest/version.rb
 - lib/retest/version_control.rb
@@ -104,7 +109,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
@@ -119,8 +124,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.6
+signing_key: 
 specification_version: 4
 summary: A simple command line tool to watch file change and run its matching spec.
 test_files: []

data/lib/retest/runner.rb

@@ -1,86 +0,0 @@
-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 && obj.class == self.class
-      end
-
-      def cached_test_file
-        @cached_test_file
-      end
-
-      def cached_test_file=(value)
-        @cached_test_file = value || @cached_test_file
-      end
-
-      def run(test_file = nil)
-        self.cached_test_file = test_file
-
-        if 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
-
-      def remove(purged)
-        return if purged.empty?
-
-        if purged.is_a? Array
-          purge_cache if purged.include? cached_test_file
-        elsif purged.is_a? String
-          purge_cache if purged == cached_test_file
-        end
-      end
-
-      def unmatching?
-        !matching?
-      end
-
-      def matching?
-        true
-      end
-
-      private
-
-      def purge_cache
-        @cached_test_file = nil
-      end
-    end
-
-    HardcodedRunner = Struct.new(:command) do
-      def run(_ = nil)
-        system command
-      end
-
-      def remove(_ = nil); end
-
-      def unmatching?
-        !matching?
-      end
-
-      def matching?
-        false
-      end
-    end
-  end
-end