Class: UberDoc::Task

Inherits:

Object

• Object
• UberDoc::Task

Defined in:

lib/uberdoc/task.rb

Direct Known Subclasses

DoctorTask, DoxygenTask, Generate

Class Method Summary

• .known_tasks ⇒ Object

  perform.

• .should_run?(options) ⇒ Boolean

  Indicates if this task needs to run based on the options.

Instance Method Summary

• #initialize(options) ⇒ Task constructor

  A new instance of Task.

• #perform ⇒ Object

  Performs the task.

Constructor Details

#initialize(options) ⇒ Task

Returns a new instance of Task.

# File 'lib/uberdoc/task.rb', line 8

def initialize(options)
    @options = options
end

Class Method Details

.known_tasks ⇒ Object

perform

# File 'lib/uberdoc/task.rb', line 26

def self.known_tasks
    ObjectSpace.each_object(Class).select { |klass| klass < self }
end

.should_run?(options) ⇒ Boolean

Indicates if this task needs to run based on the options

Returns:

• (Boolean)

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

def self.should_run?(options)
    true
end

Instance Method Details

#perform ⇒ Object

Performs the task

# File 'lib/uberdoc/task.rb', line 22

def perform
    puts "Subclass Responsibility"
end