ae 1.8.1 → 1.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 23a2b354470346c0cce0e01593887716f750919349cac99c6ec35bdb079a56d7
+  data.tar.gz: '013992a3d412b79836902cf8234c3acb6629cfbcf3654e1da51d51144bc43990'
+SHA512:
+  metadata.gz: ccfba2d7d7d331f1531810b953c9cf38663f81a3dac682179288c09a8472b510de405034d4bd9334a6872f9a46c96b8e8e94c526b7744c1f20b124b98162aa00
+  data.tar.gz: bdfe778a71801e72f005f8f467d3a0cf1f8f0dac106d43fd0c6a146d3ac176d7c6b249dfe3ee437983b733419371d0861e6c6159c2c9e9824600e5bb477ddb36

data/{HISTORY.rdoc → HISTORY.md}

@@ -1,6 +1,36 @@
-= RELEASE HISTORY
+# RELEASE HISTORY
 
-== 1.8.1 / 2011-12-04
+## 1.9.0 / 2026-03-30
+
+Maintenance release. Modernized project tooling and cleaned up documentation.
+
+Changes:
+
+* Replace custom Indexer system with standard gemspec.
+* Replace Travis CI with GitHub Actions.
+* Replace Assembly/detroit with Rakefile.
+* Simplify version.rb to use a plain constant.
+* Update minitest adapter for minitest 5+.
+* Update testunit adapter for modern test-unit gem.
+* Fix typos and update URLs to HTTPS.
+* Add LICENSE.txt.
+* Move site from gh-pages to docs/.
+* Remove obsolete files (var/, etc/, MANIFEST, DEMO.rdoc).
+* Clean up .gitignore.
+
+
+## 1.8.2 / 2013-02-18
+
+This release primarily fixes one bug --the assertions count
+global variable wasn't all caps, which prevented assertions
+from being counted correctly.
+
+Changes:
+
+* Fix $ASSERTION_COUNTS letter case.
+
+
+## 1.8.1 / 2011-12-04
 
 Fixed missing ae/ansi.rb file from distribution.
 
@@ -9,7 +39,7 @@ Changes:
 * Update manifest, missing ae/ansi.rb
 
 
-== 1.8.0 / 2011-12-03 / Checkered Flag
+## 1.8.0 / 2011-12-03 / Checkered Flag
 
 This new release improves support for Proc-based assertions and
 RSpec-style matchers. In addition, this release sees the optional
@@ -24,7 +54,7 @@ Changes:
 * Change licenses to BSD-2-Clause.
 
 
-== 1.7.4 / 2011-06-08
+## 1.7.4 / 2011-06-08
 
 Quick release fixes an issue due to Ruby 1.9+'s constant look-up
 system. Yes, BasicObject has no clue. This is fixed using the
@@ -35,7 +65,7 @@ Changes:
 * Add const_missing hook to Assertor class to redirect to 
   toplevel methods.
 
-== 1.7.3 / 2011-06-06 / D-Day
+## 1.7.3 / 2011-06-06 / D-Day
 
 This release simply adds a new optional help library, `ok.rb`.
 The API is still in it's infancy, so it probably will change
@@ -46,7 +76,7 @@ Changes:
 * Add option `ok` helper library.
 
 
-== 1.7.2 / 2011-06-02
+## 1.7.2 / 2011-06-02
 
 Minor release adds color diffs for failed equality comparisons to
 the error message, and it fixes an issue in which class references
@@ -61,7 +91,7 @@ Changes:
 * Provide ANSI colored diffs for failed equality comparisons.
 
 
-== 1.7.1 / 2011-05-06
+## 1.7.1 / 2011-05-06
 
 This release adds a specialized message for certain comparison
 operators to allow them have a more forensic output. This is done
@@ -74,7 +104,7 @@ Changes:
 * Remove optional dot.rb and detest.rb emulation scripts.
 
 
-== 1.7.0 / 2011-04-28
+## 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
@@ -92,7 +122,7 @@ Changes:
 * AE::Assertion class simplified to a simple subclass of Exception.
 
 
-== 1.6.1 / 2010-11-05
+## 1.6.1 / 2010-11-05
 
 This release has test passing for Ruby 1.9.2. Ruby 1.9.2 doesn't appear
 to like &block and block_given? to be used in same method scope. It
@@ -104,7 +134,7 @@ Changes:
 * Use `&block` and not `block_given?`.
 
 
-== 1.6.0 / 2010-11-04
+## 1.6.0 / 2010-11-04
 
 Support libraries defining toplevel methods, such as `legacy.rb`, now place
 their methods in AE::World module instead of Object. AE::World needs to
@@ -118,7 +148,7 @@ Changes:
 * In dot.rb `#true!`/`#false!` methods can take an error or error message.
 
 
-== 1.5.0 / 2010-09-06
+## 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 nice
@@ -134,7 +164,7 @@ Changes:
 * Move final assertion call to Assertion#test.
 
 
-== 1.4.0 / 2010-09-02
+## 1.4.0 / 2010-09-02
 
 Version 1.4 brings Ruby 1.9 compatibility. The Assertor class is now a
 subclass of BasicObject. This fixes an issues Assertor would had
@@ -148,7 +178,7 @@ Changes:
 * Add #refute= which works like `refute ==`.
 
 
-== 1.3.0 / 2010-06-17
+## 1.3.0 / 2010-06-17
 
 New release of AE adds support for RSpec-style matchers. This means
 it should be usable with Shoulda 3.0 and any other matchers library.
@@ -164,7 +194,7 @@ Changes:
 * #assert method can do equality comparison.
 
 
-== 1.2.3 / 2010-06-07
+## 1.2.3 / 2010-06-07
 
 This release is a quick fix, which adds a missing `require 'yaml'`.
 
@@ -173,7 +203,7 @@ Changes:
 * Add missing require 'yaml'.
 
 
-== 1.2.2 / 2010-06-06
+## 1.2.2 / 2010-06-06
 
 Version 1.2.2 simply add one new feature --the ability to
 use 'object.assert = other' instead of 'object.assert == other'.
@@ -191,7 +221,7 @@ Changes:
 * Now distributed under MIT license.
 
 
-== 1.2.0 / 2010-01-27
+## 1.2.0 / 2010-01-27
 
 This release fixes '=~' assertions and now requires the
 ae/expect library by default.
@@ -202,7 +232,7 @@ Changes:
 * Fixed bug where #=~ did not work correctly against Assertor.
 
 
-== 1.1.0 / 2009-09-06
+## 1.1.0 / 2009-09-06
 
 This release provided two major improvements. The first is
 the #expect method which is similar to #assert, but uses 
@@ -218,7 +248,7 @@ Changes:
 * Added backtrace parameter to flunk calls.
 
 
-== 1.0.0 / 2009-09-03
+## 1.0.0 / 2009-09-03
 
 This is the initial release of AE.
 

data/LICENSE.txt

@@ -0,0 +1,24 @@
+(BSD-2-Clause License)
+
+Copyright (c) 2008 Thomas Sawyer. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+
+   2. Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/{NOTICE.rdoc → NOTICE.md}

@@ -1,6 +1,6 @@
-= COPYRIGHT NOTICES
+# COPYRIGHT NOTICES
 
-== AE
+## AE
 
 Copyright:: (c) 2008 Thomas Sawyer
 License: BSD-2-Clause
@@ -32,7 +32,7 @@ License: BSD-2-Clause
     or implied, of Thoams Sawyer.
 
 
-== BlankSlate
+## BlankSlate
 
 Copyright:: (c) 2004,2006  Jim Weirich 
 License:: Custom

data/{README.rdoc → README.md}

@@ -1,22 +1,21 @@
-= Assertive Expressive
+# Assertive Expressive
 
