Narnach-minitest 0.3.0 → 0.3.1

data/README.rdoc

@@ -1,10 +1,17 @@
 == Minitest
-Minitest is a simple autotester intended to be used with rSpec and rCov.
-It can be used with 'plain' ruby projects and Ruby on Rails.
+Minitest is a simple autotester intended to be used with rSpec, Test::Unit and rCov.
+It can be used with 'plain' Ruby projects and Ruby on Rails.
 
 == Recent changes
-Version 0.3.0 switched to a new file monitoring backend, DirMonitor.
-The 'recent' feature was removed.
+
+=== Version 0.3.1
+Minitest gained support to test Test::Unit tests and RSpec specs at the same time.
+
+=== Version 0.3.0
+Minitest switched to a new file monitoring backend: DirMonitor.
+This makes it possible to track new files as they are created, without needing to restart minitest.
+The 'recent' feature was removed because DirMonitor does not (yet?) have a way to only yield files
+newer than some timestamp. This feature is likely to re-appear in a nearby future.
 
 == Installation
 === From gem
@@ -28,7 +35,12 @@ When you start working on a codebase, it makes sense to run all specs:
 When you want to see which specs are slow and could use optimizing:
   minitest profile
 You can also combine options:
-  minitest recent profile
+  minitest drb profile
+
+== Todo / ideas / plans
+* Figure out how to get RCov to run specs and tests at the same time and implement it.
+* Add 'recent' option (was removed in 0.3.0).
+* Write tests for Minitest class.
 
 == About
 Author:: Wes 'Narnach' Oldenbeuving (narnach@gmail.com)

data/Rakefile

@@ -2,7 +2,6 @@ require "rake"
 require "rake/clean"
 require "rake/gempackagetask"
 require 'rubygems'
-require 'lib/minitest'
 
 ################################################################################
 ### Gem
@@ -10,7 +9,8 @@ require 'lib/minitest'
 
 begin
   # Parse gemspec using the github safety level.
-  data = File.read('minitest.gemspec')
+  file = Dir['*.gemspec'].first
+  data = File.read(file)
   spec = nil
   Thread.new { spec = eval("$SAFE = 3\n%s" % data)}.join
 
@@ -19,10 +19,10 @@ begin
     package.gem_spec = spec
   end
 rescue Exception => e
-  printf "WARNING: Error caught (%s): %s\n", e.class.name, e.message
+  printf "WARNING: Error caught (%s): %s\n%s", e.class.name, e.message, e.backtrace[0...5].map {|l| '  %s' % l}.join("\n")
 end
 
 desc 'Package and install the gem for the current version'
 task :install => :gem do
-  system "sudo gem install -l pkg/minitest-%s.gem" % spec.version
+  system "sudo gem install -l pkg/%s-%s.gem" % [spec.name, spec.version]
 end

data/bin/minitest

@@ -1,5 +1,4 @@
 #!/usr/bin/env ruby
-$LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__),'..','lib'))
 require 'minitest'
 
 minitest = Minitest.new

data/lib/dir_monitor.rb

@@ -1,13 +1,17 @@
 # Dirmonitor's purpose is to serve as a file monitoring helper for Minitest.
+#
 # Its intended functionality is:
 # - Keep track of new files in monitored directories.
 # - Keep track of changed files in monitored directories.
-# - Link these files to their specs, so Minitest can run the specs.
+# - Link these files to their specs or tests, so Minitest can run them.
 class DirMonitor
   attr_reader :known_files, :dirs, :last_mtime
 
   # Setup a new DirMonitor.
-  # Directories can be provided in a number of ways:
+  #
+  # The input parameter(s) are flattened and forced to a string.
+  #
+  # This means that directories can be provided in a number of ways:
   #   DirMonitor.new 'lib', 'app'
   #   DirMonitor.new :lib, :app
   #   DirMonitor.new %w[lib app]
@@ -42,16 +46,6 @@ class DirMonitor
     end
   end
 
-  # Scans for changed known files, using #scan_changed. Yields the name of both the file and its associated spec.
-  # spec_for is used to determine what the name of the file's spec _should_ be.
-  # Does not yield a file/spec name when the spec does not exist.
-  def scan_changed_with_spec(&block) # :yields: file, spec
-    scan_changed do |file|
-      spec = spec_for(file)
-      block.call(file, spec) if File.exists?(spec)
-    end
-  end
-
   # Scan for new files.
   # All new file names are yielded.
   def scan_new(&block) # :yields: file
@@ -64,32 +58,40 @@ class DirMonitor
   end
 
   # Scan for new files and check for changed known files.
-  # Only yields a file once per call.
+  # The same file is not yielded twice.
   def scan_new_or_changed_with_spec(&block) # :yields: file, spec
     yielded_files = {}
-    yield_once_block = Proc.new do |file, spec|
-      next if yielded_files.has_key? file
-      block.call(file, spec)
-      yielded_files[file]=nil
+    yield_once_block = Proc.new do |file|
+      spec_file = spec_for(file)
+      next if yielded_files.has_key? spec_file
+      next unless File.exist?(spec_file)
+      block.call(file, spec_file)
+      yielded_files[spec_file]=file
     end
-    scan_new_with_spec(&yield_once_block)
-    scan_changed_with_spec(&yield_once_block)
+    scan_new(&yield_once_block)
+    scan_changed(&yield_once_block)
   end
 
-  # Scans for new files, like scan_new does, but yields the name of both the file and spec.
-  # spec_for is used to determine what the name of the file's spec _should_ be.
-  # Does not yield a file/spec name when the spec does not exist.
-  def scan_new_with_spec(&block) # :yields: file, spec
-    scan_new do |file|
-      spec = spec_for(file)
-      block.call(file, spec) if File.exists?(spec)
+  # Scan for new files and check for changed known files.
+  # The same file is not yielded twice.
+  def scan_new_or_changed_with_test(&block) # :yields: file, test
+    yielded_files = {}
+    yield_once_block = Proc.new do |file|
+      test_file = test_for(file)
+      next if yielded_files.has_key? test_file
+      next unless File.exist?(test_file)
+      block.call(file, test_file)
+      yielded_files[test_file]=file
     end
+    scan_new(&yield_once_block)
+    scan_changed(&yield_once_block)
   end
 
   # Find the (theoretical) spec file name for a given file.
   # The assumptions are:
   # - All specs reside in the 'spec' directory.
-  # - All specs file names have the suffix '_spec.rb', instead of only the '.rb' extension.
+  # - The directory structure is the same; lib/a/b/c maps to spec/a/b/c.
+  # - All specs file names have the suffix '_spec.rb'; Ruby code has the '.rb' extension.
   # - The file name for a non-ruby file spec simply has '_spec.rb' suffixed to the entire file name.
   # The returned file name does not necessarily have to exist.
   def spec_for(file)
@@ -111,6 +113,41 @@ class DirMonitor
     return File.join(spec_dir, spec_file)
   end
 
+  # Find the (theoretical) test file name for a given file.
+  # The assumptions are:
+  # - All tests reside in the 'test' directory.
+  # - The directory structure is the same; lib/a/b/c maps to test/a/b/c.
+  # - Rails is the exception to this rule: 
+  #   - Controllers are tested in test/functional
+  #   - Models are tested in test/unit
+  # - All test file names have the suffix '_test.rb'. Ruby code has the '.rb' extension.
+  # - The file name for a non-ruby file test simply has '_test.rb' suffixed to the entire file name.
+  # The returned file name does not necessarily have to exist.
+  def test_for(file)
+    base = File.basename(file)
+    extension = File.extname(base)
+    dir = File.dirname(file)
+    dir_array = dir.split('/')
+    if extension == '.rb' and dir_array.first=='test'
+      return file
+    end
+    if extension == '.rb'
+      base_without_extension = base[0, base.size - extension.size]
+      test_file = base_without_extension + '_test' + extension
+    else
+      test_file = base + '_test.rb'
+    end
+    dir_array[0]='test'
+    case dir_array[1]
+    when 'controllers'
+      dir_array[1] = 'functional'
+    when 'models'
+      dir_array[1] = 'unit'
+    end
+    test_dir = dir_array.join('/')
+    return File.join(test_dir, test_file)
+  end
+
 private
 
   # Get the modification time for a file.

data/lib/minitest.rb

@@ -1,20 +1,13 @@
-require 'set'
+require 'set_ext'
 require 'dir_monitor'
 
-class Set
-  def join(*args,&block)
-    map.join(*args,&block)
-  end
-end
-
 # = Minitest
 # The default usage of Minitest is this:
 #   minitest = Minitest.new
 #   minitest.start
 # This will do the following:
 # - Initialize a DirMonitor
-# - Map all files in source dirs to specs
-# - Frequently check for new or changed files; run rspec on their associated specs
+# - Frequently check for new or changed files; run rspec or test/unit on their associated specs or tests
 # - Run rcov (code coverage tester) on all specs when exiting (Press ctrl-C on send SIGINT to the process)
 class Minitest
   attr_accessor :source_dirs
@@ -42,40 +35,22 @@ class Minitest
     ignores.join(",")
   end
 
-  # Command line string to run rcov for all monitored specs.
-  def rcov
-    "#{rcov_cmd} -T --exclude \"#{rcov_ignores}\" -Ilib #{spec_cmd} -- " + known_specs.join(" ")
-  end
-
-  # Command line string to run rspec for an array of specs. Defaults to all specs.
-  def rspec(specs=known_specs)
-    "#{spec_cmd} #{specs.join(" ")} #{spec_opts}"
-  end
-
   def source_dirs
     @source_dirs || DEFAULT_SOURCE_DIRS
   end
 
-  def rcov_cmd
-    @rcov_cmd ||= find_rcov_cmd
-  end
-
-  # The command to use to run specs.
-  def spec_cmd
-    @spec_cmd ||= ( File.exist?('script/spec') ? 'script/spec' : find_spec_cmd )
-  end
-
   def spec_opts
     @spec_opts ||= ( File.exist?('spec/spec.opts') ? '-O spec/spec.opts' : '' )
   end
 
   def start
     @active = true
-    @dir_monitor = DirMonitor.new(source_dirs)
+    @spec_monitor = DirMonitor.new(source_dirs)
+    @test_monitor = DirMonitor.new(source_dirs)
     trap_int_for_rcov
     while active? do
       reset_need_testing
-      @dir_monitor.scan_new_or_changed_with_spec do |file, spec|
+      @spec_monitor.scan_new_or_changed_with_spec do |file, spec|
         known_specs << spec
         need_testing << spec
       end
@@ -83,19 +58,18 @@ class Minitest
         print "\nTesting files: #{need_testing.join(" ")}\n"
         system rspec(need_testing)
       end
+      tests_to_run = Set.new
+      @test_monitor.scan_new_or_changed_with_test do |file, test|
+        tests_to_run << test
+      end
+      if tests_to_run.size > 0
+        print "\nTesting files: #{tests_to_run.join(" ")}\n"
+        system 'ruby -e "" -rtest/unit %s' % tests_to_run.map{|test| '-r%s' % test}.join(" ")
+      end
       sleep 1
     end
   end
 
-  def trap_int_for_rcov
-    Signal.trap("INT") do
-      print "\nNow we run rcov and we're done.\n\n"
-      puts rcov
-      system rcov
-      @active = false
-    end
-  end
-
   private
 
   def find_rcov_cmd
@@ -106,7 +80,35 @@ class Minitest
     `which spec`.strip
   end
 
+  # Command line string to run rcov for all monitored specs.
+  def rcov
+    "#{rcov_cmd} -T --exclude \"#{rcov_ignores}\" -Ilib #{spec_cmd} -- " + known_specs.join(" ")
+  end
+
+  def rcov_cmd
+    @rcov_cmd ||= find_rcov_cmd
+  end
+
   def reset_need_testing
     @need_testing = Set.new
   end
+
+  # Command line string to run rspec for an array of specs. Defaults to all specs.
+  def rspec(specs=known_specs)
+    "#{spec_cmd} #{specs.join(" ")} #{spec_opts}"
+  end
+
+  # The command to use to run specs.
+  def spec_cmd
+    @spec_cmd ||= ( File.exist?('script/spec') ? 'script/spec' : find_spec_cmd )
+  end
+
+  def trap_int_for_rcov
+    Signal.trap("INT") do
+      print "\nNow we run rcov and we're done.\n\n"
+      puts rcov
+      system rcov
+      @active = false
+    end
+  end
 end

