tending 1.0.0

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2008-05-15
+
+* 2 major enhancements
+
+  * Tending allows adding pending tests to Test::Unit test cases
+  * Tending can report on pending tests in files given a file pattern

data/Manifest.txt

@@ -0,0 +1,14 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/tending
+lib/tending.rb
+lib/tending/disable_auto_runner.rb
+lib/tending/pending.rb
+lib/tending/tending_report.rb
+tending.gemspec
+test/pending_files/file_one.rb
+test/pending_files/file_two.rb
+test/test_pending.rb
+test/test_tending_report.rb

data/README.txt

@@ -0,0 +1,76 @@
+= tending
+
+* http://tending.rubyforge.org
+* git hub - http://github.com/dfg59/tending/tree/master
+* public git repo - git://github.com/dfg59/tending.git
+
+== DESCRIPTION:
+
+tending allows you to add pending tests to your Test::Unit test cases
+
+== FEATURES/PROBLEMS:
+
+* tending allows adding pending tests to Test::Unit test cases
+* tending can report on pending tests in files given a file pattern
+
+== SYNOPSIS:
+
+While writing your test cases, use tending to add place holders for tests you haven't yet
+written using the pending method. For example:
+
+  require 'test/unit'
+  require 'rubygems'
+  require 'tending'
+
+  class TestFoo < Test::Unit::TestCase
+    def test_truth
+      assert true
+    end
+
+    pending 'test false scenario'
+    pending 'test edge cases'
+  end
+
+After adding pending tests to your test files, you can use the tending command line tool to generate
+a report of pending tests. This command accepts any file patterns that Dir.glob accepts. For example,
+if I wanted a report of all pending tests within the test directory of my project and my current
+working directory was the project root, I would execute the following:
+
+  tending 'test/*'
+
+This will generate a detailed report, by file, of all pending tests.
+
+== REQUIREMENTS:
+
+* need 1.0.2
+* hoe 1.5.1
+
+== INSTALL:
+
+* rubyforge - sudo gem install tending
+* github - sudo gem install dfg59-tending --source=http://gems.github.com
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 FIX
+
+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/Rakefile

@@ -0,0 +1,13 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/tending.rb'
+
+Hoe.new('tending', Tending::VERSION) do |p|
+  p.rubyforge_name = 'tending'
+  p.developer('Drew Olson', 'drew@drewolson.org')
+  p.extra_deps << ['need', '>= 1.0.2']
+end
+
+# vim: syntax=Ruby

data/bin/tending

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'need'
+need {'../lib/tending/tending_report'}
+need {'../lib/tending/disable_auto_runner'}
+
+begin
+  reporter = Tending::TendingReport.new(*ARGV)
+  puts reporter.report
+rescue ArgumentError
+  puts "usage: tending [file pattern]"
+end

data/lib/tending.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'need'
+need {'tending/pending'}
+
+module Tending
+  VERSION = '1.0.0'
+end

data/lib/tending/disable_auto_runner.rb

@@ -0,0 +1,8 @@
+require "test/unit/autorunner"
+
+class Test::Unit::AutoRunner
+  # disable autorunner for gathering pending tests
+  def self.run
+    $exit = 0
+  end
+end

data/lib/tending/pending.rb

@@ -0,0 +1,16 @@
+require 'test/unit/testcase'
+
+class Test::Unit::TestCase
+  # allows creation of pending tests inside Test::Unit::TestCase
+  def self.pending(desc)
+    @@pending_tests ||= {}
+    caller_file = File.expand_path(caller.first.split(':').first)
+    @@pending_tests[caller_file] ||= []
+    @@pending_tests[caller_file] << desc
+  end
+  
+  # return hash of files and associated pending tests
+  def self.pending_tests
+    @@pending_tests ||= {}
+  end
+end

data/lib/tending/tending_report.rb

@@ -0,0 +1,34 @@
+require 'rubygems'
+require 'need'
+need {'pending'}
+
+module Tending
+  # class used to renerate reports of pending tests
+  class TendingReport
+    def initialize(pattern)
+      raise ArgumentError unless pattern.kind_of? String
+      
+      @pattern = pattern
+    end
+    
+    # generate report based on pattern
+    def report
+      Dir.glob(@pattern) do |file|
+        unless require file
+          load file
+        end
+      end
+      
+      report_string = "\nPending Tests:\n"
+      
+      Test::Unit::TestCase.pending_tests.each do |file,pending_tests|
+        report_string += "In #{file}:\n"
+        pending_tests.each do |pending_test|
+          report_string += "  #{pending_test}\n"
+        end
+      end
+      
+      report_string + "\n"
+    end
+  end
+end

