Class: Prmd::RakeTasks::Base Private

Inherits:
Rake::TaskLib
  • Object
show all
Defined in:
lib/prmd/rake_tasks/base.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Common class for Prmd rake tasks

Direct Known Subclasses

Combine, Doc, Verify

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name) {|_self| ... } ⇒ Base

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Creates a new task with name name.

Parameters:

  • name (String, Symbol) —

    the name of the rake task

Yields:

  • (_self)

Yield Parameters:



23
24
25
26
27
28
29
30
 
# File 'lib/prmd/rake_tasks/base.rb', line 23

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

  yield self if block_given?

  define
end

Instance Attribute Details

#name ⇒ String

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

The name of the task

Returns:

  • (String) —

    the task name



14
15
16
 
# File 'lib/prmd/rake_tasks/base.rb', line 14

def name
  @name
end

#options ⇒ Hash<Symbol, Object>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Options to pass to command

Returns:

  • (Hash<Symbol, Object>) —

    the options passed to the command



18
19
20
 
# File 'lib/prmd/rake_tasks/base.rb', line 18

def options
  @options
end