data/lib/set_ext.rb

@@ -0,0 +1,12 @@
+require 'set'
+
+module SetExt
+  def join(*args,&block)
+    map.join(*args,&block)
+  end
+end
+
+class Set
+  include SetExt
+end
+

data/minitest.gemspec

@@ -0,0 +1,37 @@
+Gem::Specification.new do |s|
+  # Project
+  s.name         = 'minitest'
+  s.summary      = "Minitest is a simple autotester tool."
+  s.description  = "Minitest is a simple autotester tool, which uses rSpec and rCov to test ruby and rails projects."
+  s.version      = '0.3.1'
+  s.date         = '2008-08-14'
+  s.platform     = Gem::Platform::RUBY
+  s.authors      = ["Wes Oldenbeuving"]
+  s.email        = "narnach@gmail.com"
+  s.homepage     = "http://www.github.com/Narnach/minitest"
+
+  # Files
+  root_files     = %w[MIT-LICENSE README.rdoc Rakefile minitest.gemspec]
+  bin_files      = %w[minitest]
+  lib_files      = %w[minitest dir_monitor set_ext]
+  test_files     = %w[]
+  spec_files     = %w[minitest dir_monitor set_ext]
+  other_files    = %w[spec/spec.opts spec/spec_helper.rb]
+  s.bindir       = "bin"
+  s.require_path = "lib"
+  s.executables  = bin_files
+  s.test_files   = test_files.map {|f| 'test/%s_test.rb' % f} + spec_files.map {|f| 'spec/%s_spec.rb' % f}
+  s.files        = root_files + s.test_files + other_files + bin_files.map {|f| 'bin/%s' % f} + lib_files.map {|f| 'lib/%s.rb' % f}
+
+  # rdoc
+  s.has_rdoc         = true
+  s.extra_rdoc_files = %w[ README.rdoc MIT-LICENSE]
+  s.rdoc_options << '--inline-source' << '--line-numbers' << '--main' << 'README.rdoc'
+
+  # Dependencies
+  s.add_dependency 'rspec', "> 0.0.0"
+  s.add_dependency 'rcov',  "> 0.0.0"
+
+  # Requirements
+  s.required_ruby_version = ">= 1.8.0"
+end

data/spec/dir_monitor_spec.rb

@@ -1,7 +1,9 @@
-$LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__),'..','lib'))
+require File.join(File.dirname(__FILE__),'spec_helper')
 require 'dir_monitor'
 
-describe DirMonitor, ".new" do
+describe DirMonitor do
+
+describe ".new" do
   it "should accept multiple directories" do
     dm = DirMonitor.new('lib','app')
     dm.dirs.should == ['lib','app']
@@ -18,7 +20,7 @@ describe DirMonitor, ".new" do
   end
 end
 
-describe DirMonitor, "#scan" do
+describe "#scan" do
   it "should find all files in the directories" do
     known_files1 = %w[lib/minitest.rb lib/dir_monitor.rb]
     known_files2 = %w[app/another.rb app/files.rb app/more/things.txt]
@@ -30,7 +32,7 @@ describe DirMonitor, "#scan" do
   end
 end
 
-describe DirMonitor, "#scan_new" do
+describe "#scan_new" do
   before(:each) do
     @known_files = %w[lib/minitest.rb lib/dir_monitor.rb]
     Dir.stub!(:glob).with('lib/**/*').and_return(@known_files)
@@ -57,34 +59,7 @@ describe DirMonitor, "#scan_new" do
   end
 end
 
-describe DirMonitor, "#scan_new_with_spec" do
-  before :each do
-    @file = 'lib/dir_monitor.rb'
-    @spec = 'spec/dir_monitor_spec.rb'
-    Dir.stub!(:glob).with('lib/**/*').and_return([@file])
-    @dm = DirMonitor.new 'lib'
-  end
-
-  it "should yield new files and their specs" do
-    File.should_receive(:exists?).with(@spec).and_return(true)
-    results = []
-    @dm.scan_new_with_spec do |new_file, new_spec|
-      results << {new_file => new_spec}
-    end
-    results.should == [{@file=>@spec}]
-  end
-
-  it "should not yield files with non-existent specs" do
-    File.should_receive(:exists?).with(@spec).and_return(false)
-    results = []
-    @dm.scan_new_with_spec do |new_file, new_spec|
-      results << {new_file => new_spec}
-    end
-    results.should == []
-  end
-end
-
-describe DirMonitor, "#scan_changed" do
+describe "#scan_changed" do
   before(:each) do
     @file = 'lib/dir_monitor.rb'
     @time = Time.now
