bang 0.1.0 → 0.2.0

data/.index

@@ -0,0 +1,57 @@
+---
+type: ruby
+revision: 2013
+sources:
+- var
+- VERSION
+authors:
+- name: Trans
+  email: transfire@gmail.com
+organizations:
+- name: Rubyworks
+requirements:
+- name: brass
+- groups:
+  - build
+  development: true
+  name: detroit
+- groups:
+  - test
+  development: true
+  name: qed
+conflicts: []
+alternatives: []
+resources:
+- type: home
+  uri: http://rubyworks.github.com/bang
+  label: Homepage
+- type: code
+  uri: http://github.com/rubyworks/bang
+  label: Source Code
+- type: bugs
+  uri: http://github.com/rubyworks/bang/issues
+  label: Issue Tracker
+- type: mail
+  uri: http://groups.google.com/groups/rubyworks-mailinglist
+  label: Mailing List
+repositories:
+- name: upstream
+  scm: git
+  uri: git@github.com:rubyworks/bang.git
+categories: []
+paths:
+  load:
+  - lib
+copyrights:
+- holder: Rubyworks
+  year: '2012'
+  license: BSD-2-Clause
+created: '2012-01-26'
+summary: Bang methods for assertions!
+title: Bang! Bang!
+name: bang
+description: ! 'Bang! Bang! provides a dynamic assertions framework utlizing bang
+
+  methods and built to BRASS standards.'
+version: 0.2.0
+date: '2012-12-21'

data/.yardopts

@@ -0,0 +1,7 @@
+--title "Bang! Bang!"
+--readme README.md
+--protected
+--private
+lib
+-
+[A-Z]*.*

data/HISTORY.md

@@ -1,6 +1,18 @@
-# HISTORY
+# RELEASE HISTORY
 
-## 0.1.0 | 2012-02-09
+## 0.2.0 / 2012-12-21
+
+This release modifies Bang! Bang! to rely on BRASS #assert and #refute
+methods directly. This simplifies the code a bit and takes care of
+tracking assertion counts automatically.
+
+Changes:
+
+* Use Brass #assert and #refute methods.
+* Access project metadata dynamically via const_missing.
+
+
+## 0.1.0 / 2012-02-09
 
 This is the initial release of Bang.
 

data/LICENSE.txt

@@ -0,0 +1,22 @@
+BSD-2-Clause License
+
+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/README.md

@@ -2,34 +2,33 @@
 
 [Website](http://rubyworks.github.com/bang) /
 [Report Issue](http://github.com/rubyworks/bang/issues) /
-[Mailing List](http://groups.google.com/groups/rubyworks-mailinglist) /
-[Source Code](http://github.com/rubyworks/bang) /
-IRC #rubyworks
+[Source Code](http://github.com/rubyworks/bang)
+( [![Build Status](https://secure.travis-ci.org/rubyworks/bang.png)](http://travis-ci.org/rubyworks/bang) )
 
-[![Build Status](https://secure.travis-ci.org/rubyworks/bang.png)](http://travis-ci.org/rubyworks/bang)
+<br/>
 
+Bang! Bang! is a [BRASS](http://rubyworks.github.com/brass) compliant assertions
+framework with a very clever design that translates any bang call, e.g. `#foo!`
+into an assertion based on the corresponding query call if it exists, e.g. `#foo?`.
+In practice the framework is similar to MiniTest's spec methods,
+e.g. `#must_equal`, but the dynamic nature of Bang! Bang! makes it much more 
+flexible, as it is not limited to a finite set of assertion methods.
 
-## Description
+It's also pretty interesting idea that bang methods would be assertion methods.
+In general practice bang methods are usually used for methods that change the
+state of an object *in-place*. But this isn't particularly necessary and 
+is just as well handled by non-bang methods, e.g. `#update` vs `#merge!`.
 
-Bang! Bang! is an assertions framework with a very clever design that translates
-any bang call, e.g. `#foo!` into an assertion based on the corresponding query
-call, `#foo?` (if it exists). In practice the framework is similar to MiniTest's
-spec expectation methods, e.g. `#must_equal`, but the dynamic nature of Bang!
-Bang! makes it much more flexible, as it is not limited to a finite set of 
-assertion methods.
 
-It's also pretty interesting idea that bang methods are asseriton methods.
-In usual Ruby code, bang methods ususually aren't particularly necessary and 
-could just as well be handled by non-bang methods, e.g. `#update` vs `#merge!`.
-
-
-## Instruction
+## Instructions
 
 Usage is pretty straight forward.
 
+```ruby
     require 'bang'
 
     "This string".equals!("That string")  #=> raises Bang::Assertion
+```
 
 To use Bang! Bang! most effectively with common test frameworks, you may need
 to load an adapter to ensure the framework recognizes the assertions as
@@ -37,27 +36,50 @@ such rather than as ordinary errors.
 
 For MiniTest use:
 
+```ruby
     require 'bang/minitest'`
+```
 
 For TestUnit use:
 
+```ruby
     require 'bang/testunit'
+```
 
 An RSpec adapter is in the works.
 
-Cucumber does not require an adapter as it does not differntiate errors
+Cucumber does not require an adapter as it does not differentiate errors
 from assertions.
 
 Note, these adapters simply require the `brass/adapters/minitest` and
-`brass/adapters/testunit` respecitvely along with `bang`. So that's another
+`brass/adapters/testunit` respectively along with `bang`. So that's another
 way to do it too.
 
 
+## On Robustness
+
+Bang! Bang! works via a set of core extensions. There may be some concern
+about this approach for a test framework. I can assure you that the fear
+of the inaptly named "monkey patch" is very much overwrought.
+
+Even though Bang! Bang! adds a `#method_missing` call to the Object class, it is
+almost always okay to use because it does not get called if an object already has
+a bang method defined for it's own use. And when it does get called it only applies
+if a corresponding query (e.g. `foo?`) method exists.
+
+The other core extensions it adds are simply convenience methods that make testing
+easier. Because these are only additions and not overrides, it is perfectly safe to
+use in all but the most esoteric cases (such a heavy meta-programming). In fact, if
+a program doesn't work because of these core extensions, that's usually a good 
+indication that something isn't being done right in the program itself.
+
+
 ## Copyrights
 
-Bang Bang is Copyright (c) 2012 Rubyworks
+Bang Bang is copyrighted open source software.
 
-You can redistribute it in accordance to the *BSD-2-Clause* license.
+    Copyright (c) 2012 Rubyworks
 
-Please see the included COPYING.md file for license details.
+You can redistribute it in accordance to the [BSD-2-Clause](http://spdx.org/licenses/BSD-2-Clause) license.
 
+See the included LICENSE.txt file for details.

data/demo/01_bang.md

@@ -0,0 +1,180 @@
+# Bangers
+
+    require 'bang'
+
+## true!
+
+    true.true!
+
+    expect Bang::Assertion do
+      false.true!
+    end
+
+    false.not_true!
+
+## false!
+
+    false.false!
+
+    expect Bang::Assertion do
+      true.false!
+    end
+
+    true.not_false!
+
+## nil!
+
+    nil.nil!
+
+    expect Bang::Assertion do
+      true.nil!
+    end
+
+    true.not_nil!
+
+## equal!
+
+    1.equal!(1)
+
+    expect Bang::Assertion do
+      1.equal!(2)
+    end
+
+    1.not_equal!(2)
+
+## eql!
+
+    1.eql!(1)
+
+    expect Bang::Assertion do
+      1.eql!(1.0)
+    end
+
+    1.not_eql!(1.0)
+
+## identical!
+
+Ruby's built-in query method for this is `#equal?`, but obviously that conflicts
+with our use of `#equal!` to test quality using `###`. So instead we use `#identical!`
+which makes more sense really.
+
+    :a.identical!(:a)
+
+    expect Bang::Assertion do
+      "a".identical!("a")
+    end
+
+    :a.not_identical!('a')
+
+## instance_of!
+
+    1.instance_of!(Fixnum)
+
+    expect Bang::Assertion do
+      1.instance_of!(String)
+    end
+
+    1.not_instance_of!(String)
+
+## kind_of!
+
+    1.kind_of!(Integer)
+
+    expect Bang::Assertion do
+      1.kind_of!(String)
+    end
+
+    1.not_kind_of!(String)
+
+## within!
+
+    1.within!(2, 1.5)
+
+    expect Bang::Assertion do
+      1.within!(2, 0.5)
+    end
+
+    1.not_within!(2, 0.5)
+
+## close!
+
+    1.close!(2, 1.5)
+
+    expect Bang::Assertion do
+      1.close!(1.2, 0.5)
+    end
+
+    1.not_close!(5, 0.5)
+
+## match!
+
+    "abc".match!(/a/)
+
+    expect Bang::Assertion do
+      "abc".match!(/x/)
+    end
+
+    "abc".not_match!(/g/)
+
+## respond_to!
+
+    "string".respond_to!(:upcase)
+
+    expect Bang::Assertion do
+      "string".respond_to!(:not_a_method)
+    end
+
+    "string".not_respond_to!(:not_a_method)
+
+## satisfy!
+
+    5.satisfy!{ |x| x > 3 }
+
+    expect Bang::Assertion do
+      5.satisfy!{ |x| x < 3 }
+    end
+
+    5.not_satisfy!{ |x| x < 3 }
+
+## raises!
+
+    ::ArgumentError.raised!{ raise ::ArgumentError }
+
+An extension to Proc class can also be used.
+
+    procedure = lambda{ raise ::ArgumentError }
+
+    procedure.raises!(::ArgumentError)
+
+    expect Bang::Assertion do
+      procedure.raises!(::TypeError)
+    end
+
+## rescues!
+
+    ::TypeError.rescued!{ raise ::TypeError }
+
+An extension to Proc class can also be used.
+
+    procedure = lambda{ raise ::TypeError }
+
+    procedure.rescues!(::StandardError)
+
+    expect Bang::Assertion do
+      procedure.rescues!(::IOError)
+    end
+
+## throws!
+
+    :foo.thrown!{ throw :foo }
+
+An extension to Proc class can also be used.
+
+    procedure = lambda{ throw :foo }
+
+    procedure.throws!(:foo)
+
+    expect Bang::Assertion do
+      procedure.throws!(:bar)
+    end
+

data/lib/bang.rb

@@ -1,18 +1,33 @@
 module Bang
 
-  if RUBY_VERSION < '1.9'
-    require 'bang/version'
-  else
-    require_relative 'bang/version'
+  # Bang has brass balls.
+  require 'brass'
+
+  #
+  # If constant is missing check for value in project metadata.
+  # e.g. `Bang::VERSION`.
+  #
+  def self.const_missing(const_name)
+    index[const_name.to_s.downcase] || super(const_name)
+  end
+
+  #
+  # Access project metadata.
+  #
+  def self.index
+    @index ||= (
+      require 'yaml'
+      YAML.load_file(File.dirname(__FILE__) + '/bang.yml')
+    )
   end
 
-  # Bang's assertion class. Follows standard set by Brass project,
+  # Bang's assertion class. Follows standard set by BRASS project,
   # defining `#assertion?` method which return `true`.
   #
   class Assertion < ::Exception
 
     #
-    # Price together an Assetion error give the message used to 
+    # Piece together an Assetion error give the message used to 
     # cause the assertion failure.
     #
     # @return [Assertion] Assertion instance.
@@ -72,8 +87,10 @@ module Bang
 
       result = meth.call(*a, &b)
 
-      if !(neg ^ result)
-        raise Bang::Assertion.piece(s, a, b, caller)
+      if neg
+        refute(result, Bang::Assertion.piece(s, a, b, caller))
+      else
+        assert(result, Bang::Assertion.piece(s, a, b, caller))
       end
     end
 
@@ -100,7 +117,7 @@ module Bang
     #
     # @return [true,false] Whether `self` is equal to `other`.
     #
-    def equal_to?
+    def equal_to?(other)
       other == self
     end
 

data/lib/bang.yml

@@ -0,0 +1,57 @@
+---
+type: ruby
+revision: 2013
+sources:
+- var
+- VERSION
+authors:
+- name: Trans
+  email: transfire@gmail.com
+organizations:
+- name: Rubyworks
+requirements:
+- name: brass
+- groups:
+  - build
+  development: true
+  name: detroit
+- groups:
+  - test
+  development: true
+  name: qed
+conflicts: []
+alternatives: []
+resources:
+- type: home
+  uri: http://rubyworks.github.com/bang
+  label: Homepage
+- type: code
+  uri: http://github.com/rubyworks/bang
+  label: Source Code
+- type: bugs
+  uri: http://github.com/rubyworks/bang/issues
+  label: Issue Tracker
+- type: mail
+  uri: http://groups.google.com/groups/rubyworks-mailinglist
+  label: Mailing List
+repositories:
+- name: upstream
+  scm: git
+  uri: git@github.com:rubyworks/bang.git
+categories: []
+paths:
+  load:
+  - lib
+copyrights:
+- holder: Rubyworks
+  year: '2012'
+  license: BSD-2-Clause
+created: '2012-01-26'
+summary: Bang methods for assertions!
+title: Bang! Bang!
+name: bang
+description: ! 'Bang! Bang! provides a dynamic assertions framework utlizing bang
+
+  methods and built to BRASS standards.'
+version: 0.2.0
+date: '2012-12-21'

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: bang
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
-- Thomas Sawyer
+- Trans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-09 00:00:00.000000000 Z
+date: 2012-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: brass
-  requirement: &23786500 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *23786500
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: detroit
-  requirement: &23785960 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *23785960
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: qed
-  requirement: &23785460 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,25 +53,35 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *23785460
-description: Bang! Bang! provides a dynamic assertions framework utlizing bang methods
-  and built to BRASS standards.
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'Bang! Bang! provides a dynamic assertions framework utlizing bang
+
+  methods and built to BRASS standards.'
 email:
 - transfire@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- COPYING.md
+- LICENSE.txt
 - HISTORY.md
 - README.md
 files:
+- .index
+- .yardopts
+- demo/01_bang.md
+- demo/applique/brass.rb
 - lib/bang/minitest.rb
 - lib/bang/testunit.rb
 - lib/bang.rb
-- spec/applique/brass.rb
-- COPYING.md
+- lib/bang.yml
 - HISTORY.md
 - README.md
+- LICENSE.txt
 homepage: http://rubyworks.github.com/bang
 licenses:
 - BSD-2-Clause
@@ -83,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Bang methods for assertions!

data/COPYING.md

@@ -1,36 +0,0 @@
-# COPYRIGHT
-
-## NOTICES
-
-### Assay
-
-| Project   | Bang                              |
-|-----------|-----------------------------------|
-| Copyright | (c) 2012 Rubyworks                |
-| License   | (r) BSD-2-Clause                  |
-| Website   | http://rubyworks.github.com/bang  |
-
-## LICENSES
-
-### BSD-2-Clause License
-
-    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.