sinject 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4af2aa3adf1d05d2aa82f6d0a1e7b84472ec5636
-  data.tar.gz: a8b340a1a844345f333a797d75dfd13b8b3422f7
+  metadata.gz: 84ae556b8e2fd2b90c6a6098c655a72133e3190c
+  data.tar.gz: d6994c60f60a5dad2d1cb7179c166c1255301585
 SHA512:
-  metadata.gz: ec9d058bdcd92b89f70b836f785ae44ac78ca753398d585f89447664d535fc3332bcb0c8559bc49601035cb3abc2ca99739510f17c0fa41f7e3ca027706e23e2
-  data.tar.gz: 8476d4e97aa02e22ffd58a9aecd97ae09093308dde230831e9268099391b3445c68e582ed912df605956155e2d38aead4a4a86e0637d0eef332425c849bddd3f
+  metadata.gz: bc23325620a024329a2acb4c49fe97fbed19e647353e943da931cb7c9ed900175ccfcd4dc2ced889a1366a35237f696933e3c401247693b841435be9c491ea7b
+  data.tar.gz: 1e8ba21b96980fbd99b62a18f59cb28b6c9f0549301a8882b09255262ec0ccdbc89a1b30e8d652748fd8c659883dd49cdd89dbb6789403ca99c4df056118bcb5

data/README.md

@@ -43,9 +43,8 @@ Dependencies can be registered with the container in 2 modes:
 
 The registration mode can be set by specifying **true** or **false** to the *'single_instance'* argument of the containers register method.
 
-Dependencies that require custom initialization can be registered with an initialization block to creates the dependency, this allows you more control over how the dependency is create:
+Dependencies that require custom initialization can be registered with an initialization block to handle creation of the dependency, this allows you more control over how the dependency is created:
 
-    #register your dependencies
     container.register(:cache_store, RedisCacheStore, true) do
         instance = RedisCacheStore.new
         instance.host = 'http://localhost'
@@ -53,17 +52,16 @@ Dependencies that require custom initialization can be registered with an initia
         instance
     end
 
-Dependencies with a custom initialization block must return an object of the registered dependency class name, if an unexpected instance is returned then Sinject will raise a `DependencyInitializeException`.
+Dependencies with a custom initialization block must return an object of the registered dependency class type, if an unexpected instance is returned then Sinject will raise a `DependencyInitializeException`.
 
 **Dependency Contracts**
 
-Dependency contracts can be defined and used to validate registered dependencies are valid for the task they are being registered for.
+Dependency contracts can be defined to validate registered dependencies are valid for the task they are being registered for.
 
-To create a dependency contract you simply create a new class with empty methods for each of the methods that the dependency needs to respond to in order to fulfill it's role:
+To create a dependency contract you need to create a new class with empty methods for each of the methods that the dependency needs to respond to in order to fulfill it's role:
 
-    #initialize the container
     class LoggerContract
-        def write
+        def write(message)
         end
     end
 
@@ -72,7 +70,11 @@ Then when registering a dependency for the role the contract is written for, you
     #register the dependency
     container.register(:logger, FileLogger, false, LoggerContract)
     
-Sinject will then validate that the registered dependency meets the requirements specified within the contract. If a dependency does not meet the contract requirements then a `DependencyContractException` is raised.
+Sinject will then validate that the registered dependency meets the requirements specified within the contract. If a dependency does not meet the contract requirements then 1 of the following exceptions will be raised:
+
+- `DependencyContractMissingMethodsException` is raised when 1 or more methods from the contract could not be found on the dependency.
+- `DependencyContractInvalidParametersException` is raised when the parameters of a contract method do not match the parameters found on a dependency method.
+
 
 **Assigning dependencies**
 

data/lib/sinject.rb

@@ -41,11 +41,8 @@ class SinjectContainer
 
     #check if a contract has been specified
     if contract_class_name != nil
-      #check if any contract methods are mising
-      missing_methods = validate_contract(dependency_class_name, contract_class_name)
-      if !missing_methods.empty?
-        raise DependencyContractException.new(missing_methods)
-      end
+      #validate the dependency class against the contract
+      validate_contract(dependency_class_name, contract_class_name)
     end
 
     item = ContainerItem.new
@@ -91,12 +88,33 @@ class SinjectContainer
   private
 
   def validate_contract(dependency_class, contract_class)
+
     #get the methods defined for the contract
     contract_methods = (contract_class.instance_methods - Object.instance_methods)
     #get the methods defined for the dependency
     dependency_methods = (dependency_class.instance_methods - Object.instance_methods)
     #calculate any methods specified in the contract that are not specified in the dependency
-    contract_methods - dependency_methods
+    missing_methods = contract_methods - dependency_methods
+
+    if !missing_methods.empty?
+      raise DependencyContractMissingMethodsException.new(missing_methods)
+    end
+
+    #loop through each contract method
+    contract_methods.each do |method|
+
+      #get the contract method parameters
+      cmp = contract_class.instance_method(method).parameters
+      #get teh dependency method parameters
+      dmp = dependency_class.instance_method(method).parameters
+
+      #check if the parameters match for both methods
+      if cmp != dmp
+        raise DependencyContractInvalidParametersException.new(method, cmp)
+      end
+
+    end
+
   end
 
   def create_instance(item)
@@ -153,7 +171,7 @@ class Class
   end
 end
 
-class DependencyContractException < StandardError
+class DependencyContractMissingMethodsException < StandardError
   def initialize(methods)
     @methods = methods
   end
@@ -164,6 +182,18 @@ class DependencyContractException < StandardError
   end
 end
 
+class DependencyContractInvalidParametersException < StandardError
+  def initialize(method, parameters)
+    @method = method
+    @parameters = parameters
+  end
+
+  def to_s
+    parameter_names = @parameters.join(', ')
+    "The method signature of method: '#{@method}' does not match the contract parameters: '#{parameter_names}'"
+  end
+end
+
 class DependencyInitializeException < StandardError
 
   def initialize(expected_type)

data/lib/sinject/version.rb

@@ -1,3 +1,3 @@
 module Sinject
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sinject
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - vaughan britton