Class: Anvil::Task

Inherits:

Object

• Object
• Anvil::Task

Extended by:

ClassMethods, Naming, Options

Defined in:

lib/anvil/task.rb,
lib/anvil/task/naming.rb,
lib/anvil/task/options.rb,
lib/anvil/task/callback.rb,
lib/anvil/task/projects.rb,
lib/anvil/task/repositories.rb,
lib/anvil/task/class_methods.rb

Overview

Common class for all tasks

Direct Known Subclasses

Gem::BuildTask, Gem::BumpTask, Gem::ReleaseTask, HelpTask, Projects::AddTask, Projects::ListTask

Defined Under Namespace

Modules: ClassMethods, Naming, Options, Projects, Repositories Classes: Callback

Instance Attribute Summary

• #options ⇒ Object readonly

  Returns the value of attribute options.

Attributes included from Options

#parser_block

Instance Method Summary

• #initialize(options = {}) ⇒ Task constructor

  A new instance of Task.

• #logger ⇒ Object
• #run ⇒ Object^?

  Runs a task and its callbacks if the assures are OK.

Methods included from ClassMethods

after, afters, assure, assures, before, befores, descendants

Methods included from Naming

description, from_name, get_namespace, task_name

Methods included from Options

build_parser, configure_parser, help, parse_options!, parser

Constructor Details

#initialize(options = {}) ⇒ Task

Returns a new instance of Task.

# File 'lib/anvil/task.rb', line 17

def initialize(options = {})
  @options = options
end

Instance Attribute Details

#options ⇒ Object (readonly)

Returns the value of attribute options.

# File 'lib/anvil/task.rb', line 15

def options
  @options
end

Instance Method Details

#logger ⇒ Object

# File 'lib/anvil/task.rb', line 33

def logger
  Anvil.logger
end

#run ⇒ Object^?

Runs a task and its callbacks if the assures are OK

Returns:

• (Object, nil) —

  anything the task might return

# File 'lib/anvil/task.rb', line 24

def run
  return unless run_assures
  run_before_callbacks
  task_return_value = run_task
  run_after_callbacks

  task_return_value
end