appmap 0.38.1 → 0.41.1

data/spec/config_spec.rb

@@ -7,6 +7,7 @@ require 'appmap/config'
 describe AppMap::Config, docker: false do
   it 'loads from a Hash' do
     config_data = {
+      exclude: [],
       name: 'test',
       packages: [
         {

data/spec/fixtures/hook/exclude.rb

@@ -0,0 +1,15 @@
+class ExcludeTest
+  def instance_method
+    'instance_method'
+  end
+
+  class << self
+    def singleton_method
+      'singleton_method'
+    end
+  end
+
+  def self.cls_method
+    'class_method'
+  end
+end

data/spec/fixtures/hook/labels.rb

@@ -0,0 +1,6 @@
+# @label has-cls-label
+class ClassWithLabel
+  # @label has-fn-label
+  def fn_with_label
+  end
+end

data/spec/fixtures/rails5_users_app/Gemfile

@@ -33,11 +33,10 @@ appmap_options = \
     { path: appmap_path }
   else
     {}
-  end.merge(require: %w[appmap appmap/railtie])
-
-gem 'appmap', appmap_options
+  end.merge(require: %w[appmap])
 
 group :development, :test do
+  gem 'appmap', appmap_options
   gem 'cucumber-rails', require: false
   gem 'rspec-rails'
   # Required for Sequel, since without ActiveRecord, the Rails transactional fixture support

data/spec/fixtures/rails5_users_app/app/controllers/users_controller.rb

@@ -2,4 +2,12 @@ class UsersController < ApplicationController
   def index
     @users = User.all
   end
+
+  def show
+    if (@user = User[login: params[:id]])
+      render plain: @user
+    else
+      render plain: 'Not found', status: 404
+    end
+  end
 end

data/spec/fixtures/rails5_users_app/appmap.yml

@@ -1,4 +1,7 @@
 name: rails5_users_app
 packages:
-  - path: app
+  - path: app/models
+    labels: [ mvc.model ]
+  - path: app/controllers
+    labels: [ mvc.controller ]
   - gem: sequel

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

@@ -19,6 +19,8 @@ when 'activerecord'
   require 'active_record/railtie'
 end
 
+require 'appmap/railtie' if defined?(AppMap)
+
 # require "active_storage/engine"
 # require "action_mailer/railtie"
 # require "action_cable/engine"

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

@@ -3,7 +3,7 @@ Rails.application.routes.draw do
     resources :users, only: %i[index create]
   end
 
-  resources :users, only: %i[index]
+  resources :users, only: %i[index show]
 
   get 'health', to: 'health#show'
 

data/spec/fixtures/rails5_users_app/spec/controllers/users_controller_spec.rb

@@ -13,4 +13,15 @@ RSpec.describe UsersController, type: :controller do
       expect(response).to be_ok
     end
   end
+
+  describe 'GET /users/:login', feature: 'Show a user' do
+    before do
+      User.create login: 'alice'
+    end
+
+    it 'shows the user' do
+      get :show, params: { id: 'alice' }
+      expect(response).to be_ok
+    end
+  end
 end

data/spec/fixtures/rails6_users_app/Gemfile

@@ -34,11 +34,10 @@ appmap_options = \
     { path: appmap_path }
   else
     {}
-  end.merge(require: %w[appmap appmap/railtie])
-
-gem 'appmap', appmap_options
+  end.merge(require: %w[appmap])
 
 group :development, :test do
+  gem 'appmap', appmap_options
   gem 'cucumber-rails', require: false
   gem 'rspec-rails'
   # Required for Sequel, since without ActiveRecord, the Rails transactional fixture support

data/spec/fixtures/rails6_users_app/app/controllers/users_controller.rb

@@ -2,4 +2,12 @@ class UsersController < ApplicationController
   def index
     @users = User.all
   end
+
+  def show
+    if (@user = User[login: params[:id]])
+      render plain: @user
+    else
+      render plain: 'Not found', status: 404
+    end
+  end
 end

data/spec/fixtures/rails6_users_app/appmap.yml

@@ -1,5 +1,8 @@
 name: rails6_users_app
 packages:
-  - path: app
+  - path: app/models
+    labels: [ mvc.model ]
+  - path: app/controllers
+    labels: [ mvc.controller ]
   - gem: sequel
 

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

@@ -19,6 +19,8 @@ when 'activerecord'
   require 'active_record/railtie'
 end
 
+require 'appmap/railtie' if defined?(AppMap)
+
 # require "active_storage/engine"
 # require "action_mailer/railtie"
 # require "action_cable/engine"

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

@@ -3,7 +3,7 @@ Rails.application.routes.draw do
     resources :users, only: %i[index create]
   end
 
-  resources :users, only: %i[index]
+  resources :users, only: %i[index show]
 
   get 'health', to: 'health#show'
 

data/spec/fixtures/rails6_users_app/spec/controllers/users_controller_spec.rb

@@ -13,4 +13,15 @@ RSpec.describe UsersController, type: :controller do
       expect(response).to be_ok
     end
   end
+
+  describe 'GET /users/:login', feature: 'Show a user' do
+    before do
+      User.create login: 'alice'
+    end
+
+    it 'shows the user' do
+      get :show, params: { id: 'alice' }
+      expect(response).to be_ok
+    end
+  end
 end

data/spec/hook_spec.rb

@@ -61,6 +61,42 @@ describe 'AppMap class Hooking', docker: false do
     AppMap.configuration = nil
   end
 
+  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 ], %w[ExcludeTest])
+    AppMap.configuration = config
+
+    expect(config.never_hook?(ExcludeTest.new.method(:instance_method))).to be_truthy
+    expect(config.never_hook?(ExcludeTest.method(:cls_method))).to be_truthy
+  end
+
+  it 'parses labels from comments' do
+    _, tracer = invoke_test_file 'spec/fixtures/hook/labels.rb' do
+      ClassWithLabel.new.fn_with_label
+    end
+    class_map = AppMap.class_map(tracer.event_methods).to_yaml
+    expect(Diffy::Diff.new(<<~YAML, class_map).to_s).to eq('')
+    ---
+    - :name: spec/fixtures/hook/labels.rb
+      :type: package
+      :children:
+      - :name: ClassWithLabel
+        :type: class
+        :children:
+        - :name: fn_with_label
+          :type: function
+          :location: spec/fixtures/hook/labels.rb:4
+          :static: false
+          :labels:
+          - has-fn-label
+          :comment: "# @label has-fn-label\\n"
+          :source: |2
+              def fn_with_label
+              end
+      YAML
+  end
+
   it 'hooks an instance method that takes no arguments' do
     events_yaml = <<~YAML
     ---
@@ -517,24 +553,6 @@ describe 'AppMap class Hooking', docker: false do
       events_yaml = <<~YAML
       ---
       - :id: 1
-        :event: :call
-        :defined_class: NoToSMethod
-        :method_id: respond_to?
-        :path: spec/fixtures/hook/exception_method.rb
-        :lineno: 24
-        :static: false
-        :parameters:
-        - :name: :args
-          :class: Array
-          :value: "[:to_s]"
-          :kind: :rest
-        :receiver:
-          :class: Class
-          :value: NoToSMethod
-      - :id: 2
-        :event: :return
-        :parent_id: 1
-      - :id: 3
         :event: :call
         :defined_class: NoToSMethod
         :method_id: say_hello
@@ -545,9 +563,9 @@ describe 'AppMap class Hooking', docker: false do
         :receiver:
           :class: Class
           :value: NoToSMethod
-      - :id: 4
+      - :id: 2
         :event: :return
-        :parent_id: 3
+        :parent_id: 1
         :return_value:
           :class: String
           :value: hello
@@ -565,24 +583,6 @@ describe 'AppMap class Hooking', docker: false do
       events_yaml = <<~YAML
       ---
       - :id: 1
-        :event: :call
-        :defined_class: NoToSMethod
-        :method_id: respond_to?
-        :path: spec/fixtures/hook/exception_method.rb
-        :lineno: 24
-        :static: false
-        :parameters:
-        - :name: :args
-          :class: Array
-          :value: "[:to_s]"
-          :kind: :rest
-        :receiver:
-          :class: Class
-          :value: "*Error inspecting variable*"
-      - :id: 2
-        :event: :return
-        :parent_id: 1
-      - :id: 3
         :event: :call
         :defined_class: InspectRaises
         :method_id: say_hello
@@ -593,9 +593,9 @@ describe 'AppMap class Hooking', docker: false do
         :receiver:
           :class: Class
           :value: "*Error inspecting variable*"
-      - :id: 4
+      - :id: 2
         :event: :return
-        :parent_id: 3
+        :parent_id: 1
         :return_value:
           :class: String
           :value: hello
@@ -837,7 +837,7 @@ describe 'AppMap class Hooking', docker: false do
       entry = cm[1][:children][0][:children][0][:children][0]
       # Sanity check, make sure we got the right one
       expect(entry[:name]).to eq('secure_compare')
-      expect(entry[:labels]).to eq(%w[security crypto])
+      expect(entry[:labels]).to eq(%w[provider.secure_compare])
     end
   end
 

data/spec/rails_spec_helper.rb

@@ -30,7 +30,7 @@ def run_cmd(*cmd, &failed)
 end
 
 shared_context 'Rails app pg database' do |fixture_dir|
-  let(:fixture_dir) { fixture_dir }
+  define_method(:fixture_dir) { fixture_dir }
 
   before(:all) do
     print_pg_logs = lambda do
@@ -40,7 +40,7 @@ shared_context 'Rails app pg database' do |fixture_dir|
       puts logs
     end
 
-    Dir.chdir fixture_dir do 
+    Dir.chdir fixture_dir do
       run_cmd 'docker-compose down -v'
       cmd = 'docker-compose up -d pg'
       run_cmd cmd

data/spec/record_sql_rails_pg_spec.rb

@@ -5,7 +5,7 @@ describe 'SQL events' do
     around(:each) do |example|
       FileUtils.rm_rf tmpdir
       FileUtils.mkdir_p tmpdir
-      cmd = "docker-compose run --rm -e ORM_MODULE=#{orm_module} -e APPMAP=true -v #{File.absolute_path tmpdir}:/app/tmp app ./bin/rspec spec/controllers/users_controller_api_spec.rb:#{test_line_number}"
+      cmd = "docker-compose run --rm -e ORM_MODULE=#{orm_module} -e RAILS_ENV=test -e APPMAP=true -v #{File.absolute_path tmpdir}:/app/tmp app ./bin/rspec spec/controllers/users_controller_api_spec.rb:#{test_line_number}"
       run_cmd cmd, chdir: fixture_dir
 
       example.run

data/spec/rspec_feature_metadata_spec.rb

@@ -7,7 +7,7 @@ describe 'RSpec feature and feature group metadata' do
     around(:each) do |example|
       FileUtils.rm_rf tmpdir
       FileUtils.mkdir_p tmpdir
-      cmd = "docker-compose run --rm -e APPMAP=true -v #{File.absolute_path(tmpdir).shellescape}:/app/tmp app ./bin/rspec spec/models/user_spec.rb"
+      cmd = "docker-compose run --rm -e RAILS_ENV=test -e APPMAP=true -v #{File.absolute_path(tmpdir).shellescape}:/app/tmp app ./bin/rspec spec/models/user_spec.rb"
       run_cmd cmd, chdir: fixture_dir
 
       example.run

data/spec/spec_helper.rb

@@ -3,6 +3,7 @@ require 'net/http'
 require 'json'
 require 'yaml'
 require 'English'
+require 'byebug'
 require 'webdrivers/chromedriver'
 
 # Disable default initialization of AppMap

data/test/fixtures/gem_test/appmap.yml

@@ -1,3 +1,3 @@
 name: gem_test
 packages:
-  - gem: activesupport
+  - gem: parser

data/test/fixtures/gem_test/test/parser_test.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'appmap/minitest'
+require 'minitest/autorun'
+require 'parser/current'
+
+class ParserTest < ::Minitest::Test
+  def test_parser
+    Parser::CurrentRuby.parse(File.read(__FILE__))
+  end
+end

data/test/gem_test.rb

@@ -19,14 +19,14 @@ class MinitestTest < Minitest::Test
   end
 
   def test_record_gem
-    perform_gem_test 'to_param' do
-      appmap_file = 'tmp/appmap/minitest/To_param_to_param.appmap.json'
+    perform_gem_test 'parser' do
+      appmap_file = 'tmp/appmap/minitest/Parser_parser.appmap.json'
       appmap = JSON.parse(File.read(appmap_file))
       events = appmap['events']
       assert_equal 2, events.size
       assert_equal 'call', events.first['event']
-      assert_equal 'to_param', events.first['method_id']
-      assert_equal "#{Gem.loaded_specs['activesupport'].gem_dir}/lib/active_support/core_ext/object/to_query.rb", events.first['path']
+      assert_equal 'default_parser', events.first['method_id']
+      assert_equal "#{Gem.loaded_specs['parser'].gem_dir}/lib/parser/base.rb", events.first['path']
       assert_equal 'return', events.second['event']
       assert_equal 1, events.second['parent_id']
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.38.1
+  version: 0.41.1
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-30 00:00:00.000000000 Z
+date: 2021-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -319,6 +319,7 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Dockerfile.appmap
 - Gemfile
 - LICENSE.txt
@@ -378,7 +379,6 @@ files:
 - lore/public/stylesheets/style.css
 - package-lock.json
 - package.json
-- spec/abstract_controller4_base_spec.rb
 - spec/abstract_controller_base_spec.rb
 - spec/class_map_spec.rb
 - spec/config_spec.rb
@@ -386,7 +386,9 @@ files:
 - spec/fixtures/hook/compare.rb
 - spec/fixtures/hook/constructor.rb
 - spec/fixtures/hook/exception_method.rb
+- spec/fixtures/hook/exclude.rb
 - spec/fixtures/hook/instance_method.rb
+- spec/fixtures/hook/labels.rb
 - spec/fixtures/hook/singleton_method.rb
 - spec/fixtures/rack_users_app/.dockerignore
 - spec/fixtures/rack_users_app/.gitignore
@@ -396,70 +398,6 @@ files:
 - spec/fixtures/rack_users_app/config.ru
 - spec/fixtures/rack_users_app/docker-compose.yml
 - spec/fixtures/rack_users_app/lib/app.rb
-- spec/fixtures/rails4_users_app/.gitignore
-- spec/fixtures/rails4_users_app/.rbenv-gemsets
-- spec/fixtures/rails4_users_app/.ruby-version
-- spec/fixtures/rails4_users_app/Dockerfile
-- spec/fixtures/rails4_users_app/Dockerfile.pg
-- spec/fixtures/rails4_users_app/Gemfile
-- spec/fixtures/rails4_users_app/README.rdoc
-- spec/fixtures/rails4_users_app/Rakefile
-- spec/fixtures/rails4_users_app/app/assets/images/.keep
-- spec/fixtures/rails4_users_app/app/assets/javascripts/application.js
-- spec/fixtures/rails4_users_app/app/assets/stylesheets/application.css
-- spec/fixtures/rails4_users_app/app/controllers/api/users_controller.rb
-- spec/fixtures/rails4_users_app/app/controllers/application_controller.rb
-- spec/fixtures/rails4_users_app/app/controllers/concerns/.keep
-- spec/fixtures/rails4_users_app/app/controllers/health_controller.rb
-- spec/fixtures/rails4_users_app/app/controllers/users_controller.rb
-- spec/fixtures/rails4_users_app/app/helpers/application_helper.rb
-- spec/fixtures/rails4_users_app/app/mailers/.keep
-- spec/fixtures/rails4_users_app/app/models/.keep
-- spec/fixtures/rails4_users_app/app/models/concerns/.keep
-- spec/fixtures/rails4_users_app/app/models/user.rb
-- spec/fixtures/rails4_users_app/app/views/layouts/application.html.haml
-- spec/fixtures/rails4_users_app/app/views/users/index.html.haml
-- spec/fixtures/rails4_users_app/appmap.yml
-- spec/fixtures/rails4_users_app/bin/rails
-- spec/fixtures/rails4_users_app/bin/setup
-- spec/fixtures/rails4_users_app/bin/spring
-- spec/fixtures/rails4_users_app/config.ru
-- spec/fixtures/rails4_users_app/config/application.rb
-- spec/fixtures/rails4_users_app/config/boot.rb
-- spec/fixtures/rails4_users_app/config/database.yml
-- spec/fixtures/rails4_users_app/config/environment.rb
-- spec/fixtures/rails4_users_app/config/environments/development.rb
-- spec/fixtures/rails4_users_app/config/environments/production.rb
-- spec/fixtures/rails4_users_app/config/environments/test.rb
-- spec/fixtures/rails4_users_app/config/initializers/assets.rb
-- spec/fixtures/rails4_users_app/config/initializers/backtrace_silencers.rb
-- spec/fixtures/rails4_users_app/config/initializers/cookies_serializer.rb
-- spec/fixtures/rails4_users_app/config/initializers/filter_parameter_logging.rb
-- spec/fixtures/rails4_users_app/config/initializers/inflections.rb
-- spec/fixtures/rails4_users_app/config/initializers/mime_types.rb
-- spec/fixtures/rails4_users_app/config/initializers/session_store.rb
-- spec/fixtures/rails4_users_app/config/initializers/to_time_preserves_timezone.rb
-- spec/fixtures/rails4_users_app/config/initializers/wrap_parameters.rb
-- spec/fixtures/rails4_users_app/config/locales/en.yml
-- spec/fixtures/rails4_users_app/config/routes.rb
-- spec/fixtures/rails4_users_app/config/secrets.yml
-- spec/fixtures/rails4_users_app/create_app
-- spec/fixtures/rails4_users_app/db/migrate/20191127112304_create_users.rb
-- spec/fixtures/rails4_users_app/db/schema.rb
-- spec/fixtures/rails4_users_app/db/seeds.rb
-- spec/fixtures/rails4_users_app/docker-compose.yml
-- spec/fixtures/rails4_users_app/lib/assets/.keep
-- spec/fixtures/rails4_users_app/lib/tasks/.keep
-- spec/fixtures/rails4_users_app/log/.keep
-- spec/fixtures/rails4_users_app/public/404.html
-- spec/fixtures/rails4_users_app/public/422.html
-- spec/fixtures/rails4_users_app/public/500.html
-- spec/fixtures/rails4_users_app/public/favicon.ico
-- spec/fixtures/rails4_users_app/public/robots.txt
-- spec/fixtures/rails4_users_app/spec/controllers/users_controller_api_spec.rb
-- spec/fixtures/rails4_users_app/spec/rails_helper.rb
-- spec/fixtures/rails4_users_app/spec/spec_helper.rb
-- spec/fixtures/rails4_users_app/test/fixtures/users.yml
 - spec/fixtures/rails5_users_app/.dockerignore
 - spec/fixtures/rails5_users_app/.gitignore
 - spec/fixtures/rails5_users_app/.rspec
@@ -608,7 +546,6 @@ files:
 - spec/open_spec.rb
 - spec/rails_spec_helper.rb
 - spec/railtie_spec.rb
-- spec/record_sql_rails4_pg_spec.rb
 - spec/record_sql_rails_pg_spec.rb
 - spec/remote_recording_spec.rb
 - spec/rspec_feature_metadata_spec.rb
@@ -636,7 +573,7 @@ files:
 - test/fixtures/cucumber_recorder/lib/hello.rb
 - test/fixtures/gem_test/Gemfile
 - test/fixtures/gem_test/appmap.yml
-- test/fixtures/gem_test/test/to_param_test.rb
+- test/fixtures/gem_test/test/parser_test.rb
 - test/fixtures/minitest_recorder/Gemfile
 - test/fixtures/minitest_recorder/appmap.yml
 - test/fixtures/minitest_recorder/lib/hello.rb