appmap 0.37.0 → 0.37.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fba24ecdb42c951741292378419eef430a56cc16816df46a14b2ae3e318f8f94
-  data.tar.gz: 67ff27467f72322c5a8514c90b0a6039e3fd1268dba103dea3b832eda95ac317
+  metadata.gz: 0211b21334945f6786d150fdf1a0dea8a062cbc2d59c4b347f72555232ec6480
+  data.tar.gz: ac2785471ed35210ba1c3801e8a7d186adb99d9b9369c24eb2c9f4d41a352e33
 SHA512:
-  metadata.gz: 1823304c2733b46470481fd731a1f4650a80e769d96b47dbcdb0e5763e59930d6754068b4cf0729f9f748c55109575f3c8146b09030741fccfafd06cd45669b9
-  data.tar.gz: bbebe31041ed1720dc54b9522e4c6baac3b27d8d77be0622315657d0fa5b355c3e12474aa756811a6d747b563999c6e76206805c1392a015f92c6b863e8eeda0
+  metadata.gz: d5049f8c464b5f6e6afd7567fcfe62d481c70b7db6d473f93a832763e4352c04b6d2cff3d3d03a452f82033f4220cb821f36152c003794c7adba89432a2b513a
+  data.tar.gz: 631f8ab86e132e45c1b95b667d7789b870eab393293d62c7e1f77daf3cf3f9a5c7174e913fa0bc20ec92a87f88f278bee69f41c6b2c14d166b1745df71321d0b

data/.dockerignore

@@ -1,5 +1,5 @@
 vendor
 node_modules
-spec/fixtures/rails_users_app
+spec/fixtures/rails*_users_app
 spec/fixtures/rack_users_app
 

data/.rubocop.yml

@@ -1,6 +1,9 @@
 AllCops:
   NewCops: enable
 
+Layout/CaseIndentation:
+  EnforcedStyle: end
+
 Layout/SpaceInsideArrayLiteralBrackets:
   Enabled: false
 
@@ -11,6 +14,10 @@ Layout/HeredocIndentation:
 Layout/LineLength:
   Max: 120
 
+Metrics/BlockLength:
+  ExcludedMethods:
+  - it
+
 Style/MultilineBlockChain:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# v0.37.2
+* Fix ParameterFilter deprecation warning.
+
+# v0.37.1
+* Fix parameter mapping with keyword and rest arguments.
+
 # v0.37.0
 * Capture method source and comment.
 

data/Rakefile

@@ -19,7 +19,7 @@ namespace 'gem' do
 end
 
 RUBY_VERSIONS=%w[2.5 2.6]
-FIXTURE_APPS=%w[rack_users_app rails_users_app rails4_users_app]
+FIXTURE_APPS=%w[rack_users_app rails6_users_app rails5_users_app rails4_users_app]
 
 def run_cmd(*cmd)
   $stderr.puts "Running: #{cmd}"

data/lib/appmap/event.rb

@@ -89,10 +89,25 @@ module AppMap
             else
               mc.path = [ defined_class, static ? '.' : '#', method.name ].join
             end
+
+            # Check if the method has key parameters. If there are any they'll always be last.
+            # If yes, then extract it from arguments.
+            has_key = [[:dummy], *method.parameters].last.first.to_s.start_with?('key') && arguments[-1].is_a?(Hash)
+            kwargs = has_key && arguments[-1].dup || {}
+
             mc.parameters = method.parameters.map.with_index do |method_param, idx|
               param_type, param_name = method_param
               param_name ||= 'arg'
-              value = arguments[idx]
+              value = case param_type
+                when :keyrest
+                  kwargs
+                when /^key/
+                  kwargs.delete param_name
+                when :rest
+                  arguments[idx..(has_key ? -2 : -1)]
+                else
+                  arguments[idx]
+                end
               {
                 name: param_name,
                 class: value.class.name,

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/version.rb

@@ -3,7 +3,7 @@
 module AppMap
   URL = 'https://github.com/applandinc/appmap-ruby'
 
-  VERSION = '0.37.0'
+  VERSION = '0.37.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/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