ae 1.4.0 → 1.5.0

data/HISTORY.rdoc

@@ -1,5 +1,21 @@
 = RELEASE HISTORY
 
+== 1.5.0 / 2010-09-06
+
+This release adds adapters for TestUnit, MiniTest and RSpec. AE worked with
+them previously but AE assertions were seen as errors rather than natice
+assertions. Likewise assertion counts were off in the final tally. These
+adapters insert AE's counts so the the tally's are correct.
+
+In addition to this the Assertion class itself now acts as the final end
+point for all assertions, which makes for a very clean interface.
+
+Changes:
+
+* Add adapters for TestUnit, MiniTest and RSpec.
+* Move final assertion call to Assertion#test.
+
+
 == 1.4.0 / 2010-09-02
 
 Version 1.4 brings Ruby 1.9 compatibility. The Assertor class is now a

data/LICENSE

@@ -1,23 +1,204 @@
-The MIT License
-
-Copyright (c) 2008 Thomas Sawyer
-
-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.
+.
+                             Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.
 
 

data/README.rdoc

@@ -15,7 +15,7 @@ intended for reuse by any TDD, BDD or similar system.
 * Uses higher-order functions and fluid notation.
 * Reusable core extensions ease assertion construction.
 * Core extensions are standardized around Ruby Facets.
-* Facets is an optional dependency; extensions are built-in.
+* But Facets is not a dependency; the extensions are built-in.
 * Easily extensible allowing for alternate notations.
 * Eats it's own dog food.
 
@@ -98,10 +98,9 @@ Windows users use 'ruby setup.rb all'.
 
 == COPYRIGHTS & LICENSE
 
-Copyright (c) 2008 Thomas Sawyer
+Copyright (c) 2008,2010 Thomas Sawyer
 
 Unless otherwise provided for by the originating author, this
-program is distributed under the terms of the MIT license.
+program is distributed under the terms of the Apache 2 license.
 
 See LICENSE file for details.
-

data/demo/minitest/example.rb

@@ -0,0 +1,34 @@
+require 'minitest/autorun'
+require 'ae/adapters/minitest'
+
+class MiniTestSupport < MiniTest::Unit::TestCase
+
+  def test_assert_pass
+    x = 5
+    y = 5
+    x.assert == y
+  end
+
+  def test_assert_fail
+    x = 5
+    y = 6
+    x.assert == y
+  end
+
+  def test_assert_fail_original
+    x = 5
+    y = 6
+    assert_equal(x, y)
+  end
+
+  def test_assert_pass_original
+    x = 5
+    y = 5
+    assert_equal(x, y)
+  end
+
+  def test_exception
+    raise
+  end
+
+end

data/demo/testunit/example.rb

@@ -0,0 +1,34 @@
+require 'test/unit'
+require 'ae/adapters/testunit'
+
+class TestUnitSupport < Test::Unit::TestCase
+
+  def test_assert_pass
+    x = 5
+    y = 5
+    x.assert == y
+  end
+
+  def test_assert_fail
+    x = 5
+    y = 6
+    x.assert == y
+  end
+
+  def test_assert_fail_original
+    x = 5
+    y = 6
+    assert_equal(x, y)
+  end
+
+  def test_assert_pass_original
+    x = 5
+    y = 5
+    assert_equal(x, y)
+  end
+
+  def test_exception
+    raise
+  end
+
+end

data/lib/ae.rb

@@ -1,21 +1,29 @@
-require 'yaml'
+Object.__send__(:remove_const, :VERSION) if Object.const_defined?(:VERSION)      # becuase Ruby 1.8~ gets in the way
 
 module AE
-  DIRECTORY = File.dirname(__FILE__) + '/ae'
+  DIRECTORY = File.dirname(__FILE__)
 
-  PROFILE = YAML.load(File.new(DIRECTORY + '/meta/profile')) rescue {}
-  PACKAGE = YAML.load(File.new(DIRECTORY + '/meta/package')) rescue {}
+  def self.package
+    @package ||= (
+      require 'yaml'
+      YAML.load(File.new(DIRECTORY + '/package'))
+    )
+  end
 
-  VERSION = PACKAGE['version']
+  def self.profile
+    @profile ||= (
+      require 'yaml'
+      YAML.load(File.new(DIRECTORY + '/profile'))
+    )
+  end
 
-  #
   def self.const_missing(name)
     key = name.to_s.downcase
-    PACAKGE[key] || PROFILE[key] || super(name)
+    package[key] || profile[key] || super(name)
   end
 end
 
 require 'ae/assert'
 require 'ae/expect'
 
-# Copyright (c) 2008 Thomas Sawyer
+# Copyright (c) 2008, 2010 Thomas Sawyer

data/lib/ae/adapter.rb

@@ -0,0 +1,7 @@
+if defined?(::Test::Unit)
+  require 'ae/adapters/testunit'
+elsif defined?(::MiniTest)
+  require 'ae/adapters/minitest'
+elsif defined?(::Spec)
+  require 'ae/adapters/rspec'
+end

data/lib/ae/adapters/minitest.rb

@@ -0,0 +1,24 @@
+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]
+    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

@@ -0,0 +1,14 @@
+require 'ae'
+
+class Assertion
+
+  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

@@ -0,0 +1,33 @@
+module Test #:nodoc:
+  module Unit #:nodoc:
+    class TestCase #:nodoc:
+      alias_method :_run, :run
+      def run(result, &block)
+        $_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
+  end
+
+end

data/lib/ae/assertion.rb

@@ -11,25 +11,65 @@ require 'ae/core_ext'
 #
 class Assertion < Exception
 
-  def self.recount
-    $assertions = 0
-    $failures   = 0
-  end
+  @count = 0
+  @fails = 0
+
+  class << self
+    attr_accessor :count
+    attr_accessor :fails
+
+    #
+    def test(test, options={})
+      if test
+        increment(true)
+      else
+        framework_flunk(options)
+      end
+      test
+    end
+
+    #
+    #def self.framework_assert(options={})
+    #end
 
-  def self.count ; $assertions ; end
-  def self.fails ; $failures   ; end
+    # This method can be replaced to support alternate frameworks.
+    # The intent of the methods is to raise the assertion failure
+    # class used.
+    def framework_flunk(options={})
+      message = options.delete(:message)
+      fail ::Assertion.new(message, options)
+    end
+
+    # Increment assertion counts. If +pass+ is true then only +@count+
+    # is increased. If +pass+ if false then both +@count+ and +@fails+
+    # are incremented.
+    def increment(pass)
+      @count += 1
+      @fails += 1 unless pass
+    end
+
+    # Reset counts.
+    def recount
+      f, c = @fails, @count
+      @count = 0
+      @fails = 0
+      return f, c
+    end
+  end
 
   #
-  def initialize(message=nil, opts={})
-    backtrace = opts[:backtrace]
+  def initialize(message=nil, options={})
     super(message)
+    backtrace = options[:backtrace]
     set_backtrace(backtrace) if backtrace
+    self.class.increment(false)
   end
 
+  #
   def to_s
     'fail ' + super
   end
 
 end
 
-# Copyright (c) 2008,2009 Thomas Sawyer
+# Copyright (c) 2008, 2010 Thomas Sawyer

data/lib/ae/assertor.rb

@@ -13,9 +13,6 @@ require 'ae/basic_object'
 #
 class Assertor < AE::BasicObject
 
-  $assertions = 0
-  $failures   = 0
-
   #
   #instance_methods.each{ |m| protected m unless /^(__|object_id$)/ =~ m.to_s }
 
@@ -87,18 +84,16 @@ class Assertor < AE::BasicObject
   #--
   # TODO: Should we deprecate the receiver matches in favor of #expected ?
   # In other words, should the <code>|| @delegate</code> be dropped?
-  #
-  # TODO: respond_to?(:exception) && match = exception if Exception === match
   #++
   def expect(*args, &block)
     return self if args.empty? && !block_given?  # same as #assert
 
     target = block || args.shift
 
-    if ::Proc === target || target.respond_to?(:to_proc)
-      block = target.to_proc
+    if ::Proc === target #|| target.respond_to?(:to_proc)
+      #block = target.to_proc
       match = args.shift || @delegate
-      if ::Exception === match || (::Class===match && match.ancestors.include?(::Exception))
+      if exception?(match)
         $DEBUG, debug = false, $DEBUG  # b/c it always spits-out a NameError
         begin
           block.arity > 0 ? block.call(@delegate) : block.call
@@ -126,14 +121,21 @@ class Assertor < AE::BasicObject
       msg  = @message || "#{target.inspect} === #{@delegate.inspect}"
     end
 
-    #flunk(msg, caller) unless pass
     __assert__(pass, msg)
   end
 
+  # Is the +object+ and Exception or an instance of one.
+  #--
+  # TODO: Should we use a more libreral determination of exception.
+  # e.g. <code>respond_to?(:exception)</code>.
+  #++
+  def exception?(object)
+    ::Exception === object or ::Class === object and object.ancestors.include?(::Exception)
+  end
+
   #
