Class: Dim::Container

Inherits:
Object
  • Object
show all
Defined in:
lib/dim.rb

Overview

Dim::Container is the central data store for registering services used for dependency injuction. Users register services by providing a name and a block used to create the service. Services may be retrieved by asking for them by name (via the [] operator) or by selector (via the method_missing technique).

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(parent = nil) ⇒ Container

Create a dependency injection container. Specify a parent container to use as a fallback for service lookup.



51
52
53
54
55
 
# File 'lib/dim.rb', line 51

def initialize(parent=nil)
  @services = {}
  @cache = {}
  @parent = parent || Container
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(sym, *args, &block) ⇒ Object

Lookup a service by message selector. A service with the same name as sym will be returned, or an exception is thrown if no matching service is found.



110
111
112
 
# File 'lib/dim.rb', line 110

def method_missing(sym, *args, &block)
  self[sym]
end

Instance Attribute Details

#parent ⇒ Object (readonly)

Returns the value of attribute parent.



47
48
49
 
# File 'lib/dim.rb', line 47

def parent
  @parent
end

Class Method Details

.service_block(name) ⇒ Object

Searching for a service block only reaches the Container class when all the containers in the hierarchy search chain have no entry for the service. In this case, the only thing to do is signal a failure.



130
131
132
 
# File 'lib/dim.rb', line 130

def self.service_block(name)
  fail(MissingServiceError, "Unknown Service '#{name}'")
end

.service_list ⇒ Object

initial implementation for a clean Container



103
104
105
 
# File 'lib/dim.rb', line 103

def self.service_list
  []
end

Instance Method Details

#[](name) ⇒ Object

Lookup a service by name. Throw an exception if no service is found.



91
92
93
 
# File 'lib/dim.rb', line 91

def [](name)
  @cache[name] ||= service_block(name).call(self)
end

#clear_cache! ⇒ Object

Resets the cached services



122
123
124
 
# File 'lib/dim.rb', line 122

def clear_cache!
  @cache = {}
end

#register(name, &block) ⇒ Object

Register a service named name. The block will be used to create the service on demand. It is recommended that symbols be used as the name of a service.



65
66
67
68
69
70
71
72
73
74
 
# File 'lib/dim.rb', line 65

def register(name, &block)
  if @services[name]
    fail DuplicateServiceError, "Duplicate Service Name '#{name}'"
  end
  @services[name] = block

  self.class.send(:define_method, name) do
    self[name]
  end
end

#register_env(name) ⇒ Object

Lookup a service from ENV variables; fall back to searching the container and its parents for a default value



77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/dim.rb', line 77

def register_env(name)
  if value = ENV[name.to_s.upcase]
    register(name) { value }
  else
    begin
      @parent.service_block(name)
    rescue MissingServiceError
      raise EnvironmentVariableNotFound, "Could not find an ENV variable named #{name.to_s.upcase} nor could we find a service named #{name} in the parent container"
    end
  end
end

#service_block(name) ⇒ Object

Return the block that creates the named service. Throw an exception if no service creation block of the given name can be found in the container or its parents.



117
118
119
 
# File 'lib/dim.rb', line 117

def service_block(name)
  @services[name] || @parent.service_block(name)
end

#service_list ⇒ Array

a list with services, that this container provides

Returns:

  • (Array) 


98
99
100
 
# File 'lib/dim.rb', line 98

def service_list
  (@services.keys + @parent.service_list).flatten.uniq
end

#to_s ⇒ Object 



57
58
59
60
 
# File 'lib/dim.rb', line 57

def to_s
  info = " services: #{service_list}"
  "<Dim::Container::#{self.__id__}:#{info}>"
end