ae 1.7.4 → 1.8.0

data/lib/ae/must.rb

@@ -1,28 +1,31 @@
-require 'ae/subjunctive'
-
 module AE
+  require 'ae/subjunctive'
 
-  # = Must
+  # Must
   #
   #   "It is not enough to succeed. Others must fail."
   #                           --Gore Vidal (1925 - )
   #
-  # THIS IS AN OPTIONAL LIBRARY.
-  #
+  # @note THIS IS AN OPTIONAL LIBRARY.
   module Must
     # The #must method is functionaly the same as #should.
     #
+    # @example
     #   4.must == 3  #=> Assertion Error
     #
+    # @example
     #   4.must do
     #     self == 4
     #   end
     #
+    # @return [Assertor] Assertion functor.
     def must(*args, &block)
       Assertor.new(self, :backtrace=>caller).be(*args, &block)
     end
 
     # Same as 'object.must == other'.
+    #
+    # @return [Assertor] Assertion functor.
     def must=(cmp)
       Assertor.new(self, :backtrace=>caller) == cmp
     end
@@ -30,22 +33,27 @@ module AE
     # Designate a negated expectation via a *functor*.
     # Read this as "must not".
     #
+    # @example
     #   4.must! == 4  #=> Assertion Error
     #
+    # @return [Assertor] Assertion functor.
     def must!(*args, &block)
       Assertor.new(self, :backtrace=>caller).not.be(*args, &block)
     end
 
+    # TODO: Are these negation methods needed now, since Ruby 1.9 allows for
+    # redefining `!` as a method?
+
     # Perhaps not literally the counter-term to *must* (rather *will*),
-    # it is close enough for our purposes and conveys the appropriate
-    # semantics, and I think is more sightly than *mustnt*.
-    #
-    # This method may be deprecated in the future when Ruby 1.9 becomes
-    # mainstream, as it allows for redefining *#!* as a method.
+    # but close enough for our purposes, and conveys the appropriate
+    # semantics.
     alias_method :wont, :must!
 
     # Alias for #must! method.
-    #alias_method :musnt   , :must!
+    alias_method :must_not, :must!
+
+    # Alias for #must! method.
+    alias_method :mustnt, :must!
   end
 
 end
@@ -54,4 +62,4 @@ class ::Object #:nodoc:
   include AE::Must
 end
 
-# Copyright (c) 2008,2009 Thomas Sawyer
+# Copyright (c) 2008 Thomas Sawyer

data/lib/ae/pry.rb

@@ -2,21 +2,22 @@ require 'ae/basic_object'
 
 module Kernel
 
+  # TODO: Is th cache really neccessry?
+
+  #
   $PRY_TABLE = {}
 
-  # Pry allows you to test private and protected methods,
-  # via a public-only interface.
+  # Pry allows you to test private and protected methods
+  # thru a public-only interface.
   #
   # Generally one should avoid testing private and protected
-  # method directly, instead relying on tests of public methods to
+  # methods directly, instead relying on tests of public methods to
   # indirectly test them, because private and protected methods are
-  # considered implementation details. But sometimes is necessary
+  # considered implementation details. But sometimes it is necessary
   # to test them directly, or if you wish to achieve *absolute
-  # coverage*, say in mission critical systems.
+  # coverage*, say in a mission critical system.
   #
-  #--
-  # TODO: Is th cache really neccessry?
-  #++
+  # @return [Pry] pry functor
   def pry
     $PRY_TABLE[self] ||= Pry.new do |op, *a, &b|
       __send__(op, *a, &b)

data/lib/ae/should.rb

@@ -2,14 +2,13 @@ require 'ae/subjunctive'
 
 module AE
 
-  # = Should
+  # Should
   #
-  #  "Always and never are two words you should always
-  #   remember never to use."
+  #   "Always and never are two words you should always
+  #    remember never to use."
   #                              --Wendell Johnson
   #
-  # THIS IS AN OPTIONAL LIBRARY.
-  #
+  # @note THIS IS AN OPTIONAL LIBRARY.
   module Should
     # Make an assertion in subjunctive tense.
     #
@@ -19,11 +18,14 @@ module AE
     #     self == 4
     #   end
     #
+    # @return [Assertor] Assertion functor.
     def should(*args, &block)
       Assertor.new(self, :backtrace=>caller).be(*args, &block)
     end
 
     # Same as 'object.should == other'.
+    #
+    # @return [Assertor] Assertion functor.
     def should=(cmp)
       Assertor.new(self, :backtrace=>caller).assert == cmp
     end
@@ -33,13 +35,16 @@ module AE
     #
     #   4.should! = 4  #=> Assertion Error
     #
+    # @return [Assertor] Assertion functor.
     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!
+    # NOTE: It would be nice if their were a single term that
+    # meant the opposite of should, rather than a two word compound.
+
+    # Alias for #should! method.
+    alias_method :should_not, :should!
 
     # Alias for #should! method.
     alias_method :shouldnt, :should!
@@ -51,4 +56,4 @@ class ::Object #:nodoc:
   include AE::Should
 end
 
-# Copyright (c) 2008,2009 Thomas Sawyer
+# Copyright (c) 2008 Thomas Sawyer, Rubyworks

data/lib/ae/subjunctive.rb

@@ -2,17 +2,16 @@ require 'ae/assertor'
 
 module AE
 
-  # = Subjunctive
+  # Subjunctive
   #
   # Mixin for Assertor that provides additional English-eque verbage
   # such as 'be' and 'an'. This makes it easier to create assertor
   # methods of subjunctive terms like 'should'.
   #
-  # THIS IS AN OPTIONAL LIBRARY.
-  #
+  # @note THIS IS AN OPTIONAL LIBRARY.
   module Subjunctive
 
-    # Like #assert, except if an argument if provided and no block,
+    # Like #assert, except if an argument is provided and no block,
     # uses #equate? to compare the argument to the receiver. This
     # allows for statements of the form:
     #
@@ -38,7 +37,7 @@ module AE
     alias_method :is  , :be
     alias_method :does, :be
 
-    # The indefinite article is like #be, excpet that it compares a lone argument
+    # The indefinite article is like #be, except that it compares a lone argument
     # with #case?, rather than #equate?
     #
     def a(*args, &block)
@@ -63,4 +62,4 @@ class AE::Assertor
   include ::AE::Subjunctive
 end
 
-# Copyright (c) 2008,2009 Thomas Sawyer
+# Copyright (c) 2008 Thomas Sawyer

data/lib/ae/version.rb

@@ -1,5 +1,7 @@
 module AE
+  # Access project metadata.
   #
+  # @return [Hash]
   def self.metadata
     @metadata ||= (
       require 'yaml'
@@ -13,7 +15,7 @@ module AE
     metadata[key] || super(name)
   end
 
-  # becuase Ruby 1.8~ gets in the way :(
+  # Becuase Ruby 1.8~ gets in the way :(
   VERSION = metadata['version']
 end
 

data/qed/03_assert.rdoc

@@ -57,19 +57,25 @@ Another way to get the opposite inference, is to use +not+.
 
   10.assert.not == 9
 
+== Lambda Assertions
 
-== Matchers & Lambda Assertions
-
-Passing a Proc object or an objec that responds to :to_proc, will use it
-as if it were a block of the method. This allows for a simple way to quickly
+Passing  +assert+ a `Proc` object, or any object that responds to `#call`,
+will be used as if it were a block. This allows for a simple way to quickly
 create reusable assertions.
 
   palindrome = lambda{ |word| word == word.reverse }
 
   "abracarba".assert palindrome
 
-Additionally is the object responds to #matches? then the receiver
-will be passed to this method to determine passage.
+The message for a failed assertion will come from calling `#to_s` on the
+object.
+
+== RSpec-style Assertion Matchers
+
+If an object passed to assert responds to `#matches?` then AE will handle
+the object as an RSpec-style mather, the receiver will be passed to the
+`#matches?` method to determine if the assertion passes and RSpec matcher
+message methods will be used if they are defined.
 
   palindrome = Object.new
 

metadata

@@ -1,67 +1,62 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: ae
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 1.8.0
   prerelease: 
-  version: 1.7.4
 platform: ruby
-authors: 
-- Thomas Sawyer
+authors:
+- Trans
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-06-08 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: ansi
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &30373300 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: redline
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *30373300
+- !ruby/object:Gem::Dependency
+  name: detroit
+  requirement: &30372760 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: qed
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *30372760
+- !ruby/object:Gem::Dependency
+  name: qed
+  requirement: &30372260 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-description: Assertive Expressive is an assertions library specifically designed for reuse by other test frameworks.
-email: transfire@gmail.com
+  prerelease: false
+  version_requirements: *30372260
+description: ! "Assertive Expressive is an assertions library specifically designed
+  \nfor reuse by other test frameworks."
+email:
+- transfire@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
+- HISTORY.rdoc
 - README.rdoc
-files: 
+- NOTICE.rdoc
+files:
 - .ruby
-- 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
+- .yardopts
 - lib/ae/adapter.rb
 - lib/ae/adapters/minitest.rb
 - lib/ae/adapters/rspec.rb
@@ -77,46 +72,45 @@ files:
 - lib/ae/expect.rb
 - lib/ae/legacy.rb
 - lib/ae/must.rb
-- lib/ae/ok.rb
 - lib/ae/pry.rb
 - lib/ae/should.rb
 - lib/ae/subjunctive.rb
 - lib/ae/version.rb
 - lib/ae.rb
 - lib/ae.yml
+- 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
 - HISTORY.rdoc
-- APACHE2.txt
 - README.rdoc
 - NOTICE.rdoc
 homepage: http://rubyworks.github.com/ae
-licenses: 
-- Apache 2.0
+licenses:
+- BSD-2-Clause
 post_install_message: 
-rdoc_options: 
-- --title
-- AE API
-- --main
-- README.rdoc
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: ae
-rubygems_version: 1.8.2
+rubyforge_project: 
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Assertive Expressive
 test_files: []
-

data/APACHE2.txt

@@ -1,206 +0,0 @@
-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/
-
-   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.
-
-