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/rails/sql_handler.rb,
lib/appmap/rails/action_handler.rb,
lib/appmap/algorithm/prune_class_map.rb,
lib/appmap/middleware/remote_recording.rb

Defined Under Namespace

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

Constant Summary collapse

URL = 
'https://github.com/applandinc/appmap-ruby'
VERSION = 
'0.33.0'
APPMAP_FORMAT_VERSION = 
'1.2'

Class Method Summary collapse

Class Method Details

.class_map(methods) ⇒ Object

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



83
84
85
 
# File 'lib/appmap.rb', line 83

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

.configuration ⇒ Object

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



26
27
28
 
# File 'lib/appmap.rb', line 26

def configuration
  @configuration ||= initialize
end

.configuration=(config) ⇒ Object

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



32
33
34
35
36
 
# File 'lib/appmap.rb', line 32

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

  @configuration = config
end

.detect_metadata ⇒ Object

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



89
90
91
92
 
# File 'lib/appmap.rb', line 89

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

.initialize(config_file_path = 'appmap.yml') ⇒ Object

Configures AppMap for recording. Default behavior is to configure from “appmap.yml”. 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.



42
43
44
45
46
47
48
 
# File 'lib/appmap.rb', line 42

def initialize(config_file_path = 'appmap.yml')
  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.



77
78
79
80
 
# File 'lib/appmap.rb', line 77

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.



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/appmap.rb', line 57

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.



51
52
53
 
# File 'lib/appmap.rb', line 51

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