appmap 0.48.2 → 0.51.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 455ac48f4acf31694cb571912703f62b95687b8b833be0ced7b8ab5008c3960b
-  data.tar.gz: 272c68f804affe1a461ec504475b95d1c7968e506644442437a45dd28ff7d664
+  metadata.gz: 194f53c7e13b466fef13720503fe9f8c1ee149af724884224ce03753cc0d658f
+  data.tar.gz: e9c7d5578da6d9e80d9c06e70deaa32fe7da785ab94840a09739e474601a8cac
 SHA512:
-  metadata.gz: 3bfbb562490380393c669aaeb2813389a52bf18f8e769f69a496ffe9fc26a493d9f55cfa161926d26deca370b1e18f99896eb0e269e59cbd6647801b7238c565
-  data.tar.gz: ba4b69852fc4be1850b5fd20c713e21799848bd32a251cdcc3bae87e4bf25605621dccc381e32018397ff52bbc442859065d8f1d8313211c135c1a9fb3ecb6d7
+  metadata.gz: 82da50065460e83bbbd0f35bdce8e04924d9e0388f1da9ba30cea0637594dce2d8dc3a9364c55e1492924e73dfb91cf163eac7fe7028e4b48eb5cb3c34a96c92
+  data.tar.gz: 96198ca1c1f3c5bdcd4d75ce275f8e76a39ff9c36cbaf314c642d91dac54403426a28b54c5a478a58295560af804dc3f44ac33ff9b1b710b1d401fab4c72cb75

data/CHANGELOG.md

@@ -1,3 +1,48 @@
+## [0.51.2](https://github.com/applandinc/appmap-ruby/compare/v0.51.1...v0.51.2) (2021-06-22)
+
+
+### Bug Fixes
+
+* Be less verbose when logging config messages ([fba2fd0](https://github.com/applandinc/appmap-ruby/commit/fba2fd01dbb7b1830194b49285654d6657d1c786))
+* Method objects must support eql? and hash to ensure they are unique in a Set ([f4d5b11](https://github.com/applandinc/appmap-ruby/commit/f4d5b11db90aa50bdd1f768e039927833e83c30f))
+* Require rails, then appmap/railtie ([07967a1](https://github.com/applandinc/appmap-ruby/commit/07967a14609891544a7dd874c648b7ef5a505f21))
+* Use a hybrid strategy to auto-requiring appmap modules ([6fb09b8](https://github.com/applandinc/appmap-ruby/commit/6fb09b8c0bd55b1e29967d459ce1e2bd5b1ba9fe))
+
+## [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)
 
 

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=true`. For example:
-
-```sh-session
-$ APPMAP=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/appmap.gemspec

@@ -22,6 +22,9 @@ Gem::Specification.new do |spec|
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files         = `git ls-files --no-deleted`.split("
 ")
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+
   spec.extensions << "ext/appmap/extconf.rb"
 
   spec.require_paths = ['lib']

data/exe/appmap-agent-setup

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'gli'
+
+require 'appmap'
+
+class App
+  extend GLI::App
+
+  program_desc 'CLI tool to be used by IDEs for AppMap setup and configuration'
+
+  version AppMap::VERSION
+
+  subcommand_option_handling :normal
+  arguments :strict
+  preserve_argv true
+
+  desc 'AppMap configuration file name'
+  default_value ENV['APPMAP_CONFIG'] || AppMap::DEFAULT_CONFIG_FILE_PATH
+  arg_name 'filename'
+  flag %i[c config]
+
+  desc 'Creates base configuration file for the current project'
+  command :init do |c|
+    c.action do
+      require 'appmap/command/init'
+      AppMap::Command::Init.new(@config_file).perform
+    end
+  end
+
+  pre do |global, _, _, _|
+    @config_file = global[:config]
+    @config = interpret_config_option(@config_file) if File.exist?(@config_file)
+    true
+  end
+
+  class << self
+    protected
+
+    def interpret_config_option(fname)
+      AppMap::Config.load_from_file fname
+    end
+  end
+end
+
+exit App.run(ARGV)