appmap 0.50.0 → 0.52.0

data/lib/appmap/handler/rails/template.rb

@@ -14,16 +14,30 @@ module AppMap
         # The class name is generated from the template path. The package name is
         # 'app/views', and the method name is 'render'. The source location of the method
         # is, of course, the path to the view template.
-        TemplateMethod = Struct.new(:path) do
-          private_instance_methods :path
+        class TemplateMethod
           attr_reader :class_name
- 
+
+          attr_reader :path
+          private_instance_methods :path
+
           def initialize(path)
-            super
+            @path = path
 
             @class_name = path.parameterize.underscore
           end
-  
+
+          def id
+            [ package, path, name ]
+          end
+
+          def hash
+            id.hash
+          end
+
+          def eql?(other)
+            other.is_a?(TemplateMethod) && id.eql?(other.id)
+          end
+
           def package
             'app/views'
           end

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/service/guesser.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module AppMap
+  module Service
+    class Guesser
+      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.()
+        end
+
+        def guess_paths
+          POSSIBLE_PATHS.select { |path| File.directory?(path) }
+        end
+      end
+    end
+  end
+end

data/lib/appmap/trace.rb

@@ -2,10 +2,12 @@
 
 module AppMap
   module Trace
-    class RubyMethod
+    class RubyMethod < SimpleDelegator
       attr_reader :class_name, :static
 
       def initialize(package, class_name, method, static)
+        super(method)
+
         @package = package
         @class_name = class_name
         @method = method
@@ -111,7 +113,7 @@ module AppMap
       @last_package_for_thread[Thread.current.object_id] = package if package
       @events << event
       static = event.static if event.respond_to?(:static)
-      @methods << Trace::RubyMethod.new(package, defined_class, method, static) \
+      record_method Trace::RubyMethod.new(package, defined_class, method, static) \
         if package && defined_class && method && (event.event == :call)
     end
 

data/lib/appmap/util.rb

@@ -4,6 +4,21 @@ require 'bundler'
 
 module AppMap
   module Util
+    # https://wynnnetherland.com/journal/a-stylesheet-author-s-guide-to-terminal-colors/
+    # Embed in a String to clear all previous ANSI sequences.
+    CLEAR   = "\e[0m"
+    BOLD    = "\e[1m"
+
+    # Colors
+    BLACK   = "\e[30m"
+    RED     = "\e[31m"
+    GREEN   = "\e[32m"
+    YELLOW  = "\e[33m"
+    BLUE    = "\e[34m"
+    MAGENTA = "\e[35m"
+    CYAN    = "\e[36m"
+    WHITE   = "\e[37m"
+
     class << self
       # scenario_filename builds a suitable file name from a scenario name.
       # Special characters are removed, and the file name is truncated to fit within
@@ -86,13 +101,13 @@ module AppMap
         # Rack prepends HTTP_ to all client-sent headers.
         matching_headers = env
           .select { |k,v| k.start_with? 'HTTP_'}
-          .reject { |k,v| v.blank? }
+          .reject { |k,v| blank?(v) }
           .each_with_object({}) do |kv, memo|
             key = kv[0].sub(/^HTTP_/, '').split('_').map(&:capitalize).join('-')
             value = kv[1]
             memo[key] = value
           end
-        matching_headers.blank? ? nil : matching_headers
+        blank?(matching_headers) ? nil : matching_headers
       end
 
       def normalize_path(path)
@@ -128,6 +143,41 @@ module AppMap
           FileUtils.mv tempfile.path, filename
         end
       end
+
+      def color(text, color, bold: false)
+        color = Util.const_get(color.to_s.upcase) if color.is_a?(Symbol)
+        bold  = bold ? BOLD : ""
+        "#{bold}#{color}#{text}#{CLEAR}"
+      end
+
+      def classify(word)
+        word.split(/[\-_]/).map(&:capitalize).join
+      end
+
+      def deep_dup(hash)
+        # This is a simple way to avoid the need for deep_dup from activesupport.
+        Marshal.load(Marshal.dump(hash))
+      end
+
+      def blank?(obj)
+        return true if obj.nil?
+        
+        return true if obj.is_a?(String) && obj == ''
+
+        return true if obj.respond_to?(:length) && obj.length == 0
+
+        return true if obj.respond_to?(:size) && obj.size == 0
+
+        false
+      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
 end

data/lib/appmap/version.rb

@@ -3,7 +3,10 @@
 module AppMap
   URL = 'https://github.com/applandinc/appmap-ruby'
 
-  VERSION = '0.50.0'
+  VERSION = '0.52.0'
 
   APPMAP_FORMAT_VERSION = '1.5.1'
+
+  DEFAULT_APPMAP_DIR = 'tmp/appmap'.freeze
+  DEFAULT_CONFIG_FILE_PATH = 'appmap.yml'.freeze
 end

data/package.json

@@ -1,12 +1,8 @@
 {
-  "name": "appmap-ruby-lore",
+  "name": "appmap-ruby",
   "version": "1.0.0",
-  "description": "Lore for the AppMap Rubygem",
-  "scripts": {
-    "start": "./node_modules/applore/bin/lore serve"
-  },
+  "description": "AppMap client agent for Ruby",
   "directories": {
-    "example": "examples",
     "lib": "lib",
     "test": "test"
   },
@@ -14,11 +10,14 @@
     "type": "git",
     "url": "git+https://github.com/applandinc/appmap-ruby.git"
   },
+  "author": "kgilpin@gmail.com",
+  "license": "MIT",
   "bugs": {
     "url": "https://github.com/applandinc/appmap-ruby/issues"
   },
   "homepage": "https://github.com/applandinc/appmap-ruby#readme",
   "dependencies": {
-    "applore": "^0.3.0"
+    "@appland/cli": "^1.1.0"
   }
 }
+

data/spec/config_spec.rb

@@ -55,4 +55,25 @@ describe AppMap::Config, docker: false do
 
     expect(config.to_h.deep_stringify_keys!).to eq(config_expectation)
   end
+
+  context do
+    let(:warnings) { @warnings ||= [] }
+    let(:warning) { warnings.join }
+    before do
+      expect(AppMap::Config).to receive(:warn).at_least(1) { |msg| warnings << msg }
+    end
+    it 'prints a warning and uses a default config' do
+      config = AppMap::Config.load_from_file 'no/such/file'
+      expect(config.to_h).to eq(YAML.load(<<~CONFIG))
+      :name: appmap-ruby
+      :packages:
+      - :path: lib
+        :handler_class: AppMap::Handler::Function
+        :shallow: false
+      :functions: []
+      :exclude: []
+      CONFIG
+      expect(warning).to include('NOTICE: The AppMap config file no/such/file was not found!')
+    end
+  end
 end

data/spec/fixtures/rails5_users_app/docker-compose.yml

@@ -13,7 +13,7 @@ services:
     build:
       context: .
       dockerfile: Dockerfile
-    image: rails-app:${RUBY_VERSION}
+    image: rails5-app:${RUBY_VERSION}
     command:
       [ "./bin/rails", "server", "-b", "0.0.0.0", "webrick" ]
     environment:

data/spec/fixtures/rails6_users_app/Dockerfile

@@ -4,9 +4,18 @@ ARG RUBY_VERSION
 FROM appmap:${GEM_VERSION} as appmap
 
 FROM ruby:${RUBY_VERSION}
+
+SHELL ["/bin/bash", "-c"]
+
 RUN apt-get update && apt-get install -y vim less
 RUN apt-get install -y postgresql-client
 
+RUN curl -fsSL https://fnm.vercel.app/install | bash \
+    && source /root/.bashrc \
+    && fnm install --lts \
+    && echo 'fnm default $(fnm current)' >> ~/.bashrc \
+    && ln -s $(which node) /usr/local/bin/node
+
 RUN mkdir /app
 WORKDIR /app
 

data/spec/fixtures/rails6_users_app/docker-compose.yml

@@ -13,7 +13,7 @@ services:
     build:
       context: .
       dockerfile: Dockerfile
-    image: rails-app:${RUBY_VERSION}
+    image: rails6-app:${RUBY_VERSION}
     command:
       [ "./bin/rails", "server", "-b", "0.0.0.0", "webrick" ]
     environment:

data/spec/hook_spec.rb

@@ -21,7 +21,7 @@ describe 'AppMap class Hooking', docker: false do
   def invoke_test_file(file, setup: nil, &block)
     AppMap.configuration = nil
     package = AppMap::Config::Package.build_from_path(file)
-    config = AppMap::Config.new('hook_spec', [ package ])
+    config = AppMap::Config.new('hook_spec', packages: [ package ])
     AppMap.configuration = config
     tracer = nil
     AppMap::Hook.new(config).enable do
@@ -57,7 +57,7 @@ describe 'AppMap class Hooking', docker: false do
   it 'excludes named classes and methods' do
     load 'spec/fixtures/hook/exclude.rb'
     package = AppMap::Config::Package.build_from_path('spec/fixtures/hook/exclude.rb')
-    config = AppMap::Config.new('hook_spec', [ package ], exclude: %w[ExcludeTest])
+    config = AppMap::Config.new('hook_spec', packages: [ package ], exclude: %w[ExcludeTest])
     AppMap.configuration = config
 
     expect(config.never_hook?(ExcludeTest, ExcludeTest.new.method(:instance_method))).to be_truthy

data/spec/{abstract_controller_base_spec.rb → rails_recording_spec.rb}

@@ -4,6 +4,7 @@ describe 'Rails' do
   %w[5 6].each do |rails_major_version| # rubocop:disable Metrics/BlockLength
     context "#{rails_major_version}" do
       include_context 'Rails app pg database', "spec/fixtures/rails#{rails_major_version}_users_app" unless use_existing_data?
+      include_context 'rails integration test setup'
 
       def run_spec(spec_name)
         cmd = <<~CMD.gsub "\n", ' '
@@ -13,24 +14,6 @@ describe 'Rails' do
         run_cmd cmd, chdir: fixture_dir
       end
 
-      def tmpdir
-        'tmp/spec/AbstractControllerBase'
-      end
-
-      unless use_existing_data?
-        before(:all) do
-          FileUtils.rm_rf tmpdir
-          FileUtils.mkdir_p tmpdir
-          run_spec 'spec/controllers/users_controller_spec.rb'
-          run_spec 'spec/controllers/users_controller_api_spec.rb'
-        end
-      end
-
-      let(:appmap) { JSON.parse File.read File.join tmpdir, 'appmap/rspec', appmap_json_file }
-      let(:appmap_json_path) { File.join(tmpdir, 'appmap/rspec', appmap_json_file) }
-      let(:appmap) { JSON.parse File.read(appmap_json_path) }
-      let(:events) { appmap['events'] }
-
       describe 'an API route' do
         describe 'creating an object' do
           let(:appmap_json_file) do
@@ -240,7 +223,8 @@ describe 'Rails' do
               'children' => include(hash_including(
                 'name' => 'ActionView',
                 'children' => include(hash_including(
-                  'name' => 'Renderer',
+                  # Rails 6/5 difference
+                  'name' => /^(Template)?Renderer$/,                  
                   'children' => include(hash_including(
                     'name' => 'render',
                     'labels' => ['mvc.view']
@@ -253,4 +237,40 @@ describe 'Rails' do
       end
     end
   end
+
+  describe 'with default appmap.yml' do
+    include_context 'Rails app pg database', "spec/fixtures/rails5_users_app" unless use_existing_data?
+    include_context 'rails integration test setup'
+
+    def run_spec(spec_name)
+      cmd = <<~CMD.gsub "\n", ' '
+        docker-compose run --rm -e RAILS_ENV=test -e APPMAP=true -e APPMAP_CONFIG_FILE=no/such/file
+        -v #{File.absolute_path tmpdir}:/app/tmp app ./bin/rspec #{spec_name}
+      CMD
+      run_cmd cmd, chdir: fixture_dir
+    end
+
+    let(:appmap_json_file) do
+      'Api_UsersController_POST_api_users_with_required_parameters_creates_a_user.appmap.json'
+    end
+
+    it 'http_server_request is recorded' do
+      expect(events).to include(
+        hash_including(
+          'http_server_request' => hash_including(
+            'request_method' => 'POST',
+            'path_info' => '/api/users'
+          )
+        )
+      )
+    end
+
+    it 'controller method is recorded' do
+      expect(events).to include hash_including(
+        'defined_class' => 'Api::UsersController',
+        'method_id' => 'build_user',
+        'path' => 'app/controllers/api/users_controller.rb',
+      )
+    end
+  end
 end

data/spec/rails_spec_helper.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'spec_helper'
+require 'active_support'
+require 'active_support/core_ext'
 require 'open3'
 
 def wait_for_container(app_name)
@@ -58,3 +60,23 @@ shared_context 'Rails app pg database' do |fixture_dir|
     end
   end
 end
+
+shared_context 'rails integration test setup' do
+  def tmpdir
+    'tmp/spec/AbstractControllerBase'
+  end
+
+  unless use_existing_data?
+    before(:all) do
+      FileUtils.rm_rf tmpdir
+      FileUtils.mkdir_p tmpdir
+      run_spec 'spec/controllers/users_controller_spec.rb'
+      run_spec 'spec/controllers/users_controller_api_spec.rb'
+    end
+  end
+
+  let(:appmap) { JSON.parse File.read File.join tmpdir, 'appmap/rspec', appmap_json_file }
+  let(:appmap_json_path) { File.join(tmpdir, 'appmap/rspec', appmap_json_file) }
+  let(:appmap) { JSON.parse File.read(appmap_json_path) }
+  let(:events) { appmap['events'] }
+end