appmap 0.36.0 → 0.39.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 102dab80f2d8cffd51fd1377583a1b063078cd77ab7ad4ffdcd20867a084b11b
-  data.tar.gz: cbb87144593416f84099cf8a9d8ac18f18d9763dce28277320ae6a99ff59ec58
+  metadata.gz: 384456ad51727b3c819e8307de92b2785da152a46c5fa60d0a4e6ff690dbb596
+  data.tar.gz: e0d5a984bc74ee91b0f9428d83cbaac70c387b442cc55666f36b75907080e620
 SHA512:
-  metadata.gz: a24e2ecb22a654d11e91ef28a7fdd961c178144f474a36e26c70e8e243bac18c13e3c5ff606f5ed2a058ddf6d98f9dbd0678a0f986ddfae4f18ed7524c27d41d
-  data.tar.gz: 712cb7e18026aa80135af7ce54a7a8c412362355c0eb6b151a0f05354cf991ebe9402e298d9646b9fab2e5d673d3338a773a0b1b1d0e1846ec3ed970074a1f77
+  metadata.gz: 2f0670d632a370241168ad76ad30dd663568556ea3e524c48aafdbf86ae9d0c8e8f76f48a1c34a7a830457cff66c4417bbf19acb7ac952daeaaec65121e7a0d5
+  data.tar.gz: 3f1bec26161a40c75487e7f98f039df0c135f7de77ee089d72dde29c1a5d5fd19b43661c6aff3c3de58e945b87d330b96a66738a95a208ec7a4e75db1bd85363

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/.gitignore

@@ -14,4 +14,5 @@ Gemfile.lock
 appmap.json
 .vscode
 .byebug_history
-/lib/appmap/appmap.bundle
+/lib/appmap/appmap.bundle
+*.so

data/.rubocop.yml

@@ -1,3 +1,12 @@
+AllCops:
+  NewCops: enable
+
+Layout/CaseIndentation:
+  EnforcedStyle: end
+
+Layout/FirstArgumentIndentation:
+  EnforcedStyle: consistent
+
 Layout/SpaceInsideArrayLiteralBrackets:
   Enabled: false
 
@@ -8,12 +17,17 @@ Layout/HeredocIndentation:
 Layout/LineLength:
   Max: 120
 
+Metrics/BlockLength:
+  ExcludedMethods:
+  - it
+  - context
+
 Style/MultilineBlockChain:
   Enabled: false
 
 Style/NumericPredicate:
   Enabled: false
-  
+
 Style/AndOr:
   Enabled: false
 

data/.travis.yml

@@ -16,29 +16,8 @@ before_script:
   
 jobs:
   include:
-  - stage: minitest
+  - stage: test
     script:
     - mkdir tmp
-    - bundle exec rake minitest
-    
-  - stage: base
-    script:
-    - bundle exec rake build:base:2.5
-  - stage: base
-    script:
-    - bundle exec rake build:base:2.6
-      
-  - stage: fixtures
-    script:
-    - bundle exec rake build:fixtures:2.5:all
-  - stage: fixtures
-    script:
-    - bundle exec rake build:fixtures:2.6:all
-
-  - stage: spec
-    script:
-    - bundle exec rake spec:2.5
-  - stage: spec
-    script:
-    - bundle exec rake spec:2.6
+    - bundle exec rake test
     

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+# v0.39.1
+* Support Ruby 2.7.
+* Remove support for Rails 4.
+* Stop recommending `-t appmap` argument for `rspec`.
+
+# v0.39.0
+* Recognize and record `normalized_path_info` in Rails applications, per 1.4 AppMap format version.
+
+# v0.38.1
+* Package configuration can be `shallow`, in case which only the initial entry into the package is recorded.
+
+# 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.
+
 # v0.36.0
 * *appmap.yml* package definition may specify `gem`.
 * Skip loading the railtie if `APPMAP_INITIALIZE` environment variable

data/README.md

@@ -1,3 +1,4 @@
+
 - [About](#about)
 - [Installation](#installation)
 - [Configuration](#configuration)
@@ -13,7 +14,7 @@
   - [Using fixture apps](#using-fixture-apps)
     - [`test/fixtures`](#testfixtures)
     - [`spec/fixtures`](#specfixtures)
-- [Build status](#build-status)
+
 
 # About
 
@@ -27,8 +28,9 @@ granular than a full debug trace. It's designed to be optimal for understanding
 There are several ways to record AppMaps of your Ruby program using the `appmap` gem:
 
 * Run your RSpec tests with the environment variable `APPMAP=true`. An AppMap will be generated for each spec.
-* Run your application server with AppMap remote recording enabled, and use the AppMap.
-  browser extension to start, stop, and upload recordings.
+* Run your application server with AppMap remote recording enabled, and use the [AppLand
+  browser extension](https://github.com/applandinc/appland-browser-extension) to start,
+  stop, and upload recordings.
 * Run the command `appmap record <program>` to record the entire execution of a program.
 
 Once you have recorded some AppMaps (for example, by running RSpec tests), you use the `appland upload` command
@@ -37,6 +39,13 @@ by the [AppLand CLI](https://github.com/applandinc/appland-cli/releases).
 Then, on the [AppLand website](https://app.land), you can
 visualize the design of your code and share links with collaborators.
 
+### Supported versions
+
+* Ruby 2.5, 2.6, 2.7
+* Rails 5, 6
+
+Support for new versions is added frequently, please check back regularly for updates.
+
 # Installation
 
 Add `gem 'appmap'` to your Gemfile just as you would any other dependency.
@@ -91,6 +100,9 @@ Each entry in the `packages` list is a YAML object which has the following keys:
 * **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.
+* **shallow** When set to `true`, only the first function call entry into a package will be recorded. Subsequent function calls within 
+  the same package are not recorded unless code execution leaves the package and re-enters it. Default: `true` when using `gem`,
+  `false` when using `path`.
 
 # Running
 
@@ -123,7 +135,7 @@ require File.expand_path("../../config/environment", __FILE__)
 3) Run the tests with the environment variable `APPMAP=true`:
 
 ```sh-session
-$ APPMAP=true bundle exec rspec -t appmap
+$ APPMAP=true bundle exec rspec
 ```
 
 Each RSpec test will output an AppMap file into the directory `tmp/appmap/rspec`. For example:
@@ -166,16 +178,22 @@ Note that `test_helper.rb` in a Rails project typically loads the application's
 require_relative '../config/environment'
 ```
 
-and `appmap/rspec` must be required before this:
+and `appmap/minitest` must be required before this:
 
 ```ruby
-require 'appmap/rspec'
+require 'appmap/minitest'
 require_relative '../config/environment'
 ```
 
-2) Run the tests with the environment variable `APPMAP=true`:
+2) Run your tests as you normally would with the environment variable `APPMAP=true`. For example:  
 
-```sh-session
+```
+$ APPMAP=true bundle exec rake
+```
+
+or
+
+```
 $ APPMAP=true bundle exec -Ilib -Itest test/*
 ```
 
@@ -250,11 +268,11 @@ end
 $ bundle exec rails server
 ```
 
-4. Open the AppApp browser extension and push `Start`.
+4. Open the AppLand browser extension and push `Start`.
 
 5. Use your app. For example, perform a login flow, or run through a manual UI test.
 
-6. Open the AppApp browser extension and push `Stop`. The recording will be transferred to the AppLand website and opened in your browser.
+6. Open the AppLand browser extension and push `Stop`. The recording will be transferred to the AppLand website and opened in your browser.
 
 ## Ruby on Rails
 
@@ -267,6 +285,7 @@ Note that using this method is kind of a blunt instrument. Recording RSpecs and
 For instructions on uploading, see the documentation of the [AppLand CLI](https://github.com/applandinc/appland-cli).
 
 # Development
+[![Build Status](https://travis-ci.org/applandinc/appmap-ruby.svg?branch=master)](https://travis-ci.org/applandinc/appmap-ruby)
 
 ## Running tests
 
@@ -291,7 +310,7 @@ $ bundle exec rake compile
 ### `test/fixtures`
 
 The fixture apps in `test/fixtures` are plain Ruby projects that exercise the basic functionality of the
-`appmap` gem. To develop in a fixture, simple enter the fixture directory and `bundle`.
+`appmap` gem. To develop in a fixture, simply enter the fixture directory and `bundle`.
 
 ### `spec/fixtures`
 
@@ -341,5 +360,3 @@ Finished in 0.07357 seconds (files took 2.1 seconds to load)
 4 examples, 0 failures
 ```
 
-# Build status
-[![Build Status](https://travis-ci.org/applandinc/appmap-ruby.svg?branch=master)](https://travis-ci.org/applandinc/appmap-ruby)

data/Rakefile

@@ -1,3 +1,4 @@
+$: << File.join(__dir__, 'lib')
 require 'appmap/version'
 GEM_VERSION = AppMap::VERSION
 
@@ -17,12 +18,12 @@ namespace 'gem' do
   require 'bundler/gem_tasks'
 end
 
-RUBY_VERSIONS=%w[2.5 2.6]
-FIXTURE_APPS=%w[rack_users_app rails_users_app rails4_users_app]
+RUBY_VERSIONS=%w[2.5 2.6 2.7]
+FIXTURE_APPS=%w[rack_users_app rails6_users_app rails5_users_app]
 
 def run_cmd(*cmd)
   $stderr.puts "Running: #{cmd}"
-  out,s = Open3.capture2e(*cmd)
+  out, s = Open3.capture2e(*cmd)
   unless s.success?
     $stderr.puts <<-END
       Command failed:

data/appmap.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activesupport'
   spec.add_dependency 'faraday'
   spec.add_dependency 'gli'
+  spec.add_dependency 'method_source'
   spec.add_dependency 'parser'
   spec.add_dependency 'rack'
 

data/lib/appmap.rb

@@ -83,8 +83,8 @@ module AppMap
     end
 
     # Builds a class map from a config and a list of Ruby methods.
-    def class_map(methods)
-      ClassMap.build_from_methods(methods)
+    def class_map(methods, options = {})
+      ClassMap.build_from_methods(methods, options)
     end
 
     # Returns default metadata detected from the Ruby system and from the

data/lib/appmap/class_map.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'method_source'
+
 module AppMap
   class ClassMap
     module HasChildren
@@ -48,7 +50,7 @@ module AppMap
         end
       end
       Function = Struct.new(:name) do
-        attr_accessor :static, :location, :labels
+        attr_accessor :static, :location, :labels, :comment, :source
 
         def type
           'function'
@@ -60,24 +62,26 @@ module AppMap
             type: type,
             location: location,
             static: static,
-            labels: labels
+            labels: labels,
+            comment: comment,
+            source: source
           }.delete_if { |_, v| v.nil? || v == [] }
         end
       end
     end
 
     class << self
-      def build_from_methods(methods)
+      def build_from_methods(methods, options = {})
         root = Types::Root.new
         methods.each do |method|
-          add_function root, method
+          add_function root, method, options
         end
         root.children.map(&:to_h)
       end
 
       protected
 
-      def add_function(root, method)
+      def add_function(root, method, include_source: true)
         package = method.package
         static = method.static
 
@@ -109,6 +113,16 @@ module AppMap
             [ method.defined_class, static ? '.' : '#', method.name ].join
           end
 
+        if include_source
+          begin
+            function_info[:source] = method.source
+            comment = method.comment || ''
+            function_info[:comment] = comment unless comment.empty?
+          rescue MethodSource::SourceNotFoundError
+            # pass
+          end
+        end
+
         function_info[:labels] = package.labels if package.labels
         object_infos << function_info
 

data/lib/appmap/config.rb

@@ -2,15 +2,22 @@
 
 module AppMap
   class Config
-    Package = Struct.new(:path, :gem, :package_name, :exclude, :labels) do
+    Package = Struct.new(:path, :gem, :package_name, :exclude, :labels, :shallow) do
+      # Indicates that only the entry points to a package will be recorded.
+      # Once the code has entered a package, subsequent calls within the package will not be
+      # recorded unless the code leaves the package and re-enters it.
+      def shallow?
+        shallow
+      end
+
       class << self
-        def build_from_path(path, package_name: nil, exclude: [], labels: [])
-          Package.new(path, nil, package_name, exclude, labels)
+        def build_from_path(path, shallow: false, package_name: nil, exclude: [], labels: [])
+          Package.new(path, nil, package_name, exclude, labels, shallow)
         end
 
-        def build_from_gem(gem, package_name: nil, exclude: [], labels: [])
+        def build_from_gem(gem, shallow: true, package_name: nil, exclude: [], labels: [])
           gem_paths(gem).map do |gem_path|
-            Package.new(gem_path, gem, package_name, exclude, labels)
+            Package.new(gem_path, gem, package_name, exclude, labels, shallow)
           end
         end
 
@@ -36,7 +43,8 @@ module AppMap
           package_name: package_name,
           gem: gem,
           exclude: exclude.blank? ? nil : exclude,
-          labels: labels.blank? ? nil : labels
+          labels: labels.blank? ? nil : labels,
+          shallow: shallow
         }.compact
       end
     end
@@ -49,7 +57,8 @@ module AppMap
     # 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.build_from_path('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])),
+      'ActionView::Renderer' => Hook.new(:render, Package.build_from_path('action_view', package_name: 'action_view', labels: %w[view]))
     }.freeze
 
     BUILTIN_METHODS = {
@@ -66,7 +75,7 @@ module AppMap
       '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]))
+      'JSON::Ext::Generator::State' => Hook.new(:generate, Package.build_from_path('json', package_name: 'json', labels: %w[serialization json])),
     }.freeze
 
     attr_reader :name, :packages
@@ -91,9 +100,12 @@ module AppMap
           raise 'AppMap package configuration should specify gem or path, not both' if gem && path
 
           if gem
-            Package.build_from_gem(gem, exclude: package['exclude'] || [])
+            shallow = package['shallow']
+            # shallow is true by default for gems
+            shallow = true if shallow.nil?
+            Package.build_from_gem(gem, exclude: package['exclude'] || [], shallow: shallow)
           else
-            [ Package.build_from_path(path, exclude: package['exclude'] || []) ]
+            [ Package.build_from_path(path, exclude: package['exclude'] || [], shallow: package['shallow']) ]
           end
         end.flatten
         Config.new config_data['name'], packages

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

@@ -6,6 +6,9 @@ module AppMap
   class Hook
     LOG = (ENV['APPMAP_DEBUG'] == 'true' || ENV['DEBUG'] == 'true')
 
+    OBJECT_INSTANCE_METHODS = %i[! != !~ <=> == === =~ __id__ __send__ class clone define_singleton_method display dup enum_for eql? equal? extend freeze frozen? hash inspect instance_eval instance_exec instance_of? instance_variable_defined? instance_variable_get instance_variable_set instance_variables is_a? itself kind_of? method methods nil? object_id private_methods protected_methods public_method public_methods public_send remove_instance_variable respond_to? send singleton_class singleton_method singleton_methods taint tainted? tap then to_enum to_s to_h to_a trust untaint untrust untrusted? yield_self].freeze
+    OBJECT_STATIC_METHODS = %i[! != !~ < <= <=> == === =~ > >= __id__ __send__ alias_method allocate ancestors attr attr_accessor attr_reader attr_writer autoload autoload? class class_eval class_exec class_variable_defined? class_variable_get class_variable_set class_variables clone const_defined? const_get const_missing const_set constants define_method define_singleton_method deprecate_constant display dup enum_for eql? equal? extend freeze frozen? hash include include? included_modules inspect instance_eval instance_exec instance_method instance_methods instance_of? instance_variable_defined? instance_variable_get instance_variable_set instance_variables is_a? itself kind_of? method method_defined? methods module_eval module_exec name new nil? object_id prepend private_class_method private_constant private_instance_methods private_method_defined? private_methods protected_instance_methods protected_method_defined? protected_methods public_class_method public_constant public_instance_method public_instance_methods public_method public_method_defined? public_methods public_send remove_class_variable remove_instance_variable remove_method respond_to? send singleton_class singleton_class? singleton_method singleton_methods superclass taint tainted? tap then to_enum to_s trust undef_method untaint untrust untrusted? yield_self].freeze
+
     @unbound_method_arity = ::UnboundMethod.instance_method(:arity)
     @method_arity = ::Method.instance_method(:arity)
 
@@ -42,12 +45,17 @@ module AppMap
       tp = TracePoint.new(:end) do |trace_point|
         cls = trace_point.self
 
-        instance_methods = cls.public_instance_methods(false)
-        class_methods = cls.singleton_class.public_instance_methods(false) - instance_methods
+        instance_methods = cls.public_instance_methods(false) - OBJECT_INSTANCE_METHODS
+        class_methods = cls.singleton_class.public_instance_methods(false) - instance_methods - OBJECT_STATIC_METHODS
 
         hook = lambda do |hook_cls|
           lambda do |method_id|
-            method = hook_cls.public_instance_method(method_id)
+            method = begin
+              hook_cls.public_instance_method(method_id)
+            rescue NameError
+              warn "AppMap: Method #{hook_cls} #{method.name} is not accessible" if LOG
+              return
+            end
 
             warn "AppMap: Examining #{hook_cls} #{method.name}" if LOG