interface 1.0.0 → 1.0.1

data/CHANGES

@@ -1,3 +1,15 @@
+== 1.0.1 - 29-Jul-2009
+* Now compatible with Ruby 1.9.x.
+* Replaced the install.rb with a Rakefile and various tasks.
+* Updated the license to Artistic 2.0.
+* Added test-unit 2.x as a development dependency and refactored the test
+  suite to take advantage of some of its features.
+* Renamed the test file to test_interface.rb.
+* Renamed the example programs to all start with 'example_' to avoid any
+  possible confusion with actual test suites.
+* Added rake tasks for running the example programs.
+* Updated and refactored the gemspec.
+
 == 1.0.0 - 5-Jun-2005
 * Re-released on RubyForge.
 * Some test suite and doc changes.

data/MANIFEST

@@ -1,14 +1,11 @@
 CHANGES
 MANIFEST
 README
-install.rb
+Rakefile
 interface.gemspec
-
-examples/test_instance.rb
-examples/test_interface.rb
-examples/test_sub.rb
-examples/test_unrequire.rb
-
+examples/example_instance.rb
+examples/example_interface.rb
+examples/example_sub.rb
+examples/example_unrequire.rb
 lib/interface.rb
-
-test/tc_interface.rb
+test/test_interface.rb

data/examples/example_instance.rb

@@ -0,0 +1,30 @@
+#######################################################################
+# example_instance.rb
+#
+# Sample program to demonstrate extending an interface to an instance
+# of a class. You can run this program via the 'rake example_instance'
+# task. Modify as you see fit.
+#######################################################################
+require 'interface'
+
+MyInterface = interface{
+   required_methods :foo, :bar
+}
+
+class Foo
+   def foo; end
+   def bar; end
+end
+
+class Bar
+end
+
+f = Foo.new
+f.extend(MyInterface)
+
+b = Bar.new
+
+# This will blow up
+class << b
+   include MyInterface
+end

data/examples/example_interface.rb

@@ -0,0 +1,27 @@
+#######################################################################
+# example_interface.rb
+#
+# Sample test script that demonstrates a typical interface. You can
+# run this example via the 'rake example_interface' task. Modify this
+# code as you see fit.
+#######################################################################
+require 'interface'
+
+MyInterface = interface{
+	required_methods :foo, :bar
+}
+
+class MyClass
+	def foo; end
+	def bar; end
+	include MyInterface
+end
+
+=begin
+# Raises an error until bar is defined
+class Foo
+	def foo
+		puts "foo"
+	end
+end
+=end

data/examples/example_sub.rb

@@ -0,0 +1,34 @@
+#######################################################################
+# example_sub.rb
+#
+# Sample program to demonstrate extending a sub-interface. You can
+# run this program via the 'rake example_sub' task. Modify this code
+# as you see fit.
+#######################################################################
+require 'interface'
+
+module MyInterface
+	extend Interface
+	required_methods :foo, :bar
+end
+	
+module MySubInterface
+	extend Interface
+	extend MyInterface
+	required_methods :baz
+end
+
+class MyClass
+	def baz; end
+	def bar; end
+	def foo; end
+	include MySubInterface
+end
+	
+=begin
+# Raises an error
+class MyClass
+	def baz; end
+	include MyInterface
+end
+=end

data/examples/example_unrequire.rb

@@ -0,0 +1,26 @@
+###########################################################################
+# example_unrequire.rb
+#
+# Sample test script for to verify that unrequired_methods works properly.
+# You can run this code via the 'rake example_unrequire' rake task. Modify
+# this code as you see fit.
+###########################################################################
+require 'interface'
+
+MyInterface = interface{
+	required_methods :foo, :bar
+}
+	
+# require foo and baz, but not bar
+MySubInterface = interface{
+	extends MyInterface
+	required_methods :baz
+	unrequired_methods :bar
+}
+
+# No error
+class MyClass
+	def foo; end
+	def baz; end
+	include MySubInterface
+end

data/lib/interface.rb

@@ -1,64 +1,93 @@
+# A module for implementing Java style interfaces in Ruby. For more information
+# about Java interfaces, please see:
+#
+# http://java.sun.com/docs/books/tutorial/java/concepts/interface.html
+#
 module Interface
-   Interface::VERSION = "1.0.0"
+   # The version of this library.
+   Interface::VERSION = '1.0.1'
    
    # Raised if a class or instance does not meet the interface requirements.
    class MethodMissing < RuntimeError; end
+
+   alias :extends :extend
+
+   private
  
-   # An alias for +extend+
-   def extends(o)
-      extend o
-   end
- 
-   def extend_object(o)
-      return append_features(o) if Interface === o
-      append_features(class << o; self end)
-      included(o)
+   def extend_object(obj)
+      return append_features(obj) if Interface === obj
+      append_features(class << obj; self end)
+      included(obj)
    end
  
    def append_features(mod)
       return super if Interface === mod
-      inherited = (self.ancestors-[self]).select{|x| Interface === x}.
-         map{|x| x.instance_variable_get("@ids")}
+
+      inherited = (self.ancestors-[self]).select{ |x| Interface === x }
+      inherited = inherited.map{ |x| x.instance_variable_get('@ids') }
+
       ids = @ids + inherited.flatten
       @unreq ||= []
-      (ids-@unreq).uniq.each do |id|
-         unless mod.instance_methods( true ).include?( id.to_s )
-            raise Interface::MethodMissing, id.to_s
+
+      (ids - @unreq).uniq.each do |id|
+         id = id.to_s if RUBY_VERSION.to_f < 1.9
+         unless mod.instance_methods(true).include?(id)
+            raise Interface::MethodMissing, id
          end
       end
+
       super mod
    end
+
+   public
    
    # Accepts an array of method names that define the interface.  When this
    # module is included/implemented, those method names must have already been
    # defined. 
+   #
    def required_methods(*ids)
       @ids = ids
    end
 
    # Accepts an array of method names that are removed as a requirement for
-   # implementation.  Presumably, you would use this in a subinterface where
+   # implementation. Presumably you would use this in a sub-interface where
    # you only wanted a partial implementation of an existing interface.
+   #
    def unrequired_methods(*ids)
       @unreq ||= []
       @unreq += ids
    end
 end
 
-# Accepts a block.  There are only two methods you should ever pass to this
-# block: required_methods and/or unrequired_methods.	
+# The interface method creates an interface module which typically sets
+# a list of methods that must be defined in the including class or module.
+# If the methods are not defined, an Interface::MethodMissing error is raised.
 #	
-# Subinterfaces will need to 'extend' their parent interface. 
+# A interface can extend an existing interface as well. These are called
+# sub-interfaces, and they can included the rules for their parent interface
+# by simply extending it.
+#
+# Example:
+#
+#   # Require 'alpha' and 'beta' methods
+#   AlphaInterface = interface{
+#      required_methods :alpha, :beta 
+#   }
+#
+#   # A sub-interface that requires 'beta' and 'gamma' only
+#   GammaInterface = interface{
+#      extends AlphaInterface
+#      required_methods :gamma
+#      unrequired_methods :alpha
+#   }
+#
 def interface(&block)
    mod = Module.new
-   mod.extend Interface
+   mod.extend(Interface)
    mod.instance_eval(&block)
    mod
 end
  
 class Module
-   # An alias for +include+.  This should be the last statement in your class.
-   def implements m
-      include m
-   end
-end
+   alias :implements :include
+end

data/test/test_interface.rb

@@ -0,0 +1,66 @@
+#####################################################
+# test_interface.rb
+#
+# Test suite for the Interface module.
+#####################################################
+require 'rubygems'
+gem 'test-unit'
+
+require 'test/unit'
+require 'interface'
+
+class TC_Interface < Test::Unit::TestCase
+   def self.startup
+      alpha_interface = interface{
+         required_methods :alpha, :beta
+      }
+
+      gamma_interface = interface{
+         extends alpha_interface
+         required_methods :gamma
+         unrequired_methods :alpha
+      }
+      
+      # Workaround for 1.9.x
+      @@alpha_interface = alpha_interface
+      @@gamma_interface = gamma_interface
+
+      eval("class A; end")
+
+      eval("
+         class B
+            def alpha; end
+            def beta; end
+         end
+      ")
+
+      eval("
+         class C
+            def beta; end
+            def gamma; end
+         end
+      ")
+   end
+
+   def test_version
+      assert_equal('1.0.1', Interface::VERSION)
+   end
+	
+   def test_interface_requirements_not_met
+      assert_raise(Interface::MethodMissing){ A.extend(@@alpha_interface) }
+      assert_raise(Interface::MethodMissing){ A.new.extend(@@alpha_interface) }
+   end
+
+   def test_sub_interface_requirements_not_met
+      assert_raise(Interface::MethodMissing){ B.extend(@@gamma_interface) }
+      assert_raise(Interface::MethodMissing){ B.new.extend(@@gamma_interface) }
+   end
+	
+   def test_alpha_interface_requirements_met
+      assert_nothing_raised{ B.new.extend(@@alpha_interface) }
+   end
+
+   def test_gamma_interface_requirements_met
+      assert_nothing_raised{ C.new.extend(@@gamma_interface) }
+   end
+end

metadata

@@ -1,44 +1,74 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.10
-specification_version: 1
 name: interface
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
-date: 2005-06-05
-summary: Java style interfaces for ruby
-require_paths: 
-  - lib
-email: djberg96@gmail.com
-homepage: http://www.rubyforge.org/projects/shards
-rubyforge_project: 
-description: 
+  version: 1.0.1
+platform: ruby
+authors: 
+- Daniel J. Berger
 autorequire: 
-default_executable: 
 bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-    - 
-      - ">"
+cert_chain: []
+
+date: 2009-07-29 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: test-unit
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.0.0
-  version: 
-platform: ruby
-authors: 
-  - Daniel J. Berger
-files: 
-  - lib/interface.rb
-  - README
-  - CHANGES
-  - MANIFEST
-  - test/tc_interface.rb
-test_files: 
-  - test/tc_interface.rb
-rdoc_options: []
-extra_rdoc_files: 
-  - README
-  - CHANGES
+        version: 2.0.3
+    version: 
+description: "      The interface library implements Java style interfaces for Ruby.\n      It lets you define a set a methods that must be defined in the\n      including class or module, or an error is raised.\n"
+email: djberg96@gmail.com
 executables: []
+
 extensions: []
+
+extra_rdoc_files: 
+- README
+- CHANGES
+- MANIFEST
+files: 
+- examples/example_instance.rb
+- examples/example_interface.rb
+- examples/example_sub.rb
+- examples/example_unrequire.rb
+- lib/interface.rb
+- test/test_interface.rb
+- README
+- CHANGES
+- MANIFEST
+has_rdoc: true
+homepage: http://www.rubyforge.org/projects/shards
+licenses: 
+- Artistic 2.0
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
 requirements: []
-dependencies: []
+
+rubyforge_project: shards
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Java style interfaces for Ruby
+test_files: 
+- test/test_interface.rb

data/test/tc_interface.rb

@@ -1,53 +0,0 @@
-#####################################################
-# tc_interface.rb
-#
-# Test suite for the Interface module.
-#####################################################
-base = File.basename(Dir.pwd)
-if base == "test" || base =~ /interface/
-   Dir.chdir("..") if base == "test"
-   $LOAD_PATH.unshift("lib")
-end
-
-require "test/unit"
-require "interface"
-
-TestInterface = interface{
-   required_methods :foo, :bar
-}
-
-TestSubInterface = interface{
-   extend TestInterface
-   required_methods :baz
-}
-
-class A; end
-
-class B
-   def foo; end
-   def bar; end
-end
-
-class C < B
-   def baz; end
-end
-
-class TC_Interface < Test::Unit::TestCase
-   def test_version
-      assert_equal("1.0.0", Interface::VERSION)
-   end
-	
-   def test_requirements_not_met
-      assert_raises(Interface::MethodMissing){
-         A.new.extend(TestInterface)
-      }
-      assert_raises(Interface::MethodMissing){
-         B.new.extend(TestSubInterface)
-      }
-   end
-	
-   def test_requirements_met
-      assert_nothing_raised{ B.new.extend(TestInterface) }
-      assert_nothing_raised{ C.new.extend(TestSubInterface) }
-   end
-end