Narnach-minitest 0.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Wes Oldenbeuving
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,35 @@
+== 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.
+
+== Installation
+=== From gem
+Use gem to install minitest. The gem is located on github.
+  sudo gem install narnach-minitest -s http://gems.github.com
+=== From git
+From the project root, use rake to install:
+  git clone git://github.com/Narnach/minitest.git
+  cd minitest
+  rake install
+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.
+
+== 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:
+  minitest recent profile
+
+== About
+Author:: Wes 'Narnach' Oldenbeuving (narnach@gmail.com)
+Website:: http://www.github.com/Narnach/minitest
+Copyright:: Copyright (c) 2008 Wes Oldenbeuving
+License:: MIT license. See MIT-LICENSE (in the gem directory) for license details.

data/Rakefile

@@ -0,0 +1,44 @@
+require "rake"
+require "rake/clean"
+require "rake/gempackagetask"
+require 'rubygems'
+require 'lib/minitest'
+
+################################################################################
+### Gem
+################################################################################
+
+begin
+  # Parse gemspec using the github safety level.
+  data = File.read('minitest.gemspec')
+  spec = nil
+  Thread.new { spec = eval("$SAFE = 3\n%s" % data)}.join
+
+  # Create the gem tasks
+  Rake::GemPackageTask.new(spec) do |package|
+    package.gem_spec = spec
+  end
+rescue Exception => e
+  printf "WARNING: Error caught (%s): %s\n", e.class.name, e.message
+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
+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

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__),'..','lib'))
+require 'minitest'
+
+minitest = Minitest.new
+minitest.recent = (ARGV.include? "recent")
+minitest.spec_opts = "--format profile --colour --diff unified" if ARGV.include? "profile"
+minitest.start

data/lib/dir_monitor.rb

@@ -0,0 +1,76 @@
+# 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.
+class DirMonitor
+  attr_reader :known_files, :dirs
+  
+  # Setup a new DirMonitor.
+  # Directories can be provided in a number of ways:
+  #   DirMonitor.new 'lib', 'app'
+  #   DirMonitor.new :lib, :app
+  #   DirMonitor.new %w[lib app]
+  # Each of these examples will result in the same list of directories being stored for use.
+  def initialize(*dirs)
+    @dirs = dirs.flatten.map{|dir| dir.to_s}
+    @known_files = []
+  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
+    results = []
+    dirs.each do |dir|
+      files_in_dir = Dir.glob(File.join(dir,'**','*'))
+      results.concat(files_in_dir)
+    end
+    @known_files = results
+  end
+  
+  # Scan for new files.
+  # All new file names are yielded.
+  def scan_new(&block) # :yields: file
+    old_known_files = @known_files
+    scan
+    new_files = known_files - old_known_files
+    new_files.each do |new_file|
+      block.call(new_file)
+    end
+  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)
+    end
+  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 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)
+    base = File.basename(file)
+    extension = File.extname(base)
+    dir = File.dirname(file)
+    dir_array = dir.split('/')
+    if extension == '.rb' and dir_array.first=='spec'
+      return file
+    end
+    if extension == '.rb'
+      base_without_extension = base[0, base.size - extension.size]
+      spec_file = base_without_extension + '_spec' + extension
+    else
+      spec_file = base + '_spec.rb'
+    end
+    dir_array[0]='spec'
+    spec_dir = dir_array.join('/')
+    return File.join(spec_dir, spec_file)
+  end
+end

data/lib/minitest.rb

@@ -0,0 +1,204 @@
+# = 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.
+# - 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
+  
+  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]
+  
+  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
+  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 << 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
+  end
+
+  # Command line string to run rspec for an array of specs. Defaults to all specs.
+  def rspec(specs=self.unique_specs)
+    "#{spec_cmd} #{specs.join(" ")} #{spec_opts}"
+  end
+
+  def source_dirs
+    @source_dirs || DEFAULT_SOURCE_DIRS
+  end
+
+  def source_extensions
+    @source_extensions || DEFAULT_SOURCE_EXTENSIONS
+  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
+    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
+    
+    trap_int_for_rcov
+    while active? do
+      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
+
+  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
+
+  def unique_specs
+    self.file_spec.values.uniq.sort
+  end
+
+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)
+  end
+end

