test_launcher 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 076fd8dd620db12cc980d5e0feb4e64bb0eb19d0
-  data.tar.gz: e69f9e56de5f8dd4c952301387e382ea298c8862
+  metadata.gz: a5d53997bd88d7bff2231d598664f4a9d2c17534
+  data.tar.gz: 665cc8fafb6894917dd92c8c788e3312698df4a0
 SHA512:
-  metadata.gz: ae02ab9956036df7e73ce62f6fad7ed39027eb0220c1e3516b726e47c60db3eb79f7522a8f8f8e0a5cbe0f8b8968a3b56aed6f8405e52319b04705f7471a131e
-  data.tar.gz: 9a55b973f8896de1ccbfbc34d25cdff69efbd3007f2857b27d21c5ca866a02fec717350cd76a8a5a8c7ac6b5e505de4e1c489b4e0a685e6eca23fbc18d164436
+  metadata.gz: 195db1420d9e19aeef576839f018f5a9596f5ef873401ae46e0a695a4fc52de4cf948092e714d627a367e9dcf8d91388c723a06067f9b01eeca9f3c91cce6168
+  data.tar.gz: a70dd282dcd28bab87961be98c848cb1d5b8a825d89b7befae3c67270f1331c17dd7a473ad6e265ea0875de9214f9db20fcef9a97c784acae0414c14aa45ad01

data/Gemfile

@@ -5,3 +5,4 @@ gemspec
 
 gem "minitest"
 gem "mocha"
+gem "pry"

data/README.md

@@ -1,6 +1,8 @@
 #Test Launcher -->
 
-Test Launcher takes some input and tries to figure out what test you want to run. It makes running tests on the command line much easier.  Test Launcher works with Minitest and probably TestUnit.  RSpec isn't supported.  If you use RSpec and you think this would be handy, let me know!
+Test Launcher takes some input and tries to figure out what test you want to run. It makes running tests on the command line much easier.  Test Launcher works with Minitest.  RSpec support is in its infancy.  You should try it and let me know!
+
+### Usage
 
 Let's suppose you want to run the test `test_name` in your `blog_post_test.rb`.  
 
@@ -13,7 +15,7 @@ ruby -I test test/models/blog_post_test.rb --name=test_blog_name_thing
 But with Test Launcher, you can just type this:
 
 ```
-t test_blog_name_thing
+test_launcher test_blog_name_thing
 
 #=> ruby -I test test/models/blog_post_test.rb --name=test_blog_name_thing
 ```
@@ -21,7 +23,7 @@ t test_blog_name_thing
 What if you want to run a whole file?  Just go for it!
 
 ```
-t blog_post_test
+test_launcher blog_post_test
 
 #=> ruby -I test test/models/blog_post_test.rb
 ```
@@ -29,7 +31,7 @@ t blog_post_test
 What if you just have the class name for the test?
 
 ```
-t BlogPostTest
+test_launcher BlogPostTest
 
 #=> ruby -I test test/models/blog_post_test.rb
 ```
@@ -37,14 +39,43 @@ t BlogPostTest
 But what if you aren't specific enough?
 
 ```
-t test_blog_na
+test_launcher test_blog_na
 
 #=> Found 10 test methods in 3 files.
 #=> Running most recently edited. Run with '--all' to run all the tests.
 #=> ruby -I test test/models/blog_post_test.rb --name=test_blog_name_thing
 ```
 
-Super fun? OH YEAH!
+What if you are very specific?
+```
+test_launcher /Users/username/code/my_repo/test/models/blog_post_test.rb
+
+#=> ruby -I test test/models/blog_post_test.rb
+```
+
+### Inline Gems
+
+Test Launcher will automatically move to the correct subdirectory in order to run the tests.  For example, if `thing_test.rb` is within your inline_gem, you can run:
+
+```
+test_launcher thing_test
+
+#=> cd /path/to/inline_gem && ruby -I test test/thing_test.rb
+```
+
+You don't have to run Test Launcher from the root of your project either.  It will figure things out.
+
+### Spring preloader
+
+Test Launcher will check for the spring/testunit binstubs.  If they are found in the app/gem/engine it will use spring:
+
+```
+test_launcher springified_test
+
+#=> cd /path/to/app && spring testunit test/springified_test.rb
+```
+
+Test Launcher will not use spring if the `DISABLE_SPRING=1` environment variable is set.
 
 #Installation
 
