Module: Toys::Mixin::ModuleMethods

Defined in:
core-docs/toys/mixin.rb

Overview

Defined in the toys-core gem

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.



139
140
141
 
# File 'core-docs/toys/mixin.rb', line 139

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.



118
119
120
 
# File 'core-docs/toys/mixin.rb', line 118

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) 


128
129
130
 
# File 'core-docs/toys/mixin.rb', line 128

def on_include(&block)
  # Source available in the toys-core gem
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) 


106
107
108
 
# File 'core-docs/toys/mixin.rb', line 106

def on_initialize(&block)
  # Source available in the toys-core gem
end