Class: Magicka::Helper::AggregatorOptions Private

Inherits:
Sinclair::Options
  • Object
show all
Defined in:
lib/magicka/helper/aggregator_options.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Options when generating Magicka::Helper aggregator methods

This is used when calling Helper.with

Instance Method Summary collapse

Instance Method Details

#config_block ⇒ Proc

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Block to be used when configuring a new aggregator class

Returns:

  • (Proc) 



# File 'lib/magicka/helper/aggregator_options.rb', line 13

#configured_aggregator ⇒ Class<Aggregator>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns the ready to use aggregator class

Returns:



23
24
25
 
# File 'lib/magicka/helper/aggregator_options.rb', line 23

def configured_aggregator
  @configured_aggregator ||= configure_aggregator
end

#type ⇒ Symbol

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Type of the aggregator

Type of aggregator will be used when defining the helper method

Returns:

  • (Symbol) 


32
33
34
 
# File 'lib/magicka/helper/aggregator_options.rb', line 32

def type
  @type ||= aggregator.type
end