Class: Reap::RDocTask

Inherits:
Task
  • Object
show all
Defined in:
lib/reap/tasks/rdoc-task.rb

Constant Summary

Constants inherited from Task

Task::DEFAULT_INCLUDE, Task::MUST_EXCLUDE, Task::RUBY

Instance Attribute Summary

Attributes inherited from Task

#config, #section

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Task

#[], inherited, #initialize, #package_name, registry, #ruby, #sh, tasks

Constructor Details

This class inherits a constructor from Reap::Task

Class Method Details

.desc ⇒ Object 



8
 
# File 'lib/reap/tasks/rdoc-task.rb', line 8

def self.desc ; "Generate RDocs." ; end

.task ⇒ Object 



6
 
# File 'lib/reap/tasks/rdoc-task.rb', line 6

def self.task; :rdoc ; end

Instance Method Details

#run ⇒ Object 



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/reap/tasks/rdoc-task.rb', line 21

def run
  rdoc_dir = File.expand_path(@dir)
  if FileTest.directory?(@dir)
    print "Directory '#{@dir}' already exists. Clobber? [y/N] "
    until inp = $stdin.gets[0,1] ; sleep 1 ; end ; puts
    if (inp || 'y').downcase == 'y'
      puts "Removing old directory '#{rdoc_dir}'..."
      trash_dir = ".trash/#{File.basename(@dir)}"
      FileUtils.mkdir_p(".trash") unless FileTest.directory?(".trash")
      FileUtils.rm_r(trash_dir) if FileTest.exists?(trash_dir)
      FileUtils.mv(@dir, trash_dir)
    else
      puts "Packmule rdoc task canceled."
      return nil
    end
  end
  rdoc_target = "#{rdoc_dir}/index.html"
  # rdoc files
  rdoc_files = FileList.new
  rdoc_files.include(*@include)
  rdoc_files.exclude(*@exclude)
  rdoc_files = '"' << rdoc_files.join('" "') << '"'
  # build options string
  build = @options.dup
  build << "--main '#{@main}'" if @main
  build << "--title '#{@title}'" if @title
  build << "-T '#{@template}'" if @template
  rdoc_opts = build.join(' ')
  # do it!
  puts "PackMule is shelling work out to RDoc..."
  puts %{rdoc -o #{@dir} #{rdoc_opts}}
  sh %{rdoc -o #{rdoc_dir} #{rdoc_opts} #{rdoc_files}}
end

#set(section) ⇒ Object 



11
12
13
14
15
16
17
18
19
 
# File 'lib/reap/tasks/rdoc-task.rb', line 11

def set( section )
  @dir = section["dir"] || 'doc/rdoc'
  @main = section["main"]
  @title = section["title"] || @config["title"]
  @template = section["template"] || 'html'
  @include = section["include"] || ['lib/**/*']
  @exclude = section["exclude"]
  @options = section["options"] || []
end