preconditions 0.2.0 → 0.2.1

data/README.md

@@ -38,17 +38,17 @@ To use the fluent DSL API use the `check(arg).is {}` form like so:
     end
 
 Note that there is less opportunity for custom messaging in the fluent API.  However, a second argument to `check` can
-be supplied to add the argument name to any raised errors:
+be supplied to add the argument name to any raised errors, or one can use the `#named` method to supply a name:
 
     class MyMath
       def sqrt(num)
-        Preconditions.check(num, 'num') { is_not_nil and has_type(Integer) and satisfies(">= 0") { arg >= 0 } }
+        Preconditions.check(num).named('num') { is_not_nil and has_type(Integer) and satisfies(">= 0") { arg >= 0 } }
         num.sqrt
       end
     end
 
-In this case, if `num` is the value -10 then an [ArgumentError] will be raised with a message along the lines of
-"Argument 'num' must be >= 0, but was -10".
+In this case, if `num` is the value -10 then an `ArgumentError` will be raised with a message along the lines of
+`"Argument 'num' must be >= 0, but was -10"`.
 
 The set of available checks is documented in the `ConditionChecker` documentation.
 

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/lib/condition_checker.rb

@@ -13,6 +13,20 @@ class ConditionChecker
     @name = name
   end
 
+  # Set the name of the argument being checked
+  # @param name [String] the name of the parameter being checked
+  # @return argument if a block is given to evaluate, or self if not to allow for further method chaining
+  # @raises if a block is given and the validation rules specified therein are not met
+  def named(name, &block)
+    @name = name
+    if block_given?
+      instance_eval(&block)
+      arg
+    else
+      self
+    end
+  end
+
   # DSL call.  Establishes that the checked argument is non-nil.
   # @raises [ArgumentError] if the argument is nil
   # @return true

data/lib/preconditions.rb

@@ -97,8 +97,10 @@ module Preconditions
       cc = ConditionChecker.new(argument, name)
       if block_given?
         cc.instance_eval(&block)
+        argument # return the argument if a block is given to evaluate the check immediately
+      else
+        cc # return the checker if no evaluation block is supplied
       end
-      argument
     end
   end
 

data/preconditions.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{preconditions}
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{tucker}]
-  s.date = %q{2011-05-24}
+  s.date = %q{2011-05-25}
   s.description = %q{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.
 }
   s.email = %q{tucker+rubygems@glyde.com}

data/spec/preconditions_dsl_spec.rb

@@ -56,4 +56,11 @@ describe "dsl expression" do
     }.to raise_exception(ArgumentError, "Argument 'x' must be less than zero")
   end
 
+  it "should allow for name specification using the 'named' method" do
+    x = 1
+    expect {
+      Preconditions.check(x).named('x') { is_not_nil and satisfies("<= 0") { x <= 0 } }
+    }.to raise_exception(ArgumentError, "Argument 'x' must be <= 0")
+  end
+
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: preconditions
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - tucker
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-24 00:00:00 Z
+date: 2011-05-25 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   version_requirements: &id001 !ruby/object:Gem::Requirement