rdoc 6.13.0 → 6.17.0

data/lib/rdoc/markup/attribute_manager.rb

@@ -107,7 +107,7 @@ class RDoc::Markup::AttributeManager
   ##
   # Changes the current attribute from +current+ to +new+
 
-  def change_attribute current, new
+  def change_attribute(current, new)
     diff = current ^ new
     attribute(new & diff, current & diff)
   end
@@ -116,7 +116,7 @@ class RDoc::Markup::AttributeManager
   # Used by the tests to change attributes by name from +current_set+ to
   # +new_set+
 
-  def changed_attribute_by_name current_set, new_set
+  def changed_attribute_by_name(current_set, new_set)
     current = new = 0
     current_set.each do |name|
       current |= @attributes.bitmap_for(name)
@@ -220,7 +220,7 @@ class RDoc::Markup::AttributeManager
   ##
   # Converts regexp handling sequences to RDoc attributes
 
-  def convert_regexp_handlings str, attrs, exclusive = false
+  def convert_regexp_handlings(str, attrs, exclusive = false)
     @regexp_handlings.each do |regexp, attribute|
       next unless exclusive == exclusive?(attribute)
       str.scan(regexp) do
@@ -295,7 +295,7 @@ class RDoc::Markup::AttributeManager
   #
   #   @am.add_regexp_handling(/((https?:)\S+\w)/, :HYPERLINK)
 
-  def add_regexp_handling pattern, name, exclusive = false
+  def add_regexp_handling(pattern, name, exclusive = false)
     bitmap = @attributes.bitmap_for(name)
     @regexp_handlings << [pattern, bitmap]
     @exclusive_bitmap |= bitmap if exclusive
@@ -304,7 +304,7 @@ class RDoc::Markup::AttributeManager
   ##
   # Processes +str+ converting attributes, HTML and regexp handlings
 
-  def flow str
+  def flow(str)
     @str = str.dup
 
     mask_protected_sequences

data/lib/rdoc/markup/attributes.rb

@@ -26,7 +26,7 @@ class RDoc::Markup::Attributes
   ##
   # Returns a unique bit for +name+
 
-  def bitmap_for name
+  def bitmap_for(name)
     bitmap = @name_to_bitmap.assoc name
 
     unless bitmap then
@@ -43,7 +43,7 @@ class RDoc::Markup::Attributes
   ##
   # Returns a string representation of +bitmap+
 
-  def as_string bitmap
+  def as_string(bitmap)
     return 'none' if bitmap.zero?
     res = []
 
@@ -57,7 +57,7 @@ class RDoc::Markup::Attributes
   ##
   # yields each attribute name in +bitmap+
 
-  def each_name_of bitmap
+  def each_name_of(bitmap)
     return enum_for __method__, bitmap unless block_given?
 
     @name_to_bitmap.each do |name, bit|

data/lib/rdoc/markup/blank_line.rb

@@ -16,11 +16,11 @@ class RDoc::Markup::BlankLine
   ##
   # Calls #accept_blank_line on +visitor+
 
-  def accept visitor
+  def accept(visitor)
     visitor.accept_blank_line self
   end
 
-  def pretty_print q # :nodoc:
+  def pretty_print(q) # :nodoc:
     q.text 'blankline'
   end
 

data/lib/rdoc/markup/block_quote.rb

@@ -7,7 +7,7 @@ class RDoc::Markup::BlockQuote < RDoc::Markup::Raw
   ##
   # Calls #accept_block_quote on +visitor+
 
-  def accept visitor
+  def accept(visitor)
     visitor.accept_block_quote self
   end
 

data/lib/rdoc/markup/document.rb

@@ -37,7 +37,7 @@ class RDoc::Markup::Document
   ##
   # Appends +part+ to the document
 
-  def << part
+  def <<(part)
     case part
     when RDoc::Markup::Document then
       unless part.empty? then
@@ -53,7 +53,7 @@ class RDoc::Markup::Document
     end
   end
 
-  def == other # :nodoc:
+  def ==(other) # :nodoc:
     self.class == other.class and
       @file == other.file and
       @parts == other.parts
@@ -62,7 +62,7 @@ class RDoc::Markup::Document
   ##
   # Runs this document and all its #items through +visitor+
 
-  def accept visitor
+  def accept(visitor)
     visitor.start_accepting
 
     visitor.accept_document self
@@ -73,14 +73,14 @@ class RDoc::Markup::Document
   ##
   # Concatenates the given +parts+ onto the document
 
-  def concat parts
+  def concat(parts)
     self.parts.concat parts
   end
 
   ##
   # Enumerator for the parts of this document
 
-  def each &block
+  def each(&block)
     @parts.each(&block)
   end
 
@@ -94,7 +94,7 @@ class RDoc::Markup::Document
   ##
   # The file this Document was created from.
 
-  def file= location
+  def file=(location)
     @file = case location
             when RDoc::TopLevel then
               location.relative_name
@@ -111,7 +111,7 @@ class RDoc::Markup::Document
   #
   # The information in +other+ is preferred over the receiver
 
-  def merge other
+  def merge(other)
     if empty? then
       @parts = other.parts
       return self
@@ -135,7 +135,7 @@ class RDoc::Markup::Document
     RDoc::Markup::Document === @parts.first
   end
 
-  def pretty_print q # :nodoc:
+  def pretty_print(q) # :nodoc:
     start = @file ? "[doc (#{@file}): " : '[doc: '
 
     q.group 2, start, ']' do

data/lib/rdoc/markup/formatter.rb

@@ -21,7 +21,7 @@ class RDoc::Markup::Formatter
   ##
   # Converts a target url to one that is relative to a given path
 
-  def self.gen_relative_url path, target
+  def self.gen_relative_url(path, target)
     from        = File.dirname path
     to, to_file = File.split target
 
@@ -45,7 +45,7 @@ class RDoc::Markup::Formatter
   ##
   # Creates a new Formatter
 
-  def initialize options, markup = nil
+  def initialize(options, markup = nil)
     @options = options
 
     @markup = markup || RDoc::Markup.new
@@ -66,7 +66,7 @@ class RDoc::Markup::Formatter
   ##
   # Adds +document+ to the output
 
-  def accept_document document
+  def accept_document(document)
     document.parts.each do |item|
       case item
       when RDoc::Markup::Document then # HACK
@@ -117,7 +117,7 @@ class RDoc::Markup::Formatter
   ##
   # Marks up +content+
 
-  def convert content
+  def convert(content)
     @markup.convert content, self
   end
 
@@ -147,7 +147,7 @@ class RDoc::Markup::Formatter
   ##
   # Converts added regexp handlings. See RDoc::Markup#add_regexp_handling
 
-  def convert_regexp_handling target
+  def convert_regexp_handling(target)
     return target.text if in_tt?
 
     handled = false
@@ -173,7 +173,7 @@ class RDoc::Markup::Formatter
   ##
   # Converts a string to be fancier if desired
 
-  def convert_string string
+  def convert_string(string)
     string
   end
 
@@ -195,7 +195,7 @@ class RDoc::Markup::Formatter
     @in_tt > 0
   end
 
-  def tt_tag? attr_mask, reverse = false
+  def tt_tag?(attr_mask, reverse = false)
     each_attr_tag(attr_mask, reverse) do |tag|
       return true if tt? tag
     end
@@ -205,7 +205,7 @@ class RDoc::Markup::Formatter
   ##
   # Turns on tags for +item+ on +res+
 
-  def on_tags res, item
+  def on_tags(res, item)
     each_attr_tag(item.turn_on) do |tag|
       res << annotate(tag.on)
       @in_tt += 1 if tt? tag
@@ -215,14 +215,14 @@ class RDoc::Markup::Formatter
   ##
   # Turns off tags for +item+ on +res+
 
-  def off_tags res, item
+  def off_tags(res, item)
     each_attr_tag(item.turn_off, true) do |tag|
       @in_tt -= 1 if tt? tag
       res << annotate(tag.off)
     end
   end
 
-  def each_attr_tag attr_mask, reverse = false
+  def each_attr_tag(attr_mask, reverse = false)
     return if attr_mask.zero?
 
     @attr_tags.public_send(reverse ? :reverse_each : :each) do |tag|
@@ -235,7 +235,7 @@ class RDoc::Markup::Formatter
   ##
   # Extracts and a scheme, url and an anchor id from +url+ and returns them.
 
-  def parse_url url
+  def parse_url(url)
     case url
     when /^rdoc-label:([^:]*)(?::(.*))?/ then
       scheme = 'link'
@@ -265,7 +265,7 @@ class RDoc::Markup::Formatter
   ##
   # Is +tag+ a tt tag?
 
-  def tt? tag
+  def tt?(tag)
     tag.bit == @tt_bit
   end
 