data/spec/dir_monitor_spec.rb

@@ -0,0 +1,107 @@
+$LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__),'..','lib'))
+require 'dir_monitor'
+
+describe DirMonitor, ".new" do
+  it "should accept multiple directories" do
+    dm = DirMonitor.new('lib','app')
+    dm.dirs.should == ['lib','app']
+  end
+
+  it "should accept an array with multiple directories" 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 == []
+  end
+end
+
+describe DirMonitor, "#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]
+    Dir.should_receive(:glob).with('lib/**/*').and_return(known_files1)
+    Dir.should_receive(:glob).with('app/**/*').and_return(known_files2)
+    dm = DirMonitor.new('lib', 'app')
+    dm.scan
+    dm.known_files.should == known_files1 + known_files2
+  end
+end
+
+describe DirMonitor, "#scan_new" do
+  it "should yield the names of all new files" do
+    known_files = %w[lib/minitest.rb lib/dir_monitor.rb]
+    Dir.should_receive(:glob).with('lib/**/*').and_return(known_files)
+    dm = DirMonitor.new('lib')
+    yield_results = []
+    dm.scan_new do |file|
+      yield_results << file
+    end
+    yield_results.should == known_files
+  end
+  
+  it "should not yield known file names" do
+    known_files = %w[lib/minitest.rb lib/dir_monitor.rb]
+    known_files2 = %w[lib/minitest.rb lib/dir_monitor2.rb]
+    Dir.should_receive(:glob).with('lib/**/*').and_return(known_files, known_files2)
+    dm = DirMonitor.new('lib')
+    dm.scan
+    yield_results = []
+    dm.scan_new do |file|
+      yield_results << file
+    end
+    yield_results.should == known_files2 - known_files
+  end
+end
+
+describe DirMonitor, "#spec_for" do
+  it "should find the spec for a given file" do
+    file = 'lib/dir_monitor.rb'
+    spec = 'spec/dir_monitor_spec.rb'
+    dm = DirMonitor.new
+    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 = DirMonitor.new
+    dm.spec_for(file).should == spec
+  end
+  
+  it "should map specs to themselves" do
+    spec = 'spec/dir_monitor_spec.rb'
+    dm = DirMonitor.new
+    dm.spec_for(spec).should == spec
+  end
+end
+
+describe DirMonitor, "#scan_new_with_spec" do
+  it "should yield new files and their specs" do
+    file = 'lib/dir_monitor.rb'
+    spec = 'spec/dir_monitor_spec.rb'
+    Dir.should_receive(:glob).with('lib/**/*').and_return([file])
+    File.should_receive(:exists?).with(spec).and_return(true)
+    dm = DirMonitor.new 'lib'
+    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 = 'lib/dir_monitor.rb'
+    spec = 'spec/dir_monitor_spec.rb'
+    Dir.should_receive(:glob).with('lib/**/*').and_return([file])
+    File.should_receive(:exists?).with(spec).and_return(false)
+    dm = DirMonitor.new 'lib'
+    results = []
+    dm.scan_new_with_spec do |new_file, new_spec|
+      results << {new_file => new_spec}
+    end
+    results.should == []
+  end
+end

data/spec/minitest_spec.rb

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

data/spec/spec.opts

@@ -0,0 +1,3 @@
+--diff unified
+--colour
+--format specdoc

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: Narnach-minitest
+version: !ruby/object:Gem::Version 
+  version: "0.2"
+platform: ruby
+authors: 
+- Wes Oldenbeuving
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-06-21 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: 
+description: Minitest is a simple autotester tool, which uses rSpec and rCov to test ruby and rails projects.
+email: narnach@gmail.com
+executables: 
+- minitest
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- MIT-LICENSE
+files: 
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- bin/minitest
+- lib/dir_monitor.rb
+- lib/minitest.rb
+- spec/dir_monitor_spec.rb
+- spec/minitest_spec.rb
+- spec/spec.opts
+has_rdoc: true
+homepage: http://www.github.com/Narnach/minitest
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --line-numbers
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.0
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.0.1
+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