-  def flunk(msg=nil)
-    $failures += 1
-    fail ::Assertion.new(msg || @message, :backtrace=>@backtrace)
+  def flunk(message=nil)
+    __assert__(false, message || @message)
   end
 
   # Ruby seems to have a quark in it's implementation whereby
@@ -156,12 +158,6 @@ class Assertor < AE::BasicObject
     pass = @delegate.__send__(sym, *a, &b)
     #pass = @delegate.public_send(sym, *a, &b)
     __assert__(pass, @message || __msg__(sym, *a, &b))
-    #Assertor.count += 1
-    #if (@negated ? pass : !pass)
-    #unless @negated ^ pass
-    #  msg = @message || __msg__(sym, *a, &b)
-    #  flunk(msg) #fail Assertion.new(msg, :backtrace=>@backtrace)
-    #end
   end
 
   # Puts together a suitable error message.
@@ -177,14 +173,22 @@ class Assertor < AE::BasicObject
   end
 
   # Pure old simple assert.
-  def __assert__(pass, msg=nil)
-    $assertions += 1
-    unless @negated ^ pass
-      flunk(msg || @message) #raise Assertion.new(msg, :backtrace=>@backtrace)
-    end
-    @negated ? !pass : !!pass
+  #--
+  # TODO: Can the handling of the message be simplified/improved?
+  #++
+  def __assert__(pass, message=nil)
+    pass = @negated ^ pass
+    # msg = message || @message
+    ::Assertion.test(pass, :message=>message, :backtrace=>@backtrace)
+    return pass
   end
 
+  # This method can be replaced to support alternate frameworks.
+  # The idea is to use to record that an assertion took place. 
+  # def framework_assert(pass, message)
+  #   # by default nothing needed
+  # end
+
   #
   def matcher_message(matcher)
     if @negated
@@ -210,7 +214,7 @@ end
 
 # DO WE MAKE THESE EXCEPTIONS?
 #class BasicObject
-#  def assert ;
+#  def assert
 #  end
 #end
 

data/lib/ae/basic_object.rb

@@ -21,7 +21,7 @@ else
     # BlankSlate is useful as a base class when writing classes that
     # depend upon <tt>method_missing</tt> (e.g. dynamic proxies).
     #
-    class BasicObject
+    class BasicObject #:nodoc:
 
       # Hide the method named +name+ in the BlankSlate class.  Don't
       # hide +instance_eval+ or any method beginning with "__".
@@ -101,7 +101,7 @@ else
   # "feature" of Ruby prevents late includes into modules from being
   # exposed in the first place.
   #
-  class Module
+  class Module #:nodoc:
     alias basic_object_original_append_features append_features
     def append_features(mod)
       result = basic_object_original_append_features(mod)

data/lib/ae/meta/package

@@ -1,6 +1,6 @@
 name    : ae
-date    : 2010-06-17
-version : 1.4.0
+date    : 2010-09-06
+version : 1.5.0
 
 requires:
   - syckle (build)

data/lib/ae/must.rb

@@ -1 +1,48 @@
-require 'ae/subjunctive/must'
+require 'ae/subjunctive'
+
+module AE
+
+  # = Must
+  #
+  #   "It is not enough to succeed. Others must fail."
+  #                           --Gore Vidal (1925 - )
+  #
+  # THIS IS AN OPTIONAL LIBRARY.
+  #
+  module Must
+    # The #must method is functionaly the same as #should.
+    #
+    #   4.must == 3  #=> Assertion Error
+    #
+    #   4.must do
+    #     self == 4
+    #   end
+    #
+    def must(*args, &block)
+      Assertor.new(self, :backtrace=>caller).be(*args, &block)
+    end
+
+    # Designate a negated expectation via a *functor*.
+    # Read this as "must not".
+    #
+    #   4.must! == 4  #=> Assertion Error
+    #
+    def must!(*args, &block)
+      Assertor.new(self, :backtrace=>caller).not.be(*args, &block)
+    end
+
+    # Perhaps not literally the counter-term to *must* (rather *will*),
+    # it is close enough for our purposes and conveys the appropriate semantics.
+    alias_method :wont, :must!
+
+    # Alias for #must! method.
+    #alias_method :musnt   , :must!
+  end
+
+end
+
+class ::Object #:nodoc:
+  include AE::Must
+end
+
+# Copyright (c) 2008,2009 Thomas Sawyer

data/lib/ae/pry.rb

@@ -21,7 +21,7 @@ module Kernel
   end
 
   # Pry Functor
-  class Pry < BasicObject
+  class Pry < AE::BasicObject
     #instance_methods.each{ |m| private m unless m.to_s =~ /^__/ }
     def initialize(&function)
       @function = function

data/lib/ae/should.rb

@@ -1 +1,49 @@
-require 'ae/subjunctive/should'
+require 'ae/subjunctive'
+
+module AE
+
+  # = Should
+  #
+  #  "Always and never are two words you should always
+  #   remember never to use."
+  #                              --Wendell Johnson
+  #
+  # THIS IS AN OPTIONAL LIBRARY.
+  #
+  module Should
+    # Make an assertion in subjunctive tense.
+    #
+    #   4.should == 3  #=> Assertion Error
+    #
+    #   4.should do
+    #     self == 4
+    #   end
+    #
+    def should(*args, &block)
+      Assertor.new(self, :backtrace=>caller).be(*args, &block)
+    end
+
+    # Designate a negated expectation via a *functor*.
+    # Read this as "should not".
+    #
+    #   4.should! == 4  #=> Assertion Error
+    #
+    def should!(*args, &block)
+      Assertor.new(self, :backtrace=>caller).not.be(*args, &block)
+    end
+
+    # Not quite the literally the counter-term to *should* (rather *shall*), but
+    # it is close enough for our purposes and conveys the appropriate semantics.
+    #alias_method :shant, :should!
+
+    # Alias for #should! method.
+    alias_method :shouldnt, :should!
+  end
+
+end
+
+class ::Object #:nodoc:
+  include AE::Should
+end
+
+# Copyright (c) 2008,2009 Thomas Sawyer

data/qed/01_overview.rdoc

@@ -7,14 +7,14 @@ reroutes method calls while monitoring them for failing
 conditions.
 
 
-== What's Provided
+== What AE Provides
 
 Requiring the AE library.
 
   require 'ae'
 
 Loads two classes, +Assertion+ and +Assertor+, the Kernel
-method +assert+ and it's ancillaries <tt>assert!</tt> and +refute+
+method +assert+ and it's antonyms +assert!+ and +refute+
 and a set of core extensions that make writing certain types
 of assertions easier.
 
@@ -26,7 +26,7 @@ methods depend on it. The +Assertion+ class is a subclass
 of Exception. When an assertion is made and fails, it is
 an instance of Assertion that is raised.
 
-  Assertion.assert.raised? do
+  expect Assertion do
     msg = "my failure message"
     assert false, msg
   end
@@ -63,7 +63,7 @@ statements like:
 If the operation evaluates to false or nil, then an Assertion error
 is raised.
 
-  Assertion.assert.raised? do
+  expect Assertion do
     1.assert == 2
   end
 

data/qed/02_assertion.rdoc

@@ -1 +1,4 @@
+= Assertion Class
 
+The Assertion class is a subclass of Exception and is the error raised when
+and assertion fails.

data/qed/03_assert.rdoc

@@ -11,7 +11,7 @@ the assertion fail.
 
   assert(true, "Not true!")
 
-  Assertion.assert.raised? do
+  expect Assertion do
     assert(false, "Not true!")
   end
 
@@ -271,20 +271,22 @@ can be used in conjunction with +assert+.
 
   x = X.new(4)
 
-  x.assert.instance_eval do
-    4 == @a
+  x.instance_eval do
+    @a.assert == 4
   end
 
-And should it fail
+However #instance_eval is a reserved method for the underlying Assertor class,
+so it cannot be used on #assert, e.g.
 
-  Assertion.assert.raised? do
-    x.assert.instance_eval do
-      5 == @a
-    end
+  x.assert.instance_eval do
+    @a == "obvisouly wrong"
   end
 
+AE offers an optional helper method for times when testing underlying private
+or protected methods is important, called #pry. See the QED on pry for more
+information.
+
 For some testing underlying implementation might be considered poor
 form. You will get no argument here. It should be used thoughtfully,
 but I would not bet against there being occasions when such validations
-might be handy.
-
+might be needed.

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ae
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 3
   prerelease: false
   segments: 
   - 1
-  - 4
+  - 5
   - 0
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors: 
 - Thomas Sawyer
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-02 00:00:00 -04:00
+date: 2010-09-06 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -55,16 +55,21 @@ extensions: []
 extra_rdoc_files: 
 - README.rdoc
 files: 
-- expo/cucumber/features/cucumber.feature
-- expo/cucumber/features/step_definitions/cucumber_steps.rb
-- expo/cucumber/features/support/env.rb
+- demo/cucumber/features/cucumber.feature
+- demo/cucumber/features/step_definitions/cucumber_steps.rb
+- demo/cucumber/features/support/env.rb
+- demo/minitest/example.rb
+- demo/testunit/example.rb
 - qed/01_overview.rdoc
 - qed/02_assertion.rdoc
 - qed/03_assert.rdoc
 - qed/04_subjunctive.rdoc
 - qed/05_expect.rdoc
-- qed/06_counts.rdoc
 - qed/07_matchers.rdoc
+- lib/ae/adapter.rb
+- lib/ae/adapters/minitest.rb
+- lib/ae/adapters/rspec.rb
+- lib/ae/adapters/testunit.rb
 - lib/ae/assert.rb
 - lib/ae/assertion.rb
 - lib/ae/assertor.rb
@@ -79,8 +84,6 @@ files:
 - lib/ae/must.rb
 - lib/ae/pry.rb
 - lib/ae/should.rb
-- lib/ae/subjunctive/must.rb
-- lib/ae/subjunctive/should.rb
 - lib/ae/subjunctive.rb
 - lib/ae.rb
 - HISTORY.rdoc
@@ -124,5 +127,6 @@ rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Assertive Expressive
-test_files: []
-
+test_files: 
+- lib/ae/adapters/minitest.rb
+- lib/ae/adapters/testunit.rb

data/lib/ae/subjunctive/must.rb

@@ -1,48 +0,0 @@
-require 'ae/subjunctive'
-
-module AE
-
-  # = Must
-  #
-  #   "It is not enough to succeed. Others must fail."
-  #                           --Gore Vidal (1925 - )
-  #
-  # THIS IS AN OPTIONAL LIBRARY.
-  #
-  module Must
-    # The #must method is functionaly the same as #should.
-    #
-    #   4.must == 3  #=> Assertion Error
-    #
-    #   4.must do
-    #     self == 4
-    #   end
-    #
-    def must(*args, &block)
-      Assertor.new(self, :backtrace=>caller).be(*args, &block)
-    end
-
-    # Designate a negated expectation via a *functor*.
-    # Read this as "must not".
-    #
-    #   4.must! == 4  #=> Assertion Error
-    #
-    def must!(*args, &block)
-      Assertor.new(self, :backtrace=>caller).not.be(*args, &block)
-    end
-
-    # Perhaps not literally the counter-term to *must* (rather *will*),
-    # it is close enough for our purposes and conveys the appropriate semantics.
-    alias_method :wont, :must!
-
-    # Alias for #must! method.
-    #alias_method :musnt   , :must!
-  end
-
-end
-
-class ::Object #:nodoc:
-  include AE::Must
-end
-
-# Copyright (c) 2008,2009 Thomas Sawyer

data/lib/ae/subjunctive/should.rb

@@ -1,49 +0,0 @@
-require 'ae/subjunctive'
-
-module AE
-
-  # = Should
-  #
-  #  "Always and never are two words you should always
-  #   remember never to use."
-  #                              --Wendell Johnson
-  #
-  # THIS IS AN OPTIONAL LIBRARY.
-  #
-  module Should
-    # Make an assertion in subjunctive tense.
-    #
-    #   4.should == 3  #=> Assertion Error
-    #
-    #   4.should do
-    #     self == 4
-    #   end
-    #
-    def should(*args, &block)
-      Assertor.new(self, :backtrace=>caller).be(*args, &block)
-    end
-
-    # Designate a negated expectation via a *functor*.
-    # Read this as "should not".
-    #
-    #   4.should! == 4  #=> Assertion Error
-    #
-    def should!(*args, &block)
-      Assertor.new(self, :backtrace=>caller).not.be(*args, &block)
-    end
-
-    # Not quite the literally the counter-term to *should* (rather *shall*), but
-    # it is close enough for our purposes and conveys the appropriate semantics.
-    #alias_method :shant, :should!
-
-    # Alias for #should! method.
-    alias_method :shouldnt, :should!
-  end
-
-end
-
-class ::Object #:nodoc:
-  include AE::Should
-end
-
-# Copyright (c) 2008,2009 Thomas Sawyer

data/qed/06_counts.rdoc

@@ -1,25 +0,0 @@
-= Assertion Counts
-
-AE tracks the number of assertions made and the number that failed to pass.
-We can reset the count using the +recount+ class method.
-
-  Assertion.recount
-
-For example if we one assertion fails and another fails.
-
-  assert(true)
-  assert(false)
-
-We will see that AE counted two assertions and one failure.
-
-  Assertion.count.assert == 2
-  Assertion.fails.assert == 1
-
-The above calls simply access the actual global variables.
-
-  $assertions.assert == 4
-  $failures.assert == 1
-
-Notice there are now two additional assertions.
-
-