data/lib/rdoc/markup/hard_break.rb

@@ -16,15 +16,15 @@ class RDoc::Markup::HardBreak
   ##
   # Calls #accept_hard_break on +visitor+
 
-  def accept visitor
+  def accept(visitor)
     visitor.accept_hard_break self
   end
 
-  def == other # :nodoc:
+  def ==(other) # :nodoc:
     self.class === other
   end
 
-  def pretty_print q # :nodoc:
+  def pretty_print(q) # :nodoc:
     q.text "[break]"
   end
 

data/lib/rdoc/markup/heading.rb

@@ -27,7 +27,7 @@ RDoc::Markup::Heading =
 
     @to_html = RDoc::Markup::ToHtml.new nil
 
-    def @to_html.handle_regexp_CROSSREF target
+    def @to_html.handle_regexp_CROSSREF(target)
       target.text.sub(/^\\/, '')
     end
 
@@ -37,7 +37,7 @@ RDoc::Markup::Heading =
   ##
   # Calls #accept_heading on +visitor+
 
-  def accept visitor
+  def accept(visitor)
     visitor.accept_heading self
   end
 
@@ -52,7 +52,7 @@ RDoc::Markup::Heading =
   # Creates a fully-qualified label which will include the label from
   # +context+.  This helps keep ids unique in HTML.
 
-  def label context = nil
+  def label(context = nil)
     label = aref
 
     label = [context.aref, label].compact.join '-' if
@@ -75,7 +75,7 @@ RDoc::Markup::Heading =
     self.class.to_html.to_html(text)
   end
 
-  def pretty_print q # :nodoc:
+  def pretty_print(q) # :nodoc:
     q.group 2, "[head: #{level} ", ']' do
       q.pp text
     end

data/lib/rdoc/markup/include.rb

@@ -20,17 +20,17 @@ class RDoc::Markup::Include
   ##
   # Creates a new include that will import +file+ from +include_path+
 
-  def initialize file, include_path
+  def initialize(file, include_path)
     @file = file
     @include_path = include_path
   end
 
-  def == other # :nodoc:
+  def ==(other) # :nodoc:
     self.class === other and
       @file == other.file and @include_path == other.include_path
   end
 
-  def pretty_print q # :nodoc:
+  def pretty_print(q) # :nodoc:
     q.group 2, '[incl ', ']' do
       q.text file
       q.breakable

data/lib/rdoc/markup/indented_paragraph.rb

@@ -19,14 +19,14 @@ class RDoc::Markup::IndentedParagraph < RDoc::Markup::Raw
     super(*parts)
   end
 
-  def == other # :nodoc:
+  def ==(other) # :nodoc:
     super and indent == other.indent
   end
 
   ##
   # Calls #accept_indented_paragraph on +visitor+
 
-  def accept visitor
+  def accept(visitor)
     visitor.accept_indented_paragraph self
   end
 
@@ -34,7 +34,7 @@ class RDoc::Markup::IndentedParagraph < RDoc::Markup::Raw
   # Joins the raw paragraph text and converts inline HardBreaks to the
   # +hard_break+ text followed by the indent.
 
-  def text hard_break = nil
+  def text(hard_break = nil)
     @parts.map do |part|
       if RDoc::Markup::HardBreak === part then
         '%1$s%3$*2$s' % [hard_break, @indent, ' '] if hard_break

data/lib/rdoc/markup/list.rb

@@ -46,11 +46,11 @@ class RDoc::Markup::List
   ##
   # Appends +item+ to the list
 
-  def << item
+  def <<(item)
     @items << item
   end
 
-  def == other # :nodoc:
+  def ==(other) # :nodoc:
     self.class == other.class and
       @type == other.type and
       @items == other.items
@@ -59,7 +59,7 @@ class RDoc::Markup::List
   ##
   # Runs this list and all its #items through +visitor+
 
-  def accept visitor
+  def accept(visitor)
     visitor.accept_list_start self
 
     @items.each do |item|
@@ -83,7 +83,7 @@ class RDoc::Markup::List
     @items.last
   end
 
-  def pretty_print q # :nodoc:
+  def pretty_print(q) # :nodoc:
     q.group 2, "[list: #{@type} ", ']' do
       q.seplist @items do |item|
         q.pp item

data/lib/rdoc/markup/list_item.rb

@@ -33,11 +33,11 @@ class RDoc::Markup::ListItem
   ##
   # Appends +part+ to the ListItem
 
-  def << part
+  def <<(part)
     @parts << part
   end
 
-  def == other # :nodoc:
+  def ==(other) # :nodoc:
     self.class == other.class and
       @label == other.label and
       @parts == other.parts
@@ -46,7 +46,7 @@ class RDoc::Markup::ListItem
   ##
   # Runs this list item and all its #parts through +visitor+
 
-  def accept visitor
+  def accept(visitor)
     visitor.accept_list_item_start self
 
     @parts.each do |part|
@@ -70,7 +70,7 @@ class RDoc::Markup::ListItem
     @parts.length
   end
 
-  def pretty_print q # :nodoc:
+  def pretty_print(q) # :nodoc:
     q.group 2, '[item: ', ']' do
       case @label
       when Array then

data/lib/rdoc/markup/paragraph.rb

@@ -7,7 +7,7 @@ class RDoc::Markup::Paragraph < RDoc::Markup::Raw
   ##
   # Calls #accept_paragraph on +visitor+
 
-  def accept visitor
+  def accept(visitor)
     visitor.accept_paragraph self
   end
 
@@ -15,7 +15,7 @@ class RDoc::Markup::Paragraph < RDoc::Markup::Raw
   # Joins the raw paragraph text and converts inline HardBreaks to the
   # +hard_break+ text.
 
-  def text hard_break = ''
+  def text(hard_break = '')
     @parts.map do |part|
       if RDoc::Markup::HardBreak === part then
         hard_break

data/lib/rdoc/markup/parser.rb

@@ -57,7 +57,7 @@ class RDoc::Markup::Parser
   #
   # Use RDoc::Markup#parse instead of this method.
 
-  def self.parse str
+  def self.parse(str)
     parser = new
     parser.tokenize str
     doc = RDoc::Markup::Document.new
@@ -67,7 +67,7 @@ class RDoc::Markup::Parser
   ##
   # Returns a token stream for +str+, for testing
 
-  def self.tokenize str
+  def self.tokenize(str)
     parser = new
     parser.tokenize str
     parser.tokens
@@ -87,7 +87,7 @@ class RDoc::Markup::Parser
   ##
   # Builds a Heading of +level+
 
-  def build_heading level
+  def build_heading(level)
     type, text, = get
 
     text = case type
@@ -105,7 +105,7 @@ class RDoc::Markup::Parser
   ##
   # Builds a List flush to +margin+
 
-  def build_list margin
+  def build_list(margin)
     p :list_start => margin if @debug
 
     list = RDoc::Markup::List.new
@@ -205,7 +205,7 @@ class RDoc::Markup::Parser
   ##
   # Builds a Paragraph that is flush to +margin+
 
-  def build_paragraph margin
+  def build_paragraph(margin)
     p :paragraph_start => margin if @debug
 
     paragraph = RDoc::Markup::Paragraph.new
@@ -240,7 +240,7 @@ class RDoc::Markup::Parser
   # terminated by a newline.  Blank lines always consist of a single newline
   # character, and there is never a single newline at the end of the verbatim.
 
-  def build_verbatim margin
+  def build_verbatim(margin)
     p :verbatim_begin => margin if @debug
     verbatim = RDoc::Markup::Verbatim.new
 
@@ -339,7 +339,7 @@ class RDoc::Markup::Parser
   #
   # Returns +parent+.
 
-  def parse parent, indent = 0
+  def parse(parent, indent = 0)
     p :parse_start => indent if @debug
 
     until @tokens.empty? do
@@ -403,7 +403,7 @@ class RDoc::Markup::Parser
   ##
   # Small hook that is overridden by RDoc::TomDoc
 
-  def parse_text parent, indent # :nodoc:
+  def parse_text(parent, indent) # :nodoc:
     parent << build_paragraph(indent)
   end
 
@@ -465,7 +465,7 @@ class RDoc::Markup::Parser
   ##
   # Creates the StringScanner
 
-  def setup_scanner input
+  def setup_scanner(input)
     @s = MyStringScanner.new input
   end
 
@@ -474,7 +474,7 @@ class RDoc::Markup::Parser
   #
   # Optionally raises an error if the next token is not of the expected type.
 
-  def skip token_type, error = true
+  def skip(token_type, error = true)
     type, = get
     return unless type # end of stream
     return @current_token if token_type == type
@@ -485,7 +485,7 @@ class RDoc::Markup::Parser
   ##
   # Turns text +input+ into a stream of tokens
 