data/tending.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |s|
+  s.name = %q{tending}
+  s.version = "1.0.0"
+
+  s.specification_version = 2 if s.respond_to? :specification_version=
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Drew Olson"]
+  s.date = %q{2008-05-15}
+  s.default_executable = %q{tending}
+  s.description = %q{tending allows you to add pending tests to your Test::Unit test cases}
+  s.email = ["drew@drewolson.org"]
+  s.executables = ["tending"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.txt"]
+  s.files = ["History.txt", "Manifest.txt", "README.txt", "Rakefile", "bin/tending", "lib/tending.rb", "lib/tending/disable_auto_runner.rb", "lib/tending/pending.rb", "lib/tending/tending_report.rb", "tending.gemspec", "test/pending_files/file_one.rb", "test/pending_files/file_two.rb", "test/test_pending.rb", "test/test_tending_report.rb"]
+  s.has_rdoc = true
+  s.homepage = %q{http://tending.rubyforge.org}
+  s.rdoc_options = ["--main", "README.txt"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{tending}
+  s.rubygems_version = %q{1.1.1}
+  s.summary = %q{tending allows you to add pending tests to your Test::Unit test cases}
+  s.test_files = ["test/test_pending.rb", "test/test_tending_report.rb"]
+
+  s.add_dependency(%q<need>, [">= 1.0.2"])
+  s.add_dependency(%q<hoe>, [">= 1.5.1"])
+end

data/test/pending_files/file_one.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'need'
+need {'../../lib/tending'}
+
+Class.new(Test::Unit::TestCase).pending "foo"

data/test/pending_files/file_two.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'need'
+need {'../../lib/tending'}
+
+Class.new(Test::Unit::TestCase).pending "foo"

data/test/test_pending.rb

@@ -0,0 +1,47 @@
+require "test/unit"
+require 'rubygems'
+require 'need'
+need {'../lib/tending'}
+
+class TestPending < Test::Unit::TestCase
+  def test_pending_does_not_throw_error
+    assert_nothing_raised do
+      Class.new(Test::Unit::TestCase).pending "foo"
+    end
+    Test::Unit::TestCase.class_eval { @@pending_tests = {} }
+  end
+  
+  def test_pending_tests_can_be_retrieved_from_test_class
+    klass = Class.new(Test::Unit::TestCase)
+    klass.pending "foo"
+    assert(klass.pending_tests, "Pending tests were not retrieved from Test::Unit class")
+    Test::Unit::TestCase.class_eval { @@pending_tests = {} }
+  end
+  
+  def test_pending_test_can_be_retrieved_from_test_unit_parent_class
+    klass = Class.new(Test::Unit::TestCase)
+    klass.pending "foo"
+    assert(Test::Unit::TestCase.pending_tests, "Pending tests were not retrieved from Test::Unit class")
+    Test::Unit::TestCase.class_eval { @@pending_tests = {} }  
+  end
+  
+  def test_pending_tests_shared_across_classes
+    Class.new(Test::Unit::TestCase).pending "foo"
+    Class.new(Test::Unit::TestCase).pending "bar"
+    assert_equal({File.expand_path(__FILE__) => ["foo","bar"]}, Test::Unit::TestCase.pending_tests)
+    Test::Unit::TestCase.class_eval { @@pending_tests = {} }
+  end
+  
+  def test_pending_tests_returns_correct_hash_for_one_file
+    Class.new(Test::Unit::TestCase).pending "foo"
+    assert_equal({File.expand_path(__FILE__) => ["foo"]}, Test::Unit::TestCase.pending_tests)
+    Test::Unit::TestCase.class_eval { @@pending_tests = {} }
+  end
+  
+  def test_pending_tests_shares_across_files
+    need {'pending_files/file_one'}
+    need {'pending_files/file_two'}
+    assert_equal(2, Test::Unit::TestCase.pending_tests.size)
+    Test::Unit::TestCase.class_eval { @@pending_tests = {} }
+  end
+end

data/test/test_tending_report.rb

@@ -0,0 +1,53 @@
+require "test/unit"
+require 'rubygems'
+require 'need'
+need {'../lib/tending'}
+need {'../lib/tending/tending_report'}
+
+class TestTendingReport < Test::Unit::TestCase
+  def test_raises_argument_error_when_string_is_not_passed_to_initialize
+    assert_raises ArgumentError do
+      Tending::TendingReport.new(1)
+    end
+  end
+  
+  def test_raises_argument_error_when_nothing_passed_to_initialize
+    assert_raises ArgumentError do
+      Tending::TendingReport.new
+    end
+  end
+  
+  def test_one_file_tending_report
+    simple_report = <<-EOS   
+Pending Tests:
+In #{File.expand_path(File.join(File.dirname(__FILE__),"pending_files","file_one.rb"))}:
+  foo
+    EOS
+    
+    simple_report = "\n"+simple_report+"\n"
+    
+    pattern = File.expand_path(File.join(File.dirname(__FILE__),"pending_files","file_one.rb"))
+    reporter = Tending::TendingReport.new(pattern)
+    
+    assert_equal(simple_report, reporter.report)
+    Test::Unit::TestCase.class_eval { @@pending_tests = {} }  
+  end
+  
+  def test_several_files_tending_report
+    mutli_file_report = <<-EOS   
+Pending Tests:
+In #{File.expand_path(File.join(File.dirname(__FILE__),"pending_files","file_one.rb"))}:
+  foo
+In #{File.expand_path(File.join(File.dirname(__FILE__),"pending_files","file_two.rb"))}:
+  foo
+    EOS
+    
+    mutli_file_report = "\n"+mutli_file_report+"\n"
+    
+    pattern = File.expand_path(File.join(File.dirname(__FILE__),"pending_files","*"))
+    reporter = Tending::TendingReport.new(pattern)
+    
+    assert_equal(mutli_file_report, reporter.report)
+    Test::Unit::TestCase.class_eval { @@pending_tests = {} }
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: tending
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Drew Olson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-05-16 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: need
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.1
+    version: 
+description: tending allows you to add pending tests to your Test::Unit test cases
+email: 
+- drew@drewolson.org
+executables: 
+- tending
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/tending
+- lib/tending.rb
+- lib/tending/disable_auto_runner.rb
+- lib/tending/pending.rb
+- lib/tending/tending_report.rb
+- tending.gemspec
+- test/pending_files/file_one.rb
+- test/pending_files/file_two.rb
+- test/test_pending.rb
+- test/test_tending_report.rb
+has_rdoc: true
+homepage: http://tending.rubyforge.org
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: tending
+rubygems_version: 1.1.1
+signing_key: 
+specification_version: 2
+summary: tending allows you to add pending tests to your Test::Unit test cases
+test_files: 
+- test/test_pending.rb
+- test/test_tending_report.rb