simplecheck 0.9

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2b4972b81b875d8ee3c78f8cf807c36aeffb5f5d
+  data.tar.gz: 8a5397331cdce47a1dc42f8eb696d0cbc718b18d
+SHA512:
+  metadata.gz: 99c1b54c9c1f3b319835e271ead32230fe82ac592896760841afe812fef13ec5a2f8c93397c1ed44ef78969eac362de415267778c6f89c23b39e0be0ea50445e
+  data.tar.gz: ef92f00f785240a4279a6888780a5426fa2b76424a35b8a7c7f4354c321349da3ba7e7453934b380cca20e2d5ea34a021a7e042529b81b0daf25b74558ce780f

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.ruby-version
+doc/
+.yardoc

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+Changelog
+=========
+
+1.0
+---
+* Initial release
+* Expression, Case Equality and Block checks

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+notification( :terminal_title )
+
+guard( :minitest, include: [ 'lib' ]) do
+  watch( 'test/simplecheck_test.rb' )
+  watch( 'lib/simplecheck.rb' ){ 'test/simplecheck_test.rb' }
+end

data/README.md

@@ -0,0 +1,111 @@
+Simplecheck
+===========
+
+Simplecheck is a property checking API for Ruby designed for quickly checking arguments. Once included into a class it provides the `check` instance method which takes a list of arguments and a condition to check them against.
+
+If a check fails an exception of type `Simplecheck::CheckFailed` is raised.
+
+Usage
+-----
+
+    require 'simplecheck'
+
+    class Person
+      include Simplecheck
+
+      def initialize( name, age )
+        check( name )         # Check name is not nil
+        check( age, 18..75 )  # Check age is within range
+    
+        @name = name
+        @age = age
+      end
+    end
+    
+    Person.new( "Joe", 25 ) # No error
+    Person.new( nil, 25 )   rescue puts "Name can not be nil"
+    Person.new( "Joe", 15 ) rescue puts "Age is out of range"
+
+Check Methods
+-------------
+
+Simplecheck currently supports three different check methods:
+
+* Expression Check
+* Case Equality (===) Check 
+* Block Check
+
+### Expression Check
+
+In the simplest case `check` takes an expression as an argument. If the expression evaluates to `nil` or `false` it will fail.
+
+    check( a > 2 )
+
+### Case Equality (===) Check
+
+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.
+
+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. If a class does not alias or implement it's own version of `===` it has the same functionality as  `==`.
+
+#### Class
+
+`===` is aliased to `kind_of?`:
+
+    check( age, Numeric )
+
+#### Range
+
+`===` is aliased to `include?`:
+
+    check( age, 18..75 ) 
+
+#### Regexp
+
+`===` is aliased to `match`:
+
+    check( phone_number, /^\d\d\d-\d\d\d\d$/ )
+
+#### Proc
+
+`===` is aliased to `call`: 
+
+    check( password, password_confirmation, lambda{ |pwd| !Dictionary.check( pwd )})
+
+#### Custom Check Object
+
+The default behaviour of `Object#===` is the same as `Object#==`. To customise the behaviour implement your own `Object#===` method.
+
+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 )
+
+### 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|
+      n.modulo?(2).zero?
+    end
+
+This is syntactic sugar for the Proc Case Equality check.
+
+Multiple Arguments
+------------------
+
+Case Equality and Block checks can be called with multiple arguments, with each argument being checked individually against the condition:
+
+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/examples/argument_example.rb

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

data/examples/block_example.rb

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

data/examples/case_equality_check.rb

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

data/examples/person_example.rb

@@ -0,0 +1,53 @@
+require 'date'
+require 'simplecheck'
+
+class Person
+  include Simplecheck
+  include Comparable
+
+  attr_accessor( :name, :surname, :date_of_birth )
+
+  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 )
+
+    self.date_of_birth <=> person.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
+end
+
+# date_of_birth is not a Date
+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 ))
+
+# 1 is not a Person
+try{ bob > 1 }
+
+if joe > bob
+  puts "Joe > Bob"
+end
+
+bob.date_of_birth = nil
+
+# date_of_birth is not present
+try{ joe > bob }

data/lib/simplecheck.rb

@@ -0,0 +1,58 @@
+require 'simplecheck/version'
+require 'simplecheck/check_failed'
+
+module Simplecheck
+  def check( *arguments, &block )
+    error_message = if block_given?
+                      __check_arguments_with_block( arguments, block )
+                    else
+                      __check_arguments( arguments )
+                    end
+
+    if error_message
+      __handle_failure( error_message )
+    else
+      __handle_return_arguments( arguments )
+    end
+  end
+
+
+  private
+  def __check_arguments( arguments )
+    case arguments.size
+    when 1
+      __check_expression( arguments[ 0 ])
+    else
+      __check_case_equality( *arguments )
+    end
+  end
+
+  def __check_arguments_with_block( arguments, block )
+    __check_arguments(( arguments + [ block ]))
+  end
+
+  def __check_expression( expression )
+    if !expression
+      'Condition is not true' 
+    end
+  end
+
+  def __check_case_equality( *arguments, receiver )
+    if invalid_argument = arguments.find{ |argument| !( receiver === argument )}
+      "#{ invalid_argument } does not satisfy #{ receiver }" 
+    end
+  end
+
+  def __handle_failure( message )
+    raise Simplecheck::CheckFailed.new( message )
+  end
+
+  def __handle_return_arguments( arguments )
+    case arguments.size
+    when 1
+      arguments[0]
+    else
+      arguments
+    end
+  end
+end

