shuber-interface 0.0.1 → 0.0.2

data/README.rdoc

@@ -18,7 +18,7 @@ Simply create a module with any methods that you'd like its implementing objects
     # turns the device on
     def on
     end
-    
+
     # turns the device off
     def off
     end
@@ -29,24 +29,57 @@ Then use the <tt>implements</tt> method in your classes (also aliased as <tt>imp
   class BrokenDevice
     implements RemoteControl
   end
-  
+
   BrokenDevice.new.on # NotImplementedError: BrokenDevice needs to implement 'on' for interface RemoteControl
-  
+
   class WorkingDevice < BrokenDevice
     def on
       @power = true
     end
 
-    def off
-      @power = false
+    def method_missing(method, *args)
+      method == :off ? @power = false : super
+    end
+
+    def respond_to_missing?(method, include_private)
+      method == :off
     end
   end
-  
+
   WorkingDevice.new.on # true
-  
+  WorkingDevice.new.off # false
+
   WorkingDevice.interfaces # [RemoteControl]
 
 
+== Testing interface implementations
+
+Include <tt>Interface::TestHelper</tt> in your test framework
+
+  Test::Unit::TestCase.send(:include, Interface::TestHelper)
+
+Then you can use <tt>assert_implements_interfaces</tt> (aliased as <tt>assert_implements_interface</tt>) in your tests
+
+  class BrokenDeviceTest < Test::Unit::TestCase
+    def test_should_implement_interfaces
+      assert_implements_interfaces BrokenDevice.new # Failure: unimplemented interface methods for BrokenDevice: {Remote=>["off", "on"]}
+    end
+  end
+
+You can also explicitly list <tt>interfaces</tt> to test
+
+  module MockInterface end
+
+  class BrokenDevice
+    implements Remote, MockInterface
+  end
+
+  class BrokenDeviceTest < Test::Unit::TestCase
+    def test_should_implement_mock_interface
+      assert_implements_interface BrokenDevice.new, MockInterface # passes
+    end
+  end
+
 == Note on Patches/Pull Requests
 
 * Fork the project.

data/lib/interface/test_helper.rb

@@ -0,0 +1,42 @@
+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>
+    #
+    # <tt>interfaces</tt> defaults to <tt>object.interfaces</tt> if none are specified
+    #
+    # Aliased as <tt>assert_implements_interface</tt>
+    #
+    # Example
+    #
+    #   module Remote
+    #     def on
+    #     end
+    #
+    #     def off
+    #     end
+    #   end
+    #
+    #   module MockInterface
+    #   end
+    #
+    #   class BrokenDevice
+    #     implements Remote, MockInterface
+    #   end
+    #
+    #   class BrokenDeviceTest < Test::Unit::TestCase
+    #     def test_should_implement_interfaces
+    #       assert_implements_interfaces BrokenDevice.new # Failure: unimplemented interface methods for BrokenDevice: {Remote=>["off", "on"]}
+    #
+    #       # you can also explicitly pass interfaces to test
+    #       assert_implements_interface BrokenDevice.new, MockInterface # passes
+    #     end
+    #   end
+    def assert_implements_interfaces(object, *interfaces)
+      interfaces = interfaces.empty? ? object.interfaces : interfaces.flatten
+      unimplemented_methods = object.unimplemented_methods.reject { |interface, methods| !interfaces.include?(interface) }
+      assert_block("unimplemented interface methods for #{object.class}: #{unimplemented_methods.inspect}") { unimplemented_methods.empty? }
+    end
+    alias_method :assert_implements_interface, :assert_implements_interfaces
+  end
+end

data/lib/interface/version.rb

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

data/lib/interface.rb

@@ -1,7 +1,8 @@
 # Implementable interfaces in ruby
 module Interface
-  autoload :Abstract, 'interface/abstract'
-  autoload :Version, 'interface/version'
+  autoload :Abstract,   'interface/abstract'
+  autoload :TestHelper, 'interface/test_helper'
+  autoload :Version,    'interface/version'
 
   # Takes a module (or multiple in reverse order), extends it with <tt>Interface::Abstract</tt>, then includes it into the current object
   #
@@ -29,7 +30,25 @@ module Interface
 
   # Returns an array of interfaces implemented by the current object
   def interfaces
-    included_modules.select { |mod| mod.is_a?(Abstract) }
+    klass = is_a?(Class) ? self : self.class
+    klass.included_modules.select { |mod| mod.is_a?(Abstract) }
+  end
+
+  # Returns a hash with each partially implemented <tt>interface</tt> as keys and an array of methods 
+  # that the current object does not implement as values
+  def unimplemented_methods
+    self.class.interfaces.inject({}) do |hash, interface|
+      methods = unimplemented_methods_for(interface)
+      methods.empty? ? hash : hash.merge!(interface => methods)
+    end
+  end
+
+  # Returns an array of methods from the specified <tt>interface</tt> that the current object does not implement
+  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))
+    end.sort
   end
 end
 

data/test/interface_test.rb

@@ -25,6 +25,10 @@ class Device < BrokenDevice
   def method_missing(method, *args)
     method == :off ? @power = false : super
   end
+
+  def respond_to_missing?(method, include_private)
+    method == :off
+  end
 end
 
 class InterfaceTest < Test::Unit::TestCase
@@ -50,7 +54,33 @@ class InterfaceTest < Test::Unit::TestCase
   end
 
   def test_should_return_interfaces
-    assert_equal [Remote, MockInterface], Device.interfaces
+    assert_all_equal [Remote, MockInterface], Device.interfaces, Device.new.interfaces
+  end
+
+  def test_should_return_unimplemented_methods_for_interface
+    assert_equal ['off', 'on'], BrokenDevice.new.unimplemented_methods_for(Remote)
+  end
+
+  def test_should_return_empty_array_when_all_implemented
+    assert_equal [], Device.new.unimplemented_methods_for(Remote)
+  end
+
+  def test_should_return_hash_of_unimplemented_methods_with_interfaces
+    assert_equal({ Remote => ['off', 'on'] }, BrokenDevice.new.unimplemented_methods)
+  end
+
+  def test_should_return_empty_hash_when_all_interfaces_implemented
+    assert_equal Hash.new, Device.new.unimplemented_methods
+  end
+
+  def test_should_pass_assertion
+    assert_implements_interfaces Device.new
+    assert_implements_interface BrokenDevice.new, MockInterface
+  end
+
+  def test_should_fail_assertion
+    assert_raises(Test::Unit::AssertionFailedError) { assert_implements_interfaces BrokenDevice.new }
+    assert_raises(Test::Unit::AssertionFailedError) { assert_implements_interface BrokenDevice.new, Remote }
   end
 
 end

data/test/test_helper.rb

@@ -2,4 +2,12 @@ require 'test/unit'
 
 $:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $:.unshift(File.dirname(__FILE__))
-require 'interface'
+require 'interface'
+
+Test::Unit::TestCase.class_eval do
+  include Interface::TestHelper
+
+  def assert_all_equal(expected, *results)
+    results.each { |result| assert_equal expected, result }
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: shuber-interface
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Sean Huber
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-08 00:00:00 -08:00
+date: 2011-02-09 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -30,6 +30,7 @@ extra_rdoc_files: []
 files: 
 - lib/interface.rb
 - lib/interface/abstract.rb
+- lib/interface/test_helper.rb
 - lib/interface/version.rb
 - lib/shuber-interface.rb
 - MIT-LICENSE