feat: Add swagger rake task

Also incorporates work to reduce depenency on activesupport, by providing
simple implementations of functions such as blank?, classify, and
deep_dup

Author: kgilpin

lib/appmap.rb

@@ -1,124 +1,37 @@
 # 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'),
     '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|
@@ -155,6 +68,11 @@ def detect_metadata
   if defined?(::Minitest)
     require 'appmap/minitest'
   end
+  
+  if defined?(::Rake)
+    require 'appmap/swagger'
+  end
+  
 end.call
 
 AppMap.initialize_configuration if ENV['APPMAP'] == 'true'

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

lib/appmap/class_map.rb

@@ -111,15 +111,15 @@ def add_function(root, method)
           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
 
         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)

lib/appmap/config.rb

@@ -5,6 +5,7 @@
 require 'appmap/handler/net_http'
 require 'appmap/handler/rails/template'
 require 'appmap/service/guesser'
+require 'appmap/swagger/configuration'
 
 module AppMap
   class Config
@@ -81,8 +82,8 @@ def to_h
           package_name: package_name,
           gem: gem,
           handler_class: handler_class.name,
-          exclude: exclude.blank? ? nil : exclude,
-          labels: labels.blank? ? nil : labels,
+          exclude: Util.blank?(exclude) ? nil : exclude,
+          labels: Util.blank?(labels) ? nil : labels,
           shallow: shallow
         }.compact
       end
@@ -226,15 +227,17 @@ def method_hook(cls, method_names, labels)
       'JSON::Ext::Generator::State' => TargetMethods.new(:generate, Package.build_from_path('json', package_name: 'json', labels: %w[format.json.generate])),
     }.freeze
 
-    attr_reader :name, :appmap_dir, :packages, :exclude, :hooked_methods, :builtin_hooks
+    attr_reader :name, :appmap_dir, :packages, :exclude, :swagger_config, :hooked_methods, :builtin_hooks
 
     def initialize(name,
       packages: [],
+      swagger_config: Swagger::Configuration.new,
       exclude: [],
       functions: [])
       @name = name
       @appmap_dir = AppMap::DEFAULT_APPMAP_DIR
       @packages = packages
+      @swagger_config = swagger_config
       @hook_paths = Set.new(packages.map(&:path))
       @exclude = exclude
       @builtin_hooks = BUILTIN_HOOKS
@@ -351,6 +354,11 @@ def load(config_data)
             end
           end
 
+        if config_data['swagger']
+          swagger_config = Swagger::Configuration.load(config_data['swagger'])
+          config_params[:swagger_config] = swagger_config
+        end
+
         Config.new name, config_params
       end
     end

lib/appmap/handler/net_http.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'appmap/event'
+require 'appmap/util'
 
 module AppMap
   module Handler
@@ -38,7 +39,7 @@ def to_h
             headers: headers
           }.compact
 
-          unless params.blank?
+          unless Util.blank?(params)
             h[:message] = params.keys.map do |key|
               val = params[key]
               {

lib/appmap/handler/rails/request_handler.rb

@@ -2,6 +2,7 @@
 
 require 'appmap/event'
 require 'appmap/hook'
+require 'appmap/util'
 
 module AppMap
   module Handler
@@ -40,7 +41,7 @@ def to_h
                 headers: headers,
               }.compact
 
-              unless params.blank?
+              unless Util.blank?(params)
                 h[:message] = params.keys.map do |key|
                   val = params[key]
                   {

lib/appmap/metadata.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'appmap/util'
+
 module AppMap
   module Metadata
     class << self
@@ -40,9 +42,9 @@ def git_metadata
         git_sha = `git rev-parse HEAD`.strip
         git_status = `git status -s`.split("\n").map(&:strip)
         git_last_annotated_tag = `git describe --abbrev=0 2>/dev/null`.strip
-        git_last_annotated_tag = nil if git_last_annotated_tag.blank?
+        git_last_annotated_tag = nil if Util.blank?(git_last_annotated_tag)
         git_last_tag = `git describe --abbrev=0 --tags 2>/dev/null`.strip
-        git_last_tag = nil if git_last_tag.blank?
+        git_last_tag = nil if Util.blank?(git_last_tag)
         git_commits_since_last_annotated_tag = `git describe`.strip =~ /-(\d+)-(\w+)$/[1] rescue 0 if git_last_annotated_tag
         git_commits_since_last_tag = `git describe --tags`.strip =~ /-(\d+)-(\w+)$/[1] rescue 0 if git_last_tag