Class: Ruote::Exp::IncExpression

Inherits:
SetExpression show all
Defined in:
lib/ruote/exp/fe_inc.rb

Overview

Increments or decrements the value found in a process variable or a workitem field.

One points to a var or a field in these various ways :

sequence do
  inc :var => 'counter'
  inc :field => 'counter'
  inc 'v:counter'
  inc 'f:counter'
end

‘inc’ and ‘dec’ work with two types of values : numbers (the default) and arrays.

numbers

The vanilla case of inc/dec is increasing/decreasing a value by 1.

dec :var => 'x'

will decrease the value in variable ‘x’ by 1.

inc/dec works with two kind of numbers, integers and floats.

If the target var or field is not set, it will be assumed to be at zero.

The default increment is 1 (or 1.0 for floats). It can be changed by passing a value to the inc/dec expression.

inc 'v:x', :val => 3
inc 'v:y', :val => 2.4

arrays

inc/dec can be used to push/pop elements in arrays held in process variables or workitem fields.

This fragment of process definition

sequence do
  set 'v:x' => %w[ a b c d ]
  repeat do
    dec 'v:x', :pos => 'head'
    _break :unless => '${v:d}'
    participant '${v:d}'
  end
end

is equivalent to

iterator :on => 'a, b, c, d', :to_var => 'x' do
  participant '${v:x}'
end

More details : the inc expression expects a value and it will place it at the end of the current array. The :pos or :position attribute can be set to ‘head’ to let the inc expression place the value at the head of the array.

set 'v:x' => [ 'alfred', 'bryan' ]
set 'v:customer_name' => 'charles'

inc 'v:x', :val => '${v:customer_name}'
  # the variable 'x' now holds [ 'alfred', 'bryan', 'charles' ]
inc 'v:y', :val => '${v:customer_name}', :pos => 'head'
  # the variable 'x' now holds [ 'charles', 'alfred', 'bryan', 'charles' ]

The ‘dec’ / ‘decrement’ variant of the expression will remove the tail value (by default) of the array, or the head value if :pos is set to ‘head’.

It’s also possible to remove a specific value by passing it to ‘dec’ :

set 'v:x' => [ 'alfred', 'bryan', 'carl' ]
dec 'v:x', :val => 'bryan'
  # the variable 'x' now holds [ 'alfred', 'carl' ]

‘dec’ places the removed value in the local variable named ‘d’. This trick was used in the above iterator example.

A specific variable or field can be specified via the :to_var / :to_field attributes :

dec 'v:x', :to_v => 'a'
participant :ref => '${v:a}'

Constant Summary

Constants inherited from FlowExpression

FlowExpression::COMMON_ATT_KEYS

Instance Attribute Summary

Attributes inherited from FlowExpression

#context, #error, #h

Instance Method Summary collapse

Methods inherited from FlowExpression

#ancestor?, #att, #attribute, #attribute_text, #attributes, #cancel, #compile_atts, #compile_variables, do_action, #do_apply, #do_cancel, #do_fail, #do_pause, #do_persist, #do_reply, #do_resume, #do_unpersist, #expand_atts, #fei, fetch, from_h, #handle_on_error, #has_attribute, #initial_persist, #initialize, #iterative_var_lookup, #launch_sub, #lookup_on_error, #lookup_val, #lookup_val_prefix, #lookup_variable, #name, names, #parent, #parent_id, #persist_or_raise, #reply_to_parent, #set_variable, #to_h, #tree, #tree_children, #try_persist, #try_unpersist, #unpersist_or_raise, #unset_variable, #update_tree, #variables

Methods included from WithMeta

#class_def, included

Methods included from WithH

included

Constructor Details

This class inherits a constructor from Ruote::Exp::FlowExpression

Instance Method Details

#apply ⇒ Object 



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/ruote/exp/fe_inc.rb', line 124

def apply

  if var_key = has_attribute(:v, :var, :variable)

    var = attribute(var_key)
    set_v(var, new_value(:var, var))

  elsif field_key = has_attribute(:f, :fld, :field)

    field = attribute(field_key)
    set_f(field, new_value(:field, field))

  else

    k = attribute_text

    raise(
      ArgumentError.new('no variable or field to increment/decrement')
    ) if k.length < 1

    set_vf(k, new_value(nil, k))

  #else
  #  raise ArgumentError.new(
  #    "missing a variable or field target in #{tree.inspect}")
  end

  reply_to_parent(h.applied_workitem)
end

#reply(workitem) ⇒ Object 



154
155
156
157
 
# File 'lib/ruote/exp/fe_inc.rb', line 154

def reply(workitem)

  # never called
end