Class: Packnga::DocumentTask

Inherits:
Object
  • Object
show all
Includes:
Rake::DSL
Defined in:
lib/packnga/document-task.rb

Overview

This class creates docment tasks. They generate YARD doucment or references.

Since:

  • 0.9.0

Instance Method Summary collapse

Constructor Details

#initialize(spec) ⇒ DocumentTask

Defines tasks to generate YARD documentation and to translate references.

Parameters:

  • spec (Jeweler::Task) —

    created by Jeweler::Task.new.

Since:

  • 0.9.0



33
34
35
36
37
38
39
40
41
42
 
# File 'lib/packnga/document-task.rb', line 33

def initialize(spec)
  @spec = spec
  @yard_task = YARDTask.new(@spec)
  @reference_task = ReferenceTask.new(@spec)
  self.base_dir = "doc"
  if block_given?
    yield(self)
    define
  end
end

Instance Method Details

#base_dir=(dir) ⇒ Object

Sets base directory for documents. Default value is “doc”.

Parameters:

  • base (String) —

    direcory path

Since:

  • 0.9.0



52
53
54
55
56
 
# File 'lib/packnga/document-task.rb', line 52

def base_dir=(dir)
  dir = Pathname.new(dir)
  @yard_task.base_dir = dir
  @reference_task.base_dir = dir
end

#define ⇒ Object

Since:

  • 0.9.0



45
46
47
48
 
# File 'lib/packnga/document-task.rb', line 45

def define
  set_default_values
  define_tasks
end

#htaccess ⇒ Object

Since:

  • 0.9.0



68
69
70
 
# File 'lib/packnga/document-task.rb', line 68

def htaccess
  @reference_task.htaccess
end

#reference {|@reference_task| ... } ⇒ Object

Runs block to tasks for references.

Yields:

  • (@reference_task)

Since:

  • 0.9.0



64
65
66
 
# File 'lib/packnga/document-task.rb', line 64

def reference
  yield(@reference_task)
end

#yard {|@yard_task| ... } ⇒ Object

Runs block to task for YARD documentation.

Yields:

  • (@yard_task)

Since:

  • 0.9.0



59
60
61
 
# File 'lib/packnga/document-task.rb', line 59

def yard
  yield(@yard_task)
end