shuber-interface 0.0.2 → 0.0.3

data/README.rdoc

@@ -41,8 +41,10 @@ Then use the <tt>implements</tt> method in your classes (also aliased as <tt>imp
       method == :off ? @power = false : super
     end
 
+    # Use this whenever you have custom method_missing logic
+    # See http://www.ruby-doc.org/core/classes/Object.html#M001006
     def respond_to_missing?(method, include_private)
-      method == :off
+      method == :off || super
     end
   end
 
@@ -80,7 +82,55 @@ You can also explicitly list <tt>interfaces</tt> to test
     end
   end
 
-== Note on Patches/Pull Requests
+
+== Why would you ever want to use this?
+
+It's useful for when you're working with libraries that have extensible APIs, like {writing custom ActiveModel compliant models}[http://yehudakatz.com/2010/01/10/activemodel-make-any-ruby-object-feel-like-activerecord/]
+
+Imagine if we defined <tt>ActiveModel</tt> with something like
+
+  module ActiveModel
+    # checks if this object has been saved
+    def new_record?
+    end
+
+    # checks if this object is valid
+    def valid?
+    end
+
+    # and the rest of the methods...
+  end
+
+We'd have a nice clear view of exactly which methods our custom implementations need to define AND one centralized place for documentation
+
+Now we can define our custom implementation
+
+  class CompliantModel
+    implements ActiveModel
+
+    def valid?
+      true
+    end
+  end
+
+Then we can easily test if we've completely implemented <tt>ActiveModel</tt> (or are missing any new methods because <tt>ActiveModel</tt> was updated)
+
+  require 'test/unit'
+
+  Test::Unit::TestCase.send(:include, Interface::TestHelper)
+
+  class CompliantModelTest < Test::Unit::TestCase
+    def test_should_implement_active_model
+      assert_implements_interface CompliantModel.new, ActiveModel # Failure: unimplemented interface methods for CompliantModel: {ActiveModel=>["new_record?"]}
+    end
+  end
+
+<tt>ActiveModel</tt> actually already has a great solution for this problem (providing a module called <tt>ActiveModel::Lint::Tests</tt> that you can include into your test cases to test compliance with the API) but it's still a good example for demonstrating this gem's usefulness
+
+You can see this gem used in {shuber/nestable}[https://github.com/shuber/nestable] which is actually why I created it
+
+
+== Patches and pull requests
 
 * Fork the project.
 * Make your feature addition or bug fix.

data/lib/interface/abstract.rb

@@ -4,9 +4,9 @@ module Interface
     def self.extended(base) # :nodoc:
       base.class_eval do
         instance_methods(false).each do |method|
-          define_method(method) do |*args|
+          define_method(method) do |*args, &block|
             begin
-              method_missing(method.to_sym, *args)
+              method_missing(method.to_sym, *args, &block)
             rescue NoMethodError
               raise NotImplementedError.new("#{self.class} needs to implement '#{method}' for interface #{base}")
             end

data/lib/interface/test_helper.rb

@@ -1,7 +1,7 @@
 module Interface
   # Contains interface testing methods to include in your test framework
   module TestHelper
-    # Raises AssertionFailedError if <tt>object</tt> does not implement all methods from <tt>interfaces</tt>
+    # Raises <tt>AssertionFailedError</tt> if <tt>object</tt> does not implement all methods from <tt>interfaces</tt>
     #
     # <tt>interfaces</tt> defaults to <tt>object.interfaces</tt> if none are specified
     #

data/lib/interface/version.rb

@@ -3,7 +3,7 @@ module Interface
   module Version
     MAJOR = 0
     MINOR = 0
-    PATCH = 2
+    PATCH = 3
 
     # Returns a version string by joining <tt>MAJOR</tt>, <tt>MINOR</tt>, and <tt>PATCH</tt> with <tt>'.'</tt>
     #

data/lib/interface.rb

@@ -47,9 +47,21 @@ module Interface
   def unimplemented_methods_for(interface)
     interface.instance_methods(false).reject do |method|
       method = method.to_sym
-      (respond_to?(method, true) && self.method(method).owner != interface) || (respond_to?(:respond_to_missing?, true) && respond_to_missing?(method, true))
+      (respond_to?(method, true) && self.method(method).owner != interface) || respond_to_missing?(method, true)
     end.sort
   end
+
+  # <tt>Object#respond_to_missing?</tt> wasn't implemented until ruby version 1.9
+  unless respond_to?(:respond_to_missing?)
+    def respond_to?(method, include_private = false) # :nodoc:
+      super || respond_to_missing?(method, include_private)
+    end
+
+    def respond_to_missing?(method, include_private) # :nodoc:
+      false
+    end
+  end
+
 end
 
 Object.send(:include, Interface)

data/test/interface_test.rb

@@ -27,7 +27,7 @@ class Device < BrokenDevice
   end
 
   def respond_to_missing?(method, include_private)
-    method == :off
+    method == :off || super
   end
 end
 
@@ -83,4 +83,8 @@ class InterfaceTest < Test::Unit::TestCase
     assert_raises(Test::Unit::AssertionFailedError) { assert_implements_interface BrokenDevice.new, Remote }
   end
 
+  def test_should_respond_to_respond_to_missing
+    assert respond_to?(:respond_to_missing?)
+  end
+
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: shuber-interface
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Sean Huber
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-09 00:00:00 -08:00
+date: 2011-02-10 00:00:00 -08:00
 default_executable: 
 dependencies: []