Narnach-minitest 0.2.2 → 0.3.0

data/README.rdoc

@@ -2,6 +2,10 @@
 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.
 
+== Recent changes
+Version 0.3.0 switched to a new file monitoring backend, DirMonitor.
+The 'recent' feature was removed.
+
 == Installation
 === From gem
 Use gem to install minitest. The gem is located on github.
@@ -15,14 +19,12 @@ This will build the gem and install it for you.
 
 == Usage
 Minitest has the following command line options:
-recent::   Only specs for files modified within the last hour are executed on the first run. All files are still monitored for changes, though.
 profile::  Force rspec output format to 'profile', combined with coloured output and unified diffs.
+drb:: Use a spec server to execute specs, speeding up their execution.
 
 == Examples
 When you start working on a codebase, it makes sense to run all specs:
   minitest
-When you resume work on a codebase you recently worked on, it might be useful skip running the specs for unchanged files on the first run:
-  minitest recent
 When you want to see which specs are slow and could use optimizing:
   minitest profile
 You can also combine options:

data/Rakefile

@@ -26,19 +26,3 @@ 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
 end
-
-namespace :gem do
-  desc 'Re-generate the gemspec'
-  task :gemspec do
-    files = Dir["*.rdoc"] + %w( Rakefile MIT-LICENSE ) + Dir["{spec,lib,bin}/**/*"]
-    tests = Dir["spec/**/*"]
-    data = File.read('minitest.gemspec.template')
-    files_string = "[%s]" % files.sort.uniq.map{|f| "'%s'" % f}.join(", ")
-    tests_string = "[%s]" % tests.sort.uniq.map{|f| "'%s'" % f}.join(", ")
-    data.gsub!(':FILES:', files_string)
-    data.gsub!(':TEST_FILES:', tests_string)
-    File.open('minitest.gemspec','wb') { |f| f.puts(data) }
-    puts data
-  end
-end
-

data/bin/minitest

@@ -3,7 +3,6 @@ $LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__),'..','lib')
 require 'minitest'
 
 minitest = Minitest.new
-minitest.recent = (ARGV.include? "recent")
 custom_spec_opts = ''
 custom_spec_opts << " --drb" if ARGV.include? "drb"
 custom_spec_opts << " --format profile --colour --diff unified" if ARGV.include? "profile"

data/lib/dir_monitor.rb

@@ -5,7 +5,7 @@
 # - Link these files to their specs, so Minitest can run the specs.
 class DirMonitor
   attr_reader :known_files, :dirs, :last_mtime
-  
+
   # Setup a new DirMonitor.
   # Directories can be provided in a number of ways:
   #   DirMonitor.new 'lib', 'app'
@@ -17,7 +17,7 @@ class DirMonitor
     @known_files = []
     @last_mtime = {}
   end
-  
+
   # Scan for all files in the directories and their sub-directories.
   # The results are stored as a single array in @known_files.
   def scan
@@ -28,7 +28,7 @@ class DirMonitor
     end
     @known_files = results
   end
-  
+
   # Scan for changes in the known files.
   # Yields the name of the changed files.
   # Stores the mtime for all changed files.
@@ -41,7 +41,7 @@ class DirMonitor
       end
     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.
@@ -51,7 +51,7 @@ class DirMonitor
       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
@@ -62,7 +62,7 @@ class DirMonitor
       block.call(new_file)
     end
   end
-  
+
   # Scan for new files and check for changed known files.
   # Only yields a file once per call.
   def scan_new_or_changed_with_spec(&block) # :yields: file, spec
@@ -73,9 +73,9 @@ class DirMonitor
       yielded_files[file]=nil
     end
     scan_new_with_spec(&yield_once_block)
-    scan_changed_with_spec(&yield_once_block) 
+    scan_changed_with_spec(&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.
@@ -85,7 +85,7 @@ class DirMonitor
       block.call(file, spec) if File.exists?(spec)
     end
   end
-  
+
   # Find the (theoretical) spec file name for a given file.
   # The assumptions are:
   # - All specs reside in the 'spec' directory.

data/lib/minitest.rb

@@ -1,69 +1,54 @@
+require 'set'
+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:
-# - Lookup all spec files in the spec/ directory.
-# - Lookup all possible associated files in the lib/ and app/ directories.
-# - Remember the mtimes (last modification times) of all relevant files.
-# - Every second, check all known relevant files: if their mtime changes, run rspec on their spec file.
+# - Initialize a DirMonitor
+# - Map all files in source dirs to specs
+# - Frequently check for new or changed files; run rspec on their associated specs
 # - Run rcov (code coverage tester) on all specs when exiting (Press ctrl-C on send SIGINT to the process)
 class Minitest
-  attr_reader :file_mtime
-  attr_reader :file_spec
-  attr_accessor :rcov_ignores
-  attr_accessor :recent
-  attr_accessor :recent_time
   attr_accessor :source_dirs
-  attr_accessor :source_extensions
-  attr_accessor :spec_cmd
-  attr_accessor :spec_opts
-  
+  attr_accessor :rcov_ignores
+  attr_accessor :spec_cmd, :spec_opts
+  attr_reader   :need_testing, :known_specs
+
   DEFAULT_RCOV_IGNORES = %w[spec/ db/ plugins/ vendor/ config/]
-  DEFAULT_RECENT_TIME = 3600
-  DEFAULT_SOURCE_DIRS = %w[lib app]
-  DEFAULT_SOURCE_EXTENSIONS = %w[rb haml rhtml erb]
-  
+  DEFAULT_SOURCE_DIRS = %w[lib app spec test]
+
   def initialize
-    @file_spec  = {}   # Map files to their specs
-    @file_mtime = {}   # Map files to their mtimes
-    @need_testing = [] # Specs that need testing
-    @first_run = true
     @active = false
+    @known_specs = Set.new
+    @need_testing = Set.new
   end
 
   def active?
     @active == true
   end
 
-  def first_run?
-    @first_run == true
-  end
-
   # Partial filepaths to exclude from rcov output
   def rcov_ignores
-    ignores = @rcov_ignores || DEFAULT_RCOV_IGNORES
+    ignores = (@rcov_ignores || DEFAULT_RCOV_IGNORES).dup
     ignores << spec_cmd
     ignores.join(",")
   end
 
   # Command line string to run rcov for all monitored specs.
   def rcov
-    "#{rcov_cmd} -T --exclude \"#{rcov_ignores}\" -Ilib #{spec_cmd} -- " + self.unique_specs.join(" ")
-  end
-
-  def recent?
-    @recent == true
-  end
-
-  # Maximum amount of seconds since a file has been changed for it to count as
-  # recently changed.
-  def recent_time
-    @recent_time || DEFAULT_RECENT_TIME
+    "#{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=self.unique_specs)
+  def rspec(specs=known_specs)
     "#{spec_cmd} #{specs.join(" ")} #{spec_opts}"
   end
 
@@ -71,10 +56,6 @@ class Minitest
     @source_dirs || DEFAULT_SOURCE_DIRS
   end
 
-  def source_extensions
-    @source_extensions || DEFAULT_SOURCE_EXTENSIONS
-  end
-  
   def rcov_cmd
     @rcov_cmd ||= find_rcov_cmd
   end
@@ -90,23 +71,19 @@ class Minitest
 
   def start
     @active = true
-    find_specs
-    
-    if self.file_spec.values.uniq.size == 0
-      puts "There are no specs to run."
-      return
-    end
-    
-    need_testing = find_first_run_specs
-    
+    @dir_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|
+        known_specs << spec
+        need_testing << spec
+      end
       if need_testing.size > 0
         print "\nTesting files: #{need_testing.join(" ")}\n"
         system rspec(need_testing)
       end
       sleep 1
-      need_testing = find_specs_to_check
     end
   end
 
@@ -119,86 +96,17 @@ class Minitest
     end
   end
 
-  def unique_specs
-    self.file_spec.values.uniq.sort
-  end
+  private
 
-private
-
-  def find_first_run_specs
-    need_checking = self.file_mtime.keys.dup
-    specs_to_check = []
-    if first_run? and recent?
-      need_checking.reject! { |file| @file_mtime[file] < ( Time.now - recent_time ) }
-      if need_checking.size > 0
-        puts "This first run will only test files changed in the last hour. All other files are still monitored."
-      else
-        puts "No files were changed in the last hour, so no files are tested for the first run."
-      end
-    end
-    specs_to_check = need_checking.map {|f| @file_spec[f]}
-    specs_to_check.uniq!
-    specs_to_check.sort!
-    @first_run = false
-    return specs_to_check
-  end
-  
-  def find_sources_for_spec(spec)
-    found_files = []
-    for dir in self.source_dirs
-      next unless spec[0,4]=='spec'
-      
-      file = spec.dup
-      file[0,4]=dir
-      file.gsub!("_spec.",".")
-      candidates = self.source_extensions.map { |ext| file.gsub(/[^.]+\Z/, ext)}
-      candidates = candidates.select { |f| File.exist?(f) }
-      found_files += candidates
-    end
-    found_files.uniq!
-    return found_files
-  end
-  
   def find_rcov_cmd
     `which rcov`.strip
   end
-  
+
   def find_spec_cmd
     `which spec`.strip
   end
 
-  def find_specs
-    Dir.glob("spec/**/*_spec.rb").each do |spec|
-      # If a spec changes, run it again.
-      map_file_to_spec(spec,spec)
-      for file in find_sources_for_spec(spec)
-        map_file_to_spec(file,spec)
-      end
-    end
-  end
-
-  def find_specs_to_check
-    specs = []
-    @file_mtime.each do |file, old_mtime|
-      current_mtime = File.mtime(file)
-      if current_mtime != old_mtime
-        specs << @file_spec[file]
-        store_mtime file
-      end
-    end
-    specs.uniq!
-    specs.sort!
-    return specs
-  end
-  
-  def map_file_to_spec(file,spec)
-    return if @file_mtime.has_key? file
-    @file_spec[file.dup]=spec.dup
-    store_mtime file
-    store_mtime spec
-  end
-
-  def store_mtime(file)
-    @file_mtime[file.dup] = File.mtime(file)
+  def reset_need_testing
+    @need_testing = Set.new
   end
 end

data/spec/dir_monitor_spec.rb

@@ -11,7 +11,7 @@ describe DirMonitor, ".new" do
     dm = DirMonitor.new(%w[lib app])
     dm.dirs.should == ['lib','app']
   end
-  
+
   it "should have no known files" do
     dm = DirMonitor.new('lib')
     dm.known_files.should == []
@@ -36,7 +36,7 @@ describe DirMonitor, "#scan_new" do
     Dir.stub!(:glob).with('lib/**/*').and_return(@known_files)
     @dm = DirMonitor.new 'lib'
   end
-  
+
   it "should yield the names of all new files" do
     yield_results = []
     @dm.scan_new do |file|
@@ -44,7 +44,7 @@ describe DirMonitor, "#scan_new" do
     end
     yield_results.should == @known_files
   end
-  
+
   it "should not yield known file names" do
     known_files2 = %w[lib/minitest.rb lib/dir_monitor2.rb]
     Dir.stub!(:glob).with('lib/**/*').and_return(@known_files, known_files2)
@@ -64,7 +64,7 @@ describe DirMonitor, "#scan_new_with_spec" do
     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 = []
@@ -73,7 +73,7 @@ describe DirMonitor, "#scan_new_with_spec" do
     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 = []
@@ -93,7 +93,7 @@ describe DirMonitor, "#scan_changed" do
     @dm = DirMonitor.new 'lib'
     @dm.scan
   end
-  
+
   it "should yield the names of changed known files" do
     changes = []
     @dm.scan_changed do |changed_file|
@@ -101,7 +101,7 @@ describe DirMonitor, "#scan_changed" do
     end
     changes.should == [@file]
   end
-  
+
   it "should not yield the names of files which did not change since last scan" do
     @dm.scan_changed { |f| }
     changes = []
@@ -134,7 +134,7 @@ describe DirMonitor, "scan_changed_with_spec" do
     @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 = []
@@ -163,7 +163,7 @@ describe DirMonitor, "scan_new_or_changed_with_spec" do
     File.stub!(:mtime).with(@file).and_return(@time)
     @dm = DirMonitor.new 'lib'
   end
-  
+
   it "should yield a file and spec when a file is new" do
     results = []
     @dm.scan_new_or_changed_with_spec do |file, spec|
@@ -171,7 +171,7 @@ describe DirMonitor, "scan_new_or_changed_with_spec" do
     end
     results.should == [{@file=>@spec}]
   end
-  
+
   it "should yield a file and spec when a file is not new but has changed" do
     @dm.scan
     @dm.scan_changed {|f|}
@@ -182,7 +182,7 @@ describe DirMonitor, "scan_new_or_changed_with_spec" do
     end
     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|}
@@ -198,19 +198,19 @@ describe DirMonitor, "#spec_for" do
   before(:each) do
     @dm = DirMonitor.new
   end
-  
+
   it "should find the spec for a given file" do
     file = 'lib/dir_monitor.rb'
     spec = 'spec/dir_monitor_spec.rb'
     @dm.spec_for(file).should == spec
   end
-  
+
   it "should find the spec for non-ruby files" do
     file = 'app/views/posts/post.html.haml'
     spec = 'spec/views/posts/post.html.haml_spec.rb'
     @dm.spec_for(file).should == spec
   end
-  
+
   it "should map specs to themselves" do
     spec = 'spec/dir_monitor_spec.rb'
     @dm.spec_for(spec).should == spec

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: Narnach-minitest
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors: 
 - Wes Oldenbeuving
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-06-21 00:00:00 -07:00
+date: 2008-08-14 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency