interface 1.0.0

data/CHANGES

@@ -0,0 +1,6 @@
+== 1.0.0 - 5-Jun-2005
+* Re-released on RubyForge.
+* Some test suite and doc changes.
+
+== 0.1.0 - 9-May-2004
+* Initial release

data/MANIFEST

@@ -0,0 +1,14 @@
+CHANGES
+MANIFEST
+README
+install.rb
+interface.gemspec
+
+examples/test_instance.rb
+examples/test_interface.rb
+examples/test_sub.rb
+examples/test_unrequire.rb
+
+lib/interface.rb
+
+test/tc_interface.rb

data/README

@@ -0,0 +1,82 @@
+== Description
+   This module provides Java style interfaces for Ruby, including a fairly
+   similar syntax.  I don't necessarily believe in interfaces, but I wanted to
+   put it out there as proof that it could be done.  Frankly, Java needs mixins
+   more than Ruby needs interfaces, but here you go.
+
+== Installation
+
+=== Manual
+   ruby test/ts_interface.rb
+   ruby install.rb
+   
+=== Gem Install
+   ruby interface.gemspec
+   gem install interface-<version>.gem
+
+== Synopsis
+   require "interface"
+	
+   MyInterface = interface{
+      required_methods :foo, :bar, :baz
+   }
+	
+   # Raises an error until 'baz' is defined
+   class MyClass
+      def foo
+         puts "foo"
+      end
+      def bar
+         puts "bar"
+      end
+      implements MyInterface
+   end
+   
+== General Notes
+   Subinterfaces work as well.  See the test_sub.rb file under the 'test'
+   directory for a sample.
+
+== Developer's Notes
+   A discussion on IRC with Mauricio Fernandez got us talking about traits.
+   During that discussion I remembered a blog entry by David Naseby.  I 
+   revisited his blog entry (at http://homepages.ihug.com.au/~naseby/33.html)
+   and took a closer look.
+
+   Keep in mind that I also happened to be thinking about Java at the moment
+   because of a recent job switch that involved coding in Java.  I was also
+   trying to figure out what the purpose of interfaces were.
+
+   As I read the first page of David Naseby's article I realized that,
+   whether intended or not, he had implemented a rudimentary form of interfaces
+   for Ruby.  When I discovered this, I talked about it some more with Mauricio
+   and he and I (mostly him) fleshed out the rest of the module, including some
+   syntax improvements.  The result is syntax and functionality that is nearly
+   identical to Java.
+
+   I should note that, although I am listed as the author, this was mostly the
+   combined work of David Naseby and Mauricio Fernandez.  I just happened to be
+   the guy that put it all together.
+
+== Acknowledgements
+   This module was largely inspired and somewhat copied from a post by
+   David Naseby at http://homepages.ihug.com.au/~naseby/33.html.  It was
+   subsequently modified almost entirely by Mauricio Fernandez through a
+   series of discussions on IRC.
+	
+== Copyright
+   (C) 2004 Daniel J. Berger
+   All rights reserved.
+	
+== Warranty
+   This package is provided "as is" and without any express or
+   implied warranties, including, without limitation, the implied
+   warranties of merchantability and fitness for a particular purpose.
+	
+== License
+   Ruby's
+	
+== Author
+   Daniel J. Berger (who mostly stole it from David Naseby, which was then
+   modified by Mauricio Fernandez)
+   djberg96 at gmail dot com
+   imperator on IRC (irc.freenode.net)

data/lib/interface.rb

@@ -0,0 +1,64 @@
+module Interface
+   Interface::VERSION = "1.0.0"
+   
+   # Raised if a class or instance does not meet the interface requirements.
+   class MethodMissing < RuntimeError; end
+ 
+   # 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)
+   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")}
+      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
+         end
+      end
+      super mod
+   end
+   
+   # 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
+   # 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.	
+#	
+# Subinterfaces will need to 'extend' their parent interface. 
+def interface(&block)
+   mod = Module.new
+   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

data/test/tc_interface.rb

@@ -0,0 +1,53 @@
+#####################################################
+# 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

metadata

@@ -0,0 +1,44 @@
+--- !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: 
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::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
+executables: []
+extensions: []
+requirements: []
+dependencies: []