Class: Trooper::Strategy

Inherits:

Object

• Object
• Trooper::Strategy

show all

Defined in:

lib/trooper/strategy.rb

Instance Attribute Summary (collapse)

• - (Object) block readonly

  Returns the value of attribute block.

• - (Object) config readonly

  Returns the value of attribute config.

• - (Object) description readonly

  Returns the value of attribute description.

• - (Object) name readonly

  Returns the value of attribute name.

• - (Object) prereq_run_list readonly

  Returns the value of attribute prereq_run_list.

• - (Object) run_list readonly

  Returns the value of attribute run_list.

Instance Method Summary (collapse)

• - (Object) action(name, description = "No Description", &block)

  Public: Add an Action to the Task list but scoped to this Strategy (Action Not available outside this object).

• - (Object) actions(*action_names)

  Public: Add actions to the run list.

• - (Object) call(*strategy_names)

  Public: Add other strategies actions to the run list.

• - (Strategy) initialize(name, description, config = {}, &block) constructor

  Public: Initialize a new Strategy object.

• - (Object) list(configuration = {})

  Public: The Task List.

• - (Object) method_missing(method_sym, *arguments, &block)

  :nodoc:.

• - (Boolean) ok?

  Public: Validates the strategy object.

• - (Object) prerequisites(*strategy_names)

  Public: Add other strategies actions to the prerequisite run list.

Strategy.new :my_strategy, 'Does something cool' do
  actions :my_action
end

22
23
24
25

# File 'lib/trooper/strategy.rb', line 22

def initialize(name, description, config = {}, &block)
  @name, @description, @config = name, description, config
  @run_list, @prereq_run_list, @block = [], [], block
end

136
137
138

# File 'lib/trooper/strategy.rb', line 136

def method_missing(method_sym, *arguments, &block) # :nodoc:
  config[method_sym] || super
end

6
7
8

# File 'lib/trooper/strategy.rb', line 6

def block
  @block
end

6
7
8

# File 'lib/trooper/strategy.rb', line 6

def config
  @config
end

6
7
8

# File 'lib/trooper/strategy.rb', line 6

def description
  @description
end

6
7
8

# File 'lib/trooper/strategy.rb', line 6

def name
  @name
end

6
7
8

# File 'lib/trooper/strategy.rb', line 6

def prereq_run_list
  @prereq_run_list
end

6
7
8

# File 'lib/trooper/strategy.rb', line 6

def run_list
  @run_list
end

@strategy.action(:my_action, 'Does great things') { run 'touch file' }

112
113
114
115
116
117
118
119
120

# File 'lib/trooper/strategy.rb', line 112

def action(name, description = "No Description", &block)
  action_name = "#{self.name}_#{name}".to_sym

  action = Trooper::Action.new action_name, description, &block
  Arsenal.actions.add action
  actions action_name
  
  action
end

@strategy.actions(:my_action) # => nil

91
92
93
94
95
96
97
98

# File 'lib/trooper/strategy.rb', line 91

def actions(*action_names)
  [*action_names].each do |name| 
    if Arsenal.actions[name]
      # strategy_name, type, name
      @run_list << [self.name, Arsenal.actions[name].type, name]
    end
  end
end

@strategy.call(:my_other_strategy) # => nil

47
48
49
50
51
52
53
54
55
56

# File 'lib/trooper/strategy.rb', line 47

def call(*strategy_names)
  [*strategy_names].each do |strategy_name|
    if Arsenal.strategies[strategy_name]
      Arsenal.strategies[strategy_name].list(config).each do |action|
        # strategy_name, type, name
        @run_list << action
      end
    end
  end
end

@strategy.list() # => [[:my_strategy, :action, :my_strategy_my_new_action]]

131
132
133
134

# File 'lib/trooper/strategy.rb', line 131

def list(configuration = {})
  build_list(configuration) if run_list == []
  prereq_run_list + run_list
end

@strategy.ok? # => true

34
35
36

# File 'lib/trooper/strategy.rb', line 34

def ok?
  true
end

@strategy.prerequisites(:my_other_strategy) # => nil

67
68
69
70
71
72
73
74
75
76
77
78
79
80

# File 'lib/trooper/strategy.rb', line 67

def prerequisites(*strategy_names)
  if @prereq_run_list == []
    @prereq_run_list = [[@name, :action, :prepare_prerequisite]]
  end

  [*strategy_names].each do |strategy_name|
    if Arsenal.strategies[strategy_name]
      Arsenal.strategies[strategy_name].list(config).each do |action|
        # strategy_name, type, name
        @prereq_run_list << [action[0], :prerequisite, action[2]]
      end
    end  
  end
end