protest 0.2.2 → 0.2.3

data/README.rdoc

@@ -8,11 +8,11 @@
       end
 
       test "has a name" do
-        assert @user.name == "John Doe"
+        assert_equal "John Doe", @user.name
       end
 
       test "has an email" do
-        assert @user.email == "john@example.org"
+        assert_equal "john@example.org", @user.email
       end
     end
 
@@ -30,23 +30,7 @@ Protest.
 
 Or
 
-    rip install git://github.com/foca/protest.git v0.2.2
-
-== Assertions
-
-You probably wonder why the above example doesn't have any assertion other than
-+assert+. Where's +assert_equal+, right? Well, the idea is to keep it slim. If
-you want to use more assertions, you're free to define your own. You can also
-use all the assertions provided by Test::Unit, by just including them:
-
-    require "test/unit/assertions"
-
-    class Protest::TestCase
-      include Test::Unit::Assertions
-    end
-
-You could also define rspec-like matchers if you like that. See +matchers.rb+ in
-the examples directory for an example.
+    rip install git://github.com/foca/protest.git v0.2.3
 
 == Setup and teardown
 
@@ -131,16 +115,42 @@ Or you can call the +pending+ method from inside your test.
       end
     end
 
+== Custom assertions
+
+By default Protest bundles all the assertions defined in Test::Unit (it
+literally requires them), so check its documentation for all the goodness.
+
+If you want to add assertions, just define methods that rely on +assert+ or
++assert_block+. The former takes a boolean and an optional error message as
+arguments, while the latter takes an optional error message as an argument and
+a block. The assertions is considered to fail if the block evaluates to neither
++false+ nor +nil+.
+
+For example:
+
+    module AwesomenessAssertions
+      def assert_awesomeness(object)
+        assert object.awesome?, "#{object.inspect} is not awesome enough"
+      end
+    end
+
+    class Protest::TestCase
+      include AwesomenessAssertions
+    end
+
+You could also define rspec-like matchers if you like that style. See
+<tt>matchers.rb</tt> in the examples directory for an example.
+
 == Reports
 
 Protest can report the output of a test suite in many ways. The library ships
-with a +:progress+ report, and a +:documentation+ report, +:progress+ being the
-default.
+with a <tt>:progress</tt> report, and a <tt>:documentation</tt> report,
+<tt>:progress</tt> being the default.
 
 === Progress report
 
-Use this report by calling <tt>Protest.report_with(:progress)</tt> (this isn't
-needed though, since this is the default report.)
+This is the default option, but you can force this by calling 
+<tt>Protest.report_with(:progress)</tt>.
 
 The progress report will output the "classic" Test::Unit output of periods for
 passing tests, "F" for failing assertions, "E" for unrescued exceptions, and 
@@ -163,7 +173,7 @@ in that context, one per line. For example:
       end
     end
 
-Will output, when run with the +:documentation+ report:
+Will output, when run with the <tt>:documentation</tt> report:
 
     A user
     - has a name (Not Yet Implemented)

data/lib/protest.rb

@@ -1,4 +1,6 @@
 module Protest
+  VERSION = "0.2.3"
+
   # Exception raised when an assertion fails. See TestCase#assert
   class AssertionFailed < StandardError; end
 
@@ -63,6 +65,17 @@ module Protest
     available_reports.fetch(name).new(*report_args)
   end
 
+  # Set what object will filter the backtrace. It must respond to
+  # +filter_backtrace+, taking a backtrace array and a prefix path.
+  def self.backtrace_filter=(filter)
+    @backtrace_filter = filter
+  end
+
+  # The object that filters the backtrace
+  def self.backtrace_filter
+    @backtrace_filter
+  end
+
   def self.available_test_cases
     @test_cases ||= []
   end
@@ -88,6 +101,7 @@ require "protest/reports/documentation"
 
 Protest.autorun = true
 Protest.report_with(:progress)
+Protest.backtrace_filter = Protest::Utils::BacktraceFilter.new
 
 at_exit do
   Protest.run_all_tests! if Protest.autorun?

data/lib/protest/rails.rb

@@ -1,10 +1,26 @@
 require "protest"
 require "test/unit/assertions"
 require "action_controller/test_case"
-require "webrat"
+
+begin
+  require "webrat"
+rescue LoadError
+  $no_webrat = true
+end
 
 module Protest
   module Rails
+    # Exclude rails' files from the errors
+    class BacktraceFilter < Utils::BacktraceFilter
+      include ::Rails::BacktraceFilterForTestUnit
+
+      def filter_backtrace(backtrace, prefix=nil)
+        super(backtrace, prefix).reject do |line|
+          line.starts_with?("/")
+        end
+      end
+    end
+
     # Wrap all tests in a database transaction.
     #
     # TODO: make this optional somehow (yet enabled by default) so users of
