appmap 0.41.2 → 0.45.0

data/spec/class_map_spec.rb

@@ -4,18 +4,10 @@ require 'spec_helper'
 
 describe 'AppMap::ClassMap' do
   describe '.build_from_methods' do
-    it 'includes source code if available' do
-      map = AppMap.class_map([scoped_method(method(:test_method))])
+    it 'includes method comment' do
+      map = AppMap.class_map([scoped_method((method :test_method))])
       function = dig_map(map, 5)[0]
-      expect(function[:source]).to include 'test method body'
-      expect(function[:comment]).to include 'test method comment'
-    end
-
-    it 'can omit source code even if available' do
-      map = AppMap.class_map([scoped_method((method :test_method))], include_source: false)
-      function = dig_map(map, 5)[0]
-      expect(function).to_not include(:source)
-      expect(function).to_not include(:comment)
+      expect(function).to include(:comment)
     end
 
     # test method comment

data/spec/config_spec.rb

@@ -17,10 +17,42 @@ describe AppMap::Config, docker: false do
           path: 'path-2',
           exclude: [ 'exclude-1' ]
         }
+      ],
+      functions: [
+        {
+          package: 'pkg',
+          class: 'cls',
+          function: 'fn',
+          label: 'lbl'
+        }
       ]
     }.deep_stringify_keys!
     config = AppMap::Config.load(config_data)
 
-    expect(config.to_h.deep_stringify_keys!).to eq(config_data)
+    config_expectation = {
+      exclude: [],
+      name: 'test',
+      packages: [
+        {
+          path: 'path-1',
+          handler_class: 'AppMap::Handler::Function'
+        },
+        {
+          path: 'path-2',
+          handler_class: 'AppMap::Handler::Function',
+          exclude: [ 'exclude-1' ]
+        }
+      ],
+      functions: [
+        {
+          package: 'pkg',
+          class: 'cls',
+          functions: [ :fn ],
+          labels: ['lbl']
+        }
+      ]
+    }.deep_stringify_keys!
+
+    expect(config.to_h.deep_stringify_keys!).to eq(config_expectation)
   end
 end

data/spec/fixtures/hook/custom_instance_method.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class CustomInstanceMethod
+  def to_s
+    'CustomInstance Method fixture'
+  end
+
+  def say_default
+    'default'
+  end
+end

data/spec/fixtures/hook/method_named_call.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class MethodNamedCall
+  def to_s
+    'MethodNamedCall'
+  end
+
+  def call(a, b, c, d, e)
+    [ a, b, c, d, e ].join(' ')
+  end
+end

data/spec/fixtures/rails5_users_app/Gemfile

@@ -39,12 +39,16 @@ 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
-  # isn't activated.
-  gem 'database_cleaner'
   # Call 'byebug' anywhere in the code to stop execution and get a debugger console
   gem 'pry-byebug'
 end
 
+group :test do
+  # Require only one of these.
+  # 'database_cleaner' requries 'database_cleaner-active_record', so don't require it.
+  gem 'database_cleaner-active_record', require: false
+  gem 'database_cleaner-sequel', require: false
+end
+
 group :development do
 end

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

@@ -6,6 +6,8 @@ module Api
     end
 
     def create
