ae 1.6.1 → 1.7.0

data/.ruby

@@ -0,0 +1,33 @@
+--- 
+spec_version: 1.0.0
+name: ae
+title: AE
+engine_check:
+- ruby 1.8.7 (2010-08-16 patchlevel 302) [x86_64-linux]
+contact: trans <transfire@gmail.com>
+resources: 
+  repo: git://github.com/rubyworks/ae.git
+  code: http://github.com/rubyworks/ae
+  mail: http://groups.google.com/group/rubyworks-mailinglist
+  docs: http://wiki.github.com/rubyworks/ae/docs/qed
+  bugs: http://github.com/rubyworks/ae/issues
+  wiki: http://wiki.github.com/rubyworks/ae
+  home: http://rubyworks.github.com/ae
+requires: 
+- group: 
+  - build
+  name: syckle
+  version: 0+
+- group: 
+  - test
+  name: qed
+  version: 0+
+suite: rubyworks
+manifest: Manifest.txt
+version: 1.7.0
+copyright: Copyright (c) 2008 Thomas Sawyer
+description: Assertive Expressive is an assertions library specifically designed for reuse by other test frameworks.
+authors: 
+- Thomas Sawyer
+summary: Assertive Expressive
+created: 2008-08-17

data/{LICENSE → Apache2.txt}

@@ -1,4 +1,6 @@
-.
+AE is open-source software distributed under the terms of the following license:
+
+
                              Apache License
                         Version 2.0, January 2004
                      http://www.apache.org/licenses/

data/{HISTORY.rdoc → History.rdoc}

@@ -1,5 +1,23 @@
 = RELEASE HISTORY
 
+== 1.7.0 / 2011-04-28
+
+AE now uses proper namespace for all classes. In particular, the `Assertor`
+class has become `AE::Assertor`. Only the `Assertion` class remains outside
+the `AE` namespace, as it is now used to map to the current exception class
+for raising assertions as defined by current test framwework. In addition,
+AE's Kernel extensions, which are used to adapt AE for use with any given
+test framework have been moved to the AE and AE::Assertor classes as
+class methods along with AE's assertion count methods.
+
+Changes:
+
+* All AE classes use proper namespace.
+* Framework methods moved to AE::Assertor class.
+* Assertion count tracking methods moved to AE::Assertor class.
+* AE::Assertion class simplified to a simple sublcass of Exception.
+
+
 == 1.6.1 / 2010-11-05
 
 This release has test passing for Ruby 1.9.2. Ruby 1.9.2 doesn't appear

data/NOTICE.rdoc

@@ -0,0 +1,30 @@
+= COPYRIGHT NOTICES
+
+== AE
+
+Copyright (c) 2008,2011 Thomas Sawyer
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+
+== BlankSlate
+
+AE::BasicObject is based on Jim Weirich's BlankSlate class.
+
+Copyright 2004, 2006 by Jim Weirich (jim@weirichhouse.org).
+All rights reserved.
+
+Permission is granted for use, copying, modification, distribution,
+and distribution of modified versions of this work as long as the
+above copyright notice is included.
+

data/README.rdoc

@@ -1,16 +1,12 @@
 = Assertive Expressive
 
-* home: http://rubyworks.github.com/ae/
-* code: http://github.com/rubyworks/ae/
-
-
 == DESCRIPTION
 
 Assertive Expressive (AE) is an assertions framework
 intended for reuse by any TDD, BDD or similar system.
 
 
-== FEATURES/ISSUES
+== FEATURES
 
 * Clear, simple and concise syntax.
 * Uses higher-order functions and fluid notation.
@@ -21,15 +17,16 @@ intended for reuse by any TDD, BDD or similar system.
 * Eats it's own dog food.
 
 
-== RELEASE NOTES
+== RESOURCES
 
-Please see HISTORY file.
+* home: http://rubyworks.github.com/ae/
+* code: http://github.com/rubyworks/ae/
 
 
 == SYNOPSIS
 
 AE defines the method +assert+. It's is compatible with the method
-as defined by Test::Unit and minitest, which verifies truth of a
+as defined by Test::Unit and MiniTest, which verifies truth of a
 single argument (and can accept an optional failure message).
 
   assert(true)
@@ -64,7 +61,32 @@ to make an assertion. Eg.
 
   "Daffy Duck".assert.daffy?
 