@@ -54,27 +85,33 @@ To install:
 gem install test_launcher
 ```
 
+Under the hood it uses git to search for files and to grep, so it will only work in git repositories. 
+
+
 #Setup
 
-This gem installs one executable called `test_launcher`.  That executable must be called with the `find` method, like so:
+This gem installs one executable called `test_launcher`.
 
 ```
-test_launcher find test_name_to_find
+test_launcher test_name_to_find
 ```
 
 For me, that's way too much to type, so I recommend adding an alias to your `.bash_profile` like so:
 
 ```
-alias t="test_launcher find"
+alias t='test_launcher'
+
+# If you are using RVM, use this: (see below for more details)
+alias t='NOEXEC_DISABLE=1 test_launcher'
 ```
 
-Now you can just type `t` instead of `test_launcher find`.  Much nicer!
+Now you can just type `t` instead of `test_launcher`.  Much nicer!
 
 #Usage
 
 Test Launcher searches for tests based on your input.
 
-Suppose you type `t thing`.  It will run tests using this priority preference:
+Suppose you type `test_launcher thing`.  It will run tests using this priority preference:
 
 1. A single, specific test method name or partial name
   - `def test_the_thing`
@@ -88,20 +125,66 @@ Suppose you type `t thing`.  It will run tests using this priority preference:
 1. Any test file based on a generic search
   - runs `stuff_test.rb` because it found the word `thing` inside of it
 
-Any time it matches multiple files, it will default to running the most recently edited file.  You can append `--all` if you want to run all matching tests.
+Any time it matches multiple files, it will default to running the most recently edited file.  You can append `--all` if you want to run all matching tests, even if they are in different engines/gems!
 
-#Does it work with inline gems?
+# RubyMine Support
 
-Yes!
+When working with inline gems/engines, RubyMine has a hard time figuring out what `test` folders to push into the load path for Minitest.  RubyMine also does not understand that in a project with inline engines, some of them may use Spring and some may not.  When working with inline gems/engines/apps in RubyMine, you end up having to 'Edit Configurations...' many times a day.  This is a bummer.
 
-Test Launcher will automatically move to the correct subdirectory in order to run the tests.  For example, if `thing_test.rb` is within your inline_gem, you can run:
+Test Launcher can be used from RubyMine to help alleviate these problems.  Requiring the `test_launcher/rubymine` file in your run configurations will allow Test Launcher to fix RubyMine's test running to do what you want.
+
+To use the RubyMine support:
 
+1. Open your project
+1. Click on Run -> 'Edit Configurations...'
+1. If you have any run configurations listed under 'Test::Unit/Shoulda/Minitest', use the minus button to remove them.
+1. Open the 'Defaults' and click on 'Test::Unit/Shoulda/Minitest'
+1. Under 'Ruby Arguments' change:
 
 ```
-t thing_test
+-e $stdout.sync=true;$stderr.sync=true;load($0=ARGV.shift)`
+```
+
+Replace it with:
 
-#=> cd ./path/to/inline_gem && ruby -I test test/thing_test.rb
+```
+-r test_launcher/rubymine
 ```
 
