appmap 0.35.0 → 0.37.2

data/lib/appmap/rails/request_handler.rb

@@ -14,7 +14,14 @@ module AppMap
 
           @request_method = request.request_method
           @path_info = request.path_info.split('?')[0]
-          @params = ActionDispatch::Http::ParameterFilter.new(::Rails.application.config.filter_parameters).filter(request.params)
+          # ActionDispatch::Http::ParameterFilter is deprecated
+          parameter_filter_cls = \
+            if defined?(ActiveSupport::ParameterFilter)
+              ActiveSupport::ParameterFilter
+            else
+              ActionDispatch::Http::ParameterFilter
+            end
+          @params = parameter_filter_cls.new(::Rails.application.config.filter_parameters).filter(request.params)
         end
 
         def to_h

data/lib/appmap/railtie.rb

@@ -40,4 +40,4 @@ module AppMap
       end.call
     end
   end
-end
+end unless ENV['APPMAP_INITIALIZE'] == 'false'

data/lib/appmap/rspec.rb

@@ -148,7 +148,7 @@ module AppMap
 
         AppMap::RSpec.add_event_methods @trace.event_methods
 
-        class_map = AppMap.class_map(@trace.event_methods)
+        class_map = AppMap.class_map(@trace.event_methods, include_source: false)
 
         description = []
         scope = ScopeExample.new(example)

data/lib/appmap/version.rb

@@ -3,7 +3,7 @@
 module AppMap
   URL = 'https://github.com/applandinc/appmap-ruby'
 
-  VERSION = '0.35.0'
+  VERSION = '0.37.2'
 
-  APPMAP_FORMAT_VERSION = '1.2'
+  APPMAP_FORMAT_VERSION = '1.3'
 end

data/spec/abstract_controller4_base_spec.rb

@@ -1,52 +1,50 @@
 require 'rails_spec_helper'
 
 describe 'AbstractControllerBase' do
-  before(:all) { @fixture_dir = 'spec/fixtures/rails4_users_app' }
-  include_examples 'Rails app pg database'
-  
-  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}:/app/tmp app ./bin/rspec spec/controllers/users_controller_api_spec.rb:8"
-    run_cmd cmd, chdir: @fixture_dir
+  include_context 'Rails app pg database', 'spec/fixtures/rails4_users_app' 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}:/app/tmp app ./bin/rspec spec/controllers/users_controller_api_spec.rb:8"
+      run_cmd cmd, chdir: fixture_dir
 
-    example.run
-  end
+      example.run
+    end
 
-  let(:tmpdir) { 'tmp/spec/AbstractControllerBase' }
-  let(:appmap_json) { File.join(tmpdir, 'appmap/rspec/Api_UsersController_POST_api_users_with_required_parameters_creates_a_user.appmap.json') }
+    let(:tmpdir) { 'tmp/spec/AbstractControllerBase' }
+    let(:appmap_json) { File.join(tmpdir, 'appmap/rspec/Api_UsersController_POST_api_users_with_required_parameters_creates_a_user.appmap.json') }
 
-  describe 'testing with rspec' do
-    it 'Message fields are recorded in the appmap' do
-      expect(File).to exist(appmap_json)
-      appmap = JSON.parse(File.read(appmap_json)).to_yaml
+    describe 'testing with rspec' do
+      it 'Message fields are recorded in the appmap' do
+        expect(File).to exist(appmap_json)
+        appmap = JSON.parse(File.read(appmap_json)).to_yaml
 
-      expect(appmap).to include(<<-MESSAGE.strip)
+        expect(appmap).to include(<<-MESSAGE.strip)
   message:
   - name: login
     class: String
     value: alice
     object_id:
-      MESSAGE
+        MESSAGE
 
-      expect(appmap).to include(<<-MESSAGE.strip)
+        expect(appmap).to include(<<-MESSAGE.strip)
   - name: password
     class: String
     value: "[FILTERED]"
     object_id:
-      MESSAGE
+       MESSAGE
 
-      expect(appmap).to include(<<-SERVER_REQUEST.strip)
+        expect(appmap).to include(<<-SERVER_REQUEST.strip)
   http_server_request:
     request_method: POST
     path_info: "/api/users"
-      SERVER_REQUEST
-    end
-    it 'Properly captures method parameters in the appmap' do
-      expect(File).to exist(appmap_json)
-      appmap = JSON.parse(File.read(appmap_json)).to_yaml
+        SERVER_REQUEST
+      end
+      it 'Properly captures method parameters in the appmap' do
+        expect(File).to exist(appmap_json)
+        appmap = JSON.parse(File.read(appmap_json)).to_yaml
 
-      expect(appmap).to match(<<-CREATE_CALL.strip)
+        expect(appmap).to match(<<-CREATE_CALL.strip)
   event: call
   thread_id: .*
   defined_class: Api::UsersController
@@ -61,7 +59,8 @@ describe 'AbstractControllerBase' do
     value: '{"login"=>"alice"}'
     kind: req
   receiver:
-      CREATE_CALL
+        CREATE_CALL
+      end
     end
   end
 end

data/spec/abstract_controller_base_spec.rb

@@ -1,63 +1,62 @@
 require 'rails_spec_helper'
 
 describe 'AbstractControllerBase' do
-  before(:all) { @fixture_dir = 'spec/fixtures/rails_users_app' }
-  include_context 'Rails app pg database'
+  shared_examples 'rails version' do |rails_major_version|
+    include_context 'Rails app pg database', "spec/fixtures/rails#{rails_major_version}_users_app" 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}:/app/tmp app ./bin/rspec spec/controllers/users_controller_api_spec.rb:8"
+        run_cmd cmd, chdir: fixture_dir
 
-  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}:/app/tmp app ./bin/rspec spec/controllers/users_controller_api_spec.rb:8"
-    run_cmd cmd, chdir: @fixture_dir
+        example.run
+      end
 
-    example.run
-  end
-
-  let(:tmpdir) { 'tmp/spec/AbstractControllerBase' }
-  let(:appmap_json) { File.join(tmpdir, 'appmap/rspec/Api_UsersController_POST_api_users_with_required_parameters_creates_a_user.appmap.json') }
+      let(:tmpdir) { 'tmp/spec/AbstractControllerBase' }
+      let(:appmap_json) { File.join(tmpdir, 'appmap/rspec/Api_UsersController_POST_api_users_with_required_parameters_creates_a_user.appmap.json') }
 
-  describe 'testing with rspec' do
-    it 'inventory file is printed' do
-      expect(File).to exist(File.join(tmpdir, 'appmap/rspec/Inventory.appmap.json'))
-    end
+      describe 'testing with rspec' do
+        it 'inventory file is printed' do
+          expect(File).to exist(File.join(tmpdir, 'appmap/rspec/Inventory.appmap.json'))
+        end
 
-    it 'message fields are recorded in the appmap' do
-      expect(File).to exist(appmap_json)
-      appmap = JSON.parse(File.read(appmap_json)).to_yaml
+        it 'message fields are recorded in the appmap' do
+          expect(File).to exist(appmap_json)
+          appmap = JSON.parse(File.read(appmap_json)).to_yaml
 
-      expect(appmap).to include(<<-MESSAGE.strip)
+          expect(appmap).to include(<<-MESSAGE.strip)
   message:
   - name: login
     class: String
     value: alice
     object_id:
-      MESSAGE
+          MESSAGE
 
-      expect(appmap).to include(<<-MESSAGE.strip)
+          expect(appmap).to include(<<-MESSAGE.strip)
   - name: password
     class: String
     value: "[FILTERED]"
     object_id:
-      MESSAGE
+          MESSAGE
 
-      expect(appmap).to include(<<-SERVER_REQUEST.strip)
+          expect(appmap).to include(<<-SERVER_REQUEST.strip)
   http_server_request:
     request_method: POST
     path_info: "/api/users"
-      SERVER_REQUEST
+          SERVER_REQUEST
 
-      expect(appmap).to include(<<-SERVER_RESPONSE.strip)
+          expect(appmap).to include(<<-SERVER_RESPONSE.strip)
   http_server_response:
     status: 201
     mime_type: application/json; charset=utf-8
-      SERVER_RESPONSE
-    end
+          SERVER_RESPONSE
+        end
 
-    it 'properly captures method parameters in the appmap' do
-      expect(File).to exist(appmap_json)
-      appmap = JSON.parse(File.read(appmap_json)).to_yaml
+        it 'properly captures method parameters in the appmap' do
+          expect(File).to exist(appmap_json)
+          appmap = JSON.parse(File.read(appmap_json)).to_yaml
 