-Please have a look at the QEDocs and RDocs to learn more.
+When an assertion fails an Assertion exception is raised. Any test
+framework can catch this exception and process it accordingly.
+Technically the framework should check to see that the exception
+object responds affirmatively to the #assertion? method. This way any
+type of exception can be used as a means of assertion, not just AE's
+Assertion class.
+
+Please have a look at the QED and API documentation to learn more.
+
+
+== INTEGRATION
+
+Generally speaking, AE can be used with any test framework simply by putting
+<code>require 'ae'</code> in a test helper script. However to fully
+integrate with a test framework and ensure the test framework recognizes
+AE assertions (as more than just exceptions) and to ensure assertion
+counts are correct, a little extra interfacing code may be necessary.
+
+Lucky for you AE has already done the leg work for the most common
+test frameworks:
+
+* require 'ae/adapters/testunit'
+* require 'ae/adapters/minitest'
+* require 'ae/adapters/rspec'
+
+Note that Cucumber does not need an adapter.
 
 
 == HOW TO INSTALL
@@ -99,9 +121,14 @@ Windows users use 'ruby setup.rb all'.
 
 == COPYRIGHTS & LICENSE
 
+(Apache 2.0 License)
+
 Copyright (c) 2008,2010 Thomas Sawyer
 
 Unless otherwise provided for by the originating author, this
-program is distributed under the terms of the Apache 2 license.
+program is distributed under the terms of the Apache 2.0 license.
+See the Apache2.txt for details.
+
+Protions of this program may be copyrighted by others. See the 
+NOTICE.rdoc file for details.
 
-See LICENSE file for details.

data/Syckfile

@@ -0,0 +1,82 @@
+---
+gem:
+  service: Gem
+  active : true
+
+dnote:
+  service  : DNote
+  loadpath : ~
+  labels   : ~
+  output   : ~
+  format   : ~
+  active   : true
+
+stats:
+  service  : Stats
+  title    : ~
+  loadpath : ~
+  exclude  : ~
+  output   : ~
+  active   : true
+
+rdoc:
+  service : rdoc
+  format  : redfish
+  exclude : [Syckfile, Profile, Manifest.txt]
+  output  : site/doc/api
+
+ridoc:
+  service: RIDoc
+  include: ~
+  exclude: ~
+  output : .ri
+  active : true
+
+qedoc:
+  service: custom
+  cycle: main
+  document: |
+    puts `qedoc -o site/doc/qed -t "AE Demonstrandum" qed`
+
+testrb:
+  service  : testrb
+  tests    : ~
+  exclude  : ~
+  loadpath : ~
+  requires : ~
+  live     : false   
+  active   : false
+
+grancher:
+  service: Grancher
+  active: true
+  #sitemap:
+  #  - site
+  #  - [doc/rdoc, rdoc]
+  #  - [doc/qedoc, qedoc]
+
+gemcutter:
+  active: true
+
+email:
+  service : Email
+  file    : ~
+  subject : ~
+  mailto  : ruby-talk@ruby-lang.org
+#  from    : transfire@gmail.com
+#  server  : <%= ENV['EMAIL_SERVER'] %>
+#  port    : <%= ENV['EMAIL_PORT'] %>
+#  account : <%= ENV['EMAIL_ACCOUNT'] %>
+#  domain  : <%= ENV['EMAIL_DOMAIN'] %>
+#  login   : <%= ENV['EMAIL_LOGIN'] %>
+#  secure  : <%= ENV['EMAIL_SECURE'] %>
+  active  : true
+
+vclog:
+  service  : VClog
+  format   : html   # xml, txt
+  layout   : rel    # gnu
+  typed    : false
+  output   : ~
+  active   : false
+

data/lib/ae.rb

@@ -1,29 +1,32 @@
-Object.__send__(:remove_const, :VERSION) if Object.const_defined?(:VERSION)      # becuase Ruby 1.8~ gets in the way
+# Copyright (c) 2008,2011 Thomas Sawyer
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
 
+# AE's namespace.
 module AE
-  DIRECTORY = File.dirname(__FILE__)
 
-  def self.package
-    @package ||= (
-      require 'yaml'
-      YAML.load(File.new(DIRECTORY + '/package'))
-    )
+  # Set Assertion class. This is a convenience method
+  # for framework adapters, used to set the exception class
+  # that a framework uses to raise an assertion error.
+  def self.assertion_error=(exception_class)
+    verbose, $VERBOSE = $VERBOSE, nil
+    Object.const_set(:Assertion, exception_class)
+    $VERBOSE = verbose
   end
 
-  def self.profile
-    @profile ||= (
-      require 'yaml'
-      YAML.load(File.new(DIRECTORY + '/profile'))
-    )
-  end
-
-  def self.const_missing(name)
-    key = name.to_s.downcase
-    package[key] || profile[key] || super(name)
-  end
 end
 