-You don't have to run Test Launcher from the root of your project either.  It will figure things out.
+1. Run a test.  Test Launcher should report that it is hijacking the test and it will output the command that it has decided to use.
+
+### Debugging Support
+
+Using Test Launcher to hijack your RubyMine run configuration should allow you to debug any test as well without issue.
+
+# Optimizing with RVM
+
+By default, RVM installs a hook to remove the need to run `bundle exec`.  When you run a gem command, it will search your bundle to see if that command is included in your bundle.  If it is, it will run that version of the command.  If it's not in your bundle, then it will fall back to the global gem.  You can read more about it on [rubygems-bundler](https://github.com/rvm/rubygems-bundler).
+
+Test Launcher is not installed in your bundle.  This means that the time that Bundler spends resolving your Gemfile to check if there's a test\_launcher executable in your bundle is wasted.  For most projects, the amount of time this takes is probably unnoticeable.
 
+On projects with lots of dependencies, this wasted time can be significant.  
+
+For example, in a large project, we get a nice improvement:
+
+```
+$:time test_launcher something_that_no_test_says
+#=> Could not find any tests.
+
+#=> real	0m2.214s
+#=> user	0m1.407s
+#=> sys	0m1.062s
+
+$:time NOEXEC_DISABLE=1 test_launcher something_that_no_test_might_say
+#=> Could not find any tests.
+
+#=> real	0m1.412s
+#=> user	0m0.745s
+#=> sys	0m0.945s
+```
+
+I suggest that if you are using RVM, you may as well make this your alias:
+
+```
+alias t='NOEXEC_DISABLE=1 test_launcher'
+```

data/Rakefile

@@ -1,2 +1,8 @@
 require "bundler/gem_tasks"
+require "rake/testtask"
 
+Rake::TestTask.new do |t|
+  t.test_files = Dir.glob("test/test_launcher/**/*_test.rb").reject {|f| f.match("fixtures")}
+end
+
+task :default => [:test]

data/bin/test_launcher

@@ -1,39 +1,12 @@
 #!/usr/bin/env ruby
 
-require "thor"
-require "test_launcher/searchers/git_searcher"
-require "test_launcher/tests/minitest/finder"
-require "test_launcher/tests/minitest/consolidator"
-require "test_launcher/shell/runner"
+require "test_launcher/cli/input_parser"
+require "test_launcher"
 
-class CLI < Thor
+input = TestLauncher::CLI::InputParser.new(ARGV)
 
-  desc "find", <<-DESC
-    Find tests and run them. By trying to match an individual test or the name of a test file(s).
-  DESC
-  option :all, type: :boolean, desc: %{Run all tests found!}, default: false
-
-  def find(input)
-    if input == '--help'
-      `test_launcher --help find`
-      exit
-    end
-
-    shell = TestLauncher::Shell::Runner.new(
-      log_path: '/tmp/test_launcher.log',
-      working_directory: '.',
-
-    )
-
-    searcher = TestLauncher::Searchers::GitSearcher.new(shell)
-    search_results = TestLauncher::Tests::Minitest::Finder.find(input, searcher)
-
-    test_wrapper = TestLauncher::Tests::Minitest::Consolidator.consolidate(search_results, shell, options[:all])
-
-    shell.exec test_wrapper.to_command
-  end
-
-  default_task :find
-end
-
-CLI.start(ARGV)
+TestLauncher.launch(
+  input.query,
+  run_all: input.options[:run_all],
+  framework: input.options[:framework]
+)

data/lib/test_launcher.rb

@@ -1,4 +1,26 @@
 require "test_launcher/version"
 
+require "test_launcher/shell/runner"
+require "test_launcher/search/git"
+require "test_launcher/frameworks"
+
 module TestLauncher
+  def self.launch(input, framework: "guess", run_all: false)
+    shell = Shell::Runner.new(log_path: '/tmp/test_launcher.log')
+    searcher = Searchers::Git.new(shell)
+
+    command = Frameworks.locate(
+      framework_name: framework,
+      shell: shell,
+      searcher: searcher,
+      input: input,
+      run_all: run_all
+    )
+
+    if command
+      shell.exec command
+    else
+      shell.warn "No tests found."
+    end
+  end
 end

data/lib/test_launcher/cli/input_parser.rb

