appmap 0.102.2 → 0.103.0

data/lib/appmap/rspec.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
-require_relative '../appmap'
-require_relative './util'
-require_relative './detect_enabled'
-require 'set'
-require 'fileutils'
+require_relative "../appmap"
+require_relative "util"
+require_relative "detect_enabled"
+require "set"
+require "fileutils"
 
 module AppMap
   module RSpec
-    APPMAP_OUTPUT_DIR = 'tmp/appmap/rspec'
-    LOG = (ENV['APPMAP_DEBUG'] == 'true' || ENV['DEBUG'] == 'true')
+    APPMAP_OUTPUT_DIR = File.join(AppMap.output_dir, "rspec")
+    LOG = (ENV["APPMAP_DEBUG"] == "true" || ENV["DEBUG"] == "true")
 
     def self.metadata
       AppMap.detect_metadata
@@ -52,7 +52,7 @@ module AppMap
       end
 
       def description
-        description? ? description_args.join(' ') : nil
+        description? ? description_args.join(" ") : nil
       end
 
       def parent
@@ -69,7 +69,7 @@ module AppMap
             example_group.parent_groups.first
           end
 
-        example_group_parent == example_group ? nil : ScopeExampleGroup.new(example_group_parent)
+        (example_group_parent == example_group) ? nil : ScopeExampleGroup.new(example_group_parent)
       end
     end
 
@@ -83,7 +83,7 @@ module AppMap
           # This is the ugliest thing ever but I don't want to lose it.
           # All the WebDriver calls are getting app-mapped and it's really unclear
           # what they are.
-          page.driver.options[:http_client].instance_variable_get('@server_url').port
+          page.driver.options[:http_client].instance_variable_get(:@server_url).port
         end
 
         warn "Starting recording of example #{example}@#{source_location}" if AppMap::RSpec::LOG
@@ -92,14 +92,14 @@ module AppMap
       end
 
       def source_location
-        result = example.location_rerun_argument.split(':')[0]
-        result = result[2..-1] if result.index('./') == 0
+        result = example.location_rerun_argument.split(":")[0]
+        result = result[2..-1] if result.index("./") == 0
         result
       end
 
       def finish(failure, exception)
         failed = true if failure || exception
-        warn "Finishing recording of #{failed ? 'failed ' : ''} example #{example}" if AppMap::RSpec::LOG
+        warn "Finishing recording of #{failed ? "failed " : ""} example #{example}" if AppMap::RSpec::LOG
         warn "Exception: #{exception}" if exception && AppMap::RSpec::LOG
 
         if failed
@@ -130,21 +130,21 @@ module AppMap
         description.reverse!
 
         normalize = lambda do |desc|
-          desc.gsub('it should behave like', '')
-              .gsub(/Controller$/, '')
-              .gsub(/\s+/, ' ')
-              .strip
+          desc.gsub("it should behave like", "")
+            .gsub(/Controller$/, "")
+            .gsub(/\s+/, " ")
+            .strip
         end
 
-        full_description = normalize.call(description.join(' '))
+        full_description = normalize.call(description.join(" "))
 
         AppMap::RSpec.save name: full_description,
-                           class_map: class_map,
-                           source_location: source_location,
-                           test_status: exception ? 'failed' : 'succeeded',
-                           test_failure: test_failure,
-                           exception: exception,
-                           events: events
+          class_map: class_map,
+          source_location: source_location,
+          test_status: exception ? "failed" : "succeeded",
+          test_failure: test_failure,
+          exception: exception,
+          events: events
       end
     end
 
@@ -169,10 +169,10 @@ module AppMap
         # The example is empty except for assertions. So RSwag has its own recorder, and RSpec
         # recording is disabled so it won't clobber the AppMap with empty data.
         recording = if example.metadata[:appmap] == false || example.metadata[:rswag]
-                      :disabled
-                    else
-                      Recording.new(example)
-                    end
+          :disabled
+        else
+          Recording.new(example)
+        end
 
         @recordings_by_example[example] = recording
       end
@@ -185,7 +185,7 @@ module AppMap
       end
 
       def config
-        @config or raise 'AppMap is not configured'
+        @config or raise "AppMap is not configured"
       end
 
       def add_event_methods(event_methods)
@@ -193,20 +193,20 @@ module AppMap
       end
 
       def save(name:, class_map:, source_location:, test_status:, test_failure:, exception:, events:, frameworks: [],
-               recorder: nil)
+        recorder: nil)
         metadata = AppMap::RSpec.metadata.tap do |m|
           m[:name] = name
           m[:source_location] = source_location
           m[:app] = AppMap.configuration.name
           m[:frameworks] ||= []
           m[:frameworks] << {
-            name: 'rspec',
-            version: Gem.loaded_specs['rspec-core']&.version&.to_s
+            name: "rspec",
+            version: Gem.loaded_specs["rspec-core"]&.version&.to_s
           }
           m[:frameworks] += frameworks
           m[:recorder] = recorder || {
-            name: 'rspec',
-            type: 'tests'
+            name: "rspec",
+            type: "tests"
           }
           m[:test_status] = test_status
           m[:test_failure] = test_failure if test_failure
@@ -242,9 +242,9 @@ module AppMap
 end
 
 if AppMap::RSpec.enabled?
-  require 'active_support/inflector/transliterate'
-  require 'rspec/core'
-  require 'rspec/core/example'
+  require "active_support/inflector/transliterate"
+  require "rspec/core"
+  require "rspec/core/example"
 
   module RSpec
     module Core

data/lib/appmap/trace.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'delegate'
+require "delegate"
 
 module AppMap
   module Trace
@@ -21,7 +21,7 @@ module AppMap
       end
 
       def comment
-        return nil if source_location.nil? || source_location.first.start_with?('<')
+        return nil if source_location.nil? || source_location.first.start_with?("<")
 
         # Do not use method_source's comment method because it's slow
         @comment ||= RubyMethod.last_comment(*source_location)
@@ -71,8 +71,8 @@ module AppMap
         end
       end
 
-      def enabled?
-        @tracers.any?(&:enabled?)
+      def enabled?(thread_id: nil)
+        @tracers.any? { |t| t.enabled?(thread_id: thread_id) }
       end
 
       def last_package_for_current_thread
@@ -103,11 +103,11 @@ module AppMap
   class StackPrinter
     class << self
       def enabled?
-        ENV['APPMAP_PRINT_STACKS'] == 'true'
+        ENV["APPMAP_PRINT_STACKS"] == "true"
       end
 
       def depth
-        (ENV['APPMAP_STACK_DEPTH'] || 20).to_i
+        (ENV["APPMAP_STACK_DEPTH"] || 20).to_i
       end
     end
 
@@ -116,21 +116,21 @@ module AppMap
     end
 
     def record(event)
-      stack = caller.select { |line| !line.index('/lib/appmap/') }[0...StackPrinter.depth].join("\n  ")
+      stack = caller.select { |line| !line.index("/lib/appmap/") }[0...StackPrinter.depth].join("\n  ")
       stack_hash = Digest::SHA256.hexdigest(stack)
       return if @@stacks[stack_hash]
 
       @@stacks[stack_hash] = stack
       puts
-      puts 'Event: ' + event.to_h.map { |k, v| [ "#{k}: #{v}" ] }.join(', ')
-      puts '  ' + stack
+      puts "Event: " + event.to_h.map { |k, v| ["#{k}: #{v}"] }.join(", ")
+      puts "  " + stack
       puts
     end
   end
 
   class Tracer
     attr_accessor :stacks
-    attr_reader   :thread_id, :events
+    attr_reader :thread_id, :events
 
     # Records the events which happen in a program.
     def initialize(thread_id: nil)
@@ -146,8 +146,10 @@ module AppMap
       @enabled = true
     end
 
-    def enabled?
-      @enabled
+    def enabled?(thread_id: nil)
+      return false unless @enabled
+
+      thread_id.nil? || @thread_id.nil? || @thread_id == thread_id
     end
 
     # Private function. Use AppMap.tracing#delete.

data/lib/appmap/util.rb

@@ -1,88 +1,92 @@
 # frozen_string_literal: true
 
-require 'bundler'
-require 'fileutils'
+require "bundler"
+require "fileutils"
 
+# rubocop:disable Metrics/MethodLength
+# rubocop:disable Metrics/ModuleLength
+# rubocop:disable Metrics/ClassLength
+# rubocop:disable Metrics/AbcSize
 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"
+    CLEAR = "\e[0m"
+    BOLD = "\e[1m"
 
     # Colors
-    BLACK   = "\e[30m"
-    RED     = "\e[31m"
-    GREEN   = "\e[32m"
-    YELLOW  = "\e[33m"
-    BLUE    = "\e[34m"
+    BLACK = "\e[30m"
+    RED = "\e[31m"
+    GREEN = "\e[32m"
+    YELLOW = "\e[33m"
+    BLUE = "\e[34m"
     MAGENTA = "\e[35m"
-    CYAN    = "\e[36m"
-    WHITE   = "\e[37m"
+    CYAN = "\e[36m"
+    WHITE = "\e[37m"
 
     class << self
       def parse_function_name(name)
-        package_tokens = name.split('/')
+        package_tokens = name.split("/")
 
         class_and_name = package_tokens.pop
-        class_name, function_name, static = if class_and_name.include?('.')
-                                              class_and_name.split('.',
-                                                                   2) + [ true ]
-                                            else
-                                              class_and_name.split(
-                                                '#', 2
-                                              ) + [ false ]
-                                            end
+        class_name, function_name, static = if class_and_name.include?(".")
+          class_and_name.split(".",
+            2) + [true]
+        else
+          class_and_name.split(
+            "#", 2
+          ) + [false]
+        end
 
         raise "Malformed fully-qualified function name #{name}" unless function_name
 
-        [ package_tokens.empty? ? 'ruby' : package_tokens.join('/'), class_name, static, function_name ]
+        [package_tokens.empty? ? "ruby" : package_tokens.join("/"), class_name, static, function_name]
       end
 
       # scenario_filename builds a suitable file name from a scenario name.
       # Special characters are removed, and the file name is truncated to fit within
       # shell limitations.
-      def scenario_filename(name, max_length: 255, separator: '_', extension: '.appmap.json')
+      def scenario_filename(name, max_length: 255, separator: "_", extension: ".appmap.json")
         # Cribbed from v5 version of ActiveSupport:Inflector#parameterize:
         # https://github.com/rails/rails/blob/v5.2.4/activesupport/lib/active_support/inflector/transliterate.rb#L92
         # Replace accented chars with their ASCII equivalents.
 
-        fname = name.encode('utf-8', invalid: :replace, undef: :replace, replace: '_')
+        fname = name.encode("utf-8", invalid: :replace, undef: :replace, replace: "_")
 
         # Turn unwanted chars into the separator.
         fname.gsub!(/[^a-z0-9\-_]+/i, separator)
 
         re_sep = Regexp.escape(separator)
-        re_duplicate_separator        = /#{re_sep}{2,}/
+        re_duplicate_separator = /#{re_sep}{2,}/
         re_leading_trailing_separator = /^#{re_sep}|#{re_sep}$/i
 
         # No more than one of the separator in a row.
         fname.gsub!(re_duplicate_separator, separator)
 
         # Finally, Remove leading/trailing separator.
-        fname.gsub!(re_leading_trailing_separator, '')
+        fname.gsub!(re_leading_trailing_separator, "")
 
         if (fname.length + extension.length) > max_length
-          require 'base64'
-          require 'digest'
+          require "base64"
+          require "digest"
           fname_digest = Base64.urlsafe_encode64 Digest::MD5.digest(fname), padding: false
-          fname[max_length - fname_digest.length - extension.length - 1..-1] = [ '-', fname_digest ].join
+          fname[max_length - fname_digest.length - extension.length - 1..-1] = ["-", fname_digest].join
         end
 
-        [ fname, extension ].join
+        [fname, extension].join
       end
 
       # sanitize_paths removes ephemeral values from objects with
       # embedded paths (e.g. an event or a classmap), making events
       # easier to compare across runs.
       def sanitize_paths(h)
