appmap 0.51.2 → 0.54.0

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)

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,9 +1,11 @@
 # frozen_string_literal: true
 
 require 'yaml'
+require 'appmap/util'
 require 'appmap/handler/net_http'
 require 'appmap/handler/rails/template'
 require 'appmap/service/guesser'
+require 'appmap/swagger/configuration'
 
 module AppMap
   class Config
@@ -54,7 +56,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
 
@@ -80,8 +82,8 @@ module AppMap
           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
@@ -225,15 +227,17 @@ 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, :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
@@ -350,6 +354,11 @@ module AppMap
             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

data/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 @@ module AppMap
             headers: headers
           }.compact
 
-          unless params.blank?
+          unless Util.blank?(params)
             h[:message] = params.keys.map do |key|
               val = params[key]
               {

data/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 @@ module AppMap
                 headers: headers,
               }.compact
 
-              unless params.blank?
+              unless Util.blank?(params)
                 h[:message] = params.keys.map do |key|
                   val = params[key]
                   {

data/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 @@ module AppMap
         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
 

data/lib/appmap/minitest.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'appmap/util'
+require 'active_support'
+require 'active_support/core_ext'
 
 module AppMap
   # Integration of AppMap with Minitest. When enabled with APPMAP=true, the AppMap tracer will

data/lib/appmap/node_cli.rb

@@ -0,0 +1,59 @@
+require 'open3'
+require 'shellwords'
+require 'appmap/util'
+require 'appmap/command_error'
+
+module AppMap
+  # Utilities for invoking the +@appland/appmap+ CLI.
+  class NodeCLI
+    APPMAP_JS = Pathname.new(__dir__).join('../../node_modules/@appland/cli/src/cli.js').expand_path.to_s
+
+    attr_reader :verbose
+    # Directory to scan for AppMaps.
+    attr_accessor :appmap_dir
+
+    def initialize(verbose: false, appmap_dir: AppMap::DEFAULT_APPMAP_DIR)
+      @verbose = verbose
+      @appmap_dir = appmap_dir
+
+      detect_nodejs
+    end
+
+    def detect_nodejs
+      do_fail('node', 'please install NodeJS') unless system('node --version 2>&1 > /dev/null')
+      true
+    end
+
+    def index_appmaps
+      command [ 'index', '--appmap-dir', appmap_dir ]
+      true
+    end
+
+    def command(command, options = {})
+      command.unshift << '--verbose' if verbose
+      command.unshift APPMAP_JS
+      command.unshift 'node'
+
+      warn command.join(' ') if verbose
+      stdout, stderr, status = Open3.capture3({ 'NODE_OPTIONS' => '--trace-warnings' }, *command.map(&:shellescape), options)
+      stdout_msg = stdout.split("\n").map {|line| "stdout: #{line}"}.join("\n") unless Util.blank?(stdout)
+      stderr_msg = stderr.split("\n").map {|line| "stderr: #{line}"}.join("\n") unless Util.blank?(stderr)
+      if verbose
+        warn stdout_msg if stdout_msg
+        warn stderr_msg if stderr_msg
+      end
+      unless status.exitstatus == 0
+        raise CommandError.new(command, [ stdout_msg, stderr_msg ].compact.join("\n"))
+      end
+      [ stdout, stderr ]
+    end
+
+    protected
+
+    def do_fail(command, msg)
+      command = command.join(' ') if command.is_a?(Array)
+      warn [ command, msg ].join('; ') if verbose
+      raise CommandError.new(command, msg)
+    end
+  end
+end

data/lib/appmap/railtie.rb

@@ -5,8 +5,8 @@ module AppMap
   class Railtie < ::Rails::Railtie
     initializer 'appmap.remote_recording' do
       require 'appmap/middleware/remote_recording'
-      Rails.application.config.middleware.insert_after \
-        Rails::Rack::Logger,
+      Rails.application.config.middleware.insert_before \
+        ActionDispatch::Executor,
         AppMap::Middleware::RemoteRecording
     end
 

data/lib/appmap/rspec.rb

@@ -62,8 +62,10 @@ module AppMap
         example_group_parent = \
           if example_group.respond_to?(:module_parent)
             example_group.module_parent
-          else
+          elsif example_group.respond_to?(:parent)
             example_group.parent
+          elsif example_group.respond_to?(:parent_groups)
+            example_group.parent_groups.first
           end
 
         example_group_parent != example_group ? ScopeExampleGroup.new(example_group_parent) : nil
@@ -109,13 +111,13 @@ module AppMap
 
         description = []
         scope = ScopeExample.new(example)
-
         while scope
           description << scope.description
           scope = scope.parent
         end
 
-        description.reject!(&:nil?).reject!(&:blank?)
+        description.reject!(&:nil?)
+        description.reject!(&Util.method(:blank?))
         default_description = description.last
         description.reverse!
 

data/lib/appmap/service/guesser.rb

@@ -6,15 +6,8 @@ module AppMap
       POSSIBLE_PATHS = %w[app/controllers app/models lib]
       class << self
         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.()
+          return Pathname.new(`git rev-parse --show-toplevel`.strip).basename.to_s if File.directory?('.git')
+          Dir.pwd.split('/').last
         end
 
         def guess_paths

data/lib/appmap/swagger.rb

@@ -0,0 +1,2 @@
+require 'appmap/swagger/configuration'
+require 'appmap/swagger/rake_tasks'

data/lib/appmap/swagger/configuration.rb

@@ -0,0 +1,70 @@
+require 'yaml'
+
+module AppMap
+  module Swagger
+    class Configuration
+      DEFAULT_VERSION = '1.0'
+      DEFAULT_OUTPUT_DIR = 'swagger'
+      DEFAULT_DESCRIPTION = 'Generate Swagger from AppMaps'
+
+      attr_accessor :project_version,
+        :output_dir,
+        :description
+      attr_writer :project_name, :template
+
+      class << self
+        def load(config_data)
+          Configuration.new.tap do |config|
+            config_data.each do |k,v|
+              config.send "#{k}=", v
+            end
+          end
+        end
+      end
+
+      def initialize
+        @project_name = nil
+        @project_version = DEFAULT_VERSION
+        @output_dir = DEFAULT_OUTPUT_DIR
+        @description = DEFAULT_DESCRIPTION
+      end
+
+      def project_name
+        @project_name || default_project_name
+      end
+
+      def template
+        @template || default_template
+      end
+
+      def default_template
+        YAML.load <<~TEMPLATE
+          openapi: 3.0.1
+          info:
+            title: #{project_name}
+            version: #{project_version}
+          paths:
+          components:
+          servers:
+          - url: http://{defaultHost}
+            variables:
+              defaultHost:
+                default: localhost:3000
+          TEMPLATE
+      end
+
+      def default_project_name
+        # https://www.rubydoc.info/docs/rails/Module#module_parent_name-instance_method
+        module_parent_name = ->(cls) { cls.name =~ /::[^:]+\Z/ ? $`.freeze : nil }
+
+        # Lazy-evaluate this so that Rails.application will be defined.
+        # If this code runs too early in the lifecycle, Rails.application is nil.
+        if defined?(::Rails)
+          [module_parent_name.(::Rails.application.class).humanize.titleize, "API"].join(" ")
+        else
+          "MyProject API"
+        end
+      end
+    end
+  end
+end

data/lib/appmap/swagger/markdown_descriptions.rb

@@ -0,0 +1,43 @@
+require 'rdoc'
+require 'reverse_markdown'
+
+module AppMap
+  module Swagger
+    # Transform description fields into Markdown.
+    class MarkdownDescriptions
+      def initialize(swagger_yaml)
+        @swagger_yaml = swagger_yaml
+      end
+
+      def converter
+        method(:rdoc_to_markdown)
+      end
+
+      def perform
+        to_markdown = lambda do |obj|
+          return obj.each(&to_markdown) if obj.is_a?(Array)
+          return unless obj.is_a?(Hash)
+
+          description = obj['description']
+          obj['description'] = converter.(description) if description
+
+          obj.reject { |k,v| k == 'properties' }.each_value(&to_markdown)
+
+          obj
+        end
+
+        to_markdown.(Util.deep_dup(@swagger_yaml))
+      end
+
+      protected
+
+      def rdoc_to_markdown(comment)
+        # Strip tags
+        comment = comment.split("\n").reject { |line| line =~ /^\s*@/ }.join("\n")
+        converter = ::RDoc::Markup::ToHtml.new(::RDoc::Options.new)
+        html = converter.convert(comment).strip
+        ::ReverseMarkdown.convert(html).strip
+      end
+    end
+  end
+end