@@ -124,7 +99,7 @@ describe DirMonitor, "#scan_changed" do
   end
 end
 
-describe DirMonitor, "scan_changed_with_spec" do
+describe "#scan_new_or_changed_with_spec" do
   before(:each) do
     @file = 'lib/dir_monitor.rb'
     @spec = 'spec/dir_monitor_spec.rb'
@@ -132,69 +107,94 @@ describe DirMonitor, "scan_changed_with_spec" do
     Dir.stub!(:glob).with('lib/**/*').and_return([@file])
     File.stub!(:mtime).with(@file).and_return(@time)
     @dm = DirMonitor.new 'lib'
-    @dm.scan
   end
 
-  it "should yield the file name and spec name of changed files with an existing spec" do
-    File.should_receive(:exists?).with(@spec).and_return(true)
-    changes = []
-    @dm.scan_changed_with_spec do |changed_file, spec_file|
-      changes << { changed_file => spec_file }
+  it "should yield a file and spec when a file is new" do
+    results = []
+    @dm.scan_new_or_changed_with_spec do |file, spec|
+      results << {file => spec}
     end
-    changes.should == [{@file=>@spec}]
+    results.should == [{@file=>@spec}]
   end
 
-  it "should not yield the file name and spec name of changed files without an existing spec" do
-    File.should_receive(:exists?).with(@spec).and_return(false)
-    changes = []
-    @dm.scan_changed_with_spec do |changed_file, spec_file|
-      changes << { changed_file => spec_file }
+  it "should yield a file and spec when a file is not new but has changed" do
+    @dm.scan
+    @dm.scan_changed {|f|}
+    File.should_receive(:mtime).with(@file).and_return(@time+1)
+    results = []
+    @dm.scan_new_or_changed_with_spec do |file, spec|
+      results << {file => spec}
     end
-    changes.should == []
+    results.should == [{@file=>@spec}]
+  end
+
+  it "should not yield a file and spec when a file is not new and has not changed" do
+    @dm.scan
+    @dm.scan_changed {|f|}
+    results = []
+    @dm.scan_new_or_changed_with_spec do |file, spec|
+      results << {file => spec}
+    end
+    results.should == []
   end
 end
 
-describe DirMonitor, "scan_new_or_changed_with_spec" do
+describe "#scan_new_or_changed_with_test" do
   before(:each) do
     @file = 'lib/dir_monitor.rb'
-    @spec = 'spec/dir_monitor_spec.rb'
+    @test = 'test/dir_monitor_test.rb'
     @time = Time.now
     Dir.stub!(:glob).with('lib/**/*').and_return([@file])
     File.stub!(:mtime).with(@file).and_return(@time)
+    File.stub!(:exist?).with(@test).and_return(true)
     @dm = DirMonitor.new 'lib'
   end
 
-  it "should yield a file and spec when a file is new" do
+  it "should yield a file and test when a file is new" do
     results = []
-    @dm.scan_new_or_changed_with_spec do |file, spec|
-      results << {file => spec}
+    @dm.scan_new_or_changed_with_test do |file, test|
+      results << {file => test}
     end
-    results.should == [{@file=>@spec}]
+    results.should == [{@file=>@test}]
   end
 
-  it "should yield a file and spec when a file is not new but has changed" do
+  it "should yield a file and test when a file is not new but has changed" do
     @dm.scan
     @dm.scan_changed {|f|}
     File.should_receive(:mtime).with(@file).and_return(@time+1)
     results = []
-    @dm.scan_new_or_changed_with_spec do |file, spec|
-      results << {file => spec}
+    @dm.scan_new_or_changed_with_test do |file, test|
+      results << {file => test}
     end
