Class: Wirer::Service

Inherits:
Object
  • Object
show all
Extended by:
Factory::ClassDSL
Defined in:
lib/wirer/service.rb

Overview

This is a small convenience superclass which you can (but needn’t if you’d rather not) inherit from when making wireable classes.

It comes pre-extended with Wirer::Factory::ClassDSL, and it defines initialize for you to save each constructor dependency in an appropriately-named instance variable. (note that the ‘dependency’ class method will also have declared an attr_reader

with this name too, so you'll be able to get at it that way also.)

Its ‘new’ method also type-checks the arguments to ensure that it has indeed been supplied with all the right dependencies that it was expecting. Since we have the metadata lying around for what is required, may as well take advantage of it. This is most handy if you’re constructing instances manually rather than via a Wirer::Container – eg in unit tests.

It also sets a straightforward convention for arguments to the constructor: dependencies and other arguments are given in a single Hash argument.

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Factory::ClassDSL

constructor_dependencies, provides_features, setter_dependencies

Methods included from Factory::ClassMixin

#new_from_dependencies, #provides_class

Methods included from Factory::Interface

#constructor_dependencies, #curry_with_dependencies, #inject_dependency, #new_from_dependencies, #post_initialize, #provides_class, #provides_features, #setter_dependencies, #wrapped_with

Constructor Details

#initialize(dependencies = {}) ⇒ Service

Returns a new instance of Service.

Raises:

  • (ArgumentError) 


44
45
46
47
48
49
 
# File 'lib/wirer/service.rb', line 44

def initialize(dependencies={})
  raise ArgumentError, "expected a Hash of dependencies" unless dependencies.is_a?(Hash)
  self.class.constructor_dependencies.each do |name, dependency|
    instance_variable_set(:"@#{name}", dependencies[name])
  end
end

Class Method Details

.new(dependencies) ⇒ Object 



26
27
28
29
30
31
 
# File 'lib/wirer/service.rb', line 26

def new(dependencies, *)
  constructor_dependencies.each do |name, dependency|
    dependency.check_argument(name, dependencies[name], true)
  end
  super
end

.new_from_dependencies ⇒ Object

new_from_dependencies, which the container uses, will skip any type-checking as the container is designed to supply the right dependencies.



24
 
# File 'lib/wirer/service.rb', line 24

alias :new_from_dependencies :new

.new_skipping_type_checks(dependencies, *p, &b) ⇒ Object

this one will check that the relevant dependency arguments are passed, but won’t check their types - useful if you want to pass in mocks for testing.



36
37
38
39
40
41
 
# File 'lib/wirer/service.rb', line 36

def new_skipping_type_checks(dependencies, *p, &b)
  constructor_dependencies.each do |name, dependency|
    dependency.check_argument(name, dependencies[name], false)
  end
  new_from_dependencies(dependencies, *p, &b)
end