invariant 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Norbert Wojtowicz
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,84 @@
+# Invariant
+
+`Invariant` is a simple gem that provides `Kernel#assert` to document your assumptions in code.
+
+> Use assertions to prevent the impossible.
+> 
+> Whenever you find yourself thinking "but of course that could never happen,"
+> add code to check it. The easiest way to do this is with assertions. 
+>
+> http://pragmatictips.com/33
+
+
+## Installation
+
+Add to Gemfile:
+
+    gem 'invariant'
+
+
+## Configuration
+
+Assertions are enabled by default. Better safe than sorry. To disable assertions:
+
+```ruby
+Invariant.disable_assertions
+```
+
+For example, in Rails you may want to disable assertions in Production:
+
+```ruby
+# config/initializers/invariant.rb
+Invariant.disable_assertions if Rails.env.production?
+```
+
+## Usage
+
+Use `assert` to test a condition:
+
+```ruby
+assert age > 0
+```
+
+Provide an optional message:
+
+```ruby
+assert errors.empty?, "Why do we still have errors?"
+```
+
+You can also test a block of code. This is handy when you're invariant requires several lines of code.
+
+```ruby
+assert do
+  one_thing = calculate_something
+  other_thing = calculate_something_else
+  one_thing > other_thing
+end
+```
+
+Blocks also support an optional message:
+
+```ruby
+assert 'That one thing should always be greater' do
+  one_thing = calculate_something
+  other_thing = calculate_something_else
+  one_thing > other_thing
+end
+```
+
+## Errors
+
+A failed assertion raises `Invariant::AssertionError` which inherits directly from `Exception`.
+
+An `AssertionError` should be an *exceptional* failure. It should not be something a program knows how to recover from. This is why `AssertionError` is not a `StandardError`:
+
+```ruby
+  def real_world
+    assert 1 == 0, 'We are in the real world'
+  rescue
+    'We are in the Matrix'
+  end
+
+  real_world # => raises Invariant::AssertionError, 'We are in the real world'
+```
+  

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/invariant.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name          = 'invariant'
+  gem.version       = '0.1.0'
+  gem.authors       = ["Norbert Wojtowicz"]
+  gem.email         = ["wojtowicz.norbert@gmail.com"]
+  gem.description   = 'Document your code invariants'
+  gem.summary       = gem.description
+  gem.homepage      = "https://github.com/pithyless/invariant"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency('rspec', "~> 2.12.0")
+  gem.add_development_dependency('rake')
+end

data/lib/invariant.rb

@@ -0,0 +1,25 @@
+module Invariant
+  class AssertionError < StandardError
+  end
+
+  def self.enable_assertions
+    Kernel.class_eval do
+      def assert(first=nil, second=nil)
+        if block_given?
+          assert(yield, first)
+        else
+          raise AssertionError, second unless first
+        end
+      end
+    end
+  end
+
+  def self.disable_assertions
+    Kernel.class_eval do
+      def assert(*args, &block)
+      end
+    end
+  end
+end
+
+Invariant.enable_assertions

data/spec/invariant/assert_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe 'Invariant Assertion' do
+
+  before :each do
+    Invariant.enable_assertions
+  end
+
+  describe 'assert' do
+
+    context 'without message' do
+      it 'fails when condition is false' do
+        expect{ assert false }.to raise_error Invariant::AssertionError
+      end
+
+      it 'fails when condition evaluates to false' do
+        expect{ assert nil }.to raise_error Invariant::AssertionError
+      end
+
+      it 'returns nil when condition is true' do
+        expect{ assert true }.to_not raise_error Invariant::AssertionError
+        assert(true).should be_nil
+      end
+
+      it 'returns nil when condition evaluates to true' do
+        expect{ assert 'This evaluates to true' }.to_not raise_error Invariant::AssertionError
+        assert('This evaluates to true').should be_nil
+      end
+    end
+
+    context 'with message' do
+      it 'raises error with specified message when condition evaluates to false' do
+        expect{ assert nil, 'The error message' }.to raise_error(Invariant::AssertionError, 'The error message')
+      end
+
+      it 'returns nil without error when condition evaluates to true' do
+        expect{ assert 'This evaluates to true', 'The error message' }.to_not raise_error(Invariant::AssertionError)
+        assert('This evaluates to true').should be_nil
+      end
+    end
+
+    context 'block invariant without message' do
+      it 'invokes block' do
+        expect{ |b| assert(&b) }.to yield_with_no_args
+      end
+
+      it 'invokes assert with the block result' do
+        assert { 'Evaluates to true' }.should be_nil
+      end
+
+      it 'raises error without message' do
+        expect{ assert { nil } }.to raise_error(Invariant::AssertionError)
+      end
+    end
+
+    context 'block invariant with message' do
+      it 'invokes block' do
+        expect{ |b| assert('The error message', &b) }.to yield_with_no_args
+      end
+
+      it 'invokes assert with the block result and message' do
+        assert('The error message'){ 'Evaluates to true' }.should be_nil
+      end
+
+      it 'raises error with message' do
+        expect{ assert('The error message'){ 1 == 2 } }.to raise_error(Invariant::AssertionError, 'The error message')
+      end
+    end
+  end
+
+end

data/spec/invariant/invariant_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Invariant do
+
+  describe '::disable_assertions' do
+    it 'disables assertions' do
+      Invariant.disable_assertions
+      assert(false).should be_nil
+    end
+  end
+
+  describe '::disable_assertions' do
+    it 'enables assertions' do
+      Invariant.enable_assertions
+      expect{ assert false }.to raise_error Invariant::AssertionError
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'invariant'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: invariant
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Norbert Wojtowicz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Document your code invariants
+email:
+- wojtowicz.norbert@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- invariant.gemspec
+- lib/invariant.rb
+- spec/invariant/assert_spec.rb
+- spec/invariant/invariant_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/pithyless/invariant
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 970666457985510709
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 970666457985510709
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Document your code invariants
+test_files:
+- spec/invariant/assert_spec.rb
+- spec/invariant/invariant_spec.rb
+- spec/spec_helper.rb