isy 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1550994168afbec25a7b84884bed12df5a820c7f
-  data.tar.gz: 4ae42990401ee896783e7faf287501d1f18e19d9
+  metadata.gz: c3b170f040c49a3262f8f3138321752e89f22dcf
+  data.tar.gz: 9e08893688c801d61ccac0de3ac2c8b6c61d81ef
 SHA512:
-  metadata.gz: 9b3652ba2ea55251ab37446615bbc9a7233dc2566cafb2a4873c24ad001ae4d86e8ed3b1a9bf9d560b7f7afdf35fccfd3985968222d0586b796ecbd7edf941cb
-  data.tar.gz: 2a2efc241c027f5d8a6d9cef42c7cbbcfab9ea0aa09f94612faa71199b10504bb333a0071094c2dee33db66b1a281656bfd952f0e4234c9dedc96c1b9f9ed6d2
+  metadata.gz: 874b089ca5916fbbfaca5d55fcd20225890fefc2ccf97368f36f511658ad9eb19f491d06c55edf599fbe5dbae5903e6c0a14fad731a4536e63be807e9dcfcc4b
+  data.tar.gz: f5178fa77edda673fb4a6cae89cfa8105407900bc31b4a86bcc4bc3d70f3493e60fac6a8191ac3233164170c2b5fce9334a4679165850fd9109934bbd5837ff8

data/README.md

@@ -1,10 +1,13 @@
 # Isy
 
+[![Build Status](https://travis-ci.org/acuppy/isy.svg?branch=master)](https://travis-ci.org/acuppy/isy)
+[![Code Climate](https://codeclimate.com/github/acuppy/isy/badges/gpa.svg)](https://codeclimate.com/github/acuppy/isy)
+
 Guard clauses for argument type assertions can be messy:
 
 ```ruby
 def fullname segments=[]
-  raise 'User#fullname expects 'segments' to be an Array' if segments.is_a? Array
+  raise ArgumentError, 'User#fullname expects 'segments' to be an Array' if segments.is_a? Array
   # ...
 end
 ```
@@ -35,20 +38,37 @@ The second argument is the type.
 If the subject doesn't match the provided type, then it raises a formatted exception describing
 what argument *value* was a type mismatch (as an `Isy::ArgumentTypeMismatch` exception).
 
+Alternatively, you can use the predicate version for type assertion:
+
+```ruby
+def fullname segments=[]
+  if isy? segments, Array
+    # passes
+  end
+end
+```
+
+In the previous example, the interface is the same: subject, arguments,
+optional block.  The difference is that if the assertion fails, it will
+catch the `Isy::ArgumentTypeMismatch` exception and return `false`.
+
 ## Usage with an operation
 
 Optionally, in place of a type as the second argument, you can pass a block, and perform
 a more complex comparison operation:
 
 ```ruby
-  def fullname segments
-    isy segments { |seg| seg.length == 3 }
-  end
+def fullname segments
+  isy segments { |seg| seg.length == 3 }
+  # ...
+end
 ```
 
 As illustrated above, `isy` yields to the operation the first argument (segments).  The expectation
 is that the value returned by the operation (block) is a boolen (true => passes, false => failed).
 
+*Note: predicate version has the same support*
+
 ## Performance
 
 It's not great against a more "native" implementation; but, where you lose a little

data/lib/isy/methods.rb

@@ -40,14 +40,49 @@ module Isy
           'Object#isy requires either a type or evaluation block'
       end
 
-      evaluation ||= lambda { |s| s.is_a? args[0] }
+      evaluation ||= ->(s) { s.is_a? args[0] }
+      is_valid = !!(evaluation.call subject)
 
-      unless evaluation.call(subject)
+      unless is_valid
         raise Isy::ArgumentTypeMismatch.new(
           subject: subject,
           caller_method: caller_locations(1,1)[0].label
         )
       end
+
+      is_valid
+    end
+
+    # Isy::Methods#isy?
+    #
+    # == Usage
+    #
+    # The implementation follows the same workflow as `isy` with one exception (pun intended): returns a boolen.
+    #
+    #   def fullname segments
+    #     if isy? segments, Array
+    #       # passes
+    #     end
+    #   end
+    #
+    # If the subject doesn't match the provided type, then it returns false
+    #
+    # == Usage with an operation
+    #
+    # Optionally, in place of a type as the second argument, you can pass a block, and perform
+    # a more complex comparison operation:
+    #
+    #   def fullname segments
+    #     isy? segments { |seg| seg.length == 3 }
+    #   end
+    #
+    # As illustrated above, `isy?` yields to the operation the first argument (segments).  The expectation
+    # is that the value returned by the operation (block) is a boolen (true => passes, false => failed).
+    #
+    def isy? subject, *args, &evaluation
+      isy subject, *args, &evaluation
+    rescue ArgumentTypeMismatch
+      false
     end
   end
 end

data/lib/isy/version.rb

@@ -1,3 +1,3 @@
 module Isy
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: isy
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Adam Cuppy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-30 00:00:00.000000000 Z
+date: 2016-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler