appmap 0.39.1 → 0.42.0

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/docker-compose.yml

@@ -19,6 +19,9 @@ services:
     environment:
       RAILS_ENV:
       ORM_MODULE:
+      PGHOST: pg
+      PGPORT: '5432'
+      DATABASE_URL: postgres://postgres@pg
       APPMAP:
     volumes:
     - .:/src/app

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

@@ -1,8 +1,8 @@
 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' }
@@ -16,7 +16,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

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/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/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/docker-compose.yml

@@ -19,6 +19,9 @@ services:
     environment:
       RAILS_ENV:
       ORM_MODULE:
+      PGHOST: pg
+      PGPORT: '5432'
+      DATABASE_URL: postgres://postgres@pg
       APPMAP:
     volumes:
     - .:/src/app

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

@@ -1,8 +1,8 @@
 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' }
@@ -16,7 +16,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

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

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
     ---
@@ -801,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/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/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/fixtures/rspec_recorder/spec/decorated_hello_spec.rb

@@ -2,7 +2,7 @@ require 'rspec'
 require 'appmap/rspec'
 require 'hello'
 
-describe Hello, feature_group: 'Saying hello' do
+describe Hello do
   before do
     # Trick appmap-ruby into thinking we're a Rails app.
     stub_const('Rails', double('rails', version: 'fake.0'))
@@ -11,11 +11,11 @@ describe Hello, feature_group: 'Saying hello' do
   # The order of these examples is important. The tests check the
   # appmap for 'says hello', and we want another example to get run
   # before it.
-  it 'does not say goodbye', feature: 'Speak hello', appmap: true do
+  it 'does not say goodbye' do
     expect(Hello.new.say_hello).not_to eq('Goodbye!')
   end
 
-  it 'says hello', feature: 'Speak hello', appmap: true do
+  it 'says hello' do
     expect(Hello.new.say_hello).to eq('Hello!')
   end
 end

data/test/fixtures/rspec_recorder/spec/plain_hello_spec.rb

@@ -2,7 +2,7 @@ require 'rspec'
 require 'appmap/rspec'
 require 'hello'
 
-describe Hello, appmap: true do
+describe Hello do
   it 'says hello' do
     expect(Hello.new.say_hello).to eq('Hello!')
   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

data/test/minitest_test.rb

@@ -30,9 +30,8 @@ class MinitestTest < Minitest::Test
       assert_equal 'minitest_recorder', metadata['app']
       assert_equal 'minitest', metadata['recorder']['name']
       assert_equal 'ruby', metadata['language']['name']
-      assert_equal 'Hello', metadata['feature_group']
-      assert_equal 'hello', metadata['feature']
       assert_equal 'Hello hello', metadata['name']
+      assert_equal 'test/hello_test.rb:9', metadata['source_location']
     end
   end
 end

data/test/rspec_test.rb

@@ -28,8 +28,6 @@ class RSpecTest < Minitest::Test
       assert_includes appmap.keys, 'metadata'
       metadata = appmap['metadata']
       assert_equal 'Inventory', metadata['name']
-      assert_includes metadata.keys, 'labels'
-      assert_equal metadata['labels'], %w[inventory]
     end
   end
 
@@ -42,9 +40,8 @@ class RSpecTest < Minitest::Test
       assert_equal AppMap::APPMAP_FORMAT_VERSION, appmap['version']
       assert_includes appmap.keys, 'metadata'
       metadata = appmap['metadata']
-      assert_equal 'Saying hello', metadata['feature_group']
-      assert_equal 'Speak hello', metadata['feature']
       assert_equal 'Hello says hello', metadata['name']
+      assert_equal 'spec/decorated_hello_spec.rb', metadata['source_location']
       assert_includes metadata.keys, 'client'
       assert_equal({ name: 'appmap', url: AppMap::URL, version: AppMap::VERSION }.stringify_keys, metadata['client'])
       assert_includes metadata.keys, 'recorder'
@@ -63,8 +60,6 @@ class RSpecTest < Minitest::Test
       appmap = JSON.parse(File.read(appmap_file))
       assert_includes appmap.keys, 'metadata'
       metadata = appmap['metadata']
-      assert_equal 'Hello', metadata['feature_group']
-      assert_equal 'Hello', metadata['feature']
       assert_equal 'Hello says hello', metadata['name']
     end
   end
@@ -76,7 +71,6 @@ class RSpecTest < Minitest::Test
       appmap = JSON.parse(File.read(appmap_file))
       assert_includes appmap.keys, 'metadata'
       metadata = appmap['metadata']
-      assert_equal %w[hello speak], metadata['labels'].sort
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.39.1
+  version: 0.42.0
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-22 00:00:00.000000000 Z
+date: 2021-03-25 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
@@ -385,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
@@ -545,7 +548,6 @@ files:
 - spec/railtie_spec.rb
 - spec/record_sql_rails_pg_spec.rb
 - spec/remote_recording_spec.rb
-- spec/rspec_feature_metadata_spec.rb
 - spec/spec_helper.rb
 - spec/util_spec.rb
 - test/cli_test.rb
@@ -570,7 +572,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

data/spec/rspec_feature_metadata_spec.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails_spec_helper'
-
-describe 'RSpec feature and feature group metadata' do
-  include_examples 'Rails app pg database', 'spec/fixtures/rails5_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).shellescape}:/app/tmp app ./bin/rspec spec/models/user_spec.rb"
-      run_cmd cmd, chdir: fixture_dir
-
-      example.run
-    end
-
-    let(:tmpdir) { 'tmp/spec/RSpec feature and feature group metadata' }
-    let(:appmap_json) { File.join(tmpdir, %(appmap/rspec/User_creation_creates_charles.appmap.json)) }
-
-    describe do
-      it '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(<<-METADATA.strip)
-  feature: Create a user
-  feature_group: User
-        METADATA
-      end
-    end
-  end
-end