simplecheck 1.0 → 2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc468c54a4b799857823419a0492b16f088f011a
-  data.tar.gz: 66bb8cfc8196b4dbdfd00ef2a6eca8b336c10dbb
+  metadata.gz: 3b05cb2a1bd9000b3dc9519a7dff8980a8938614
+  data.tar.gz: 9a35961dc01ebb3d95620f2ed58bdfe352a5bf33
 SHA512:
-  metadata.gz: 7a9ab02843cee5155e667f91f83b0f16942eff1f94becc5e5449ca6eebb654a05fcb28ec9f2a4ec304e29011557cafef28f04fd95e703f79b8c68e60cd63b68b
-  data.tar.gz: 22207c8cccd871e1dd158f520172cd5dfcedfa658a7059476d0ba3b110736b71ff65a6feb6dd1f521cfb181b9b7d13c17262de4d34ea67e770e7cbcbf28b8ee4
+  metadata.gz: 6e1b11ae24ff312d64482ee9b47f82ec06a548afddec64f791149d5bc58ea6e346a282b141bdde1d99d265c2778c66066f9c46758b6c514ecf15082f95e8457c
+  data.tar.gz: d5cd76cbfa5e7b90ac354ba3c2b248dcaa3acd8b397c285b7187df97d641851bcdc6628a1295685e3f60bbb74dc3b11c878fee99ce7d5d476c9247c5d8a60829

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Changelog
 =========
 
+2.0
+---
+* Custom error messages
+* Fixed checks with nil argument
+
 1.0
 ---
 * Initial release

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright 2013 AIMRED CC. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* 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 BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 HOLDER 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/README.md

@@ -1,9 +1,11 @@
 # Simplecheck
 
-Simplecheck is a lightweight property checking API for Ruby designed to quickly check arguments. Once included into a class it provides the `check` instance method which takes arguments and a condition to check them against.
+Simplecheck is a lightweight property checking API for Ruby designed to quickly check arguments in under 50 lines of Ruby. Once included into a class it provides the `check` instance method which takes arguments and a condition to check them against.
 
 If a check fails a `Simplecheck::CheckFailed` exception is raised.
 
