Class: Eddy::Models::Loop::Repeat

Inherits:

Object

• Object
• Eddy::Models::Loop::Repeat

Defined in:

lib/eddy/models/loop/repeat.rb

Overview

Data form a single loop iteration.

Direct Known Subclasses

TransactionSets::TS810::Loops::IT1::Repeat, TransactionSets::TS810::Loops::N1::Repeat, TransactionSets::TS810::Loops::PID::Repeat, TransactionSets::TS810::Loops::SAC::Repeat, TransactionSets::TS846::Loops::LIN::Repeat, TransactionSets::TS846::Loops::N1::Repeat, TransactionSets::TS846::Loops::QTY::Repeat, TransactionSets::TS846::Loops::SCH::Repeat, TransactionSets::TS846::Loops::SLN::Repeat, TransactionSets::TS850::Loops::CTP::Repeat, TransactionSets::TS850::Loops::N1::Repeat, TransactionSets::TS850::Loops::N9::Repeat, TransactionSets::TS850::Loops::PID::Repeat, TransactionSets::TS850::Loops::PO1::Repeat, TransactionSets::TS850::Loops::SAC::Repeat, TransactionSets::TS855::Loops::ACK::Repeat, TransactionSets::TS855::Loops::N1::Repeat, TransactionSets::TS855::Loops::PID::Repeat, TransactionSets::TS855::Loops::PO1::Repeat, TransactionSets::TS856::Loops::HL_Item::Repeat, TransactionSets::TS856::Loops::HL_Order::Repeat, TransactionSets::TS856::Loops::HL_Shipment::Repeat, TransactionSets::TS856::Loops::HL_Tare::Repeat, TransactionSets::TS856::Loops::N1::Repeat, TransactionSets::TS856::Loops::SLN::Repeat

Instance Attribute Summary

• #components ⇒ Array<Eddy::Models::Segment, Eddy::Models::Loop::Base> readonly

  An array of Segments and/or other Loops.

• #store ⇒ Eddy::Data::Store readonly

  Data passed down from a Transaction Set.

Instance Method Summary

• #all_contents ⇒ Array<Eddy::Models::Segment>

  Return all contained Segments in a single, flattened array.

• #initialize(store, *components) ⇒ void constructor

  All of a Loop's elements need to be declared in its constructor.

• #repeat {|rep| ... } ⇒ self

Constructor Details

#initialize(store, *components) ⇒ void

All of a Loop's elements need to be declared in its constructor.

Parameters:

• store (Eddy::Data::Store)
• components (Array<Eddy::Models::Loop, Eddy::Models::Segment>)

# File 'lib/eddy/models/loop/repeat.rb', line 19

def initialize(store, *components)
  @store = store
  components.flatten!
  @components = components || []
end

Instance Attribute Details

#components ⇒ Array<Eddy::Models::Segment, Eddy::Models::Loop::Base> (readonly)

An array of Segments and/or other Loops. This is used as a template to populate content.

Returns:

• (Array<Eddy::Models::Segment, Eddy::Models::Loop::Base>)

# File 'lib/eddy/models/loop/repeat.rb', line 10

def components
  @components
end

#store ⇒ Eddy::Data::Store (readonly)

Returns Data passed down from a Transaction Set.

Returns:

• (Eddy::Data::Store) —

  Data passed down from a Transaction Set.

# File 'lib/eddy/models/loop/repeat.rb', line 12

def store
  @store
end

Instance Method Details

#all_contents ⇒ Array<Eddy::Models::Segment>

Return all contained Segments in a single, flattened array.

Returns:

• (Array<Eddy::Models::Segment>)

# File 'lib/eddy/models/loop/repeat.rb', line 28

def all_contents()
  contents = self.components.flatten.map do |c|
    case c
    when Eddy::Models::Loop::Repeat then c.all_contents()
    when Eddy::Models::Loop::Base   then c.all_contents()
    when Eddy::Models::Segment      then c
    else raise Eddy::Errors::RenderError
    end
  end
  return contents.flatten
end

#repeat {|rep| ... } ⇒ self

Yield Parameters:

• rep (self)

Returns:

• (self)

# File 'lib/eddy/models/loop/repeat.rb', line 42

def repeat()
  if block_given?
    yield(self)
  else
    raise Eddy::Errors::Error, "No block given in loop iteration"
  end
  return self
end