brass 1.0.0

data/.ruby

@@ -0,0 +1,53 @@
+---
+source:
+- meta
+authors:
+- name: Thomas Sawyer
+  email: transfire@gmail.com
+copyrights:
+- holder: Rubyworks
+  year: '2012'
+  license: BSD-2-Clause
+replacements: []
+alternatives: []
+requirements:
+- name: detroit
+  groups:
+  - build
+  development: true
+- name: lemon
+  groups:
+  - test
+  development: true
+- name: rubytest
+  groups:
+  - test
+  development: true
+dependencies: []
+conflicts: []
+repositories:
+- uri: git@github.com:rubyworks/brass.git
+  scm: git
+  name: upstream
+resources:
+  home: http://rubyworks.github.com/brass
+  docs: http://rubydoc.info/gems/brass
+  code: http://github.com/rubyworks/brass
+  mail: http://groups.google.com/groups/rubyworks-mailinglist
+extra: {}
+load_path:
+- lib
+revision: 0
+created: '2012-01-24'
+summary: Bare-Metal Ruby Assertion System Standard
+title: BRASS
+version: 1.0.0
+name: brass
+description: ! 'BRASS stands for Bare-Metal Ruby Assertion System Standard. It is
+  a very basic
+
+  foundational assertions framework for other assertion and test frameworks
+
+  to make use so they can all work together harmoniously.'
+organization: Rubyworks
+date: '2012-01-24'

data/COPYING.rdoc

@@ -0,0 +1,38 @@
+= COPYRIGHT
+
+== NOTICES
+
+=== Brass
+
+Copyright:: (c) 2012 RubyWorks
+License::   (r) BSD-2-Clause
+Website::   http://rubyworks.github.com/brass
+
+== LICENSES
+
+=== BSD-2-Clause License
+
+    Brass
+
+    Copyright (c) 2012 Rubyworks. 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/HISTORY.rdoc

@@ -0,0 +1,12 @@
+= HISTORY
+
+== 1.0.0 | 2012-01-24
+
+This is the initial release of BRASS. It is given a 1.0.0 version
+despite being such a new project because it is very simple and 
+the code is derived from other system that have used it for some time.
+
+Changes:
+
+* Happy Birthday!
+

data/README.md

@@ -0,0 +1,71 @@
+# BRASS
+
+[Website](http://rubyworks.github.com/brass) /
+[Report Issue](http://github.com/rubyworks/brass/issues) /
+[Development](http://github.com/rubyworks/brass)
+
+[![Build Status](https://secure.travis-ci.org/rubyworks/brass.png)](http://travis-ci.org/rubyworks/brass)
+
+
+# DESCRIPTION
+
+BRASS is a standard assertions framework, framework's framework, or even
+a framework's framework's framework, depending on where you're staking
+out your assertions keister.
+
+In other words, BRASS provides a standard rudimentary assertions framework
+that all other assertion and/or test framework can use, or at least comply
+with, and then everyone gets on swell.
+
+Now, you may be thinking, "No thanks, I do it my way." But when you see
+how stupid simple BRASS is, you'll realize that, "Yea, that actually 
+make sense." And feel a bit like a ass yourself for jumping to 
+quick judgment.
+
+Now, enough fluffery.
+
+BRASS defines two Kernel methods: `assert` and `refute`
+
+    assert(truthiness, *fail_arguments)
+    refute(truthiness, *fail_arguments)
+
+Where `truthiness` is any object evaluated for it's truth value (`false` and `nil`
+are `false`, everything else is `true`), and `fail_arguments` are exactly the same
+as those we would pass to the `fail` or `raise` methods.
+
+The `assert` and `refute` methods do three things. First they test the `truthiness`,
+then they tick up the counts in the global assertions counter, and if truthiness fails,
+they raise an error. This error is either `StandardError` or the one specified
+by the `fail_arguments`.
+
+The global assertions counter is `$ASSERTION_COUNTS`. If is simply a Hash formally
+defined as:
+
+    $ASSERTIONS_COUNTS = Hash.new{|h,k| h[k] = 0}
+
+And though it is open to any key, they should be symbols and three in particular
+and standard `:pass`, `:fail` and `:total`. Whenever an assertion passes, 
+the `:total` and `:pass` counts are incremented, and whenever an assertion
+fails the `:total` and `:fail` counts are incremented. You might wonder why
+there is a total entry when the sum of the other two would do just as well. 
+Well, other frameworks might want to add some other counts, e.g. a `:skip` 
+count, and to ensure we still get the proper total despite this, we keep
+a separate tally. Moving on....
+
+Okay, last thing. When `assert` or `refute` raises an error, it marks the error
+as an assertion via the `Exception#set_assertion` method. This is a method extension
+to the Exception class along with the `Exception#assertion?` method which any
+test framework can use to distinguish an assertion error from an ordinarily error.
+
+That's all, bro. Consider your brass ass informed.
+
+
+## COPYING
+
+Copyright (c) 2010 Rubyworks
+
+All rights reserved.
+
+Distribute in accordance with the **BSD-2-Clause** license.
+
+See COPYING.md file for details.

data/lib/brass.rb

@@ -0,0 +1,78 @@
+class Exception
+
+  # Is the exception an assertion error?
+  def assertion?
+    @assertion
+  end
+
+  # Set the the exception's assertion flag.
+  def set_assertion(boolean)
+    @assertion = boolean  # ? true : false
+  end
+
+end
+
+module Kernel
+
+  # Track assertions counts.
+  $ASSERTION_COUNTS ||= Hash.new{ |h,k| h[k] = 0 }
+
+  #
+  # Universal assertion method.
+  #
+  def assert(truth, *raise_arguments)
+    $ASSERTION_COUNTS[:total] += 1
+    if truth
+      $ASSERTION_COUNTS[:pass] += 1
+    else
+      $ASSERTION_COUNTS[:fail] += 1
+      # if fail set assertion=true then just,
+      #   fail *raise_arguments
+      # but alas ...
+      if Exception === raise_arguments.first
+        error = raise_arguments.shift
+      else
+        if Exception > raise_arguments.first
+          error_class = raise_arguments.shift
+        else
+          error_class = StandardError
+        end
+        error = error_class.new(*raise_arguments)
+      end
+      error.set_assertion(true)
+      raise error
+    end
+  end
+
+  module_function :assert
+
+  #
+  # Universal refutation method (opposite of `#assert`).
+  #
+  def refute(truth, *raise_arguments)
+    $ASSERTION_COUNTS[:total] += 1
+    if truth
+      $ASSERTION_COUNTS[:fail] += 1
+      # if fail set assertion=true then just,
+      #   fail *raise_arguments
+      # but alas ...
+      if Exception === raise_arguments.first
+        error = raise_arguments.shift
+      else
+        if Exception > raise_arguments.first
+          error_class = raise_arguments.shift
+        else
+          error_class = StandardError
+        end
+        error = error_class.new(*raise_arguments)
+      end
+      error.set_assertion(true)
+      raise error
+    else
+      $ASSERTION_COUNTS[:pass] += 1
+    end
+  end
+
+  module_function :refute
+
+end

data/lib/brass/expect.rb

@@ -0,0 +1,24 @@
+module Kernel
+
+  # TODO: Should `#expect` method be part of standard?
+
+  # Executate a block asserting that a type of error will be raised.
+  #
+  # Presently this is not part of brass by default, as whether it should
+  # be is under debate. So this file must be required separately:
+  #
+  #   require 'brass/expect'
+  #
+  def expect(error_class) #:yield:
+    begin
+      yield
+      assert(false, error_class, "#{error_class} expected but none thrown")
+    rescue error_class
+      assert(true)
+    rescue Exception => err
+      assert(false, error_class, "#{error_class} expected but #{err} was thrown")
+    end
+  end
+
+end
+

data/test/case_brass.rb

@@ -0,0 +1,22 @@
+covers 'brass'
+
+testcase Kernel do
+
+  method :assert do
+
+    test do
+      assert(true)
+    end
+
+  end
+
+  method :refute do
+
+    test do
+      refute(false)
+    end
+
+  end
+
+end
+

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: brass
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Thomas Sawyer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: detroit
+  requirement: &26437340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *26437340
+- !ruby/object:Gem::Dependency
+  name: lemon
+  requirement: &26436120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *26436120
+- !ruby/object:Gem::Dependency
+  name: rubytest
+  requirement: &26460580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *26460580
+description: ! 'BRASS stands for Bare-Metal Ruby Assertion System Standard. It is
+  a very basic
+
+  foundational assertions framework for other assertion and test frameworks
+
+  to make use so they can all work together harmoniously.'
+email:
+- transfire@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- HISTORY.rdoc
+- COPYING.rdoc
+- README.md
+files:
+- .ruby
+- lib/brass/expect.rb
+- lib/brass.rb
+- test/case_brass.rb
+- HISTORY.rdoc
+- README.md
+- COPYING.rdoc
+homepage: http://rubyworks.github.com/brass
+licenses:
+- BSD-2-Clause
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Bare-Metal Ruby Assertion System Standard
+test_files: []