Class: YARD::CodeObjects::MethodObject

Inherits:

Base

• Object
• Base
• YARD::CodeObjects::MethodObject

show all

Defined in:

lib/yard/code_objects/method_object.rb

Overview

Instance Attribute Summary (collapse)

• - (Boolean) explicit

  Whether the object is explicitly defined in source or whether it was inferred by a handler.

• - (Array<Array(String, String)>) parameters

  Returns the list of parameters parsed out of the method signature with their default values.

• - (Symbol) scope

  The scope of the method (:class or :instance).

• - (Symbol) visibility

  The visibility of the method (:public:, :protected, :private).

Instance Method Summary (collapse)

• - (Array<Symbol>) aliases

  Returns all alias names of the object.

• - (SymbolHash^?) attr_info

  Returns the read/writer info for the attribute if it is one.

• - (Boolean) constructor?

  Whether or not the method is the #initialize constructor method.

• - (MethodObject) initialize(namespace, name, scope = :instance) constructor

  Creates a new method object in namespace with name and an instance or class scope.

• - (Boolean) is_alias?

  Tests if the object is defined as an alias of another method.

• - (Boolean) is_attribute?

  Tests if the object is defined as an attribute in the namespace.

• - (Boolean) is_explicit?

  Tests boolean #explicit value.

• - (String, Symbol) name(prefix = false)

  Returns the name of the object.

• - (MethodObject^?) overridden_method
• - (String) path

  Override path handling for instance methods in the root namespace (they should still have a separator as a prefix).

• - (Boolean) reader?

  Whether the method is a reader attribute.

• - (String) sep protected

  Override separator to differentiate between class and instance methods.

• - (Boolean) writer?

  Whether the method is a writer attribute.

Methods inherited from Base

===, #[], #[]=, #add_file, #dynamic?, #equal?, #file, #format, #format_source, #has_tag?, #hash, #inspect, #line, #method_missing, new, #relative_path, #root?, #tag, #tags, #type

34
35
36
37
38
39
40
41

# File 'lib/yard/code_objects/method_object.rb', line 34

def initialize(namespace, name, scope = :instance) 
  @scope = nil
  self.visibility = :public
  self.scope = scope
  self.parameters = []

  super
end

19
20
21

# File 'lib/yard/code_objects/method_object.rb', line 19

def explicit
  @explicit
end

26
27
28

# File 'lib/yard/code_objects/method_object.rb', line 26

def parameters
  @parameters
end

12
13
14

# File 'lib/yard/code_objects/method_object.rb', line 12

def scope
  @scope
end

7
8
9

# File 'lib/yard/code_objects/method_object.rb', line 7

def visibility
  @visibility
end

113
114
115
116
117
118
119
120

# File 'lib/yard/code_objects/method_object.rb', line 113

def aliases
  list = []
  return list unless namespace.is_a?(NamespaceObject)
  namespace.aliases.each do |o, aname| 
    list << o if aname == name && o.scope == scope 
  end
  list
end

65
66
67
68

# File 'lib/yard/code_objects/method_object.rb', line 65

def attr_info
  return nil unless namespace.is_a?(NamespaceObject)
  namespace.attributes[scope][name.to_s.gsub(/=$/, '')]
end

57
58
59

# File 'lib/yard/code_objects/method_object.rb', line 57

def constructor?
  name == :initialize && scope == :instance && namespace.is_a?(ClassObject)
end

91
92
93
94

# File 'lib/yard/code_objects/method_object.rb', line 91

def is_alias?
  return false unless namespace.is_a?(NamespaceObject)
  namespace.aliases.has_key? self
end

84
85
86
87

# File 'lib/yard/code_objects/method_object.rb', line 84

def is_attribute?
  return false unless info = attr_info
  info[name.to_s =~ /=$/ ? :write : :read] ? true : false
end

99
100
101

# File 'lib/yard/code_objects/method_object.rb', line 99

def is_explicit?
  explicit ? true : false
end

an_instance_method.name(true) # => "#mymethod"

a_class_method.name(true) # => "mymethod"

143
144
145

# File 'lib/yard/code_objects/method_object.rb', line 143

def name(prefix = false)
  prefix ? (sep == ISEP ? "#{sep}#{super}" : super.to_s) : super
end

106
107
108
109

# File 'lib/yard/code_objects/method_object.rb', line 106

def overridden_method
  meths = namespace.meths(:all => true)
  meths.find {|m| m.path != path && m.name == name && m.scope == scope }
end

125
126
127
128
129
130
131

# File 'lib/yard/code_objects/method_object.rb', line 125

def path
  if !namespace || namespace.path == "" 
    sep + super
  else
    super
  end
end

78
79
80

# File 'lib/yard/code_objects/method_object.rb', line 78

def reader?
  !!((info = attr_info) && info[:read] == self)
end

152
153
154
155
156
157
158

# File 'lib/yard/code_objects/method_object.rb', line 152

def sep
  if scope == :class
    namespace && namespace != YARD::Registry.root ? CSEP : NSEP
  else
    ISEP
  end
end

72
73
74

# File 'lib/yard/code_objects/method_object.rb', line 72

def writer?
  !!((info = attr_info) && info[:write] == self)
end