appmap 0.50.0 → 0.52.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce006905408a0ee15ccaee33ecb13e8bfbf1bc7b93f3cc4cbb105e2be9849bee
-  data.tar.gz: 4f73e289a332301d6efbf0c7e8985b5e62a8a030f90c4265b221fc1d67c801be
+  metadata.gz: 91abfbaf6b18062625413f1a4ba9a465325af82734a04ab875bb8b4092f3bc34
+  data.tar.gz: 9fb260bc1fb09cc1a6bc6771114b8306f596d1595bcaf1234dd346abe871d3b7
 SHA512:
-  metadata.gz: 86108afa917712908800f9303368ee48c8b0bf7d66892e6aadd76a18d76d355106f751984579bf57f9fdd876f7e4071f75a0d6cdf4fd90dfa5ce90a93d1ed9a1
-  data.tar.gz: b62b7793fd03c9d3cb43792b0a9b056547b4dd9f75a6b31f582a12d7a19cfdf4eaee7f566b27eaaf9a36dd4477afa396184b31bc753858b979ac5fb6804d3027
+  metadata.gz: 4eb0fe09e7657fbb3541c17b047e2c0c24cb171201828b684353fd2de94fcca216f84b2776ce4a1f57fe1e721aaeb66c55fbea5fc627d9529f4bf687805a1079
+  data.tar.gz: 938da5ae0d846bc3e2c7f571ef836fe35f4d0fefebe5af9f5b5846b949c87c1cc1812881a973168c014cc789a0b6bb1ee9eb556d11406e846f99fdecd0eeb04a

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.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)
+
+
+### Bug Fixes
+
+* Add missing require 'yaml' ([1187a02](https://github.com/applandinc/appmap-ruby/commit/1187a023243caaab8cd48de5cbbddefa361636ad))
+
+# [0.51.0](https://github.com/applandinc/appmap-ruby/compare/v0.50.0...v0.51.0) (2021-06-21)
+
+
+### Features
+
+* Provide default appmap.yml settings ([7fa8159](https://github.com/applandinc/appmap-ruby/commit/7fa8159b5020e35f13379017b44906d671e62e64))
+
 # [0.50.0](https://github.com/applandinc/appmap-ruby/compare/v0.49.0...v0.50.0) (2021-06-17)
 
 

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,26 @@ 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-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 code editor plugins 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/agent_setup/init'
+      AppMap::Command::AgentSetup::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/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
@@ -27,7 +27,7 @@ module AppMap
     # Gets the configuration. If there is no configuration, the default
     # configuration is initialized.
     def configuration
-      @configuration ||= initialize
+      @configuration ||= initialize_configuration
     end
 
     # Sets the configuration. This is only expected to happen once per
@@ -38,13 +38,20 @@ module AppMap
       @configuration = config
     end
 
-    # Configures AppMap for recording. Default behavior is to configure from "appmap.yml".
+    def default_config_file_path
+      ENV['APPMAP_CONFIG_FILE'] || 'appmap.yml'
+    end
+
+    # Configures AppMap for recording. Default behavior is to configure from
+    # APPMAP_CONFIG_FILE, or 'appmap.yml'. If no config file is available, a
+    # configuration will be automatically generated and used - and the user is prompted
+    # to create the config file.
+    #
     # This method also activates the code hooks which record function calls as trace events.
     # 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(config_file_path = 'appmap.yml')
-      raise "AppMap configuration file #{config_file_path} does not exist" unless ::File.exists?(config_file_path)
-      warn "Configuring AppMap from path #{config_file_path}"
+    def initialize_configuration(config_file_path = default_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
@@ -105,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 if ENV['APPMAP'] == 'true'
+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,7 +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
@@ -52,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
 
@@ -223,10 +226,14 @@ module AppMap
       'JSON::Ext::Generator::State' => TargetMethods.new(:generate, Package.build_from_path('json', package_name: 'json', labels: %w[format.json.generate])),
     }.freeze
 
-    attr_reader :name, :packages, :exclude, :hooked_methods, :builtin_hooks
+    attr_reader :name, :appmap_dir, :packages, :exclude, :hooked_methods, :builtin_hooks
 
-    def initialize(name, packages, exclude: [], functions: [])
+    def initialize(name,
+      packages: [],
+      exclude: [],
+      functions: [])
       @name = name
+      @appmap_dir = AppMap::DEFAULT_APPMAP_DIR
       @packages = packages
       @hook_paths = Set.new(packages.map(&:path))
       @exclude = exclude
@@ -253,38 +260,98 @@ module AppMap
     class << self
       # Loads configuration data from a file, specified by the file name.
       def load_from_file(config_file_name)
-        require 'yaml'
-        load YAML.safe_load(::File.read(config_file_name))
+        logo = lambda do
+          Util.color(<<~LOGO, :magenta)
+             ___             __  ___
+            / _ | ___  ___  /  |/  /__ ____
+           / __ |/ _ \\/ _ \\/ /|_/ / _ `/ _ \\
+          /_/ |_/ .__/ .__/_/  /_/\\_,_/ .__/
+               /_/  /_/              /_/
+          LOGO
+        end
+
+        config_present = true if File.exists?(config_file_name)
+
+        config_data = if config_present
+          YAML.safe_load(::File.read(config_file_name))
+        else
+          warn logo.()
+          warn ''
+          warn Util.color(%Q|NOTICE: The AppMap config file #{config_file_name} was not found!|, :magenta, bold: true)
+          warn ''
+          warn Util.color(<<~MISSING_FILE_MSG, :magenta)
+          AppMap uses this file to customize its behavior. For example, you can use
+          the 'packages' setting to indicate which local file paths and dependency
+          gems you want to include in the AppMap. Since you haven't provided specific
+          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}
+          
+          Here are the default settings that will be used in the meantime. You can
+          copy and paste this example to start your appmap.yml.
+          MISSING_FILE_MSG
+          {}
+        end
+        load(config_data).tap do |config|
+          config_yaml = {
+            'name' => config.name,
+            'packages' => config.packages.select{|p| p.path}.map do |pkg|
+              { 'path' => pkg.path }
+            end,
+            'exclude' => []
+          }.compact
+          unless config_present
+            warn Util.color(YAML.dump(config_yaml), :magenta)
+            warn logo.()
+          end
+        end
       end
 
       # Loads configuration from a Hash.
       def load(config_data)
-        functions = (config_data['functions'] || []).map do |function_data|
-          package = function_data['package']
-          cls = function_data['class']
-          functions = function_data['function'] || function_data['functions']
-          raise 'AppMap class configuration should specify package, class and function(s)' unless package && cls && functions
-          functions = Array(functions).map(&:to_sym)
-          labels = function_data['label'] || function_data['labels']
-          labels = Array(labels).map(&:to_s) if labels
-          Function.new(package, cls, labels, functions)
+        name = config_data['name'] || Service::Guesser.guess_name
+        config_params = {
+          exclude: config_data['exclude']
+        }.compact
+
+        if config_data['functions']
+          config_params[:functions] = config_data['functions'].map do |function_data|
+            package = function_data['package']
+            cls = function_data['class']
+            functions = function_data['function'] || function_data['functions']
+            raise %q(AppMap config 'function' element should specify 'package', 'class' and 'function' or 'functions') unless package && cls && functions
+
+            functions = Array(functions).map(&:to_sym)
+            labels = function_data['label'] || function_data['labels']
+            labels = Array(labels).map(&:to_s) if labels
+            Function.new(package, cls, labels, functions)
+          end
         end
-        packages = (config_data['packages'] || []).map do |package|
-          gem = package['gem']
-          path = package['path']
-          raise 'AppMap package configuration should specify gem or path, not both' if gem && path
-
-          if gem
-            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)
+
+        config_params[:packages] = \
+          if config_data['packages']
+            config_data['packages'].map do |package|
+              gem = package['gem']
+              path = package['path']
+              raise %q(AppMap config 'package' element should specify 'gem' or 'path', not both) if gem && path
+
+              if gem
+                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'] || [], shallow: package['shallow'])
+              end
+            end.compact
           else
-            Package.build_from_path(path, exclude: package['exclude'] || [], shallow: package['shallow'])
+            Array(Service::Guesser.guess_paths).map do |path|
+              Package.build_from_path(path)
+            end
           end
-        end.compact
-        exclude = config_data['exclude'] || []
-        Config.new config_data['name'], packages, exclude: exclude, functions: functions
+
+        Config.new name, config_params
       end
     end
 
@@ -294,7 +361,7 @@ module AppMap
         packages: packages.map(&:to_h),
         functions: @functions.map(&:to_h),
         exclude: exclude
-      }
+      }.compact
     end
 
     # Determines if methods defined in a file path should possibly be hooked.