appmap 0.48.1 → 0.51.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 698da91c88a89867584e3d78e10974a4a2f8d726636d60366c214be9e3ddbf97
-  data.tar.gz: eee0b62c442eecc5cf978960128c0b19ff2ebdc393770d8cefc820c82a451d4f
+  metadata.gz: 8a51a7f69ebbca275fd9a215a52cd3e4d8db739e8e6cecf3eb522871f23295b5
+  data.tar.gz: 58f033b5c4f8756532dd3dbe83c631b36560e3215a342f804916de205f53cb56
 SHA512:
-  metadata.gz: 77ae4b055912a7bd6f62f32bb2db7d3684d614453fb82bb7d8f53496181919609ca2af0a65906ca36f1f28aaf28e06c64d6f5e6326b8f384f4c1206c22af559a
-  data.tar.gz: a72831c1908beb0130b4797ea5455b976677caec810edcdf0009b9be609ba6510a59873b66ca4df5406fe8f3e5aea995d8dabc983573517adc67fdf86cad822a
+  metadata.gz: e52a4b23f708892b12c3ca68a2b5e3c13a2c9b1d1b52057ede1548faa7c7d03914296ebb1402c7c1cd1f0540df1d6182ffa09de2cf3558410d499703bc8b352f
+  data.tar.gz: 32201a386bc48ef35395e702a46661f78b12c4b15cab6214203e91e3599537cc53742f5ef2848ecf3d73b3c6c007413b55b4ea22bc4f8c83131733b9b2ace4a3

data/CHANGELOG.md

