pending 0.1.1

data/History.txt

@@ -0,0 +1,4 @@
+== 1.0.0 / 2008-12-29
+
+* 1 major enhancement
+  * Birthday!

data/Manifest.txt

@@ -0,0 +1,6 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/pending.rb
+test/test_pending.rb

data/README.txt

@@ -0,0 +1,74 @@
+pending
+    by Jeremy McAnally
+    http://jeremymcanally.com
+
+== DESCRIPTION:
+
+pending lets you define a block of test code that is currently "pending" functionality,
+similar to RSpec's pending method.
+
+== FEATURES/PROBLEMS:
+
+* A pending method to let you define pending test code
+
+== SYNOPSIS:
+
+The pending method lets you define a block of test code that is currently "pending"
+functionality.
+
+You can use it two ways.  One is simply put a string as the parameter:
+
+  def test_web_service_integration
+    pending "This is not done yet..."
+  end
+
+This will output a "P" in the test output alerting there is pending functionality.
+
+You can also supply a block of code:
+
+  def test_new_helpers
+    pending "New helpers for database display" do
+      output = render_record(User.first)
+      assert_equal "Jerry User (jerry@users.com)", output
+    end
+  end
+
+If the block doesn't fail, then the test will flunk with output like:
+
+  <New helpers for database display> did not fail.
+
+If the test fails (i.e., the functionality isn't implemented), then it will
+not fail the surrounding test.
+
+== REQUIREMENTS:
+
+* Test::Unit
+
+== INSTALL:
+
+  sudo gem install pending
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 FIXME (different license?)
+
+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,34 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+# Test::Unit::UI::VERBOSE
+test_files_pattern = 'test/**/*_test.rb'
+src_files_pattern = 'src/**/*.rb'
+
+Rake::TestTask.new do |t|
+  src_files = Dir[src_files_pattern]
+  src_files.each { |f| puts f; require f[0...-3] }
+  t.pattern = test_files_pattern
+  t.verbose = false
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "pending"
+    s.version = "0.1.1"
+    s.authors = ["Jeremy McAnally"]
+    s.email = "jeremymcanally@gmail.com"
+    s.summary = %q{pending lets you define a block of test code that is currently "pending" functionality, similar to RSpec's pending method}
+    s.homepage = %q{http://jeremymcanally.com}
+    s.description = %q{pending lets you define a block of test code that is currently "pending" functionality, similar to RSpec's pending method.}
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+
+desc 'Default: run tests.'
+task :default => 'test'

data/lib/pending.rb

@@ -0,0 +1,86 @@
+module Test
+  module Unit
+    class TestCase
+      @@pending_cases = []
+      @@at_exit = false
+      
+      # The pending method lets you define a block of test code that is currently "pending"
+      # functionality.
+      #
+      # You can use it two ways.  One is simply put a string as the parameter:
+      #
+      #   def test_web_service_integration
+      #     pending "This is not done yet..."
+      #   end
+      #
+      # This will output a "P" in the test output alerting there is pending functionality.
+      #
+      # You can also supply a block of code:
+      #
+      #   def test_new_helpers
+      #     pending "New helpers for database display" do
+      #       output = render_record(User.first)
+      #       assert_equal "Jerry User (jerry@users.com)", output
+      #     end
+      #   end
+      #
+      # If the block doesn't fail, then the test will flunk with output like:
+      #
+      #   <New helpers for database display> did not fail.
+      #
+      # If the test fails (i.e., the functionality isn't implemented), then it will
+      # not fail the surrounding test.
+      #
+      def pending(description = "", &block)
+        if block_given?
+          failed = false
+
+          begin
+            block.call
+          rescue
+            failed = true
+          end
+
+          flunk("<#{description}> did not fail.") unless failed 
+        end
+
+        caller[0] =~ (/(.*):(.*):in `(.*)'/)
+        @@pending_cases << "#{$3} at #{$1}, line #{$2}"
+        print "P"
+        
+        @@at_exit ||= begin
+          at_exit do
+            puts "\nPending Cases:"
+            @@pending_cases.each do |test_case|
+              puts test_case
+            end
+          end
+        end
+      end
+      
+      # This method will define a test method using the description as the test name
+      # ("pending function" => "test_pending_function")
+      # 
+      # Instead of doing this:
+      #
+      # def test_function_is_pending
+      #   pending "this test is pending"
+      # end
+      # 
+      # You can just do this:
+      #   
+      # pending "function is pending"
+      # 
+      # This method can be called with a block passed, the same as the instance method
+      # 
+      def self.pending(description, &block)
+        test_name = "test_#{description.gsub(/\s+/,'_')}".to_sym
+        defined = instance_method(test_name) rescue false
+        raise "#{test_name} is already defined in #{self}" if defined
+        define_method(test_name) do
+          pending(description) {self.instance_eval(&block)}
+        end
+      end
+    end
+  end
+end

data/pending.gemspec

@@ -0,0 +1,46 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{pending}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jeremy McAnally"]
+  s.date = %q{2009-11-23}
+  s.description = %q{pending lets you define a block of test code that is currently "pending" functionality, similar to RSpec's pending method.}
+  s.email = %q{jeremymcanally@gmail.com}
+  s.extra_rdoc_files = [
+    "README.txt"
+  ]
+  s.files = [
+    "History.txt",
+     "Manifest.txt",
+     "README.txt",
+     "Rakefile",
+     "lib/pending.rb",
+     "pending.gemspec",
+     "test/test_pending.rb"
+  ]
+  s.homepage = %q{http://jeremymcanally.com}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{pending lets you define a block of test code that is currently "pending" functionality, similar to RSpec's pending method}
+  s.test_files = [
+    "test/test_pending.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/test/test_pending.rb

@@ -0,0 +1,66 @@
+require 'test/unit'
+require File.dirname(__FILE__) + "/../lib/pending.rb"
+
+# Quick and dirty way to test our output
+class StdoutStub
+  attr_accessor :text
+  
+  def write(text)
+    @text = text
+  end
+end
+
+class TestPending < Test::Unit::TestCase
+  def test_output
+    old = $stdout
+    $> = StdoutStub.new
+    pending("poop")
+    
+    assert_equal "P", $>.text
+    $> = $stdout
+  end
+  
+  def test_does_not_require_block
+    assert_nothing_raised do
+      pending("hello there")
+    end
+  end
+  
+  def test_block_allows_fail
+    assert_nothing_raised do
+      pending("this is awesome") do
+        assert false
+      end
+    end
+  end
+  
+  def test_flunk_when_no_flunk
+    assert_raises(Test::Unit::AssertionFailedError) do
+      pending("this is fail") do
+        assert true
+      end
+    end
+  end
+  
+  def test_output_of_flunk_when_no_flunk
+    begin
+      pending("this is fail") do
+        assert true
+      end
+    rescue StandardError => e
+      assert_equal "<this is fail> did not fail.", e.message
+    end
+  end
+  
+  def test_creates_test_method_when_called_on_self
+    TestPending.pending("this test is pending") do
+      assert true
+    end
+    
+    assert TestPending.instance_methods.include?('test_this_test_is_pending')
+    assert_raises(Test::Unit::AssertionFailedError) do
+      send(:test_this_test_is_pending)
+    end
+  end
+
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: pending
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Jeremy McAnally
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-23 00:00:00 -06:00
+default_executable: 
+dependencies: []
+
+description: pending lets you define a block of test code that is currently "pending" functionality, similar to RSpec's pending method.
+email: jeremymcanally@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/pending.rb
+- pending.gemspec
+- test/test_pending.rb
+has_rdoc: true
+homepage: http://jeremymcanally.com
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: pending lets you define a block of test code that is currently "pending" functionality, similar to RSpec's pending method
+test_files: 
+- test/test_pending.rb