appmap 0.51.1 → 0.53.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a51a7f69ebbca275fd9a215a52cd3e4d8db739e8e6cecf3eb522871f23295b5
-  data.tar.gz: 58f033b5c4f8756532dd3dbe83c631b36560e3215a342f804916de205f53cb56
+  metadata.gz: 69fc6d5fce636d669cb33a9564a3c504eb255cb13a81985154589eb7cc6f9879
+  data.tar.gz: f2400bbda425b4e0f8d72b52d7edfcf761c8356638691074c79b72fdbca9f086
 SHA512:
-  metadata.gz: e52a4b23f708892b12c3ca68a2b5e3c13a2c9b1d1b52057ede1548faa7c7d03914296ebb1402c7c1cd1f0540df1d6182ffa09de2cf3558410d499703bc8b352f
-  data.tar.gz: 32201a386bc48ef35395e702a46661f78b12c4b15cab6214203e91e3599537cc53742f5ef2848ecf3d73b3c6c007413b55b4ea22bc4f8c83131733b9b2ace4a3
+  metadata.gz: 17016392e9b2931c961bf1cdb3c7f832af15896201b395995c124befb7de1987ee43997f9186c329f9fe6474101158c06a0772e8bf0bd6bbd9b9b4ddd84defeb
+  data.tar.gz: 29fe408c9a44ec5cf8ffd410f732d6cc5959e045480c94406a4f9cc4abc2badbc1843f449bba0b8cd5e2b6269c71f8e5d603b9e99a902e63e6692d16af0e4c6f

data/.travis.yml

@@ -26,7 +26,9 @@ before_install:
     if [ ! -z "$DOCKERHUB_PASSWORD" ] && [ ! -z "$DOCKERHUB_USERNAME" ]; then
       echo "$DOCKERHUB_PASSWORD" | docker login -u "$DOCKERHUB_USERNAME" --password-stdin  ;
     fi
-
+  - |
+    nvm install --lts \
+      && nvm use --lts
  
 # GEM_ALTERNATIVE_NAME only needed for deployment 
 jobs:

data/CHANGELOG.md

