rdoc 6.13.0 → 6.17.0

data/lib/rdoc/rdoc.rb

@@ -89,7 +89,7 @@ class RDoc::RDoc
   ##
   # Sets the active RDoc::RDoc instance
 
-  def self.current= rdoc
+  def self.current=(rdoc)
     @current = rdoc
   end
 
@@ -118,7 +118,7 @@ class RDoc::RDoc
   # Gathers a set of parseable files from the files and directories listed in
   # +files+.
 
-  def gather_files files
+  def gather_files(files)
     files = [@options.root.to_s] if files.empty?
 
     file_list = normalized_file_list files, true, @options.exclude
@@ -237,7 +237,7 @@ option)
   # representing candidates for documentation. It may also contain comments
   # (starting with '#')
 
-  def parse_dot_doc_file in_dir, filename
+  def parse_dot_doc_file(in_dir, filename)
     # read and strip comments
     patterns = File.read(filename).gsub(/#.*/, '')
 
@@ -311,7 +311,7 @@ option)
   # files. However we may well contain subdirectories which must be tested
   # for .document files.
 
-  def list_files_in_directory dir
+  def list_files_in_directory(dir)
     files = Dir.glob File.join(dir, "*")
 
     normalized_file_list files, false, @options.exclude
@@ -320,7 +320,7 @@ option)
   ##
   # Parses +filename+ and returns an RDoc::TopLevel
 
-  def parse_file filename
+  def parse_file(filename)
     encoding = @options.encoding
     filename = filename.encode encoding
 
@@ -391,7 +391,7 @@ The internal error was:
   ##
   # Parse each file on the command line, recursively entering directories.
 
-  def parse_files files
+  def parse_files(files)
     file_list = gather_files files
     @stats = RDoc::Stats.new @store, file_list.length, @options.verbosity
 
@@ -418,7 +418,7 @@ The internal error was:
   # Removes file extensions known to be unparseable from +files+ and TAGS
   # files for emacs and vim.
 
-  def remove_unparseable files
+  def remove_unparseable(files)
     files.reject do |file, *|
       file =~ /\.(?:class|eps|erb|scpt\.txt|svg|ttf|yml)$/i or
         (file =~ /tags$/i and
@@ -440,7 +440,7 @@ The internal error was:
   # By default, output will be stored in a directory called "doc" below the
   # current directory, so make sure you're somewhere writable before invoking.
 
-  def document options
+  def document(options)
     if RDoc::Options === options then
       @options = options
     else
@@ -547,5 +547,6 @@ end
 
 # require built-in generators after discovery in case they've been replaced
 require_relative 'generator/darkfish'
+require_relative 'generator/aliki'
 require_relative 'generator/ri'
 require_relative 'generator/pot'

data/lib/rdoc/ri/driver.rb

@@ -96,7 +96,7 @@ class RDoc::RI::Driver
   ##
   # Dump +data_path+ using pp
 
-  def self.dump data_path
+  def self.dump(data_path)
     require 'pp'
 
     File.open data_path, 'rb' do |io|
@@ -107,7 +107,7 @@ class RDoc::RI::Driver
   ##
   # Parses +argv+ and returns a Hash of options
 
-  def self.process_args argv
+  def self.process_args(argv)
     options = default_options
 
     opts = OptionParser.new do |opt|
@@ -384,7 +384,7 @@ or the PAGER environment variable.
   ##
   # Runs the ri command line executable using +argv+
 
-  def self.run argv = ARGV
+  def self.run(argv = ARGV)
     options = process_args argv
 
     if options[:dump_path] then
@@ -399,7 +399,7 @@ or the PAGER environment variable.
   ##
   # Creates a new driver using +initial_options+ from ::process_args
 
-  def initialize initial_options = {}
+  def initialize(initial_options = {})
     @paging = false
     @classes = nil
 
@@ -438,7 +438,7 @@ or the PAGER environment variable.
   ##
   # Adds paths for undocumented classes +also_in+ to +out+
 
-  def add_also_in out, also_in
+  def add_also_in(out, also_in)
     return if also_in.empty?
 
     out << RDoc::Markup::Rule.new(1)
@@ -455,7 +455,7 @@ or the PAGER environment variable.
   # Adds a class header to +out+ for class +name+ which is described in
   # +classes+.
 
-  def add_class out, name, classes
+  def add_class(out, name, classes)
     heading = if classes.all? { |klass| klass.module? } then
                 name
               else
@@ -475,14 +475,14 @@ or the PAGER environment variable.
   ##
   # Adds "(from ...)" to +out+ for +store+
 
-  def add_from out, store
+  def add_from(out, store)
     out << RDoc::Markup::Paragraph.new("(from #{store.friendly_path})")
   end
 
   ##
   # Adds +extends+ to +out+
 
-  def add_extends out, extends
+  def add_extends(out, extends)
     add_extension_modules out, 'Extended by', extends
   end
 
@@ -490,7 +490,7 @@ or the PAGER environment variable.
   # Adds a list of +extensions+ to this module of the given +type+ to +out+.
   # add_includes and add_extends call this, so you should use those directly.
 
-  def add_extension_modules out, type, extensions
+  def add_extension_modules(out, type, extensions)
     return if extensions.empty?
 
     out << RDoc::Markup::Rule.new(1)
@@ -508,7 +508,7 @@ or the PAGER environment variable.
   ##
   # Renders multiple included +modules+ from +store+ to +out+.
 
-  def add_extension_modules_multiple out, store, modules # :nodoc:
+  def add_extension_modules_multiple(out, store, modules) # :nodoc:
     out << RDoc::Markup::Paragraph.new("(from #{store.friendly_path})")
 
     wout, with = modules.partition { |incl| incl.comment.empty? }
@@ -535,7 +535,7 @@ or the PAGER environment variable.
   ##
   # Adds a single extension module +include+ from +store+ to +out+
 
-  def add_extension_modules_single out, store, include # :nodoc:
+  def add_extension_modules_single(out, store, include) # :nodoc:
     name = include.name
     path = store.friendly_path
     out << RDoc::Markup::Paragraph.new("#{name} (from #{path})")
@@ -549,14 +549,14 @@ or the PAGER environment variable.
   ##
   # Adds +includes+ to +out+
 
-  def add_includes out, includes
+  def add_includes(out, includes)
     add_extension_modules out, 'Includes', includes
   end
 
   ##
   # Looks up the method +name+ and adds it to +out+
 
-  def add_method out, name
+  def add_method(out, name)
     filtered = lookup_method name
     method_document out, name, filtered
   end
@@ -564,7 +564,7 @@ or the PAGER environment variable.
   ##
   # Adds documentation for all methods in +klass+ to +out+
 
-  def add_method_documentation out, klass
+  def add_method_documentation(out, klass)
     klass.method_list.each do |method|
       begin
         add_method out, method.full_name
@@ -577,7 +577,7 @@ or the PAGER environment variable.
   ##
   # Adds a list of +methods+ to +out+ with a heading of +name+
 
-  def add_method_list out, methods, name
+  def add_method_list(out, methods, name)
     return if methods.empty?
 
     out << RDoc::Markup::Heading.new(1, "#{name}:")
@@ -597,7 +597,7 @@ or the PAGER environment variable.
   ##
   # Returns ancestor classes of +klass+
 
-  def ancestors_of klass
+  def ancestors_of(klass)
     ancestors = []
 
     unexamined = [klass]
@@ -634,7 +634,7 @@ or the PAGER environment variable.
   ##
   # Builds a RDoc::Markup::Document from +found+, +klasess+ and +includes+
 
-  def class_document name, found, klasses, includes, extends
+  def class_document(name, found, klasses, includes, extends)
     also_in = []
 
     out = RDoc::Markup::Document.new
@@ -657,7 +657,7 @@ or the PAGER environment variable.
   ##
   # Adds the class +comment+ to +out+.
 
-  def class_document_comment out, document # :nodoc:
+  def class_document_comment(out, document) # :nodoc:
     unless document.empty? then
       out << RDoc::Markup::Rule.new(1)
 
@@ -677,7 +677,7 @@ or the PAGER environment variable.
   ##
   # Adds the constants from +klass+ to the Document +out+.
 
-  def class_document_constants out, klass # :nodoc:
+  def class_document_constants(out, klass) # :nodoc:
     return if klass.constants.empty?
 
     out << RDoc::Markup::Heading.new(1, "Constants:")
@@ -721,7 +721,7 @@ or the PAGER environment variable.
   # Returns the stores wherein +name+ is found along with the classes,
   # extends and includes that match it
 
-  def classes_and_includes_and_extends_for name
+  def classes_and_includes_and_extends_for(name)
     klasses = []
     extends = []
     includes = []
@@ -746,7 +746,7 @@ or the PAGER environment variable.
   ##
   # Completes +name+ based on the caches.  For Readline
 
-  def complete name
+  def complete(name)
     completions = []
 
     klass, selector, method = parse_name name
@@ -757,7 +757,7 @@ or the PAGER environment variable.
     completions.uniq.select {|s| s.start_with? name }.sort
   end
 
-  def complete_klass name, klass, selector, method, completions # :nodoc:
+  def complete_klass(name, klass, selector, method, completions) # :nodoc:
     klasses = classes.keys
 
     # may need to include Foo when given Foo::
@@ -776,7 +776,7 @@ or the PAGER environment variable.
     end
   end
 
-  def complete_method name, klass, selector, completions # :nodoc:
+  def complete_method(name, klass, selector, completions) # :nodoc:
     if completions.include? klass and name =~ /#|\.|::/ then
       methods = list_methods_matching name
 
@@ -804,7 +804,7 @@ or the PAGER environment variable.
   ##
   # Converts +document+ to text and writes it to the pager
 
-  def display document
+  def display(document)
     page do |io|
       f = formatter(io)
       f.width = @width if @width and f.respond_to?(:width)
@@ -817,7 +817,7 @@ or the PAGER environment variable.
   ##
   # Outputs formatted RI data for class +name+.  Groups undocumented classes
 
-  def display_class name
+  def display_class(name)
     return if name =~ /#|\./
 
     found, klasses, includes, extends =
@@ -833,7 +833,7 @@ or the PAGER environment variable.
   ##
   # Outputs formatted RI data for method +name+
 
-  def display_method name
+  def display_method(name)
     out = RDoc::Markup::Document.new
 
     add_method out, name
@@ -849,7 +849,7 @@ or the PAGER environment variable.
   # Returns true if +name+ was found, false if it was not an alternative could
   # be guessed, raises an error if +name+ couldn't be guessed.
 
-  def display_name name
+  def display_name(name)
     if name =~ /\w:(\w|$)/ then
       display_page name
       return true
@@ -878,7 +878,7 @@ or the PAGER environment variable.
   ##
   # Displays each name in +name+
 
-  def display_names names
+  def display_names(names)
     names.each do |name|
       name = expand_name name
 
@@ -889,7 +889,7 @@ or the PAGER environment variable.
   ##
   # Outputs formatted RI data for page +name+.
 
-  def display_page name
+  def display_page(name)
     store_name, page_name = name.split ':', 2
 
     store = @stores.find { |s| s.source == store_name }
@@ -920,7 +920,7 @@ or the PAGER environment variable.
   ##
   # Outputs a formatted RI page list for the pages in +store+.
 
-  def display_page_list store, pages = store.cache[:pages], search = nil
+  def display_page_list(store, pages = store.cache[:pages], search = nil)
     out = RDoc::Markup::Document.new
 
     title = if search then
@@ -964,7 +964,7 @@ or the PAGER environment variable.
   # Expands abbreviated klass +klass+ into a fully-qualified class.  "Zl::Da"
   # will be expanded to Zlib::DataError.
 
-  def expand_class klass
+  def expand_class(klass)
     class_names = classes.keys
     ary = class_names.grep(Regexp.new("\\A#{klass.gsub(/(?=::|\z)/, '[^:]*')}\\z"))
     if ary.length != 1 && ary.first != klass
@@ -982,7 +982,7 @@ or the PAGER environment variable.
   # Expands the class portion of +name+ into a fully-qualified class.  See
   # #expand_class.
 
-  def expand_name name
+  def expand_name(name)
     klass, selector, method = parse_name name
 
     return [selector, method].join if klass.empty?
@@ -998,7 +998,7 @@ or the PAGER environment variable.
   ##
   # Filters the methods in +found+ trying to find a match for +name+.
 
-  def filter_methods found, name
+  def filter_methods(found, name)
     regexp = name_regexp name
 
     filtered = found.find_all do |store, methods|
@@ -1016,7 +1016,7 @@ or the PAGER environment variable.
   # types of methods to look up (from #method_type), and the method name being
   # searched for
 
-  def find_methods name
+  def find_methods(name)
     klass, selector, method = parse_name name
 
     types = method_type selector
@@ -1062,7 +1062,7 @@ or the PAGER environment variable.
   #
   # See also RDoc::Store#source
 
-  def find_store name
+  def find_store(name)
     @stores.each do |store|
       source = store.source
 
@@ -1131,7 +1131,7 @@ or the PAGER environment variable.
   # Lists classes known to ri starting with +names+.  If +names+ is empty all
   # known classes are shown.
 
-  def list_known_classes names = []
+  def list_known_classes(names = [])
     classes = []
 
     stores.each do |store|
@@ -1163,7 +1163,7 @@ or the PAGER environment variable.
   ##
   # Returns an Array of methods matching +name+
 
-  def list_methods_matching name
+  def list_methods_matching(name)
     found = []
 
     find_methods name do |store, klass, ancestor, types, method|
@@ -1202,7 +1202,7 @@ or the PAGER environment variable.
   # Loads RI data for method +name+ on +klass+ from +store+.  +type+ and
   # +cache+ indicate if it is a class or instance method.
 
-  def load_method store, cache, klass, type, name
+  def load_method(store, cache, klass, type, name)
     methods = store.public_send(cache)[klass]
 
     return unless methods
@@ -1226,7 +1226,7 @@ or the PAGER environment variable.
   ##
   # Returns an Array of RI data for methods matching +name+
 
-  def load_methods_matching name
+  def load_methods_matching(name)
     found = []
 
     find_methods name do |store, klass, ancestor, types, method|
@@ -1247,7 +1247,7 @@ or the PAGER environment variable.
   ##
   # Returns a filtered list of methods matching +name+
 
-  def lookup_method name
+  def lookup_method(name)
     found = load_methods_matching name
 
     if found.empty?
@@ -1272,7 +1272,7 @@ or the PAGER environment variable.
   ##
   # Builds a RDoc::Markup::Document from +found+, +klasses+ and +includes+
 
-  def method_document out, name, filtered
+  def method_document(out, name, filtered)
     out << RDoc::Markup::Heading.new(1, name)
     out << RDoc::Markup::BlankLine.new
 
@@ -1288,7 +1288,7 @@ or the PAGER environment variable.
   ##
   # Returns the type of method (:both, :instance, :class) for +selector+
 
-  def method_type selector
+  def method_type(selector)
     case selector
     when '.', nil then :both
     when '#'      then :instance
@@ -1300,7 +1300,7 @@ or the PAGER environment variable.
   # Returns a regular expression for +name+ that will match an
   # RDoc::AnyMethod's name.
 
-  def name_regexp name
+  def name_regexp(name)
     klass, type, name = parse_name name
 
     case type
@@ -1343,7 +1343,7 @@ or the PAGER environment variable.
   # NOTE: Given Foo::Bar, Bar is considered a class even though it may be a
   # method
 
-  def parse_name name
+  def parse_name(name)
     parts = name.split(/(::?|#|\.)/)
 
     if parts.length == 1 then
@@ -1375,7 +1375,7 @@ or the PAGER environment variable.
   # Renders the +klass+ from +store+ to +out+.  If the klass has no
   # documentable items the class is added to +also_in+ instead.
 
-  def render_class out, store, klass, also_in # :nodoc:
+  def render_class(out, store, klass, also_in) # :nodoc:
     document = klass.comment.parse
     # TODO the store's cache should always return an empty Array
     class_methods    = store.class_methods[klass.full_name]    || []
@@ -1405,7 +1405,7 @@ or the PAGER environment variable.
     add_method_documentation out, klass if @show_all
   end
 
-  def render_method out, store, method, name # :nodoc:
+  def render_method(out, store, method, name) # :nodoc:
     out << RDoc::Markup::Paragraph.new("(from #{store.friendly_path})")
 
     unless name =~ /^#{Regexp.escape method.parent_name}/ then
@@ -1425,7 +1425,7 @@ or the PAGER environment variable.
     end
   end
 
-  def render_method_arguments out, arglists # :nodoc:
+  def render_method_arguments(out, arglists) # :nodoc:
     return unless arglists
 
     arglists = arglists.chomp.split "\n"
@@ -1434,7 +1434,7 @@ or the PAGER environment variable.
     out << RDoc::Markup::Rule.new(1)
   end
 
-  def render_method_comment out, method, alias_for = nil# :nodoc:
+  def render_method_comment(out, method, alias_for = nil)# :nodoc:
     if alias_for
       unless method.comment.nil? or method.comment.empty?
         out << RDoc::Markup::BlankLine.new
@@ -1452,7 +1452,7 @@ or the PAGER environment variable.
     end
   end
 
-  def render_method_superclass out, method # :nodoc:
+  def render_method_superclass(out, method) # :nodoc:
     return unless
       method.respond_to?(:superclass_method) and method.superclass_method
 

data/lib/rdoc/ri/paths.rb

@@ -52,7 +52,7 @@ module RDoc::RI::Paths
   ##
   # The ri directory for the gem with +gem_name+.
 
-  def self.gem_dir name, version
+  def self.gem_dir(name, version)
     req = Gem::Requirement.new "= #{version}"
 
     spec = Gem::Specification.find_by_name name, req
@@ -67,7 +67,7 @@ module RDoc::RI::Paths
   # A +filter+ :all includes all versions of gems and includes gems without
   # ri documentation.
 
-  def self.gemdirs filter = :latest
+  def self.gemdirs(filter = :latest)
     ri_paths = {}
 
     all = Gem::Specification.map do |spec|

data/lib/rdoc/ri/task.rb

@@ -26,8 +26,8 @@ require_relative '../task'
 #   require 'rdoc/ri/task'
 #
 #   RDoc::RI::Task.new do |ri|
-#     ri.main = 'README.rdoc'
-#     ri.rdoc_files.include 'README.rdoc', 'lib/**/*.rb'
+#     ri.main = 'README.md'
+#     ri.rdoc_files.include 'README.md', 'lib/**/*.rb'
 #   end
 #
 # For further configuration details see RDoc::Task.
@@ -44,7 +44,7 @@ class RDoc::RI::Task < RDoc::Task
   # Create an ri task with the given name. See RDoc::Task for documentation on
   # setting names.
 
-  def initialize name = DEFAULT_NAMES # :yield: self
+  def initialize(name = DEFAULT_NAMES) # :yield: self
     super
   end
 

data/lib/rdoc/rubygems_hook.rb

@@ -51,7 +51,7 @@ class RDoc::RubyGemsHook
   # Post installs hook that generates documentation for each specification in
   # +specs+
 
-  def self.generate installer, specs
+  def self.generate(installer, specs)
     start = Time.now
     types = installer.document
 
@@ -70,7 +70,7 @@ class RDoc::RubyGemsHook
     say "Done installing documentation for #{names} after #{duration} seconds"
   end
 
-  def self.remove uninstaller
+  def self.remove(uninstaller)
     new(uninstaller.spec).remove
   end
 
@@ -92,7 +92,7 @@ class RDoc::RubyGemsHook
   #
   # Only +generate_ri+ is enabled by default.
 
-  def initialize spec, generate_rdoc = false, generate_ri = true
+  def initialize(spec, generate_rdoc = false, generate_ri = true)
     @doc_dir   = spec.doc_dir
     @force     = false
     @rdoc      = nil
@@ -110,7 +110,7 @@ class RDoc::RubyGemsHook
   #--
   # TODO move to RDoc::Options
 
-  def delete_legacy_args args
+  def delete_legacy_args(args)
     args.delete '--inline-source'
     args.delete '--promiscuous'
     args.delete '-p'
@@ -123,7 +123,7 @@ class RDoc::RubyGemsHook
   #
   # Documentation will be generated into +destination+
 
-  def document generator, options, destination
+  def document(generator, options, destination)
     generator_name = generator
 
     options = options.dup
@@ -182,18 +182,21 @@ class RDoc::RubyGemsHook
       options.default_title = "#{@spec.full_name} Documentation"
       options.parse args
       options.quiet = !Gem.configuration.really_verbose
-      options.finish
     end
 
     @rdoc = new_rdoc
-    @rdoc.options = options
-
-    @rdoc.store = RDoc::Store.new(options)
 
     say "Parsing documentation for #{@spec.full_name}"
 
     Dir.chdir @spec.full_gem_path do
-      @rdoc.parse_files options.files
+      # RDoc::Options#finish must be called before parse_files.
+      # RDoc::Options#finish is also called after ri/darkfish generator setup.
+      # We need to dup the options to avoid modifying it after finish is called.
+      parse_options = options.dup
+      parse_options.finish
+      @rdoc.options = parse_options
+      @rdoc.store = RDoc::Store.new(parse_options)
+      @rdoc.parse_files parse_options.files
     end
 
     document 'ri',       options, @ri_dir if
@@ -297,7 +300,7 @@ module RDoc
       RubyGemsHook.new(@spec).remove
     end
 
-    def self.generation_hook installer, specs
+    def self.generation_hook(installer, specs)
       # Do nothing if this is NOT a default gem.
       return unless default_gem?