appmap 0.52.0 → 0.54.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91abfbaf6b18062625413f1a4ba9a465325af82734a04ab875bb8b4092f3bc34
-  data.tar.gz: 9fb260bc1fb09cc1a6bc6771114b8306f596d1595bcaf1234dd346abe871d3b7
+  metadata.gz: b5368ab640de6fdf14f35502a5c756b7c6f681ee8d9a87c5fd9cd13d2b1036d9
+  data.tar.gz: 15806ff9cfa6256bb29c9ed2d8cb7d4ff5f62cfc3354e313e3b6f52b4cd96c12
 SHA512:
-  metadata.gz: 4eb0fe09e7657fbb3541c17b047e2c0c24cb171201828b684353fd2de94fcca216f84b2776ce4a1f57fe1e721aaeb66c55fbea5fc627d9529f4bf687805a1079
-  data.tar.gz: 938da5ae0d846bc3e2c7f571ef836fe35f4d0fefebe5af9f5b5846b949c87c1cc1812881a973168c014cc789a0b6bb1ee9eb556d11406e846f99fdecd0eeb04a
+  metadata.gz: d078fcb6e1bf1942462be38f2547b73e34c6f9a0313aabdd8919070218701937bd53bec4207c34c48c37e7b67f69500fbd6339f6fc26ad11eed86e2027ca4acf
+  data.tar.gz: f5493735794a3385287721a30021996bc66ac44e19bc4e2214823eb78a730f07213989c93dadf8f38f0163c6c21fc39d375511b4ccd87b33974a54e667898b22

data/.travis.yml

@@ -1,5 +1,10 @@
 language: ruby
 
+rbenv:
+- 2.5
+- 2.6
+- 2.7
+
 addons:
   apt:
     packages:
@@ -38,7 +43,6 @@ jobs:
     - mkdir tmp
     - GEM_ALTERNATIVE_NAME='' bundle exec rake test
 
-    
 before_deploy:
   - |
     nvm install --lts \

data/CHANGELOG.md

@@ -1,3 +1,44 @@
+## [0.54.2](https://github.com/applandinc/appmap-ruby/compare/v0.54.1...v0.54.2) (2021-06-25)
+
+
+### Bug Fixes
+
+* Require appmap/railtie if Rails is defined ([66b4cbd](https://github.com/applandinc/appmap-ruby/commit/66b4cbd4d418695b0e69150d253dfd5a6f9096cf))
+
+## [0.54.1](https://github.com/applandinc/appmap-ruby/compare/v0.54.0...v0.54.1) (2021-06-25)
+
+
+### Bug Fixes
+
+* Add missing imports and remove deprecation warnings ([f1cb087](https://github.com/applandinc/appmap-ruby/commit/f1cb087f80cad88093227ebf8b4a4cd574853667))
+* Workaround Ruby bug in 2.7.3 with kwrest ([26e34ca](https://github.com/applandinc/appmap-ruby/commit/26e34ca421fdae6602b27fee5653c8fe26b3793b))
+
+# [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)
 
 

data/Rakefile

@@ -6,8 +6,7 @@ require 'rake/testtask'
 require 'rdoc/task'
 
 require 'open3'
-
-require "rake/extensiontask"
+require 'rake/extensiontask'
 
 desc 'build the native extension'
 Rake::ExtensionTask.new("appmap") do |ext|
@@ -26,7 +25,7 @@ namespace 'gem' do
       # ~/.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)
+        sh('yarn install --prod')
   
         default_build_gem
       end
@@ -34,7 +33,17 @@ namespace 'gem' do
   end
 end
 
-RUBY_VERSIONS=%w[2.5 2.6 2.7]
+RUBY_VERSIONS=%w[2.5 2.6 2.7].select do |version|
+  travis_ruby_version = ENV['TRAVIS_RUBY_VERSION']
+  next true unless travis_ruby_version
+
+  if travis_ruby_version.index(version) == 0
+    warn "Testing Ruby version #{version}, since it matches TRAVIS_RUBY_VERSION=#{travis_ruby_version}"
+    next true
+  end
+
+  false
+end
 FIXTURE_APPS=%w[rack_users_app rails6_users_app rails5_users_app]
 
 def run_cmd(*cmd)

data/appmap.gemspec

@@ -33,7 +33,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'activesupport'
-  spec.add_dependency 'gli'
   spec.add_dependency 'method_source'
   spec.add_dependency 'rack'
   spec.add_dependency 'reverse_markdown'
@@ -55,4 +54,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'webdrivers', '~> 4.0'
   spec.add_development_dependency 'timecop'
   spec.add_development_dependency 'hashie'
+  spec.add_development_dependency 'webrick'
 end

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/lib/appmap.rb

@@ -1,124 +1,38 @@
 # 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/util'
-require 'appmap/hook'
-require 'appmap/config'
-require 'appmap/trace'
-require 'appmap/class_map'
-require 'appmap/metadata'
-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)
-      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
-
-    # 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
-  end
-end
+require 'appmap/agent'
 
 lambda do
   Initializer = Struct.new(:class_name, :module_name, :gem_module_name)
 
   INITIALIZERS = {
-    'Rails::Railtie' => Initializer.new('AppMap::Railtie', 'appmap/railtie', 'railtie'),
+    # In a Rails app, Rails is always defined by the time the other gems are loaded. Therefore, we
+    # don't try and trap the loading of Rails itself here.
     '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|
@@ -144,7 +58,7 @@ lambda do
     end
   end.enable
 
-  if defined?(::Rails::Railtie)
+  if defined?(::Rails)
     require 'appmap/railtie'
   end
   
@@ -155,6 +69,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

data/lib/appmap/class_map.rb

@@ -111,7 +111,7 @@ module AppMap
           end
 
         comment = method.comment
-        function_info[:comment] = comment unless comment.blank?
+        function_info[:comment] = comment unless Util.blank?(comment)
 
         function_info[:labels] = parse_labels(comment) + (method.labels || [])
         object_infos << function_info
@@ -119,7 +119,7 @@ module AppMap
         parent = root
         object_infos.each do |info|
           parent = find_or_create parent.children, info do
-            Types.const_get(info[:type].classify).new(info[:name].to_s).tap do |type|
+            Types.const_get(Util.classify(info[:type])).new(info[:name].to_s).tap do |type|
               info.keys.tap do |keys|
                 keys.delete(:name)
                 keys.delete(:type)