@@ -1,3 +1,41 @@
+# [0.53.0](https://github.com/applandinc/appmap-ruby/compare/v0.52.1...v0.53.0) (2021-06-23)
+
+
+### Features
+
+* appmap-agent-setup as a separate command not using GLI library ([f0eedb7](https://github.com/applandinc/appmap-ruby/commit/f0eedb7451368ea0399872f3be680e1581ac6200))
+
+## [0.52.1](https://github.com/applandinc/appmap-ruby/compare/v0.52.0...v0.52.1) (2021-06-23)
+
+
+### Bug Fixes
+
+* Better project name guesser ([d22f379](https://github.com/applandinc/appmap-ruby/commit/d22f379623bd3022ba34d7241838fe6abbbb61d6))
+
+# [0.52.0](https://github.com/applandinc/appmap-ruby/compare/v0.51.3...v0.52.0) (2021-06-22)
+
+
+### Features
+
+* Bundle NPM package @appland/cli with this gem ([945e28c](https://github.com/applandinc/appmap-ruby/commit/945e28c699fff6bd97ae51983816e97955c4ff36))
+
+## [0.51.3](https://github.com/applandinc/appmap-ruby/compare/v0.51.2...v0.51.3) (2021-06-22)
+
+
+### Bug Fixes
+
+* Remove outdate lore, command, and algorithm code ([d899989](https://github.com/applandinc/appmap-ruby/commit/d8999896c611c16f51a092f5f7afb3d7203d7e72))
+
+## [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/Rakefile

@@ -16,6 +16,22 @@ end
 
 namespace 'gem' do
   require 'bundler/gem_tasks'
+  
+  module Bundler
+    class GemHelper
+      alias default_build_gem build_gem
+  
+      # A handy tip - find the location of any Rake task using `rake -W`.
+      # rake -W build
+      # ~/.rbenv/versions/2.6.6/lib/ruby/gems/2.6.0/gems/bundler-2.1.4/lib/bundler/gem_helper.rb:39:in `install'
+      def build_gem
+        # Ensure that NPM packages are installed before building.
+        sh('yarn install --prod'.shellsplit)
+  
+        default_build_gem
+      end
+    end
+  end
 end
 
 RUBY_VERSIONS=%w[2.5 2.6 2.7]
@@ -34,18 +50,19 @@ def run_cmd(*cmd)
     raise 'Docker build failed'
   end
 end
-  
+
 def build_base_image(ruby_version)
   run_cmd "docker build" \
          " --build-arg RUBY_VERSION=#{ruby_version}"    \
          " --build-arg GEM_VERSION=#{GEM_VERSION}"      \
          " -t appmap:#{GEM_VERSION} -f Dockerfile.appmap ."
 end
-  
+
 def build_app_image(app, ruby_version)
   Dir.chdir "spec/fixtures/#{app}" do
-    run_cmd( {"RUBY_VERSION" => ruby_version, "GEM_VERSION" => GEM_VERSION},
-      " docker-compose build" \
+    env = {"RUBY_VERSION" => ruby_version, "GEM_VERSION" => GEM_VERSION}
+    run_cmd(env,
+      "docker-compose build" \
       " --build-arg RUBY_VERSION=#{ruby_version}" \
       " --build-arg GEM_VERSION=#{GEM_VERSION}"  ) 
   end
@@ -139,4 +156,3 @@ task spec: %i[spec:all]
 task test: %i[spec:all minitest]
 
 task default: :test
-

data/appmap.gemspec

@@ -4,8 +4,6 @@ lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'appmap/version'
 
-
-
 Gem::Specification.new do |spec|
   # ability to parameterize gem name is added intentionally, 
   # to support the possibility of unofficial releases, e.g. during CI tests
@@ -22,19 +20,25 @@ 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.extensions << "ext/appmap/extconf.rb"
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
 
+  strip_dir = ->(file) { file.index(Dir.pwd) == 0 ? file[Dir.pwd.length+1...file.length] : file }
+  Dir.glob(File.join(__dir__, 'node_modules/**/*')).map(&strip_dir).each do |filename|
+    next if File.directory?(filename) || filename.length > 100
+    spec.files << filename
+  end
+
+  spec.extensions << "ext/appmap/extconf.rb"
   spec.require_paths = ['lib']
 
   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'
+  spec.add_dependency 'reverse_markdown'
 
   spec.add_development_dependency 'bundler', '>= 1.16'
-  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'minitest', '= 5.14.4'
   spec.add_development_dependency 'pry-byebug'
   spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rdoc'

data/exe/appmap-agent-init

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'optparse'
+require 'appmap'
+require 'appmap/command/agent_setup/init'
+
+@options = {:config_file => AppMap::DEFAULT_CONFIG_FILE_PATH}
+
+OptionParser.new do |parser|
+  parser.banner = 'Usage: bundle exec exe/appmap-agent-init [options]'
+
+  description = "AppMap configuration file path (default: #{AppMap::DEFAULT_CONFIG_FILE_PATH})"
+  parser.on('-c', '--config=FILEPATH', description) do |filepath|
+    @options[:config_file] = filepath
+  end
+end.parse!
+
+AppMap::Command::AgentSetup::Init.new(@options[:config_file]).perform

data/exe/appmap-inspect

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.join(__dir__, '../lib')
+
+require 'appmap/command/inspect'
+AppMap::Command::Inspect.run

data/lib/appmap.rb

@@ -8,12 +8,12 @@ rescue NameError
 end
 
 require 'appmap/version'
+require 'appmap/util'
 require 'appmap/hook'
 require 'appmap/config'
 require 'appmap/trace'
 require 'appmap/class_map'
 require 'appmap/metadata'
-require 'appmap/util'
 require 'appmap/open'
 
 # load extension
@@ -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}"
+      Util.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
@@ -112,17 +112,49 @@ module AppMap
   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::Util.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/agent_setup/init.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'appmap/service/guesser'
+require 'appmap/util'
+
+module AppMap
+  module Command
+    module AgentSetup
+      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
+end

data/lib/appmap/command/inspect.rb

@@ -0,0 +1,27 @@
+require 'appmap/version'
+require 'appmap/config'
+require 'appmap/node_cli'
+
+module AppMap
+  module Command
+    class Inspect < AppMap::NodeCLI
+      class << self
+        def run
+          command = Inspect.new(verbose: ENV['DEBUG'] == 'true')
+          command.inspect(ARGV)
+        end
+      end
+
+      def inspect(arguments)
+        detect_nodejs
+        index_appmaps
+
+        arguments.unshift 'inspect'
+        arguments.unshift APPMAP_JS
+        arguments.unshift 'node'
+
+        exec(*arguments)
+      end
+    end
+  end
+end

data/lib/appmap/command_error.rb

@@ -0,0 +1,13 @@
+module AppMap
+  # Raised when a system / shell command fails.
+  class CommandError < StandardError
+    attr_reader :command, :msg
+
+    def initialize(command, msg = nil)
+      super [ "Command failed: #{command}", msg ].compact.join('; ')
+
+      @command = command
+      @msg = msg
+    end
+  end
+end

data/lib/appmap/config.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
 require 'yaml'
+require 'appmap/util'
 require 'appmap/handler/net_http'
 require 'appmap/handler/rails/template'
+require 'appmap/service/guesser'
 
 module AppMap
   class Config
@@ -53,7 +55,7 @@ module AppMap
           if path
             Package.new(path, gem, package_name, exclude, labels, shallow)
           else
-            warn "#{gem} is not available in the bundle" if AppMap::Hook::LOG
+            AppMap::Util.startup_message "#{gem} is not available in the bundle"
           end
         end
 
@@ -284,7 +286,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 +310,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 +346,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