assay 0.4.0 → 0.4.1

data/.ruby

@@ -28,9 +28,10 @@ repositories:
   scm: git
   name: upstream
 resources:
-  home: http://rubydoc.info/gems/assay
-  docs: http://rubydoc.info/gems/assay
+  home: http://rubyworks.github.com/assay
+  docs: http://rubydoc.info/gems/assay/frames
   code: http://github.com/rubyworks/assay
+  bugs: http://github.com/rubyworks/assay/issues
   mail: http://groups.google.com/groups/rubyworks-mailinglist
 extra: {}
 load_path:
@@ -39,11 +40,12 @@ revision: 0
 created: '2009-08-21'
 summary: Class-based Assertions Framework
 title: Assay
-version: 0.4.0
+version: 0.4.1
 name: assay
-description: ! 'The Assay project defines Assertions in the same way that Ruby defines
-  Exceptions.
+description: ! 'Assay defines assertions in the same way that Ruby defines exceptions.
 
-  An asserition then simply becomes an extension to an Exception class.'
+  Each type of asserition, called an assay, is then a child of the base
+
+  Assertion class, which itself is a subclass of the Exception class.'
 organization: Rubyworks
-date: '2012-01-25'
+date: '2012-01-27'

data/HISTORY.rdoc

@@ -1,6 +1,17 @@
 = HISTORY
 
-== 0.4.0 | 1012-01-25
+== 0.4.1 | 2012-01-27
+
+This release adds CloseAssay for relative approxmation assertions on values,
+where as the WithinAssay handles absolute difference.
+
+Changes:
+
+* Add CloseAssay for relative approximation.
+* Use past tense for RescueAssay's assertive name, i.e. :rescued.
+
+
+== 0.4.0 | 2012-01-25
 
 Version 0.4 is a very polished partial rewrite of the Assay project.
 This release sheds all ancillary code to separate projects. The 

data/QED.rdoc

@@ -440,6 +440,49 @@ This applies to any type of object that defines `#<=`, not just numbers.
     refute MoreEqualAssay.fail?('b', 'a')
 
 
+## CloseAssay
+
+The `CloseAssay` class defines an assertion for matching that two values
+are within a relative difference.
+
+    assert CloseAssay.pass?(1, 1,   0)
+    assert CloseAssay.pass?(1, 1.1, 0.1)
+
+    refute CloseAssay.pass?(1, 2,   0)
+    refute CloseAssay.pass?(1, 1.2, 0.1)
+
+And conversely,
+
+    assert CloseAssay.fail?(1, 2,   0)
+    assert CloseAssay.fail?(1, 1.2, 0.1)
+
+    refute CloseAssay.fail?(1, 1,   0)
+    refute CloseAssay.fail?(1, 1.1, 0.1)
+
+The object do not have to be numbers necessaity, just so long as they
+are comparable and subtractable.
+
+    time = Time.now
+
+    assert CloseAssay.pass?(time, time+1, 2)
+
+Making assertions,
+
+    assert CloseAssay.assert!(10, 11, 1)
+
+    expect ::CloseAssay do
+      CloseAssay.assert!(10, 15, 0.25)
+    end
+
+And refutations,
+
+    assert CloseAssay.refute!(10, 11, 0.01)
+
+    expect ::CloseAssay do
+      CloseAssay.refute!(10, 11, 1)
+    end
+
+
 ## WithinAssay
 
 The `WithinAssay` class defines an assertion for matching that two values

data/lib/assay.yml

@@ -28,9 +28,10 @@ repositories:
   scm: git
   name: upstream
 resources:
-  home: http://rubydoc.info/gems/assay
-  docs: http://rubydoc.info/gems/assay
+  home: http://rubyworks.github.com/assay
+  docs: http://rubydoc.info/gems/assay/frames
   code: http://github.com/rubyworks/assay
+  bugs: http://github.com/rubyworks/assay/issues
   mail: http://groups.google.com/groups/rubyworks-mailinglist
 extra: {}
 load_path:
@@ -39,11 +40,12 @@ revision: 0
 created: '2009-08-21'
 summary: Class-based Assertions Framework
 title: Assay
