Module: AppMap

Defined in:
lib/appmap.rb,
lib/appmap/hook.rb,
lib/appmap/open.rb,
lib/appmap/util.rb,
lib/appmap/event.rb,
lib/appmap/rspec.rb,
lib/appmap/trace.rb,
lib/appmap/config.rb,
lib/appmap/railtie.rb,
lib/appmap/version.rb,
lib/appmap/cucumber.rb,
lib/appmap/metadata.rb,
lib/appmap/minitest.rb,
lib/appmap/class_map.rb,
lib/appmap/hook/method.rb,
lib/appmap/command/stats.rb,
lib/appmap/command/record.rb,
lib/appmap/algorithm/stats.rb,
lib/appmap/handler/function.rb,
lib/appmap/handler/net_http.rb,
lib/appmap/handler/rails/template.rb,
lib/appmap/algorithm/prune_class_map.rb,
lib/appmap/handler/rails/sql_handler.rb,
lib/appmap/middleware/remote_recording.rb,
lib/appmap/handler/rails/request_handler.rb,
ext/appmap/appmap.c

Defined Under Namespace

Modules: Algorithm, Command, Cucumber, Event, Handler, Metadata, Middleware, Minitest, RSpec, Trace, Util Classes: ClassMap, Config, Hook, Open, OpenStruct, Railtie, Tracer

Constant Summary collapse

URL = 
'https://github.com/applandinc/appmap-ruby'
VERSION = 
'0.51.1'
APPMAP_FORMAT_VERSION = 
'1.5.1'
DEFAULT_APPMAP_DIR = 
'tmp/appmap'.freeze

Class Method Summary collapse

Class Method Details

.class_map(methods) ⇒ Object

Builds a class map from a config and a list of Ruby methods.



102
103
104
 
# File 'lib/appmap.rb', line 102

def class_map(methods)
  ClassMap.build_from_methods(methods)
end

.configuration ⇒ Object

Gets the configuration. If there is no configuration, the default configuration is initialized.



29
30
31
 
# File 'lib/appmap.rb', line 29

def configuration
  @configuration ||= initialize_configuration
end

.configuration=(config) ⇒ Object

Sets the configuration. This is only expected to happen once per Ruby process.



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

def configuration=(config)
  warn 'AppMap is already configured' if @configuration && config

  @configuration = config
end

.default_config_file_path ⇒ Object 



41
42
43
 
# File 'lib/appmap.rb', line 41

def default_config_file_path
  ENV['APPMAP_CONFIG_FILE'] || 'appmap.yml'
end

.detect_metadata ⇒ Object

Returns default metadata detected from the Ruby system and from the filesystem.



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

def detect_metadata
  @metadata ||= Metadata.detect.freeze
  @metadata.deep_dup
end

.info(msg) ⇒ Object 



61
62
63
64
65
66
67
 
# File 'lib/appmap.rb', line 61

def info(msg)
  if defined?(::Rails) && defined?(::Rails.logger)
    ::Rails.logger.info msg
  else
    warn msg
  end
end

.initialize_configuration(config_file_path = default_config_file_path) ⇒ Object

Configures AppMap for recording. Default behavior is to configure from APPMAP_CONFIG_FILE, or ‘appmap.yml’. If no config file is available, a configuration will be automatically generated and used - and the user is prompted to create the config file.

This method also activates the code hooks which record function calls as trace events. Call this function before the program code is loaded by the Ruby VM, otherwise the load events won’t be seen and the hooks won’t activate.



53
54
55
56
57
58
59
 
# File 'lib/appmap.rb', line 53

def initialize_configuration(config_file_path = default_config_file_path)
  warn "Configuring AppMap from path #{config_file_path}"
  Config.load_from_file(config_file_path).tap do |configuration|
    self.configuration = configuration
    Hook.new(configuration).enable
  end
end

.open(appmap = nil, &block) ⇒ Object

Uploads an AppMap to the AppLand website and displays it.



96
97
98
99
 
# File 'lib/appmap.rb', line 96

def open(appmap = nil, &block)
  appmap ||= AppMap.record(&block)
  AppMap::Open.new(appmap).perform
end

.record ⇒ Object

Records the events which occur while processing a block, and returns an AppMap as a Hash.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/appmap.rb', line 76

def record
  tracer = tracing.trace
  begin
    yield
  ensure
    tracing.delete(tracer)
  end

  events = [].tap do |event_list|
    event_list << tracer.next_event.to_h while tracer.event?
  end
  {
    'version' => AppMap::APPMAP_FORMAT_VERSION,
    'metadata' => detect_metadata,
    'classMap' => class_map(tracer.event_methods),
    'events' => events
  }
end

.tracing ⇒ Object

Used to start tracing, stop tracing, and record events.



70
71
72
 
# File 'lib/appmap.rb', line 70

def tracing
  @tracing ||= Trace::Tracing.new
end