@@ -0,0 +1,73 @@
+require "test_launcher/version"
+require "optparse"
+
+module TestLauncher
+  module CLI
+    class InputParser
+      ParseError = Class.new(RuntimeError)
+
+      BANNER = <<-DESC
+Find tests and run them by trying to match an individual test or the name of a test file(s).
+
+See full README: https://github.com/petekinnecom/test_launcher
+
+Usage: `test_launcher "search string" [--all]`
+
+VERSION: #{TestLauncher::VERSION}
+
+      DESC
+
+      def initialize(args)
+        @query = args
+        @options = {}
+        option_parser.parse!(args)
+      rescue OptionParser::ParseError
+        puts "Invalid arguments"
+        puts "----"
+        puts option_parser
+        exit
+      end
+
+      def query
+        if @query.size == 0
+          puts option_parser
+          exit
+        elsif @query.size > 1
+          puts "Concatenating args to single string. (see https://github.com/petekinnecom/test_launcher)"
+        end
+
+        @query.join(" ")
+      end
+
+      def options
+        @options
+      end
+
+      private
+
+      def option_parser
+        OptionParser.new do |opts|
+          opts.banner = BANNER
+
+          opts.on("-a", "--all", "Run all matching tests. Defaults to false.") do
+            options[:run_all] = true
+          end
+
+          opts.on("-h", "--help", "Prints this help") do
+            puts opts
+            exit
+          end
+
+          opts.on("-v", "--version", "Display the version info") do
+            puts TestLauncher::VERSION
+            exit
+          end
+
+          opts.on("-f", "--framework framework", "The testing framework being used. Valid options: ['minitest', 'rspec', 'guess']. Defaults to 'guess'") do |framework|
+            options[:framework] = framework
+          end
+        end
+      end
+    end
+  end
+end

data/lib/test_launcher/frameworks.rb

@@ -0,0 +1,32 @@
+require "test_launcher/frameworks/base"
+require "test_launcher/frameworks/minitest"
+require "test_launcher/frameworks/rspec"
+
+module TestLauncher
+  module Frameworks
+    def self.locate(framework_name:, input:, run_all:, shell:, searcher:)
+      frameworks = guess_frameworks(framework_name)
+
+      frameworks.each do |framework|
+        search_results = framework::Locator.new(input, searcher).prioritized_results
+        runner = framework::Runner.new
+
+        command = Implementation::Consolidator.consolidate(search_results, shell, runner, run_all)
+
+        return command if command
+      end
+
+      nil
+    end
+
+    def self.guess_frameworks(framework_name)
+      if framework_name == "rspec"
+        [RSpec]
+      elsif framework_name == "minitest"
+        [Minitest]
+      else
+        [Minitest, RSpec].select(&:active?)
+      end
+    end
+  end
+end

data/lib/test_launcher/frameworks/base.rb

@@ -0,0 +1,54 @@
+require "test_launcher/frameworks/implementation/locator"
+require "test_launcher/frameworks/implementation/test_case"
+require "test_launcher/frameworks/implementation/consolidator"
+
+module TestLauncher
+  module Frameworks
+    module Base
+      class Locator < Implementation::Locator
+        def file_name_regex
+          # for ruby to match on file names
+          raise NotImplementedError
+        end
+
+        def file_name_pattern
+          # for bash to match on file names
+          raise NotImplementedError
+        end
+
+        def regex_pattern
+          # to match on examples
+          raise NotImplementedError
+        end
+      end
+
+      class Runner
+        def single_example(test_case)
+          raise NotImplementedError
+        end
+
+        def one_or_more_files(test_cases)
+          raise NotImplementedError
+        end
+
+        def single_file(test_case)
+          one_or_more_files([test_case])
+        end
+
+        def multiple_files(collection)
+          collection
+            .group_by(&:app_root)
+            .map { |_root, test_cases| one_or_more_files(test_cases) }
+            .join("; cd -;\n\n")
+        end
+      end
+
+      class TestCase < Implementation::TestCase
+        def test_root_folder_name
+          # directory where tests are found
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end