Class: Trooper::Action

Inherits:

Object

• Object
• Trooper::Action

show all

Includes:

DSL::Bundler, DSL::Folders, DSL::Rake

Defined in:

lib/trooper/action.rb

Instance Attribute Summary (collapse)

• - (Object) block readonly

  Returns the value of attribute block.

• - (Object) commands

  Returns the value of attribute commands.

• - (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) options readonly

  Returns the value of attribute options.

Instance Method Summary (collapse)

• - (Object) call(configuration) (also: #execute)

  Public: Eval's the block passed on initialize.

• - (Action) initialize(name, description, options = {}, &block) constructor

  Public: Define a new action.

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

  :nodoc:.

• - (Boolean) ok?

  Public: Validates the action object.

• - (Object) prerequisite_call(configuration)

  Public: Modifies the commands list to include the prerequisite list checker .

• - (Object) run(command)

  Public: Appends command(string) to commands(array).

• - (Object) type

  Public: What type of action this is.

Methods included from DSL::Bundler

#bundle_exec, #bundle_install, #rake

Methods included from DSL::Rake

#rake

Methods included from DSL::Folders

#cd, #create_folder, #create_folders, #delete_folder

:local - A boolean of whether this action should be run locally (optional).

Action.new(:my_action, 'Does great things') { run 'touch file' }

27
28
29
30

# File 'lib/trooper/action.rb', line 27

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

103
104
105

# File 'lib/trooper/action.rb', line 103

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

11
12
13

# File 'lib/trooper/action.rb', line 11

def block
  @block
end

12
13
14

# File 'lib/trooper/action.rb', line 12

def commands
  @commands
end

11
12
13

# File 'lib/trooper/action.rb', line 11

def config
  @config
end

11
12
13

# File 'lib/trooper/action.rb', line 11

def description
  @description
end

11
12
13

# File 'lib/trooper/action.rb', line 11

def name
  @name
end

11
12
13

# File 'lib/trooper/action.rb', line 11

def options
  @options
end

@action.call(config_object) # => ['touch file']

41
42
43
44
45

# File 'lib/trooper/action.rb', line 41

def call(configuration)
  @config = configuration
  eval_block(&block)
  commands
end

@action.ok? # => true

71
72
73

# File 'lib/trooper/action.rb', line 71

def ok?
  true
end

@action.call(config_object) # => "..."

57
58
59
60
61
62

# File 'lib/trooper/action.rb', line 57

def prerequisite_call(configuration)
  original_commands = call configuration
  original_commands << "echo '#{self.name}' >> #{prerequisite_list}"
  original_commands << "echo '#{self.description}'"
  "touch #{prerequisite_list}; if grep -vz #{self.name} #{prerequisite_list}; then #{original_commands.join(' && ')}; else echo 'Already Done'; fi" 
end

@action.run 'touch file' # => 'touch file'
@action.run '' # => nil

99
100
101

# File 'lib/trooper/action.rb', line 99

def run(command)
  commands << command if command != ''
end

@action.type # => :action
@action.type # => :local_action

83
84
85

# File 'lib/trooper/action.rb', line 83

def type
  options && options[:local] ? :local_action : :action
end