class RDoc::MethodAttr
Abstract class representing either a method or an attribute.
Attributes
Array of other names for this method/attribute
Parameters yielded by the called block
Different ways to call this method
The method/attribute we’re aliasing
Name of this method/attribute.
Pretty parameter list for this method
Parameters for this method
Is this a singleton method/attribute?
Source file token stream
public, protected, private
Public Class Methods
Source
# File lib/rdoc/code_object/method_attr.rb, line 78 def initialize text, name super() @text = text @name = name @aliases = [] @is_alias_for = nil @parent_name = nil @singleton = nil @visibility = :public @see = false @arglists = nil @block_params = nil @call_seq = nil @param_seq = nil @params = nil end
Creates a new MethodAttr
from token stream text
and method or attribute name name
.
Usually this is called by super from a subclass.
RDoc::CodeObject::new
Public Instance Methods
Source
Source
# File lib/rdoc/code_object/method_attr.rb, line 209 def add_alias(an_alias, context) raise NotImplementedError end
Abstract method. Contexts in their building phase call this to register a new alias for this known method/attribute.
-
creates a new AnyMethod/Attribute named
an_alias.new_name
; -
adds
self
as an alias for the new method or attribute -
adds the method or attribute to
aliases
-
adds the method or attribute to
context
.
Source
# File lib/rdoc/generator/markup.rb, line 77 def add_line_numbers(src) return unless src.sub!(/\A(.*)(, line (\d+))/, '\1') first = $3.to_i - 1 last = first + src.count("\n") size = last.to_s.length line = first src.gsub!(/^/) do res = if line == first then " " * (size + 1) else "<span class=\"line-num\">%2$*1$d</span> " % [size, line] end line += 1 res end end
Prepend src
with line numbers. Relies on the first line of a source code listing having:
# File xxxxx, line dddd
If it has this comment then line numbers are added to src
and the , line dddd
portion of the comment is removed.
Source
# File lib/rdoc/code_object/method_attr.rb, line 216 def aref type = singleton ? 'c' : 'i' # % characters are not allowed in html names => dash instead "#{aref_prefix}-#{type}-#{html_name}" end
HTML fragment reference for this method
Source
# File lib/rdoc/code_object/method_attr.rb, line 225 def aref_prefix raise NotImplementedError end
Prefix for aref
, defined by subclasses.
Source
# File lib/rdoc/code_object/method_attr.rb, line 233 def block_params=(value) # 'yield.to_s' or 'assert yield, msg' return @block_params = '' if value =~ /^[\.,]/ # remove trailing 'if/unless ...' return @block_params = '' if value =~ /^(if|unless)\s/ value = $1.strip if value =~ /^(.+)\s(if|unless)\s/ # outer parentheses value = $1 if value =~ /^\s*\((.*)\)\s*$/ value = value.strip # proc/lambda return @block_params = $1 if value =~ /^(proc|lambda)(\s*\{|\sdo)/ # surrounding +...+ or [...] value = $1.strip if value =~ /^\+(.*)\+$/ value = $1.strip if value =~ /^\[(.*)\]$/ return @block_params = '' if value.empty? # global variable return @block_params = 'str' if value =~ /^\$[&0-9]$/ # wipe out array/hash indices value.gsub!(/(\w)\[[^\[]+\]/, '\1') # remove @ from class/instance variables value.gsub!(/@@?([a-z0-9_]+)/, '\1') # method calls => method name value.gsub!(/([A-Z:a-z0-9_]+)\.([a-z0-9_]+)(\s*\(\s*[a-z0-9_.,\s]*\s*\)\s*)?/) do case $2 when 'to_s' then $1 when 'const_get' then 'const' when 'new' then $1.split('::').last. # ClassName => class_name gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2'). gsub(/([a-z\d])([A-Z])/, '\1_\2'). downcase else $2 end end # class prefixes value.gsub!(/[A-Za-z0-9_:]+::/, '') # simple expressions value = $1 if value =~ /^([a-z0-9_]+)\s*[-*+\/]/ @block_params = value.strip end
Attempts to sanitize the content passed by the Ruby parser: remove outer parentheses, etc.
Source
# File lib/rdoc/code_object/method_attr.rb, line 132 def documented? super or (is_alias_for and is_alias_for.documented?) or (see and see.documented?) end
A method/attribute is documented if any of the following is true:
-
it was marked with :nodoc:;
-
it has a comment;
-
it is an alias for a documented method;
-
it has a
see
method that is documented.
RDoc::CodeObject#documented?
Source
# File lib/rdoc/code_object/method_attr.rb, line 300 def full_name @full_name ||= "#{parent_name}#{pretty_name}" end
Full method/attribute name including namespace
Source
# File lib/rdoc/code_object/method_attr.rb, line 291 def html_name require 'cgi/util' CGI.escape(@name.gsub('-', '-2D')).gsub('%', '-').sub(/^-/, '') end
HTML id-friendly method/attribute name
Source
# File lib/rdoc/generator/markup.rb, line 101 def markup_code return '' unless @token_stream src = RDoc::TokenStream.to_html @token_stream # dedent the source indent = src.length lines = src.lines.to_a lines.shift if src =~ /\A.*#\ *File/i # remove '# File' comment lines.each do |line| if line =~ /^ *(?=\S)/ n = $~.end(0) indent = n if n < indent break if n == 0 end end src.gsub!(/^#{' ' * indent}/, '') if indent > 0 add_line_numbers(src) if options.line_numbers src end
Turns the method’s token stream into HTML.
Prepends line numbers if options.line_numbers
is true.
Source
# File lib/rdoc/code_object/method_attr.rb, line 319 def name_prefix @singleton ? '::' : '#' end
‘::’ for a class method/attribute, ‘#’ for an instance method.
Source
# File lib/rdoc/code_object/method_attr.rb, line 330 def output_name context return "#{name_prefix}#{@name}" if context == parent "#{parent_name}#{@singleton ? '.' : '#'}#{@name}" end
Name for output to HTML. For class methods the full name with a “.” is used like SomeClass.method_name
. For instance methods the class name is used if context
does not match the parent.
- This is to help prevent people from using
-
to call class methods.
Source
# File lib/rdoc/code_object/method_attr.rb, line 360 def parent_name @parent_name || super end
Name of our parent with special handling for un-marshaled methods
RDoc::CodeObject#parent_name
Source
# File lib/rdoc/code_object/method_attr.rb, line 353 def path "#{@parent.path}##{aref}" end
Path to this method for use with HTML generator output.
Source
# File lib/rdoc/code_object/method_attr.rb, line 339 def pretty_name "#{name_prefix}#{@name}" end
Method/attribute name with class/instance indicator
Source
# File lib/rdoc/code_object/method_attr.rb, line 398 def search_record [ @name, full_name, @name, @parent.full_name, path, params, snippet(@comment), ] end
Used by RDoc::Generator::JsonIndex
to create a record for the search engine.
Source
# File lib/rdoc/code_object/method_attr.rb, line 152 def see @see = find_see if @see == false @see end
A method/attribute to look at, in particular if this method/attribute has no documentation.
It can be a method/attribute of the superclass or of an included module, including the Kernel module, which is always appended to the included modules.
Returns nil
if there is no such method/attribute. The is_alias_for
method/attribute, if any, is not included.
Templates may generate a “see also …” if this method/attribute has documentation, and “see …” if it does not.
Source
# File lib/rdoc/code_object/method_attr.rb, line 160 def store= store super @file = @store.add_file @file.full_name if @file end
Sets the store for this class or module and its contained code objects.
RDoc::CodeObject#store=
Source
# File lib/rdoc/code_object/method_attr.rb, line 346 def type singleton ? 'class' : 'instance' end
Type of method/attribute (class or instance)