@@ -1,3 +1,45 @@
+## [0.51.1](https://github.com/applandinc/appmap-ruby/compare/v0.51.0...v0.51.1) (2021-06-21)
+
+
+### Bug Fixes
+
+* Add missing require 'yaml' ([1187a02](https://github.com/applandinc/appmap-ruby/commit/1187a023243caaab8cd48de5cbbddefa361636ad))
+
+# [0.51.0](https://github.com/applandinc/appmap-ruby/compare/v0.50.0...v0.51.0) (2021-06-21)
+
+
+### Features
+
+* Provide default appmap.yml settings ([7fa8159](https://github.com/applandinc/appmap-ruby/commit/7fa8159b5020e35f13379017b44906d671e62e64))
+
+# [0.50.0](https://github.com/applandinc/appmap-ruby/compare/v0.49.0...v0.50.0) (2021-06-17)
+
+
+### Bug Fixes
+
+* Remove appmap configuration in test cases which now occurs automatically ([7391c4c](https://github.com/applandinc/appmap-ruby/commit/7391c4c36ed80f98a6b82ccd43f05de488e7cd2f))
+
+
+### Features
+
+* Direct minitest and rspec startup messages to the Rails log, when available ([15f6444](https://github.com/applandinc/appmap-ruby/commit/15f6444b0fad3ce7d9e91273b6a1116e470c2a89))
+* Enroll railtie, rspec, and minitest helpers automatically ([1709374](https://github.com/applandinc/appmap-ruby/commit/1709374ee7b5183482c55cf4c7386266fa517262))
+* railtie enrolls the app in remote recording ([3a1f8aa](https://github.com/applandinc/appmap-ruby/commit/3a1f8aac1d83c4df04b5da55ed33d418235e348b))
+
+# [0.49.0](https://github.com/applandinc/appmap-ruby/compare/v0.48.2...v0.49.0) (2021-06-16)
+
+
+### Features
+
+* Add refinement to the labels ([6a93396](https://github.com/applandinc/appmap-ruby/commit/6a93396ba73f1b3ed21b4e9e15a2c271af04d866))
+
+## [0.48.2](https://github.com/applandinc/appmap-ruby/compare/v0.48.1...v0.48.2) (2021-05-26)
+
+
+### Bug Fixes
+
+* Correct the method-hooking logic to capture some missing model methods ([be529bd](https://github.com/applandinc/appmap-ruby/commit/be529bdce7d4fdf9f1a2fdd32259d792f29f4f13))
+
 ## [0.48.1](https://github.com/applandinc/appmap-ruby/compare/v0.48.0...v0.48.1) (2021-05-25)
 
 

data/README.md

@@ -1,17 +1,6 @@
 
 - [About](#about)
-    - [Supported versions](#supported-versions)
-- [Installation](#installation)
-- [Configuration](#configuration)
-- [Labels](#labels)
-- [Running](#running)
-  - [RSpec](#rspec)
-  - [Minitest](#minitest)
-  - [Cucumber](#cucumber)
-  - [Remote recording](#remote-recording)
-- [AppMap for VSCode](#appmap-for-vscode)
-- [AppMap Swagger](#appmap-swagger)
-- [Uploading AppMaps](#uploading-appmaps)
+- [Usage](#usage)
 - [Development](#development)
   - [Internal architecture](#internal-architecture)
   - [Running tests](#running-tests)
@@ -19,7 +8,6 @@
     - [`test/fixtures`](#testfixtures)
     - [`spec/fixtures`](#specfixtures)
 
-
 # About
 
 `appmap-ruby` is a Ruby Gem for recording
@@ -29,326 +17,9 @@
 SHA, labels, etc). It's more granular than a performance profile, but it's less
 granular than a full debug trace. It's designed to be optimal for understanding the design intent and structure of code and key data flows.
 
-There are several ways to record AppMaps of your Ruby program using the `appmap` gem:
-
-* Run your tests (RSpec, Minitest, Cucumber) with the environment variable `APPMAP=true`. An AppMap will be generated for each spec.
-* Run your application server with AppMap remote recording enabled, and use the [AppLand
-  browser extension](https://github.com/applandinc/appland-browser-extension) to start,
-  stop, and upload recordings.
-* Wrap some code in an `AppMap.record` block, which returns JSON containing the code execution trace.
-
-Once you have made a recording, there are two ways to view automatically generated diagrams of the AppMaps.
-
-The first option is to load the diagrams directly in your IDE, using the [AppMap extension for VSCode](https://marketplace.visualstudio.com/items?itemName=appland.appmap).
-
-The second option is to upload them to the [AppLand server](https://app.land) using the [AppLand CLI](https://github.com/applandinc/appland-cli/releases).
-
-### Supported versions
-
-* Ruby 2.5, 2.6, 2.7
-* Rails 5, 6
-
-Support for new versions is added frequently, please check back regularly for updates.
-
-# Installation
-
-<a href="https://www.loom.com/share/78ab32a312ff4b85aa8827a37f1cb655"> <p>Quick and easy setup of the AppMap gem for Rails - Watch Video</p> <img style="max-width:300px;" src="https://cdn.loom.com/sessions/thumbnails/78ab32a312ff4b85aa8827a37f1cb655-with-play.gif"> </a>
-
-
-Add `gem 'appmap'` to **beginning** of your Gemfile. We recommend that you add the `appmap` gem to the `:development, :test` group. Your Gemfile should look something like this:
-
-```
-source 'https://rubygems.org'
-git_source(:github) { |repo| "https://github.com/#{repo}.git" }
-
-# Optional rubRuby version
-# ruby '2.7.2'
-
-group :development, :test do
-  gem 'appmap'
-end
-```
-
-Install with `bundle install`, as usual.
-
-It's important to add the `appmap` gem before any other gems that you may want to instrument. There is more about this in the section on adding gems to the *appmap.yml*.
-
-**Railtie**
-
-If you are using Ruby on Rails, require the railtie after Rails is loaded. 
-
-```
-# application.rb is a good place to do this, along with all the other railties.
-# Don't require the railtie in environments that don't bundle the appmap gem.
-require 'appmap/railtie' if defined?(AppMap).
-```
-
-# Configuration
-
-When you run your program, the `appmap` gem reads configuration settings from `appmap.yml`. Here's a sample configuration
-file for a typical Rails project:
-
-```yaml
-# 'name' should generally be the same as the code repo name.
-name: my_project
-packages:
-- path: app/controllers
-- path: app/models
-  # Exclude sub-paths within the package path
-  exclude:
-  - concerns/accessor
-- path: app/jobs
-- path: app/helpers
-# Include the gems that you want to see in the dependency maps.
-# These are just examples.
-- gem: activerecord
-- gem: devise
-- gem: aws-sdk
-- gem: will_paginate
-# Global exclusion of a class name
-exclude:
-- MyClass
-- MyClass#my_instance_method
-- MyClass.my_class_method
-functions:
-- packages: myapp
-  class: ControllerHelper
-  function: logged_in_user
-  labels: [ authentication ]
-```
-
-* **name** Provides the project name (required)
-* **packages** A list of source code directories which should be recorded.
-* **exclude** A list of classes and/or methods to definitively exclude from recording.
-* **functions** A list of specific functions, scoped by package and class, to record.
-
-**packages**
-
-Each entry in the `packages` list is a YAML object which has the following keys:
-
-* **path** The path to the source code directory. The path may be relative to the current working directory, or it may
-  be an absolute path.
-* **gem** As an alternative to specifying the path, specify the name of a dependency gem. When using `gem`, don't specify `path`. In your `Gemfile`, the `appmap` gem **must** be listed **before** any gem that you specify in your *appmap.yml*.
-* **exclude** A list of files and directories which will be ignored. By default, all modules, classes and public
-  functions are inspected. See also: global `exclude` list.
-* **shallow** When set to `true`, only the first function call entry into a package will be recorded. Subsequent function calls within 
-  the same package are not recorded unless code execution leaves the package and re-enters it. Default: `true` when using `gem`,
-  `false` when using `path`.
-
-**exclude**
-
-Optional list of fully qualified class and method names. Separate class and method names with period (`.`) for class methods and hash (`#`) for instance methods.
-
-**functions**
-
-Optional list of `class, function` pairs. The `package` name is used to place the function within the class map, and does not have to match
-the folder or gem name. The primary use of `functions` is to apply specific labels to functions whose source code is not accessible (e.g., it's in a Gem).
-For functions which are part of the application code, use `@label` or `@labels` in code comments to apply labels.
-
-# Labels
-
-The [AppMap data format](https://github.com/applandinc/appmap) provides for class and function `labels`, which can be used to enhance the AppMap visualizations, and to programatically analyze the data.
-
-You can apply function labels using source code comments in your Ruby code. To apply a labels to a function, add a `@label` or `@labels` line to the comment which immediately precedes a function.
-
-For example, if you add this comment to your source code:
-
-```ruby
-class ApiKey
-  # @labels provider.authentication security
-  def authenticate(key)
-    # logic to verify the key here...
-  end
-end
-```
-
-Then the AppMap metadata section for this function will include:
-
-```json
-  {
-    "name": "authenticate",
-    "type": "function",
-    "labels": [ "provider.authentication", "security" ]
-  }
-```
-
-
-# Running
-
-## RSpec
-
-To record RSpec tests, follow these additional steps:
-
-1) Require `appmap/rspec` in your `spec_helper.rb` before any other classes are loaded.
-
-```ruby
-require 'appmap/rspec'
-```
-
-Note that `spec_helper.rb` in a Rails project typically loads the application's classes this way:
-
-```ruby
-require File.expand_path("../../config/environment", __FILE__)
-```
-
-and `appmap/rspec` must be required before this:
-
-```ruby
-require 'appmap/rspec'
-require File.expand_path("../../config/environment", __FILE__)
-```
-
-2) Run the tests with the environment variable `APPMAP=true`:
-
-```sh-session
-$ APPMAP=true bundle exec rspec
-```
-
-Each RSpec test will output an AppMap file into the directory `tmp/appmap/rspec`. For example:
-
-```
-$ find tmp/appmap/rspec
-Hello_says_hello_when_prompted.appmap.json
-```
-
-## Minitest
-
-To record Minitest tests, follow these additional steps:
-
-1) Require `appmap/minitest` in `test_helper.rb`
-
-```ruby
-require 'appmap/minitest'
-```
-
-Note that `test_helper.rb` in a Rails project typically loads the application's classes this way:
-
-```ruby
-require_relative '../config/environment'
-```
-
-and `appmap/minitest` must be required before this:
-
-```ruby
-require 'appmap/minitest'
-require_relative '../config/environment'
-```
-
-2) Run your tests as you normally would with the environment variable `APPMAP=true`. For example:  
-
-```
-$ APPMAP=true bundle exec rake test
-```
-
-or
-
-```
-$ APPMAP=true bundle exec ruby -Ilib -Itest test/*_test.rb
-```
-
-Each Minitest test will output an AppMap file into the directory `tmp/appmap/minitest`. For example:
-
-```
-$ find tmp/appmap/minitest
-Hello_says_hello_when_prompted.appmap.json
-```
-
-## Cucumber
-
-To record Cucumber tests, follow these additional steps:
-
-1) Require `appmap/cucumber` in `support/env.rb`:
-
-```ruby
-require 'appmap/cucumber'
-```
-
-Be sure to require it before `config/environment` is required.
-
-2) Create an `Around` hook in `support/hooks.rb` to record the scenario:
-
-
-```ruby
-if AppMap::Cucumber.enabled?
-  Around('not @appmap-disable') do |scenario, block|
-    appmap = AppMap.record do
-      block.call
-    end
-
-    AppMap::Cucumber.write_scenario(scenario, appmap)
-  end
-end
-```
-
-3) Run the tests with the environment variable `APPMAP=true`:
-
-```sh-session
-$ APPMAP=true bundle exec cucumber
-```
-
-Each Cucumber test will output an AppMap file into the directory `tmp/appmap/cucumber`. For example:
-
-```
-$ find tmp/appmap/cucumber
-Hello_Says_hello_when_prompted.appmap.json
-```
-
-## Remote recording
-
-To manually record ad-hoc AppMaps of your Ruby app, use AppMap remote recording.
-
-1. Add the AppMap remote recording middleware. For example, in `config/initializers/appmap_remote_recording.rb`:
-
-```ruby
-if defined?(AppMap)
-  require 'appmap/middleware/remote_recording'
-
-  Rails.application.config.middleware.insert_after \
-    Rails::Rack::Logger,
-    AppMap::Middleware::RemoteRecording
-end
-```
-
-2. (optional) Download and unpack the [AppLand browser extension](https://github.com/applandinc/appland-browser-extension). Install into Chrome using `chrome://extensions/`. Turn on "Developer Mode" and then load the extension using the "Load unpacked" button.
-
-3. Start your Rails application server, with `APPMAP_RECORD=true`. For example:
-
-```sh-session
-$ APPMAP_RECORD=true bundle exec rails server
-```
-
-4. Start the recording
-
-Option 1: Open the AppLand browser extension and push `Start`.
-Option 2: `curl -XPOST localhost:3000/_appmap/record` (be sure and get the port number right)
-
-5. Use your app. For example, perform a login flow, or run through a manual UI test.
-
-6. Finish the recording.
-
-Option 1: Open the AppLand browser extension and push `Stop`. The recording will be transferred to the AppLand website and opened in your browser.
-Option 2: `curl -XDELETE localhost:3000/_appmap/record > recording.appmap.json` - Saves the recording as a local file.
-
-
-# AppMap for VSCode
-
-The [AppMap extension for VSCode](https://marketplace.visualstudio.com/items?itemName=appland.appmap) helps you navigate your code more efficiently with interactive, accurate software architecture diagrams right in your IDE. In less than two minutes you can go from installing the AppMap extension to exploring maps of your code's architecture. AppMap helps you:
-
-* Onboard to code architecture, with no extra work for the team
-* Conduct code and design reviews using live and accurate data
-* Troubleshoot hard-to-understand bugs using a "top-down" approach.
-
-Each interactive diagram links directly to the source code, and the information is easy to share.
-
-# AppMap Swagger
-
-[appmap_swagger](https://github.com/applandinc/appmap_swagger-ruby) is a tool to generate Swagger files from AppMap data. With `appmap_swagger`, you can add Swagger to your Ruby or Ruby on Rails project, with no need to write or modify code. Use the Swagger UI to interact with your web services API as you build it, and use diffs of Swagger to perform code review of web service changes.
-
-# Uploading AppMaps
-
-[https://app.land](https://app.land) can be used to store, analyze, and share AppMaps.
+# Usage
 
-For instructions on uploading, see the documentation of the [AppLand CLI](https://github.com/applandinc/appland-cli).
+Visit the [AppMap for Ruby](https://appland.com/docs/reference/appmap-ruby.html) reference page on AppLand.com for a complete reference guide.
 
 # Development
 [![Build Status](https://travis-ci.com/applandinc/appmap-ruby.svg?branch=master)](https://travis-ci.com/applandinc/appmap-ruby)

data/lib/appmap.rb

@@ -27,7 +27,7 @@ module AppMap
     # Gets the configuration. If there is no configuration, the default
     # configuration is initialized.
     def configuration
-      @configuration ||= initialize
+      @configuration ||= initialize_configuration
     end
 
     # Sets the configuration. This is only expected to happen once per
@@ -38,12 +38,19 @@ module AppMap
       @configuration = config
     end
 
-    # Configures AppMap for recording. Default behavior is to configure from "appmap.yml".
+    def default_config_file_path
+      ENV['APPMAP_CONFIG_FILE'] || 'appmap.yml'
+    end
+
+    # 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.
-    def initialize(config_file_path = 'appmap.yml')
-      raise "AppMap configuration file #{config_file_path} does not exist" unless ::File.exists?(config_file_path)
+    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
@@ -51,6 +58,14 @@ module AppMap
       end
     end
 
+    def info(msg)
+      if defined?(::Rails) && defined?(::Rails.logger)
+        ::Rails.logger.info msg
+      else
+        warn msg
+      end
+    end
+
     # Used to start tracing, stop tracing, and record events.
     def tracing
       @tracing ||= Trace::Tracing.new
@@ -97,5 +112,17 @@ module AppMap
   end
 end
 
-require 'appmap/railtie' if defined?(::Rails::Railtie)
-AppMap.initialize if ENV['APPMAP'] == 'true'
+if defined?(::Rails::Railtie)
+  require 'appmap/railtie' 
+end
+
+if defined?(::RSpec)
+  require 'appmap/rspec'
+end
+
+# defined?(::Minitest) returns nil...
+if Gem.loaded_specs['minitest']
+  require 'appmap/minitest'
+end
+
+AppMap.initialize_configuration if ENV['APPMAP'] == 'true'

data/lib/appmap/config.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'yaml'
 require 'appmap/handler/net_http'
 require 'appmap/handler/rails/template'
 
@@ -167,8 +168,10 @@ module AppMap
       ),
       package_hooks('actionpack',
         [
-          method_hook('ActionDispatch::Request::Session', %i[destroy [] dig values []= clear update delete fetch merge], %w[http.session]),
-          method_hook('ActionDispatch::Cookies::CookieJar', %i[[]= clear update delete recycle], %w[http.session]),
+          method_hook('ActionDispatch::Request::Session', %i[[] dig values fetch], %w[http.session.read]),
+          method_hook('ActionDispatch::Request::Session', %i[destroy[]= clear update delete merge], %w[http.session.write]),
+          method_hook('ActionDispatch::Cookies::CookieJar', %i[[]= clear update delete recycle], %w[http.session.read]),
+          method_hook('ActionDispatch::Cookies::CookieJar', %i[[]= clear update delete recycle], %w[http.session.write]),
           method_hook('ActionDispatch::Cookies::EncryptedCookieJar', %i[[]= clear update delete recycle], %w[http.cookie crypto.encrypt])
         ],
         package_name: 'action_dispatch'
@@ -213,15 +216,22 @@ module AppMap
       # This is happening: Method send_command not found on Net::IMAP
       # 'Net::IMAP' => TargetMethods.new(:send_command, Package.build_from_path('net/imap', package_name: 'net/imap', labels: %w[protocol.email.imap])),
       # 'Marshal' => TargetMethods.new(%i[dump load], Package.build_from_path('marshal', labels: %w[format.marshal])),
-      'Psych' => TargetMethods.new(%i[dump dump_stream load load_stream parse parse_stream], Package.build_from_path('yaml', package_name: 'psych', labels: %w[format.yaml])),
-      'JSON::Ext::Parser' => TargetMethods.new(:parse, Package.build_from_path('json', package_name: 'json', labels: %w[format.json])),
-      'JSON::Ext::Generator::State' => TargetMethods.new(:generate, Package.build_from_path('json', package_name: 'json', labels: %w[format.json])),
+      'Psych' => [
+        TargetMethods.new(%i[load load_stream parse parse_stream], Package.build_from_path('yaml', package_name: 'psych', labels: %w[format.yaml.parse])),
+        TargetMethods.new(%i[dump dump_stream], Package.build_from_path('yaml', package_name: 'psych', labels: %w[format.yaml.generate])),
+      ],
+      'JSON::Ext::Parser' => TargetMethods.new(:parse, Package.build_from_path('json', package_name: 'json', labels: %w[format.json.parse])),
+      'JSON::Ext::Generator::State' => TargetMethods.new(:generate, Package.build_from_path('json', package_name: 'json', labels: %w[format.json.generate])),
     }.freeze
 
-    attr_reader :name, :packages, :exclude, :hooked_methods, :builtin_hooks
+    attr_reader :name, :appmap_dir, :packages, :exclude, :hooked_methods, :builtin_hooks
 
-    def initialize(name, packages, exclude: [], functions: [])
+    def initialize(name,
+      packages: [],
+      exclude: [],
+      functions: [])
       @name = name
+      @appmap_dir = AppMap::DEFAULT_APPMAP_DIR
       @packages = packages
       @hook_paths = Set.new(packages.map(&:path))
       @exclude = exclude
@@ -248,38 +258,118 @@ module AppMap
     class << self
       # Loads configuration data from a file, specified by the file name.
       def load_from_file(config_file_name)
-        require 'yaml'
-        load YAML.safe_load(::File.read(config_file_name))
+        logo = lambda do
+          Util.color(<<~LOGO, :magenta)
+             ___             __  ___
+            / _ | ___  ___  /  |/  /__ ____
+           / __ |/ _ \\/ _ \\/ /|_/ / _ `/ _ \\
+          /_/ |_/ .__/ .__/_/  /_/\\_,_/ .__/
+               /_/  /_/              /_/
+          LOGO
+        end
+
+        config_present = true if File.exists?(config_file_name)
+
+        config_data = if config_present
+          YAML.safe_load(::File.read(config_file_name))
+        else
+          warn logo.()
+          warn ''
+          warn Util.color(%Q|NOTICE: The AppMap config file #{config_file_name} was not found!|, :magenta, bold: true)
+          warn ''
+          warn Util.color(<<~MISSING_FILE_MSG, :magenta)
+          AppMap uses this file to customize its behavior. For example, you can use
+          the 'packages' setting to indicate which local file paths and dependency
+          gems you want to include in the AppMap. Since you haven't provided specific
+          settings, the appmap gem will try and guess some reasonable defaults.
+          To suppress this message, create the file:
+          
+          #{Pathname.new(config_file_name).expand_path}.
+          
+          Here are the default settings that will be used in the meantime. You can
+          copy and paste this example to start your appmap.yml.
+          MISSING_FILE_MSG
+          {}
+        end
+        load(config_data).tap do |config|
+          config_yaml = {
+            'name' => config.name,
+            'packages' => config.packages.select{|p| p.path}.map do |pkg|
+              { 'path' => pkg.path }
+            end,
+            'exclude' => []
+          }.compact
+          unless config_present
+            warn Util.color(YAML.dump(config_yaml), :magenta)
+            warn logo.()
+          end
+        end
       end
 
       # Loads configuration from a Hash.
       def load(config_data)
-        functions = (config_data['functions'] || []).map do |function_data|
-          package = function_data['package']
-          cls = function_data['class']
-          functions = function_data['function'] || function_data['functions']
-          raise 'AppMap class configuration should specify package, class and function(s)' unless package && cls && functions
-          functions = Array(functions).map(&:to_sym)
-          labels = function_data['label'] || function_data['labels']
-          labels = Array(labels).map(&:to_s) if labels
-          Function.new(package, cls, labels, functions)
+        name = config_data['name'] || guess_name
+        config_params = {
+          exclude: config_data['exclude']
+        }.compact
+
+        if config_data['functions']
+          config_params[:functions] = config_data['functions'].map do |function_data|
+            package = function_data['package']
+            cls = function_data['class']
+            functions = function_data['function'] || function_data['functions']
+            raise %q(AppMap config 'function' element should specify 'package', 'class' and 'function' or 'functions') unless package && cls && functions
+
+            functions = Array(functions).map(&:to_sym)
+            labels = function_data['label'] || function_data['labels']
+            labels = Array(labels).map(&:to_s) if labels
+            Function.new(package, cls, labels, functions)
+          end
         end
-        packages = (config_data['packages'] || []).map do |package|
-          gem = package['gem']
-          path = package['path']
-          raise 'AppMap package configuration should specify gem or path, not both' if gem && path
-
-          if gem
-            shallow = package['shallow']
-            # shallow is true by default for gems
-            shallow = true if shallow.nil?
-            Package.build_from_gem(gem, exclude: package['exclude'] || [], shallow: shallow)
+
+        config_params[:packages] = \
+          if config_data['packages']
+            config_data['packages'].map do |package|
+              gem = package['gem']
+              path = package['path']
+              raise %q(AppMap config 'package' element should specify 'gem' or 'path', not both) if gem && path
+
+              if gem
+                shallow = package['shallow']
+                # shallow is true by default for gems
+                shallow = true if shallow.nil?
+                Package.build_from_gem(gem, exclude: package['exclude'] || [], shallow: shallow)
+              else
+                Package.build_from_path(path, exclude: package['exclude'] || [], shallow: package['shallow'])
+              end
+            end.compact
           else
-            Package.build_from_path(path, exclude: package['exclude'] || [], shallow: package['shallow'])
+            Array(guess_paths).map do |path|
+              Package.build_from_path(path)
+            end
           end
-        end.compact
-        exclude = config_data['exclude'] || []
-        Config.new config_data['name'], packages, exclude: exclude, functions: functions
+
+        Config.new name, config_params
+      end
+
+      def guess_name
+        reponame = lambda do
+          next unless File.directory?('.git')
+
+          repo_name = `git config --get remote.origin.url`.strip
+          repo_name.split('/').last.split('.').first unless repo_name == ''
+        end
+        dirname = -> { Dir.pwd.split('/').last }
+
+        reponame.() || dirname.()
+      end
+
+      def guess_paths
+        if defined?(::Rails)
+          %w[app/controllers app/models]
+        elsif File.directory?('lib')
+          %w[lib]
+        end
       end
     end
 
@@ -289,7 +379,7 @@ module AppMap
         packages: packages.map(&:to_h),
         functions: @functions.map(&:to_h),
         exclude: exclude
-      }
+      }.compact
     end
 
     # Determines if methods defined in a file path should possibly be hooked.

data/lib/appmap/hook.rb

@@ -36,7 +36,7 @@ module AppMap
 
     def initialize(config)
       @config = config
-      @trace_locations = []
+      @trace_enabled = []
       # Paths that are known to be non-tracing
       @notrace_paths = Set.new
     end
@@ -47,10 +47,8 @@ module AppMap
 
       hook_builtins
 
-      @trace_begin = TracePoint.new(:class, &method(:trace_class))
       @trace_end = TracePoint.new(:end, &method(:trace_end))
-
-      @trace_begin.enable(&block)
+      @trace_end.enable(&block)
     end
 
     # hook_builtins builds hooks for code that is built in to the Ruby standard library.
@@ -96,29 +94,22 @@ module AppMap
 
     protected
 
-    def trace_class(trace_point)
-      path = trace_point.path
-
-      return if @notrace_paths.member?(path)
-
-      if config.path_enabled?(path)
-        location = trace_location(trace_point)
-        warn "Entering hook-enabled location #{location}" if Hook::LOG || Hook::LOG_HOOK
-        @trace_locations << location
-        unless @trace_end.enabled?
-          warn "Enabling hooking" if Hook::LOG || Hook::LOG_HOOK
-          @trace_end.enable
-        end
-      else
-        @notrace_paths << path
-      end
-    end
-
     def trace_location(trace_point)
       [ trace_point.path, trace_point.lineno ].join(':')
     end
 
     def trace_end(trace_point)
+      location = trace_location(trace_point)
+      warn "Class or module ends at location #{trace_location(trace_point)}" if Hook::LOG || Hook::LOG_HOOK
+
+      path = trace_point.path
+      enabled = !@notrace_paths.member?(path) && config.path_enabled?(path)
+      if !enabled
+        warn "Not hooking - path is not enabled" if Hook::LOG || Hook::LOG_HOOK
+        @notrace_paths << path
+        return
+      end
+
       cls = trace_point.self
 
       instance_methods = cls.public_instance_methods(false) - OBJECT_INSTANCE_METHODS
@@ -151,7 +142,8 @@ module AppMap
           warn "AppMap: Examining #{hook_cls} #{method.name}" if LOG
 
           disasm = RubyVM::InstructionSequence.disasm(method)
-          # Skip methods that have no instruction sequence, as they are obviously trivial.
+          # Skip methods that have no instruction sequence, as they are either have no body or they are or native.
+          # TODO: Figure out how to tell the difference?
           next unless disasm
 
           package = config.lookup_package(hook_cls, method)
@@ -170,13 +162,6 @@ module AppMap
         #   uninitialized constant Faraday::Connection
         warn "NameError in #{__FILE__}: #{$!.message}"
       end
-
-      location = @trace_locations.pop
-      warn "Leaving hook-enabled location #{location}" if Hook::LOG || Hook::LOG_HOOK
-      if @trace_locations.empty?
-        warn "Disabling hooking" if Hook::LOG || Hook::LOG_HOOK
-        @trace_end.disable
-      end
     end
   end
 end

data/lib/appmap/minitest.rb

@@ -54,15 +54,21 @@ module AppMap
 
     @recordings_by_test = {}
     @event_methods = Set.new
+    @recording_count = 0
 
     class << self
       def init
-        warn 'Configuring AppMap recorder for Minitest'
-
         FileUtils.mkdir_p APPMAP_OUTPUT_DIR
       end
 
+      def first_recording?
+        @recording_count == 0
+      end
+
       def begin_test(test, name)
+        AppMap.info 'Configuring AppMap recorder for Minitest' if first_recording?
+        @recording_count += 1
+
         @recordings_by_test[test.object_id] = Recording.new(test, name)
       end
 

data/lib/appmap/railtie.rb

@@ -3,6 +3,13 @@
 module AppMap
   # Railtie connects the AppMap recorder to Rails-specific features.
   class Railtie < ::Rails::Railtie
+    initializer 'appmap.remote_recording' do
+      require 'appmap/middleware/remote_recording'
+      Rails.application.config.middleware.insert_after \
+        Rails::Rack::Logger,
+        AppMap::Middleware::RemoteRecording
+    end
+
     # appmap.subscribe subscribes to ActiveSupport Notifications so that they can be recorded as
     # AppMap events.
     initializer 'appmap.subscribe' do |_| # params: app

data/lib/appmap/rspec.rb

@@ -139,15 +139,21 @@ module AppMap
 
     @recordings_by_example = {}
     @event_methods = Set.new
+    @recording_count = 0
 
     class << self
       def init
-        warn 'Configuring AppMap recorder for RSpec'
-
         FileUtils.mkdir_p APPMAP_OUTPUT_DIR
       end
 
+      def first_recording?
+        @recording_count == 0
+      end
+
       def begin_spec(example)
+        AppMap.info 'Configuring AppMap recorder for RSpec' if first_recording?
+        @recording_count += 1
+
         @recordings_by_example[example.object_id] = Recording.new(example)
       end
 

data/lib/appmap/util.rb

@@ -4,6 +4,21 @@ require 'bundler'
 
 module AppMap
   module Util
+    # https://wynnnetherland.com/journal/a-stylesheet-author-s-guide-to-terminal-colors/
+    # Embed in a String to clear all previous ANSI sequences.
+    CLEAR   = "\e[0m"
+    BOLD    = "\e[1m"
+
+    # Colors
+    BLACK   = "\e[30m"
+    RED     = "\e[31m"
+    GREEN   = "\e[32m"
+    YELLOW  = "\e[33m"
+    BLUE    = "\e[34m"
+    MAGENTA = "\e[35m"
+    CYAN    = "\e[36m"
+    WHITE   = "\e[37m"
+
     class << self
       # scenario_filename builds a suitable file name from a scenario name.
       # Special characters are removed, and the file name is truncated to fit within
@@ -128,6 +143,12 @@ module AppMap
           FileUtils.mv tempfile.path, filename
         end
       end
+
+      def color(text, color, bold: false)
+        color = Util.const_get(color.to_s.upcase) if color.is_a?(Symbol)
+        bold  = bold ? BOLD : ""
+        "#{bold}#{color}#{text}#{CLEAR}"
+      end
     end
   end
 end

data/lib/appmap/version.rb

@@ -3,7 +3,9 @@
 module AppMap
   URL = 'https://github.com/applandinc/appmap-ruby'
 
-  VERSION = '0.48.1'
+  VERSION = '0.51.1'
 
   APPMAP_FORMAT_VERSION = '1.5.1'
+
+  DEFAULT_APPMAP_DIR = 'tmp/appmap'.freeze
 end

data/spec/abstract_controller_base_spec.rb

@@ -1,9 +1,30 @@
 require 'rails_spec_helper'
 
 describe 'Rails' do
+  shared_context 'rails integration test setup' do
+    def tmpdir
+      'tmp/spec/AbstractControllerBase'
+    end
+
+    unless use_existing_data?
+      before(:all) do
+        FileUtils.rm_rf tmpdir
+        FileUtils.mkdir_p tmpdir
+        run_spec 'spec/controllers/users_controller_spec.rb'
+        run_spec 'spec/controllers/users_controller_api_spec.rb'
+      end
+    end
+
+    let(:appmap) { JSON.parse File.read File.join tmpdir, 'appmap/rspec', appmap_json_file }
+    let(:appmap_json_path) { File.join(tmpdir, 'appmap/rspec', appmap_json_file) }
+    let(:appmap) { JSON.parse File.read(appmap_json_path) }
+    let(:events) { appmap['events'] }
+  end
+
   %w[5 6].each do |rails_major_version| # rubocop:disable Metrics/BlockLength
     context "#{rails_major_version}" do
       include_context 'Rails app pg database', "spec/fixtures/rails#{rails_major_version}_users_app" unless use_existing_data?
+      include_context 'rails integration test setup'
 
       def run_spec(spec_name)
         cmd = <<~CMD.gsub "\n", ' '
@@ -13,24 +34,6 @@ describe 'Rails' do
         run_cmd cmd, chdir: fixture_dir
       end
 
-      def tmpdir
-        'tmp/spec/AbstractControllerBase'
-      end
-
-      unless use_existing_data?
-        before(:all) do
-          FileUtils.rm_rf tmpdir
-          FileUtils.mkdir_p tmpdir
-          run_spec 'spec/controllers/users_controller_spec.rb'
-          run_spec 'spec/controllers/users_controller_api_spec.rb'
-        end
-      end
-
-      let(:appmap) { JSON.parse File.read File.join tmpdir, 'appmap/rspec', appmap_json_file }
-      let(:appmap_json_path) { File.join(tmpdir, 'appmap/rspec', appmap_json_file) }
-      let(:appmap) { JSON.parse File.read(appmap_json_path) }
-      let(:events) { appmap['events'] }
-
       describe 'an API route' do
         describe 'creating an object' do
           let(:appmap_json_file) do
@@ -253,4 +256,40 @@ describe 'Rails' do
       end
     end
   end
+
+  describe 'with default appmap.yml' do
+    include_context 'Rails app pg database', "spec/fixtures/rails5_users_app" unless use_existing_data?
+    include_context 'rails integration test setup'
+
+    def run_spec(spec_name)
+      cmd = <<~CMD.gsub "\n", ' '
+        docker-compose run --rm -e RAILS_ENV=test -e APPMAP=true -e APPMAP_CONFIG_FILE=no/such/file
+        -v #{File.absolute_path tmpdir}:/app/tmp app ./bin/rspec #{spec_name}
+      CMD
+      run_cmd cmd, chdir: fixture_dir
+    end
+
+    let(:appmap_json_file) do
+      'Api_UsersController_POST_api_users_with_required_parameters_creates_a_user.appmap.json'
+    end
+
+    it 'http_server_request is recorded' do
+      expect(events).to include(
+        hash_including(
+          'http_server_request' => hash_including(
+            'request_method' => 'POST',
+            'path_info' => '/api/users'
+          )
+        )
+      )
+    end
+
+    it 'controller method is recorded' do
+      expect(events).to include hash_including(
+        'defined_class' => 'Api::UsersController',
+        'method_id' => 'build_user',
+        'path' => 'app/controllers/api/users_controller.rb',
+      )
+    end
+  end
 end

data/spec/config_spec.rb

@@ -55,4 +55,25 @@ describe AppMap::Config, docker: false do
 
     expect(config.to_h.deep_stringify_keys!).to eq(config_expectation)
   end
+
+  context do
+    let(:warnings) { @warnings ||= [] }
+    let(:warning) { warnings.join }
+    before do
+      expect(AppMap::Config).to receive(:warn).at_least(1) { |msg| warnings << msg }
+    end
+    it 'prints a warning and uses a default config' do
+      config = AppMap::Config.load_from_file 'no/such/file'
+      expect(config.to_h).to eq(YAML.load(<<~CONFIG))
+      :name: appmap-ruby
+      :packages:
+      - :path: lib
+        :handler_class: AppMap::Handler::Function
+        :shallow: false
+      :functions: []
+      :exclude: []
+      CONFIG
+      expect(warning).to include('NOTICE: The AppMap config file no/such/file was not found!')
+    end
+  end
 end

data/spec/fixtures/rails5_users_app/config/application.rb

@@ -21,14 +21,6 @@ when 'activerecord'
   require 'database_cleaner-active_record' if Rails.env.test?
 end
 
-require 'appmap/railtie' if defined?(AppMap)
-
-# require "active_storage/engine"
-# require "action_mailer/railtie"
-# require "action_cable/engine"
-# require "sprockets/railtie"
-# require "rails/test_unit/railtie"
-
 # Require the gems listed in Gemfile, including any gems
 # you've limited to :test, :development, or :production.
 Bundler.require(*Rails.groups)

data/spec/fixtures/rails5_users_app/spec/rails_helper.rb

@@ -7,8 +7,6 @@ abort("The Rails environment is running in production mode!") if Rails.env.produ
 require 'rspec/rails'
 # Add additional requires below this line. Rails is not loaded until this point!
 
-require 'appmap/rspec'
-
 # Requires supporting ruby files with custom matchers and macros, etc, in
 # spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
 # run as spec files by default. This means that files in spec/support that end

data/spec/fixtures/rails6_users_app/config/application.rb

@@ -21,14 +21,6 @@ when 'activerecord'
   require 'database_cleaner-active_record' if Rails.env.test?
 end
 
-require 'appmap/railtie' if defined?(AppMap)
-
-# require "active_storage/engine"
-# require "action_mailer/railtie"
-# require "action_cable/engine"
-# require "sprockets/railtie"
-# require "rails/test_unit/railtie"
-
 # Require the gems listed in Gemfile, including any gems
 # you've limited to :test, :development, or :production.
 Bundler.require(*Rails.groups)

data/spec/fixtures/rails6_users_app/spec/rails_helper.rb

@@ -7,8 +7,6 @@ abort("The Rails environment is running in production mode!") if Rails.env.produ
 require 'rspec/rails'
 # Add additional requires below this line. Rails is not loaded until this point!
 
-require 'appmap/rspec'
-
 # Requires supporting ruby files with custom matchers and macros, etc, in
 # spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
 # run as spec files by default. This means that files in spec/support that end

data/spec/hook_spec.rb

@@ -21,7 +21,7 @@ describe 'AppMap class Hooking', docker: false do
   def invoke_test_file(file, setup: nil, &block)
     AppMap.configuration = nil
     package = AppMap::Config::Package.build_from_path(file)
-    config = AppMap::Config.new('hook_spec', [ package ])
+    config = AppMap::Config.new('hook_spec', packages: [ package ])
     AppMap.configuration = config
     tracer = nil
     AppMap::Hook.new(config).enable do
@@ -57,7 +57,7 @@ describe 'AppMap class Hooking', docker: false do
   it 'excludes named classes and methods' do
     load 'spec/fixtures/hook/exclude.rb'
     package = AppMap::Config::Package.build_from_path('spec/fixtures/hook/exclude.rb')
-    config = AppMap::Config.new('hook_spec', [ package ], exclude: %w[ExcludeTest])
+    config = AppMap::Config.new('hook_spec', packages: [ package ], exclude: %w[ExcludeTest])
     AppMap.configuration = config
 
     expect(config.never_hook?(ExcludeTest, ExcludeTest.new.method(:instance_method))).to be_truthy

data/spec/record_net_http_spec.rb

@@ -62,7 +62,7 @@ describe 'Net::HTTP handler' do
   end
 
   context 'with trace enabled' do
-    let(:configuration) { AppMap::Config.new('record_net_http_spec', []) }
+    let(:configuration) { AppMap::Config.new('record_net_http_spec') }
 
     after do
       AppMap.configuration = nil

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.48.1
+  version: 0.51.1
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-25 00:00:00.000000000 Z
+date: 2021-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -455,7 +455,6 @@ files:
 - spec/fixtures/rails5_users_app/config/initializers/filter_parameter_logging.rb
 - spec/fixtures/rails5_users_app/config/initializers/inflections.rb
 - spec/fixtures/rails5_users_app/config/initializers/mime_types.rb
-- spec/fixtures/rails5_users_app/config/initializers/record_button.rb
 - spec/fixtures/rails5_users_app/config/initializers/wrap_parameters.rb
 - spec/fixtures/rails5_users_app/config/locales/en.yml
 - spec/fixtures/rails5_users_app/config/routes.rb
@@ -527,7 +526,6 @@ files:
 - spec/fixtures/rails6_users_app/config/initializers/filter_parameter_logging.rb
 - spec/fixtures/rails6_users_app/config/initializers/inflections.rb
 - spec/fixtures/rails6_users_app/config/initializers/mime_types.rb
-- spec/fixtures/rails6_users_app/config/initializers/record_button.rb
 - spec/fixtures/rails6_users_app/config/initializers/wrap_parameters.rb
 - spec/fixtures/rails6_users_app/config/locales/en.yml
 - spec/fixtures/rails6_users_app/config/routes.rb

data/spec/fixtures/rails5_users_app/config/initializers/record_button.rb

@@ -1,3 +0,0 @@
-require 'appmap/middleware/remote_recording'
-Rails.application.config.middleware.insert_after Rails::Rack::Logger, AppMap::Middleware::RemoteRecording \
-  unless Rails.env.test?

data/spec/fixtures/rails6_users_app/config/initializers/record_button.rb

@@ -1,3 +0,0 @@
-require 'appmap/middleware/remote_recording'
-Rails.application.config.middleware.insert_after Rails::Rack::Logger, AppMap::Middleware::RemoteRecording \
-  unless Rails.env.test?