-version: 0.4.0
+version: 0.4.1
 name: assay
-description: ! 'The Assay project defines Assertions in the same way that Ruby defines
-  Exceptions.
+description: ! 'Assay defines assertions in the same way that Ruby defines exceptions.
 
-  An asserition then simply becomes an extension to an Exception class.'
+  Each type of asserition, called an assay, is then a child of the base
+
+  Assertion class, which itself is a subclass of the Exception class.'
 organization: Rubyworks
-date: '2012-01-25'
+date: '2012-01-27'

data/lib/assay/close_assay.rb

@@ -0,0 +1,42 @@
+require_relative 'compare_assay'
+
+# Relative approximation, sometimes refered to as *within epsilon*.
+#
+class CloseAssay < CompareAssay
+
+  register :close
+
+  #
+  # Check assertion.
+  #
+  def self.pass?(subject, criterion, epsilon)
+    #if [subject, criterion, epsilon].all?{ |v| Numeric === v }
+      a, b, e = subject.to_f, criterion.to_f, epsilon.to_f
+    #else
+    #  a, b, e = subject, criterion, epsilon
+    #end
+
+    #(a - b).abs / [a.abs, b.abs].max <= e
+    
+    d = b * e   # [a.abs,b.abs].max * e
+
+    (b - d) <= a && (b + d) >= a
+  end
+
+  #
+  # Failed assertion message.
+  #
+  def self.assert_message(subject, criterion, delta)
+    a = subject.inspect
+    b = criterion.inspect
+    e = delta.inspect
+
+    if [a, b, e].any?{ |e| e.to_s.size > SIZE_LIMIT }
+      "b(1 - e) <= a <= b(1 + e)\na) #{a}\nb) #{b}\nd) #{d}"
+    else
+      "#{b}(1 - #{e}) <= #{a} <= #{b}(1 + #{e})"
+    end
+  end
+
+end
+

data/lib/assay/rescue_assay.rb

@@ -5,7 +5,7 @@ require_relative 'assertion'
 #
 class RescueAssay < Assertion
 
-  register :rescue
+  register :rescued
 
   #
   # Check assertion.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: assay
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-25 00:00:00.000000000 Z
+date: 2012-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ansi
-  requirement: &18939580 !ruby/object:Gem::Requirement
+  requirement: &14053100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *18939580
+  version_requirements: *14053100
 - !ruby/object:Gem::Dependency
   name: brass
-  requirement: &18936100 !ruby/object:Gem::Requirement
+  requirement: &15234940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *18936100
+  version_requirements: *15234940
 - !ruby/object:Gem::Dependency
   name: detroit
-  requirement: &19011100 !ruby/object:Gem::Requirement
+  requirement: &15232900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *19011100
+  version_requirements: *15232900
 - !ruby/object:Gem::Dependency
   name: qed
-  requirement: &19008540 !ruby/object:Gem::Requirement
+  requirement: &15230160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,11 +54,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *19008540
-description: ! 'The Assay project defines Assertions in the same way that Ruby defines
-  Exceptions.
+  version_requirements: *15230160
+description: ! 'Assay defines assertions in the same way that Ruby defines exceptions.
 
-  An asserition then simply becomes an extension to an Exception class.'
+  Each type of asserition, called an assay, is then a child of the base
+
+  Assertion class, which itself is a subclass of the Exception class.'
 email:
 - transfire@gmail.com
 executables: []
@@ -77,6 +78,7 @@ files:
 - lib/assay/assertor.rb
 - lib/assay/boolean_assay.rb
 - lib/assay/case_assay.rb
+- lib/assay/close_assay.rb
 - lib/assay/compare_assay.rb
 - lib/assay/core_ext/kernel.rb
 - lib/assay/core_ext/na.rb
@@ -142,7 +144,7 @@ files:
 - README.rdoc
 - QED.rdoc
 - COPYING.rdoc
-homepage: http://rubydoc.info/gems/assay
+homepage: http://rubyworks.github.com/assay
 licenses:
 - BSD-2-Clause
 post_install_message: