rdoc 6.12.0 → 6.14.1

data/lib/rdoc/servlet.rb

@@ -66,7 +66,7 @@ class RDoc::Servlet < WEBrick::HTTPServlet::AbstractServlet
   # +server+ is provided automatically by WEBrick when mounting.  +stores+ and
   # +cache+ are provided automatically by the servlet.
 
-  def initialize server, stores, cache, mount_path = nil, extra_doc_dirs = []
+  def initialize(server, stores, cache, mount_path = nil, extra_doc_dirs = [])
     super server
 
     @cache      = cache
@@ -97,7 +97,7 @@ class RDoc::Servlet < WEBrick::HTTPServlet::AbstractServlet
   ##
   # Serves the asset at the path in +req+ for +generator_name+ via +res+.
 
-  def asset generator_name, req, res
+  def asset(generator_name, req, res)
     asset_dir = @asset_dirs[generator_name]
 
     asset_path = File.join asset_dir, req.path
@@ -116,7 +116,7 @@ class RDoc::Servlet < WEBrick::HTTPServlet::AbstractServlet
   ##
   # GET request entry point.  Fills in +res+ for the path, etc. in +req+.
 
-  def do_GET req, res
+  def do_GET(req, res)
     req.path.sub!(/\A#{Regexp.escape @mount_path}/, '') if @mount_path
 
     case req.path
@@ -133,7 +133,7 @@ class RDoc::Servlet < WEBrick::HTTPServlet::AbstractServlet
       show_documentation req, res
     end
   rescue WEBrick::HTTPStatus::NotFound => e
-    generator = generator_for RDoc::Store.new
+    generator = generator_for RDoc::Store.new(@options)
 
     not_found generator, req, res, e.message
   rescue WEBrick::HTTPStatus::Status
@@ -149,7 +149,7 @@ class RDoc::Servlet < WEBrick::HTTPServlet::AbstractServlet
   # module or page name (/RDoc/Servlet.html becomes RDoc::Servlet).
   # +generator+ is used to create the page.
 
-  def documentation_page store, generator, path, req, res
+  def documentation_page(store, generator, path, req, res)
     text_name = path.chomp '.html'
     name = text_name.gsub '/', '::'
 
@@ -168,7 +168,7 @@ class RDoc::Servlet < WEBrick::HTTPServlet::AbstractServlet
   # Creates the JSON search index on +res+ for the given +store+.  +generator+
   # must respond to \#json_index to build.  +req+ is ignored.
 
-  def documentation_search store, generator, req, res
+  def documentation_search(store, generator, req, res)
     json_index = @cache[store].fetch :json_index do
       @cache[store][:json_index] =
         JSON.dump generator.json_index.build_index
@@ -182,7 +182,7 @@ class RDoc::Servlet < WEBrick::HTTPServlet::AbstractServlet
   # Returns the RDoc::Store and path relative to +mount_path+ for
   # documentation at +path+.
 
-  def documentation_source path
+  def documentation_source(path)
     _, source_name, path = path.split '/', 3
 
     store = @stores[source_name]
@@ -200,7 +200,7 @@ class RDoc::Servlet < WEBrick::HTTPServlet::AbstractServlet
   ##
   # Generates an error page for the +exception+ while handling +req+ on +res+.
 
-  def error exception, req, res
+  def error(exception, req, res)
     backtrace = exception.backtrace.join "\n"
 
     res.content_type = 'text/html'
@@ -243,10 +243,11 @@ version.  If you're viewing Ruby's documentation, include the version of ruby.
   ##
   # Instantiates a Darkfish generator for +store+
 
-  def generator_for store
+  def generator_for(store)
     generator = RDoc::Generator::Darkfish.new store, @options
     generator.file_output = false
     generator.asset_rel_path = '..'
+    generator.setup
 
     rdoc = RDoc::RDoc.new
     rdoc.store     = store
@@ -264,7 +265,7 @@ version.  If you're viewing Ruby's documentation, include the version of ruby.
   # file has not been modified a Not Modified response is returned.  If the
   # file has been modified a Last-Modified header is added to +res+.
 
-  def if_modified_since req, res, path = nil
+  def if_modified_since(req, res, path = nil)
     last_modified = File.stat(path).mtime if path
 
     res['last-modified'] = last_modified.httpdate
@@ -290,7 +291,7 @@ version.  If you're viewing Ruby's documentation, include the version of ruby.
   def installed_docs
     extra_counter = 0
     ri_paths.map do |path, type|
-      store = RDoc::Store.new path, type
+      store = RDoc::Store.new(@options, path: path, type: type)
       exists = File.exist? store.cache_path
 
       case type
@@ -315,7 +316,7 @@ version.  If you're viewing Ruby's documentation, include the version of ruby.
   ##
   # Returns a 404 page built by +generator+ for +req+ on +res+.
 
-  def not_found generator, req, res, message = nil
+  def not_found(generator, req, res, message = nil)
     message ||= "The page <kbd>#{ERB::Util.h req.path}</kbd> was not found"
     res.body = generator.generate_servlet_not_found message
     res.status = 404
@@ -324,14 +325,14 @@ version.  If you're viewing Ruby's documentation, include the version of ruby.
   ##
   # Enumerates the ri paths.  See RDoc::RI::Paths#each
 
-  def ri_paths &block
+  def ri_paths(&block)
     RDoc::RI::Paths.each true, true, true, :all, *@extra_doc_dirs, &block #TODO: pass extra_dirs
   end
 
   ##
   # Generates the root page on +res+.  +req+ is ignored.
 
-  def root req, res
+  def root(req, res)
     generator = RDoc::Generator::Darkfish.new nil, @options
 
     res.body = generator.generate_servlet_root installed_docs
@@ -342,7 +343,7 @@ version.  If you're viewing Ruby's documentation, include the version of ruby.
   ##
   # Generates a search index for the root page on +res+.  +req+ is ignored.
 
-  def root_search req, res
+  def root_search(req, res)
     search_index = []
     info         = []
 
@@ -392,7 +393,7 @@ version.  If you're viewing Ruby's documentation, include the version of ruby.
   # Displays documentation for +req+ on +res+, whether that be HTML or some
   # asset.
 
-  def show_documentation req, res
+  def show_documentation(req, res)
     store, path = documentation_source req.path
 
     if_modified_since req, res, store.cache_path
@@ -416,18 +417,18 @@ version.  If you're viewing Ruby's documentation, include the version of ruby.
   ##
   # Returns an RDoc::Store for the given +source_name+ ('ruby' or a gem name).
 
-  def store_for source_name
+  def store_for(source_name)
     case source_name
     when 'home' then
-      RDoc::Store.new RDoc::RI::Paths.home_dir, :home
+      RDoc::Store.new(@options, path: RDoc::RI::Paths.home_dir, type: :home)
     when 'ruby' then
-      RDoc::Store.new RDoc::RI::Paths.system_dir, :system
+      RDoc::Store.new(@options, path: RDoc::RI::Paths.system_dir, type: :system)
     when 'site' then
-      RDoc::Store.new RDoc::RI::Paths.site_dir, :site
+      RDoc::Store.new(@options, path: RDoc::RI::Paths.site_dir, type: :site)
     when /\Aextra-(\d+)\z/ then
       index = $1.to_i - 1
       ri_dir = installed_docs[index][4]
-      RDoc::Store.new ri_dir, :extra
+      RDoc::Store.new(@options, path: ri_dir, type: :extra)
     else
       ri_dir, type = ri_paths.find do |dir, dir_type|
         next unless dir_type == :gem
@@ -438,7 +439,7 @@ version.  If you're viewing Ruby's documentation, include the version of ruby.
       raise WEBrick::HTTPStatus::NotFound,
             "Could not find gem \"#{ERB::Util.html_escape(source_name)}\". Are you sure you installed it?" unless ri_dir
 
-      store = RDoc::Store.new ri_dir, type
+      store = RDoc::Store.new(@options, path: ri_dir, type: type)
 
       return store if File.exist? store.cache_path
 

data/lib/rdoc/stats/normal.rb

@@ -20,7 +20,7 @@ class RDoc::Stats::Normal < RDoc::Stats::Quiet
   ##
   # Prints a file with a progress bar
 
-  def print_file files_so_far, filename
+  def print_file(files_so_far, filename)
     progress_bar = sprintf("%3d%% [%2d/%2d]  ",
                            100 * files_so_far / @num_files,
                            files_so_far,

data/lib/rdoc/stats/quiet.rb

@@ -7,7 +7,7 @@ class RDoc::Stats::Quiet
   ##
   # Creates a new Quiet that will print nothing
 
-  def initialize num_files
+  def initialize(num_files)
     @num_files = num_files
   end
 

data/lib/rdoc/stats/verbose.rb

@@ -8,15 +8,15 @@ class RDoc::Stats::Verbose < RDoc::Stats::Normal
   ##
   # Returns a marker for RDoc::CodeObject +co+ being undocumented
 
-  def nodoc co
+  def nodoc(co)
     " (undocumented)" unless co.documented?
   end
 
-  def print_alias as # :nodoc:
+  def print_alias(as) # :nodoc:
     puts "    alias #{as.new_name} #{as.old_name}#{nodoc as}"
   end
 
-  def print_attribute attribute # :nodoc:
+  def print_attribute(attribute) # :nodoc:
     puts "    #{attribute.definition} #{attribute.name}#{nodoc attribute}"
   end
 

data/lib/rdoc/stats.rb

@@ -26,7 +26,7 @@ class RDoc::Stats
   # Creates a new Stats that will have +num_files+.  +verbosity+ defaults to 1
   # which will create an RDoc::Stats::Normal outputter.
 
-  def initialize store, num_files, verbosity = 1
+  def initialize(store, num_files, verbosity = 1)
     @num_files = num_files
     @store     = store
 
@@ -49,28 +49,28 @@ class RDoc::Stats
   ##
   # Records the parsing of an alias +as+.
 
-  def add_alias as
+  def add_alias(as)
     @display.print_alias as
   end
 
   ##
   # Records the parsing of an attribute +attribute+
 
-  def add_attribute attribute
+  def add_attribute(attribute)
     @display.print_attribute attribute
   end
 
   ##
   # Records the parsing of a class +klass+
 
-  def add_class klass
+  def add_class(klass)
     @display.print_class klass
   end
 
   ##
   # Records the parsing of +constant+
 
-  def add_constant constant
+  def add_constant(constant)
     @display.print_constant constant
   end
 
@@ -155,7 +155,7 @@ class RDoc::Stats
   # 0:: Classes, modules, constants, attributes, methods
   # 1:: Level 0 + method parameters
 
-  def coverage_level= level
+  def coverage_level=(level)
     level = -1 unless level
 
     @coverage_level = level
@@ -164,7 +164,7 @@ class RDoc::Stats
   ##
   # Returns the length and number of undocumented items in +collection+.
 
-  def doc_stats collection
+  def doc_stats(collection)
     visible = collection.select { |item| item.display? }
     [visible.length, visible.count { |item| not item.documented? }]
   end
@@ -256,12 +256,12 @@ class RDoc::Stats
   ##
   # Returns a report on undocumented attributes in ClassModule +cm+
 
-  def report_attributes cm
+  def report_attributes(cm)
     return if cm.attributes.empty?
 
     report = []
 
-    cm.each_attribute do |attr|
+    cm.attributes.each do |attr|
       next if attr.documented?
       line = attr.line ? ":#{attr.line}" : nil
       report << "  #{attr.definition} :#{attr.name} # in file #{attr.file.full_name}#{line}\n"
@@ -274,7 +274,7 @@ class RDoc::Stats
   ##
   # Returns a report on undocumented items in ClassModule +cm+
 
-  def report_class_module cm
+  def report_class_module(cm)
     return if cm.fully_documented? and @coverage_level.zero?
     return unless cm.display?
 
@@ -326,12 +326,12 @@ class RDoc::Stats
   ##
   # Returns a report on undocumented constants in ClassModule +cm+
 
-  def report_constants cm
+  def report_constants(cm)
     return if cm.constants.empty?
 
     report = []
 
-    cm.each_constant do |constant|
+    cm.constants.each do |constant|
       # TODO constant aliases are listed in the summary but not reported
       # figure out what to do here
       next if constant.documented? || constant.is_alias_for
@@ -348,7 +348,7 @@ class RDoc::Stats
   ##
   # Returns a report on undocumented methods in ClassModule +cm+
 
-  def report_methods cm
+  def report_methods(cm)
     return if cm.method_list.empty?
 
     report = []
@@ -436,7 +436,7 @@ class RDoc::Stats
   # Determines which parameters in +method+ were not documented.  Returns a
   # total parameter count and an Array of undocumented methods.
 
-  def undoc_params method
+  def undoc_params(method)
     @formatter ||= RDoc::Markup::ToTtOnly.new
 
     params = method.param_list

data/lib/rdoc/store.rb

@@ -54,7 +54,7 @@ class RDoc::Store
     # Creates a new MissingFileError for the missing +file+ for the given
     # +name+ that should have been in the +store+.
 
-    def initialize store, file, name
+    def initialize(store, file, name)
       @store = store
       @file  = file
       @name  = name
@@ -94,11 +94,7 @@ class RDoc::Store
 
   attr_accessor :path
 
-  ##
-  # The RDoc::RDoc driver for this parse tree.  This allows classes consulting
-  # the documentation tree to access user-set options, for example.
-
-  attr_accessor :rdoc
+  attr_reader :options
 
   ##
   # Type of ri datastore this was loaded from.  See RDoc::RI::Driver,
@@ -124,11 +120,11 @@ class RDoc::Store
   ##
   # Creates a new Store of +type+ that will load or save to +path+
 
-  def initialize path = nil, type = nil
-    @dry_run  = false
-    @encoding = nil
-    @path     = path
-    @rdoc     = nil
+  def initialize(options, path: nil, type: nil)
+    @options  = options
+    @dry_run  = options.dry_run
+    @encoding = options.encoding
+    @path     = path || options.op_dir
     @type     = type
 
     @cache = {
@@ -139,10 +135,10 @@ class RDoc::Store
       :c_singleton_class_variables => {},
       :encoding                    => @encoding,
       :instance_methods            => {},
-      :main                        => nil,
+      :main                        => options.main_page,
       :modules                     => [],
       :pages                       => [],
-      :title                       => nil,
+      :title                       => options.title,
     }
 
     @classes_hash = {}
@@ -166,14 +162,14 @@ class RDoc::Store
   # Adds +module+ as an enclosure (namespace) for the given +variable+ for C
   # files.
 
-  def add_c_enclosure variable, namespace
+  def add_c_enclosure(variable, namespace)
     @c_enclosure_classes[variable] = namespace
   end
 
   ##
   # Adds C variables from an RDoc::Parser::C
 
-  def add_c_variables c_parser
+  def add_c_variables(c_parser)
     filename = c_parser.top_level.relative_name
 
     @c_class_variables[filename] = make_variable_map c_parser.classes
@@ -185,7 +181,7 @@ class RDoc::Store
   # Adds the file with +name+ as an RDoc::TopLevel to the store.  Returns the
   # created RDoc::TopLevel.
 
-  def add_file absolute_name, relative_name: absolute_name, parser: nil
+  def add_file(absolute_name, relative_name: absolute_name, parser: nil)
     unless top_level = @files_hash[relative_name] then
       top_level = RDoc::TopLevel.new absolute_name, relative_name
       top_level.parser = parser if parser
@@ -272,7 +268,7 @@ class RDoc::Store
   ##
   # Path to the ri data for +klass_name+
 
-  def class_file klass_name
+  def class_file(klass_name)
     name = klass_name.split('::').last
     File.join class_path(klass_name), "cdesc-#{name}.ri"
   end
@@ -288,7 +284,7 @@ class RDoc::Store
   ##
   # Path where data for +klass_name+ will be stored (methods or class data)
 
-  def class_path klass_name
+  def class_path(klass_name)
     File.join @path, *klass_name.split('::')
   end
 
@@ -303,7 +299,7 @@ class RDoc::Store
   # Removes empty items and ensures item in each collection are unique and
   # sorted
 
-  def clean_cache_collection collection # :nodoc:
+  def clean_cache_collection(collection) # :nodoc:
     collection.each do |name, item|
       if item.empty? then
         collection.delete name
@@ -331,7 +327,7 @@ class RDoc::Store
   #
   # See also RDoc::Context#remove_from_documentation?
 
-  def complete min_visibility
+  def complete(min_visibility)
     fix_basic_object_inheritance
 
     # cache included modules before they are removed from the documentation
@@ -378,7 +374,7 @@ class RDoc::Store
   ##
   # Finds the enclosure (namespace) for the given C +variable+.
 
-  def find_c_enclosure variable
+  def find_c_enclosure(variable)
     @c_enclosure_classes.fetch variable do
       break unless name = @c_enclosure_names[variable]
 
@@ -403,14 +399,14 @@ class RDoc::Store
   ##
   # Finds the class with +name+ in all discovered classes
 
-  def find_class_named name
+  def find_class_named(name)
     @classes_hash[name]
   end
 
   ##
   # Finds the class with +name+ starting in namespace +from+
 
-  def find_class_named_from name, from
+  def find_class_named_from(name, from)
     from = find_class_named from unless RDoc::Context === from
 
     until RDoc::TopLevel === from do
@@ -428,7 +424,7 @@ class RDoc::Store
   ##
   # Finds the class or module with +name+
 
-  def find_class_or_module name
+  def find_class_or_module(name)
     name = $' if name =~ /^::/
     @classes_hash[name] || @modules_hash[name]
   end
@@ -436,14 +432,14 @@ class RDoc::Store
   ##
   # Finds the file with +name+ in all discovered files
 
-  def find_file_named name
+  def find_file_named(name)
     @files_hash[name]
   end
 
   ##
   # Finds the module with +name+ in all discovered modules
 
-  def find_module_named name
+  def find_module_named(name)
     @modules_hash[name]
   end
 
@@ -451,7 +447,7 @@ class RDoc::Store
   # Returns the RDoc::TopLevel that is a text file and has the given
   # +file_name+
 
-  def find_text_page file_name
+  def find_text_page(file_name)
     @text_files_hash.each_value.find do |file|
       file.full_name == file_name
     end
@@ -464,7 +460,7 @@ class RDoc::Store
   #--
   # TODO  aliases should be registered by Context#add_module_alias
 
-  def find_unique all_hash
+  def find_unique(all_hash)
     unique = []
 
     all_hash.each_pair do |full_name, cm|
@@ -607,7 +603,7 @@ class RDoc::Store
   ##
   # Loads ri data for +klass_name+ and hooks it up to this store.
 
-  def load_class klass_name
+  def load_class(klass_name)
     obj = load_class_data klass_name
 
     obj.store = self
@@ -625,7 +621,7 @@ class RDoc::Store
   ##
   # Loads ri data for +klass_name+
 
-  def load_class_data klass_name
+  def load_class_data(klass_name)
     file = class_file klass_name
 
     marshal_load(file)
@@ -638,7 +634,7 @@ class RDoc::Store
   ##
   # Loads ri data for +method_name+ in +klass_name+
 
-  def load_method klass_name, method_name
+  def load_method(klass_name, method_name)
     file = method_file klass_name, method_name
 
     obj = marshal_load(file)
@@ -654,7 +650,7 @@ class RDoc::Store
   ##
   # Loads ri data for +page_name+
 
-  def load_page page_name
+  def load_page(page_name)
     file = page_file page_name
 
     obj = marshal_load(file)
@@ -677,7 +673,7 @@ class RDoc::Store
   ##
   # Sets the main page for this RDoc store.
 
-  def main= page
+  def main=(page)
     @cache[:main] = page
   end
 
@@ -685,7 +681,7 @@ class RDoc::Store
   # Converts the variable => ClassModule map +variables+ from a C parser into
   # a variable => class name map.
 
-  def make_variable_map variables
+  def make_variable_map(variables)
     map = {}
 
     variables.each { |variable, class_module|
@@ -698,7 +694,7 @@ class RDoc::Store
   ##
   # Path to the ri data for +method_name+ in +klass_name+
 
-  def method_file klass_name, method_name
+  def method_file(klass_name, method_name)
     method_name = method_name.split('::').last
     method_name =~ /#(.*)/
     method_type = $1 ? 'i' : 'c'
@@ -726,7 +722,7 @@ class RDoc::Store
   ##
   # Returns the RDoc::TopLevel that is a text file and has the given +name+
 
-  def page name
+  def page(name)
     @text_files_hash.each_value.find do |file|
       file.page_name == name or file.base_name == name
     end
@@ -735,7 +731,7 @@ class RDoc::Store
   ##
   # Path to the ri data for +page_name+
 
-  def page_file page_name
+  def page_file(page_name)
     file_name = File.basename(page_name).gsub('.', '_')
 
     File.join @path, File.dirname(page_name), "page-#{file_name}.ri"
@@ -746,7 +742,7 @@ class RDoc::Store
   #
   # See RDoc::Context#remove_from_documentation?
 
-  def remove_nodoc all_hash
+  def remove_nodoc(all_hash)
     all_hash.keys.each do |name|
       context = all_hash[name]
       all_hash.delete(name) if context.remove_from_documentation?
@@ -766,7 +762,7 @@ class RDoc::Store
         save_method klass, method
       end
 
-      klass.each_attribute do |attribute|
+      klass.attributes.each do |attribute|
         save_method klass, attribute
       end
     end
@@ -808,7 +804,7 @@ class RDoc::Store
   ##
   # Writes the ri data for +klass+ (or module)
 
-  def save_class klass
+  def save_class(klass)
     full_name = klass.full_name
 
     FileUtils.mkdir_p class_path(full_name) unless @dry_run
@@ -882,7 +878,7 @@ class RDoc::Store
   ##
   # Writes the ri data for +method+ on +klass+
 
-  def save_method klass, method
+  def save_method(klass, method)
     full_name = klass.full_name
 
     FileUtils.mkdir_p class_path(full_name) unless @dry_run
@@ -905,7 +901,7 @@ class RDoc::Store
   ##
   # Writes the ri data for +page+
 
-  def save_page page
+  def save_page(page)
     return unless page.text?
 
     path = page_file page.full_name
@@ -952,7 +948,7 @@ class RDoc::Store
   ##
   # Sets the title page for this RDoc store.
 
-  def title= title
+  def title=(title)
     @cache[:title] = title
   end
 

data/lib/rdoc/task.rb

@@ -154,7 +154,7 @@ class RDoc::Task < Rake::TaskLib
   # Create an RDoc task with the given name. See the RDoc::Task class overview
   # for documentation.
 
-  def initialize name = :rdoc # :yield: self
+  def initialize(name = :rdoc) # :yield: self
     defaults
 
     check_names name
@@ -170,7 +170,7 @@ class RDoc::Task < Rake::TaskLib
   # Ensures that +names+ only includes names for the :rdoc, :clobber_rdoc and
   # :rerdoc.  If other names are given an ArgumentError is raised.
 
-  def check_names names
+  def check_names(names)
     return unless Hash === names
 
     invalid_options =