Class: YARD::CodeObjects::Proxy
- Inherits:
-
Object
- Object
- YARD::CodeObjects::Proxy
- Defined in:
- lib/yard/code_objects/proxy.rb
Overview
The Proxy class is a way to lazily resolve code objects in cases where the object may not yet exist. A proxy simply stores an unresolved path until a method is called on the object, at which point it does a lookup using Registry.resolve. If the object is not found, a warning is raised and ProxyMethodError might be raised.
Instance Attribute Summary collapse
-
#namespace ⇒ Object
(also: #parent)
readonly
Returns the value of attribute namespace.
Class Method Summary collapse
Instance Method Summary collapse
- #<=>(other) ⇒ Boolean
- #===(other) ⇒ Boolean
-
#class ⇒ Class
Returns the class name of the object the proxy is mimicking, if resolved.
- #equal?(other) ⇒ Boolean (also: #==)
-
#hash ⇒ Integer
The object’s hash value (for equality checking).
-
#initialize(namespace, name, type = nil) ⇒ Proxy
constructor
Creates a new Proxy.
-
#inspect ⇒ String
Returns a text representation of the Proxy.
- #instance_of?(klass) ⇒ Boolean
- #is_a?(klass) ⇒ Boolean
- #kind_of?(klass) ⇒ Boolean
-
#method_missing(meth, *args, &block) ⇒ Object
Dispatches the method to the resolved object.
-
#name(prefix = false) ⇒ Symbol, String
The name of the object.
-
#path ⇒ String
(also: #to_s, #to_str)
If the proxy resolves to an object, returns its path, otherwise guesses at the correct path using the original namespace and name.
- #respond_to?(meth, include_private = false) ⇒ Boolean
-
#root? ⇒ Boolean
This class is never a root object.
-
#type ⇒ Symbol
Returns the type of the proxy.
-
#type=(type) ⇒ void
Allows a parser to infer the type of the proxy by its path.
Constructor Details
#initialize(namespace, name, type = nil) ⇒ Proxy
Creates a new Proxy
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 |
# File 'lib/yard/code_objects/proxy.rb', line 28 def initialize(namespace, name, type = nil) namespace = Registry.root if !namespace || namespace == :root if name =~ /^#{NSEPQ}/ namespace = Registry.root name = name[2..-1] end if name =~ /(?:#{NSEPQ}|#{ISEPQ}|#{CSEPQ})([^#{NSEPQ}#{ISEPQ}#{CSEPQ}]+)$/ @orignamespace, @origname = namespace, name @imethod = true if name.include? ISEP namespace = Proxy.new(namespace, $`) unless $`.empty? name = $1 else @orignamespace, @origname, @imethod = nil, nil, nil end @name = name.to_sym @namespace = namespace @obj = nil @imethod ||= nil self.type = type if @namespace.is_a?(ConstantObject) @origname = nil # forget these for a constant @orignamespace = nil @namespace = Proxy.new(@namespace.namespace, @namespace.value) end unless @namespace.is_a?(NamespaceObject) or @namespace.is_a?(Proxy) raise ArgumentError, "Invalid namespace object: #{namespace}" end # If the name begins with "::" (like "::String") # this is definitely a root level object, so # remove the namespace and attach it to the root if @name =~ /^#{NSEPQ}/ @name.gsub!(/^#{NSEPQ}/, '') @namespace = Registry.root end end |
Dynamic Method Handling
This class handles dynamic methods through the method_missing method
#method_missing(meth, *args, &block) ⇒ Object
Dispatches the method to the resolved object.
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 |
# File 'lib/yard/code_objects/proxy.rb', line 191 def method_missing(meth, *args, &block) if obj = to_obj obj.__send__(meth, *args, &block) else log.warn "Load Order / Name Resolution Problem on #{path}:" log.warn "-" log.warn "Something is trying to call #{meth} on object #{path} before it has been recognized." log.warn "This error usually means that you need to modify the order in which you parse files" log.warn "so that #{path} is parsed before methods or other objects attempt to access it." log.warn "-" log.warn "YARD will recover from this error and continue to parse but you *may* have problems" log.warn "with your generated documentation. You should probably fix this." log.warn "-" begin super rescue NoMethodError raise ProxyMethodError, "Proxy cannot call method ##{meth} on object '#{path}'" end end end |
Instance Attribute Details
#namespace ⇒ Object (readonly) Also known as: parent
Returns the value of attribute namespace.
21 22 23 |
# File 'lib/yard/code_objects/proxy.rb', line 21 def namespace @namespace end |
Class Method Details
.===(other) ⇒ Object
19 |
# File 'lib/yard/code_objects/proxy.rb', line 19 def self.===(other) other.is_a?(self) end |
Instance Method Details
#<=>(other) ⇒ Boolean
119 120 121 122 123 124 125 |
# File 'lib/yard/code_objects/proxy.rb', line 119 def <=>(other) if other.respond_to? :path path <=> other.path else false end end |
#===(other) ⇒ Boolean
110 111 112 113 114 115 116 |
# File 'lib/yard/code_objects/proxy.rb', line 110 def ===(other) if obj = to_obj obj === other else self.class <= other.class end end |
#class ⇒ Class
Returns the class name of the object the proxy is mimicking, if resolved. Otherwise returns Proxy
.
143 144 145 146 147 148 149 |
# File 'lib/yard/code_objects/proxy.rb', line 143 def class if obj = to_obj obj.class else Proxy end end |
#equal?(other) ⇒ Boolean Also known as: ==
128 129 130 131 132 133 134 |
# File 'lib/yard/code_objects/proxy.rb', line 128 def equal?(other) if other.respond_to? :path path == other.path else false end end |
#hash ⇒ Integer
Returns the object’s hash value (for equality checking).
138 |
# File 'lib/yard/code_objects/proxy.rb', line 138 def hash; path.hash end |
#inspect ⇒ String
Returns a text representation of the Proxy
77 78 79 80 81 82 83 |
# File 'lib/yard/code_objects/proxy.rb', line 77 def inspect if obj = to_obj obj.inspect else "P(#{path})" end end |
#instance_of?(klass) ⇒ Boolean
170 171 172 |
# File 'lib/yard/code_objects/proxy.rb', line 170 def instance_of?(klass) self.class == klass end |
#is_a?(klass) ⇒ Boolean
101 102 103 104 105 106 107 |
# File 'lib/yard/code_objects/proxy.rb', line 101 def is_a?(klass) if obj = to_obj obj.is_a?(klass) else self.class <= klass end end |
#kind_of?(klass) ⇒ Boolean
175 176 177 |
# File 'lib/yard/code_objects/proxy.rb', line 175 def kind_of?(klass) self.class <= klass end |
#name(prefix = false) ⇒ Symbol, String
The name of the object
71 72 73 |
# File 'lib/yard/code_objects/proxy.rb', line 71 def name(prefix = false) prefix ? (@imethod ? ISEP : '') + @name.to_s : @name end |
#path ⇒ String Also known as: to_s, to_str
If the proxy resolves to an object, returns its path, otherwise guesses at the correct path using the original namespace and name.
90 91 92 93 94 95 96 |
# File 'lib/yard/code_objects/proxy.rb', line 90 def path if obj = to_obj obj.path else proxy_path end end |
#respond_to?(meth, include_private = false) ⇒ Boolean
180 181 182 183 184 185 186 |
# File 'lib/yard/code_objects/proxy.rb', line 180 def respond_to?(meth, include_private = false) if obj = to_obj obj.respond_to?(meth, include_private) else super end end |
#root? ⇒ Boolean
This class is never a root object
213 |
# File 'lib/yard/code_objects/proxy.rb', line 213 def root?; false end |
#type ⇒ Symbol
Returns the type of the proxy. If it cannot be resolved at the time of the call, it will either return the inferred proxy type (see #type=) or :proxy
156 157 158 159 160 161 162 |
# File 'lib/yard/code_objects/proxy.rb', line 156 def type if obj = to_obj obj.type else @type || :proxy end end |
#type=(type) ⇒ void
This method returns an undefined value.
Allows a parser to infer the type of the proxy by its path.
167 |
# File 'lib/yard/code_objects/proxy.rb', line 167 def type=(type) @type = type ? type.to_sym : nil end |