-  def tokenize input
+  def tokenize(input)
     setup_scanner input
 
     until @s.eos? do

data/lib/rdoc/markup/pre_process.rb

@@ -27,7 +27,7 @@ class RDoc::Markup::PreProcess
   # with the result RDoc::Comment (or text String) and the code object for the
   # comment (if any).
 
-  def self.post_process &block
+  def self.post_process(&block)
     @post_processors << block
   end
 
@@ -50,7 +50,7 @@ class RDoc::Markup::PreProcess
   #     # replace text, etc.
   #   end
 
-  def self.register directive, &block
+  def self.register(directive, &block)
     @registered[directive] = block
   end
 
@@ -96,19 +96,16 @@ class RDoc::Markup::PreProcess
   # directive's parameter is set as metadata on the +code_object+.  See
   # RDoc::CodeObject#metadata for details.
 
-  def handle text, code_object = nil, &block
-    first_line = 1
+  def handle(text, code_object = nil, &block)
     if RDoc::Comment === text then
       comment = text
       text = text.text
-      first_line = comment.line || 1
     end
 
     # regexp helper (square brackets for optional)
     # $1      $2  $3        $4      $5
     # [prefix][\]:directive:[spaces][param]newline
-    text = text.lines.map.with_index(first_line) do |line, num|
-      next line unless line =~ /\A([ \t]*(?:#|\/?\*)?[ \t]*)(\\?):([\w-]+):([ \t]*)(.+)?(\r?\n|$)/
+    text = text.gsub(/^([ \t]*(?:#|\/?\*)?[ \t]*)(\\?):([\w-]+):([ \t]*)(.+)?(\r?\n|$)/) do
       # skip something like ':toto::'
       next $& if $4.empty? and $5 and $5[0, 1] == ':'
 
@@ -122,9 +119,8 @@ class RDoc::Markup::PreProcess
         comment.format = $5.downcase
         next "#{$1.strip}\n"
       end
-
-      handle_directive $1, $3, $5, code_object, text.encoding, num, &block
-    end.join
+      handle_directive $1, $3, $5, code_object, text.encoding, &block
+    end
 
     if comment then
       comment.text = text
@@ -132,11 +128,39 @@ class RDoc::Markup::PreProcess
       comment = text
     end
 
+    run_post_processes(comment, code_object)
+
+    text
+  end
+
+  # Apply directives to a code object
+
+  def run_pre_processes(comment_text, code_object, start_line_no, type)
+    comment_text, directives = parse_comment(comment_text, start_line_no, type)
+    directives.each do |directive, (param, line_no)|
+      handle_directive('', directive, param, code_object)
+    end
+    if code_object.is_a?(RDoc::AnyMethod) && (call_seq, = directives['call-seq']) && call_seq
+      code_object.call_seq = call_seq.lines.map(&:chomp).reject(&:empty?).join("\n")
+    end
+    format, = directives['markup']
+    [comment_text, format]
+  end
+
+  # Perform post preocesses to a code object
+
+  def run_post_processes(comment, code_object)
     self.class.post_processors.each do |handler|
       handler.call comment, code_object
     end
+  end
 
-    text
+  # Parse comment and return [normalized_comment_text, directives_hash]
+
+  def parse_comment(text, line_no, type)
+    RDoc::Comment.parse(text, @input_file_name, line_no, type) do |filename, prefix_indent|
+      include_file(filename, prefix_indent, text.encoding)
+    end
   end
 
   ##
@@ -150,8 +174,8 @@ class RDoc::Markup::PreProcess
   #--
   # When 1.8.7 support is ditched prefix can be defaulted to ''
 
-  def handle_directive prefix, directive, param, code_object = nil,
-                       encoding = nil, line = nil
+  def handle_directive(prefix, directive, param, code_object = nil,
+                       encoding = nil)
     blankline = "#{prefix.strip}\n"
     directive = directive.downcase
 
@@ -244,7 +268,7 @@ class RDoc::Markup::PreProcess
 
       blankline
     else
-      result = yield directive, param, line if block_given?
+      result = yield directive, param if block_given?
 
       case result
       when nil then
@@ -279,7 +303,7 @@ class RDoc::Markup::PreProcess
   # TODO shift left the whole file content in that case
   # TODO comment stop/start #-- and #++ in included file must be processed here
 
-  def include_file name, indent, encoding
+  def include_file(name, indent, encoding)
     full_name = find_include_file name
 
     unless full_name then