rdoc 6.17.0 → 8.1.0

data/lib/rdoc/task.rb

@@ -36,310 +36,315 @@ require_relative '../rdoc'
 require 'rake'
 require 'rake/tasklib'
 
-##
-# RDoc::Task creates the following rake tasks to generate and clean up RDoc
-# output:
-#
-# [rdoc]
-#   Main task for this RDoc task.
-#
-# [clobber_rdoc]
-#   Delete all the rdoc files.  This target is automatically added to the main
-#   clobber target.
-#
-# [rerdoc]
-#   Rebuild the rdoc files from scratch, even if they are not out of date.
-#
-# [rdoc:coverage]
-#   Print RDoc coverage report for all rdoc files.
-#
-# Simple Example:
-#
-#   require 'rdoc/task'
-#
-#   RDoc::Task.new do |rdoc|
-#     rdoc.main = "README.md"
-#     rdoc.rdoc_files.include("README.md", "lib/**/*.rb")
-#   end
-#
-# The +rdoc+ object passed to the block is an RDoc::Task object. See the
-# attributes list for the RDoc::Task class for available customization options.
-#
-# == Specifying different task names
-#
-# You may wish to give the task a different name, such as if you are
-# generating two sets of documentation.  For instance, if you want to have a
-# development set of documentation including private methods:
-#
-#   require 'rdoc/task'
-#
-#   RDoc::Task.new :rdoc_dev do |rdoc|
-#     rdoc.main = "README.md"
-#     rdoc.rdoc_files.include("README.md", "lib/**/*.rb")
-#     rdoc.options << "--all"
-#   end
-#
-# The tasks would then be named :<em>rdoc_dev</em>,
-# :clobber_<em>rdoc_dev</em>, and :re<em>rdoc_dev</em>.
-#
-# If you wish to have completely different task names, then pass a Hash as
-# first argument. With the <tt>:rdoc</tt>, <tt>:clobber_rdoc</tt> and
-# <tt>:rerdoc</tt> options, you can customize the task names to your liking.
-#
-# For example:
-#
-#   require 'rdoc/task'
-#
-#   RDoc::Task.new(:rdoc => "rdoc", :clobber_rdoc => "rdoc:clean",
-#                  :rerdoc => "rdoc:force")
-#
-# This will create the tasks <tt>:rdoc</tt>, <tt>:rdoc:clean</tt>,
-# <tt>:rdoc:force</tt>, and <tt>:rdoc:coverage</tt>.
-
-class RDoc::Task < Rake::TaskLib
-
+module RDoc
   ##
-  # Name of the main, top level task.  (default is :rdoc)
+  # RDoc::Task creates the following rake tasks to generate and clean up RDoc
+  # output:
+  #
+  # [rdoc]
+  #   Main task for this RDoc task.
+  #
+  # [clobber_rdoc]
+  #   Delete all the rdoc files.  This target is automatically added to the main
+  #   clobber target.
+  #
+  # [rerdoc]
+  #   Rebuild the rdoc files from scratch, even if they are not out of date.
+  #
+  # [rdoc:coverage]
+  #   Print RDoc coverage report for all rdoc files.
+  #
+  # Simple Example:
+  #
+  #   require 'rdoc/task'
+  #
+  #   RDoc::Task.new do |rdoc|
+  #     rdoc.main = "README.md"
+  #     rdoc.rdoc_files.include("README.md", "lib/**/*.rb")
+  #   end
+  #
+  # The +rdoc+ object passed to the block is an RDoc::Task object. See the
+  # attributes list for the RDoc::Task class for available customization options.
+  #
+  # == Specifying different task names
+  #
+  # You may wish to give the task a different name, such as if you are
+  # generating two sets of documentation.  For instance, if you want to have a
+  # development set of documentation including private methods:
+  #
+  #   require 'rdoc/task'
+  #
+  #   RDoc::Task.new :rdoc_dev do |rdoc|
+  #     rdoc.main = "README.md"
+  #     rdoc.rdoc_files.include("README.md", "lib/**/*.rb")
+  #     rdoc.options << "--all"
+  #   end
+  #
+  # The tasks would then be named :<em>rdoc_dev</em>,
+  # :clobber_<em>rdoc_dev</em>, and :re<em>rdoc_dev</em>.
+  #
+  # If you wish to have completely different task names, then pass a Hash as
+  # first argument. With the <tt>:rdoc</tt>, <tt>:clobber_rdoc</tt> and
+  # <tt>:rerdoc</tt> options, you can customize the task names to your liking.
+  #
+  # For example:
+  #
+  #   require 'rdoc/task'
+  #
+  #   RDoc::Task.new(:rdoc => "rdoc", :clobber_rdoc => "rdoc:clean",
+  #                  :rerdoc => "rdoc:force")
+  #
+  # This will create the tasks <tt>:rdoc</tt>, <tt>:rdoc:clean</tt>,
+  # <tt>:rdoc:force</tt>, and <tt>:rdoc:coverage</tt>.
+
+  class Task < Rake::TaskLib
+
+    ##
+    # Name of the main, top level task.  (default is :rdoc)
+
+    attr_accessor :name
+
+    ##
+    # The markup format; one of: +rdoc+ (the default), +markdown+, +rd+, +tomdoc+.
+    # See {Markup Formats}[rdoc-ref:RDoc::Markup@Markup+Formats].
+    attr_accessor :markup
+
+    ##
+    # Name of directory to receive the html output files. (default is "html")
+
+    attr_accessor :rdoc_dir
+
+    ##
+    # Title of RDoc documentation. (defaults to rdoc's default)
+
+    attr_accessor :title
+
+    ##
+    # Name of file to be used as the main, top level file of the RDoc. (default
+    # is none)
+
+    attr_accessor :main
+
+    ##
+    # Name of template to be used by rdoc. (defaults to rdoc's default)
+
+    attr_accessor :template
+
+    ##
+    # Name of format generator (<tt>--format</tt>) used by rdoc. (defaults to
+    # rdoc's default)
+
+    attr_accessor :generator
+
+    ##
+    # List of files to be included in the rdoc generation. (default is [])
+
+    attr_accessor :rdoc_files
+
+    ##
+    # Additional list of options to be passed rdoc.  (default is [])
+
+    attr_accessor :options
+
+    ##
+    # Whether to run the rdoc process as an external shell (default is false)
+
+    attr_accessor :external
+
+    ##
+    # Create an RDoc task with the given name. See the RDoc::Task class overview
+    # for documentation.
+
+    def initialize(name = :rdoc) # :yield: self
+      defaults
+
+      check_names name
 
-  attr_accessor :name
+      @name = name
 
-  ##
-  # The markup format; one of: +rdoc+ (the default), +markdown+, +rd+, +tomdoc+.
-  # See {Markup Formats}[rdoc-ref:RDoc::Markup@Markup+Formats].
-  attr_accessor :markup
-
-  ##
-  # Name of directory to receive the html output files. (default is "html")
-
-  attr_accessor :rdoc_dir
-
-  ##
-  # Title of RDoc documentation. (defaults to rdoc's default)
+      yield self if block_given?
 
-  attr_accessor :title
-
-  ##
-  # Name of file to be used as the main, top level file of the RDoc. (default
-  # is none)
-
-  attr_accessor :main
-
-  ##
-  # Name of template to be used by rdoc. (defaults to rdoc's default)
+      define
+    end
 
-  attr_accessor :template
+    ##
+    # Ensures that +names+ only includes names for the :rdoc, :clobber_rdoc and
+    # :rerdoc.  If other names are given an ArgumentError is raised.
 
-  ##
-  # Name of format generator (<tt>--format</tt>) used by rdoc. (defaults to
-  # rdoc's default)
+    def check_names(names)
+      return unless Hash === names
 
-  attr_accessor :generator
+      invalid_options =
+        names.keys.map { |k| k.to_sym } - [:rdoc, :clobber_rdoc, :rerdoc]
 
-  ##
-  # List of files to be included in the rdoc generation. (default is [])
-
-  attr_accessor :rdoc_files
+      unless invalid_options.empty?
+        raise ArgumentError, "invalid options: #{invalid_options.join ', '}"
+      end
+    end
 
-  ##
-  # Additional list of options to be passed rdoc.  (default is [])
+    ##
+    # Task description for the clobber rdoc task or its renamed equivalent
 
-  attr_accessor :options
+    def clobber_task_description
+      "Remove RDoc HTML files"
+    end
 
-  ##
-  # Whether to run the rdoc process as an external shell (default is false)
+    ##
+    # Sets default task values
+
+    def defaults
+      @name = :rdoc
+      @rdoc_files = Rake::FileList.new
+      @rdoc_dir = 'html'
+      @main = nil
+      @title = nil
+      @template = nil
+      @generator = nil
+      @options = []
+    end
 
-  attr_accessor :external
+    ##
+    # Create the tasks defined by this task lib.
 
-  ##
-  # Create an RDoc task with the given name. See the RDoc::Task class overview
-  # for documentation.
+    def define
+      desc rdoc_task_description
+      task rdoc_task_name
 
-  def initialize(name = :rdoc) # :yield: self
-    defaults
+      desc rerdoc_task_description
+      task rerdoc_task_name => [clobber_task_name, rdoc_task_name]
 
-    check_names name
+      desc clobber_task_description
+      task clobber_task_name do
+        rm_r @rdoc_dir rescue nil
+      end
 
-    @name = name
+      task :clobber => [clobber_task_name]
 
-    yield self if block_given?
+      directory @rdoc_dir
 
-    define
-  end
+      rdoc_target_deps = [
+        @rdoc_files,
+        Rake.application.rakefile
+      ].flatten.compact
 
-  ##
-  # Ensures that +names+ only includes names for the :rdoc, :clobber_rdoc and
-  # :rerdoc.  If other names are given an ArgumentError is raised.
+      task rdoc_task_name => [rdoc_target]
+      file rdoc_target => rdoc_target_deps do
+        @before_running_rdoc.call if @before_running_rdoc
+        args = option_list + @rdoc_files
 
-  def check_names(names)
-    return unless Hash === names
+        $stderr.puts "rdoc #{args.join ' '}" if Rake.application.options.trace
+        RDoc.new.document args
+      end
 
-    invalid_options =
-      names.keys.map { |k| k.to_sym } - [:rdoc, :clobber_rdoc, :rerdoc]
+      namespace rdoc_task_name do
+        desc coverage_task_description
+        task coverage_task_name do
+          @before_running_rdoc.call if @before_running_rdoc
+          opts = option_list << "-C"
+          args = opts + @rdoc_files
+
+          $stderr.puts "rdoc #{args.join ' '}" if Rake.application.options.trace
+          RDoc.new.document args
+        rescue SystemExit => exit
+          raise "RDoc coverage is incomplete" unless exit.success?
+        end
+
+        desc server_task_description
+        task "server" do
+          @before_running_rdoc.call if @before_running_rdoc
+          args = option_list + ["--server"] + @rdoc_files
+
+          $stderr.puts "rdoc #{args.join ' '}" if Rake.application.options.trace
+          RDoc.new.document args
+        end
+      end
 
-    unless invalid_options.empty? then
-      raise ArgumentError, "invalid options: #{invalid_options.join ', '}"
+      self
     end
-  end
-
-  ##
-  # Task description for the clobber rdoc task or its renamed equivalent
-
-  def clobber_task_description
-    "Remove RDoc HTML files"
-  end
 
-  ##
-  # Sets default task values
-
-  def defaults
-    @name = :rdoc
-    @rdoc_files = Rake::FileList.new
-    @rdoc_dir = 'html'
-    @main = nil
-    @title = nil
-    @template = nil
-    @generator = nil
-    @options = []
-  end
+    ##
+    # List of options that will be supplied to RDoc
+
+    def option_list
+      result = @options.dup
+      result << "-o"       << @rdoc_dir
+      result << "--main"   << main      if main
+      result << "--markup" << markup    if markup
+      result << "--title"  << title     if title
+      result << "-T"       << template  if template
+      result << '-f'       << generator if generator
+      result
+    end
 
-  ##
-  # All source is inline now.  This method is deprecated
+    ##
+    # The block passed to this method will be called just before running the
+    # RDoc generator. It is allowed to modify RDoc::Task attributes inside the
+    # block.
 
-  def inline_source # :nodoc:
-    warn "RDoc::Task#inline_source is deprecated"
-    true
-  end
+    def before_running_rdoc(&block)
+      @before_running_rdoc = block
+    end
 
-  ##
-  # All source is inline now.  This method is deprecated
+    ##
+    # Task description for the rdoc task or its renamed equivalent
 
-  def inline_source=(value) # :nodoc:
-    warn "RDoc::Task#inline_source is deprecated"
-  end
+    def rdoc_task_description
+      'Build RDoc HTML files'
+    end
 
-  ##
-  # Create the tasks defined by this task lib.
+    ##
+    # Task description for the rerdoc task or its renamed description
 
-  def define
-    desc rdoc_task_description
-    task rdoc_task_name
+    def rerdoc_task_description
+      "Rebuild RDoc HTML files"
+    end
 
-    desc rerdoc_task_description
-    task rerdoc_task_name => [clobber_task_name, rdoc_task_name]
+    ##
+    # Task description for the coverage task or its renamed description
 
-    desc clobber_task_description
-    task clobber_task_name do
-      rm_r @rdoc_dir rescue nil
+    def coverage_task_description
+      "Print RDoc coverage report"
     end
 
-    task :clobber => [clobber_task_name]
-
-    directory @rdoc_dir
+    ##
+    # Task description for the server task
 
-    rdoc_target_deps = [
-      @rdoc_files,
-      Rake.application.rakefile
-    ].flatten.compact
+    def server_task_description
+      "Start a live-reloading documentation server"
+    end
 
-    task rdoc_task_name => [rdoc_target]
-    file rdoc_target => rdoc_target_deps do
-      @before_running_rdoc.call if @before_running_rdoc
-      args = option_list + @rdoc_files
+  private
 
-      $stderr.puts "rdoc #{args.join ' '}" if Rake.application.options.trace
-      RDoc::RDoc.new.document args
+    def rdoc_target
+      "#{rdoc_dir}/created.rid"
     end
 
-    namespace rdoc_task_name do
-      desc coverage_task_description
-      task coverage_task_name do
-        @before_running_rdoc.call if @before_running_rdoc
-        opts = option_list << "-C"
-        args = opts + @rdoc_files
-
-        $stderr.puts "rdoc #{args.join ' '}" if Rake.application.options.trace
-        RDoc::RDoc.new.document args
+    def rdoc_task_name
+      case name
+      when Hash then (name[:rdoc] || "rdoc").to_s
+      else           name.to_s
       end
     end
 
-    self
-  end
-
-  ##
-  # List of options that will be supplied to RDoc
-
-  def option_list
-    result = @options.dup
-    result << "-o"       << @rdoc_dir
-    result << "--main"   << main      if main
-    result << "--markup" << markup    if markup
-    result << "--title"  << title     if title
-    result << "-T"       << template  if template
-    result << '-f'       << generator if generator
-    result
-  end
-
-  ##
-  # The block passed to this method will be called just before running the
-  # RDoc generator. It is allowed to modify RDoc::Task attributes inside the
-  # block.
-
-  def before_running_rdoc(&block)
-    @before_running_rdoc = block
-  end
-
-  ##
-  # Task description for the rdoc task or its renamed equivalent
-
-  def rdoc_task_description
-    'Build RDoc HTML files'
-  end
-
-  ##
-  # Task description for the rerdoc task or its renamed description
-
-  def rerdoc_task_description
-    "Rebuild RDoc HTML files"
-  end
-
-  ##
-  # Task description for the coverage task or its renamed description
-
-  def coverage_task_description
-    "Print RDoc coverage report"
-  end
-
-  private
-
-  def rdoc_target
-    "#{rdoc_dir}/created.rid"
-  end
-
-  def rdoc_task_name
-    case name
-    when Hash then (name[:rdoc] || "rdoc").to_s
-    else           name.to_s
+    def clobber_task_name
+      case name
+      when Hash then (name[:clobber_rdoc] || "clobber_rdoc").to_s
+      else           "clobber_#{name}"
+      end
     end
-  end
 
-  def clobber_task_name
-    case name
-    when Hash then (name[:clobber_rdoc] || "clobber_rdoc").to_s
-    else           "clobber_#{name}"
+    def rerdoc_task_name
+      case name
+      when Hash then (name[:rerdoc] || "rerdoc").to_s
+      else           "re#{name}"
+      end
     end
-  end
 
-  def rerdoc_task_name
-    case name
-    when Hash then (name[:rerdoc] || "rerdoc").to_s
-    else           "re#{name}"
+    def coverage_task_name
+      "coverage"
     end
-  end
 
-  def coverage_task_name
-    "coverage"
   end
-
 end
 
 # :stopdoc: