appmap 0.51.1 → 0.51.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a51a7f69ebbca275fd9a215a52cd3e4d8db739e8e6cecf3eb522871f23295b5
-  data.tar.gz: 58f033b5c4f8756532dd3dbe83c631b36560e3215a342f804916de205f53cb56
+  metadata.gz: 194f53c7e13b466fef13720503fe9f8c1ee149af724884224ce03753cc0d658f
+  data.tar.gz: e9c7d5578da6d9e80d9c06e70deaa32fe7da785ab94840a09739e474601a8cac
 SHA512:
-  metadata.gz: e52a4b23f708892b12c3ca68a2b5e3c13a2c9b1d1b52057ede1548faa7c7d03914296ebb1402c7c1cd1f0540df1d6182ffa09de2cf3558410d499703bc8b352f
-  data.tar.gz: 32201a386bc48ef35395e702a46661f78b12c4b15cab6214203e91e3599537cc53742f5ef2848ecf3d73b3c6c007413b55b4ea22bc4f8c83131733b9b2ace4a3
+  metadata.gz: 82da50065460e83bbbd0f35bdce8e04924d9e0388f1da9ba30cea0637594dce2d8dc3a9364c55e1492924e73dfb91cf163eac7fe7028e4b48eb5cb3c34a96c92
+  data.tar.gz: 96198ca1c1f3c5bdcd4d75ce275f8e76a39ff9c36cbaf314c642d91dac54403426a28b54c5a478a58295560af804dc3f44ac33ff9b1b710b1d401fab4c72cb75

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## [0.51.2](https://github.com/applandinc/appmap-ruby/compare/v0.51.1...v0.51.2) (2021-06-22)
+
+
+### Bug Fixes
+
+* Be less verbose when logging config messages ([fba2fd0](https://github.com/applandinc/appmap-ruby/commit/fba2fd01dbb7b1830194b49285654d6657d1c786))
+* Method objects must support eql? and hash to ensure they are unique in a Set ([f4d5b11](https://github.com/applandinc/appmap-ruby/commit/f4d5b11db90aa50bdd1f768e039927833e83c30f))
+* Require rails, then appmap/railtie ([07967a1](https://github.com/applandinc/appmap-ruby/commit/07967a14609891544a7dd874c648b7ef5a505f21))
+* Use a hybrid strategy to auto-requiring appmap modules ([6fb09b8](https://github.com/applandinc/appmap-ruby/commit/6fb09b8c0bd55b1e29967d459ce1e2bd5b1ba9fe))
+
 ## [0.51.1](https://github.com/applandinc/appmap-ruby/compare/v0.51.0...v0.51.1) (2021-06-21)
 
 

data/appmap.gemspec

@@ -22,6 +22,9 @@ Gem::Specification.new do |spec|
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files         = `git ls-files --no-deleted`.split("
 ")
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+
   spec.extensions << "ext/appmap/extconf.rb"
 
   spec.require_paths = ['lib']

data/exe/appmap-agent-setup

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'gli'
+
+require 'appmap'
+
+class App
+  extend GLI::App
+
+  program_desc 'CLI tool to be used by IDEs for AppMap setup and configuration'
+
+  version AppMap::VERSION
+
+  subcommand_option_handling :normal
+  arguments :strict
+  preserve_argv true
+
+  desc 'AppMap configuration file name'
+  default_value ENV['APPMAP_CONFIG'] || AppMap::DEFAULT_CONFIG_FILE_PATH
+  arg_name 'filename'
+  flag %i[c config]
+
+  desc 'Creates base configuration file for the current project'
+  command :init do |c|
+    c.action do
+      require 'appmap/command/init'
+      AppMap::Command::Init.new(@config_file).perform
+    end
+  end
+
+  pre do |global, _, _, _|
+    @config_file = global[:config]
+    @config = interpret_config_option(@config_file) if File.exist?(@config_file)
+    true
+  end
+
+  class << self
+    protected
+
+    def interpret_config_option(fname)
+      AppMap::Config.load_from_file fname
+    end
+  end
+end
+
+exit App.run(ARGV)

data/lib/appmap.rb

@@ -51,7 +51,7 @@ module AppMap
     # Call this function before the program code is loaded by the Ruby VM, otherwise
     # the load events won't be seen and the hooks won't activate.
     def initialize_configuration(config_file_path = default_config_file_path)
-      warn "Configuring AppMap from path #{config_file_path}"
+      startup_message "Configuring AppMap from path #{config_file_path}"
       Config.load_from_file(config_file_path).tap do |configuration|
         self.configuration = configuration
         Hook.new(configuration).enable
@@ -109,20 +109,60 @@ module AppMap
       @metadata ||= Metadata.detect.freeze
       @metadata.deep_dup
     end
+
+    def startup_message(msg)
+      if defined?(::Rails) && defined?(::Rails.logger) && ::Rails.logger
+        ::Rails.logger.debug msg
+      elsif ENV['DEBUG'] == 'true'
+        warn msg
+      end
+    end
   end
 end
 
-if defined?(::Rails::Railtie)
-  require 'appmap/railtie' 
-end
+lambda do
+  Initializer = Struct.new(:class_name, :module_name, :gem_module_name)
 
-if defined?(::RSpec)
-  require 'appmap/rspec'
-end
+  INITIALIZERS = {
+    'Rails::Railtie' => Initializer.new('AppMap::Railtie', 'appmap/railtie', 'railtie'),
+    'RSpec' => Initializer.new('AppMap::RSpec', 'appmap/rspec', 'rspec-core'),
+    'Minitest::Unit::TestCase' => Initializer.new('AppMap::Minitest', 'appmap/minitest', 'minitest')
+  }
 
-# defined?(::Minitest) returns nil...
-if Gem.loaded_specs['minitest']
-  require 'appmap/minitest'
-end
+  TracePoint.new(:class) do |tp|
+    cls_name = tp.self.name
+    initializers = INITIALIZERS.delete(cls_name)
+    if initializers
+      initializers = [ initializers ] unless initializers.is_a?(Array)
+      next if Object.const_defined?(initializers.first.class_name)
+
+      gem_module_name = initializers.first.gem_module_name
+
+      AppMap.startup_message AppMap::Util.color(<<~LOAD_MSG, :magenta)
+      When 'appmap' was loaded, '#{gem_module_name}' had not been loaded yet. Now '#{gem_module_name}' has
+      just been loaded, so the following AppMap modules will be automatically required:
+
+      #{initializers.map(&:module_name).join("\n")}
+
+      To suppress this message, ensure '#{gem_module_name}' appears before 'appmap' in your Gemfile.
+      LOAD_MSG
+      initializers.each do |init|
+        require init.module_name
+      end
+    end
+  end.enable
+
+  if defined?(::Rails::Railtie)
+    require 'appmap/railtie'
+  end
+  
+  if defined?(::RSpec)
+    require 'appmap/rspec'
+  end
+  
+  if defined?(::Minitest)
+    require 'appmap/minitest'
+  end
+end.call
 
 AppMap.initialize_configuration if ENV['APPMAP'] == 'true'

data/lib/appmap/command/init.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'appmap/service/guesser'
+require 'appmap/util'
+
+module AppMap
+  module Command
+    InitStruct = Struct.new(:config_file)
+
+    class Init < InitStruct
+      def perform
+        if File.exist?(config_file)
+          puts AppMap::Util.color(%(The AppMap config file #{config_file} already exists.), :magenta)
+          return
+        end
+
+        ensure_directory_exists
+
+        config = {
+          'name' => Service::Guesser.guess_name,
+          'packages' => Service::Guesser.guess_paths.map { |path| { 'path' => path } }
+        }
+        content = YAML.dump(config).gsub("---\n", '')
+
+        File.write(config_file, content)
+        puts AppMap::Util.color(
+          %(The following AppMap config file #{config_file} has been created:),
+          :green
+        )
+        puts content
+      end
+
+      private
+
+      def ensure_directory_exists
+        dirname = File.dirname(config_file)
+        FileUtils.mkdir_p(dirname) unless File.directory?(dirname)
+      end
+    end
+  end
+end

data/lib/appmap/config.rb

@@ -3,6 +3,7 @@
 require 'yaml'
 require 'appmap/handler/net_http'
 require 'appmap/handler/rails/template'
+require 'appmap/service/guesser'
 
 module AppMap
   class Config
@@ -284,7 +285,7 @@ module AppMap
           settings, the appmap gem will try and guess some reasonable defaults.
           To suppress this message, create the file:
           
-          #{Pathname.new(config_file_name).expand_path}.
+          #{Pathname.new(config_file_name).expand_path}
           
           Here are the default settings that will be used in the meantime. You can
           copy and paste this example to start your appmap.yml.
@@ -308,7 +309,7 @@ module AppMap
 
       # Loads configuration from a Hash.
       def load(config_data)
-        name = config_data['name'] || guess_name
+        name = config_data['name'] || Service::Guesser.guess_name
         config_params = {
           exclude: config_data['exclude']
         }.compact
@@ -344,33 +345,13 @@ module AppMap
               end
             end.compact
           else
-            Array(guess_paths).map do |path|
+            Array(Service::Guesser.guess_paths).map do |path|
               Package.build_from_path(path)
             end
           end
 
         Config.new name, config_params
       end
-
-      def guess_name
-        reponame = lambda do
-          next unless File.directory?('.git')
-
-          repo_name = `git config --get remote.origin.url`.strip
-          repo_name.split('/').last.split('.').first unless repo_name == ''
-        end
-        dirname = -> { Dir.pwd.split('/').last }
-
-        reponame.() || dirname.()
-      end
-
-      def guess_paths
-        if defined?(::Rails)
-          %w[app/controllers app/models]
-        elsif File.directory?('lib')
-          %w[lib]
-        end
-      end
     end
 
     def to_h

data/lib/appmap/handler/rails/template.rb

@@ -14,16 +14,30 @@ module AppMap
         # The class name is generated from the template path. The package name is
         # 'app/views', and the method name is 'render'. The source location of the method
         # is, of course, the path to the view template.
-        TemplateMethod = Struct.new(:path) do
-          private_instance_methods :path
+        class TemplateMethod
           attr_reader :class_name
- 
+
+          attr_reader :path
+          private_instance_methods :path
+
           def initialize(path)
-            super
+            @path = path
 
             @class_name = path.parameterize.underscore
           end
-  
+
+          def id
+            [ package, path, name ]
+          end
+
+          def hash
+            id.hash
+          end
+
+          def eql?(other)
+            other.is_a?(TemplateMethod) && id.eql?(other.id)
+          end
+
           def package
             'app/views'
           end

data/lib/appmap/service/guesser.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module AppMap
+  module Service
+    class Guesser
+      POSSIBLE_PATHS = %w[app/controllers app/models lib]
+      class << self
+        def guess_name
+          reponame = lambda do
+            next unless File.directory?('.git')
+
+            repo_name = `git config --get remote.origin.url`.strip
+            repo_name.split('/').last.split('.').first unless repo_name == ''
+          end
+          dirname = -> { Dir.pwd.split('/').last }
+
+          reponame.() || dirname.()
+        end
+
+        def guess_paths
+          POSSIBLE_PATHS.select { |path| File.directory?(path) }
+        end
+      end
+    end
+  end
+end

data/lib/appmap/trace.rb

@@ -2,10 +2,12 @@
 
 module AppMap
   module Trace
-    class RubyMethod
+    class RubyMethod < SimpleDelegator
       attr_reader :class_name, :static
 
       def initialize(package, class_name, method, static)
+        super(method)
+
         @package = package
         @class_name = class_name
         @method = method
@@ -111,7 +113,7 @@ module AppMap
       @last_package_for_thread[Thread.current.object_id] = package if package
       @events << event
       static = event.static if event.respond_to?(:static)
-      @methods << Trace::RubyMethod.new(package, defined_class, method, static) \
+      record_method Trace::RubyMethod.new(package, defined_class, method, static) \
         if package && defined_class && method && (event.event == :call)
     end
 

data/lib/appmap/version.rb

@@ -3,9 +3,10 @@
 module AppMap
   URL = 'https://github.com/applandinc/appmap-ruby'
 
-  VERSION = '0.51.1'
+  VERSION = '0.51.2'
 
   APPMAP_FORMAT_VERSION = '1.5.1'
 
   DEFAULT_APPMAP_DIR = 'tmp/appmap'.freeze
+  DEFAULT_CONFIG_FILE_PATH = 'appmap.yml'.freeze
 end

data/test/cli_test.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class CLITest < Minitest::Test
+  CONFIG_FILENAME = '123.yml'
+  SUBFOLDER_CONFIG_FILEPATH = 'conf/123.yml'
+  EXPECTED_CONFIG_CONTENT = %(name: appmap-ruby
+packages:
+- path: lib
+)
+
+  def test_init_when_config_exists
+    output = `./exe/appmap-agent-setup init`
+    assert_equal 0, $CHILD_STATUS.exitstatus
+    assert_includes output, 'The AppMap config file appmap.yml already exists.'
+  end
+
+  def test_init_with_custom_config_filename
+    output = `./exe/appmap-agent-setup -c #{CONFIG_FILENAME} init`
+    assert_equal 0, $CHILD_STATUS.exitstatus
+    assert_includes output, "The following AppMap config file #{CONFIG_FILENAME} has been created:"
+    assert_equal EXPECTED_CONFIG_CONTENT, File.read(CONFIG_FILENAME)
+  ensure
+    File.delete(CONFIG_FILENAME) if File.exist?(CONFIG_FILENAME)
+  end
+
+  def test_init_with_custom_config_file_in_subfolder
+    output = `./exe/appmap-agent-setup -c #{SUBFOLDER_CONFIG_FILEPATH} init`
+    assert_equal 0, $CHILD_STATUS.exitstatus
+    assert_includes output, "The following AppMap config file #{SUBFOLDER_CONFIG_FILEPATH} has been created:"
+    assert_equal EXPECTED_CONFIG_CONTENT, File.read(SUBFOLDER_CONFIG_FILEPATH)
+  ensure
+    File.delete(SUBFOLDER_CONFIG_FILEPATH) if File.exist?(SUBFOLDER_CONFIG_FILEPATH)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.51.1
+  version: 0.51.2
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2021-06-21 00:00:00.000000000 Z
+date: 2021-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -307,7 +307,8 @@ dependencies:
 description: 
 email:
 - kgilpin@gmail.com
-executables: []
+executables:
+- appmap-agent-setup
 extensions:
 - ext/appmap/extconf.rb
 extra_rdoc_files: []
@@ -335,12 +336,14 @@ 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-agent-setup
 - ext/appmap/appmap.c
 - ext/appmap/extconf.rb
 - lib/appmap.rb
 - lib/appmap/algorithm/prune_class_map.rb
 - lib/appmap/algorithm/stats.rb
 - lib/appmap/class_map.rb
+- lib/appmap/command/init.rb
 - lib/appmap/command/record.rb
 - lib/appmap/command/stats.rb
 - lib/appmap/config.rb
@@ -360,6 +363,7 @@ files:
 - lib/appmap/railtie.rb
 - lib/appmap/record.rb
 - lib/appmap/rspec.rb
+- lib/appmap/service/guesser.rb
 - lib/appmap/trace.rb
 - lib/appmap/util.rb
 - lib/appmap/version.rb
@@ -556,6 +560,7 @@ files:
 - spec/spec_helper.rb
 - spec/util_spec.rb
 - test/bundle_vendor_test.rb
+- test/cli_test.rb
 - test/cucumber_test.rb
 - test/expectations/openssl_test_key_sign1.json
 - test/expectations/openssl_test_key_sign2.json