-    results.should == [{@file=>@spec}]
+    results.should == [{@file=>@test}]
   end
 
-  it "should not yield a file and spec when a file is not new and has not changed" do
+  it "should not yield a file and test when a file is not new and has not changed" do
     @dm.scan
     @dm.scan_changed {|f|}
     results = []
-    @dm.scan_new_or_changed_with_spec do |file, spec|
-      results << {file => spec}
+    @dm.scan_new_or_changed_with_test do |file, test|
+      results << {file => test}
+    end
+    results.should == []
+  end
+
+  it "should skip files with non-existent tests" do
+    @dm.scan
+    @dm.scan_changed {|f|}
+
+    @test = @dm.test_for(@file)
+    File.should_receive(:mtime).with(@file).and_return(@time+1)
+    File.should_receive(:exist?).with(@test).and_return(false)
+    results = []
+    @dm.scan_new_or_changed_with_test do |file, test|
+      results << {file => test}
     end
     results.should == []
   end
 end
 
-describe DirMonitor, "#spec_for" do
+describe "#spec_for" do
   before(:each) do
     @dm = DirMonitor.new
   end
@@ -215,4 +215,41 @@ describe DirMonitor, "#spec_for" do
     spec = 'spec/dir_monitor_spec.rb'
     @dm.spec_for(spec).should == spec
   end
-end
+end
+
+describe "#test_for" do
+  before(:each) do
+    @dm = DirMonitor.new
+  end
+
+  it "should find the test for a given file" do
+    file = 'lib/dir_monitor.rb'
+    test = 'test/dir_monitor_test.rb'
+    @dm.test_for(file).should == test
+  end
+
+  it "should find the test for non-ruby files" do
+    file = 'app/views/posts/post.html.haml'
+    test = 'test/views/posts/post.html.haml_test.rb'
+    @dm.test_for(file).should == test
+  end
+
+  it "should map tests to themselves" do
+    test = 'test/dir_monitor_test.rb'
+    @dm.test_for(test).should == test
+  end
+
+  it "should recognize Rails controllers" do
+    file = 'app/controllers/posts_controller.rb'
+    test = 'test/functional/posts_controller_test.rb'
+    @dm.test_for(file).should == test
+  end
+
+  it "should recognize Rails models" do
+    file = 'app/models/post.rb'
+    test = 'test/unit/post_test.rb'
+    @dm.test_for(file).should == test
+  end
+end
+
+end # describe DirMonitor

data/spec/minitest_spec.rb

@@ -1,4 +1,4 @@
-$LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__),'..','lib'))
+require File.join(File.dirname(__FILE__),'spec_helper')
 require 'minitest'
 
 describe Minitest do

data/spec/set_ext_spec.rb

@@ -0,0 +1,11 @@
+require File.join(File.dirname(__FILE__),'spec_helper')
+require 'set_ext'
+
+describe Set do
+  describe "#join" do
+    it 'should join the elements in its collection' do
+      s = Set.new([1,2,3])
+      s.join(" ").should == '1 2 3'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+$LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__),'..','lib'))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: Narnach-minitest
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors: 
 - Wes Oldenbeuving
@@ -43,12 +43,16 @@ files:
 - MIT-LICENSE
 - README.rdoc
 - Rakefile
-- bin/minitest
-- lib/dir_monitor.rb
-- lib/minitest.rb
-- spec/dir_monitor_spec.rb
+- minitest.gemspec
 - spec/minitest_spec.rb
+- spec/dir_monitor_spec.rb
+- spec/set_ext_spec.rb
 - spec/spec.opts
+- spec/spec_helper.rb
+- bin/minitest
+- lib/minitest.rb
+- lib/dir_monitor.rb
+- lib/set_ext.rb
 has_rdoc: true
 homepage: http://www.github.com/Narnach/minitest
 post_install_message: 
@@ -79,6 +83,6 @@ signing_key:
 specification_version: 2
 summary: Minitest is a simple autotester tool.
 test_files: 
-- spec/dir_monitor_spec.rb
 - spec/minitest_spec.rb
-- spec/spec.opts
+- spec/dir_monitor_spec.rb
+- spec/set_ext_spec.rb