simplecheck 0.9 → 1.0rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2b4972b81b875d8ee3c78f8cf807c36aeffb5f5d
-  data.tar.gz: 8a5397331cdce47a1dc42f8eb696d0cbc718b18d
+  metadata.gz: a928fd88137669a29e16e814e1d21af7e6403f3f
+  data.tar.gz: 547b3655c4efdbf9ab4e1ef019f51fcc224c537f
 SHA512:
-  metadata.gz: 99c1b54c9c1f3b319835e271ead32230fe82ac592896760841afe812fef13ec5a2f8c93397c1ed44ef78969eac362de415267778c6f89c23b39e0be0ea50445e
-  data.tar.gz: ef92f00f785240a4279a6888780a5426fa2b76424a35b8a7c7f4354c321349da3ba7e7453934b380cca20e2d5ea34a021a7e042529b81b0daf25b74558ce780f
+  metadata.gz: c77b199bbbc3308e07b0348f6f7c013cc473376b62930a715ba31b249cff9a55f291cfcb658d8c756c5f929abf0a63bd453f1524a85397619b20535ab98f9ea8
+  data.tar.gz: 1cb867dc97e7dba604956d0432198304990be0d0a024deca114350a47c263a75c41d1a38260ab3e663a133d2fdebcd0c9e00b84ef08eb548df6d8907b247bf3e

data/README.md

@@ -1,9 +1,9 @@
 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.
+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.
 
-If a check fails an exception of type `Simplecheck::CheckFailed` is raised.
+If a check fails a `Simplecheck::CheckFailed` exception is raised.
 
 Usage
 -----
@@ -37,15 +37,24 @@ Simplecheck currently supports three different check methods:
 
 ### Expression Check
 
-In the simplest case `check` takes an expression as an argument. If the expression evaluates to `nil` or `false` it will fail.
+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 )
+    def calculate_percentage( score, total )
+      check( total > 0 )
+      100.0 * score / total
+    end
 
 ### 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  `==`.
+    def greatest_common_divisor( a, b )
+      check( a, b, Numeric )
+      # 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
 
@@ -69,7 +78,7 @@ If a class does not alias or implement it's own version of `===` it has the same
 
 `===` is aliased to `call`: 
 
-    check( password, password_confirmation, lambda{ |pwd| !Dictionary.check( pwd )})
+    check( password, password_confirmation , ->(p){ !Dict.lookup( p )})
 
 #### Custom Check Object
 
@@ -84,7 +93,7 @@ For example to check whether a set of points is inside a given polygon we would
 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?
+      n.odd?
     end
 
 This is syntactic sugar for the Proc Case Equality check.
@@ -94,6 +103,11 @@ Multiple Arguments
 
 Case Equality and Block checks can be called with multiple arguments, with each argument being checked individually against the condition:
 
+    check( i, j, k, Integer ) 
+    check( a, b, c ) do |n|
+      n.even?
+    end
+
 License
 -------
 Simplecheck is released under the BSD License.

data/examples/argument_example.rb

@@ -1,4 +1,5 @@
 require 'simplecheck'
+
 include Simplecheck
 
 check( 1.odd? )

data/examples/block_example.rb

@@ -1,4 +1,5 @@
 require 'simplecheck'
+
 include Simplecheck
 
 # Block passed implicitly to check

data/examples/case_equality_check.rb

@@ -1,4 +1,5 @@
 require 'simplecheck'
+
 include Simplecheck
 
 # Class#=== -> Class#kind_of?

data/lib/simplecheck.rb

@@ -4,55 +4,40 @@ require 'simplecheck/check_failed'
 module Simplecheck
   def check( *arguments, &block )
     error_message = if block_given?
-                      __check_arguments_with_block( arguments, block )
+                      Simplecheck.check_arguments_with_block( arguments, block )
                     else
-                      __check_arguments( arguments )
+                      Simplecheck.check_arguments( arguments )
                     end
 
-    if error_message
-      __handle_failure( error_message )
-    else
-      __handle_return_arguments( arguments )
-    end
+    error_message ?  Simplecheck.handle_failure( error_message ) : true
   end
 
-
-  private
-  def __check_arguments( arguments )
+  def Simplecheck.check_arguments( arguments )
     case arguments.size
     when 1
-      __check_expression( arguments[ 0 ])
+      Simplecheck.check_expression( arguments[ 0 ])
     else
-      __check_case_equality( *arguments )
+      Simplecheck.check_case_equality( *arguments )
     end
   end
 
-  def __check_arguments_with_block( arguments, block )
-    __check_arguments(( arguments + [ block ]))
+  def Simplecheck.check_arguments_with_block( arguments, block )
+    Simplecheck.check_arguments(( arguments + [ block ]))
   end
 
-  def __check_expression( expression )
+  def Simplecheck.check_expression( expression )
     if !expression
-      'Condition is not true' 
+      'Condition is not satisfied' 
     end
   end
 
-  def __check_case_equality( *arguments, receiver )
-    if invalid_argument = arguments.find{ |argument| !( receiver === argument )}
-      "#{ invalid_argument } does not satisfy #{ receiver }" 
+  def Simplecheck.check_case_equality( *arguments, check_argument )
+    if invalid_argument = arguments.find{ |argument| !( check_argument === argument )}
+      "#{ invalid_argument } does not satisfy #{ check_argument }" 
     end
   end
 
-  def __handle_failure( message )
+  def Simplecheck.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/version.rb

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

data/simplecheck.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['Farrel Lifson']
   s.email       = ['farrel.lifson@aimred.com']
-  s.homepage    = 'http://www.aimred.com/projects/simplecheck'
+  s.homepage    = 'http://github.com/farrel/simplecheck'
   s.summary     = 'Simple property checking for Ruby'
   s.description = 'Simple property checking for Ruby'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simplecheck
 version: !ruby/object:Gem::Version
-  version: '0.9'
+  version: 1.0rc1
 platform: ruby
 authors:
 - Farrel Lifson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-04 00:00:00.000000000 Z
+date: 2013-11-08 00:00:00.000000000 Z
 dependencies: []
 description: Simple property checking for Ruby
 email:
@@ -33,7 +33,7 @@ files:
 - simplecheck.gemspec
 - test/simplecheck_test.rb
 - test/test_helper.rb
-homepage: http://www.aimred.com/projects/simplecheck
+homepage: http://github.com/farrel/simplecheck
 licenses: []
 metadata: {}
 post_install_message: 
@@ -47,9 +47,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: rcap
 rubygems_version: 2.0.3