ducktypechecker 0.1.0 → 0.1.1

data/README

@@ -1,4 +1,4 @@
-Duck Type Checker is copyrighted free software by Brian Takita <brian.takita@gmail.com>.
+Duck Type Checker is copyrighted free software by Brian Takita <Brian.Takita@gmail.com>.
 You can redistribute it and/or modify it under either the terms of the GPL, or the conditions below:
 
   1. You may make and give away verbatim copies of the source form of the

data/lib/duck_type_checker.rb

@@ -1,12 +1,76 @@
+# DuckType - A mixin that checks an object to see if it implements
+# certain methods (ie "Walks like a Duck"). If the object does not
+# implement a given method, an exception is raised
+# or user defined action is performed.
+#
+# ===Example
+#  require 'ducktypechecker'
+#  
+#  class Test
+#    def a_method(a)
+#      DuckType.check(a, [:method_one, :method_two], 'a')
+#      puts a.method_one
+#      puts a.method_two
+#    end
+#  end
+# 
+#  class A
+#    def method_one
+#      'method_one'
+#    end
+#  end
+#  
+#  t = Test.new
+#  t.a_method(A.new)
+#  # A TypeError exception is raised with the message
+#  #"Variable 'a' needs to implement 'method_two'."
+#
+# ==Passing a Block
+# You can also use a custom action adding a block to the
+# DuckType.check method.
+#
+# ===Example
+#  require 'ducktypechecker'
+#  s = Struct.new(:a)
+#  o = s.new(1)
+#  DuckType.check(o, [:a, :b]) do |s|
+#    print "Method '#{s.to_s}' is not implemented in object 'o'."
+#  end
+#  # "Method 'b' is not implemented in object 'o'."
+#
+# ==Mixin
+# You can also mixin DuckType into your own class.
+#
+# ===Example
+#  require 'ducktypechecker'
+#  class Test
+#    include(DuckType)
+#    def a_method(a)
+#      duck_type_check(a, [:method_one, :method_two], 'a')
+#      puts a.method_one
+#      puts a.method_two
+#    end
+#  end
+#  
+#  class A
+#    def method_one
+#      'method_one'
+#    end
+#  end
+#  
+#  t = Test.new
+#  t.a_method(A.new)
+#  # A TypeError exception is raised with the message
+#  #"Variable 'a' needs to implement 'method_two'."
+
 module DuckType
   # Checks the given object if is responds to the given
   # method signatures.
-  # ==Arguments
-  # :obj      = The object being tested
-  # :methods  = A method name or enumerable of the method names.
-  # :var_name = The name of the variable begin tested.
-  #             This is useful for the default messages.
-  # ==Block
+  # ===Arguments
+  #  :obj      = The object being tested
+  #  :methods  = A method name or enumerable of the method names.
+  #  :var_name = The name of the variable begin tested.
+  # ===Block
   # Optionally a block may be passed to respond to a method that
   # is not implemented by the object.
   def self.check(obj, methods, var_name = nil, &block)
@@ -28,7 +92,16 @@ module DuckType
     end
   end
   
-  # Instance implementation of the static method DuckTypeChecker.check
+  # Instance implementation of DuckType.check
+  # Checks the given object if is responds to the given
+  # method signatures.
+  # ===Arguments
+  #  :obj      = The object being tested
+  #  :methods  = A method name or enumerable of the method names.
+  #  :var_name = The name of the variable begin tested.
+  # ===Block
+  # Optionally a block may be passed to respond to a method that
+  # is not implemented by the object.
   def duck_type_check(obj, methods, var_name = nil, &block)
     DuckType.check(obj, methods, var_name, &block)
   end

data/lib/ducktypechecker.rb

@@ -1,2 +1,2 @@
 dir = File.dirname(__FILE__)
-require "#{dir}/duck_type_checker"
+require "#{dir}/duck_type_checker"

metadata

@@ -3,9 +3,9 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: ducktypechecker
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
-date: 2005-09-01 00:00:00 -07:00
-summary: Check to see if an object contains the required method signatures.
+  version: 0.1.1
+date: 2005-09-05 00:00:00 -07:00
+summary: Check to see if an object "walks like a duck".
 require_paths: 
   - lib
 email: brian.takita@gmail.com