retest 0.9.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8df33036507fe29259ef99ac9fa574fdece9af4e69911f21125a1c4bbad7778c
-  data.tar.gz: a4bb2606b7373fb304638125be08d94c79a5dfb5e324cbf433848730cf08abe6
+  metadata.gz: 13ce5e74ba4682f3777259a6565c585271dd7db5f6d753c4e5d6836f5c457634
+  data.tar.gz: bfc62c5fd481982435b3ee8e372839b7678e489d8123bbcd629c5ba56c2b7012
 SHA512:
-  metadata.gz: ba3f7823d9789965dbd44d92ac40aeb1f6d3dd9f35f6e634f317949adf72ba672abb231f4603acfe1da2c766d3158da81ca1c538868ab8be8955bfdf443651b0
-  data.tar.gz: 74f1a43fc0b23d48bd9a7cdd53c8a57206cbf9cc3546f1a6d2d0609d7f837744f1f74162ced9f57661f6008237b039f32ba2454289d839314ecfae5bc4ce011f
+  metadata.gz: ef3ee2efb84b012c5b6ba340d81e578ec512960e7fc28516abbc23689c8ad43f3c3a5ecd1855d51df1bcee5a426fdd92aef3f460a65fbb7c39d35d83ad08c735
+  data.tar.gz: e5af1bbe78c6bfa347088fc0ec3c8e985a1dbad5393f47640b7885cf4a0bbdd5cbc8c8922f7b189794027af4e7091dc36fd81693e5d785cf11e330fd2ea78dc0

data/.github/workflows/ci.yml

@@ -44,8 +44,10 @@ jobs:
       matrix:
         repo:
           - ruby-app
-          - rails-app
+          - ruby-bare
+          - git-ruby
           - hanami-app
+          - rails-app
           - rspec-rails
           - rspec-ruby
     steps:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    retest (0.9.0)
+    retest (1.2.0)
       listen (~> 3.2)
       string-similarity (~> 2.1)
       tty-option (~> 0.1)
@@ -11,12 +11,12 @@ GEM
   specs:
     byebug (11.1.3)
     ffi (1.15.0)
-    listen (3.4.1)
+    listen (3.5.0)
       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-fsevent (0.11.0)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     string-similarity (2.1.0)

data/README.md

@@ -1,3 +1,5 @@
+[![Gem Version](https://badge.fury.io/rb/retest.svg)](https://badge.fury.io/rb/retest)
+
 # Retest
 
 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)
@@ -13,6 +15,7 @@ Install it on your machine without adding it on a Gemfile:
     $ gem install retest
 
 ## Usage
+### Refactoring
 
 Launch `retest` in your terminal after accessing your ruby repository.
 
@@ -28,11 +31,10 @@ Few shortcut flags exist to avoid writing the full test command.
     $ retest --rails
     $ retest --rake --all
 
-Finally let retest automatically find your ruby setup and run the appropriate command using:
+Or let retest find your ruby setup and run the appropriate command using:
 
     $ retest
-    $ retest --auto
-    $ retest --auto --all
+    $ retest --all
 
 The gem works as follows:
 
@@ -41,7 +43,15 @@ The gem works as follows:
 * 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.
 
-See more example with `retest -h`
+### Diff Check
+
+You can diff a branch and test all the relevant test files before pushing your branch and trigger the full CI suite. 
+
+    $ retest --diff origin/main
+
+### Help
+
+See more examples with `retest -h`
 
 ```
 Usage: retest  [OPTIONS] [COMMAND]
@@ -82,6 +92,10 @@ Examples:
   Let retest identify which command to run for all tests
     $ retest --all
     $ retest --auto --all
+
+  Run a sanity check on changed files from a branch
+    $ retest --diff origin/main --rails
+    $ retest --diff main --auto
 ```
 
 ## Why?

data/bin/debug

@@ -13,6 +13,14 @@ if options.help?
   return
 end
 
-Retest.start(options.command) # not blocking
+program = Retest::Program.new(
+  repository: Retest::Repository.new(files: Retest::VersionControl.files),
+  runner: Retest::Runner.for(Retest::Command.for_options(options))
+)
 
-sleep
+if options.params[:diff]
+  program.diff(options.params[:diff])
+else
+  program.start # not blocking
+  sleep
+end

data/bin/test/git-ruby

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+bundle install
+bundle exec rake build
+ls -t pkg | head -n1 | xargs -I {} mv pkg/{} features/git-ruby/retest.gem
+docker-compose -f features/git-ruby/docker-compose.yml up --build --exit-code-from retest

data/bin/test/ruby-bare

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+bundle install
+bundle exec rake build
+ls -t pkg | head -n1 | xargs -I {} mv pkg/{} features/ruby-bare/retest.gem
+docker-compose -f features/ruby-bare/docker-compose.yml up --build --exit-code-from retest

data/exe/retest

@@ -11,6 +11,14 @@ if options.help?
   return
 end
 
-Retest.start(options.command) # not blocking
+program = Retest::Program.new(
+  repository: Retest::Repository.new(files: Retest::VersionControl.files),
+  runner: Retest::Runner.for(Retest::Command.for_options(options))
+)
 
-sleep
+if options.params[:diff]
+  program.diff(options.params[:diff])
+else
+  program.start # not blocking
+  sleep
+end

data/lib/retest.rb

@@ -8,23 +8,39 @@ require "retest/test_options"
 require "retest/options"
 require "retest/version_control"
 require "retest/setup"
+require "retest/command"
+require "retest/file_system"
 
 module Retest
   class Error < StandardError; end
 
-  class << self
-    def start(command)
+  class Program
+    attr_accessor :runner, :repository
+    def initialize(runner: nil, repository: nil)
+      @runner = runner
+      @repository = repository
+    end
+
+    def start
       puts "Launching Retest..."
+      build.start
+      puts "Ready to refactor! You can make file changes now"
+    end
 
-      build(
-        runner: Runner.for(command),
-        repository: Repository.new(files: VersionControl.files)
-      ).start
+    def diff(branch)
+      raise "Git not installed" unless VersionControl::Git.installed?
+      test_files = repository.find_tests VersionControl::Git.diff_files(branch)
 
-      puts "Ready to refactor! You can make file changes now"
+      puts "Tests found:"
+      test_files.each { |test_file| puts "  - #{test_file}" }
+
+      puts "Running tests..."
+      test_files.each { |test_file| runner.run test_file }
     end
 
-    def build(runner:, repository:)
+    private
+
+    def build
       Listen.to('.', only: /\.rb$/, relative: true) do |modified, added, removed|
         begin
           repository.add(added)
@@ -32,11 +48,15 @@ module Retest
           runner.remove(removed)
           system('clear 2>/dev/null') || system('cls 2>/dev/null')
 
-          runner.run repository.find_test (modified + added).first
+          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?
+    end
   end
 end

data/lib/retest/command.rb

@@ -0,0 +1,77 @@
+require_relative 'command/rails'
+require_relative 'command/rake'
+require_relative 'command/rspec'
+require_relative 'command/ruby'
+
+module Retest
+  class Command
+    extend Forwardable
+
+    def self.for_options(options)
+      new(options: options).command
+    end
+
+    def self.for_setup(setup)
+      new(setup: setup).command
+    end
+
+    def_delegator :setup, :type
+    def_delegators :options, :params, :full_suite?, :auto?
+
+    attr_accessor :options, :setup
+    def initialize(options: Options.new, setup: Setup.new, output_stream: STDOUT)
+      @options = options
+      @setup = setup
+      @output_stream = output_stream
+    end
+
+    def command
+      return default_command if auto?
+      options_command || default_command
+    end
+
+    def options_command
+      return params[:command] if params[:command]
+
+      if    params[:rspec] then rspec_command
+      elsif params[:rails] then rails_command
+      elsif params[:ruby]  then ruby_command
+      elsif params[:rake]  then rake_command
+      else
+      end
+    end
+
+    def setup_command
+      case type
+      when :rake  then rake_command
+      when :rspec then rspec_command
+      when :rails then rails_command
+      when :ruby  then ruby_command
+      else             ruby_command
+      end
+    end
+
+    def default_command
+      @output_stream.puts "Setup identified: [#{type.upcase}]. Using command: '#{setup_command}'"
+      setup_command
+    end
+
+    private
+
+    def rspec_command
+      Rspec.command(all: full_suite?)
+    end
+
+    def rails_command
+      Rails.command(all: full_suite?)
+    end
+
+    def rake_command
+      Rake.command(all: full_suite?)
+    end
+
+    def ruby_command
+      Ruby.command(all: full_suite?)
+    end
+  end
+end

data/lib/retest/command/rails.rb

@@ -0,0 +1,22 @@
+module Retest
+  class Command
+    Rails = Struct.new(:all, :file_system) do
+      def self.command(all:, file_system: FileSystem)
+        new(all, file_system).command
+      end
+
+      def command
+        return "#{root_command} <test>" unless all
+        root_command
+      end
+
+      private
+
+      def root_command
+        return 'bin/rails test' if file_system.exist? 'bin/rails'
+
+        'bundle exec rails test'
+      end
+    end
+  end
+end

data/lib/retest/command/rake.rb

@@ -0,0 +1,22 @@
+module Retest
+  class Command
+    Rake = Struct.new(:all, :file_system) do
+      def self.command(all:, file_system: FileSystem)
+        new(all, file_system).command
+      end
+
+      def command
+        return "#{root_command} TEST=<test>" unless all
+        root_command
+      end
+
+      private
+
+      def root_command
+        return 'bin/rake test' if file_system.exist? 'bin/rake'
+
+        'bundle exec rake test'
+      end
+    end
+  end
+end

data/lib/retest/command/rspec.rb

@@ -0,0 +1,22 @@
+module Retest
+  class Command
+    Rspec = Struct.new(:all, :file_system) do
+      def self.command(all:, file_system: FileSystem)
+        new(all, file_system).command
+      end
+
+      def command
+        return "#{root_command} <test>" unless all
+        root_command
+      end
+
+      private
+
+      def root_command
+        return 'bin/rspec' if file_system.exist? 'bin/rspec'
+
+        'bundle exec rspec'
+      end
+    end
+  end
+end

data/lib/retest/command/ruby.rb

@@ -0,0 +1,15 @@
+module Retest
+  class Command
+    module Ruby
+      module_function
+
+      def command(all: false, file_system: FileSystem)
+        if file_system.exist? 'Gemfile.lock'
+          'bundle exec ruby <test>'
+        else
+          'ruby <test>'
+        end
+      end
+    end
+  end
+end

data/lib/retest/file_system.rb

@@ -0,0 +1,9 @@
+module Retest
+  module FileSystem
+    module_function
+
+    def exist?(value)
+      File.exist? value
+    end
+  end
+end

data/lib/retest/options.rb

@@ -48,6 +48,12 @@ module Retest
         $ retest --all
         $ retest --auto --all
       EOS
+
+      example <<~EOS
+      Run a sanity check on changed files from a branch
+        $ retest --diff origin/main --rails
+        $ retest --diff main --auto
+      EOS
     end
 
     argument :command do
@@ -58,6 +64,11 @@ module Retest
       EOS
     end
 
+    option :diff do
+      desc "Pipes all matching tests from diffed branch to test command"
+      long "--diff=git-branch"
+    end
+
     flag :all do
       long "--all"
       desc "Run all the specs of a specificied ruby setup"
@@ -100,22 +111,8 @@ module Retest
       new(args).command
     end
 
-    def initialize(args = [], output_stream: STDOUT, setup: Setup)
+    def initialize(args = [])
       self.args = args
-      @output_stream = output_stream
-      @setup = setup
-    end
-
-    def command
-      return params[:command] if params[:command]
-
-      if    params[:rspec] then rspec_command
-      elsif params[:rake]  then rake_command
-      elsif params[:rails] then rails_command
-      elsif params[:ruby]  then ruby_command
-      elsif params[:auto]  then default_command
-      else                      default_command
-      end
     end
 
     def args=(args)
@@ -127,45 +124,19 @@ module Retest
       params[:help]
     end
 
-    private
-
     def full_suite?
       params[:all]
     end
 
-    def default_command
-      choose_command @setup.type, command_for(@setup.type)
+    def auto?
+      return true if no_options_passed?
+      params[:auto]
     end
 
-    def command_for(type)
-      case type
-      when :rspec then rspec_command
-      when :rails then rails_command
-      when :rake  then rake_command
-      when :ruby  then ruby_command
-      else             ruby_command
-      end
-    end
-
-    def choose_command(type, command)
-      @output_stream.puts "Setup identified: [#{type.upcase}]. Using command: '#{command}'"
-      command
-    end
-
-    def rspec_command
-      full_suite? ? ALL_RSPEC_COMMAND : RSPEC_COMMAND
-    end
-
-    def rails_command
-      full_suite? ? ALL_RAILS_COMMAND : RAILS_COMMAND
-    end
-
-    def rake_command
-      full_suite? ? ALL_RAKE_COMMAND : RAKE_COMMAND
-    end
+    private
 
-    def ruby_command
-      RUBY_COMMAND
+    def no_options_passed?
+      params.to_h.values.compact.uniq == [false]
     end
   end
 end

data/lib/retest/repository.rb

@@ -13,7 +13,17 @@ module Retest
       return unless path
       return if path.empty?
 
-      cache[path] ||= select_from TestOptions.for(path, files: files)
+      @path = path
+      cache[@path] ||= select_from TestOptions.for(@path, files: files)
+    end
+
+    def find_tests(paths)
+      paths
+        .select { |path| Regexp.new("\.rb$") =~ path }
+        .map    { |path| find_test(path) }
+        .compact
+        .uniq
+        .sort
     end
 
     def add(added)
@@ -47,7 +57,7 @@ module Retest
 
     def ask_question(tests)
       output_stream.puts <<~QUESTION
-        We found few tests matching:
+        We found few tests matching: #{@path}
         #{list_options(tests)}
 
         Which file do you want to use?

data/lib/retest/runner.rb

@@ -52,6 +52,14 @@ module Retest
         end
       end
 
+      def unmatching?
+        !matching?
+      end
+
+      def matching?
+        true
+      end
+
       private
 
       def purge_cache
@@ -65,6 +73,14 @@ module Retest
       end
 
       def remove(_ = nil); end
+
+      def unmatching?
+        !matching?
+      end
+
+      def matching?
+        false
+      end
     end
   end
 end

data/lib/retest/setup.rb

@@ -6,7 +6,7 @@ module Retest
 
     def type
       @type ||= begin
-        return :ruby unless has_gemfile?
+        return :ruby unless has_lock_file?
 
         if rspec?
           :rspec
@@ -22,8 +22,8 @@ module Retest
 
     private
 
-    def has_gemfile?
-      File.exist? 'Gemfile'
+    def has_lock_file?
+      File.exist? 'Gemfile.lock'
     end
 
     def rspec?
@@ -31,7 +31,7 @@ module Retest
     end
 
     def rails?
-      File.exist? 'bin/rails'
+      has_gem? 'rails'
     end
 
     def rake?
@@ -39,7 +39,7 @@ module Retest
     end
 
     def has_gem?(gem_name)
-      !`cat Gemfile | grep #{gem_name}`.empty?
+      !`cat Gemfile.lock | grep #{gem_name}`.empty?
     end
   end
 end

data/lib/retest/version.rb

@@ -1,3 +1,3 @@
 module Retest
-  VERSION = "0.9.0"
+  VERSION = "1.2.0"
 end

data/lib/retest/version_control.rb

@@ -1,3 +1,6 @@
+require_relative 'version_control/git'
+require_relative 'version_control/no_version_control'
+
 module Retest
   class VersionControl
     def self.files
@@ -6,43 +9,5 @@ module Retest
 
     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
-        (untracked_files + tracked_files).sort
-      end
-
-      private
-
-      def untracked_files
-        `git ls-files --other --exclude-standard -z`.split("\x0")
-      end
-
-      def tracked_files
-        `git ls-files -z`.split("\x0")
-      end
-    end
   end
 end

data/lib/retest/version_control/git.rb

@@ -0,0 +1,33 @@
+class Retest::VersionControl
+  class Git
+    def self.installed?
+      system "git -C . rev-parse 2>/dev/null"
+    end
+
+    def self.diff_files(branch)
+      new.diff_files(branch)
+    end
+
+    def name
+      'git'
+    end
+
+    def files
+      (untracked_files + tracked_files).sort
+    end
+
+    def diff_files(branch)
+      `git diff #{branch} --name-only --diff-filter=ACMRT -z`.split("\x0")
+    end
+
+    private
+
+    def untracked_files
+      `git ls-files --other --exclude-standard -z`.split("\x0")
+    end
+
+    def tracked_files
+      `git ls-files -z`.split("\x0")
+    end
+  end
+end

data/lib/retest/version_control/no_version_control.rb

@@ -0,0 +1,15 @@
+class Retest::VersionControl
+  class NoVersionControl
+    def self.installed?
+      true
+    end
+
+    def name
+      'default'
+    end
+
+    def files
+      Dir.glob('**/*') - Dir.glob('{tmp,node_modules}/**/*')
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: retest
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Alexandre Barret
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-16 00:00:00.000000000 Z
+date: 2021-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: string-similarity
@@ -72,13 +72,21 @@ files:
 - bin/console
 - bin/debug
 - bin/setup
+- bin/test/git-ruby
 - bin/test/hanami-app
 - bin/test/rails-app
 - bin/test/rspec-rails
 - bin/test/rspec-ruby
 - bin/test/ruby-app
+- bin/test/ruby-bare
 - exe/retest
 - lib/retest.rb
+- lib/retest/command.rb
+- lib/retest/command/rails.rb
+- lib/retest/command/rake.rb
+- lib/retest/command/rspec.rb
+- lib/retest/command/ruby.rb
+- lib/retest/file_system.rb
 - lib/retest/options.rb
 - lib/retest/repository.rb
 - lib/retest/runner.rb
@@ -86,6 +94,8 @@ files:
 - lib/retest/test_options.rb
 - lib/retest/version.rb
 - lib/retest/version_control.rb
+- lib/retest/version_control/git.rb
+- lib/retest/version_control/no_version_control.rb
 - retest.gemspec
 homepage: https://github.com/AlexB52/retest
 licenses: