m 1.3.3 → 1.3.4

data/lib/m/executor.rb

@@ -0,0 +1,101 @@
+require_relative 'runners/base'
+require_relative 'runners/minitest_5'
+require_relative 'runners/minitest_4'
+require_relative 'runners/test_unit'
+require_relative 'runners/unsupported_framework'
+
+module M
+  class Executor
+    def initialize(testable)
+      @testable = testable
+    end
+
+    def execute
+      # Locate tests to run that may be inside of this line. There could be more than one!
+      tests_to_run = tests.within(testable.line)
+
+      # If we found any tests,
+      if tests_to_run.size > 0
+        # assemble the regexp to run these tests,
+        test_names = tests_to_run.map { |test| Regexp.escape(test.name) }.join('|')
+
+        # set up the args needed for the runner
+        test_arguments = ["-n", "/^(#{test_names})$/"]
+
+        # directly run the tests from here and exit with the status of the tests passing or failing
+        runner.run(test_arguments)
+      elsif tests.size > 0
+        # Otherwise we found no tests on this line, so you need to pick one.
+        message = "No tests found on line #{testable.line}. Valid tests to run:\n\n"
+
+        # For every test ordered by line number,
+        # spit out the test name and line number where it starts,
+        tests.by_line_number do |test|
+          message << "#{sprintf("%0#{tests.column_size}s", test.name)}: m #{testable.file}:#{test.start_line}\n"
+        end
+
+        # Spit out helpful message and bail
+        STDERR.puts message
+        false
+      else
+        # There were no tests at all
+        message = "There were no tests found.\n\n"
+        STDERR.puts message
+        false
+      end
+    end
+
+    private
+
+    attr_reader :testable
+
+    # Shoves tests together in our custom container and collection classes.
+    # Memoize it since it's unnecessary to do this more than one for a given file.
+    def tests
+      @tests ||= begin
+                   require "m/test_collection"
+                   require "m/test_method"
+                   # With each suite and array of tests,
+                   # and with each test method present in this test file,
+                   # shove a new test method into this collection.
+                   suites.inject(TestCollection.new) do |collection, (suite_class, test_methods)|
+                     test_methods.each do |test_method|
+                     collection << TestMethod.create(suite_class, test_method)
+                   end
+                   collection
+                   end
+                 end
+    end
+
+
+    # Finds all test suites in this test file, with test methods included.
+    def suites
+      # Since we're not using `ruby -Itest -Ilib` to run the tests, we need to add this directory to the `LOAD_PATH`
+      $:.unshift "./test", "./spec", "./lib"
+
+      begin
+        # Fire up this Ruby file. Let's hope it actually has tests.
+        load testable.file
+      rescue LoadError => e
+        # Fail with a happier error message instead of spitting out a backtrace from this gem
+        STDERR.puts "Failed loading test file:\n#{e.message}"
+        return []
+      end
+
+      suites = runner.suites
+
+      # Use some janky internal APIs to group test methods by test suite.
+      suites.inject({}) do |test_suites, suite_class|
+        # End up with a hash of suite class name to an array of test methods, so we can later find them and ignore empty test suites
+        if runner.test_methods(suite_class).any?
+          test_suites[suite_class] = runner.test_methods(suite_class)
+        end
+        test_suites
+      end
+    end
+
+    def runner
+      @runner ||= M::Frameworks.framework_runner
+    end
+  end
+end

data/lib/m/frameworks.rb

@@ -1,5 +1,35 @@
 module M
   class Frameworks
+    def self.framework_runner
+      new.framework_runner
+    end
+
+    def framework_runner
+      if minitest5?
+        Runners::Minitest5.new
+      elsif minitest4?
+        Runners::Minitest4.new
+      elsif test_unit?
+        Runners::TestUnit.new
+      else
+        Runners::UnsupportedFramework.new
+      end
+    end
+
+    private
+
+    def minitest5?
+      defined?(Minitest) && Minitest::Unit::VERSION.start_with?("5")
+    end
+
+    def minitest4?
+      defined?(MiniTest)
+    end
+
+    def test_unit?
+      defined?(Test)
+    end
+
     def self.minitest5?
       defined?(Minitest) && Minitest::Unit::VERSION.start_with?("5")
     end
@@ -7,5 +37,9 @@ module M
     def self.minitest4?
       defined?(MiniTest)
     end
+
+    def self.test_unit?
+      defined?(Test)
+    end
   end
 end

data/lib/m/parser.rb

@@ -0,0 +1,74 @@
+require_relative 'testable'
+
+module M
+  class Parser
+    def initialize(argv)
+      @argv = argv
+      @testable = Testable.new
+    end
+
+    def parse
+      # With no arguments,
+      if argv.empty?
+        # Just shell out to `rake test`.
+        exec "rake test"
+      else
+        parse_options! argv
+
+        # Parse out ARGV, it should be coming in in a format like `test/test_file.rb:9`
+        testable.file, testable.line = argv.first.split(':')
+
+        # If this file is a directory, not a file, run the tests inside of this directory
+        if Dir.exist?(testable.file)
+          # Make a new rake test task with a hopefully unique name, and run every test looking file in it
+          require "rake/testtask"
+          Rake::TestTask.new(:m_custom) do |t|
+            t.libs << 'test'
+            t.libs << 'spec'
+            t.test_files = FileList["#{testable.file}/*test*.rb", "#{testable.file}/*spec*.rb"]
+          end
+          # Invoke the rake task and exit, hopefully it'll work!
+          begin
+            Rake::Task['m_custom'].invoke
+          rescue RuntimeError
+            exit
+          ensure
+            exit
+          end
+        else
+          return testable
+        end
+      end
+    end
+
+    private
+
+    attr_reader :argv, :testable
+
+    def parse_options!(argv)
+      require 'optparse'
+
+      OptionParser.new do |opts|
+        opts.banner  = 'Options:'
+        opts.version = M::VERSION
+
+        opts.on '-h', '--help', 'Display this help.' do
+          puts "Usage: m [OPTIONS] [FILES]\n\n", opts
+          exit
+        end
+
+        opts.on '--version', 'Display the version.' do
+          puts "m #{M::VERSION}"
+          exit
+        end
+
+        opts.on '-l', '--line LINE', Integer, 'Line number for file.' do |line|
+          p "parsing line #{line}"
+          testable.line = line
+        end
+
+        opts.parse! argv
+      end
+    end
+  end
+end

data/lib/m/runner.rb

@@ -0,0 +1,20 @@
+require_relative 'parser'
+require_relative 'executor'
+
+### Runners are in charge of running your tests, depending on the framework
+# Instead of slamming all of this junk in an `M` class, it's here instead.
+module M
+  class Runner
+    def initialize(argv)
+      @argv = argv
+    end
+
+    # There's two steps to running our tests:
+    # 1. Parsing the given input for the tests we need to find (or groups of tests)
+    # 2. Run those tests we found that match what you wanted
+    def run
+      testable = Parser.new(@argv).parse
+      Executor.new(testable).execute
+    end
+  end
+end

data/lib/m/runners/base.rb

@@ -0,0 +1,17 @@
+module M
+  module Runners
+    class Base
+      def suites
+        raise 'Not implemented'
+      end
+
+      def run(_test_arguments)
+        raise 'Not implemented'
+      end
+
+      def test_methods(suite_class)
+        suite_class.test_methods
+      end
+    end
+  end
+end

data/lib/m/runners/minitest_4.rb

@@ -0,0 +1,13 @@
+module M
+  module Runners
+    class Minitest4 < Base
+      def suites
+        MiniTest::Unit::TestCase.test_suites
+      end
+
+      def run(test_arguments)
+        MiniTest::Unit.runner.run test_arguments
+      end
+    end
+  end
+end

data/lib/m/runners/minitest_5.rb

@@ -0,0 +1,17 @@
+module M
+  module Runners
+    class Minitest5 < Base
+      def suites
+        Minitest::Runnable.runnables
+      end
+
+      def run(test_arguments)
+        Minitest.run test_arguments
+      end
+
+      def test_methods(suite_class)
+        suite_class.runnable_methods
+      end
+    end
+  end
+end

data/lib/m/runners/test_unit.rb

@@ -0,0 +1,13 @@
+module M
+  module Runners
+    class TestUnit < Base
+      def suites
+        Test::Unit::TestCase.test_suites
+      end
+
+      def run(test_arguments)
+        Test::Unit::AutoRunner.run(false, nil, test_arguments)
+      end
+    end
+  end
+end

data/lib/m/runners/unsupported_framework.rb

@@ -0,0 +1,21 @@
+module M
+  module Runners
+    class UnsupportedFramework < Base
+      def suites
+        not_supported
+        []
+      end
+
+      def run(_test_arguments)
+        not_supported
+      end
+
+      private
+
+      def not_supported
+        STDERR.puts "This test framework is not supported! Please open up an issue at https://github.com/qrush/m !"
+        false
+      end
+    end
+  end
+end

data/lib/m/testable.rb

@@ -0,0 +1,15 @@
+module M
+  class Testable
+    attr_accessor :file
+    attr_reader :line
+
+    def initialize(file = "", line = nil)
+      @file = file
+      @line = line
+    end
+
+    def line=(line)
+      @line ||= line.to_i
+    end
+  end
+end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module M
-  VERSION = "1.3.3"
+  VERSION = "1.3.4"
 end

data/m.gemspec

@@ -14,10 +14,10 @@ Gem::Specification.new do |gem|
 
   gem.add_runtime_dependency "method_source", ">= 0.6.7"
   gem.add_runtime_dependency "rake", ">= 0.9.2.2"