-      expect(appmap).to match(<<-CREATE_CALL.strip)
+          expect(appmap).to match(<<-CREATE_CALL.strip)
   event: call
   thread_id: .*
   defined_class: Api::UsersController
@@ -72,14 +71,19 @@ describe 'AbstractControllerBase' do
     value: '{"login"=>"alice"}'
     kind: req
   receiver:
-      CREATE_CALL
-    end
+          CREATE_CALL
+        end
 
-    it 'returns a minimal event' do
-      expect(File).to exist(appmap_json)
-      appmap = JSON.parse(File.read(appmap_json))
-      event = appmap['events'].find { |event| event['event'] == 'return' && event['return_value'] }
-      expect(event.keys).to eq(%w[id event thread_id parent_id elapsed return_value])
+        it 'returns a minimal event' do
+          expect(File).to exist(appmap_json)
+          appmap = JSON.parse(File.read(appmap_json))
+          event = appmap['events'].find { |event| event['event'] == 'return' && event['return_value'] }
+          expect(event.keys).to eq(%w[id event thread_id parent_id elapsed return_value])
+        end
+      end
     end
   end
+
+  it_behaves_like 'rails version', '5'
+  it_behaves_like 'rails version', '6'
 end

data/spec/class_map_spec.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+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))])
+      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)
+    end
+
+    # test method comment
+    def test_method
+      'test method body'
+    end
+
+    def scoped_method(method)
+      AppMap::Trace::ScopedMethod.new AppMap::Config::Package.new, method.receiver.class.name, method, false
+    end
+
+    def dig_map(map, depth)
+      return map if depth == 0
+
+      dig_map map[0][:children], depth - 1
+    end
+  end
+end

data/spec/fixtures/hook/exception_method.rb

@@ -9,3 +9,47 @@ class ExceptionMethod
     raise 'Exception occurred in raise_exception'
   end
 end
+
+# subclass from BasicObject so we don't get #to_s. Requires some
+# hackery to implement the other methods normally provided by Object.
+class NoToSMethod < BasicObject
+  def is_a?(*args)
+    return false
+  end
+
+  def class
+    return ::Class
+  end
+
+  def respond_to?(*args)
+    return false
+  end
+
+  def inspect
+    "NoToSMethod"
+  end
+
+  def say_hello
+    "hello"
+  end
+end
+
+class InspectRaises < NoToSMethod
+  def inspect
+    ::Kernel.raise "#to_s missing, #inspect raises"
+  end
+
+  def say_hello
+    "hello"
+  end
+end
+
+class ToSRaises
+  def to_s
+    raise "#to_s raises"
+  end
+
+  def say_hello
+    "hello"
+  end
+end

data/spec/fixtures/hook/instance_method.rb

@@ -17,6 +17,10 @@ class InstanceMethod
     kw.to_s
   end
 
+  def say_kws(*args, kw1:, kw2: 'kw2', **kws)
+    [kw1, kw2, kws, args].join
+  end
+
   def say_block(&block)
     yield
   end

data/spec/fixtures/rails5_users_app/Gemfile

@@ -0,0 +1,51 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+gem 'rails', '~> 6'
+
+gem 'haml-rails'
+
+gem 'activerecord', require: false
+gem 'pg'
+gem 'sequel', '= 5.20.0', require: false
+gem 'sequel-rails', require: false
+gem 'sequel_secure_password', require: false
+
+appmap_path = \
+  # Support debugging inside the container with volume-mounted source
+  if File.directory?('/src/appmap-ruby')
+    '/src/appmap-ruby'
+  elsif File.exist?('../../../appmap.gemspec')
+    '../../..'
+  end
+
+if appmap_path
+  # Set the branch parameter, so that 'bundle config local.appmap' will work
+  appmap_branch = Dir.chdir appmap_path do
+    `git rev-parse --abbrev-ref HEAD`.strip
+  end
+end
+
+appmap_options = \
+  if appmap_path && appmap_branch
+    { git: appmap_path, branch: appmap_branch }
+  elsif appmap_path
+    { path: appmap_path }
+  else
+    {}
+  end.merge(require: %w[appmap appmap/railtie])
+
+gem 'appmap', appmap_options
+
+group :development, :test do
+  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 :development do
+end

data/spec/fixtures/{rails_users_app → rails5_users_app}/appmap.yml

@@ -1,3 +1,3 @@
-name: rails_users_app
+name: rails5_users_app
 packages:
   - path: app