contractual 0.0.1 → 0.0.2

data/README.md

@@ -31,37 +31,36 @@ Or install it yourself as:
 
 Consider a canonical superclass.
 
-  class Vehicle
-    def drive(passengers, destination)
-      load passengers
-      follow Route.new(@current_location, destination)
-      unload passengers
+    class Vehicle
+      def drive(passengers, destination)
+        load passengers
+        follow Route.new(@current_location, destination)
+        unload passengers
+      end
     end
-  end
   
-See all the methods have to be implemented for this to work? Let's specify these as part of the interface:
+Note all the methods have to be implemented for this to work (load, follow, unload). Let's go ahead and specify these as part of the interface:
 
-  class Vehicle
+    class Vehicle
+      include Contractual::Interface
     
-    must_implement :load, :passengers
-    must_implement :follow, :route
-    must_implement :unload, :passengers
+      must :load, :passengers
+      must :follow, :route
+      must :unload, :passengers
     
-    def move(passengers, destination)
-      load passengers
-      follow Route.new(@current_location, destination)
-      unload passengers
+      def move(passengers, destination)
+        load passengers
+        follow Route.new(@current_location, destination)
+        unload passengers
+      end
     end
-  end
 
 Let's suppose we've been handed this interface from another developer. How do we make a custom subclass? Our first attempt at implementing might look something like this:
 
-  class Zeppelin
-    
-    def load(passengers); @passengers << passengers; end
-    def unload(passengers); @current_location << passengers; @passengers = []; end
-    
-   end
+    class Zeppelin
+      def load(passengers); @passengers << passengers; end
+      def unload(passengers); @current_location << passengers; @passengers = []; end
+    end
    
 So now when we try to invoke Zeppelin.move, we'll get an exception warning us that Zeppelin is obligated to implement a method 'follow' from the interface Vehicle. This is the 'hint' that the implementing developer has a bit more work to do before they can use this custom class smoothly with the rest of the system. 
 

data/lib/contractual.rb

@@ -20,7 +20,7 @@ module Contractual
         klass_name = klass.class.name
         interface_name = self.name
 
-        raise MethodNotImplementedError.new("#{klass.class.name} needs to implement '#{method_name}' for interface #{self.name}!")
+        raise MethodNotImplementedError.new("#{klass.class.name} is obligated to implement '#{method_name}' for interface #{self.name}!")
       end
     end
 

data/lib/contractual/version.rb

@@ -1,3 +1,3 @@
 module Contractual
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/contractual_spec.rb

@@ -0,0 +1,24 @@
+require 'contractual'
+
+describe Contractual::Interface, "an interface should support a contract" do
+  
+  class MockInterface
+    include Contractual::Interface
+    
+    must_implement :mock_operation
+    must :perform_another_mock_operation
+    
+  end
+
+  class MockInterfaceImpl < MockInterface; end
+
+
+  it "should warn about unimplemented methods" do
+    mock_object = MockInterfaceImpl.new
+  
+    lambda { mock_object.mock_operation }.should raise_error(Contractual::Interface::MethodNotImplementedError, "MockInterfaceImpl is obligated to implement 'mock_operation' for interface MockInterface!")
+
+    lambda { mock_object.perform_another_mock_operation }.should raise_error(Contractual::Interface::MethodNotImplementedError, "MockInterfaceImpl is obligated to implement 'perform_another_mock_operation' for interface MockInterface!")
+  
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: contractual
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -30,6 +30,7 @@ files:
 - contractual.gemspec
 - lib/contractual.rb
 - lib/contractual/version.rb
+- spec/contractual_spec.rb
 homepage: ''
 licenses: []
 post_install_message: 
@@ -54,4 +55,5 @@ rubygems_version: 1.8.22
 signing_key: 
 specification_version: 3
 summary: Specify interface contracts for your Ruby classes.
-test_files: []
+test_files:
+- spec/contractual_spec.rb