appmap 0.36.0 → 0.37.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 102dab80f2d8cffd51fd1377583a1b063078cd77ab7ad4ffdcd20867a084b11b
-  data.tar.gz: cbb87144593416f84099cf8a9d8ac18f18d9763dce28277320ae6a99ff59ec58
+  metadata.gz: fba24ecdb42c951741292378419eef430a56cc16816df46a14b2ae3e318f8f94
+  data.tar.gz: 67ff27467f72322c5a8514c90b0a6039e3fd1268dba103dea3b832eda95ac317
 SHA512:
-  metadata.gz: a24e2ecb22a654d11e91ef28a7fdd961c178144f474a36e26c70e8e243bac18c13e3c5ff606f5ed2a058ddf6d98f9dbd0678a0f986ddfae4f18ed7524c27d41d
-  data.tar.gz: 712cb7e18026aa80135af7ce54a7a8c412362355c0eb6b151a0f05354cf991ebe9402e298d9646b9fab2e5d673d3338a773a0b1b1d0e1846ec3ed970074a1f77
+  metadata.gz: 1823304c2733b46470481fd731a1f4650a80e769d96b47dbcdb0e5763e59930d6754068b4cf0729f9f748c55109575f3c8146b09030741fccfafd06cd45669b9
+  data.tar.gz: bbebe31041ed1720dc54b9522e4c6baac3b27d8d77be0622315657d0fa5b355c3e12474aa756811a6d747b563999c6e76206805c1392a015f92c6b863e8eeda0

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,6 @@
+AllCops:
+  NewCops: enable
+
 Layout/SpaceInsideArrayLiteralBrackets:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 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
@@ -250,11 +252,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 +269,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 +294,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 +344,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
 

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/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.36.0'
+  VERSION = '0.37.0'
 
-  APPMAP_FORMAT_VERSION = '1.2'
+  APPMAP_FORMAT_VERSION = '1.3'
 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/hook_spec.rb

@@ -112,6 +112,10 @@ describe 'AppMap class Hooking', docker: false do
           :type: function
           :location: spec/fixtures/hook/instance_method.rb:8
           :static: false
+          :source: |2
+              def say_default
+                'default'
+              end
     YAML
   end
 
@@ -713,6 +717,10 @@ describe 'AppMap class Hooking', docker: false do
             :type: function
             :location: spec/fixtures/hook/compare.rb:4
             :static: true
+            :source: |2
+                def self.compare(s1, s2)
+                  ActiveSupport::SecurityUtils.secure_compare(s1, s2)
+                end
       - :name: active_support
         :type: package
         :children:
@@ -729,6 +737,15 @@ describe 'AppMap class Hooking', docker: false do
               :labels:
               - security
               - crypto
+              :comment: |
+                # Constant time string comparison, for variable length strings.
+                #
+                # The values are first processed by SHA256, so that we don't leak length info
+                # via timing attacks.
+              :source: |2
+                    def secure_compare(a, b)
+                      fixed_length_secure_compare(::Digest::SHA256.digest(a), ::Digest::SHA256.digest(b)) && a == b
+                    end
       - :name: openssl
         :type: package
         :children:

data/test/expectations/openssl_test_key_sign1.json

@@ -0,0 +1,55 @@
+[
+  {
+    "name": "lib",
+    "type": "package",
+    "children": [
+      {
+        "name": "Example",
+        "type": "class",
+        "children": [
+          {
+            "name": "sign",
+            "type": "function",
+            "location": "lib/openssl_key_sign.rb:10",
+            "static": true,
+            "source": "  def Example.sign\n    key = OpenSSL::PKey::RSA.new 2048\n\n    document = 'the document'\n\n    digest = OpenSSL::Digest::SHA256.new\n    key.sign digest, document\n  end\n"
+          }
+        ]
+      }
+    ]
+  },
+  {
+    "name": "openssl",
+    "type": "package",
+    "children": [
+      {
+        "name": "OpenSSL",
+        "type": "class",
+        "children": [
+          {
+            "name": "PKey",
+            "type": "class",
+            "children": [
+              {
+                "name": "PKey",
+                "type": "class",
+                "children": [
+                  {
+                    "name": "sign",
+                    "type": "function",
+                    "location": "OpenSSL::PKey::PKey#sign",
+                    "static": false,
+                    "labels": [
+                      "security",
+                      "crypto"
+                    ]
+                  }
+                ]
+              }
+            ]
+          }
+        ]
+      }
+    ]
+  }
+]

data/test/expectations/openssl_test_key_sign2.json

@@ -0,0 +1,58 @@
+[
+  {
+    "id": 1,
+    "event": "call",
+    "defined_class": "Example",
+    "method_id": "sign",
+    "path": "lib/openssl_key_sign.rb",
+    "lineno": 10,
+    "static": true,
+    "parameters": [
+
+    ],
+    "receiver": {
+      "class": "Module"
+    }
+  },
+  {
+    "id": 2,
+    "event": "call",
+    "defined_class": "OpenSSL::PKey::PKey",
+    "method_id": "sign",
+    "path": "OpenSSL::PKey::PKey#sign",
+    "static": false,
+    "parameters": [
+      {
+        "name": "arg",
+        "class": "OpenSSL::Digest::SHA256",
+        "value": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
+        "kind": "req"
+      },
+      {
+        "name": "arg",
+        "class": "String",
+        "value": "the document",
+        "kind": "req"
+      }
+    ],
+    "receiver": {
+      "class": "OpenSSL::PKey::RSA"
+    }
+  },
+  {
+    "id": 3,
+    "event": "return",
+    "parent_id": 2,
+    "return_value": {
+      "class": "String"
+    }
+  },
+  {
+    "id": 4,
+    "event": "return",
+    "parent_id": 1,
+    "return_value": {
+      "class": "String"
+    }
+  }
+]

data/test/openssl_test.rb

@@ -18,6 +18,10 @@ class OpenSSLTest < Minitest::Test
     end
   end
 
+  def expectation(name)
+    File.read File.join __dir__, 'expectations', name
+  end
+
   def test_key_sign
     perform_test 'key_sign' do
       appmap_file = 'appmap.json'
@@ -26,62 +30,7 @@ class OpenSSLTest < Minitest::Test
       appmap = JSON.parse(File.read(appmap_file))
       assert_equal AppMap::APPMAP_FORMAT_VERSION, appmap['version']
       assert_equal [ { 'recorder' => 'lib/openssl_key_sign.rb' } ], appmap['metadata']
-      assert_equal JSON.parse(<<~JSON), appmap['classMap']
-      [
-        {
-          "name": "lib",
-          "type": "package",
-          "children": [
-            {
-              "name": "Example",
-              "type": "class",
-              "children": [
-                {
-                  "name": "sign",
-                  "type": "function",
-                  "location": "lib/openssl_key_sign.rb:10",
-                  "static": true
-                }
-              ]
-            }
-          ]
-        },
-        {
-          "name": "openssl",
-          "type": "package",
-          "children": [
-            {
-              "name": "OpenSSL",
-              "type": "class",
-              "children": [
-                {
-                  "name": "PKey",
-                  "type": "class",
-                  "children": [
-                    {
-                      "name": "PKey",
-                      "type": "class",
-                      "children": [
-                        {
-                          "name": "sign",
-                          "type": "function",
-                          "location": "OpenSSL::PKey::PKey#sign",
-                          "static": false,
-                          "labels": [
-                            "security",
-                            "crypto"
-                          ]
-                        }
-                      ]
-                    }
-                  ]
-                }
-              ]
-            }
-          ]
-        }
-      ]
-      JSON
+      assert_equal JSON.parse(expectation('openssl_test_key_sign1.json')), appmap['classMap']
       sanitized_events = appmap['events'].map(&:deep_symbolize_keys).map(&AppMap::Util.method(:sanitize_event)).map do |event|
         delete_value = ->(obj) { (obj || {}).delete(:value) }
         delete_value.call(event[:receiver])
@@ -89,66 +38,10 @@ class OpenSSLTest < Minitest::Test
         event
       end
 
-      diff = Diffy::Diff.new(<<~JSON.strip, JSON.pretty_generate(sanitized_events).strip)
-      [
-        {
-          "id": 1,
-          "event": "call",
-          "defined_class": "Example",
-          "method_id": "sign",
-          "path": "lib/openssl_key_sign.rb",
-          "lineno": 10,
-          "static": true,
-          "parameters": [
-      
-          ],
-          "receiver": {
-            "class": "Module"
-          }
-        },
-        {
-          "id": 2,
-          "event": "call",
-          "defined_class": "OpenSSL::PKey::PKey",
-          "method_id": "sign",
-          "path": "OpenSSL::PKey::PKey#sign",
-          "static": false,
-          "parameters": [
-            {
-              "name": "arg",
-              "class": "OpenSSL::Digest::SHA256",
-              "value": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
-              "kind": "req"
-            },
-            {
-              "name": "arg",
-              "class": "String",
-              "value": "the document",
-              "kind": "req"
-            }
-          ],
-          "receiver": {
-            "class": "OpenSSL::PKey::RSA"
-          }
-        },
-        {
-          "id": 3,
-          "event": "return",
-          "parent_id": 2,
-          "return_value": {
-            "class": "String"
-          }
-        },
-        {
-          "id": 4,
-          "event": "return",
-          "parent_id": 1,
-          "return_value": {
-            "class": "String"
-          }
-        }
-      ]
-      JSON
+      diff = Diffy::Diff.new(
+        expectation('openssl_test_key_sign2.json').strip,
+        JSON.pretty_generate(sanitized_events).strip
+      )
       assert_equal '', diff.to_s
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.36.0
+  version: 0.37.0
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-05 00:00:00.000000000 Z
+date: 2020-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: method_source
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: parser
   requirement: !ruby/object:Gem::Requirement
@@ -366,6 +380,7 @@ files:
 - package.json
 - spec/abstract_controller4_base_spec.rb
 - spec/abstract_controller_base_spec.rb
+- spec/class_map_spec.rb
 - spec/config_spec.rb
 - spec/fixtures/hook/attr_accessor.rb
 - spec/fixtures/hook/compare.rb
@@ -528,6 +543,8 @@ files:
 - spec/util_spec.rb
 - test/cli_test.rb
 - test/cucumber_test.rb
+- test/expectations/openssl_test_key_sign1.json
+- test/expectations/openssl_test_key_sign2.json
 - test/fixtures/cli_record_test/appmap.yml
 - test/fixtures/cli_record_test/lib/cli_record_test/main.rb
 - test/fixtures/cucumber4_recorder/Gemfile