Class: TraceTree::Point

Inherits:
Object
  • Object
show all
Includes:
TreeGraphable, TreeHtmlable
Defined in:
lib/trace_tree/point.rb,
lib/trace_tree/point.rb,
lib/trace_tree/point/omit.rb,
lib/trace_tree/point/common.rb,
lib/trace_tree/point/threadend.rb,
lib/trace_tree/point/threadbegin.rb,
lib/trace_tree/point/ccall_kernel_raise.rb,
lib/trace_tree/point/ccall_kernel_extend.rb,
lib/trace_tree/point/ccall_module_include.rb,
lib/trace_tree/point/ccall_module_prepend.rb,
lib/trace_tree/point/ccall_classthread_new.rb,
lib/trace_tree/point/ccall_thread_initialize.rb,
lib/trace_tree/point/creturn_classthread_new.rb,
lib/trace_tree/point/ccall_module_extendobject.rb,
lib/trace_tree/point/creturn_thread_initialize.rb,
lib/trace_tree/point/ccall_module_appendfeatures.rb,
lib/trace_tree/point/creturn_module_extendobject.rb,
lib/trace_tree/point/ccall_module_prependfeatures.rb,
lib/trace_tree/point/creturn_module_appendfeatures.rb,
lib/trace_tree/point/call_modulemutexm_extendobject.rb,
lib/trace_tree/point/creturn_module_prependfeatures.rb,
lib/trace_tree/point/call_activesupportconcern_appendfeatures.rb

Defined Under Namespace

Classes: CallActivesupportconcernAppendfeatures, CallModuleMutexmExtendobject, CcallClassthreadNew, CcallKernelExtend, CcallKernelRaise, CcallModuleAppendfeatures, CcallModuleExtendobject, CcallModuleInclude, CcallModulePrepend, CcallModulePrependfeatures, CcallThreadInitialize, Common, CreturnClassthreadNew, CreturnModuleAppendfeatures, CreturnModuleExtendobject, CreturnModulePrependfeatures, CreturnThreadInitialize, Loader, Omitted, Threadbegin, Threadend

Constant Summary collapse

Interfaces = 
[:event, :defined_class, :method_id, :path, :lineno]
NativeThreadCall = 
[CcallClassthreadNew,
CreturnClassthreadNew,
CcallThreadInitialize,
CreturnThreadInitialize,
Threadbegin,
Threadend]

Constants included from TreeHtmlable

TreeHtmlable::DEFAULT_JS

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from TreeHtmlable

#body_js_for_tree_html, #children_for_tree_html, #css_for_tree_html, #data_for_tree_html, #label_for_tree_html

Methods included from TreeGraphable

#children_for_tree_graph, #label_for_tree_graph

Constructor Details

#initialize(trace_point) ⇒ Point

Returns a new instance of Point.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/trace_tree/point.rb', line 74

def initialize trace_point
  Interfaces.each do |i|
    instance_variable_set "@#{i}", trace_point.send(i)
  end

  @return_value = trace_point.return_value if x_return?

  if thread?
    @thread = trace_point.self
  else
    there = trace_point.binding.of_caller(3)
    @current = BindingOfCallers::Revealed.new there
    @frame_env = current.frame_env.to_sym
    @thread = current.send(:eval, 'Thread.current')
  end
rescue => e
  puts e
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method_id, *args, &blk) ⇒ Object

Raises:

  • (NoMethodError) 


69
70
71
72
 
# File 'lib/trace_tree/point.rb', line 69

def method_missing method_id, *args, &blk
  raise NoMethodError, "NoMethodError: undefined method `#{method_id}' "\
    "for #<#{self.class.proto or self.class.name}#{inspect}>"
end

Class Attribute Details

.proto ⇒ Object (readonly)

Returns the value of attribute proto.



53
54
55
 
# File 'lib/trace_tree/point.rb', line 53

def proto
  @proto
end

Instance Attribute Details

#config ⇒ Object

Returns the value of attribute config.



11
12
13
 
# File 'lib/trace_tree/point.rb', line 11

def config
  @config
end

#current ⇒ Object (readonly)

Returns the value of attribute current.



10
11
12
 
# File 'lib/trace_tree/point.rb', line 10

def current
  @current
end

#frame_env ⇒ Object (readonly)

Returns the value of attribute frame_env.



10
11
12
 
# File 'lib/trace_tree/point.rb', line 10

def frame_env
  @frame_env
end

#terminal ⇒ Object

Returns the value of attribute terminal.



11
12
13
 
# File 'lib/trace_tree/point.rb', line 11

def terminal
  @terminal
end

#thread ⇒ Object (readonly)

Returns the value of attribute thread.



10
11
12
 
# File 'lib/trace_tree/point.rb', line 10

def thread
  @thread
end

Class Method Details

.bases ⇒ Object 



25
26
27
 
# File 'lib/trace_tree/point.rb', line 25

def bases
  @bases ||= []
end

.cache_event_class_method! ⇒ Object 



55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/trace_tree/point.rb', line 55

def cache_event_class_method!
  bases.each do |base|
    base.class_eval "      class << self\n        alias_method :_event_class_method, :event_class_method\n        def self.event_class_method\n          @ecm ||= _event_class_method.freeze\n        end\n      end\n"
  end
end

.class_of?(point) ⇒ Boolean

Returns:

  • (Boolean) 


42
43
44
45
 
# File 'lib/trace_tree/point.rb', line 42

def class_of? point
  e, c, m = event_class_method
  point.method_id == m && point.event == e && point.defined_class == c
end

.classes ⇒ Object 



21
22
23
 
# File 'lib/trace_tree/point.rb', line 21

def classes
  @classes ||= bases.each_with_object(Hash.new{|h| h[:common]}){|c, h| h[c.event_class_method] = c}
end

.hashify(point) ⇒ Object 



29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/trace_tree/point.rb', line 29

def hashify point
  h = {}
  h[:event] = point.event
  h[:defined_class] = point.defined_class
  h[:method_id] = point.method_id
  h[:frame_env] = point.frame_env unless point.thread?
  h[:path] = point.path
  h[:lineno] = point.lineno
  h[:thread] = point.thread
  h[:return_value] = point.return_value if point.event =~ /return/
  h
end

.inherited(base) ⇒ Object 



17
18
19
 
# File 'lib/trace_tree/point.rb', line 17

def inherited base
  bases << base
end

.initialize_clone(proto) ⇒ Object 



47
48
49
50
51
 
# File 'lib/trace_tree/point.rb', line 47

def initialize_clone proto
  super.tap do
    instance_variable_set :@proto, proto
  end
end

Instance Method Details

#<<(node) ⇒ Object 



151
152
153
 
# File 'lib/trace_tree/point.rb', line 151

def << node
  callees << node
end

#_class_and_method ⇒ Object 



163
164
165
 
# File 'lib/trace_tree/point.rb', line 163

def _class_and_method
  @km ||= "#{class_name}#{call_symbol}#{method_name}"
end

#arg ⇒ Object 



187
188
189
 
# File 'lib/trace_tree/point.rb', line 187

def arg
  respond_to?(:parameters) ? "(#{parameters})" : nil
end

#arguments ⇒ Object 



120
121
122
123
124
125
126
127
 
# File 'lib/trace_tree/point.rb', line 120

def arguments
  {}.tap do |args|
    if event == :call
      defined_class.instance_method(method_id).parameters.
        each{ |role, name| args[name] = current.lv(name) unless name.nil? && role == :rest }
    end
  end
end

#b_call? ⇒ Boolean

Returns:

  • (Boolean) 


93
94
95
 
# File 'lib/trace_tree/point.rb', line 93

def b_call?
  event == :b_call
end

#c_call? ⇒ Boolean

Returns:

  • (Boolean) 


97
98
99
 
# File 'lib/trace_tree/point.rb', line 97

def c_call?
  event == :c_call
end

#call_symbol ⇒ Object 



179
180
181
 
# File 'lib/trace_tree/point.rb', line 179

def call_symbol
  c_call? ? '#' : current.call_symbol
end

#callees ⇒ Object 



155
156
157
 
# File 'lib/trace_tree/point.rb', line 155

def callees
  @callees ||= []
end

#class? ⇒ Boolean

Returns:

  • (Boolean) 


101
102
103
 
# File 'lib/trace_tree/point.rb', line 101

def class?
  event == :class
end

#class_and_method ⇒ Object 



159
160
161
 
# File 'lib/trace_tree/point.rb', line 159

def class_and_method
  "#{_class_and_method}#{arg}"
end

#class_name ⇒ Object 



167
168
169
170
171
 
# File 'lib/trace_tree/point.rb', line 167

def class_name
  c_call? ? defined_class : current.klass
rescue => e
  puts event
end

#end_of_trace? ⇒ Boolean

Returns:

  • (Boolean) 


113
114
115
116
117
118
 
# File 'lib/trace_tree/point.rb', line 113

def end_of_trace?
  MainFile == path && (
    (:c_return == event && :instance_eval == method_id) ||
      (:c_call == event && :disable == method_id)
  )
end

#inspect ⇒ Object 



133
134
135
 
# File 'lib/trace_tree/point.rb', line 133

def inspect
  to_h.inspect
end

#method_defined_by_define_method? ⇒ Boolean

Returns:

  • (Boolean) 


236
237
238
239
 
# File 'lib/trace_tree/point.rb', line 236

def method_defined_by_define_method?
  (event == :call || event == :return) &&
    method_id != frame_env
end

#method_name ⇒ Object 



173
174
175
176
177
 
# File 'lib/trace_tree/point.rb', line 173

def method_name
  return method_id if c_call?
  return frame_env if b_call? || class?
  (method_id == frame_env) ? method_id : "#{method_id} -> #{frame_env}"
end

#return_value ⇒ Object 



129
130
131
 
# File 'lib/trace_tree/point.rb', line 129

def return_value
  x_return? ? @return_value : (terminal.nil? ? nil : terminal.return_value)
end

#source_location ⇒ Object 



183
184
185
 
# File 'lib/trace_tree/point.rb', line 183

def source_location
  "#{path}:#{lineno}"
end

#terminate?(point) ⇒ Boolean

Returns:

  • (Boolean) 


141
142
143
144
145
146
147
148
149
 
# File 'lib/trace_tree/point.rb', line 141

def terminate? point
  (point.defined_class == defined_class && point.method_id == method_id) && (
    (event == :return && point.event == :call) ||
    (event == :b_return && point.event == :b_call) ||
    (event == :c_return && point.event == :c_call) ||
    (event == :end && point.event == :class) ||
    (event == :thread_end && point.event == :thread_begin)
  )
end

#thread? ⇒ Boolean

Returns:

  • (Boolean) 


109
110
111
 
# File 'lib/trace_tree/point.rb', line 109

def thread?
  event =~ /thread/
end

#thread_relative? ⇒ Boolean

Returns:

  • (Boolean) 


231
232
233
234
 
# File 'lib/trace_tree/point.rb', line 231

def thread_relative?
  NativeThreadCall.any?{ |k| k.class_of? self } ||
    Thread == defined_class
end

#to_h ⇒ Object 



137
138
139
 
# File 'lib/trace_tree/point.rb', line 137

def to_h
  self.class.hashify(self)
end

#x_return? ⇒ Boolean

Returns:

  • (Boolean) 


105
106
107
 
# File 'lib/trace_tree/point.rb', line 105

def x_return?
  event =~ /return/
end