quacks-like 1.0.0

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2009, Michael H. Buselli
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * 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 THE COPYRIGHT HOLDER(S) ''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 THE COPYRIGHT HOLDER(S) 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.

data/lib/quacks_like.rb

@@ -0,0 +1,72 @@
+#
+# Copyright (c) 2009, Michael H. Buselli
+# See LICENSE for details on permitted use.
+#
+
+#
+# QuacksLike is a module for RSpec to add matchers that test if an
+# object is fully duck-typed to pretend to be another class.  This kind
+# of thing is really only necessary when passing such an object as the
+# return value in an API where you don't know exactly how it will be
+# consumed, but it needs to "quack like an Array" or something.  It does
+# its job by checking every instance method in the class that the target
+# object needs to "quack like" and makes sure the target both responds
+# to that method name and that the arity of the method is appropriate.
+#
+# Usage (in RSpec files):
+#   require 'quacks_like'
+#
+#   it "should return an object that quacks like a Hash" do
+#     my_func.should quack_like_a(Hash)
+#   end
+#
+#   it "should return an object that does not quack like an Array" do
+#     my_func.should_not quack_like_an(Array)
+#   end
+#
+class QuacksLike
+  def initialize (quack_class)
+    @quack_class = quack_class
+  end
+
+  def arity_compare (quack_arity, target_arity)
+    if quack_arity >= 0
+      target_arity == quack_arity or target_arity.between?(-1 - quack_arity, -1)
+    else
+      target_arity.between?(quack_arity, -1)
+    end
+  end
+  private :arity_compare
+
+  def matches? (target)
+    @target = target
+    @mismatches = []
+
+    @quack_class.instance_methods.each do |m|
+      if not @target.respond_to?(m)
+        @mismatches.push "does not respond to :#{m}"
+      elsif not arity_compare(q = @quack_class.instance_method(m).arity,
+                              t = @target.method(m).arity)
+        @mismatches.
+            push "quacking method :#{m} has arity #{q} but found arity #{t}"
+      end
+    end
+
+    @mismatches.empty?
+  end
+
+  def failure_message_for_should
+    [@target.inspect, @mismatches.join(', ')].join(' ')
+  end
+
+  def failure_message_for_should_not
+    "expected #{@target.inspect} to not quack like a(n) #{@quack_class.inspect}"
+  end
+end
+
+
+def quack_like_a (quack_class)
+  QuacksLike.new(quack_class)
+end
+alias quack_like_an quack_like_a
+

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: quacks-like
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Michael H Buselli
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-11 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: "    QuacksLike is a module for RSpec to add matchers that test if an\n    object is fully duck-typed to pretend to be another class.  This\n    kind of thing is really only necessary when passing such an\n    object as the return value in an API where you don't know\n    exactly how it will be consumed, but it needs to \"quack like an\n    Array\" or something.  It does its job by checking every instance\n    method in the class that the target object needs to \"quack like\"\n    and makes sure the target both responds to that method name and\n    that the arity of the method is appropriate.\n"
+email: 
+- cosine@cosine.org
+- michael@buselli.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- lib/quacks_like.rb
+has_rdoc: true
+homepage: http://cosine.org/ruby/QuacksLike/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: quacks-like
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: "QuacksLike \xE2\x80\x94 RSpec matcher for duck-type testing"
+test_files: []
+