isy 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1924fef98cb5aaaf39ed180fe2fd14db37bc072a
-  data.tar.gz: 79661c9517afc68bf60dcb6db5f916249d633a6b
+  metadata.gz: 1550994168afbec25a7b84884bed12df5a820c7f
+  data.tar.gz: 4ae42990401ee896783e7faf287501d1f18e19d9
 SHA512:
-  metadata.gz: 2192aa293532cfa148aaed6a2b54604a0505389ff77a7e2cafca582dbcc2bb0aeee3a8af0425786980d00930880ce136f1f5b7717b90f52e287b8a50c03cb3a6
-  data.tar.gz: 89dba2c5ae9aa5bc706a30b4f2ed2057263118a6de96aa8a9711c258d03feaadb48351144ffb17c4ad9fa8f60e5badbdfc3a148276799d64d744109a8636bb22
+  metadata.gz: 9b3652ba2ea55251ab37446615bbc9a7233dc2566cafb2a4873c24ad001ae4d86e8ed3b1a9bf9d560b7f7afdf35fccfd3985968222d0586b796ecbd7edf941cb
+  data.tar.gz: 2a2efc241c027f5d8a6d9cef42c7cbbcfab9ea0aa09f94612faa71199b10504bb333a0071094c2dee33db66b1a281656bfd952f0e4234c9dedc96c1b9f9ed6d2

data/README.md

@@ -9,8 +9,18 @@ def fullname segments=[]
 end
 ```
 
-Setting aside that an issue of this type can be a sign of an
-architectural problem, `isy` is meant to clean this up.
+Setting aside that an issue of this type could be a sign of a greater
+architectural problem, `Isy` takes a declarative approach to solving the problem.
+Instead of dictating the contraints (and resulting response) to each argument type,
+you can leverage Isy's simple interface:
+
+## Usage
+
+The primary use of Isy is through the `isy` method, which is included into Object upon initialization
+
+You can call isy from any point, but it's intended use is to be treated like a "guard clause" to
+assert method argument types before those arguments are used (and potentially wreak havoc
+throughout the implementation:
 
 ```ruby
 def fullname segments=[]
@@ -19,9 +29,25 @@ def fullname segments=[]
 end
 ```
 
-`Isy` takes a declarative approach to solving the problem.  Instead of
-dictating the contraints (and resulting response) to each argument type,
-you can levelage Isy's simple interface.
+The first argument is the subject of the test (i.e. what should match the proceeding assertion)
+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).
+
+## 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
+```
+
+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).
 
 ## Performance
 
@@ -58,4 +84,5 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERN
 
 ## License
 
+Copyright (c) 2016 Adam Cuppy, Zeal (https://codingzeal.com)
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/isy/methods.rb

@@ -0,0 +1,53 @@
+require_relative 'exceptions'
+
+module Isy
+  module Methods
+    # Isy::Methods#isy
+    #
+    # The primary use of Isy is through the #isy method, which is included into Object upon initialization
+    #
+    # == Usage
+    #
+    # You can call isy from any point, but it's intended use is to be treated like a "guard clause" to
+    # assert method argument types before those arguments are used (and potentially wreak havoc
+    # throughout the implementation:
+    #
+    #   def fullname segments
+    #     isy segments, Array
+    #   end
+    #
+    # The first argument is the subject of the test (i.e. what should match the proceeding assertion)
+    # 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).
+    #
+    # == 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
+      if evaluation.nil? && args[0].nil?
+        raise ArgumentError,
+          'Object#isy requires either a type or evaluation block'
+      end
+
+      evaluation ||= lambda { |s| s.is_a? args[0] }
+
+      unless evaluation.call(subject)
+        raise Isy::ArgumentTypeMismatch.new(
+          subject: subject,
+          caller_method: caller_locations(1,1)[0].label
+        )
+      end
+    end
+  end
+end

data/lib/isy/version.rb

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

data/lib/isy.rb

@@ -1,30 +1,12 @@
-require "isy/version"
-require "isy/exceptions"
+require 'isy/version'
+require 'isy/methods'
 
 module Isy
-  def self.bind!
+  def self.bind! # :nodoc:
     Object.instance_eval do
       include Isy::Methods
     end
   end
-
-  module Methods
-    def isy subject, *args, &evaluation
-      if evaluation.nil? && args[0].nil?
-        raise ArgumentError,
-          'Object#isy requires either a type or evaluation block'
-      end
-
-      evaluation ||= lambda { |s| s.is_a? args[0] }
-
-      unless evaluation.call(subject)
-        raise Isy::ArgumentTypeMismatch.new(
-          subject: subject,
-          caller_method: caller_locations(1,1)[0].label
-        )
-      end
-    end
-  end
 end
 
 Isy.bind!

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: isy
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Adam Cuppy
@@ -99,6 +99,7 @@ files:
 - isy.gemspec
 - lib/isy.rb
 - lib/isy/exceptions.rb
+- lib/isy/methods.rb
 - lib/isy/version.rb
 homepage: https://github.com/acuppy/isy
 licenses: