appmap 0.102.2 → 0.103.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7535028ffd94cccfeb167a51005d03d3eb49bdab5e987d08eaaa41040f2ead72
-  data.tar.gz: 1e447679a5a3b0b690d9db333e4150e28c84c5bc0556f221a959331c16ac259f
+  metadata.gz: da7a93e936ce2a43f5003c66a1c690b2a02add786ab25f620b09febeafe64859
+  data.tar.gz: f4b5bc2e8aa1fe181900fa31b2d3d1965fdbe79e6f8a4c9122039367c4b8bf40
 SHA512:
-  metadata.gz: 9356f03158736805234225c0a0368317658b4d2ad821ca67cb9c2582f5d7ada84a0c36edbbc71a26dab37509bcbc79c3e8bdaa16b64a76468702ccea068d4068
-  data.tar.gz: 592abd7344c26dbd07a6137aa99bf5b8ba21020569b796b6dcecb06a27a8bc24bb5079f9992d85cb6ebb9c43ab2d05690361dc1bc0e5c9dea52d78594290ebc6
+  metadata.gz: 8dc10f3ea70a97280466c1d36c693bf33bb6ef3874ee9fcc42dfd2cb38af04138e7206a434a45218beded2827737e0c34eaefe3ed016acc2d0052d9b04de2465
+  data.tar.gz: 6b0d23c664a28695748c83b4229e7321853025db183d100c3ce30ec9f3c4ce98228502fbb9e95e51ebfda22ac6849a73680854f94e4ae968ac22be0d9c0ea0da

data/.rubocop.yml

@@ -0,0 +1,6 @@
+AllCops:
+  DisabledByDefault: true
+  Exclude:
+    - 'lib/**'
+    - 'test/**'
+    - 'spec/**'

data/.standard.yml

@@ -0,0 +1 @@
+ruby_version: 2.6

data/.travis.yml

@@ -1,7 +1,7 @@
 language: ruby
 dist: focal
 cache:
-- bundle
+- bundler
 - yarn
 
 # Travis pre-installs some Ruby versions. You can see the current list
@@ -10,7 +10,7 @@ cache:
 # that list to not install rvm and ruby each time.
 rvm:
 - 2.6.9
