solid_assert 0.5.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end
+
+group :test do
+  gem 'ZenTest'
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Jorge Manrubia
+
+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,24 @@
+# solid_assert
+
+solid_assert is a simple implementation of an `assert` utility in Ruby. 
+
+It let you code in your assumptions when coding. Sometimes, when you are coding, you have this thinking of "I it reaches here, then this variable has to be this value", or "This line should never be executed", or "At this point, this list should contain an entry for all the keys in this hash". These are the kind of scenarios when assertions comes handy.
+
+The practice of using assertions makes your code more solid, since it is the computer who systematically verifies your code integrity. 
+
+# Installation
+
+In your `Gemfile`
+
+	gem "solid_assert"
+
+# Usage
+
+
+## References
+
+- [Programming with assertions](http://download.oracle.com/javase/1.4.2/docs/guide/lang/assert.html). A great article on assertions. It is about the Java language, but the concepts it explains apply to any programming language.
+- [Writing Solid Code](http://www.amazon.com/Writing-Solid-Code-Microsoft-Programming/dp/1556155514).
+
+
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "solid_assert"
+  gem.homepage = "http://github.com/jorgemanrubia/solid_assert"
+  gem.license = "MIT"
+  gem.summary = %Q{Assert utility for ruby}
+  gem.description = %Q{Assert utility for ruby. It let you code your assumptions and code invariants, so they are checked automatically. It can be deactivated, so you it doesn't affect to your program performance (for example, in production)'}
+  gem.email = "jorge.manrubia@gmail.com"
+  gem.authors = ["Jorge Manrubia"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "solid_assert #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.5.0

data/lib/solid_assert.rb

@@ -0,0 +1,4 @@
+Dir[File.dirname(__FILE__) + '/solid_assert/**/*.rb'].each do |file|
+  require file
+end
+

data/lib/solid_assert/assert.rb

@@ -0,0 +1,37 @@
+module SolidAssert
+  module Assert
+
+    # Expresses a condition and fails if the condition is not satisfied
+    #
+    # Usage
+    #   assert false
+    #   assert not_nil_object
+    #   assert !list.empty?, "The list should not be empty at this point"
+    #
+    # @param condition The condition to assert
+    # @param message The optional message when the condition is not satisfied
+    # @raise {AssertionFailedError} when the condition is not satisfied
+    def assert(condition, message=nil)
+      raise SolidAssert::AssertionFailedError.new(message) if !condition
+    end
+
+    # Let you {#assert} a block of code. It comes handy when your assertion requires more than one lines of code
+    # Usage:
+    #   invariant do
+    #     some_number = 1
+    #     other_number = 2
+    #     some_number == other_number
+    #   end
+    #
+    #   invariant "Both numbers should be equal" do
+    #     some_number = 1
+    #     other_number = 2
+    #     some_number == other_number
+    #   end
+    # @param message The optional message when the block doesn't evaluates to a satisfied condition
+    # @yield The block that will be evaluated for deciding whether the condition is satisfied
+    def invariant(message=nil)
+      assert yield, message
+    end
+  end
+end

data/lib/solid_assert/assertion_failed_error.rb

@@ -0,0 +1,10 @@
+module SolidAssert
+
+  class AssertionFailedError < StandardError
+    def initialize(message=nil)
+      super
+    end
+  end
+
+end
+

data/lib/solid_assert/null_assert.rb

@@ -0,0 +1,14 @@
+module SolidAssert
+
+  # Null assert implementation. Used when the assertions are disabled
+  module NullAssert
+
+    # Empty implemention of {Assert#assert}
+    def assert(condition, message=nil)
+    end
+
+    # Empty implemention of {Assert#invariant}
+    def invariant(message=nil)
+    end
+  end
+end

data/lib/solid_assert/solid_assert.rb

@@ -0,0 +1,20 @@
+module SolidAssert
+
+  # Turns the assertions on
+  def self.enable_assertions
+    Object.class_eval do
+      include Assert
+    end
+  end
+
+  # Turns the assertions off
+  def self.disable_assertions
+    Object.class_eval do
+      include NullAssert
+    end
+  end
+
+end
+
+
+

data/solid_assert.gemspec

@@ -0,0 +1,65 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{solid_assert}
+  s.version = "0.5.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Jorge Manrubia}]
+  s.date = %q{2011-09-18}
+  s.description = %q{Assert utility for ruby. It let you code your assumptions and code invariants, so they are checked automatically. It can be deactivated, so you it doesn't affect to your program performance (for example, in production)'}
+  s.email = %q{jorge.manrubia@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/solid_assert.rb",
+    "lib/solid_assert/assert.rb",
+    "lib/solid_assert/assertion_failed_error.rb",
+    "lib/solid_assert/null_assert.rb",
+    "lib/solid_assert/solid_assert.rb",
+    "solid_assert.gemspec",
+    "spec/solid_assert/assert_spec.rb",
+    "spec/solid_assert/null_assert_spec.rb",
+    "spec/solid_assert/solid_assert_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/jorgemanrubia/solid_assert}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.6}
+  s.summary = %q{Assert utility for ruby}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/spec/solid_assert/assert_spec.rb

@@ -0,0 +1,54 @@
+require "spec_helper"
+
+describe SolidAssert::Assert do
+  before(:all) do
+    Object.class_eval do
+      include SolidAssert::Assert
+    end
+  end
+
+  describe "#assert" do
+    describe "without assertion message" do
+      it "should fail when condition is false" do
+        lambda { assert false }.should raise_error SolidAssert::AssertionFailedError
+      end
+
+      it "should fail when condition evaluates to false" do
+        lambda { assert nil }.should raise_error SolidAssert::AssertionFailedError
+      end
+
+      it "should not fail when condition is true" do
+        lambda { assert true }.should_not raise_error SolidAssert::AssertionFailedError
+      end
+
+      it "should not fail when condition evaluates to true" do
+        lambda { assert "This evaluates to true" }.should_not raise_error SolidAssert::AssertionFailedError
+      end
+    end
+
+    describe "with assertion message" do
+      it "should raise error with specified message when condition evaluates to false" do
+        lambda { assert nil, "The error message" }.should raise_error(SolidAssert::AssertionFailedError, "The error message")
+      end
+
+      it "should not raise any error when condition doesn't evaluate to false'" do
+        lambda { assert 'This evaluates to true', "The error message" }.should_not raise_error(SolidAssert::AssertionFailedError)
+      end
+    end
+  end
+
+  describe "#invariants" do
+    it "should invoke assert with the provided block" do
+      self.should_receive(:assert).with('This is the invariant block', nil)
+      invariant { "This is the invariant block" }
+    end
+
+    it "should invoke assert with the provided block and the provided error message" do
+      self.should_receive(:assert).with('This is the invariant block', 'the error message')
+      invariant "the error message" do
+        "This is the invariant block"
+      end
+    end
+  end
+
+end

data/spec/solid_assert/null_assert_spec.rb

@@ -0,0 +1,34 @@
+require "spec_helper"
+
+describe SolidAssert::NullAssert do
+  before(:all) do
+    Object.class_eval do
+      include SolidAssert::NullAssert
+    end
+  end
+
+  describe "#assert" do
+    it "should do nothing without message" do
+      assert false
+    end
+
+    it "should do nothing with message" do
+      assert false, "Some message"
+    end
+  end
+
+  describe "#invariants" do
+    it "should do nothing without message" do
+      invariant do
+        false
+      end
+    end
+
+    it "should do nothing with message" do
+      invariant "Some message" do
+        false
+      end
+    end
+  end
+
+end

data/spec/solid_assert/solid_assert_spec.rb

@@ -0,0 +1,35 @@
+require "spec_helper"
+
+describe SolidAssert::Assert do
+  describe ".enable_assertions" do
+    it "should make the Object class to include the Assertions module" do
+      Object.should_receive(:include).with(SolidAssert::Assert)
+      SolidAssert.enable_assertions
+    end
+
+    it "should turn on the assertions" do
+      SolidAssert.enable_assertions
+      lambda{assert false}.should raise_error(SolidAssert::AssertionFailedError)
+    end
+  end
+
+  describe ".disable_assertions" do
+    it "should make the Object class to include the EmptyAssertions module" do
+      Object.should_receive(:include).with(SolidAssert::NullAssert)
+      SolidAssert.disable_assertions
+    end
+
+    it "should enable blank assertions, when these have been enabled previously" do
+      SolidAssert.disable_assertions
+      lambda{assert false}.should_not raise_error(SolidAssert::AssertionFailedError)
+    end
+
+    it "should disabled assertions, if these have been enabled previously" do
+      SolidAssert.enable_assertions
+      SolidAssert.disable_assertions
+      lambda{assert false}.should_not raise_error(SolidAssert::AssertionFailedError)
+    end
+
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+require 'solid_assert'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification 
+name: solid_assert
+version: !ruby/object:Gem::Version 
+  hash: 11
+  prerelease: 
+  segments: 
+  - 0
+  - 5
+  - 0
+  version: 0.5.0
+platform: ruby
+authors: 
+- Jorge Manrubia
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-18 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  version_requirements: *id001
+  name: rspec
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  version_requirements: *id002
+  name: bundler
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 6
+        - 4
+        version: 1.6.4
+  version_requirements: *id003
+  name: jeweler
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  version_requirements: *id004
+  name: rcov
+  prerelease: false
+description: Assert utility for ruby. It let you code your assumptions and code invariants, so they are checked automatically. It can be deactivated, so you it doesn't affect to your program performance (for example, in production)'
+email: jorge.manrubia@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- .document
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/solid_assert.rb
+- lib/solid_assert/assert.rb
+- lib/solid_assert/assertion_failed_error.rb
+- lib/solid_assert/null_assert.rb
+- lib/solid_assert/solid_assert.rb
+- solid_assert.gemspec
+- spec/solid_assert/assert_spec.rb
+- spec/solid_assert/null_assert_spec.rb
+- spec/solid_assert/solid_assert_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/jorgemanrubia/solid_assert
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Assert utility for ruby
+test_files: []
+