-{home}[http://rubyworks.github.com/ae] |
-{code}[http://github.com/rubyworks/ae] |
-{docs}[http://rubydoc.info/gems/ae] |
-{wiki}[http://wiki.github.com/rubyworks/ae] |
-{bugs}[http://github.com/rubyworks/ae/issues] |
-{mail}[http://googlegroups.com/group/rubyworks-mailinglist]
+[Website](https://rubyworks.github.io/ae) /
+[API](https://rubydoc.info/gems/ae) /
+[Report Issue](https://github.com/rubyworks/ae/issues) /
+[Source Code](https://github.com/rubyworks/ae)
 
-{<img src="http://travis-ci.org/rubyworks/ae.png" />}[http://travis-ci.org/rubyworks/ae]
+[![Gem Version](https://img.shields.io/gem/v/ae.svg?style=flat)](https://rubygems.org/gems/ae)
+[![Build Status](https://github.com/rubyworks/ae/actions/workflows/test.yml/badge.svg)](https://github.com/rubyworks/ae/actions/workflows/test.yml)
 
 
-== DESCRIPTION
+## About
 
 Assertive Expressive (AE) is an assertions framework
 intended for reuse by any TDD, BDD or similar system.
 
 
-== FEATURES
+## Features
 
 * Clear, simple and concise syntax.
 * Uses higher-order functions and fluid notation.
@@ -24,46 +23,46 @@ intended for reuse by any TDD, BDD or similar system.
 * Core extensions are standardized around Ruby Facets.
 * But Facets is not a dependency; the extensions are built-in.
 * Easily extensible allowing for alternate notations.
-* Eats it's own dog food.
+* Eats its own dog food.
 
 
-== SYNOPSIS
+## Synopsis
 
-AE defines the method +assert+. It's is compatible with the method
+AE defines the method `assert`. It is compatible with the method
 as defined by Test::Unit and MiniTest, which verifies truth of a
 single argument (and can accept an optional failure message).
 
-  assert(true)
+    assert(true)
 
-In addition AE's +assert+ method has been extended to accept a block,
+In addition AE's `assert` method has been extended to accept a block,
 the result of which is likewise verified.
 
-  assert{true}
+    assert{true}
 
 But the real power the AE's +assert+ method lies in it's use
 without argument or block. In that case it returns an instance of
-+Assertor+. An +Assertor+ is an <i>Assertions Functor</i>, or 
-<i>Higher-Order Function</i>. It is a function that operates on
+`Assertor`. An `Assertor` is an *Assertions Functor*, or 
+*Higher-Order Function*. It is a function that operates on
 another function. With it, we can make assertions like so:
 
-  x.assert == y
+    x.assert == y
 
-  a.assert.include? e
+    a.assert.include? e
 
-  StandardError.assert.raised? do
-    ...
-  end
+    StandardError.assert.raised? do
+      ...
+    end
 
 And so forth. Any method can be used in conjunction with +assert+
 to make an assertion. Eg.
 
-  class String
-    def daffy?
-      /daffy/i =~ self
+    class String
+      def daffy?
+        /daffy/i =~ self
+      end
     end
-  end
 
-  "Daffy Duck".assert.daffy?
+    "Daffy Duck".assert.daffy?
 
 When an assertion fails an Assertion exception is raised. Any test
 framework can catch this exception and process it accordingly.
@@ -75,10 +74,10 @@ Assertion class.
 Please have a look at the QED and API documentation to learn more.
 
 
-== INTEGRATION
+## 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
+`require 'ae'` 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.
@@ -86,9 +85,9 @@ 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'
+    require 'ae/adapters/testunit'
+    require 'ae/adapters/minitest'
+    require 'ae/adapters/rspec'
 
 (Note that Cucumber does not need an adapter.)
 
@@ -96,10 +95,10 @@ AE also includes a script that will automatically detect the current
 test framework by checking for the existence of their respective 
 namespace modules.
 
-  require 'ae/adapter'
+    require 'ae/adapter'
 
 
-== NOMENCLATURE
+## Nomenclature
 
 With AE, defining assertions centers around the #assert method. So
 *assert* can be thought of as AE's primary _nomenclature_. However, variant
@@ -107,63 +106,75 @@ nomenclatures have been popularized by other test frameworks, in particular
 *should* and *must*. If you prefer one of them terms, AE provides optional
 libraries that can loaded for utilizing them.
 
-  require 'ae/should'
-  require 'ae/must'
+    require 'ae/should'
+    require 'ae/must'
 
 By loading one of these scripts (or both) into your test system (e.g. via a test
 helper script) you gain access to subjunctive terminology. See the API documentation
 for the Subjunctive module for details.
 
 
-== LEGACY
+## Legacy
 
 To ease transition from TestUnit style assertion methods, AE provides
 a TestUnit legacy module.
 
-  require 'ae/legacy'
+    require 'ae/legacy'
 
 This provides a module `AE::Legacy::Assertions` which is included in AE::World
 and can be mixed into your test environment to provide old-school assertion
 methods, e.g.
 
-  assert_equal(foo, bar, "it failed")
+    assert_equal(foo, bar, "it failed")
 
 
-== INSTALLATION
+## Installation
 
-=== Gem Installs
+### Gem Installs
 
 Install AE in the usual fashion:
 
-  $ gem install ae
+    $ gem install ae
 
-=== Site Installs
+### Site Installs
 
 Local installation requires Setup.rb.
 
-  $ gem install setup
+    $ gem install setup
 
 Then download the tarball package from GitHub
 and do:
 
-  $ tar -xvzf ae-1.0.0.tgz
-  $ cd ae-1.0.0.tgz
-  $ sudo setup.rb all
+    $ tar -xvzf ae-1.0.0.tgz
+    $ cd ae-1.0.0.tgz
+    $ sudo setup.rb all
 
 Windows users use 'ruby setup.rb all'.
 
 
-== COPYRIGHTS & LICENSE
+## Contributing
+
+If you would like to contribute code to the AE project, for the upstream
+repository and create a branch for you changes. When your changes are ready
+for review (and no, they do not have to 100% perfect if you still have some issues
+you need help working out).
+
+It you need to personally discuss some ideas or issue you try to get up with us
+via the mailing list or the IRC channel.
+
+* [Source Code](https://github.com/rubyworks/ae) /
+* [Mailing List](https://groups.google.com/group/rubyworks-mailinglist)
+
 
-(BSD-2-Clause License)
+## Copyrights & License
 
-Copyright (c) 2008,2010 Thomas Sawyer
+Copyright (c) 2008 Rubyworks. All rights reserved.
 
 Unless otherwise provided for by the originating author, this
 program is distributed under the terms of the *BSD-2-Clause* license.
 Portions of this program may be copyrighted by others.
 
-See the NOTICE.rdoc file for details.
+See the NOTICE.md file for details.
 
-AE is a Rubyworks[http://rubyworks.github.com] project.
+AE is a [Rubyworks](https://rubyworks.github.io) project.
 

data/{qed/01_overview.rdoc → demo/01_overview.md}

@@ -1,4 +1,4 @@
-= Introduction
+# Introduction
 
 AE is an assertions framework for Ruby. It's designed
 around the concept of an Assertor. The Assertor is an
@@ -7,11 +7,11 @@ reroutes method calls while monitoring them for failing
 conditions.
 
 
-== What AE Provides
+## What AE Provides
 
 Requiring the AE library.
 
-  require 'ae'
+    require 'ae'
 
 Loads two classes, +Assertion+ and +Assertor+, the Kernel
 method +assert+ and it's antonyms +assert!+ and +refute+
@@ -19,20 +19,20 @@ and a set of core extensions that make writing certain types
 of assertions easier.
 
 
-== Assertion and Assertor Classes
+## Assertion and Assertor Classes
 
 The +Assertion+ class is at the heart of AE. All other AE
 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.
 
-  expect Assertion do
-    msg = "my failure message"
-    assert false, msg
-  end
+    expect Assertion do
+      msg = "my failure message"
+      assert false, msg
+    end
 
 Like any raised exception, the last Assertion message is available
-via <tt>$!</tt>.
+via `$!`.
 
 (FYI, in Test::Unit the equivalent class was called +AssertionFailedError+.)
 
@@ -46,26 +46,26 @@ invocation to monitor for failed conditions, upon which is raises
 Assertion exceptions.
 
 
-== Assertion Methods
+## Assertion Methods
 
 The three methods, +assert+, <tt>assert!</tt> and +refute+ all
 return an Assertor instance when used fluidly, i.e. magic-dot
 notation, higher-order notation, functor notation, whatever you
 prefer to call it.
 
-  assert(AE::Assertor === assert)
+    assert(AE::Assertor === assert)
 
 Through the use of +method_missing+, the Assertor allows us to write
 statements like:
 
-  1.assert == 1
+    1.assert == 1
 
 If the operation evaluates to false or nil, then an Assertion error
 is raised.
 
-  expect Assertion do
-    1.assert == 2
-  end
+    expect Assertion do
+      1.assert == 2
+    end
 
 The methods <tt>assert!</tt> and +refute+ are just like +assert+
 expect they purport the negative condition. Patterned after Ruby's
@@ -74,7 +74,7 @@ read "assert not". While +refute+ exists for the sake of those who
 find the use of a bang method for this purpose unsuited to them.
 
 
-== How It Works
+## How It Works
 
 An Assertor essentially sits in wait for a method call (via
 method_missing). When that happens it applies the method to the
@@ -82,11 +82,11 @@ original receiver, but wrapped in a clause that raises an
 Assertion should the statement fail. If we wanted to be 
 pedantic, we could write our assertions like:
 
-  raise Assertion.new("1 != 1") unless 1 == 1
+    raise Assertion.new("1 != 1") unless 1 == 1
 
 Instead of 
 
-  1.assert == 1
+    1.assert == 1
 
 Obviously using Assertor methods are whole lot more concise.
 

data/{qed/02_assertion.rdoc → demo/02_assertion.md}

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