appmap 0.35.2 → 0.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e7d5c58bd3addf395c32591fe468c4a0b0e886d715cb711ffb6c898049455e5
-  data.tar.gz: 271ac50ee1ebe139ed8e52262a98a13e6b3d471ddcab49316669e66d0b7be57a
+  metadata.gz: 102dab80f2d8cffd51fd1377583a1b063078cd77ab7ad4ffdcd20867a084b11b
+  data.tar.gz: cbb87144593416f84099cf8a9d8ac18f18d9763dce28277320ae6a99ff59ec58
 SHA512:
-  metadata.gz: b84b1d76d8890a72fb376e95c7ab3811814b75e99304d2f1c15bb091cba1aef1e81f7688fd69c35b8c7735fd72167f89c67eeb25f76e54253503be610fff52cc
-  data.tar.gz: 12b27887ae25d8f91fa6321ea59c222c7ec7d1e2d6a198f6672fa166fcd3c32456fe0d3969dda729d4c4817129a3eb874f8bae0afb5dca6b74253ccf457bd51b
+  metadata.gz: a24e2ecb22a654d11e91ef28a7fdd961c178144f474a36e26c70e8e243bac18c13e3c5ff606f5ed2a058ddf6d98f9dbd0678a0f986ddfae4f18ed7524c27d41d
+  data.tar.gz: 712cb7e18026aa80135af7ce54a7a8c412362355c0eb6b151a0f05354cf991ebe9402e298d9646b9fab2e5d673d3338a773a0b1b1d0e1846ec3ed970074a1f77

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# v0.36.0
+* *appmap.yml* package definition may specify `gem`.
+* Skip loading the railtie if `APPMAP_INITIALIZE` environment variable
+  is set to `false`.
+
 # v0.35.2
 * Make sure `MethodEvent#display_string` works when the value's `#to_s` and/or `#inspect`
   methods have problems.

data/README.md

@@ -76,6 +76,7 @@ name: MyProject
 packages:
 - path: app/controllers
 - path: app/models
+- gem: activerecord
 ```
 
 * **name** Provides the project name (required)
@@ -87,6 +88,7 @@ Each entry in the `packages` list is a YAML object which has the following keys:
 
 * **path** The path to the source code directory. The path may be relative to the current working directory, or it may
   be an absolute path.
+* **gem** As an alternative to specifying the path, specify the name of a dependency gem. When using `gem`, don't specify `path`.
 * **exclude** A list of files and directories which will be ignored. By default, all modules, classes and public
   functions are inspected.
 

data/Rakefile

@@ -113,7 +113,7 @@ namespace :spec do
     desc ruby_version
     task ruby_version, [:specs] => ["compile", "build:fixtures:#{ruby_version}:all"] do |_, task_args|
       run_specs(ruby_version, task_args)
-    end.tap do|t|
+    end.tap do |t|
       desc "Run all specs"
       task :all, [:specs] => t
     end

data/appmap.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'parser'
   spec.add_dependency 'rack'
 
-  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'bundler', '>= 1.16'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'pry-byebug'
   spec.add_development_dependency 'rake', '>= 12.3.3'

data/appmap.yml

@@ -1,8 +1,2 @@
 name: AppMap Rubygem
-packages:
-  - path: lib/appmap
-    exclude:
-      - server
-      - trace
-
-  - path: examples
+packages: []

data/lib/appmap/class_map.rb

@@ -83,7 +83,7 @@ module AppMap
 
         object_infos = [
           {
-            name: package.path,
+            name: package.name,
             type: 'package'
           }
         ]

data/lib/appmap/config.rb

@@ -2,15 +2,39 @@
 
 module AppMap
   class Config
-    Package = Struct.new(:path, :package_name, :exclude, :labels) do
-      def initialize(path, package_name: nil, exclude: [], labels: [])
-        super path, package_name, exclude, labels
+    Package = Struct.new(:path, :gem, :package_name, :exclude, :labels) do
+      class << self
+        def build_from_path(path, package_name: nil, exclude: [], labels: [])
+          Package.new(path, nil, package_name, exclude, labels)
+        end
+
+        def build_from_gem(gem, package_name: nil, exclude: [], labels: [])
+          gem_paths(gem).map do |gem_path|
+            Package.new(gem_path, gem, package_name, exclude, labels)
+          end
+        end
+
+        private_class_method :new
+
+        protected
+
+        def gem_paths(gem)
+          gemspec = Gem.loaded_specs[gem] or raise "Gem #{gem.inspect} not found"
+          gemspec.source_paths.map do |path|
+            File.join(gemspec.gem_dir, path)
+          end
+        end
+      end
+
+      def name
+        gem || path
       end
 
       def to_h
         {
           path: path,
           package_name: package_name,
+          gem: gem,
           exclude: exclude.blank? ? nil : exclude,
           labels: labels.blank? ? nil : labels
         }.compact
@@ -20,29 +44,29 @@ module AppMap
     Hook = Struct.new(:method_names, :package) do
     end
 
-    OPENSSL_PACKAGE = Package.new('openssl', package_name: 'openssl', labels: %w[security crypto])
+    OPENSSL_PACKAGES = Package.build_from_path('openssl', package_name: 'openssl', labels: %w[security crypto])
 
     # Methods that should always be hooked, with their containing
     # package and labels that should be applied to them.
     HOOKED_METHODS = {
-      'ActiveSupport::SecurityUtils' => Hook.new(:secure_compare, Package.new('active_support', package_name: 'active_support', labels: %w[security crypto]))
+      'ActiveSupport::SecurityUtils' => Hook.new(:secure_compare, Package.build_from_path('active_support', package_name: 'active_support', labels: %w[security crypto]))
     }.freeze
 
     BUILTIN_METHODS = {
-      'OpenSSL::PKey::PKey' => Hook.new(:sign, OPENSSL_PACKAGE),
-      'Digest::Instance' => Hook.new(:digest, OPENSSL_PACKAGE),
-      'OpenSSL::X509::Request' => Hook.new(%i[sign verify], OPENSSL_PACKAGE),
-      'OpenSSL::PKCS5' => Hook.new(%i[pbkdf2_hmac_sha1 pbkdf2_hmac], OPENSSL_PACKAGE),
-      'OpenSSL::Cipher' => Hook.new(%i[encrypt decrypt final], OPENSSL_PACKAGE),
-      'OpenSSL::X509::Certificate' => Hook.new(:sign, OPENSSL_PACKAGE),
-      'Net::HTTP' => Hook.new(:request, Package.new('net/http', package_name: 'net/http', labels: %w[http io])),
-      'Net::SMTP' => Hook.new(:send, Package.new('net/smtp', package_name: 'net/smtp', labels: %w[smtp email io])),
-      'Net::POP3' => Hook.new(:mails, Package.new('net/pop3', package_name: 'net/pop', labels: %w[pop pop3 email io])),
-      'Net::IMAP' => Hook.new(:send_command, Package.new('net/imap', package_name: 'net/imap', labels: %w[imap email io])),
-      'Marshal' => Hook.new(%i[dump load], Package.new('marshal', labels: %w[serialization marshal])),
-      'Psych' => Hook.new(%i[dump dump_stream load load_stream parse parse_stream], Package.new('yaml', package_name: 'psych', labels: %w[serialization yaml])),
-      'JSON::Ext::Parser' => Hook.new(:parse, Package.new('json', package_name: 'json', labels: %w[serialization json])),
-      'JSON::Ext::Generator::State' => Hook.new(:generate, Package.new('json', package_name: 'json', labels: %w[serialization json]))
+      'OpenSSL::PKey::PKey' => Hook.new(:sign, OPENSSL_PACKAGES),
+      'Digest::Instance' => Hook.new(:digest, OPENSSL_PACKAGES),
+      'OpenSSL::X509::Request' => Hook.new(%i[sign verify], OPENSSL_PACKAGES),
+      'OpenSSL::PKCS5' => Hook.new(%i[pbkdf2_hmac_sha1 pbkdf2_hmac], OPENSSL_PACKAGES),
+      'OpenSSL::Cipher' => Hook.new(%i[encrypt decrypt final], OPENSSL_PACKAGES),
+      'OpenSSL::X509::Certificate' => Hook.new(:sign, OPENSSL_PACKAGES),
+      'Net::HTTP' => Hook.new(:request, Package.build_from_path('net/http', package_name: 'net/http', labels: %w[http io])),
+      'Net::SMTP' => Hook.new(:send, Package.build_from_path('net/smtp', package_name: 'net/smtp', labels: %w[smtp email io])),
+      'Net::POP3' => Hook.new(:mails, Package.build_from_path('net/pop3', package_name: 'net/pop', labels: %w[pop pop3 email io])),
+      'Net::IMAP' => Hook.new(:send_command, Package.build_from_path('net/imap', package_name: 'net/imap', labels: %w[imap email io])),
+      'Marshal' => Hook.new(%i[dump load], Package.build_from_path('marshal', labels: %w[serialization marshal])),
+      'Psych' => Hook.new(%i[dump dump_stream load load_stream parse parse_stream], Package.build_from_path('yaml', package_name: 'psych', labels: %w[serialization yaml])),
+      'JSON::Ext::Parser' => Hook.new(:parse, Package.build_from_path('json', package_name: 'json', labels: %w[serialization json])),
+      'JSON::Ext::Generator::State' => Hook.new(:generate, Package.build_from_path('json', package_name: 'json', labels: %w[serialization json]))
     }.freeze
 
     attr_reader :name, :packages
@@ -62,8 +86,16 @@ module AppMap
       # Loads configuration from a Hash.
       def load(config_data)
         packages = (config_data['packages'] || []).map do |package|
-          Package.new(package['path'], exclude: package['exclude'] || [])
-        end
+          gem = package['gem']
+          path = package['path']
+          raise 'AppMap package configuration should specify gem or path, not both' if gem && path
+
+          if gem
+            Package.build_from_gem(gem, exclude: package['exclude'] || [])
+          else
+            [ Package.build_from_path(path, exclude: package['exclude'] || []) ]
+          end
+        end.flatten
         Config.new config_data['name'], packages
       end
     end

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

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

data/spec/hook_spec.rb

@@ -27,7 +27,7 @@ describe 'AppMap class Hooking', docker: false do
 
   def invoke_test_file(file, setup: nil, &block)
     AppMap.configuration = nil
-    package = AppMap::Config::Package.new(file)
+    package = AppMap::Config::Package.build_from_path(file)
     config = AppMap::Config.new('hook_spec', [ package ])
     AppMap.configuration = config
     tracer = nil

data/test/fixtures/gem_test/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'appmap', git: 'applandinc/appmap-ruby', branch: `git rev-parse --abbrev-ref HEAD`.strip
+gem 'activesupport'
+gem 'byebug'
+gem 'minitest'

data/test/fixtures/gem_test/appmap.yml

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

data/test/fixtures/gem_test/test/to_param_test.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'appmap/minitest'
+require 'minitest/autorun'
+require 'active_support'
+require 'active_support/core_ext'
+
+class ToParamTest < ::Minitest::Test
+  def test_to_param
+    # record use of a core extension
+    assert_equal 'my+id', 'my+id'.to_param
+  end
+end

data/test/gem_test.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'test_helper'
+require 'English'
+
+class MinitestTest < Minitest::Test
+  def perform_gem_test(test_name)
+    Bundler.with_clean_env do
+      Dir.chdir 'test/fixtures/gem_test' do
+        FileUtils.rm_rf 'tmp'
+        system 'bundle config --local local.appmap ../../..'
+        system 'bundle'
+        system({ 'APPMAP' => 'true' }, %(bundle exec ruby -Ilib -Itest test/#{test_name}_test.rb))
+
+        yield
+      end
+    end
+  end
+
+  def test_record_gem
+    perform_gem_test 'to_param' do
+      appmap_file = 'tmp/appmap/minitest/To_param_to_param.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 'return', events.second['event']
+      assert_equal 1, events.second['parent_id']
+    end
+  end
+end

data/test/minitest_test.rb

@@ -5,7 +5,7 @@ require 'test_helper'
 require 'English'
 
 class MinitestTest < Minitest::Test
-  def perform_test(test_name)
+  def perform_minitest_test(test_name)
     Bundler.with_clean_env do
       Dir.chdir 'test/fixtures/minitest_recorder' do
         FileUtils.rm_rf 'tmp'
@@ -19,7 +19,7 @@ class MinitestTest < Minitest::Test
   end
 
   def test_hello
-    perform_test 'hello' do
+    perform_minitest_test 'hello' do
       appmap_file = 'tmp/appmap/minitest/Hello_hello.appmap.json'
 
       assert File.file?(appmap_file), 'appmap output file does not exist'

data/test/openssl_test.rb

@@ -11,7 +11,7 @@ class OpenSSLTest < Minitest::Test
         FileUtils.rm_rf 'tmp'
         system 'bundle config --local local.appmap ../../..'
         system 'bundle'
-        system({ 'APPMAP' => 'true', 'DEBUG' => 'true' }, %(bundle exec ruby lib/openssl_#{test_name}.rb))
+        system({ 'APPMAP' => 'true' }, %(bundle exec ruby lib/openssl_#{test_name}.rb))
 
         yield
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.35.2
+  version: 0.36.0
 platform: ruby
 authors:
 - Kevin Gilpin
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-01 00:00:00.000000000 Z
+date: 2020-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -84,14 +84,14 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.16'
 - !ruby/object:Gem::Dependency
@@ -290,7 +290,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - kgilpin@gmail.com
 executables:
@@ -303,7 +303,6 @@ files:
 - ".gitignore"
 - ".rbenv-gemsets"
 - ".rubocop.yml"
-- ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
 - Dockerfile.appmap
@@ -545,6 +544,9 @@ files:
 - test/fixtures/cucumber_recorder/features/support/hooks.rb
 - test/fixtures/cucumber_recorder/features/support/steps.rb
 - 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/minitest_recorder/Gemfile
 - test/fixtures/minitest_recorder/appmap.yml
 - test/fixtures/minitest_recorder/lib/hello.rb
@@ -562,6 +564,7 @@ files:
 - test/fixtures/rspec_recorder/spec/decorated_hello_spec.rb
 - test/fixtures/rspec_recorder/spec/labeled_hello_spec.rb
 - test/fixtures/rspec_recorder/spec/plain_hello_spec.rb
+- test/gem_test.rb
 - test/minitest_test.rb
 - test/openssl_test.rb
 - test/record_process_test.rb
@@ -571,7 +574,7 @@ homepage: https://github.com/applandinc/appmap-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -587,7 +590,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Record the operation of a Ruby program, using the AppLand 'AppMap' format.
 test_files: []

data/.ruby-version

@@ -1 +0,0 @@
-2.6.2