+require 'ae/version'
 require 'ae/assert'
 require 'ae/expect'
 
-# Copyright (c) 2008, 2010 Thomas Sawyer

data/lib/ae.yml

@@ -0,0 +1,33 @@
+--- 
+spec_version: 1.0.0
+name: ae
+title: AE
+engine_check:
+- ruby 1.8.7 (2010-08-16 patchlevel 302) [x86_64-linux]
+contact: trans <transfire@gmail.com>
+resources: 
+  repo: git://github.com/rubyworks/ae.git
+  code: http://github.com/rubyworks/ae
+  mail: http://groups.google.com/group/rubyworks-mailinglist
+  docs: http://wiki.github.com/rubyworks/ae/docs/qed
+  bugs: http://github.com/rubyworks/ae/issues
+  wiki: http://wiki.github.com/rubyworks/ae
+  home: http://rubyworks.github.com/ae
+requires: 
+- group: 
+  - build
+  name: syckle
+  version: 0+
+- group: 
+  - test
+  name: qed
+  version: 0+
+suite: rubyworks
+manifest: Manifest.txt
+version: 1.7.0
+copyright: Copyright (c) 2008 Thomas Sawyer
+description: Assertive Expressive is an assertions library specifically designed for reuse by other test frameworks.
+authors: 
+- Thomas Sawyer
+summary: Assertive Expressive
+created: 2008-08-17

data/lib/ae/adapters/minitest.rb

@@ -1,24 +1,17 @@
+require 'ae'
+
+AE.assertion_error = ::MiniTest::Assertion
+
+# MiniTest tracks assertion counts internally in it's Unit class via the 
+# +assertion_count+ attribute. To work with AE we need add in AE's assertion
+# total by overriding the +assertion_count+ method.
+
 module MiniTest #:nodoc:
   class Unit #:nodoc:
-    def status io = @@out
-      ae_count = ::Assertion.count
-      format = "%d tests, %d assertions, %d failures, %d errors, %d skips"
-      io.puts format % [test_count, assertion_count + ae_count, failures, errors, skips]
+    def assertion_count
+      @assertion_count + AE::Assertor.counts[:total]
     end
   end
 end
 
-require 'ae'
-
-class Assertion #:nodoc:
-
-  def self.framework_flunk(options)
-    message   = options.delete(:message)
-    backtrace = options.delete(:backtrace)
 
-    err = MiniTest::Assertion.new(message)
-    err.set_backtrace(backtrace) if backtrace
-    fail err
-  end
-
-end

data/lib/ae/adapters/rspec.rb

@@ -1,14 +1,4 @@
 require 'ae'
 
-class Assertion
+AE.assertion_error = ::RSpec::Expectations::ExpectationNotMetError
 
-  def self.framework_flunk(options)
-    message   = options.delete(:message)
-    backtrace = options.delete(:backtrace)
-
-    err = Spec::Expectations::ExpectationNotMetError.new(message)
-    err.set_backtrace(options[:backtrace]) if options[:backtrace]
-    fail err
-  end
-
-end

data/lib/ae/adapters/testunit.rb

@@ -1,33 +1,34 @@
+require 'ae'
+
+AE.assertion_error = ::Test::Unit::AssertionFailedError
+
+# TestUnit uses #add_assertion on it's +result+ object to track counts.
+# We capture the result object by overriding the TestCase#run method,
+# store it in a global variable and then use it when AE increments
+# assertion counts.
+
 module Test #:nodoc:
   module Unit #:nodoc:
     class TestCase #:nodoc:
       alias_method :_run, :run
       def run(result, &block)
-        $_result = result
+        $_test_unit_result = result
         _run(result, &block)
       end
     end
   end
 end
 
-require 'ae'
-
-class Assertion #:nodoc:
-
-  def self.increment(pass)
-    @count += 1
-    @fails += 1 unless pass
-
-    $_result.add_assertion if $_result
-  end
-
-  def self.framework_flunk(options)
-    message   = options.delete(:message)
-    backtrace = options.delete(:backtrace)
-
-    err = Test::Unit::AssertionFailedError.new(message)
-    err.set_backtrace(backtrace) if backtrace
-    fail err
+class AE::Assertor #:nodoc:
+  def self.increment_counts(pass)
+    $_test_unit_result.add_assertion if $_test_unit_result
+    counts[:total] += 1
+    if pass
+      counts[:pass] += 1
+    else
+      counts[:fail] += 1
+    end
+    return counts
   end
-
 end
+