Module: ObjectTracker

Defined in:
lib/object_tracker.rb,
lib/object_tracker/version.rb

Defined Under Namespace

Modules: Inspector Classes: UntrackableMethod

Constant Summary collapse

VERSION = 
'1.2.0'.freeze

Instance Method Summary collapse

Instance Method Details

#cleanse(str) ⇒ Object

PRIVATE



46
47
48
 
# File 'lib/object_tracker.rb', line 46

def cleanse(str)
  str.to_s.sub(/^\w*[#.]/, '')
end

#track(*args) ⇒ Object 



5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/object_tracker.rb', line 5

def track(*args)
  args.each do |method_name|
    next if tracking?(method_name) || track_reserved_methods.include?(method_name)
    if respond_to?(method_name)
      track!(method_name => track_with_source(self, method_name))
    elsif respond_to?(:allocate)
      inst = allocate
      if inst.respond_to?(method_name)
        track!(method_name => track_with_source(inst, method_name))
      else
        fail UntrackableMethod, method_name
      end
    else
      fail UntrackableMethod, method_name
    end
  end
  nil
end

#track!(method_names = nil) ⇒ Object 



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/object_tracker.rb', line 50

def track!(method_names = nil)
  mod = Module.new
  Array(method_names || tracking).each do |method_name, source_def|
    mod.module_eval "      def \#{cleanse(method_name)}(*args)\n        msg = %Q(   * called \"\#{method_name}\" )\n        msg << \"with \" << args.join(', ') << \" \" if args.any?\n        msg << \"[\#{source_def}]\"\n        result = nil\n        bm = Benchmark.measure { result = super }\n        msg << \" (%.5f)\" % bm.real\n        puts msg\n        @__tracked_calls ||= Set.new\n        @__tracked_calls << \"\#{method_name}\"\n        result\n      rescue NoMethodError => e\n        raise e if e.message !~ /no superclass/\n      end\n    RUBY\n  end\n\n  mod.module_eval <<-RUBY, __FILE__, __LINE__\n    def self.prepended(base)\n      base.extend(self)\n    end\n  RUBY\n\n  # Handle both instance and class level extension\n  if Class === self\n    prepend(Inspector)\n    prepend(mod)\n  else\n    extend(Inspector)\n    extend(mod)\n  end\nend\n", __FILE__, __LINE__

#track_all!(*args) ⇒ Object 



35
36
37
38
39
40
 
# File 'lib/object_tracker.rb', line 35

def track_all!(*args)
  track_not *args if args.any?
  track_methods_for(self)
  track_methods_for(allocate) if respond_to?(:allocate)
  track!
end

#track_methods_for(obj) ⇒ Object 



87
88
89
90
91
 
# File 'lib/object_tracker.rb', line 87

def track_methods_for(obj)
  (obj.methods - track_reserved_methods).each do |method_name|
    track_with_source(obj, method_name)
  end
end

#track_not(*args) ⇒ Object 



28
29
30
31
32
33
 
# File 'lib/object_tracker.rb', line 28

def track_not(*args)
  args.each do |method_name|
    track_reserved_methods << method_name unless track_reserved_methods.include?(method_name)
  end
  nil
end

#track_reserved_methods ⇒ Object 



112
113
114
115
116
117
118
 
# File 'lib/object_tracker.rb', line 112

def track_reserved_methods
  @__reserved_methods ||= begin
    names = [:__send__, :object_id]
    names.concat [:default_scope, :base_class, :superclass, :<, :current_scope=] if defined?(Rails)
    names
  end
end

#track_with_source(obj, method_name) ⇒ Object 



93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/object_tracker.rb', line 93

def track_with_source(obj, method_name)
  source = obj.method(method_name).source_location || ['RUBY CORE']
  if Class === obj || Module === obj
    name = obj.name
    prefix = '.'
  elsif obj.class === Class
    prefix = '.'
    name = obj.class.name
  else
    prefix = '#'
    name = obj.class.name
  end
  tracking["#{name}#{prefix}#{method_name}".to_sym] = source.join(':').split('/').last(5).join('/')
end

#tracking ⇒ Object 



108
109
110
 
# File 'lib/object_tracker.rb', line 108

def tracking
  @__tracking ||= {}
end

#tracking?(method_name) ⇒ Boolean

Returns:

  • (Boolean) 


24
25
26
 
# File 'lib/object_tracker.rb', line 24

def tracking?(method_name)
  tracking.keys.include?(cleanse(method_name).to_sym)
end