+
   gem.add_development_dependency "activesupport"
   gem.add_development_dependency "rdiscount"
   gem.add_development_dependency "rocco"
-  gem.add_development_dependency "minitest"
   gem.add_development_dependency "appraisal"
 
   gem.required_ruby_version = ">= 1.9"

data/test/active_support_test.rb

@@ -2,28 +2,28 @@ require 'test_helper'
 
 class ActiveSupportTest < MTest
   def test_run_simple_test_by_line_number
-    output = m('examples/active_support_example_test.rb:12')
-    assert_output /1 tests, 1 assertions/, output
+    output = m('examples/active_support_example_test.rb:11')
+    assert_output(/1 tests, 1 assertions/, output)
   end
 
   def test_runs_entire_test_without_line_number
     output = m('examples/active_support_example_test.rb')
-    assert_output /4 tests/, output
+    assert_output(/4 tests/, output)
   end
 
   def test_run_inside_of_test
-    output = m('examples/active_support_example_test.rb:13')
-    assert_output /1 tests, 1 assertions/, output
+    output = m('examples/active_support_example_test.rb:12')
+    assert_output(/1 tests, 1 assertions/, output)
   end
 
   def test_run_on_end_of_test
-    output = m('examples/active_support_example_test.rb:14')
-    assert_output /1 tests, 1 assertions/, output
+    output = m('examples/active_support_example_test.rb:13')
+    assert_output(/1 tests, 1 assertions/, output)
   end
 
   def test_run_inside_big_test
-    output = m('examples/active_support_example_test.rb:18')
-    assert_output /1 tests, 3 assertions/, output
+    output = m('examples/active_support_example_test.rb:17')
+    assert_output(/1 tests, 3 assertions/, output)
   end
 
   def test_run_on_blank_line_orders_tests_by_line_number
@@ -33,21 +33,21 @@ class ActiveSupportTest < MTest
     expected = <<-EOF
 No tests found on line 2. Valid tests to run:
 
-      test_normal: m examples/active_support_example_test.rb:8
-      test_carrot: m examples/active_support_example_test.rb:12
-      test_daikon: m examples/active_support_example_test.rb:16
-test_eggplant_fig: m examples/active_support_example_test.rb:22
+      test_normal: m examples/active_support_example_test.rb:7
+      test_carrot: m examples/active_support_example_test.rb:11
+      test_daikon: m examples/active_support_example_test.rb:15
+test_eggplant_fig: m examples/active_support_example_test.rb:21
 EOF
     assert_equal expected.strip, output
   end
 
   def test_run_on_test_with_spaces
-    output = m('examples/active_support_example_test.rb:22')
-    assert_output /1 tests, 1 assertions/, output
+    output = m('examples/active_support_example_test.rb:21')
+    assert_output(/1 tests, 1 assertions/, output)
   end
 
   def test_run_on_test_with_unescaped_regular_express_characters
-    output = m('examples/active_support_unescaped_example_test.rb:8')
-    assert_output /1 tests, 1 assertions/, output
+    output = m('examples/active_support_unescaped_example_test.rb:7')
+    assert_output(/1 tests, 1 assertions/, output)
   end
 end

data/test/bench.rb

@@ -1,10 +1,27 @@
-require 'benchmark'
-
-Benchmark.bmbm do |bench|
-  TIMES = 100
-  bench.report("running m on a file that doesn't exist, #{TIMES} times") do
-    TIMES.times do
-      `ruby -Ilib ./bin/m failwhale 2>/dev/null`
-    end
+require 'benchmark/ips'
+
+Benchmark.ips do |bench|
+  bench.report("running m on a file that doesn't exist") do
+    `ruby -Ilib ./bin/m failwhale 2>/dev/null`
+  end
+
+  bench.report("running m on an empty file") do
+    `ruby -Ilib ./bin/m test/examples/empty_example_test.rb 2>/dev/null`
+  end
+
+  bench.report("running m on an entire file with minitest5") do
+    `appraisal minitest5 ruby -Ilib ./bin/m test/examples/minitest_5_example_test.rb 2>/dev/null`
+  end
+
+  bench.report("running m on an entire file with minitest4") do
+    `appraisal minitest4 ruby -Ilib ./bin/m test/examples/minitest_4_example_test.rb 2>/dev/null`
+  end
+
+  bench.report("running m on a specific test with minitest4") do
+    `appraisal minitest4 ruby -Ilib ./bin/m test/examples/minitest_4_example_test.rb:19 2>/dev/null`
+  end
+
+  bench.report("running m on a specific test with minitest5") do
+    `appraisal minitest5 ruby -Ilib ./bin/m test/examples/minitest_5_example_test.rb:19 2>/dev/null`
   end
 end