appmap 0.43.0 → 0.44.0

data/spec/abstract_controller_base_spec.rb

@@ -27,6 +27,8 @@ describe 'Rails' do
       end
 
       let(:appmap) { JSON.parse File.read File.join tmpdir, 'appmap/rspec', appmap_json_file }
+      let(:appmap_json_path) { File.join(tmpdir, 'appmap/rspec', appmap_json_file) }
+      let(:appmap) { JSON.parse File.read(appmap_json_path) }
       let(:events) { appmap['events'] }
 
       describe 'an API route' do
@@ -35,10 +37,6 @@ describe 'Rails' do
             'Api_UsersController_POST_api_users_with_required_parameters_creates_a_user.appmap.json'
           end
 
-          it 'inventory file is printed' do
-            expect(File).to exist(File.join(tmpdir, 'appmap/rspec/Inventory.appmap.json'))
-          end
-
           it 'http_server_request is recorded in the appmap' do
             expect(events).to include(
               hash_including(

data/spec/class_map_spec.rb

@@ -4,18 +4,10 @@ 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))])
+    it 'includes method comment' 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)
+      expect(function).to include(:comment)
     end
 
     # test method comment

data/spec/config_spec.rb

@@ -17,10 +17,40 @@ describe AppMap::Config, docker: false do
           path: 'path-2',
           exclude: [ 'exclude-1' ]
         }
+      ],
+      functions: [
+        {
+          package: 'pkg',
+          class: 'cls',
+          function: 'fn',
+          label: 'lbl'
+        }
       ]
     }.deep_stringify_keys!
     config = AppMap::Config.load(config_data)
 
-    expect(config.to_h.deep_stringify_keys!).to eq(config_data)
+    config_expectation = {
+      exclude: [],
+      name: 'test',
+      packages: [
+        {
+          path: 'path-1'
+        },
+        {
+          path: 'path-2',
+          exclude: [ 'exclude-1' ]
+        }
+      ],
+      functions: [
+        {
+          package: 'pkg',
+          class: 'cls',
+          functions: [ :fn ],
+          labels: ['lbl']
+        }
+      ]
+    }.deep_stringify_keys!
+
+    expect(config.to_h.deep_stringify_keys!).to eq(config_expectation)
   end
 end

data/spec/fixtures/hook/custom_instance_method.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class CustomInstanceMethod
+  def to_s
+    'CustomInstance Method fixture'
+  end
+
+  def say_default
+    'default'
+  end
+end

data/spec/fixtures/hook/method_named_call.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class MethodNamedCall
+  def to_s
+    'MethodNamedCall'
+  end
+
+  def call(a, b, c, d, e)
+    [ a, b, c, d, e ].join(' ')
+  end
+end

data/spec/hook_spec.rb

@@ -64,13 +64,144 @@ describe 'AppMap class Hooking', docker: false do
   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])
