Class: Rcov::CallSiteAnalyzer
- Inherits:
-
DifferentialAnalyzer
- Object
- DifferentialAnalyzer
- Rcov::CallSiteAnalyzer
- Defined in:
- lib/rcov.rb
Overview
A CallSiteAnalyzer can be used to obtain information about:
-
where a method is defined (“
defsite
”) -
where a method was called from (“
callsite
”)
Example
example.rb
:
class X
def f1; f2 end
def f2; 1 + 1 end
def f3; f1 end
end
analyzer = Rcov::CallSiteAnalyzer.new
x = X.new
analyzer.run_hooked do
x.f1
end
# ....
analyzer.run_hooked do
x.f3
# the information generated in this run is aggregated
# to the previously recorded one
end
analyzer.analyzed_classes # => ["X", ... ]
analyzer.methods_for_class("X") # => ["f1", "f2", "f3"]
analyzer.defsite("X#f1") # => DefSite object
analyzer.callsites("X#f2") # => hash with CallSite => count
# associations
defsite = analyzer.defsite("X#f1")
defsite.file # => "example.rb"
defsite.line # => 2
You can have several CallSiteAnalyzer objects at a time, and it is possible to nest the #run_hooked / #install_hook/#remove_hook blocks: each analyzer will manage its data separately. Note however that no special provision is taken to ignore code executed “inside” the CallSiteAnalyzer class.
defsite
information is only available for methods that were called under the inspection of the CallSiteAnalyzer, i.o.w. you will only have defsite
information for those methods for which callsite information is available.
Defined Under Namespace
Class Method Summary collapse
-
.hook_level ⇒ Object
defined this way instead of attr_accessor so that it’s covered.
-
.hook_level=(x) ⇒ Object
:nodoc:.
Instance Method Summary collapse
-
#analyzed_classes ⇒ Object
Classes whose methods have been called.
-
#callsites(classname_or_fullname, methodname = nil) ⇒ Object
Returns a hash with
CallSite => call count
associations ornil
Can be called in two ways: analyzer.callsites(“Foo#f1”) # instance method analyzer.callsites(“Foo.g1”) # singleton method of the class or analyzer.callsites(“Foo”, “f1”) analyzer.callsites(“#<class:Foo>”, “g1”). -
#defsite(classname_or_fullname, methodname = nil) ⇒ Object
Returns a DefSite object corresponding to the given method Can be called in two ways: analyzer.defsite(“Foo#f1”) # instance method analyzer.defsite(“Foo.g1”) # singleton method of the class or analyzer.defsite(“Foo”, “f1”) analyzer.defsite(“#<class:Foo>”, “g1”).
-
#initialize ⇒ CallSiteAnalyzer
constructor
A new instance of CallSiteAnalyzer.
-
#methods_for_class(classname) ⇒ Object
(also: #analyzed_methods)
Methods that were called for the given class.
Methods inherited from DifferentialAnalyzer
#install_hook, #remove_hook, #reset, #run_hooked
Constructor Details
#initialize ⇒ CallSiteAnalyzer
Returns a new instance of CallSiteAnalyzer.
862 863 864 865 |
# File 'lib/rcov.rb', line 862 def initialize super(:install_callsite_hook, :remove_callsite_hook, :reset_callsite) end |
Class Method Details
.hook_level ⇒ Object
defined this way instead of attr_accessor so that it’s covered
855 856 857 |
# File 'lib/rcov.rb', line 855 def self.hook_level # :nodoc: @hook_level end |
.hook_level=(x) ⇒ Object
:nodoc:
858 859 860 |
# File 'lib/rcov.rb', line 858 def self.hook_level=(x) # :nodoc: @hook_level = x end |
Instance Method Details
#analyzed_classes ⇒ Object
Classes whose methods have been called. Returns an array of strings describing the classes (just klass.to_s for each of them). Singleton classes are rendered as:
#<Class:MyNamespace::MyClass>
871 872 873 |
# File 'lib/rcov.rb', line 871 def analyzed_classes raw_data_relative.first.keys.map{|klass, meth| klass}.uniq.sort end |
#callsites(classname_or_fullname, methodname = nil) ⇒ Object
Returns a hash with CallSite => call count
associations or nil
Can be called in two ways:
analyzer.callsites("Foo#f1") # instance method
analyzer.callsites("Foo.g1") # singleton method of the class
or
analyzer.callsites("Foo", "f1")
analyzer.callsites("#<class:Foo>", "g1")
891 892 893 894 895 896 897 898 899 900 |
# File 'lib/rcov.rb', line 891 def callsites(classname_or_fullname, methodname = nil) rawsites = raw_data_relative.first[(classname_or_fullname, methodname)] return nil unless rawsites ret = {} # could be a job for inject but it's slow and I don't mind the extra loc rawsites.each_pair do |backtrace, count| ret[CallSite.new(backtrace)] = count end ret end |
#defsite(classname_or_fullname, methodname = nil) ⇒ Object
Returns a DefSite object corresponding to the given method Can be called in two ways:
analyzer.defsite("Foo#f1") # instance method
analyzer.defsite("Foo.g1") # singleton method of the class
or
analyzer.defsite("Foo", "f1")
analyzer.defsite("#<class:Foo>", "g1")
909 910 911 912 913 |
# File 'lib/rcov.rb', line 909 def defsite(classname_or_fullname, methodname = nil) file, line = raw_data_relative[1][(classname_or_fullname, methodname)] return nil unless file && line DefSite.new(file, line) end |
#methods_for_class(classname) ⇒ Object Also known as: analyzed_methods
Methods that were called for the given class. See #analyzed_classes for the notation used for singleton classes. Returns an array of strings or nil
878 879 880 881 |
# File 'lib/rcov.rb', line 878 def methods_for_class(classname) a = raw_data_relative.first.keys.select{|kl,_| kl == classname}.map{|_,meth| meth}.sort a.empty? ? nil : a end |