splot 0.0.1 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c04e7305e738732e77b9a84f76475766b359d25f
-  data.tar.gz: f3ace6ce20f136b5187d3117eae7311721d23fed
+  metadata.gz: e7239341b56f137cc8eb9e3ee90ad87f963c7be2
+  data.tar.gz: 1374d68cb52b2b77279b08e349a3ceae0de2402d
 SHA512:
-  metadata.gz: 747a98ac47f7f4d0d312ca7f29189bd2a0474e0270faa22a0ef85fabc057cca8e12e629bde4ec4db96c0435349ea582ba539fd8faf8b80127a8d353533b0f29f
-  data.tar.gz: 760e746ed1a79c5f38cc09fe9ad56634ad9563a92c306149220a3e94560dee344dc38281d0e2fe5ad96a766586c05c4fa1b712636a9096180c1a20bc38b2f18e
+  metadata.gz: 34b95e19ee56c4350fb7817d3f584076700a6f0d19b6f69807a70f15e9d5682ed6009366d9f29ba42e753f55eac4e9309bc46008fa397f22c8c65fbf9dddc2f7
+  data.tar.gz: b15e8603ce6d104a9084523831bfad7adcd51826b344a04558aa22f195185b9189d63b961f07783a91ad465c3492e9970d42da97ec45503dcd5fea668434cbc6

data/Rakefile

@@ -1 +1,16 @@
+require "rake/testtask"
 require "bundler/gem_tasks"
