CSC/ECE 517 Fall 2011/ch2 2c ac

Ruby mixins versus Java interfaces

To inherit from multiple sources Ruby uses mixins while Java uses interfaces. This article explains both mechanisms, finds similarities and highlights differences between the two. Some code samples show the practical use of both mechanisms. The article also tries to remark situations where the use of one mechanism would be more appropriate than the other.

Ruby mixins

In Ruby a mixin happens when a module is included/mixed into a class or into another module.

A module is "a way of grouping together" different elements like class/instance methods, classes, instance variables and constants.(Thomas [3] page 76)

# module Introspect defines a method named 'kind'
module Introspect
  def kind
    puts "#{self.class.name}"
  end
end

A module cannot be instantiated but it can be included/mixed into another class

# The Animal and the Car classes include/mix in the module Introspect
class Animal
  include Introspect
end

class Car
  include Introspect
end

The class that includes a module inherits anything that the module defines.

d = Animal.new
c = Car.new

# the method 'kind' is inherited from the Introspect module
puts d.kind
puts c.kind

# outputs
Animal
Car

Notice that the code in the module has access to variables of the host class. In this sample the kind method defined in the Introspect module accesses the self variable of the host class (either Animal or Car).

Java interfaces

In its most common form, an interface is a group of related methods with empty bodies. A bicycle's behavior, if specified as an interface, might appear as follows:

interface Bicycle {

       void changeGear(int newValue);

       void speedUp(int increment);

       void applyBrakes(int decrement);
}

To implement this interface, the name of your class would change (to a particular brand of bicycle, for example, such as ACMEBicycle), and you'd use the implements keyword in the class declaration:

class ACMEBicycle implements Bicycle {

    void changeGear(int newValue){
    	// method implementation
    }

    void speedUp(int increment){
    	// method implementation
    }

    void applyBrakes(int decrement){
    	// method implementation
    }

}

Comparing Ruby mixins to Java interfaces

These two diagrams from Ruby For Java Programmers illustrates how inheritance is done by Ruby mixins and Java interfaces.

Ruby Mixins	Java Interfaces

Let's look at some of the differences and similarities between Ruby mixins and Java interfaces.

Implementation Inheritance

In Ruby, a class that includes a module inherits the implementation of the methods defined in the module as well as the instance variables defined in the module.

In Java, a class that implements an interface inherits the signatures of the methods defined in the interface but it must provide with the implementation of the methods itself.

In the Ruby sample the host class inherits from the Introspect module the implementation of the kind method and therefore it can call the method right away.

The ability to call the inherited methods right away is good for rapid prototyping, but in Ruby, one should be aware that the include “statement makes a reference to a module. If multiple classes include that module they’ll all point to the same thing. If you change the definition of a method within that module, even while your program is running, all classes that include the module will exhibit the new behavior.” (Thomas [3] page 79)

Bloch reminds us that this is one of the risks of implementation inheritance: for its proper function, the host class may depend on the implementation of the included module. If the implementation of the included module changes the host class may brake. (Bloch [1] page 81)

Another risk associated to implementation inheritance in Ruby is that "mixed-in module's instance variables can clash with the ones of the host class or with the ones of other mixins."(Thomas [3] page 82)

For example the following module adds the instance variable @observer_list

module Observable
  def observers
    @observer_list ||= []
  end
  def add_observer(obj)
    observer << obj
  end
  def notify_observers
    observers.each {|o| o.update}
  end
end

but a class that includes the module could also use an instance variable named @observer_list

class TelescopeScheduler
  # other classes can register to get notifications when the schedule changes
  include Observable
  def initialize
    @observer_list = []  # people with telescope time
  end
  def add_viewer(viewer)
    @observer_list << viewer
  end
end

If this happens, Thomas states that, at runtime, the TelescopeScheduler could malfunction in ways difficult to diagnose. (Thomas [3] page 82)

With Java interfaces this problem cannot happen because there's no implementation inheritance: Any field you declare in an interface is automatically public static and final, in other words a constant and not an instance variable that can be inherited.

Separation of interface and implementation

Java interfaces ensure the separation of interface and implementation by requiring the implementing classes to implement all the methods inherited from the interfaces. Ruby does not enforce this separation in mixins.

For example we have a Shape interface, and a Circle class that implements Shape

package interfaces;

public interface Shape {
	public void draw();
}

package classes;

import interfaces.Shape;

public class Circle implements Shape{
	public void draw()
	{
		System.out.println("This method draws a circle");
	}
}

If the Circle class does not provide a draw method, the class will not compile.

However, in Ruby, an interface can be simulated but a class does not require to override the inherited methods.

module Shape
	def draw
		raise NoMethodError, "draw method is not defined for Shape"
	end
end

class Circle
	include Shape
end

puts Circle.new.draw

=>shape.rb:3:in `draw': draw method is not defined for Shape (NoMethodError)

Method name collision handling

Method names collisions in Java interfaces are eliminated at compile time.

Because of the unbound polymorphism nature, the return type of Ruby method is determined at run time. This allows a class inherits from two modules that include same method call with different return types.

In Java, a class cannot inherit from two interfaces that include same method with different return type, due to the name conflict. For example,

public interface I1 {
	public void method1();
}
public interface I2 {
	public int method1();
}

package classes;
import interfaces.I1;
import interfaces.I2;

public class Mul_inherit implements I1, I2{
...
}

The Mul_inherit class will give error since there are no ways to satisfy both method1 signatures from I1 and I2.

But with Mixin this example is allowed since

1. A method always returns a value (nil if nothing is defined).

2. The type of return object is determined at runtime.

module M1
    def method1
	#this method returns nothing"
    end
end

module M2
    def method1
        "returns a string"
    end
end

class Myclass
include M1
include M2
end

puts Myclass.new.method1

=>returns a string

In Ruby the latest method definition always overloads the previous one, therefore, the name collision needs to be handled more carefully.

To avoid name clashes at the origin each module could prefix the name of a method with the name of the module so that the two modules in the previous example could become

module M1
    def M1method1
	    "this is M1method1"
    end
end

module M2
    def M2method1
        "this is M2method1"
    end
end

class Myclass
include M1
include M2
end

puts Myclass.new.M1method1
puts Myclass.new.M2method1

=>this is M1method1
=>this is M2method1

Ruby mixins vs. Java interfaces feature comparison

Now lets look at some features Ruby mixin provides and compare it with Java interface.

Features	Ruby Mixins	Java Interfaces
Add functionality/behavior to a class	Yes. When a Ruby module gets mixed in a Ruby class, the class receives the implementation (behavior) of the methods defined in the module.	No. A Java interface "can contain only constants, method signatures, and nested types. There are no method bodies. Interfaces cannot be instantiated—they can only be implemented by classes or extended by other interfaces." (Java Interface)
Favor composition over inheritance	Yes. The class that includes a module establishes a "use-a" relationship with the module. This is composition.	No. The class that implements an interface establishes a "is-a" relationship with the interface. This is inheritance.
The code of the mixin/interface interacts with the code of the class that includes/implements it	Yes. A mixed-in module can implement methods in terms of the host's class methods. See the Enumerable example.	No. An interface provides a set of method signatures that the host class must implement. An interface provides no implementation of methods.

Examples

We are going to compare mixin and interface implementations by looking at some code examples.

Comparable

Comparable provides a set of operations that can be used to compare two objects.

In Ruby

If a Ruby class wants to use Comparable functions, it needs to define a method called <=> (sometimes called “rocket”). Ones the rocket function is defined, we get a lot of comparison functions for free, such as <, >, <=, >=, == and the method between.

Suppose we have a Rectangle class.

class Rectangle
    attr_reader :x,:y
    def initialize(x,y)
	@x,@y=x,y
    end
end

Now we want to compare the area of two rectangles. We can do so by include the Comparable mixin.

class Rectangle
include Comparable
    def area
	x*y
    end
    def <=>(other)
	self.area<=>other.area
    end
end

The <=> function uses Comparable mixin of Fixnum class to compare the area of two rectangles. We can call the Comparable methods on Rectangle objects.

r1 = Rectangle.new(3,4)
r2 = Rectangle.new(4,5)
puts r1.area
if r1 < r2
   puts "The area of Rectangle 1 is smaller than Rectangle 2"
else if r1 > r2
   puts "The area of Rectangle 1 is larger than Rectangle 2"
else
   puts "The area of Rectangle 1 equals to Rectangle 2"
 end
end


=>12
=>The area of Rectangle 1 is smaller than Rectangle 2

In Java

Java provides Comparable interface. A Java class implements Comparable interface need to define compareTo method.

For the same Rectangle class example, we need to define compareTo method, and define each of the <=> operators within the method.

public class Rectangle implements Comparable {

	private int x,y;
	
	public Rectangle(int width, int length)
	{
		x=width;
		y=length;
	}
	
	public int area()
	{
		return x*y;
	}
	public int compareTo(Object otherRectangle)
	{
		/*
		 * If passed object is of type other than Rectangle, throw ClassCastException
		 */
		if(!(otherRectangle instanceof Rectangle)){
			 throw new ClassCastException("Invalid object");
		}
		/*
		 * If left operand less than right operand return -1
		 * If left operand greater than right operand return 1
		 * If left operand equals to right operand return 0
		 */
		int otherArea=((Rectangle)otherRectangle).area();
		if (this.area() < otherArea)
			return -1;
		else if (this.area() > otherArea)
			return 1;
		else
			return 0;
	}
}

compareTo function is then used on Rectangle object when comparing two Rectangle objects.

public class CompareRectangle {
	public void main(String args[]){
		
		Rectangle r1=new Rectangle(3,4);		
		Rectangle r2=new Rectangle(4,5);

		if (r1.compareTo(r2) < 0)
			System.out.println("The area of Rectangle 1 is smaller than Rectangle 2");
		if (r1.compareTo(r2) > 0)
			System.out.println("The area of Rectangle 1 is larger than Rectangle 2");
		if (r1.compareTo(r2)==0)
			System.out.println("The area of Rectangle 1 equals to Rectangle 2");
			
	}
}

Singleton

The Singleton design pattern ensures that only one instance of a particular class may be created for the lifetime of a program.

In Ruby

The singleton library contains the Singleton module that if mixed into a class will make the class a singleton. The Singleton module makes the mixee new method private and replaces it with a method called instance that when called returns a singleton instance of the mixee.

You do not have to code the singleton functionality inside each class that needs to be a singleton.

require 'singleton'

class Klass
      include Singleton
end

a,b  = Klass.instance, Klass.instance
=> [#<Klass:0x007fa7a28798e8>, #<Klass:0x007fa7a28798e8>]

a == b
=> true

Klass.new
NoMethodError: private method `new' called for Klass:Class

In Java

Each class that needs to be a singleton must implement the singleton functionality itself such as in the following example.

public class Singleton  {
    private static final Singleton instance = new Singleton();
 
/**
Private constructor prevents instantiation from other classes
**/
    private Singleton() {
    }
 
    public static Singleton getInstance() {
        return instance;
    }
}

Enumerable

The Enumerable pattern is used to describe a set of fix constants.

In Ruby

Enumerable is a standard mixin in Ruby that can be included in any class. A class wants to use Enumerable functions need to define each method.

Consider a class takes a string and change the words to uppercase.

class WordToUpper
include Enumerable
    attr_reader :string
    def initialize(string)
	@string=string
    end
    def each
	@string.upcase.scan(/\w/) do |upper|
	  yield upper
        end
    end
    def to_s
        self.each{|a| puts a}
    end
end

Now that each method is defined we can use inject method from Enumerable mixin.

puts WordToUpper.new("Rudolph is a Ring Deer!").inject{|v,n| v+n}

=>RUDOLPHISARINGDEER

In Java

In Java there is no interface comparable to the Enumerable mixin in Ruby defined. Java can simulate the use of Enumerable by using Iterator class. However, it is not as convenient as have a Enumerable interface.

import java.util.*;

public class EnumerableExample {
	public static void main(String args[])
	{
	    //removal of items requires an explicit iterator :
	    Collection<String> words = new ArrayList<String>();
	    words.add("Rudolph");
	    words.add("is");
	    words.add("a");
	    words.add("red");
	    words.add("nose");
	    words.add("ring");
	    words.add("deer");
	    for(Iterator<String> iter = words.iterator(); iter.hasNext();){
	      if (iter.next().length() == 4){
	        iter.remove();
	      }
	    }
	}
}

In this example, we removed all strings with length of 4 in the Collection.

DataMapper

Martin Fowler describes the Data Mapper design pattern as "a layer of software that separates the in-memory objects from the database. Its responsibility is to transfer data between the two and also to isolate them from each other. With Data Mapper the in-memory objects needn't know even that there's a database present; they need no SQL interface code, and certainly no knowledge of the database schema. (The database schema is always ignorant of the objects that use it.)"(Data Mapper)

In Ruby

The DataMapper Ruby library was originally developed to address perceived shortcomings in Ruby on Rails' ActiveRecord library. For example DataMapper lets you avoid writing raw query fragments yourself. It allows you to write

Zoo.all(:name => 'Dallas')

instead of

Zoo.find(:all, :conditions => [ 'name = ?', 'Dallas' ])

In Java

The mybatis SQL Mapping Framework implements the Data Mapper design pattern. Its setup and use though seem more complicated than the DataMapper Ruby library.

Mixins in Java

Java does not support mixins natively.

Different approaches try to reproduce the mixin feature in Java.

One example is the cgilb Java library. It provides the Mixin class that allows multiple objects to be combined into a single larger object at run time. The methods in the generated object simply call the original methods in the underlying "delegate" objects.

A similar result is achieved at compile time by this Java annotations processor. Let's say for example that you want to combine/mix the functionality of three classes into one class. You can write a Java annotation that declares which classes you want to mix, then you pass this annotation to the annotation processor and you get the source code of a class that combines all the three behaviors.

Another approach is to implement the Decorator design pattern. In this case the new behavior is added not statically to classes at compile time but to specific objects/instances at run time.

Conclusion

In comparison with Java interface, Ruby mixin provides more flexibility and functionality. Ruby mixin can include behavior to a class. It makes mix and match of several classes easy. It also includes many standard mixins such as Singleton, Comparable, Enumerable and Datamapper, these standard modules make these design patterns easy to use and inherit functions by new objects. While Ruby mixin might seem more powerful than Java interface, Java interface still have its advantage over Ruby mixin in some cases. Java interface handles separation of interface and implementation better, it also handles name collision more strictly than Ruby mixin. Furthermore, when Ruby class includes a module, it gets a reference of the module, which increases coupling between the class and the included module. If the included module changes during runtime the class might result in some unexpected behavior.

References

1. Joshua Bloch, "Effective Java". Second Edition. May 2008, Prentice Hall.

2. Ruby For Java Programmers by Mike Bowler.

3. Dave Thomas, Chad Fowler, Andy Hunt, "Programming Ruby 1.9: The Pragmatic Programmers' Guide (Facets of Ruby Series)". Third Edition. April 2009, Pragmatic Bookshelf.

4. Java Interface From oracle.com, the Java Tutorials.

5. Mixin From Wikipedia, the free encyclopedia.

6. Data Mapper Design Pattern From Martin Fowler.

7. Data Mapper in Ruby From DataMapper, Ruby Object Relational Mapper.

8. Data Mapper in Java From mybatis - SQL mapping framwork for Java.

9. cgilb From Code Generation Library, sourceforge.net.

10. Java annotations processor From AnnotationsMixinExample, JavaDude OpenSource Projects.

11. Decorator pattern From Wikipedia, the free encyclopedia.