Module: Toys::Mixin::ModuleMethods

Defined in:
lib/toys/mixin.rb

Overview

Methods that will be added to a mixin module object.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#inclusion ⇒ Proc

The inclusion proc for this mixin. This block is evaluated in the tool class immediately after the mixin is included, and is passed any arguments provided to the include directive.

Returns:

  • (Proc) —

    The inclusion procedure for this mixin.



170
171
172
 
# File 'lib/toys/mixin.rb', line 170

def inclusion
  @inclusion
end

#initializer ⇒ Proc

The initializer proc for this mixin. This proc is evaluated in the runtime context before execution, and is passed any arguments provided to the include directive. It can perform any runtime initialization needed by the mixin.

Returns:

  • (Proc) —

    The iniitiliazer for this mixin.



148
149
150
 
# File 'lib/toys/mixin.rb', line 148

def initializer
  @initializer
end

Instance Method Details

#on_include(&block) ⇒ self

Set an inclusion proc for this mixin. This block is evaluated in the tool class immediately after the mixin is included, and is passed any arguments provided to the include directive.

Parameters:

  • block (Proc) —

    Sets the inclusion proc.

Returns:

  • (self) 


158
159
160
161
 
# File 'lib/toys/mixin.rb', line 158

def on_include(&block)
  self.inclusion = block
  self
end

#on_initialize(&block) ⇒ self

Set the initializer for this mixin. This block is evaluated in the runtime context before execution, and is passed any arguments provided to the include directive. It can perform any runtime initialization needed by the mixin.

Parameters:

  • block (Proc) —

    Sets the initializer proc.

Returns:

  • (self) 


135
136
137
138
 
# File 'lib/toys/mixin.rb', line 135

def on_initialize(&block)
  self.initializer = block
  self
end