Class: YARD::CodeObjects::Proxy

Inherits:

Object

• Object
• YARD::CodeObjects::Proxy

show all

Defined in:

lib/yard/code_objects/proxy.rb

Overview

# When the String class is parsed this method will
# begin to act like the String ClassObject.
Proxy.new(mymoduleobj, "String")

Instance Attribute Summary (collapse)

• - (Object) name readonly

  Returns the value of attribute name.

• - (Object) namespace (also: #parent) readonly

  Returns the value of attribute namespace.

Class Method Summary (collapse)

• + (Object) ===(other)

Instance Method Summary (collapse)

• - (Boolean) <=>(other)
• - (Boolean) ===(other)
• - (Class) class

  Returns the class name of the object the proxy is mimicking, if resolved.

• - (Boolean) equal?(other) (also: #==)
• - (Integer) hash

  The object's hash value (for equality checking).

• - (Proxy) initialize(namespace, name) constructor

  Creates a new Proxy.

• - (String) inspect

  Returns a text representation of the Proxy.

• - (Boolean) instance_of?(klass)
• - (Boolean) is_a?(klass)
• - (Boolean) kind_of?(klass)
• - (Object) method_missing(meth, *args, &block)

  Dispatches the method to the resolved object.

• - (String) path (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.

• - (Boolean) respond_to?(meth, include_private = false)
• - (Boolean) root?

  This class is never a root object.

• - (Symbol) type

  or :proxy.

• - (void) type=(type)

  Allows a parser to infer the type of the proxy by its path.

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

# 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
  
  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

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

21
22
23

# File 'lib/yard/code_objects/proxy.rb', line 21

def name
  @name
end

21
22
23

# File 'lib/yard/code_objects/proxy.rb', line 21

def namespace
  @namespace
end

19

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

def self.===(other) other.is_a?(self) end

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

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

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

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

138

# File 'lib/yard/code_objects/proxy.rb', line 138

def hash; path.hash end

65
66
67
68
69
70
71

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

def inspect
  if obj = to_obj
    obj.inspect
  else
    "P(#{path})"
  end
end

170
171
172

# File 'lib/yard/code_objects/proxy.rb', line 170

def instance_of?(klass)
  self.class == klass
end

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

175
176
177

# File 'lib/yard/code_objects/proxy.rb', line 175

def kind_of?(klass)
  self.class <= klass
end

78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

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

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

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

213

# File 'lib/yard/code_objects/proxy.rb', line 213

def root?; false end

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
    Registry.proxy_types[path] || :proxy
  end
end

167

# File 'lib/yard/code_objects/proxy.rb', line 167

def type=(type) Registry.proxy_types[path] = type.to_sym end