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) ⇒ 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) ⇒ 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 |
# File 'lib/yard/code_objects/proxy.rb', line 28 def initialize(namespace, name) 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 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.
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 |
# File 'lib/yard/code_objects/proxy.rb', line 202 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
130 131 132 133 134 135 136 |
# File 'lib/yard/code_objects/proxy.rb', line 130 def <=>(other) if other.respond_to? :path path <=> other.path else false end end |
#===(other) ⇒ Boolean
121 122 123 124 125 126 127 |
# File 'lib/yard/code_objects/proxy.rb', line 121 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
.
154 155 156 157 158 159 160 |
# File 'lib/yard/code_objects/proxy.rb', line 154 def class if obj = to_obj obj.class else Proxy end end |
#equal?(other) ⇒ Boolean Also known as: ==
139 140 141 142 143 144 145 |
# File 'lib/yard/code_objects/proxy.rb', line 139 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).
149 |
# File 'lib/yard/code_objects/proxy.rb', line 149 def hash; path.hash end |
#inspect ⇒ String
Returns a text representation of the Proxy
76 77 78 79 80 81 82 |
# File 'lib/yard/code_objects/proxy.rb', line 76 def inspect if obj = to_obj obj.inspect else "P(#{path})" end end |
#instance_of?(klass) ⇒ Boolean
181 182 183 |
# File 'lib/yard/code_objects/proxy.rb', line 181 def instance_of?(klass) self.class == klass end |
#is_a?(klass) ⇒ Boolean
112 113 114 115 116 117 118 |
# File 'lib/yard/code_objects/proxy.rb', line 112 def is_a?(klass) if obj = to_obj obj.is_a?(klass) else self.class <= klass end end |
#kind_of?(klass) ⇒ Boolean
186 187 188 |
# File 'lib/yard/code_objects/proxy.rb', line 186 def kind_of?(klass) self.class <= klass end |
#name(prefix = false) ⇒ Symbol, String
The name of the object
70 71 72 |
# File 'lib/yard/code_objects/proxy.rb', line 70 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.
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 |
# File 'lib/yard/code_objects/proxy.rb', line 89 def path if obj = to_obj obj.path else if @namespace.root? (@imethod ? ISEP : "") + name.to_s elsif @origname if @origname =~ /^[A-Z]/ @origname else [namespace.path, @origname].join end elsif name.to_s =~ /^[A-Z]/ # const name.to_s else # class meth? [namespace.path, name.to_s].join(CSEP) end end end |
#respond_to?(meth, include_private = false) ⇒ Boolean
191 192 193 194 195 196 197 |
# File 'lib/yard/code_objects/proxy.rb', line 191 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
224 |
# File 'lib/yard/code_objects/proxy.rb', line 224 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
167 168 169 170 171 172 173 |
# File 'lib/yard/code_objects/proxy.rb', line 167 def type if obj = to_obj obj.type else Registry.proxy_types[path] || :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.
178 |
# File 'lib/yard/code_objects/proxy.rb', line 178 def type=(type) Registry.proxy_types[path] = type.to_sym end |