-- 2.7.6
+- 2.7.5
 - 3.0.1 # doesn't show in pre-installed list
 - 3.1.2
 - 3.2.0

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+# [0.103.0](https://github.com/getappmap/appmap-ruby/compare/v0.102.2...v0.103.0) (2023-12-18)
+
+
+### Bug Fixes
+
+* Drop metadata timestamp ([950d8e6](https://github.com/getappmap/appmap-ruby/commit/950d8e63b87853d8d631f31e70dbf56b76166cec))
+
+
+### Features
+
+* APPMAP_OUTPUT_DIR ([82fe6d7](https://github.com/getappmap/appmap-ruby/commit/82fe6d7cc5b5672f45739ccaaf40b4b05c8fb074))
+* AppMap.record accepts thread ([9863cc5](https://github.com/getappmap/appmap-ruby/commit/9863cc557f3a32229a6068bcb05df095eaf107a2))
+* Drop extended git info ([1d26cb4](https://github.com/getappmap/appmap-ruby/commit/1d26cb451b8c1cee4cccfd1412ec9d8e8e88a3d9))
+* Ensure existence of the appmap output dir ([3019868](https://github.com/getappmap/appmap-ruby/commit/3019868ad9d08af581a33ce2ea8664e74255ca00))
+* Record around command-labeled methods ([9692e2b](https://github.com/getappmap/appmap-ruby/commit/9692e2b4fdf41bcb0bab96b0040cefe063c520ef))
+* Report metadata timestamp as iso8601 ([56f8a52](https://github.com/getappmap/appmap-ruby/commit/56f8a52b3c5b964e163c9ba6021cf0f44981369e))
+
 ## [0.102.2](https://github.com/getappmap/appmap-ruby/compare/v0.102.1...v0.102.2) (2023-11-07)
 
 

data/appmap.gemspec

@@ -1,56 +1,55 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('lib', __dir__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'appmap/version'
+require "appmap/version"
 
 Gem::Specification.new do |spec|
   # ability to parameterize gem name is added intentionally,
   # to support the possibility of unofficial releases, e.g. during CI tests
-  spec.name          = ENV.fetch('GEM_ALTERNATIVE_NAME', 'appmap')
-  spec.version       = AppMap::VERSION
-  spec.authors       = ['Kevin Gilpin']
-  spec.email         = ['kgilpin@gmail.com']
+  spec.name = ENV.fetch("GEM_ALTERNATIVE_NAME", "appmap")
+  spec.version = AppMap::VERSION
+  spec.authors = ["Kevin Gilpin"]
+  spec.email = ["kgilpin@gmail.com"]
 
-  spec.required_ruby_version = '>= 2.6.0'
+  spec.required_ruby_version = ">= 2.6.0"
 
-  spec.summary       = "Record the operation of a Ruby program, using the AppLand 'AppMap' format."
-  spec.homepage      = AppMap::URL
-  spec.license       = 'MIT'
+  spec.summary = "Record the operation of a Ruby program, using the AppLand 'AppMap' format."
+  spec.homepage = AppMap::URL
+  spec.license = "MIT"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = `git ls-files --no-deleted`.split("\n").grep_v(/appmap\.json$/).grep_v(%r{^(spec|test)/})
+  spec.files = `git ls-files --no-deleted`.split("\n").grep_v(/appmap\.json$/).grep_v(%r{^(spec|test)/})
 
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
 
-  spec.extensions << 'ext/appmap/extconf.rb'
-  spec.require_paths = ['lib']
+  spec.extensions << "ext/appmap/extconf.rb"
+  spec.require_paths = ["lib"]
 
-  spec.add_dependency 'method_source'
-  spec.add_dependency 'reverse_markdown'
+  spec.add_dependency "method_source"
+  spec.add_dependency "reverse_markdown"
 
-  spec.add_runtime_dependency 'activesupport'
-  spec.add_runtime_dependency 'rack'
+  spec.add_runtime_dependency "activesupport"
+  spec.add_runtime_dependency "rack"
 
-  spec.add_development_dependency 'bundler', '>= 1.16'
-  spec.add_development_dependency 'minitest', '~> 5.15'
-  spec.add_development_dependency 'pry-byebug'
-  spec.add_development_dependency 'rake', '>= 12.3.3'
-  spec.add_development_dependency 'rake-compiler'
-  spec.add_development_dependency 'rdoc'
-  spec.add_development_dependency 'standardrb', "~> 1.0"
+  spec.add_development_dependency "bundler", ">= 1.16"
+  spec.add_development_dependency "minitest", "~> 5.15"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency "rake-compiler"
+  spec.add_development_dependency "rdoc"
 
   # Testing
-  spec.add_development_dependency 'climate_control'
-  spec.add_development_dependency 'diffy'
-  spec.add_development_dependency 'hashie'
-  spec.add_development_dependency 'launchy'
-  spec.add_development_dependency 'random-port', '~> 0.5.1'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'selenium-webdriver'
-  spec.add_development_dependency 'timecop'
-  spec.add_development_dependency 'webdrivers', '~> 4.0'
-  spec.add_development_dependency 'webrick'
+  spec.add_development_dependency "climate_control"
+  spec.add_development_dependency "diffy"
+  spec.add_development_dependency "hashie"
+  spec.add_development_dependency "launchy"
+  spec.add_development_dependency "random-port", "~> 0.5.1"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "selenium-webdriver"
+  spec.add_development_dependency "timecop"
+  spec.add_development_dependency "webdrivers", "~> 4.0"
+  spec.add_development_dependency "webrick"
 end

data/lib/appmap/agent.rb

@@ -1,15 +1,15 @@
-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'
+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'
-require_relative './detect_enabled'
+require_relative "appmap"
+require_relative "detect_enabled"
 
 module AppMap
   class << self
@@ -25,13 +25,17 @@ module AppMap
     # Sets the configuration. This is only expected to happen once per
     # Ruby process.
     def configuration=(config)
-      warn 'AppMap is already configured' if @configuration && config
+      warn "AppMap is already configured" if @configuration && config
 
       @configuration = config
     end
 
+    def output_dir
+      ENV["APPMAP_OUTPUT_DIR"] || DEFAULT_APPMAP_DIR
+    end
+
     def default_config_file_path
-      ENV['APPMAP_CONFIG_FILE'] || 'appmap.yml'
+      ENV["APPMAP_CONFIG_FILE"] || "appmap.yml"
     end
 
     # Configures AppMap for recording. Default behavior is to configure from
@@ -58,10 +62,10 @@ module AppMap
       end
     end
 
-    def tracing_enabled?
+    def tracing_enabled?(thread: nil)
       return false unless @tracing
 
-      @tracing.enabled?
+      @tracing.enabled?(thread_id: thread&.object_id)
     end
 
     # Used to start tracing, stop tracing, and record events.
@@ -69,10 +73,10 @@ module AppMap
       @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
+    # Records the events which occur while processing a block, and returns an AppMap as a Hash.
+    # Recording may optionally capture only a single thread.
+    def record(thread: nil)
+      tracer = tracing.trace(thread: thread)
       tracer.enable
       begin
         yield
@@ -84,10 +88,10 @@ module AppMap
         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
+        "version" => AppMap::APPMAP_FORMAT_VERSION,
+        "metadata" => detect_metadata,
+        "classMap" => class_map(tracer.event_methods),
+        "events" => events
       }
     end
 
@@ -110,11 +114,11 @@ module AppMap
     end
 
     def parameter_schema?
-      ENV['APPMAP_PARAMETER_SCHEMA'] == 'true'
+      ENV["APPMAP_PARAMETER_SCHEMA"] == "true"
     end
 
     def explain_queries?
-      ENV['APPMAP_EXPLAIN_QUERIES'] == 'true'
+      ENV["APPMAP_EXPLAIN_QUERIES"] == "true"
     end
 
     def recording_enabled?(recording_method = nil)

data/lib/appmap/class_map.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'method_source'
+require "method_source"
 
 module AppMap
   class ClassMap
@@ -23,7 +23,7 @@ module AppMap
         include HasChildren
 
         def type
-          'package'
+          "package"
         end
 
         def to_h
@@ -38,7 +38,7 @@ module AppMap
         include HasChildren
 
         def type
-          'class'
+          "class"
         end
 
         def to_h
@@ -53,7 +53,7 @@ module AppMap
         attr_accessor :static, :location, :labels
 
         def type
-          'function'
+          "function"
         end
 
         def to_h
@@ -62,13 +62,34 @@ module AppMap
             type: type,
             location: location,
             static: static,
-            labels: labels,
+            labels: labels
           }.delete_if { |_, v| v.nil? || v == [] }
         end
       end
     end
 
     class << self
+      # Labels can be embedded in the function comment. Label format is similar to YARD and JavaDoc.
+      # The keyword is @labels or @label. The keyword is followed by space-separated labels.
+      # For example:
+      # @label provider.authentication security
+      # rubocop:disable Metrics/MethodLength
+      def parse_labels(comment)
+        return [] unless comment
+
+        comment
+          .split("\n")
+          .map { |line| line.match(/^\s*#\s*@labels?\s+(.*)/) }
+          .compact
+          .map { |match| match[1] }
+          .inject([]) { |accum, labels|
+          accum += labels.split(/\s+/)
+          accum
+        }
+          .sort
+      end
+      # rubocop:enable Metrics/MethodLength
+
       def build_from_methods(methods)
         root = Types::Root.new
         methods.each do |method|
@@ -76,13 +97,13 @@ module AppMap
         end
 
         collapse_package = lambda do |package|
-          next unless package.type == 'package'
+          next unless package.type == "package"
 
-          while package.children.length == 1 && package.children.all? { |child| child.type == 'package' }
+          while package.children.length == 1 && package.children.all? { |child| child.type == "package" }
             child = package.children[0]
             package.children.clear
             child.children.each { |child| package.children << child }
-            package.name = [ package.name, child.name ].join('/')
+            package.name = [package.name, child.name].join("/")
           end
           package.tap do
             package.children.map(&collapse_package)
@@ -96,20 +117,20 @@ module AppMap
 
       def add_function(root, method)
         object_infos = \
-          method.package.split('/').map do |name|
+          method.package.split("/").map do |name|
             {
               name: name,
-              type: 'package'
+              type: "package"
             }
-          end + method.class_name.split('::').map do |name|
+          end + method.class_name.split("::").map do |name|
             {
               name: name,
-              type: 'class'
+              type: "class"
             }
           end
         function_info = {
           name: method.name,
-          type: 'function',
+          type: "function",
           static: method.static
         }
         location = method.source_location
@@ -118,9 +139,9 @@ module AppMap
           if location
             location_file, lineno = location
             location_file = location_file[Dir.pwd.length + 1..-1] if location_file.index(Dir.pwd) == 0
-            [ location_file, lineno ].compact.join(':')
+            [location_file, lineno].compact.join(":")
           else
-            [ method.class_name, method.static ? '.' : '#', method.name ].join
+            [method.class_name, method.static ? "." : "#", method.name].join
           end
 
         comment = method.comment
@@ -143,22 +164,6 @@ module AppMap
         end
       end
 
-      # Labels can be embedded in the function comment. Label format is similar to YARD and JavaDoc.
-      # The keyword is @labels or @label. The keyword is followed by space-separated labels.
-      # For example:
-      # @label provider.authentication security
-      def parse_labels(comment)
-        return [] unless comment
-
-        comment
-          .split("\n")
-          .map { |line| line.match(/^\s*#\s*@labels?\s+(.*)/) }
-          .compact
-          .map { |match| match[1] }
-          .inject([]) { |accum, labels| accum += labels.split(/\s+/); accum }
-          .sort
-      end
-
       def find_or_create(list, info)
         obj = list.find { |item| item.type == info[:type] && item.name == info[:name] }
         return obj if obj