+Simplecheck is compatiable with Ruby 2.0.0 and above only.
+
 ## Installation
 
 Simplecheck is available as a Rubygem installable via [gem install simplecheck](http://rubygems.org/gems/simplecheck).
@@ -20,16 +22,26 @@ A git repository is also available at [http://github.com/farrel/simplecheck](htt
       attr_accessor( :name, :age )
 
       def initialize( name, age )
-        check( name, String ) # Check name is String
-        check( age, 18..75 )  # Check age is within Range
+        check(name, String, error_message: 'name must be a String') # Check name is String with custom error message
+        check(age, 18..75)                                          # Check age is within Range
     
         @name, @age = name, age
       end
     end
     
-    Customer.new( "Joe", 25 ) # No error
-    Customer.new( nil, 25 )   rescue puts "Name can not be nil"
-    Customer.new( "Joe", 15 ) rescue puts "Age is out of range"
+    Customer.new("Joe", 25) # No error
+
+    begin
+      Customer.new(nil, 25)
+    rescue Simplecheck::CheckFailed => exception
+      puts exception.message # => 'name must be a String'  
+    ebd
+
+    begin 
+      Customer.new("Joe", 15) 
+    rescue Simplecheck::CheckFailed => exception
+      puts exception.message # => '15 does not satisfy 18..75'
+    ebd
 
 ## Check Methods
 
@@ -39,12 +51,18 @@ Simplecheck currently supports three different check methods:
 * Case Equality (===) Check 
 * Block Check
 
+### Custom Error Message
+
+All check methods may take an optional named parameter `error_message` to override the default error message.
+
+    check(age, Integer, error_message: 'Age must be an whole number')
+
 ### Expression Check
 
 In the simplest case `check` takes an expression as an argument. If the expression evaluates to `nil` or `false` it will fail. 
 
     def calculate_percentage( score, total )
-      check( total > 0 )
+      check(total > 0)
       100.0 * score / total
     end
 
@@ -52,37 +70,36 @@ In the simplest case `check` takes an expression as an argument. If the expressi
 
 If two or more arguments are given without a block, then the last argument becomes the condition against which the previous arguments are checked. To accomplish this the condition argument should implement the case equality operator (`===` or threequal) in a logical manner.
 
-    def greatest_common_divisor( a, b )
-      check( a, b, Integer )
+    def greatest_common_divisor(a, b)
+      check(a, b, Integer)
       # GCD Algorithm...
     end
 
 If a class does not alias or implement it's own version of `===` it has the same functionality as  `==`. The following Ruby Core classes already alias `===` to various instance methods.
 
-
 #### Class
 
 `===` is aliased to `kind_of?`:
 
-    check( age, Numeric )
+    check(age, Numeric)
 
 #### Range
 
 `===` is aliased to `include?`:
 
-    check( age, 18..75 ) 
+    check(age, 18..75) 
 
 #### Regexp
 
-`===` is aliased to `match`:
+`===` is aliased to `=~`:
 
-    check( phone_number, /^\d\d\d-\d\d\d\d$/ )
+    check(phone_number, /^\d\d\d-\d\d\d\d$/)
 
 #### Proc
 
 `===` is aliased to `call`: 
 
-    check( password, password_confirmation , ->(p){ !Dict.lookup( p )})
+    check(password, password_confirmation , ->(p) { !Dict.lookup(p) })
 
 #### Custom Check Object
 
@@ -90,13 +107,13 @@ The default behaviour of `Object#===` is the same as `Object#==`. To customise t
 
 For example to check whether a set of points is inside a given polygon we would implement `Polygon#===` as a [point-in-polygon algorithm](https://en.wikipedia.org/wiki/Point_in_polygon), allowing us to carry out the check using a Polygon instance:
 
-    check( point_1, point_2, polygon )
+    check(point_1, point_2, polygon)
 
 ### Block Check
 
 A block can be passed to `check`, with the arguments passed to `check` then passed individually to the block:
 
-    check( a, b, c ) do |n|
+    check(a, b, c) do |n|
       n.odd?
     end
 
@@ -115,18 +132,3 @@ Case Equality and Block checks can be called with multiple arguments, with each
 
 * Git repository - [http://github.com/farrel/simplecheck](http://github.com/farrel/simplecheck)
 * Rubygem page - [http://rubygems.org/gems/simplecheck](http://rubygems.org/gems/simplecheck)
-
-## License
-Simplecheck is released under the BSD License.
-
-Copyright 2013 AIMRED CC. 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 BY AIMRED CC "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 AIMRED CC 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.
-
-The views and conclusions contained in the software and documentation are those of the authors and should not be interpreted as representing official policies, either expressed or implied, of AIMRED CC.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test:lib'
+  t.pattern = "test/*_test.rb"
+end
+
+task default: :test

data/examples/argument_example.rb

@@ -2,8 +2,8 @@ require 'simplecheck'
 
 include Simplecheck
 
-check( 1.odd? )
-check( 5 > 2 )
-check( [ 1, 2, 3 ].include?( 2 ))
+check(1.odd?)
+check(5 > 2)
+check([1, 2, 3].include?(2))
 
-puts "All passed"
+puts 'All passed'

data/examples/block_example.rb

@@ -3,10 +3,10 @@ require 'simplecheck'
 include Simplecheck
 
 # Block passed implicitly to check
-check( 2, 4 ){ |x| x.even? }
+check(2, 4) { |x| x.even? }
 
 # Block passed explicity to check
-is_even = lambda{ |x| x.even? } 
-check( 2, 4, &is_even  )
+is_even = ->(x) { x.even? }
+check(2, 4, &is_even)
 
-puts "All passed"
+puts 'All passed'

data/examples/case_equality_check.rb

@@ -3,15 +3,15 @@ require 'simplecheck'
 include Simplecheck
 
 # Class#=== -> Class#kind_of?
-check( 1, Integer )
+check(1, Integer)
 
 # Regexp#=== -> Regexp#match
-check( 'aaabbb', /^aaa/ )
+check('aaabbb', /^aaa/)
 
 # Range#=== -> Range#include?
-check( 1, 1..10 )
+check(1, 1..10)
 
 # Proc#=== -> Proc#call
-check( 1, ->(n){ n.odd? })
+check(1, ->(n) { n.odd? })
 
-puts "All passed"
+puts 'All passed'

data/examples/person_example.rb

@@ -5,51 +5,45 @@ class Person
   include Simplecheck
   include Comparable
 
-  attr_accessor( :name, :surname, :date_of_birth )
+  attr_accessor :name, :surname, :date_of_birth 
 
-  def initialize( name, surname, date_of_birth )
-    check( name, surname, String )
-    check( date_of_birth, Date )
+  def initialize(name, surname, date_of_birth)
+    check name, surname, String
+    check date_of_birth, Date
 
     @name          = name
     @surname       = surname
     @date_of_birth = date_of_birth
   end
 
-  def <=>( person )
-    check( person, Person )
-    check( person.date_of_birth )
+  def <=>(other)
+    check other, Person
+    check other.date_of_birth
 
-    self.date_of_birth <=> person.date_of_birth
+    date_of_birth <=> other.date_of_birth
   end
 end
 
 def try
-  begin
-    yield
-  rescue Simplecheck::CheckFailed => exception
-    puts "Check Failed: #{ exception.message }"
-  rescue => exception
-    puts "EXCEPTION: #{ exception.message }"
-  end
+  yield
+rescue Simplecheck::CheckFailed => exception
+  puts "Simplecheck::CheckFailed: #{ exception.message }"
 end
 
 # date_of_birth is not a Date
-try{ Person.new( 'Bob', 'Roberts', '1980-01-01' )} 
+try { Person.new('Bob', 'Roberts', '1980-01-01') }
 
-bob = Person.new( 'Bob', 'Roberts', Date.civil( 1970, 1, 1 )) 
-joe = Person.new( 'Joe', 'Josephs', Date.civil( 1980, 1, 1 ))
+bob = Person.new('Bob', 'Roberts', Date.civil(1970, 1, 1))
+joe = Person.new('Joe', 'Josephs', Date.civil(1980, 1, 1))
 
 # 1 is not a Person
-try{ bob > 1 }
+try { bob > 1 }
 
-if joe > bob
-  puts "Joe > Bob"
-end
+puts 'Joe > Bob' if joe > bob
 
 bob.date_of_birth = nil
 
 # date_of_birth is not present
-try{ joe > bob }
+try { joe > bob }
 
-puts "Finished"
+puts 'Finished'

data/lib/simplecheck.rb

@@ -2,42 +2,42 @@ require 'simplecheck/version'
 require 'simplecheck/check_failed'
 
 module Simplecheck
-  def check( *arguments, &block )
-    error_message = if block_given?
-                      Simplecheck.check_arguments_with_block( arguments, block )
-                    else
-                      Simplecheck.check_arguments( arguments )
-                    end
-
-    error_message ?  Simplecheck.handle_failure( error_message ) : true
+  def check(*arguments, error_message: nil, &block)
+    default_error_message = if block_given?
+                              Simplecheck.check_arguments_with_block(arguments, block)
+                            else
+                              Simplecheck.check_arguments(arguments)
+                            end
+    
+    default_error_message ?  Simplecheck.handle_failure(error_message || default_error_message) : true
   end
 
-  def Simplecheck.check_arguments( arguments )
+  def self.check_arguments(arguments)
     case arguments.size
     when 1
-      Simplecheck.check_expression( arguments[ 0 ])
+      check_expression(arguments[0])
     else
-      Simplecheck.check_case_equality( *arguments )
+      check_case_equality(*arguments)
     end
   end
 
-  def Simplecheck.check_arguments_with_block( arguments, block )
-    Simplecheck.check_arguments(( arguments + [ block ]))
+  def self.check_arguments_with_block(arguments, block)
+    check_arguments(arguments + [block])
   end
 
-  def Simplecheck.check_expression( expression )
-    if !expression
-      'Condition is not satisfied' 
-    end
+  def self.check_expression(expression_satisfied)
+    'Condition is not satisfied' unless expression_satisfied
   end
 
-  def Simplecheck.check_case_equality( *arguments, check_argument )
-    if invalid_argument = arguments.find{ |argument| !( check_argument === argument )}
-      "#{ invalid_argument } does not satisfy #{ check_argument }" 
+  def self.check_case_equality(*arguments, check_argument)
+    invalid_argument_index = arguments.index{ |argument| !(check_argument === argument) }
+
+    if invalid_argument_index
+      "#{ arguments[invalid_argument_index] } does not satisfy #{ check_argument }"
     end
   end
 
-  def Simplecheck.handle_failure( message )
-    raise Simplecheck::CheckFailed.new( message )
+  def self.handle_failure(message)
+    fail(Simplecheck::CheckFailed, message)
   end
 end

data/lib/simplecheck/check_failed.rb

@@ -1,3 +1,3 @@
 module Simplecheck
-   class CheckFailed < StandardError; end
+  class CheckFailed < StandardError; end
 end

data/lib/simplecheck/version.rb

@@ -1,3 +1,3 @@
 module Simplecheck
-  VERSION = '1.0'
+  VERSION = '2.0'
 end

data/simplecheck.gemspec

@@ -3,17 +3,17 @@ $:.unshift File.expand_path('../lib', __FILE__)
 require 'simplecheck/version'
 
 Gem::Specification.new do |s|
-  s.name        = 'simplecheck'
-  s.version     = Simplecheck::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ['Farrel Lifson']
-  s.email       = ['farrel.lifson@aimred.com']
-  s.homepage    = 'http://github.com/farrel/simplecheck'
-  s.summary     = 'Simple property checking for Ruby'
-  s.description = 'Simple property checking for Ruby'
-
-  s.rubyforge_project = 'rcap'
-
+  s.name                  = 'simplecheck'
+  s.version               = Simplecheck::VERSION
+  s.platform              = Gem::Platform::RUBY
+  s.authors               = ['Farrel Lifson']
+  s.email                 = ['farrel.lifson@aimred.com']
+  s.homepage              = 'http://github.com/farrel/simplecheck'
+  s.summary               = 'Simple property checking for Ruby'
+  s.description           = 'Simple property checking for Ruby'
+  s.license               = 'BSD 2-Clause'
+  s.required_ruby_version = '>= 2.0.0'
+  
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- test/*`.split("\n")
   s.require_paths = ['lib']

data/test/simplecheck_test.rb

@@ -4,58 +4,97 @@ class TestSimplecheck < MiniTest::Test
   include Simplecheck
 
   def test_expression_check_true
-    assert( check( 1 ))
+    assert(check(1))
   end
 
   def test_expression_check_raises_exception
-    assert_raises( Simplecheck::CheckFailed ){ check( nil )}
+    assert_raises(Simplecheck::CheckFailed) { check(nil) }
+  end
+
+  def test_expression_check_raises_exception_with_error_message
+    exception = assert_raises(Simplecheck::CheckFailed) { check(nil, error_message: 'Nil object') }
+    assert_equal(exception.message, 'Nil object')
   end
 
   def test_case_equality_check_true
-    assert( check( 1, Integer ))
+    assert(check(1, Integer))
   end
 
   def test_case_equality_check_raises_exception
-    assert_raises( Simplecheck::CheckFailed ){ check( '1', Integer )}
+    assert_raises(Simplecheck::CheckFailed) { check('1', Integer) }
+  end
+
+  def test_case_equality_check_raises_exception_with_error_message
+    exception = assert_raises(Simplecheck::CheckFailed) { check('1', Integer, error_message: 'Not Integer') }
+    assert_equal(exception.message, 'Not Integer')
   end
 
   def test_case_equality_check_multiple_arguments
-    assert( check( 1, 2, Integer ))
+    assert(check(1, 2, Integer))
   end
 
   def test_case_equality_check_multiple_arguments_raises_exception
-    assert_raises( Simplecheck::CheckFailed ){ check( 1, '2', Integer )}
+    assert_raises(Simplecheck::CheckFailed) { check(1, '2', Integer) }
+  end
+
+  def test_case_equality_check_multiple_arguments_raises_exception_with_error_message
+    exception = assert_raises(Simplecheck::CheckFailed) { check(1, '2', Integer, error_message: 'Not Integer') }
+    assert_equal(exception.message, 'Not Integer')
   end
 
   def test_block_check_true
-    assert( check( 1 ){ |n| n.odd? }) 
+    assert(check(1) { |n| n.odd? })
   end
 
   def test_block_check_raises_exception
-    assert_raises( Simplecheck::CheckFailed ){ check( 1 ){ |n| n.even? }}
+    assert_raises(Simplecheck::CheckFailed) { check(1) { |n| n.even? } }
+  end
+
+  def test_block_check_raises_exception_with_error_message
+    exception = assert_raises(Simplecheck::CheckFailed) { check(1, error_message: 'Not Even') { |n| n.even? } }
+    assert_equal(exception.message, 'Not Even')
   end
 
   def test_block_check_multiple_arguments_true
-    assert( check( 1, 1, 1 ){ |n| n.odd? })
+    assert(check(1, 1, 1) { |n| n.odd? })
   end
 
   def test_block_check_multiple_arguments_exception
-    assert_raises( Simplecheck::CheckFailed ){ check( 1, 1, 2 ){ |n| n.odd? }}
+    assert_raises(Simplecheck::CheckFailed) { check(1, 1, 2) { |n| n.odd? } }
+  end
+
+  def test_block_check_multiple_arguments_exception_with_error_message
+    exception = assert_raises(Simplecheck::CheckFailed) { check(1, 1, 2, error_message: 'Not Odd') { |n| n.odd? } }
+    assert_equal(exception.message, 'Not Odd')
   end
 
   def test_lambda_argument_check_true
-    assert( check( 1, ->(n){ n.odd? }))
+    assert(check(1, ->(n) { n.odd? }))
   end
 
   def test_lambda_argument_check_raises_exception
-    assert_raises( Simplecheck::CheckFailed ){ check( 2, ->(n){ n.odd? })}
+    assert_raises(Simplecheck::CheckFailed) { check(1, ->(n) { n.even? }) }
+  end
+
+  def test_lambda_argument_check_raises_exception_with_error_message
+    exception = assert_raises(Simplecheck::CheckFailed) { check(1, ->(n) { n.even? }, error_message: 'Not Even') }
+    assert_equal(exception.message, 'Not Even')
   end
 
   def test_lambda_block_check_true
-    assert( check( 1, &->(n){ n.odd? }))
+    assert(check(1, &->(n){ n.odd? }))
   end
 
   def test_lambda_block_check_raises_exception
-    assert_raises( Simplecheck::CheckFailed ){ check( 2, &->(n){ n.odd? })}
+    assert_raises(Simplecheck::CheckFailed) { check(1, &->(n){ n.even? }) }
+  end
+
+  def test_lambda_block_check_raises_exception_with_error_message
+    exception = assert_raises(Simplecheck::CheckFailed) { check(1, error_message: 'Not Even', &->(n){ n.even? }) }
+    assert_equal(exception.message, 'Not Even')
+  end
+
+  def test_nil_check
+    assert_raises(Simplecheck::CheckFailed) { check(nil, String) }
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simplecheck
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: '2.0'
 platform: ruby
 authors:
 - Farrel Lifson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-12 00:00:00.000000000 Z
+date: 2014-06-18 00:00:00.000000000 Z
 dependencies: []
 description: Simple property checking for Ruby
 email:
@@ -19,10 +19,12 @@ extra_rdoc_files:
 - README.md
 - CHANGELOG.md
 files:
-- .gitignore
+- ".gitignore"
 - CHANGELOG.md
 - Guardfile
+- LICENSE
 - README.md
+- Rakefile
 - examples/argument_example.rb
 - examples/block_example.rb
 - examples/case_equality_check.rb
@@ -34,7 +36,8 @@ files:
 - test/simplecheck_test.rb
 - test/test_helper.rb
 homepage: http://github.com/farrel/simplecheck
-licenses: []
+licenses:
+- BSD 2-Clause
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -42,17 +45,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: rcap
-rubygems_version: 2.0.3
+rubyforge_project: 
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Simple property checking for Ruby