Class: ORI::ListMethod

20
21
22
23
24

# File 'lib/ori/list_method.rb', line 20

def access
  # NOTE: It is *WRONG* to rely on Ruby's `inspect` to handle things because
  #       it doesn't work for cases when singleton methods are included from modules.
  @cache[:access] ||= (module? and not inspector.match /instance/) ? "::" : "#"
end

228
229
230

# File 'lib/ori/list_method.rb', line 228

def eql?(other)
  hash == other.hash
end

137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154

# File 'lib/ori/list_method.rb', line 137

def format(options = {})
  options = options.dup
  o = {}
  o[k = :color] = (v = options.delete(k)).nil?? true : v
  raise ArgumentError, "Unknown option(s): #{options.inspect}" if not options.empty?

  require_valid

  Colorize.colorize *[
    (own?? [[:list_method, :own_marker], OWN_MARKER[0]] : [[:list_method, :not_own_marker], OWN_MARKER[1]]),
    [[:list_method, :obj_module_name], obj_module_name],
    ([[:list_method, :owner_name], "(#{owner_name})"] if not own?),
    [[:list_method, :access], access],
    [[:list_method, :name], method_name],
    ([[:list_method, :visibility], " [#{visibility}]"] if not public?),
    [[:reset]],
  ].compact.flatten(1).reject {|v| v.is_a? Array and not o[:color]}
end

157
158
159

# File 'lib/ori/list_method.rb', line 157

def fullmatch(re)
  format(:color => false).match(re)
end

223
224
225

# File 'lib/ori/list_method.rb', line 223

def hash
  @cache[:hash] ||= qformat.hash
end

31
32
33

# File 'lib/ori/list_method.rb', line 31

def instance?
  access == "#"
end

162
163
164

# File 'lib/ori/list_method.rb', line 162

def match(re)
  @method_name.match(re)
end

41
42
43
44
45
46
47
48
49

# File 'lib/ori/list_method.rb', line 41

def method_object
  require_valid

  @cache[:method_object] ||= if @inspector.match /instance/
    @obj._ori_instance_method(@method_name)
  else
    @obj._ori_method(@method_name)
  end
end

51
52
53
54
55
56

# File 'lib/ori/list_method.rb', line 51

def module?
  @cache[:is_module] ||= begin
    require_obj
    @obj.is_a? Module
  end
end

64
65
66

# File 'lib/ori/list_method.rb', line 64

def obj_module
  @cache[:obj_module] ||= obj.is_a?(Module) ? obj : obj.class
end

68
69
70

# File 'lib/ori/list_method.rb', line 68

def obj_module_name
  @cache[:obj_module_name] ||= Tools.get_module_name(obj_module)
end

78
79
80
81
82
83
84
85
86

# File 'lib/ori/list_method.rb', line 78

def obj_singleton_class
  @cache[:obj_singleton] ||= begin
    class << obj    #:nodoc:
      self
    end
  rescue
    nil
  end
end

89
90
91
92
93
94

# File 'lib/ori/list_method.rb', line 89

def own?
  @cache[:is_own] ||= begin
    require_valid
    owner == obj_module || owner == obj_singleton_class
  end
end

72
73
74

# File 'lib/ori/list_method.rb', line 72

def owner
  @cache[:owner] ||= method_object.owner
end

96
97
98

# File 'lib/ori/list_method.rb', line 96

def owner_name
  @cache[:owner_name] ||= Tools.get_module_name(owner)
end

100
101
102

# File 'lib/ori/list_method.rb', line 100

def private?
  visibility == :private
end

104
105
106

# File 'lib/ori/list_method.rb', line 104

def protected?
  visibility == :protected
end

108
109
110

# File 'lib/ori/list_method.rb', line 108

def public?
  visibility == :public
end

167
168
169
170

# File 'lib/ori/list_method.rb', line 167

def qformat
  #"#{owner_name}#{access}#{@method_name} [#{visibility}]"        # Before multi-obj support.
  "#{obj_module_name}#{access}#{@method_name} [#{visibility}]"
end

172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205

# File 'lib/ori/list_method.rb', line 172

def ri_topics
  @cache[:ri_topics] ||= begin
    require_valid

    # Build "hierarchy methods". Single record is:
    #
    #   ["Kernel", "#", "dup"]
    hmethods = []

    # Always stuff self in front of the line regardless of if we have method or not.
    hmethods << [obj_module_name, access, method_name]

    ancestors = []
    ancestors += obj_module.ancestors
    ancestors += obj_singleton_class.ancestors if obj_singleton_class     # E.g. when module extends class.

    ancestors.each do |mod|
      mav = Tools.get_methods(mod, :inspector_arg => false, :to_mav => true)
      ##p "mav", mav
      found = mav.select {|method_name,| method_name == self.method_name}
      ##p "found", found
      found.each do |method_name, access|
        hmethods << [Tools.get_module_name(mod), access, method_name]
      end
    end

    # Misdoc hack -- stuff Object#meth lookup if Kernel#meth is present. For methods like Kernel#is_a?.
    if (found = hmethods.find {|mod, access| [mod, access] == ["Kernel", "#"]}) and not hmethods.find {|mod,| mod == "Object"}
      hmethods << ["Object", "#", found.last]
    end

    hmethods.uniq
  end
end

112
113
114

# File 'lib/ori/list_method.rb', line 112

def singleton?
  access == "::"
end

207
208
209
210
211
212
213

# File 'lib/ori/list_method.rb', line 207

def valid?
  [
    @obj_present,
    @method_name,
    @inspector,
  ].all?
end

117
118
119
120
121
122
123
124
125
126
127
128
129

# File 'lib/ori/list_method.rb', line 117

def visibility
  @cache[:visibility] ||= begin
    require_valid

    if @inspector.match /private/
      :private
    elsif @inspector.match /protected/
      :protected
    else
      :public
    end
  end
end