data/lib/simplecheck/check_failed.rb

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

data/lib/simplecheck/version.rb

@@ -0,0 +1,3 @@
+module Simplecheck
+  VERSION = '0.9'
+end

data/simplecheck.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.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://www.aimred.com/projects/simplecheck'
+  s.summary     = 'Simple property checking for Ruby'
+  s.description = 'Simple property checking for Ruby'
+
+  s.rubyforge_project = 'rcap'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- test/*`.split("\n")
+  s.require_paths = ['lib']
+
+  s.extra_rdoc_files = ['README.md','CHANGELOG.md']
+end

data/test/simplecheck_test.rb

@@ -0,0 +1,98 @@
+require 'test_helper'
+
+class Foo
+  include Simplecheck
+
+  def expression_check( a )
+    check( a )
+  end
+
+  def case_equality_check( a )
+    check( a, Integer )
+  end
+
+  def case_equality_check_multiple_arguments( *arguments )
+    check( *arguments, Integer )
+  end
+
+  def block_check( a )
+    check( a ){ |x| x.modulo( 2 ).zero? }
+  end
+
+  def block_check_multiple_arguments( a, b, c )
+    check( a, b, c ){ |x| x.even? }
+  end
+
+  def lambda_argument_check( a )
+    check_lambda = lambda{ |x| x.even? }
+    check( a, check_lambda ) 
+  end
+
+  def lambda_block_check( a )
+    check_lambda = lambda{ |x| x.even? }
+    check( a, &check_lambda ) 
+  end
+end
+
+class TestSimplecheck < MiniTest::Test
+
+  def setup
+    @foo = Foo.new
+  end
+
+  def test_expression_check_true
+    assert( @foo.expression_check( 1 ))
+  end
+
+  def test_expression_check_raises_exception
+    assert_raises( Simplecheck::CheckFailed ){ @foo.expression_check( nil )}
+  end
+
+  def test_case_equality_check_true
+    assert( @foo.case_equality_check( 1 ))
+  end
+
+  def test_case_equality_check_raises_exception
+    assert_raises( Simplecheck::CheckFailed ){ @foo.case_equality_check( '1' )}
+  end
+
+  def test_case_equality_check_multiple_arguments
+    assert( @foo.case_equality_check_multiple_arguments( 1, 2 ))
+  end
+
+  def test_case_equality_check_multiple_arguments_raises_exception
+    assert_raises( Simplecheck::CheckFailed ){ @foo.case_equality_check_multiple_arguments( 1, '2' )}
+  end
+
+  def test_block_check_true
+    assert( @foo.block_check( 2 )) 
+  end
+
+  def test_block_check_raises_exception
+    assert_raises( Simplecheck::CheckFailed ){ @foo.block_check( 1 )}
+  end
+
+  def test_block_check_multiple_arguments_true
+    assert( @foo.block_check_multiple_arguments( 2, 2, 2 ))
+  end
+
+  def test_block_check_multiple_arguments_exception
+    assert_raises( Simplecheck::CheckFailed ){ @foo.block_check_multiple_arguments( 2, 2, 1 )}
+  end
+
+  def test_lambda_argument_check_true
+    assert( @foo.lambda_argument_check( 2 ))
+  end
+
+  def test_lambda_argument_check_raises_exception
+    assert_raises( Simplecheck::CheckFailed ){ @foo.lambda_argument_check( 1 )}
+  end
+
+  def test_lambda_block_check_true
+    assert( @foo.lambda_block_check( 2 ))
+  end
+
+  def test_lambda_block_check_raises_exception
+    assert_raises( Simplecheck::CheckFailed ){ @foo.lambda_block_check( 1 )}
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'minitest/autorun'
+require 'simplecheck'

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: simplecheck
+version: !ruby/object:Gem::Version
+  version: '0.9'
+platform: ruby
+authors:
+- Farrel Lifson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-04 00:00:00.000000000 Z
+dependencies: []
+description: Simple property checking for Ruby
+email:
+- farrel.lifson@aimred.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+files:
+- .gitignore
+- CHANGELOG.md
+- Guardfile
+- README.md
+- examples/argument_example.rb
+- examples/block_example.rb
+- examples/case_equality_check.rb
+- examples/person_example.rb
+- lib/simplecheck.rb
+- lib/simplecheck/check_failed.rb
+- lib/simplecheck/version.rb
+- simplecheck.gemspec
+- test/simplecheck_test.rb
+- test/test_helper.rb
+homepage: http://www.aimred.com/projects/simplecheck
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: rcap
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Simple property checking for Ruby
+test_files:
+- test/simplecheck_test.rb
+- test/test_helper.rb
+has_rdoc: