Narnach-minitest 0.3.1 → 0.3.2

data/README.rdoc

@@ -4,6 +4,20 @@ It can be used with 'plain' Ruby projects and Ruby on Rails.
 
 == Recent changes
 
+=== Version 0.3.2
+* Bugfixes:
+  * Minitest will not run non-existent specs
+  * Rcov will not run non-existent specs
+* Documentation changes:
+  * Readme examples match current functionality
+  * Readme has a todo section
+  * Minitest documentation updated
+  * DirMonitor documentation updated
+* Code cleanups:
+  * Gemspec is a lot more readable
+  * Numerous refactorings in Minitest and DirMonitor
+  * Set extension has its own file
+
 === Version 0.3.1
 Minitest gained support to test Test::Unit tests and RSpec specs at the same time.
 
@@ -40,7 +54,21 @@ You can also combine options:
 == 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.
+* Cleanup Minitest class / rewrite in a clean and testable way.
+
+== Minitest cleanup
+
+The Minitest class started as a simple script and thus was not designed to focus on one responsibility.
+Right now it tries to do too much:
+* Infinite loop
+* Execute RSpec for changed files
+* Execute test/unit for changed files
+* Execute RCov when terminating the loop
+Instead of delegating these tasks, it actually performs them.
+
+Adding three classes is a good first step to reduce complexity.
+Each 'executable' gets its own class: RSpec, RCov and test/unit.
+When that is done, the code in Minitest should be reduced to looping and delegating.
 
 == About
 Author:: Wes 'Narnach' Oldenbeuving (narnach@gmail.com)

data/lib/minitest.rb

@@ -1,5 +1,7 @@
 require 'set_ext'
 require 'dir_monitor'
+require 'mixins/rcov_mixin'
+require 'mixins/rspec_mixin'
 
 # = Minitest
 # The default usage of Minitest is this:
@@ -10,104 +12,82 @@ require 'dir_monitor'
 # - 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
+  include RcovMixin
+  include RspecMixin
+
   attr_accessor :source_dirs
-  attr_accessor :rcov_ignores
-  attr_accessor :spec_cmd, :spec_opts
-  attr_reader   :need_testing, :known_specs
+  attr_reader   :specs_to_run, :known_specs
+  attr_reader   :tests_to_run
 
-  DEFAULT_RCOV_IGNORES = %w[spec/ db/ plugins/ vendor/ config/]
   DEFAULT_SOURCE_DIRS = %w[lib app spec test]
 
   def initialize
     @active = false
     @known_specs = Set.new
-    @need_testing = Set.new
+    @specs_to_run = Set.new
+    @tests_to_run = Set.new
   end
 
   def active?
     @active == true
   end
 
-  # Partial filepaths to exclude from rcov output
-  def rcov_ignores
-    ignores = (@rcov_ignores || DEFAULT_RCOV_IGNORES).dup
-    ignores << spec_cmd
-    ignores.join(",")
-  end
-
   def source_dirs
     @source_dirs || DEFAULT_SOURCE_DIRS
   end
 
-  def spec_opts
-    @spec_opts ||= ( File.exist?('spec/spec.opts') ? '-O spec/spec.opts' : '' )
+  # Compile list of new or changed files with specs.
+  # Execute rspec on their specs.
+  def check_specs
+    specs_to_run.clear
+    @spec_monitor.scan_new_or_changed_with_spec do |file, spec|
+      next if specs_to_ignore.include?(spec)
+      known_specs << spec
+      specs_to_run << spec
+    end
+    if specs_to_run.size > 0
+      print "\nTesting files: #{specs_to_run.join(" ")}\n"
+      system rspec(specs_to_run)
+    end
+  end
+
+  # Compile list of new or changed files with tests.
+  # Execute test/unit on the test files.
+  def check_tests
+    tests_to_run.clear
+    @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
   end
 
+  # Start an infinite loop which does the following:
+  # * Check for files to test and test them, both for specs and tests
+  # * Sleep for a second
+  # Prior to starting the loop, the INT signal is trapped,
+  # so interrupting the process will not directly kill it.
+  # Instead, RCov is ran on all known specs.
   def start
     @active = true
     @spec_monitor = DirMonitor.new(source_dirs)
     @test_monitor = DirMonitor.new(source_dirs)
     trap_int_for_rcov
     while active? do
