lib/rdoc/task.rb

   1 # frozen_string_literal: true
   2 #--
   3 # Copyright (c) 2003, 2004 Jim Weirich, 2009 Eric Hodel
   4 #
   5 # Permission is hereby granted, free of charge, to any person obtaining
   6 # a copy of this software and associated documentation files (the
   7 # "Software"), to deal in the Software without restriction, including
   8 # without limitation the rights to use, copy, modify, merge, publish,
   9 # distribute, sublicense, and/or sell copies of the Software, and to
  10 # permit persons to whom the Software is furnished to do so, subject to
  11 # the following conditions:
  12 #
  13 # The above copyright notice and this permission notice shall be
  14 # included in all copies or substantial portions of the Software.
  15 #
  16 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  17 # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  18 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  19 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  20 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  21 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  22 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23 #++
  24
  25 begin
  26   gem 'rdoc'
  27 rescue Gem::LoadError
  28 end unless defined?(RDoc)
  29
  30 begin
  31   gem 'rake'
  32 rescue Gem::LoadError
  33 end unless defined?(Rake)
  34
  35 require_relative '../rdoc'
  36 require 'rake'
  37 require 'rake/tasklib'
  38
  39 ##
  40 # RDoc::Task creates the following rake tasks to generate and clean up RDoc
  41 # output:
  42 #
  43 # [rdoc]
  44 #   Main task for this RDoc task.
  45 #
  46 # [clobber_rdoc]
  47 #   Delete all the rdoc files.  This target is automatically added to the main
  48 #   clobber target.
  49 #
  50 # [rerdoc]
  51 #   Rebuild the rdoc files from scratch, even if they are not out of date.
  52 #
  53 # [rdoc:coverage]
  54 #   Print RDoc coverage report for all rdoc files.
  55 #
  56 # Simple Example:
  57 #
  58 #   require 'rdoc/task'
  59 #
  60 #   RDoc::Task.new do |rdoc|
  61 #     rdoc.main = "README.rdoc"
  62 #     rdoc.rdoc_files.include("README.rdoc", "lib/**/*.rb")
  63 #   end
  64 #
  65 # The +rdoc+ object passed to the block is an RDoc::Task object. See the
  66 # attributes list for the RDoc::Task class for available customization options.
  67 #
  68 # == Specifying different task names
  69 #
  70 # You may wish to give the task a different name, such as if you are
  71 # generating two sets of documentation.  For instance, if you want to have a
  72 # development set of documentation including private methods:
  73 #
  74 #   require 'rdoc/task'
  75 #
  76 #   RDoc::Task.new :rdoc_dev do |rdoc|
  77 #     rdoc.main = "README.rdoc"
  78 #     rdoc.rdoc_files.include("README.rdoc", "lib/**/*.rb")
  79 #     rdoc.options << "--all"
  80 #   end
  81 #
  82 # The tasks would then be named :<em>rdoc_dev</em>,
  83 # :clobber_<em>rdoc_dev</em>, and :re<em>rdoc_dev</em>.
  84 #
  85 # If you wish to have completely different task names, then pass a Hash as
  86 # first argument. With the <tt>:rdoc</tt>, <tt>:clobber_rdoc</tt> and
  87 # <tt>:rerdoc</tt> options, you can customize the task names to your liking.
  88 #
  89 # For example:
  90 #
  91 #   require 'rdoc/task'
  92 #
  93 #   RDoc::Task.new(:rdoc => "rdoc", :clobber_rdoc => "rdoc:clean",
  94 #                  :rerdoc => "rdoc:force")
  95 #
  96 # This will create the tasks <tt>:rdoc</tt>, <tt>:rdoc:clean</tt>,
  97 # <tt>:rdoc:force</tt>, and <tt>:rdoc:coverage</tt>.
  98
  99 class RDoc::Task < Rake::TaskLib
 100
 101   ##
 102   # Name of the main, top level task.  (default is :rdoc)
 103
 104   attr_accessor :name
 105
 106   ##
 107   # Comment markup format.  rdoc, rd and tomdoc are supported.  (default is
 108   # 'rdoc')
 109
 110   attr_accessor :markup
 111
 112   ##
 113   # Name of directory to receive the html output files. (default is "html")
 114
 115   attr_accessor :rdoc_dir
 116
 117   ##
 118   # Title of RDoc documentation. (defaults to rdoc's default)
 119
 120   attr_accessor :title
 121
 122   ##
 123   # Name of file to be used as the main, top level file of the RDoc. (default
 124   # is none)
 125
 126   attr_accessor :main
 127
 128   ##
 129   # Name of template to be used by rdoc. (defaults to rdoc's default)
 130
 131   attr_accessor :template
 132
 133   ##
 134   # Name of format generator (<tt>--format</tt>) used by rdoc. (defaults to
 135   # rdoc's default)
 136
 137   attr_accessor :generator
 138
 139   ##
 140   # List of files to be included in the rdoc generation. (default is [])
 141
 142   attr_accessor :rdoc_files
 143
 144   ##
 145   # Additional list of options to be passed rdoc.  (default is [])
 146
 147   attr_accessor :options
 148
 149   ##
 150   # Whether to run the rdoc process as an external shell (default is false)
 151
 152   attr_accessor :external
 153
 154   ##
 155   # Create an RDoc task with the given name. See the RDoc::Task class overview
 156   # for documentation.
 157
 158   def initialize name = :rdoc # :yield: self
 159     defaults
 160
 161     check_names name
 162
 163     @name = name
 164
 165     yield self if block_given?
 166
 167     define
 168   end
 169
 170   ##
 171   # Ensures that +names+ only includes names for the :rdoc, :clobber_rdoc and
 172   # :rerdoc.  If other names are given an ArgumentError is raised.
 173
 174   def check_names names
 175     return unless Hash === names
 176
 177     invalid_options =
 178       names.keys.map { |k| k.to_sym } - [:rdoc, :clobber_rdoc, :rerdoc]
 179
 180     unless invalid_options.empty? then
 181       raise ArgumentError, "invalid options: #{invalid_options.join ', '}"
 182     end
 183   end
 184
 185   ##
 186   # Task description for the clobber rdoc task or its renamed equivalent
 187
 188   def clobber_task_description
 189     "Remove RDoc HTML files"
 190   end
 191
 192   ##
 193   # Sets default task values
 194
 195   def defaults
 196     @name = :rdoc
 197     @rdoc_files = Rake::FileList.new
 198     @rdoc_dir = 'html'
 199     @main = nil
 200     @title = nil
 201     @template = nil
 202     @generator = nil
 203     @options = []
 204   end
 205
 206   ##
 207   # All source is inline now.  This method is deprecated
 208
 209   def inline_source # :nodoc:
 210     warn "RDoc::Task#inline_source is deprecated"
 211     true
 212   end
 213
 214   ##
 215   # All source is inline now.  This method is deprecated
 216
 217   def inline_source=(value) # :nodoc:
 218     warn "RDoc::Task#inline_source is deprecated"
 219   end
 220
 221   ##
 222   # Create the tasks defined by this task lib.
 223
 224   def define
 225     desc rdoc_task_description
 226     task rdoc_task_name
 227
 228     desc rerdoc_task_description
 229     task rerdoc_task_name => [clobber_task_name, rdoc_task_name]
 230
 231     desc clobber_task_description
 232     task clobber_task_name do
 233       rm_r @rdoc_dir rescue nil
 234     end
 235
 236     task :clobber => [clobber_task_name]
 237
 238     directory @rdoc_dir
 239
 240     rdoc_target_deps = [
 241       @rdoc_files,
 242       Rake.application.rakefile
 243     ].flatten.compact
 244
 245     task rdoc_task_name => [rdoc_target]
 246     file rdoc_target => rdoc_target_deps do
 247       @before_running_rdoc.call if @before_running_rdoc
 248       args = option_list + @rdoc_files
 249
 250       $stderr.puts "rdoc #{args.join ' '}" if Rake.application.options.trace
 251       RDoc::RDoc.new.document args
 252     end
 253
 254     namespace rdoc_task_name do
 255       desc coverage_task_description
 256       task coverage_task_name do
 257         @before_running_rdoc.call if @before_running_rdoc
 258         opts = option_list << "-C"
 259         args = opts + @rdoc_files
 260
 261         $stderr.puts "rdoc #{args.join ' '}" if Rake.application.options.trace
 262         RDoc::RDoc.new.document args
 263       end
 264     end
 265
 266     self
 267   end
 268
 269   ##
 270   # List of options that will be supplied to RDoc
 271
 272   def option_list
 273     result = @options.dup
 274     result << "-o"       << @rdoc_dir
 275     result << "--main"   << main      if main
 276     result << "--markup" << markup    if markup
 277     result << "--title"  << title     if title
 278     result << "-T"       << template  if template
 279     result << '-f'       << generator if generator
 280     result
 281   end
 282
 283   ##
 284   # The block passed to this method will be called just before running the
 285   # RDoc generator. It is allowed to modify RDoc::Task attributes inside the
 286   # block.
 287
 288   def before_running_rdoc(&block)
 289     @before_running_rdoc = block
 290   end
 291
 292   ##
 293   # Task description for the rdoc task or its renamed equivalent
 294
 295   def rdoc_task_description
 296     'Build RDoc HTML files'
 297   end
 298
 299   ##
 300   # Task description for the rerdoc task or its renamed description
 301
 302   def rerdoc_task_description
 303     "Rebuild RDoc HTML files"
 304   end
 305
 306   ##
 307   # Task description for the coverage task or its renamed description
 308
 309   def coverage_task_description
 310     "Print RDoc coverage report"
 311   end
 312
 313   private
 314
 315   def rdoc_target
 316     "#{rdoc_dir}/created.rid"
 317   end
 318
 319   def rdoc_task_name
 320     case name
 321     when Hash then (name[:rdoc] || "rdoc").to_s
 322     else           name.to_s
 323     end
 324   end
 325
 326   def clobber_task_name
 327     case name
 328     when Hash then (name[:clobber_rdoc] || "clobber_rdoc").to_s
 329     else           "clobber_#{name}"
 330     end
 331   end
 332
 333   def rerdoc_task_name
 334     case name
 335     when Hash then (name[:rerdoc] || "rerdoc").to_s
 336     else           "re#{name}"
 337     end
 338   end
 339
 340   def coverage_task_name
 341     "coverage"
 342   end
 343
 344 end
 345
 346 # :stopdoc:
 347 module Rake
 348
 349   ##
 350   # For backwards compatibility
 351
 352   RDocTask = RDoc::Task # :nodoc:
 353
 354 end
 355 # :startdoc: