Class: AppMap::Config::LookupPackage

Inherits:
Struct
  • Object
show all
Defined in:
lib/appmap/config.rb

Overview

Looks up a class and method in the config, to find the matching Package configuration. This class is only used after path_enabled? has returned ‘true`.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#cls ⇒ Object

Returns the value of attribute cls

Returns:

  • (Object) —

    the current value of cls



248
249
250
 
# File 'lib/appmap/config.rb', line 248

def cls
  @cls
end

#config ⇒ Object

Returns the value of attribute config

Returns:

  • (Object) —

    the current value of config



248
249
250
 
# File 'lib/appmap/config.rb', line 248

def config
  @config
end

#method ⇒ Object

Returns the value of attribute method

Returns:

  • (Object) —

    the current value of method



248
249
250
 
# File 'lib/appmap/config.rb', line 248

def method
  @method
end

Instance Method Details

#package ⇒ Object 



249
250
251
252
253
254
 
# File 'lib/appmap/config.rb', line 249

def package
  # Global "excludes" configuration can be used to ignore any class/method.
  return if config.never_hook?(cls, method)

  package_for_code_object || package_for_location
end

#package_for_code_object ⇒ Object

Hook a method which is specified by class and method name.



257
258
259
260
261
262
 
# File 'lib/appmap/config.rb', line 257

def package_for_code_object
  Array(config.hooked_methods[cls.name])
    .compact
    .find { |hook| hook.include_method?(method.name) }
    &.package
end

#package_for_location ⇒ Object

Hook a method which is specified by code location (i.e. path).



265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/appmap/config.rb', line 265

def package_for_location
  location = method.source_location
  location_file, = location
  return unless location_file

  location_file = AppMap::Util.normalize_path(location_file)
  config
    .packages
    .select { |pkg| pkg.path }
    .find do |pkg|
      (location_file.index(pkg.path) == 0) &&
        !pkg.exclude.find { |p| location_file.index(p) }
    end
end