+
+ENV['COVERAGE'] = '1'
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/*_test.rb'
+  t.libs << 'test'
+end
+
+desc "Update ctags"
+task :ctags do
+  `ctags -R --languages=Ruby --totals -f tags`
+end
+
+task default: :test

data/bin/splot

@@ -1,87 +1,10 @@
 #!/usr/bin/env ruby
 
-require 'open3'
-require 'optparse'
-
-options = {}
-
-OptionParser.new do |opts|
-  opts.banner = "Usage: #{File.basename($PROGRAM_NAME)} [options]"
-
-  opts.on('-f', '--file FILE', 'Run test for a given FILE') do |file|
-    options[:file] = file
-  end
-
-  opts.on('-l', '--line LINE', 'Only run test on LINE') do |line|
-    options[:line] = line.to_i
-  end
-
-  opts.on('-p', '--preloader PRELOADER', 'Use e.g. zeus or spring to preload the environment') do |preloader|
-    options[:preloader] = preloader
-  end
-end.parse!
-
-module ContextTest
-  extend self
-
-  module MinitestCommand
-    extend self
-
-    ACTIVE_SUPPORT_TEST_CASE_MATCHER = %r{
-      \A\s*test\s+              #   test
-      (?:                       #
-         "(?<double_quote>.*)"  #        "it should work"
-         |                      # OR
-         '(?<single_quote>.*)'  #        'it should work'
-      )                         #
-      \s+do\s*\Z                #                         do\n
-    }x
-
-    TEST_UNIT_MATCHER = %r{
-      \A\s*def\s+               #  def
-      (?<test_name>             #
-        test_                   #      test_
-        [a-zA-Z_]+              #           it_should_work
-        [\?!=]?                 #                         ?
-      )                         #
-      \s*\Z                     #                          \n
-    }x
-
-    def command(file: nil, line: nil, preloader: nil)
-      command = [preloader, "rake test"].compact
-      command << file if file
-      command << parse_line(file, line) if line
-      command.join ' '
-    end
-
-    def parse_line(file, line)
-      test_name = nil
-      line_no = 0
-      File.open file do |io|
-        until io.eof?
-          line_text = io.gets
-          line_no += 1
-          line_text.match ACTIVE_SUPPORT_TEST_CASE_MATCHER do |matches|
-            match = matches[:double_quote] || matches[:single_quote]
-            test_name = "test_#{match.gsub(/\s+/, '_')}"
-          end
-          line_text.match TEST_UNIT_MATCHER do |matches|
-            test_name = matches[:test_name]
-          end
-          return to_arg(test_name) if line_no == line && test_name
-        end
-      end
-      fail "Could not find test for line #{line} of file #{file}"
-    end
-
-    def to_arg(test_name)
-      "TESTOPTS=\"-n #{test_name}\""
-    end
-  end
-
-  def run(str)
-    exec str
-  end
+begin
+  require "splot"
+rescue LoadError
+  require "rubygems"
+  require "splot"
 end
 
-ContextTest.run ContextTest::MinitestCommand.command options
+Kernel.exec Splot.build_command_from_argv

data/lib/splot.rb

@@ -1,5 +1,28 @@
+require "optparse"
+require "pathname"
+
 require "splot/version"
 
 module Splot
-  # Your code goes here...
+  autoload :Command,           "splot/command"
+  autoload :CorrespondingFile, "splot/corresponding_file"
+  autoload :Runner,            "splot/runner"
+
+  RunnerNotFoundError = Class.new StandardError
+
+  def self.command(params = {})
+    new_file = CorrespondingFile.fetch params[:file]
+    unless new_file == params[:file]
+      params[:file] = new_file
+      params.delete(:line)
+    end
+    Command.for(params[:file]).new(params).command
+  end
+
+  def self.build_command_from_argv
+    Runner.new.tap(&:parse).command
+  rescue RunnerNotFoundError => e
+    warn "Warning: #{e}; will not run any test"
+    exit 2
+  end
 end

data/lib/splot/command.rb

@@ -0,0 +1,167 @@
+module Splot
+  class Command
+    attr :include_path, :line_no, :file, :preloader
+
+    def initialize(params = {})
+      @file         = params.fetch(:file).to_str
+      @include_path = params[:include_path]
+      @line_no      = Integer(params[:line]) if params.has_key? :line
+      @preloader    = params[:preloader].to_str if params.has_key? :preloader
+    end
+
+    def self.for(file)
+      ObjectSpace.each_object(Class).select { |klass| klass < self }.each do |subklass|
+        return subklass if subklass.match? file
+      end
+      self
+    end
+
+    def self.match?(file)
+      false
+    end
+
+    def command
+      [
+        preloader,    # "spring"
+        runner,       # "rake test"
+        include_args, # "-Itest"
+        file_arg,     # "TEST=\"/path/to/test.rb\""
+        line_no_arg,  # "TESTOPTS=\"-n test_foo\""
+      ].compact * ' '
+    end
+
+    def file_arg
+      file
+    end
+
+    def include_args
+      include_path ? "-I#{include_path}" : nil
+    end
+
+    def line_no_arg
+      line_no ? "-l #{line_no}" : nil
+    end
+
+    def runner
+      raise RunnerNotFoundError, "cannot determine runner for #{file.inspect}"
+    end
+  end
+
+  class CucumberCommand < Command
+    def self.match?(file)
+      file.match %r{\.feature\Z}
+    end
+
+    def include_args
+      return super if include_path.nil?
+      raise ArgumentError, "Cucumber does not support include arguments"
+    end
+
+    def runner
+      'cucumber'
+    end
+  end
+
+  class RSpecCommand < Command
+    def self.match?(file)
+      file.match /\_spec\.rb\Z/
+    end
+
+    def runner
+      'rspec'
+    end
+  end
+
+  class TestUnitCommand < Command
+
+    ACTIVE_SUPPORT_TEST_CASE_MATCHER = %r{
+      \A\s*test\s+              #   test
+      (?:                       #
+         "(?<double_quote>.*)"  #        "it should work"
+         |                      # OR
+         '(?<single_quote>.*)'  #        'it should work'
+      )                         #
+      \s+do\s*\Z                #                         do\n
+    }x
+
+    TEST_UNIT_MATCHER = %r{
+      \A\s*def\s+               #  def
+      (?<test_name>             #
+        test_                   #      test_
+        [a-zA-Z_]+              #           it_should_work
+        [\?!=]?                 #                         ?
+      )                         #
+      \s*\Z                     #                          \n
+    }x
+
+    def initialize(params = {})
+      @runner = params.fetch(:runner) { "rake test" }
+      super
+    end
+
+    def self.match?(file)
+      file.match /\_test\.rb/
+    end
+
+    def file_arg
+      if rake?
+        "TEST=#{file}"
+      else
+        super
+      end
+    end
+
+    def rake?
+      runner == "rake test"
+    end
+
+    def runner
+      @runner
+    end
+
+    def line_no_arg
+      test_name = catch(:test_name) { fetch_test_name }
+      return nil if test_name.nil?
+      arg = "--name=#{test_name}"
+      rake? ? "TESTOPTS=#{arg.inspect}" : arg
+    end
+
+    def fetch_test_name
+      return nil if line_no.nil?
+      current_test_name = nil
+      read_file do |current_line_no, line|
+        match_test_method(line) { |match| current_test_name = match }
+        throw :test_name, current_test_name if current_line_no == line_no
+      end
+    end
+
+    def match_test_method(line, &block)
+      match_active_support line, &block
+      match_test_unit line, &block
+    end
+
+    def match_active_support(line)
+      line.match ACTIVE_SUPPORT_TEST_CASE_MATCHER do |matches|
+        quoted_bit = matches[:double_quote] || matches[:single_quote]
+        yield "test_#{quoted_bit.gsub(/\s+/, '_')}"
+      end
+    end
+
+    def match_test_unit(line)
+      line.match TEST_UNIT_MATCHER do |matches|
+        yield matches[:test_name]
+      end
+    end
+
+    def read_file
+      current_line_no = 0
+      File.open file do |io|
+        until io.eof?
+          current_line_no += 1
+          line_text = io.gets
+          yield current_line_no, line_text
+        end
+      end
+    end
+  end
+end

data/lib/splot/corresponding_file.rb

@@ -0,0 +1,36 @@
+module Splot
+  class CorrespondingFile
+    def self.fetch(file)
+      catch :test_file do
+        root_path = Pathname.new File.expand_path Dir.pwd
+        file_path = Pathname.new File.expand_path file
+        relative_path = file_path.relative_path_from(root_path).to_s
+        if %r{\Alib/(?<bit>.*)\.rb} =~ relative_path
+          ['test', 'spec'].each do |e|
+            try_file "#{e}/lib/#{bit}_#{e}.rb"
+            try_file "#{e}/#{bit}_#{e}.rb"
+          end
+        end
+        if %r{\Aapp/(?<subdir>[a-z_]+)/(?<bit>.*)\.rb} =~ relative_path
+          ['test', 'spec'].each do |e|
+            alternate_subdir = {
+              models:      "unit",
+              controllers: "functional",
+            }[subdir.to_sym]
+            try_file "#{e}/#{subdir}/#{bit}_#{e}.rb"
+            try_file "#{e}/#{alternate_subdir}/#{bit}_#{e}.rb" if alternate_subdir
+          end
+        end
+        file
+      end
+    end
+
+    def self.try_file(test_path)
+      throw :test_file, test_path if file_exists? test_path
+    end
+
+    def self.file_exists?(file)
+      File.size? file
+    end
+  end
+end

data/lib/splot/runner.rb

@@ -0,0 +1,39 @@
+module Splot
+  class Runner
+    attr :params
+
+    def initialize
+      @params = {}
+    end
+
+    def command
+      ::Splot.command params
+    end
+
+    def parse
+      OptionParser.new do |opts|
+        opts.banner = "Usage: #{File.basename($PROGRAM_NAME)} [options]"
+
+        opts.on('-f', '--file FILE', 'Run test for a given FILE') do |file|
+          params[:file] = file
+        end
+
+        opts.on('-i', '--include-path PATH', 'Add an include PATH') do |path|
+          params[:include_path] = path
+        end
+
+        opts.on('-l', '--line LINE', 'Only run test on LINE') do |line|
+          params[:line] = line.to_i
+        end
+
+        opts.on('-r', '--runner RUNNER', 'Specify alternate runner') do |runner|
+          params[:runner] = runner
+        end
+
+        opts.on('-p', '--preloader PRELOADER', 'Use e.g. zeus or spring to preload the environment') do |preloader|
+          params[:preloader] = preloader
+        end
+      end.parse!
+    end
+  end
+end

data/lib/splot/version.rb

@@ -1,3 +1,3 @@
 module Splot
-  VERSION = "0.0.1"
+  VERSION = "0.5.1"
 end

data/test/corresponding_file_test.rb

@@ -0,0 +1,80 @@
+require 'test_helper'
+
+class CorrespondingFileTest < Minitest::Test
+  include Splot
+
+  def test_looks_in_test_and_spec_when_file_is_in_lib
+    mock_files_existing "test/my_class_test.rb" do
+      assert_equal "test/my_class_test.rb",
+        CorrespondingFile.fetch("lib/my_class.rb")
+    end
+    mock_files_existing "spec/my_class_spec.rb" do
+      assert_equal "spec/my_class_spec.rb",
+        CorrespondingFile.fetch("lib/my_class.rb")
+    end
+  end
+
+  def test_lib_directory_priority
+    mock_files_existing "test/my_class_test.rb", "test/lib/my_class_test.rb" do
+      assert_equal "test/lib/my_class_test.rb",
+        CorrespondingFile.fetch("lib/my_class.rb")
+    end
+  end
+
+  def test_namespacing
+    mock_files_existing "test/lib/my_namespace/my_class_test.rb" do
+      assert_equal "test/lib/my_namespace/my_class_test.rb",
+        CorrespondingFile.fetch("lib/my_namespace/my_class.rb")
+    end
+  end
+
+  def test_rails_models
+    mock_files_existing "test/unit/my_model_test.rb" do
+      assert_equal "test/unit/my_model_test.rb",
+        CorrespondingFile.fetch("app/models/my_model.rb")
+    end
+    mock_files_existing "test/models/my_model_test.rb" do
+      assert_equal "test/models/my_model_test.rb",
+        CorrespondingFile.fetch("app/models/my_model.rb")
+    end
+  end
+
+  def test_rails_controllers
+    mock_files_existing "test/functional/my_controller_test.rb" do
+      assert_equal "test/functional/my_controller_test.rb",
+        CorrespondingFile.fetch("app/controllers/my_controller.rb")
+    end
+    mock_files_existing "test/controllers/my_controller_test.rb" do
+      assert_equal "test/controllers/my_controller_test.rb",
+        CorrespondingFile.fetch("app/controllers/my_controller.rb")
+    end
+  end
+
+  def test_rails_custom_app_load_path
+    mock_files_existing "test/services/my_service_test.rb" do
+      assert_equal "test/services/my_service_test.rb",
+        CorrespondingFile.fetch("app/services/my_service.rb")
+    end
+  end
+
+  private
+
+  def mock_files_existing(*files)
+    File.singleton_class.class_eval <<-CLASS_EVAL, __FILE__, __LINE__
+    alias_method :size_orig?, :size?
+
+    def size?(file)                      # def size?(file)
+      #{files.inspect}.include?(file)    #   ["fileA", "my/fileB"].include?(file)
+    end                                  # end
+    CLASS_EVAL
+
+    begin
+      yield
+    ensure
+      File.singleton_class.class_eval <<-CLASS_EVAL, __FILE__, __LINE__
+      alias_method :size?, :size_orig?
+      undef :size_orig?
+      CLASS_EVAL
+    end
+  end
+end

data/test/fixtures/activesupport_example_test.rb

@@ -0,0 +1,10 @@
+require "fake_test_helper"
+
+class ActiveSupportExampleTest < ActiveSupport::TestCase
+  test "will always pass" do
+    assert true
+  end
+  test "will always fail" do
+    refute true
+  end
+end

data/test/fixtures/fake_test_helper.rb

@@ -0,0 +1,2 @@
+require "minitest"
+require "minitest/autorun"

data/test/fixtures/test_unit_example_test.rb

@@ -0,0 +1,10 @@
+require "fake_test_helper"
+
+class SampleTest < Minitest::Test
+  def test_always_passes
+    assert true
+  end
+  def test_always_fails
+    refute true
+  end
+end

data/test/splot_test.rb

@@ -0,0 +1,117 @@
+require "test_helper"
+
+class SplotTest < Minitest::Test
+  def test_binary
+    assert_equal 0, run_binary(runner: "ruby", include_path: "test/fixtures", file: "test/fixtures/test_unit_example_test.rb", line: 5)
+    refute_equal 0, run_binary(runner: "ruby", include_path: "test/fixtures", file: "test/fixtures/test_unit_example_test.rb", line: 8)
+    assert_equal 2, run_binary(runner: "ruby", include_path: "test/fixtures", file: "non/existent/file.rb")
+  end
+
+  def test_test_unit
+    assert_equal "rake test TEST=test/fixtures/test_unit_example_test.rb",
+      Splot.command(file: test_unit_rb)
+
+    assert_equal "rake test TEST=test/fixtures/test_unit_example_test.rb TESTOPTS=\"--name=test_always_passes\"",
+      Splot.command(file: test_unit_rb, line: 5)
+    assert_equal "rake test TEST=test/fixtures/test_unit_example_test.rb TESTOPTS=\"--name=test_always_fails\"",
+      Splot.command(file: test_unit_rb, line: 8)
+  end
+
+  def test_test_unit_with_ruby_runner
+    assert_equal "ruby test/fixtures/test_unit_example_test.rb",
+      Splot.command(runner: "ruby", file: test_unit_rb)
+  end
+
+  def test_test_unit_with_invalid_line_numbers
+    assert_equal "rake test TEST=test/fixtures/test_unit_example_test.rb",
+      Splot.command(file: test_unit_rb, line: 1)
+  end
+
+  def test_activesupport_test_unit
+    assert_equal "rake test TEST=test/fixtures/activesupport_example_test.rb",
+      Splot.command(file: activesupport_test_rb)
+
+    assert_equal "rake test TEST=test/fixtures/activesupport_example_test.rb TESTOPTS=\"--name=test_will_always_pass\"",
+      Splot.command(file: activesupport_test_rb, line: 5)
+    assert_equal "rake test TEST=test/fixtures/activesupport_example_test.rb TESTOPTS=\"--name=test_will_always_fail\"",
+      Splot.command(file: activesupport_test_rb, line: 8)
+  end
+
+  def test_cucumber
+    assert_equal "cucumber path/to/cucumber_example.feature",
+      Splot.command(file: cucumber_feature)
+
+    assert_equal "cucumber path/to/cucumber_example.feature -l 2",
+      Splot.command(file: cucumber_feature, line: 2)
+  end
+
+  def test_rspec
+    assert_equal "rspec path/to/rspec_example_spec.rb",
+      Splot.command(file: rspec_spec_rb)
+
+    assert_equal "rspec path/to/rspec_example_spec.rb -l 3",
+      Splot.command(file: rspec_spec_rb, line: 3)
+  end
+
+  def test_unknown
+    assert_raises Splot::RunnerNotFoundError do
+      Splot.command file: "path/to/any_old_ruby_file.rb"
+    end
+  end
+
+  def test_preloader
+    assert_equal "spring rspec my_spec.rb",
+      Splot.command(file: "my_spec.rb", preloader: "spring")
+  end
+
+  def test_adding_include_paths
+    assert_equal "rake test -Imy_lib_dir TEST=test/fixtures/test_unit_example_test.rb",
+      Splot.command(file: test_unit_rb, include_path: "my_lib_dir")
+    assert_equal "rspec -Imy_lib_dir path/to/rspec_example_spec.rb",
+      Splot.command(file: rspec_spec_rb, include_path: "my_lib_dir")
+    assert_raises ArgumentError do
+      assert_equal "cucumber -Imy_lib_dir TEST=path/to/cucumber_example.feature",
+        Splot.command(file: cucumber_feature, include_path: "my_lib_dir")
+    end
+  end
+
+  def test_lib_files_automatically_translate_to_corresponding_test
+    assert_equal "rake test TEST=test/splot_test.rb",
+      Splot.command(file: "lib/splot.rb")
+    # Forget the line number when we change files
+    assert_equal "rake test TEST=test/splot_test.rb",
+      Splot.command(file: "lib/splot.rb", line: 5)
+  end
+
+  private
+
+  def run_binary(params = {})
+    Process::fork do
+      command = params.each_with_object 'bin/splot' do |(k,v), str|
+        str << " --#{k.to_s.gsub('_', '-')} #{v}"
+      end
+      $stdout.reopen File.open("/dev/null", "w+")
+      $stderr.reopen File.open("/dev/null", "w+")
+      command.insert 0, "RUBYLIB=#{File.expand_path('../../lib', __FILE__)}:$RUBYLIB "
+      exec command
+    end
+    Process::wait
+    $?.exitstatus
+  end
+
+  def activesupport_test_rb
+    "test/fixtures/activesupport_example_test.rb"
+  end
+
+  def cucumber_feature
+    "path/to/cucumber_example.feature"
+  end
+
+  def rspec_spec_rb
+    "path/to/rspec_example_spec.rb"
+  end
+
+  def test_unit_rb
+    "test/fixtures/test_unit_example_test.rb"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+require 'simplecov' if ENV['COVERAGE']
+
+require 'minitest/autorun'
+require 'minitest/unit'
+require 'minitest/reporters'
+
+require 'ostruct'
+require 'pp'
+require 'stringio'
+
+require 'splot'
+
+Minitest::Reporters.use! MiniTest::Reporters::DefaultReporter.new

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: splot
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.5.1
 platform: ruby
 authors:
 - ntl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-23 00:00:00.000000000 Z
+date: 2013-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -109,8 +109,17 @@ files:
 - Rakefile
 - bin/splot
 - lib/splot.rb
+- lib/splot/command.rb
+- lib/splot/corresponding_file.rb
+- lib/splot/runner.rb
 - lib/splot/version.rb
 - splot.gemspec
+- test/corresponding_file_test.rb
+- test/fixtures/activesupport_example_test.rb
+- test/fixtures/fake_test_helper.rb
+- test/fixtures/test_unit_example_test.rb
+- test/splot_test.rb
+- test/test_helper.rb
 homepage: ''
 licenses:
 - MIT
@@ -135,4 +144,10 @@ rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Run any test from any file from any project :)
-test_files: []
+test_files:
+- test/corresponding_file_test.rb
+- test/fixtures/activesupport_example_test.rb
+- test/fixtures/fake_test_helper.rb
+- test/fixtures/test_unit_example_test.rb
+- test/splot_test.rb
+- test/test_helper.rb