+    config = AppMap::Config.new('hook_spec', [ package ], exclude: %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 "handles an instance method named 'call' without issues" do
+    events_yaml = <<~YAML
+    ---
+    - :id: 1
+      :event: :call
+      :defined_class: MethodNamedCall
+      :method_id: call
+      :path: spec/fixtures/hook/method_named_call.rb
+      :lineno: 8
+      :static: false
+      :parameters:
+      - :name: :a
+        :class: Integer
+        :value: '1'
+        :kind: :req
+      - :name: :b
+        :class: Integer
+        :value: '2'
+        :kind: :req
+      - :name: :c
+        :class: Integer
+        :value: '3'
+        :kind: :req
+      - :name: :d
+        :class: Integer
+        :value: '4'
+        :kind: :req
+      - :name: :e
+        :class: Integer
+        :value: '5'
+        :kind: :req
+      :receiver:
+        :class: MethodNamedCall
+        :value: MethodNamedCall
+    - :id: 2
+      :event: :return
+      :parent_id: 1
+      :return_value:
+        :class: String
+        :value: 1 2 3 4 5
+    YAML
+
+    _, tracer = test_hook_behavior 'spec/fixtures/hook/method_named_call.rb', events_yaml do
+      expect(MethodNamedCall.new.call(1, 2, 3, 4, 5)).to eq('1 2 3 4 5')
+    end
+    class_map = AppMap.class_map(tracer.event_methods)
+    expect(Diffy::Diff.new(<<~CLASSMAP, YAML.dump(class_map)).to_s).to eq('')
+    ---
+    - :name: spec/fixtures/hook/method_named_call.rb
+      :type: package
+      :children:
+      - :name: MethodNamedCall
+        :type: class
+        :children:
+        - :name: call
+          :type: function
+          :location: spec/fixtures/hook/method_named_call.rb:8
+          :static: false
+    CLASSMAP
+  end
+
+  it 'can custom hook and label a function' do
+    events_yaml = <<~YAML
+    ---
+    - :id: 1
+      :event: :call
+      :defined_class: CustomInstanceMethod
+      :method_id: say_default
+      :path: spec/fixtures/hook/custom_instance_method.rb
+      :lineno: 8
+      :static: false
+      :parameters: []
+      :receiver:
+        :class: CustomInstanceMethod
+        :value: CustomInstance Method fixture
+    - :id: 2
+      :event: :return
+      :parent_id: 1
+      :return_value:
+        :class: String
+        :value: default
+    YAML
+
+    config = AppMap::Config.load({
+      functions: [
+        {
+          package: 'hook_spec',
+          class: 'CustomInstanceMethod',
+          functions: [ :say_default ],
+          labels: ['cowsay']
+        }
+      ]
+    }.deep_stringify_keys)
+
+    load 'spec/fixtures/hook/custom_instance_method.rb'
+    hook_cls = CustomInstanceMethod
+    method = hook_cls.instance_method(:say_default)
+
+    require 'appmap/hook/method'
+    hook_method = AppMap::Hook::Method.new(config.package_for_method(method), hook_cls, method)
+    hook_method.activate
+
+    tracer = AppMap.tracing.trace
+    AppMap::Event.reset_id_counter
+    begin
+      expect(CustomInstanceMethod.new.say_default).to eq('default')
+    ensure
+      AppMap.tracing.delete(tracer)
+    end
+
+    events = collect_events(tracer).to_yaml
+
+    expect(Diffy::Diff.new(events_yaml, events).to_s).to eq('')
+    class_map = AppMap.class_map(tracer.event_methods)
+    expect(Diffy::Diff.new(<<~CLASSMAP, YAML.dump(class_map)).to_s).to eq('')
+    ---
+    - :name: hook_spec
+      :type: package
+      :children:
+      - :name: CustomInstanceMethod
+        :type: class
+        :children:
+        - :name: say_default
+          :type: function
+          :location: spec/fixtures/hook/custom_instance_method.rb:8
+          :static: false
+          :labels:
+          - cowsay
+    CLASSMAP
+  end
+
   it 'parses labels from comments' do
     _, tracer = invoke_test_file 'spec/fixtures/hook/labels.rb' do
       ClassWithLabel.new.fn_with_label
@@ -91,9 +222,6 @@ describe 'AppMap class Hooking', docker: false do
           :labels:
           - has-fn-label
           :comment: "# @label has-fn-label\\n"
-          :source: |2
-              def fn_with_label
-              end
       YAML
   end
 
@@ -148,10 +276,6 @@ 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
 
@@ -746,6 +870,7 @@ describe 'AppMap class Hooking', docker: false do
       end
       secure_compare_event = YAML.load(events).find { |evt| evt[:defined_class] == 'ActiveSupport::SecurityUtils' }
       secure_compare_event.delete(:lineno)
+      secure_compare_event.delete(:path)
 
       expect(Diffy::Diff.new(<<~YAML, secure_compare_event.to_yaml).to_s).to eq('')
       ---
@@ -753,7 +878,6 @@ describe 'AppMap class Hooking', docker: false do
       :event: :call
       :defined_class: ActiveSupport::SecurityUtils
       :method_id: secure_compare
-      :path: lib/active_support/security_utils.rb
       :static: true
       :parameters:
       - :name: :a
@@ -837,7 +961,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[provider.secure_compare])
+      expect(entry[:labels]).to eq(%w[crypto.secure_compare])
     end
   end
 

data/test/expectations/openssl_test_key_sign1.json

@@ -11,8 +11,7 @@
             "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"
+            "static": true
           }
         ]
       }
@@ -40,8 +39,7 @@
                     "location": "OpenSSL::PKey::PKey#sign",
                     "static": false,
                     "labels": [
-                      "security",
-                      "crypto"
+                      "crypto.pkey"
                     ]
                   }
                 ]

data/test/gem_test.rb

@@ -26,7 +26,7 @@ class MinitestTest < Minitest::Test
       assert_equal 2, events.size
       assert_equal 'call', events.first['event']
       assert_equal 'default_parser', events.first['method_id']
-      assert_equal "#{Gem.loaded_specs['parser'].gem_dir}/lib/parser/base.rb", events.first['path']
+      assert_match /\lib\/parser\/base\.rb$/, events.first['path']
       assert_equal 'return', events.second['event']
       assert_equal 1, events.second['parent_id']
     end

data/test/rspec_test.rb

@@ -18,19 +18,6 @@ class RSpecTest < Minitest::Test
     end
   end
 
-  def test_inventory
-    perform_test 'plain_hello_spec' do
-      appmap_file = 'tmp/appmap/rspec/Inventory.appmap.json'
-
-      assert File.file?(appmap_file), 'appmap output file does not exist'
-      appmap = JSON.parse(File.read(appmap_file))
-      assert_equal AppMap::APPMAP_FORMAT_VERSION, appmap['version']
-      assert_includes appmap.keys, 'metadata'
-      metadata = appmap['metadata']
-      assert_equal 'Inventory', metadata['name']
-    end
-  end
-
   def test_record_decorated_rspec
     perform_test 'decorated_hello_spec' do
       appmap_file = 'tmp/appmap/rspec/Hello_says_hello.appmap.json'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.43.0
+  version: 0.44.0
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2021-03-31 00:00:00.000000000 Z
+date: 2021-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -307,8 +307,7 @@ dependencies:
 description:
 email:
 - kgilpin@gmail.com
-executables:
-- appmap
+executables: []
 extensions:
 - ext/appmap/extconf.rb
 extra_rdoc_files: []
@@ -334,7 +333,6 @@ files:
 - examples/mock_webapp/lib/mock_webapp/controller.rb
 - examples/mock_webapp/lib/mock_webapp/request.rb
 - examples/mock_webapp/lib/mock_webapp/user.rb
-- exe/appmap
 - ext/appmap/appmap.c
 - ext/appmap/extconf.rb
 - lib/appmap.rb
@@ -379,16 +377,19 @@ files:
 - lore/public/stylesheets/style.css
 - package-lock.json
 - package.json
+- patch
 - 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
 - spec/fixtures/hook/constructor.rb
+- spec/fixtures/hook/custom_instance_method.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/method_named_call.rb
 - spec/fixtures/hook/singleton_method.rb
 - spec/fixtures/rack_users_app/.dockerignore
 - spec/fixtures/rack_users_app/.gitignore
@@ -550,7 +551,6 @@ files:
 - spec/remote_recording_spec.rb
 - spec/spec_helper.rb
 - 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

data/exe/appmap

@@ -1,154 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'gli'
-
-ENV['APPMAP_INITIALIZE'] = 'false'
-
-require 'appmap'
-require 'appmap/version'
-
-# AppMap CLI.
-module AppMap
-  class App
-    extend GLI::App
-
-    program_desc 'AppMap client'
-
-    version AppMap::VERSION
-
-    subcommand_option_handling :normal
-    arguments :strict
-    preserve_argv true
-
-    class << self
-      protected
-
-      def default_appmap_file
-        ENV['APPMAP_FILE'] || 'appmap.json'
-      end
-
-      def output_file_flag(c, default_value: nil)
-        c.desc 'Name of the output file'
-        c.long_desc <<~DESC
-        Use a single dash '-' for stdout.
-        DESC
-        c.default_value default_value if default_value
-        c.arg_name 'filename'
-        c.flag %i[o output]
-      end
-    end
-
-    desc 'AppMap configuration file name'
-    default_value ENV['APPMAP_CONFIG'] || 'appmap.yml'
-    arg_name 'filename'
-    flag %i[c config]
-
-    desc 'Record the execution of a program and generate an AppMap.'
-    arg_name 'program'
-    command :record do |c|
-      output_file_flag(c, default_value: default_appmap_file)
-
-      c.action do |_, _, args|
-        # My subcommand name
-        ARGV.shift
-
-        # Consume the :output option, if provided
-        if %w[-o --output].find { |arg_name| ARGV[0] == arg_name.to_s }
-          ARGV.shift
-          ARGV.shift
-        end
-
-        # Name of the program to execute. GLI will ensure that it's present.
-        program = args.shift or help_now!("'program' argument is required")
-
-        # Also pop the program name from ARGV, because the command will use raw ARGV
-        # to load the extra arguments into this Ruby process.
-        ARGV.shift
-
-        require 'appmap/command/record'
-        AppMap::Command::Record.new(@config, program).perform do |version, metadata, class_map, events|
-          @output_file.write JSON.generate(version: version,
-                                           metadata: metadata,
-                                           classMap: class_map,
-                                           events: events)
-        end
-      end
-    end
-
-    desc 'Calculate and print statistics of scenario files.'
-    arg_name 'filename'
-    command :stats do |c|
-      output_file_flag(c, default_value: '-')
-
-      c.desc 'Display format for the result (text | json)'
-      c.default_value 'text'
-      c.flag %i[f format]
-
-      c.desc 'Maximum number of lines to display for each stat'
-      c.flag %i[l limit]
-
-      c.action do |_, options, args|
-        require 'appmap/command/stats'
-
-        limit = options[:limit].to_i if options[:limit]
-
-        # Name of the file to analyze. GLI will ensure that it's present.
-        filenames = args
-        help_now!("'filename' argument is required") if filenames.empty?
-
-        require 'appmap/algorithm/stats'
-        result = filenames.inject(::AppMap::Algorithm::Stats::Result.new([], [])) do |stats_result, filename|
-          appmap = begin
-            JSON.parse(File.read(filename))
-          rescue JSON::ParserError
-            STDERR.puts "#{filename} is not valid JSON : #{$!}"
-            nil
-          end
-          stats_result.tap do
-            if appmap
-              limit = options[:limit].to_i if options[:limit]
-              stats_for_file = AppMap::Command::Stats.new(appmap).perform(limit: limit)
-              stats_result.merge!(stats_for_file)
-            end
-          end
-        end
-
-        result.sort!
-        result.limit!(limit) if limit
-
-        display = case options[:format]
-        when 'json'
-          JSON.pretty_generate(result.as_json)
-        else
-          result.as_text
-        end
-        @output_file.write display
-      end
-    end
-
-    pre do |global, _, options, _|
-      @config = interpret_config_option(global[:config])
-      @output_file = interpret_output_file_option(options[:output])
-
-      true
-    end
-
-    class << self
-      protected
-
-      def interpret_config_option(fname)
-        AppMap.initialize fname
-      end
-
-      def interpret_output_file_option(file_name)
-        Hash.new { |_, fname| -> { File.new(fname, 'w') } }.tap do |open_output_file|
-          open_output_file[nil] = -> { nil }
-          open_output_file['-'] = -> { $stdout }
-        end[file_name].call
-      end
-    end
-  end
-end
-
-exit AppMap::App.run(ARGV)