+      params = self.params.key?(:user) ? self.params[:user] : self.params
+      
       @user = build_user(params.slice(:login).to_unsafe_h)
       unless @user.valid?
         error = {

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

@@ -4,7 +4,15 @@ class UsersController < ApplicationController
   end
 
   def show
-    if (@user = User[login: params[:id]])
+    find_user = lambda do |id|
+      if User.respond_to?(:[])
+        User[login: id]
+      else
+        User.find_by_login!(id)
+      end
+    end
+
+    if (@user = find_user.(params[:id]))
       render plain: @user
     else
       render plain: 'Not found', status: 404

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

@@ -15,8 +15,10 @@ case orm_module
 when 'sequel'
   require 'sequel-rails'
   require 'sequel_secure_password'
+  require 'database_cleaner-sequel' if Rails.env.test?
 when 'activerecord'
   require 'active_record/railtie'
+  require 'database_cleaner-active_record' if Rails.env.test?
 end
 
 require 'appmap/railtie' if defined?(AppMap)

data/spec/fixtures/rails5_users_app/create_app

@@ -16,11 +16,17 @@ if [[ $? != 0 ]]; then
    exit 1
 fi
 
-psql -h pg -U postgres -c "create database app_development"
-psql -h pg -U postgres -c "create database app_test"
+# Required for migrations
+export ORM_MODULE=sequel
 
+set +e
+psql -h pg -U postgres -c "drop database if exists app_development"
+psql -h pg -U postgres -c "drop database if exists app_test"
 set -e
 
+psql -h pg -U postgres -c "create database app_development"
+psql -h pg -U postgres -c "create database app_test"
+
 RAILS_ENV=development ./bin/rake db:migrate
 RAILS_ENV=test ./bin/rake db:migrate
 

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

@@ -1,13 +1,19 @@
 require 'rails_helper'
 require 'rack/test'
 
-RSpec.describe Api::UsersController, feature_group: 'Users', type: :controller, appmap: true do
-  describe 'POST /api/users', feature: 'Create a user' do
+RSpec.describe Api::UsersController, type: :controller do
+  describe 'POST /api/users' do
     describe 'with required parameters' do
       it 'creates a user' do
         post :create, params: { login: 'alice', password: 'foobar' }
         expect(response.status).to eq(201)
       end
+      describe 'with object-style parameters' do
+        it 'creates a user' do
+          post :create, params: { user: { login: 'alice', password: 'foobar' } }
+          expect(response.status).to eq(201)
+        end
+      end
     end
     describe 'with a missing parameter' do
       it 'reports error 422' do
@@ -16,7 +22,7 @@ RSpec.describe Api::UsersController, feature_group: 'Users', type: :controller,
       end
     end
   end
-  describe 'GET /api/users', feature: 'List users' do
+  describe 'GET /api/users' do
     before do
       post :create, params: { login: 'alice' }
     end
@@ -25,5 +31,12 @@ RSpec.describe Api::UsersController, feature_group: 'Users', type: :controller,
       users = JSON.parse(response.body)
       expect(users.map { |r| r['login'] }).to include('alice')
     end
+    describe 'with a custom header' do
+      it 'lists the users' do
+        request.headers['X-Sandwich'] = 'turkey'
+        get :index, params: {}
+        expect(response.status).to eq(200)
+      end
+    end
   end
 end

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

@@ -4,7 +4,7 @@ require 'rack/test'
 RSpec.describe UsersController, type: :controller do
   render_views
 
-  describe 'GET /users', feature: 'Show all users' do
+  describe 'GET /users' do
     before do
       User.create login: 'alice'
     end
@@ -14,7 +14,7 @@ RSpec.describe UsersController, type: :controller do
     end
   end
 
-  describe 'GET /users/:login', feature: 'Show a user' do
+  describe 'GET /users/:login' do
     before do
       User.create login: 'alice'
     end

data/spec/fixtures/rails5_users_app/spec/models/user_spec.rb

@@ -1,6 +1,6 @@
 require 'rails_helper'
 
-describe User, feature_group: 'User', appmap: true do
+describe User do
   # TODO: appmap/rspec doesn't handle shared_examples_for 100% correctly yet.
   # In my tests, only one of these two tests will be emitted as an appmap.
   shared_examples_for 'creates the user' do |username|
@@ -11,17 +11,7 @@ describe User, feature_group: 'User', appmap: true do
     end
   end
 
-  describe 'creation', feature: 'Create a user' do
-    context 'using shared_examples_for' do
-      # AppMap.
-#      context "with username 'alice'" do
-#        it_should_behave_like 'creates the user', 'alice'
-#      end
-#      context "with username 'bob'" do
-#        it_should_behave_like 'creates the user', 'bob'
-#      end
-    end
-
+  describe 'creation' do
     # So, instead of shared_examples_for, let's go with a simple method
     # containing the assertions. The method can be called from within an example.
     def save_and_verify

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

@@ -45,7 +45,6 @@ RSpec.configure do |config|
   # arbitrary gems may also be filtered via:
   # config.filter_gems_from_backtrace("gem name")
 
-
   DatabaseCleaner.allow_remote_database_url = true
   
   config.before(:suite) do
@@ -54,13 +53,8 @@ RSpec.configure do |config|
   end
 
   config.around :each do |example|
-    # Enable the use of 'return' from a guard
-    -> {
-      return example.run unless %i[model controller].member?(example.metadata[:type])
-
-      DatabaseCleaner.cleaning do
-        example.run
-      end
-    }.call
+    DatabaseCleaner.cleaning do
+      example.run
+    end
   end
 end

data/spec/fixtures/rails6_users_app/Gemfile

@@ -1,7 +1,6 @@
 source 'https://rubygems.org'
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
 gem 'rails', '~> 6'
 
 gem 'haml-rails'
@@ -40,12 +39,14 @@ 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
-  # isn't activated.
-  gem 'database_cleaner'
   # Call 'byebug' anywhere in the code to stop execution and get a debugger console
   gem 'pry-byebug'
 end
 
+group :test do
+  gem 'database_cleaner-active_record', require: false
+  gem 'database_cleaner-sequel', require: false
+end
+
 group :development do
 end

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

@@ -6,6 +6,7 @@ module Api
     end
 
     def create
+      params = self.params.key?(:user) ? self.params[:user] : self.params
       @user = build_user(params.slice(:login).to_unsafe_h)
       unless @user.valid?
         error = {

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

@@ -4,7 +4,15 @@ class UsersController < ApplicationController
   end
 
   def show
-    if (@user = User[login: params[:id]])
+    find_user = lambda do |id|
+      if User.respond_to?(:[])
+        User[login: id]
+      else
+        User.find_by_login!(id)
+      end
+    end
+
+    if (@user = find_user.(params[:id]))
       render plain: @user
     else
       render plain: 'Not found', status: 404

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

@@ -15,8 +15,10 @@ case orm_module
 when 'sequel'
   require 'sequel-rails'
   require 'sequel_secure_password'
+  require 'database_cleaner-sequel' if Rails.env.test?
 when 'activerecord'
   require 'active_record/railtie'
+  require 'database_cleaner-active_record' if Rails.env.test?
 end
 
 require 'appmap/railtie' if defined?(AppMap)

data/spec/fixtures/rails6_users_app/create_app

@@ -16,11 +16,17 @@ if [[ $? != 0 ]]; then
    exit 1
 fi
 
-psql -h pg -U postgres -c "create database app_development"
-psql -h pg -U postgres -c "create database app_test"
+# Required for migrations
+export ORM_MODULE=sequel
 
+set +e
+psql -h pg -U postgres -c "drop database if exists app_development"
+psql -h pg -U postgres -c "drop database if exists app_test"
 set -e
 
+psql -h pg -U postgres -c "create database app_development"
+psql -h pg -U postgres -c "create database app_test"
+
 RAILS_ENV=development ./bin/rake db:migrate
 RAILS_ENV=test ./bin/rake db:migrate
 

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

@@ -1,13 +1,19 @@
 require 'rails_helper'
 require 'rack/test'
 
-RSpec.describe Api::UsersController, feature_group: 'Users', type: :controller, appmap: true do
-  describe 'POST /api/users', feature: 'Create a user' do
+RSpec.describe Api::UsersController, type: :controller do
+  describe 'POST /api/users' do
     describe 'with required parameters' do
       it 'creates a user' do
         post :create, params: { login: 'alice', password: 'foobar' }
         expect(response.status).to eq(201)
       end
+      describe 'with object-style parameters' do
+        it 'creates a user' do
+          post :create, params: { user: { login: 'alice', password: 'foobar' } }
+          expect(response.status).to eq(201)
+        end
+      end
     end
     describe 'with a missing parameter' do
       it 'reports error 422' do
@@ -16,7 +22,7 @@ RSpec.describe Api::UsersController, feature_group: 'Users', type: :controller,
       end
     end
   end
-  describe 'GET /api/users', feature: 'List users' do
+  describe 'GET /api/users' do
     before do
       post :create, params: { login: 'alice' }
     end
@@ -25,5 +31,12 @@ RSpec.describe Api::UsersController, feature_group: 'Users', type: :controller,
       users = JSON.parse(response.body)
       expect(users.map { |r| r['login'] }).to include('alice')
     end
+    describe 'with a custom header' do
+      it 'lists the users' do
+        request.headers['X-Sandwich'] = 'turkey'
+        get :index, params: {}
+        expect(response.status).to eq(200)
+      end
+    end
   end
 end

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

@@ -4,7 +4,7 @@ require 'rack/test'
 RSpec.describe UsersController, type: :controller do
   render_views
 
-  describe 'GET /users', feature: 'Show all users' do
+  describe 'GET /users' do
     before do
       User.create login: 'alice'
     end
@@ -14,7 +14,7 @@ RSpec.describe UsersController, type: :controller do
     end
   end
 
-  describe 'GET /users/:login', feature: 'Show a user' do
+  describe 'GET /users/:login' do
     before do
       User.create login: 'alice'
     end

data/spec/fixtures/rails6_users_app/spec/models/user_spec.rb

@@ -1,6 +1,6 @@
 require 'rails_helper'
 
-describe User, feature_group: 'User', appmap: true do
+describe User  do
   # TODO: appmap/rspec doesn't handle shared_examples_for 100% correctly yet.
   # In my tests, only one of these two tests will be emitted as an appmap.
   shared_examples_for 'creates the user' do |username|
@@ -11,17 +11,7 @@ describe User, feature_group: 'User', appmap: true do
     end
   end
 
-  describe 'creation', feature: 'Create a user' do
-    context 'using shared_examples_for' do
-      # AppMap.
-#      context "with username 'alice'" do
-#        it_should_behave_like 'creates the user', 'alice'
-#      end
-#      context "with username 'bob'" do
-#        it_should_behave_like 'creates the user', 'bob'
-#      end
-    end
-
+  describe 'creation' do
     # So, instead of shared_examples_for, let's go with a simple method
     # containing the assertions. The method can be called from within an example.
     def save_and_verify