-      reset_need_testing
-      @spec_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
-      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
+      check_specs
+      check_tests
       sleep 1
     end
   end
 
-  private
-
-  def find_rcov_cmd
-    `which rcov`.strip
-  end
-
-  def find_spec_cmd
-    `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
+      specs = known_specs.select{|s| File.exist?(s)}
+      puts rcov(specs)
+      system rcov(specs)
       @active = false
     end
   end

data/lib/mixins/rcov_mixin.rb

@@ -0,0 +1,26 @@
+module RcovMixin
+  DEFAULT_RCOV_IGNORES = %w[spec/ db/ plugins/ vendor/ config/]
+  attr_accessor :rcov_ignores
+
+  # Partial filepaths to exclude from rcov output
+  def rcov_ignores
+    ignores = (@rcov_ignores || DEFAULT_RCOV_IGNORES).dup
+    ignores << spec_cmd
+    ignores.join(",")
+  end
+
+  private
+
+  def find_rcov_cmd
+    `which rcov`.strip
+  end
+
+  # Command line string to run rcov for all monitored specs.
+  def rcov(files)
+    "#{rcov_cmd} -T --exclude \"#{rcov_ignores}\" -Ilib #{spec_cmd} -- " + files.join(" ")
+  end
+
+  def rcov_cmd
+    @rcov_cmd ||= find_rcov_cmd
+  end
+end

data/lib/mixins/rspec_mixin.rb

@@ -0,0 +1,28 @@
+module RspecMixin
+  attr_accessor :spec_cmd, :spec_opts
+  DEFAULT_SPECS_TO_IGNORE = %w[spec/spec_helper.rb]
+
+  def spec_opts
+    @spec_opts ||= ( File.exist?('spec/spec.opts') ? '-O spec/spec.opts' : '' )
+  end
+
+  def specs_to_ignore
+    @specs_to_ignore ||= Set.new(DEFAULT_SPECS_TO_IGNORE)
+  end
+
+  private
+
+  def find_spec_cmd
+    `which spec`.strip
+  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
+end

data/minitest.gemspec

@@ -3,7 +3,7 @@ Gem::Specification.new do |s|
   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.version      = '0.3.2'
   s.date         = '2008-08-14'
   s.platform     = Gem::Platform::RUBY
   s.authors      = ["Wes Oldenbeuving"]
@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
   # Files
   root_files     = %w[MIT-LICENSE README.rdoc Rakefile minitest.gemspec]
   bin_files      = %w[minitest]
-  lib_files      = %w[minitest dir_monitor set_ext]
+  lib_files      = %w[minitest dir_monitor set_ext mixins/rcov_mixin mixins/rspec_mixin]
   test_files     = %w[]
   spec_files     = %w[minitest dir_monitor set_ext]
   other_files    = %w[spec/spec.opts spec/spec_helper.rb]

data/spec/minitest_spec.rb

@@ -2,4 +2,27 @@ require File.join(File.dirname(__FILE__),'spec_helper')
 require 'minitest'
 
 describe Minitest do
+  describe "#check" do
+    describe 'run existing specs and tests', :shared => true do
+      it 'should run its associated spec'
+      it 'should run its associated test'
+      it 'should skip non-existent specs'
+      it 'should skip non-existent tests'
+    end
+
+    describe '(when a new file is created)' do
+      it_should_behave_like 'run existing specs and tests'
+    end
+
+    describe '(when a file is changed)' do
+      it_should_behave_like 'run existing specs and tests'
+    end
+  end
+
+  describe "#start" do
+    it 'should run #check periodically'
+    describe "(when interrupted)" do
+      it 'should run rcov on known specs and tests'
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: Narnach-minitest
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors: 
 - Wes Oldenbeuving
@@ -53,6 +53,8 @@ files:
 - lib/minitest.rb
 - lib/dir_monitor.rb
 - lib/set_ext.rb
+- lib/mixins/rcov_mixin.rb
+- lib/mixins/rspec_mixin.rb
 has_rdoc: true
 homepage: http://www.github.com/Narnach/minitest
 post_install_message: