preconditions 0.1.0

data/.document

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

data/Gemfile

@@ -0,0 +1,14 @@
+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 "yard", "~> 0.6.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+  gem "rspec", ">= 2.6.0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 tucker
+
+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,120 @@
+# Preconditions #
+
+A simple package to make the testing of method arguments easier to write and
+easier to read, inspired by <a
+href="http://guava-libraries.googlecode.com/svn-history/r13/trunk/javadoc/com/google/common/base/Preconditions.html">Guava's
+Preconditions</a> class
+
+## Overview ##
+
+The Preconditions package provides a single module, Preconditions, with methods for:
+
+* Checking if an argument is nil
+* Checking if an argument satisfies a boolean condition (e.g. x > 10)
+* Checking if an argument responds to a certain method (duck typing)
+* Checking if an argument is of a specific type (strict typing)
+
+Each of these methods will raise an appropriate exception if the rule it is
+applying is violated.
+
+Preconditions can be checked either by using the `Preconditions` module
+directly, as in `Preconditions::check_not_nil(x)`, or by mixing the
+`Preconditions` module into your class to make the methods available without the
+`Preconditions` prefix.  If the module is mixed in the precondition checking
+methods will be available to both class and instance methods equivalently.
+
+## Usage ##
+
+To check for nil arguments:
+
+    def my_meth(arg)
+      Preconditions.check_not_nil(arg)
+      ...
+    end
+
+If you wish to supply a message simply include a string as your second
+parameter:
+
+    def my_meth(arg)
+      Preconditions.check_not_nil(arg, "nil values are evil!")
+      ...
+    end
+
+You can even use a format if you want to interpolate some variables into your
+message lazily:
+
+    def my_meth(arg)
+      Preconditions.check_not_nil(arg, "Using nil in context of: %s", @bigobj.to_s)
+      ...
+    end
+
+All methods support both a message and a message/format argument pair.
+
+To check an argument property:
+
+    def sqrt(num)
+      Preconditions.check_argument(num > 0)
+      ...
+    end
+
+or alternatively
+    
+    def sqrt(num)
+      Preconditions.check_block("sqrt doesn't yet support complex numbers") { num > 0 }
+      ...
+    end
+
+To check the type of an object being supplied:
+
+    def sqrt(num)
+      Preconditions.check_type(num, Integer, 
+                               "sqrt is integer only, you supplied a %s", num.class)
+      ...
+    end
+
+To check if an object will respond to a method you intend to call:
+
+    def sqrt(num)
+      Preconditions.check_reponds_to(num, :sqrt,
+                                     "yup, we're that lazy")
+      ...
+    end
+
+If you wish to avoid the `Preconditions` prefix on every call, you can include the `Preconditions` module into your class:
+
+    class SpiffyClass
+      include Preconditions
+      
+      def a(x)
+        check_not_nil(x)
+        ...
+      end
+      
+      def self.b(y)
+        check_not_nil(y)
+        ...
+      end
+    end
+
+Where possible the `check_` methods will return the object being checked.  In
+the cases where this is not possible (`check_argument` and `check_block`) the
+boolean result of the expression is returned.
+
+## Contributing to preconditions ##
+ 
+* Check out the latest master to make sure the feature hasn't been implemented
+  or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it
+  and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want
+  to have your own version, or is otherwise necessary, that is fine, but
+  please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright ##
+
+Copyright (c) 2011 Chris Tucker. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,45 @@
+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 = "preconditions"
+  gem.homepage = "http://github.com/ctucker/preconditions"
+  gem.license = "MIT"
+  gem.summary = "Preconditions checking support inspired by Guava"
+  gem.description = <<-EOD
+The Preconditions library provides a simple set of methods for checking arguments being passed into a method.  Instead of writing custom checks and raising exceptions directly in your code you can use Preconditions to verify basic properties of your arguments (not-nil, satisfying a boolean expression, being of a certain type/duck-type) and raise the appropriate exception for you.
+  EOD
+  gem.email = "tucker+rubygems@glyde.com"
+  gem.authors = ["tucker"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+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 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/preconditions.rb

@@ -0,0 +1,99 @@
+# 
+module Preconditions
+
+  module PreconditionMethods
+
+    # Check that arg is not nil, raising an ArgumentError with an optional
+    # message and format if it is nil
+    # @param arg the argument to check
+    # @param msg optional format string message to print
+    # @param fmt arguments to format into format string
+    # @raise [ArgumentError] if the arg is nil
+    def check_not_nil(arg, msg = nil, *fmt)
+      if arg.nil?
+        raise_exception(ArgumentError, msg, *fmt)
+      end
+      arg
+    end
+
+    # Check that given expression is satisfied. Should be used in the context of
+    # an checking an argument, though this is not strictly required.
+    # @param exp a boolean expression; if true, the argument is good, if false it is not
+    # @param msg optional format string message to print
+    # @param fmt arguments to format into format string
+    # @raise [ArgumentError] if exp is false
+    def check_argument(exp, msg = nil, *fmt)
+      if !exp
+        raise_exception(ArgumentError, msg, *fmt)
+      end
+      exp
+    end
+
+
+    # Check that given block expression is satisfied. Should be used in the context of
+    # an checking an argument, though this is not strictly required.
+    # @param msg optional format string message to print
+    # @param fmt arguments to format into format string
+    # @raise [ArgumentError] if block evaluates to false
+    def check_block(msg = nil, *fmt, &block)
+      res = yield
+      if !res
+        raise_exception(ArgumentError, msg, *fmt)
+      end
+      res
+    end
+
+    # Check that given object is of given type.
+    # @param obj object to check
+    # @param expected_type type of which object is expected to be an instance
+    # @param msg optional format string message to print
+    # @param fmt arguments to format into format string
+    # @return obj
+    # @raise [TypeError] if obj is not an instance of expected_type
+    def check_type(obj, expected_type, msg=nil, *fmt)
+      if !obj.kind_of?(expected_type)
+        raise_exception(TypeError, msg, *fmt)
+      end
+      obj
+    end
+
+    # Check that given object responds to given method
+    # @param obj object to check
+    # @param meth_sym symbolic name of method
+    # @param msg optional format string message to print
+    # @param fmt arguments to format into format string
+    # @return obj
+    # @raise [NameError] if meth_sym is not a method on obj
+    def check_responds_to(obj, meth_sym, msg=nil, *fmt)
+      if !obj.respond_to?(meth_sym)
+        raise_exception(NameError, msg, *fmt)
+      end
+      obj
+    end
+
+    def self.included(receiver)
+      receiver.extend PreconditionMethods
+    end
+
+    private
+
+    def raise_exception(e, msg, *fmt)
+      message = if !fmt.empty?
+                  sprintf(msg, *fmt)
+                elsif !msg.nil?
+                  msg
+                else
+                  ''
+                end
+      raise e, message
+    end
+  end
+
+  class << self
+    include PreconditionMethods
+  end
+
+  def self.included(receiver)
+    receiver.send :include, PreconditionMethods
+  end
+end

data/spec/preconditions_spec.rb

@@ -0,0 +1,72 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class IncludingClass
+  include Preconditions
+end
+
+[Preconditions, IncludingClass, IncludingClass.new].each do |s|
+
+  describe "precondition checks on #{s}" do
+    subject { s }
+
+    it "raises an ArgumentError when checking for nil on a nil value" do
+      expect { subject.check_not_nil(nil) }.to raise_exception ArgumentError
+    end
+    
+    it "returns the argument in a nil check when argument is not nil" do
+      subject.check_not_nil(1).should == 1
+    end
+    
+    it "raises an ArgumentError with message when checking for nil with a supplied message" do
+      expect { subject.check_not_nil(nil, "expected message") }.
+        to raise_exception(ArgumentError, "expected message")
+    end
+    
+    it "raises an ArgumentError with formatted message when checking for nil with a formatted message" do
+      expect { subject.check_not_nil(nil, "expected message is %s (%d)", "awesome", 10) }.
+        to raise_exception(ArgumentError, "expected message is awesome (10)")
+    end
+
+
+    it "raises an ArgumentError when checking an argument expression that is false" do
+      expect { subject.check_argument(false) }.
+        to raise_exception ArgumentError
+    end
+
+    it "returns the expression result when expression is true" do
+      subject.check_argument(true).should == true
+    end
+
+    it "raises an ArgumentError when checking a block that yields false" do
+      expect { subject.check_block { false } }.
+        to raise_exception ArgumentError
+    end
+
+    it "returns the block evaluation result when evaluation is true" do
+      subject.check_block { true }.should == true
+    end
+
+    it "raises a TypeError when argument is not of required type" do
+      expect { subject.check_type(1, String) }.
+        to raise_exception TypeError
+    end
+
+    it "returns the argument in a type check when the type is equal" do
+      subject.check_type(1, Fixnum).should == 1
+    end
+
+    it "returns the argument in a type check when the type is compatible" do
+      subject.check_type(1, Integer).should == 1
+    end
+
+    it "raises a NameError when argument does not support requested method" do
+      expect { subject.check_responds_to(1, :no_such_method) }.
+        to raise_exception
+    end
+
+    it "returns the argument when it supports the requested method" do
+      subject.check_responds_to(1, :succ).should == 1
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'preconditions'
+
+# 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

data/test/helper.rb

@@ -0,0 +1,17 @@
+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 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'preconditions'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification 
+name: preconditions
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- tucker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-19 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  name: yard
+  prerelease: false
+  type: :development
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  name: bundler
+  prerelease: false
+  type: :development
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  name: jeweler
+  prerelease: false
+  type: :development
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rcov
+  prerelease: false
+  type: :development
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 2
+        - 6
+        - 0
+        version: 2.6.0
+  name: rspec
+  prerelease: false
+  type: :development
+  requirement: *id005
+description: |
+  The Preconditions library provides a simple set of methods for checking arguments being passed into a method.  Instead of writing custom checks and raising exceptions directly in your code you can use Preconditions to verify basic properties of your arguments (not-nil, satisfying a boolean expression, being of a certain type/duck-type) and raise the appropriate exception for you.
+
+email: tucker+rubygems@glyde.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- .document
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/preconditions.rb
+- spec/preconditions_spec.rb
+- spec/spec_helper.rb
+- test/helper.rb
+homepage: http://github.com/ctucker/preconditions
+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.7.2
+signing_key: 
+specification_version: 3
+summary: Preconditions checking support inspired by Guava
+test_files: 
+- spec/preconditions_spec.rb
+- spec/spec_helper.rb
+- test/helper.rb