simplecheck 1.0rc1 → 1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a928fd88137669a29e16e814e1d21af7e6403f3f
-  data.tar.gz: 547b3655c4efdbf9ab4e1ef019f51fcc224c537f
+  metadata.gz: fc468c54a4b799857823419a0492b16f088f011a
+  data.tar.gz: 66bb8cfc8196b4dbdfd00ef2a6eca8b336c10dbb
 SHA512:
-  metadata.gz: c77b199bbbc3308e07b0348f6f7c013cc473376b62930a715ba31b249cff9a55f291cfcb658d8c756c5f929abf0a63bd453f1524a85397619b20535ab98f9ea8
-  data.tar.gz: 1cb867dc97e7dba604956d0432198304990be0d0a024deca114350a47c263a75c41d1a38260ab3e663a133d2fdebcd0c9e00b84ef08eb548df6d8907b247bf3e
+  metadata.gz: 7a9ab02843cee5155e667f91f83b0f16942eff1f94becc5e5449ca6eebb654a05fcb28ec9f2a4ec304e29011557cafef28f04fd95e703f79b8c68e60cd63b68b
+  data.tar.gz: 22207c8cccd871e1dd158f520172cd5dfcedfa658a7059476d0ba3b110736b71ff65a6feb6dd1f521cfb181b9b7d13c17262de4d34ea67e770e7cbcbf28b8ee4

data/README.md

@@ -1,33 +1,37 @@
-Simplecheck
-===========
+# 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.
 
 If a check fails a `Simplecheck::CheckFailed` exception is raised.
 
-Usage
------
+## Installation
+
+Simplecheck is available as a Rubygem installable via [gem install simplecheck](http://rubygems.org/gems/simplecheck).
+
+A git repository is also available at [http://github.com/farrel/simplecheck](http://github.com/farrel/simplecheck).
+
+## Usage
 
     require 'simplecheck'
 
-    class Person
+    class Customer
       include Simplecheck
+      
+      attr_accessor( :name, :age )
 
       def initialize( name, age )
-        check( name )         # Check name is not nil
-        check( age, 18..75 )  # Check age is within range
+        check( name, String ) # Check name is String
+        check( age, 18..75 )  # Check age is within Range
     
-        @name = name
-        @age = age
+        @name, @age = name, 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"
+    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"
 
-Check Methods
--------------
+## Check Methods
 
 Simplecheck currently supports three different check methods:
 
@@ -49,8 +53,8 @@ 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, Numeric )
-      # GCD Algorithm
+      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.
@@ -98,8 +102,7 @@ A block can be passed to `check`, with the arguments passed to `check` then pass
 
 This is syntactic sugar for the Proc Case Equality check.
 
-Multiple Arguments
-------------------
+## Multiple Arguments
 
 Case Equality and Block checks can be called with multiple arguments, with each argument being checked individually against the condition:
 
@@ -108,8 +111,12 @@ Case Equality and Block checks can be called with multiple arguments, with each
       n.even?
     end
 
-License
--------
+## Resources
+
+* 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.

data/examples/case_equality_check.rb

@@ -12,6 +12,6 @@ check( 'aaabbb', /^aaa/ )
 check( 1, 1..10 )
 
 # Proc#=== -> Proc#call
-check( 1, lambda{ |n|  n.odd? })
+check( 1, ->(n){ n.odd? })
 
 puts "All passed"

data/examples/person_example.rb

@@ -51,3 +51,5 @@ bob.date_of_birth = nil
 
 # date_of_birth is not present
 try{ joe > bob }
+
+puts "Finished"

data/lib/simplecheck/version.rb

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

data/test/simplecheck_test.rb

@@ -1,98 +1,61 @@
 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
+  include Simplecheck
 
   def test_expression_check_true
-    assert( @foo.expression_check( 1 ))
+    assert( check( 1 ))
   end
 
   def test_expression_check_raises_exception
-    assert_raises( Simplecheck::CheckFailed ){ @foo.expression_check( nil )}
+    assert_raises( Simplecheck::CheckFailed ){ check( nil )}
   end
 
   def test_case_equality_check_true
-    assert( @foo.case_equality_check( 1 ))
+    assert( check( 1, Integer ))
   end
 
   def test_case_equality_check_raises_exception
-    assert_raises( Simplecheck::CheckFailed ){ @foo.case_equality_check( '1' )}
+    assert_raises( Simplecheck::CheckFailed ){ check( '1', Integer )}
   end
 
   def test_case_equality_check_multiple_arguments
-    assert( @foo.case_equality_check_multiple_arguments( 1, 2 ))
+    assert( check( 1, 2, Integer ))
   end
 
   def test_case_equality_check_multiple_arguments_raises_exception
-    assert_raises( Simplecheck::CheckFailed ){ @foo.case_equality_check_multiple_arguments( 1, '2' )}
+    assert_raises( Simplecheck::CheckFailed ){ check( 1, '2', Integer )}
   end
 
   def test_block_check_true
-    assert( @foo.block_check( 2 )) 
+    assert( check( 1 ){ |n| n.odd? }) 
   end
 
   def test_block_check_raises_exception
-    assert_raises( Simplecheck::CheckFailed ){ @foo.block_check( 1 )}
+    assert_raises( Simplecheck::CheckFailed ){ check( 1 ){ |n| n.even? }}
   end
 
   def test_block_check_multiple_arguments_true
-    assert( @foo.block_check_multiple_arguments( 2, 2, 2 ))
+    assert( check( 1, 1, 1 ){ |n| n.odd? })
   end
 
   def test_block_check_multiple_arguments_exception
-    assert_raises( Simplecheck::CheckFailed ){ @foo.block_check_multiple_arguments( 2, 2, 1 )}
+    assert_raises( Simplecheck::CheckFailed ){ check( 1, 1, 2 ){ |n| n.odd? }}
   end
 
   def test_lambda_argument_check_true
-    assert( @foo.lambda_argument_check( 2 ))
+    assert( check( 1, ->(n){ n.odd? }))
   end
 
   def test_lambda_argument_check_raises_exception
-    assert_raises( Simplecheck::CheckFailed ){ @foo.lambda_argument_check( 1 )}
+    assert_raises( Simplecheck::CheckFailed ){ check( 2, ->(n){ n.odd? })}
   end
 
   def test_lambda_block_check_true
-    assert( @foo.lambda_block_check( 2 ))
+    assert( check( 1, &->(n){ n.odd? }))
   end
 
   def test_lambda_block_check_raises_exception
-    assert_raises( Simplecheck::CheckFailed ){ @foo.lambda_block_check( 1 )}
+    assert_raises( Simplecheck::CheckFailed ){ check( 2, &->(n){ n.odd? })}
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simplecheck
 version: !ruby/object:Gem::Version
-  version: 1.0rc1
+  version: '1.0'
 platform: ruby
 authors:
 - Farrel Lifson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-08 00:00:00.000000000 Z
+date: 2013-11-12 00:00:00.000000000 Z
 dependencies: []
 description: Simple property checking for Ruby
 email:
@@ -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: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: rcap
 rubygems_version: 2.0.3