appmap 0.51.2 → 0.54.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 194f53c7e13b466fef13720503fe9f8c1ee149af724884224ce03753cc0d658f
-  data.tar.gz: e9c7d5578da6d9e80d9c06e70deaa32fe7da785ab94840a09739e474601a8cac
+  metadata.gz: a00ec7ef6ec83aebf28d11c8004c89885ae32562ef6384c6c7880ca09d380027
+  data.tar.gz: a16129c01467f043eb18786ea8f3cae2df65226b924e6f85b40614f7d563e8a1
 SHA512:
-  metadata.gz: 82da50065460e83bbbd0f35bdce8e04924d9e0388f1da9ba30cea0637594dce2d8dc3a9364c55e1492924e73dfb91cf163eac7fe7028e4b48eb5cb3c34a96c92
-  data.tar.gz: 96198ca1c1f3c5bdcd4d75ce275f8e76a39ff9c36cbaf314c642d91dac54403426a28b54c5a478a58295560af804dc3f44ac33ff9b1b710b1d401fab4c72cb75
+  metadata.gz: daeec49a1a7e46fa5d5f572755725d766a2c37e00f8013d93ac1cde6d7dcff504633b4ca74cbbc94c9a3d355bc221d795970e0af393be29557f03d8fbe06114a
+  data.tar.gz: f1c8b85f2e9224604f3138c208dbcff0dbb939aa1038834a8ca761b290b5f07086023857881dd4c14c37644a9ae403108ba059c4a337796ea7ecab0e6b2826bb

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,43 @@
+# [0.54.0](https://github.com/applandinc/appmap-ruby/compare/v0.53.0...v0.54.0) (2021-06-24)
+
+
+### Bug Fixes
+
+* Handle new behavior in RSpec ExampleGroup ([176d0df](https://github.com/applandinc/appmap-ruby/commit/176d0dfca0b2e4cc5a8908fa67c01dd0c79ef175))
+
+
+### Features
+
+* Add swagger rake task ([0aaae49](https://github.com/applandinc/appmap-ruby/commit/0aaae4973f0df530c75ed92b93f8a1940a948091))
+
+# [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)
 
 

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
@@ -25,19 +23,22 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
 
-  spec.extensions << "ext/appmap/extconf.rb"
+  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

@@ -1,124 +1,26 @@
 # frozen_string_literal: true
 
-begin
-  require 'active_support'
-  require 'active_support/core_ext'
-rescue NameError
-  warn 'active_support is not available. AppMap execution will continue optimistically without it...'
-end
+# This is the file that's loaded when you require 'appmap'.
+# If you require this file, we assume that you want to automatically activate all
+# the AppMap functionality that seems suitable for your project.
+# For example, if your project is a Rails project, the Railtie will be loaded.
+# If your bundle includes rspec, the appmap/rspec will be loaded.
+#
+# If you don't want this "all-in" behavior, then you can use the 'require' option
+# in your Gemfile to selectively activate just the AppMap features that you want. Then
+# you can manually configure/require other features, elsewhere in your code.
+# Note that you should always require 'appmap/agent' as early as possible, so that it can
+# observe and hook as much code loading as possible.
+#
+# Modules that you can load independently include:
+# - appmap/agent
+# - appmap/railtie
+# - appmap/rspec
+# - appmap/minitest
+# - appmap/swagger (Rake task)
 
 require 'appmap/version'
-require 'appmap/hook'
-require 'appmap/config'
-require 'appmap/trace'
-require 'appmap/class_map'
-require 'appmap/metadata'
-require 'appmap/util'
-require 'appmap/open'
-
-# load extension
-require 'appmap/appmap'
-
-module AppMap
-  class << self
-    @configuration = nil
-    @configuration_file_path = nil
-
-    # Gets the configuration. If there is no configuration, the default
-    # configuration is initialized.
-    def configuration
-      @configuration ||= initialize_configuration
-    end
-
-    # Sets the configuration. This is only expected to happen once per
-    # Ruby process.
-    def configuration=(config)
-      warn 'AppMap is already configured' if @configuration && config
-
-      @configuration = config
-    end
-
-    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_configuration(config_file_path = default_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
-      end
-    end
-
-    def info(msg)
-      if defined?(::Rails) && defined?(::Rails.logger)
-        ::Rails.logger.info msg
-      else
-        warn msg
-      end
-    end
-
-    # Used to start tracing, stop tracing, and record events.
-    def tracing
-      @tracing ||= Trace::Tracing.new
-    end
-
-    # Records the events which occur while processing a block,
-    # and returns an AppMap as a Hash.
-    def record
-      tracer = tracing.trace
-      begin
-        yield
-      ensure
-        tracing.delete(tracer)
-      end
-
-      events = [].tap do |event_list|
-        event_list << tracer.next_event.to_h while tracer.event?
-      end
-      {
-        'version' => AppMap::APPMAP_FORMAT_VERSION,
-        'metadata' => detect_metadata,
-        'classMap' => class_map(tracer.event_methods),
-        'events' => events
-      }
-    end
-
-    # Uploads an AppMap to the AppLand website and displays it.
-    def open(appmap = nil, &block)
-      appmap ||= AppMap.record(&block)
-      AppMap::Open.new(appmap).perform
-    end
-
-    # Builds a class map from a config and a list of Ruby methods.
-    def class_map(methods)
-      ClassMap.build_from_methods(methods)
-    end
-
-    # Returns default metadata detected from the Ruby system and from the
-    # filesystem.
-    def detect_metadata
-      @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
+require 'appmap/agent'
 
 lambda do
   Initializer = Struct.new(:class_name, :module_name, :gem_module_name)
@@ -126,7 +28,10 @@ lambda do
   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')
+    'Minitest::Unit::TestCase' => Initializer.new('AppMap::Minitest', 'appmap/minitest', 'minitest'),
+    'Rake' => [
+      Initializer.new('AppMap::Swagger', 'appmap/swagger', 'rake')
+    ]
   }
 
   TracePoint.new(:class) do |tp|
@@ -138,7 +43,7 @@ lambda do
 
       gem_module_name = initializers.first.gem_module_name
 
-      AppMap.startup_message AppMap::Util.color(<<~LOAD_MSG, :magenta)
+      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:
 
@@ -163,6 +68,11 @@ lambda do
   if defined?(::Minitest)
     require 'appmap/minitest'
   end
+  
+  if defined?(::Rake)
+    require 'appmap/swagger'
+  end
+  
 end.call
 
 AppMap.initialize_configuration if ENV['APPMAP'] == 'true'

data/lib/appmap/agent.rb

@@ -0,0 +1,115 @@
+require_relative 'version'
+require_relative 'hook'
+require_relative 'config'
+require_relative 'trace'
+require_relative 'class_map'
+require_relative 'metadata'
+require_relative 'util'
+require_relative 'open'
+
+# load extension
+require_relative 'appmap'
+
+module AppMap
+  class << self
+    @configuration = nil
+    @configuration_file_path = nil
+
+    # Gets the configuration. If there is no configuration, the default
+    # configuration is initialized.
+    def configuration
+      @configuration ||= initialize_configuration
+    end
+
+    # Sets the configuration. This is only expected to happen once per
+    # Ruby process.
+    def configuration=(config)
+      warn 'AppMap is already configured' if @configuration && config
+
+      @configuration = config
+    end
+
+    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_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
+      end
+    end
+
+    def info(msg)
+      if defined?(::Rails) && defined?(::Rails.logger)
+        ::Rails.logger.info msg
+      else
+        warn msg
+      end
+    end
+
+    def config_message(msg)
+      logger = if defined?(::Rails) && ::Rails.logger
+        ::Rails.logger
+      elsif ENV['DEBUG'] == 'true'
+        method(:warn)
+      else
+        ->(msg) { }
+      end
+      logger.call(msg)
+    end
+
+    # Used to start tracing, stop tracing, and record events.
+    def tracing
+      @tracing ||= Trace::Tracing.new
+    end
+
+    # Records the events which occur while processing a block,
+    # and returns an AppMap as a Hash.
+    def record
+      tracer = tracing.trace
+      begin
+        yield
+      ensure
+        tracing.delete(tracer)
+      end
+
+      events = [].tap do |event_list|
+        event_list << tracer.next_event.to_h while tracer.event?
+      end
+      {
+        'version' => AppMap::APPMAP_FORMAT_VERSION,
+        'metadata' => detect_metadata,
+        'classMap' => class_map(tracer.event_methods),
+        'events' => events
+      }
+    end
+
+    # Uploads an AppMap to the AppLand website and displays it.
+    def open(appmap = nil, &block)
+      appmap ||= AppMap.record(&block)
+      AppMap::Open.new(appmap).perform
+    end
+
+    # Builds a class map from a config and a list of Ruby methods.
+    def class_map(methods)
+      ClassMap.build_from_methods(methods)
+    end
+
+    # Returns default metadata detected from the Ruby system and from the
+    # filesystem.
+    def detect_metadata
+      @metadata ||= Metadata.detect.freeze
+      Util.deep_dup(@metadata)
+    end
+  end
+end