@@ -38,7 +54,7 @@ module Protest
     # should use webrat for integration tests. Really.
     class IntegrationTest < RequestTest
       include ActionController::Integration::Runner
-      include Webrat::Methods
+      include Webrat::Methods unless $no_webrat
     end
   end
 
@@ -59,4 +75,6 @@ module Protest
   class << self
     alias_method :describe, :context
   end
+
+  self.backtrace_filter = Rails::BacktraceFilter.new
 end

data/lib/protest/test_case.rb

@@ -25,6 +25,12 @@ module Protest
   # your tests by declaring nested contexts inside the class. See
   # TestCase.context.
   class TestCase
+    begin
+      require "test/unit/assertions"
+      include Test::Unit::Assertions
+    rescue LoadError
+    end
+
     # Run all tests in this context. Takes a Report instance in order to
     # provide output.
     def self.run(runner)
@@ -46,7 +52,7 @@ module Protest
     # Add a test to be run in this context. This method is aliased as +it+ and
     # +should+ for your comfort.
     def self.test(name, &block)
-      tests << new(name, &block)
+      tests << new(name, caller.at(0), &block)
     end
 
     # Add a setup block to be run before each test in this context. This method
@@ -140,8 +146,9 @@ module Protest
 
     # Initialize a new instance of a single test. This test can be run in
     # isolation by calling TestCase#run.
-    def initialize(name, &block)
+    def initialize(name, location, &block)
       @test = block
+      @location = location
       @name = name
     end
 
@@ -179,7 +186,7 @@ module Protest
     # Make the test be ignored as pending. You can override the default message
     # that will be sent to the report by passing it as an argument.
     def pending(message="Not Yet Implemented")
-      raise Pending, message
+      raise Pending, message, [@location, *caller].uniq
     end
 
     # Name of the test

data/lib/protest/tests.rb

@@ -39,7 +39,7 @@ module Protest
     # Filtered backtrace of the assertion. See Protest::Utils::BacktraceFilter
     # for details on the filtering.
     def backtrace
-      @backtrace ||= Utils::BacktraceFilter.filter(raw_backtrace)
+      @backtrace ||= Protest.backtrace_filter.filter_backtrace(raw_backtrace)
     end
 
     # Raw backtrace, as provided by the error.

data/lib/protest/utils/backtrace_filter.rb

@@ -1,17 +1,23 @@
 module Protest
   module Utils
     # Small utility object to filter an error's backtrace and remove any mention
-    # of Testicle's own files.
-    module BacktraceFilter
-      # Path to the library's 'lib' dir.
-      BASE_PATH = /^#{Regexp.escape(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__)))))}/
+    # of Protest's own files.
+    class BacktraceFilter
+      ESCAPE_PATHS = [
+        # Path to the library's 'lib' dir.
+        /^#{Regexp.escape(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__)))))}/,
+
+        # Users certainly don't care about what test loader is being used
+        %r[lib/rake/rake_test_loader.rb], %r[bin/testrb]
+      ]
 
       # Filter the backtrace, removing any reference to files located in
       # BASE_PATH.
-      def self.filter(backtrace)
+      def filter_backtrace(backtrace, prefix=nil)
+        paths = ESCAPE_PATHS + [prefix].compact
         backtrace.reject do |line|
           file = line.split(":").first
-          File.expand_path(file) =~ BASE_PATH
+          paths.any? {|path| File.expand_path(file) =~ path }
         end
       end
     end

data/protest.gemspec

@@ -1,11 +1,11 @@
 Gem::Specification.new do |s|
   s.name    = "protest"
-  s.version = "0.2.2"
-  s.date    = "2009-09-17"
+  s.version = "0.2.3"
+  s.date    = "2009-11-14"
 
   s.description = "Protest is a tiny, simple, and easy-to-extend test framework"
   s.summary     = s.description
-  s.homepage    = "http://github.com/foca/protest"
+  s.homepage    = "http://rubyprotest.org"
 
   s.authors = ["Nicolás Sanguinetti"]
   s.email   = "contacto@nicolassanguinetti.info"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: protest
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors: 
 - "Nicol\xC3\xA1s Sanguinetti"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-17 00:00:00 -03:00
+date: 2009-11-14 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -41,7 +41,7 @@ files:
 - lib/protest/reports/documentation.rb
 - lib/protest/rails.rb
 has_rdoc: true
-homepage: http://github.com/foca/protest
+homepage: http://rubyprotest.org
 licenses: []
 
 post_install_message: 
@@ -64,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: protest
-rubygems_version: 1.3.2
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Protest is a tiny, simple, and easy-to-extend test framework