-        require 'hashie'
+        require "hashie"
         h.extend(Hashie::Extensions::DeepLocate)
         keys = %i[path location]
         h.deep_locate lambda { |k, _v, o|
           next unless keys.include?(k)
 
-          fix = ->(v) { v.gsub(%r{#{Gem.dir}/gems/.*(?=lib)}, '') }
+          fix = ->(v) { v.gsub(%r{#{Gem.dir}/gems/.*(?=lib)}, "") }
           keys.each { |k| o[k] = fix.call(o[k]) if o[k] }
         }
 
@@ -105,8 +109,8 @@ module AppMap
           headers = event.dig(field, :headers)
           next unless headers
 
-          headers['Date'] = '<instanceof date>' if headers['Date']
-          headers['Server'] = headers['Server'].match(/^(\w+)/)[0] if headers['Server']
+          headers["Date"] = "<instanceof date>" if headers["Date"]
+          headers["Server"] = headers["Server"].match(/^(\w+)/)[0] if headers["Server"]
         end
 
         case event[:event]
@@ -122,8 +126,8 @@ module AppMap
           blank?(headers) ? nil : headers
         end
 
-        unless env['rack.version']
-          warn 'Request headers does not contain rack.version. HTTP_ prefix is not expected.'
+        unless env["rack.version"]
+          warn "Request headers does not contain rack.version. HTTP_ prefix is not expected."
           return finalize_headers.call(env.dup)
         end
 
@@ -131,15 +135,15 @@ module AppMap
         # Apparently, it's following the CGI spec in doing so.
         # https://datatracker.ietf.org/doc/html/rfc3875#section-4.1.18
         matching_headers = env
-                           .select { |k, _v| k.to_s.start_with? 'HTTP_' }
-                           .merge(
-                             'CONTENT_TYPE' => env['CONTENT_TYPE'],
-                             'CONTENT_LENGTH' => env['CONTENT_LENGTH'],
-                             'AUTHORIZATION' => env['AUTHORIZATION']
-                           )
-                           .reject { |_k, v| blank?(v) }
-                           .each_with_object({}) do |kv, memo|
-          key = kv[0].sub(/^HTTP_/, '').split('_').map(&:capitalize).join('-')
+          .select { |k, _v| k.to_s.start_with? "HTTP_" }
+          .merge(
+            "CONTENT_TYPE" => env["CONTENT_TYPE"],
+            "CONTENT_LENGTH" => env["CONTENT_LENGTH"],
+            "AUTHORIZATION" => env["AUTHORIZATION"]
+          )
+          .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
@@ -147,9 +151,9 @@ module AppMap
       end
 
       def normalize_path(path)
-        is_local_path    = -> { path.index(Dir.pwd) == 0 }
-        is_bundled_path  = -> { path.index(Bundler.bundle_path.to_s) == 0 }
-        is_vendored_path = -> { path.index(File.join(Dir.pwd, 'vendor/bundle')) == 0 }
+        is_local_path = -> { path.index(Dir.pwd) == 0 }
+        is_bundled_path = -> { path.index(Bundler.bundle_path.to_s) == 0 }
+        is_vendored_path = -> { path.index(File.join(Dir.pwd, "vendor/bundle")) == 0 }
 
         if is_local_path.call && !is_bundled_path.call && !is_vendored_path.call
           path[Dir.pwd.length + 1..-1]
@@ -168,13 +172,13 @@ module AppMap
       def extract_test_failure(exception)
         return unless exception
 
-        { message: exception.message }.tap do |test_failure|
+        {message: exception.message}.tap do |test_failure|
           first_location = exception.backtrace_locations&.find do |location|
             !Pathname.new(normalize_path(location.absolute_path || location.path)).absolute?
           end
           if first_location
             test_failure[:location] =
-              [ normalize_path(first_location.path), first_location.lineno ].join(':')
+              [normalize_path(first_location.path), first_location.lineno].join(":")
           end
         end
       end
@@ -182,21 +186,23 @@ module AppMap
       # Convert a Rails-style path from /org/:org_id(.:format)
       # to Swagger-style paths like /org/{org_id}
       def swaggerize_path(path)
-        path = path.split('(.')[0]
-        tokens = path.split('/')
+        path = path.split("(.")[0]
+        tokens = path.split("/")
         tokens.map do |token|
           # stop matching if an ending ) is found
           token.gsub(/^:(.*[^)])/, '{\1}')
-        end.join('/')
+        end.join("/")
       end
 
       # Atomically writes AppMap data to +filename+.
       def write_appmap(filename, appmap)
-        require 'tmpdir'
+        require "tmpdir"
+
+        FileUtils.mkdir_p(File.dirname(filename))
 
         # This is what Ruby Tempfile does; but we don't want the file to be unlinked.
         mode = File::RDWR | File::CREAT | File::EXCL
-        ::Dir::Tmpname.create([ 'appmap_', '.json' ]) do |tmpname|
+        ::Dir::Tmpname.create(["appmap_", ".json"]) do |tmpname|
           tempfile = File.open(tmpname, mode)
           tempfile.write(JSON.generate(appmap))
           tempfile.close
@@ -207,7 +213,7 @@ module AppMap
 
       def color(text, color, bold: false)
         color = Util.const_get(color.to_s.upcase) if color.is_a?(Symbol)
-        bold  = bold ? BOLD : ''
+        bold = bold ? BOLD : ""
         "#{bold}#{color}#{text}#{CLEAR}"
       end
 
@@ -219,24 +225,24 @@ module AppMap
       def underscore(camel_cased_word)
         return camel_cased_word unless /[A-Z-]|::/.match?(camel_cased_word)
 
-        word = camel_cased_word.to_s.gsub('::', '/')
+        word = camel_cased_word.to_s.gsub("::", "/")
         # word.gsub!(inflections.acronyms_underscore_regex) { "#{$1 && '_' }#{$2.downcase}" }
         word.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
         word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
-        word.tr!('-', '_')
+        word.tr!("-", "_")
         word.downcase!
         word
       end
 
       def deep_dup(hash)
-        require 'active_support/core_ext'
+        require "active_support/core_ext"
         hash.deep_dup
       end
 
       def blank?(obj)
         return true if obj.nil?
 
-        return true if obj.is_a?(String) && obj == ''
+        return true if obj.is_a?(String) && obj == ""
 
         return true if obj.respond_to?(:length) && obj.length == 0
 
@@ -257,7 +263,7 @@ module AppMap
       def startup_message(msg)
         if defined?(::Rails) && defined?(::Rails.logger) && ::Rails.logger
           ::Rails.logger.info msg
-        elsif ENV['DEBUG'] == 'true'
+        elsif ENV["DEBUG"] == "true"
           warn msg
         end
 
@@ -265,7 +271,7 @@ module AppMap
       end
 
       def ruby_minor_version
-        @ruby_minor_version ||= RUBY_VERSION.split('.')[0..1].join('.').to_f
+        @ruby_minor_version ||= RUBY_VERSION.split(".")[0..1].join(".").to_f
       end
 
       def gettime
@@ -274,3 +280,7 @@ module AppMap
     end
   end
 end
+# rubocop:enable Metrics/MethodLength
+# rubocop:enable Metrics/ModuleLength
+# rubocop:enable Metrics/ClassLength
+# rubocop:enable Metrics/AbcSize

data/lib/appmap/version.rb

@@ -3,7 +3,7 @@
 module AppMap
   URL = 'https://github.com/applandinc/appmap-ruby'
 
-  VERSION = '0.102.2'
+  VERSION = '0.103.0'
 
   APPMAP_FORMAT_VERSION = '1.12.0'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.102.2
+  version: 0.103.0
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-11-07 00:00:00.000000000 Z
+date: 2023-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: method_source
@@ -150,20 +150,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: standardrb
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: climate_control
   requirement: !ruby/object:Gem::Requirement
@@ -324,8 +310,10 @@ files:
 - ".nvmrc"
 - ".rbenv-gemsets"
 - ".releaserc.yml"
+- ".rubocop.yml"
 - ".ruby-version"
 - ".rufo"
+- ".standard.yml"
 - ".travis.yml"
 - ARCHITECTURE.md
 - CHANGELOG.md
@@ -414,6 +402,7 @@ files:
 - lib/appmap/hook/method.rb
 - lib/appmap/hook/method/ruby2.rb
 - lib/appmap/hook/method/ruby3.rb
+- lib/appmap/hook/record_around.rb
 - lib/appmap/hook_log.rb
 - lib/appmap/metadata.rb
 - lib/appmap/middleware/remote_recording.rb