Class: DataMiner::Step::Process

Inherits:

DataMiner::Step

• Object
• DataMiner::Step
• DataMiner::Step::Process

Defined in:

lib/data_miner/step/process.rb

Overview

A step that executes a single class method on the model or an arbitrary code block.

Create these by calling process inside a data_miner block.

See Also:

• Overview of how to define data miner scripts inside of ActiveRecord models.
• Creating a process step by calling DataMiner::Script#process from inside a data miner script

Instance Attribute Summary

• #blk ⇒ Proc readonly

  The block of arbitrary code to be run.

• #description ⇒ String (also: #block_description) readonly

  A description of what the block does.

• #method_id ⇒ Symbol readonly

  The method to be called on the model class.

Method Summary

Methods inherited from DataMiner::Step

#notify, #pos, #register, #target?

Instance Attribute Details

#blk ⇒ Proc (readonly)

The block of arbitrary code to be run.

Returns:

• (Proc)

# File 'lib/data_miner/step/process.rb', line 20

def blk
  @blk
end

#description ⇒ String (readonly) Also known as: block_description

A description of what the block does. Doesn’t exist when a single class method is specified using a Symbol.

Returns:

• (String)

# File 'lib/data_miner/step/process.rb', line 16

def description
  @description
end

#method_id ⇒ Symbol (readonly)

The method to be called on the model class.

Returns:

• (Symbol)

# File 'lib/data_miner/step/process.rb', line 12

def method_id
  @method_id
end