guard-test 0.1.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Rémy Coutable
+
+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,77 @@
+= Guard::Test
+
+Test::Unit guard allows to automatically & intelligently launch tests when files are modified.
+
+- Compatible with Test::Unit 2.1.1.
+- Tested on Ruby 1.8.6, 1.8.7, REE & 1.9.2 (display a annoying "uninitialized constant Test::Unit::UI::Console::Diff" warning though).
+
+== Install
+
+Please be sure to have {guard}[http://github.com/guard/guard] installed before continue.
+
+Install the gem:
+
+    gem install guard-test
+
+Add it to your Gemfile (inside test group):
+
+    gem 'guard-test'
+
+Add guard definition to your Guardfile by running this command:
+
+    guard init test
+
+== Usage
+
+Please read {guard usage doc}[http://github.com/guard/guard#readme]
+
+== Guardfile
+
+Test::Unit guard can be really be adapted to all kind of projects.
+Please read {guard doc}[http://github.com/guard/guard#readme] for more info about Guardfile DSL.
+
+=== Standard ruby gems
+
+    guard 'test' do
+      watch('^lib/(.*)\.rb')        { |m| "test/lib/#{m[1]}_test.rb" }
+      watch('^test/(.*)_test.rb')   
+      watch('^test/test_helper.rb') { "test" }
+    end
+
+=== Rails app
+
+    guard 'test' do
+      watch('^app/models/(.*)\.rb')                       { |m| "test/unit/#{m[1]}_test.rb" }
+      watch('^app/controllers/(.*)\.rb')                  { |m| "test/functional/#{m[1]}_test.rb" }
+      watch('^app/controllers/application_controller.rb') { "test/functional" }
+      watch('^app/controllers/application_controller.rb') { "test/integration" }
+      watch('^app/views/(.*)\.rb')                        { "test/integration" }
+      watch('^lib/(.*)\.rb')                              { |m| "test/lib/#{m[1]}_test.rb" }
+      watch('^test/(.*)_test.rb')
+      watch('^test/factories.rb')                         { "test/unit" }
+      watch('^test/test_helper.rb')                       { "test" }
+    end
+
+== Options
+
+Test::Unit guard allow you to choose between two different runners:
+  
+- 'default' (obviously, guard-test will use this by default): Display progress as chars ('.' for pass, 'F' for fail, 'E' for error) and errors when all the tests are finished.
+- 'fastfail': Display failures/errors messages as they happen, not at the end and passing tests with '.'.
+
+Set the desired runner by passing the :runner option to the <tt>guard</tt> method:
+
+    guard 'test', :runner => 'fastfail' do
+      ...
+    end
+
+== Development
+
+- Source hosted at {GitHub}[http://github.com/guard/guard-test]
+- Report issues/Questions/Feature requests on {GitHub Issues}[http://github.com/guard/guard-test/issues]
+
+Pull requests are very welcome! Make sure your patches are well tested. Please create a topic branch for every separate change you make.
+
+== Authors
+
+{Rémy Coutable}[http://github.com/rymai]

data/lib/guard/test/formatter.rb

@@ -0,0 +1,61 @@
+require "#{File.dirname(__FILE__)}/../test"
+
+module Formatter
+  
+  def output_results(test_count, assertion_count, failure_count, error_count, duration, options = {})
+    output(duration_text(duration, options)) if options[:with_duration]
+    color = (failure_count > 0 ? "failure" : (error_count > 0 ? "error" : "pass"))
+    output(results_text(test_count, assertion_count, failure_count, error_count), color)
+  end
+  
+  def notify_results(test_count, assertion_count, failure_count, error_count, duration)
+    notify(
+      results_text(test_count, assertion_count, failure_count, error_count) + duration_text(duration, :short => true),
+      image(failure_count)
+    )
+  end
+  
+  def output_and_notify_results(test_count, assertion_count, failure_count, error_count, duration, options = {})
+    output_results(test_count, assertion_count, failure_count, error_count, duration, options)
+    notify_results(test_count, assertion_count, failure_count, error_count, duration)
+  end
+  
+  def image(failure_count)
+    failure_count > 0 ? :failed : :success
+  end
+  
+  def notify(message, image)
+    Guard::Notifier.notify(message, :title => "Test::Unit results", :image => image)
+  end
+  
+  def output_single(something, color_name = "reset")
+    something = "%s%s%s" % [color_sequence(color_name), something, color_sequence("reset")]
+    $stdout.write(something)
+    $stdout.flush
+    true
+  end
+  
+  def output(something, color_name = "reset")
+    output_single(something, color_name)
+    $stdout.puts
+  end
+  
+private
+  
+  def color_sequence(color_name = "reset")
+    "\e[0#{color_code(color_name)}m"
+  end
+  
+  def color_code(name = "reset")
+    { "pass" => ";32", "failure" => ";31", "pending" => ";33", "error" => ";35", "reset" => "" }[name]
+  end
+  
+  def results_text(test_count, assertion_count, failure_count, error_count)
+    "#{test_count} tests, #{assertion_count} asserts, #{failure_count} fails, #{error_count} errors"
+  end
+  
+  def duration_text(duration, options = {})
+    "\n\n#{"Finished " unless options[:short]}in #{duration} seconds\n"
+  end
+  
+end

data/lib/guard/test/inspector.rb

@@ -0,0 +1,45 @@
+module Guard
+  class Test
+    module Inspector
+      class << self
+        
+        def clean(paths)
+          paths.uniq!
+          paths.compact!
+          clean_paths = paths.select { |p| test_file?(p) || test_folder?(p) }
+          
+          paths.each do |path|
+            if File.directory?(path)
+              clean_paths.delete(path)
+              clean_paths = clean_paths + Dir.glob("#{path}/**/*_test.rb")
+            end
+          end
+          
+          clean_paths.uniq!
+          clean_paths.compact!
+          clear_test_files_list
+          clean_paths.sort
+        end
+        
+      private
+        
+        def test_folder?(path)
+          path.match(/^\/?test/) && !path.match(/\..+$/)
+        end
+        
+        def test_file?(path)
+          test_files.include?(path)
+        end
+        
+        def test_files
+          @test_files ||= Dir.glob("test/**/*_test.rb")
+        end
+        
+        def clear_test_files_list
+          @test_files = nil
+        end
+        
+      end
+    end
+  end
+end

data/lib/guard/test/runner.rb

@@ -0,0 +1,34 @@
+module Guard
+  class Test
+    module Runner
+      class << self
+        attr_reader :test_unit_runner
+        
+        AVAILABLE_TEST_UNIT_RUNNERS = %w[default fastfail]
+        
+        def set_test_unit_runner(options = {})
+          @test_unit_runner = AVAILABLE_TEST_UNIT_RUNNERS.include?(options[:runner]) ? options[:runner] : 'default'
+        end
+        
+        def run(paths, options = {})
+          message = "\n" + (options[:message] || "Running (#{@test_unit_runner} runner): #{paths.join(' ') }")
+          UI.info(message, :reset => true)
+          system(test_unit_command(paths))
+        end
+        
+      private
+        
+        def test_unit_command(files)
+          cmd_parts = ["ruby"]
+          cmd_parts << "-r#{File.dirname(__FILE__)}/runners/#{@test_unit_runner}_test_unit_runner"
+          cmd_parts << "-Itest"
+          cmd_parts << "-e \"%w[#{files.join(' ')}].each { |f| load f }\""
+          cmd_parts << files.map { |f| "\"#{f}\"" }.join(' ')
+          cmd_parts << "--runner=guard-#{@test_unit_runner}"
+          cmd_parts.join(' ')
+        end
+        
+      end
+    end
+  end
+end

data/lib/guard/test/runners/default_test_unit_runner.rb

@@ -0,0 +1,56 @@
+require "#{File.dirname(__FILE__)}/../formatter"
+require 'test/unit'
+require 'test/unit/testcase'
+require 'test/unit/ui/console/testrunner'
+
+# Thanks to Adam Sanderson for the really good starting point:
+# http://endofline.wordpress.com/2008/02/11/a-custom-testrunner-to-scratch-an-itch/
+# 
+# This class inherits from Test::Unit' standard console TestRunner
+# I'm just overriding some callbacks methods to display nice results
+class DefaultGuardTestRunner < Test::Unit::UI::Console::TestRunner
+  include Formatter
+  
+  def initialize(suite, options = {})
+    super
+    @use_color = true
+  end
+  
+protected
+  
+  # Test::Unit::UI::Console::TestRunner overrided methods
+  def setup_mediator
+    @mediator = Test::Unit::UI::TestRunnerMediator.new(@suite)
+  end
+  
+  def started(result)
+    @result = result
+  end
+  
+  def test_started(name) # silence!
+  end
+  
+  def add_fault(fault)
+    @faults << fault
+    output_single(fault.single_character_display, fault_color_name(fault))
+    @already_outputted = true
+  end
+  
+  def test_finished(name)
+    output_single(".", "pass") unless @already_outputted
+    @already_outputted = false
+  end
+  
+  def finished(elapsed_time)
+    nl
+    super
+    notify_results(@result.run_count, @result.assertion_count, @result.failure_count, @result.error_count, elapsed_time)
+  end
+  
+  def fault_color_name(fault)
+    fault.class.name.split(/::/).last.downcase
+  end
+  
+end
+
+Test::Unit::AutoRunner::RUNNERS["guard-default"] = Proc.new { |r| DefaultGuardTestRunner }

data/lib/guard/test/runners/fastfail_test_unit_runner.rb

@@ -0,0 +1,24 @@
+require "#{File.dirname(__FILE__)}/default_test_unit_runner"
+
+# This class is directly inspired by a blog post by Adam Sanderson:
+# http://endofline.wordpress.com/2008/02/11/a-custom-testrunner-to-scratch-an-itch/
+# It inherits DefaultGuardTestRunner and redefines only 2 methods in order to display failures
+# as they happen (the default display them when all the tests are finished).
+class FastfailGuardTestUnitRunner < DefaultGuardTestRunner
+  
+private
+  
+  def add_fault(fault)
+    @faults << fault
+    nl
+    output("%3d) %s" % [@faults.length, fault.long_display])
+    @already_outputted = true
+  end
+  
+  def finished(elapsed_time)
+    output_and_notify_results(@result.run_count, @result.assertion_count, @result.failure_count, @result.error_count, elapsed_time, :with_duration => true)
+  end
+  
+end
+
+Test::Unit::AutoRunner::RUNNERS["guard-fastfail"] = Proc.new { |r| FastfailGuardTestUnitRunner }

data/lib/guard/test/templates/Guardfile

@@ -0,0 +1,13 @@
+guard 'test' do
+  watch('^lib/(.*)\.rb')                              { |m| "test/lib/#{m[1]}_test.rb" }
+  watch('^test/(.*)_test.rb')
+  watch('^test/test_helper.rb')                       { "test" }
+  
+  # Rails example
+  watch('^app/models/(.*)\.rb')                       { |m| "test/unit/#{m[1]}_test.rb" }
+  watch('^app/controllers/(.*)\.rb')                  { |m| "test/functional/#{m[1]}_test.rb" }
+  watch('^app/controllers/application_controller.rb') { "test/functional" }
+  watch('^app/controllers/application_controller.rb') { "test/integration" }
+  watch('^app/views/(.*)\.rb')                        { "test/integration" }
+  watch('^test/factories.rb')                         { "test/unit" }
+end

data/lib/guard/test/version.rb

@@ -0,0 +1,5 @@
+module Guard
+  module TestVersion
+    VERSION = "0.1.1"
+  end
+end

data/lib/guard/test.rb

@@ -0,0 +1,31 @@
+require 'rubygems'
+require 'guard'
+require 'guard/guard'
+
+module Guard
+  class Test < Guard
+    
+    autoload :Runner,    'guard/test/runner'
+    autoload :Inspector, 'guard/test/inspector'
+    
+    def start
+      Runner.set_test_unit_runner(options)
+      UI.info "Guard::Test is guarding your tests!"
+    end
+    
+    def run_all
+      clean_and_run(["test"], :message => "Running all tests")
+    end
+    
+    def run_on_change(paths)
+      clean_and_run(paths)
+    end
+    
+  private
+    
+    def clean_and_run(paths, options = {})
+      paths = Inspector.clean(paths)
+      Runner.run(paths, options) unless paths.empty?
+    end
+  end
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification 
+name: guard-test
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- "R\xC3\xA9my Coutable"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-19 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: guard
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 62196353
+        segments: 
+        - 0
+        - 2
+        - 0
+        - beta
+        - 1
+        version: 0.2.0.beta.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 1
+        - 0
+        - 2
+        version: 1.0.2
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: guard-rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 0
+        - 1
+        - 3
+        version: 0.1.3
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: test-unit
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 1
+        - 1
+        version: 2.1.1
+  type: :development
+  version_requirements: *id005
+description: Guard::Test automatically run your tests and notify you of the result when a file is modified.
+email: 
+- rymai@rymai.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/guard/test/formatter.rb
+- lib/guard/test/inspector.rb
+- lib/guard/test/runner.rb
+- lib/guard/test/runners/default_test_unit_runner.rb
+- lib/guard/test/runners/fastfail_test_unit_runner.rb
+- lib/guard/test/templates/Guardfile
+- lib/guard/test/version.rb
+- lib/guard/test.rb
+- LICENSE
+- README.rdoc
+has_rdoc: true
+homepage: http://rubygems.org/gems/guard-test
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: guard-test
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Guard gem for Test::Unit
+test_files: []
+