appmap 0.77.0 → 0.77.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72b52604fce9e01c3e4bc760d12f877a47b846a2f42a3e880dc3fbe3a3caf07b
-  data.tar.gz: 50428860dafdf6f79add97f9f51787014358b6178f5206ebc915c85dced62eb7
+  metadata.gz: 6889544929fdf05360b3e528847aaa1e3c4a423c580b982d5ecbb3403a44f6aa
+  data.tar.gz: dad6b337385f4700b0974bf727329afa2bcd4c33f5a17bd951fd9516608a5798
 SHA512:
-  metadata.gz: ae7670741f126ccf52fc7916229f29831a4320a673db755ab9c38fa9286e970baa447134c96acab4f443a4115bd8bca8f49552a983212e328bacabd88abd8352
-  data.tar.gz: 5e7b760bc10d31a40ae44996a9200e1ef6c3976364b4a43e5dd6b7b9b81005f57e1efac758f54b4d8274dc420cc74baebf91629ab12bc2a26b8959642feba56d
+  metadata.gz: 197d249f8aa3ca22766168688f3b31e3b9cdf4c16d20227012d77dc5d6d1eb16b7814af8e605b51a5dc5a60ef4861f8cfd3f7089878ff88b046fac59a15b52a3
+  data.tar.gz: 0e74d7f95043ea588f0a0ef9aca170765db7475c6009d6471ce2299885b59aca25eb4d87bb72cd7045a2a743b6b8c95fbb6348786d99cb938a269c73189a5234

data/.travis.yml

@@ -1,10 +1,13 @@
 language: ruby
 dist: bionic
 
+# NB: if you update the ruby versions here, you also need to update
+# them in the Rakefile.
 rbenv:
 - 2.6
 - 2.7
 - 3.0
+- 3.1
 
 addons:
   apt:

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+## [0.77.3](https://github.com/applandinc/appmap-ruby/compare/v0.77.2...v0.77.3) (2022-03-29)
+
+
+### Bug Fixes
+
+* Rescue exceptions when calling Class#to_s ([f59f2f6](https://github.com/applandinc/appmap-ruby/commit/f59f2f6b39664ff050486c88ff1b859ca0db48d8))
+
+## [0.77.2](https://github.com/applandinc/appmap-ruby/compare/v0.77.1...v0.77.2) (2022-03-25)
+
+
+### Bug Fixes
+
+* Pass the proper openapi-template arg ([05cbfde](https://github.com/applandinc/appmap-ruby/commit/05cbfdebdf80e3df2105a943ad892d5a7df614d7))
+
+## [0.77.1](https://github.com/applandinc/appmap-ruby/compare/v0.77.0...v0.77.1) (2022-03-24)
+
+
+### Bug Fixes
+
+* Add 3.1 as a supported version ([453f6df](https://github.com/applandinc/appmap-ruby/commit/453f6dfc5de29303fc9cbcf60ce0c3499528711c))
+
 # [0.77.0](https://github.com/applandinc/appmap-ruby/compare/v0.76.0...v0.77.0) (2022-03-22)
 
 

data/Rakefile

@@ -2,6 +2,21 @@ $: << File.join(__dir__, 'lib')
 require 'appmap/version'
 GEM_VERSION = AppMap::VERSION
 
+# Make sure the local version is not behind the one on
+# rubygems.org (it's ok if they're the same).
+#
+# If it is behind, the fixture images won't get updated with the gem
+# built from the local source, so you'll wind up testing the rubygems
+# version instead.
+unless ENV['SKIP_VERSION_CHECK']
+  require 'json'
+  require 'net/http'
+  rubygems_version = JSON.parse(Net::HTTP.get(URI.parse('https://rubygems.org/api/v1/gems/appmap.json')))['version']
+  if Gem::Version.new(GEM_VERSION) < Gem::Version.new(rubygems_version)
+    raise "#{GEM_VERSION} < #{rubygems_version}. Rebase to avoid build issues."
+  end
+end
+
 require 'rake/testtask'
 require 'rdoc/task'
 
@@ -13,7 +28,7 @@ Rake::ExtensionTask.new("appmap") do |ext|
   ext.lib_dir = "lib/appmap"
 end
 
-RUBY_VERSIONS=%w[2.6 2.7 3.0].select do |version|
+RUBY_VERSIONS=%w[2.6 2.7 3.0 3.1].select do |version|
   travis_ruby_version = ENV['TRAVIS_RUBY_VERSION']
   next true unless travis_ruby_version
 
@@ -24,7 +39,7 @@ RUBY_VERSIONS=%w[2.6 2.7 3.0].select do |version|
 
   false
 end
-FIXTURE_APPS=%w[rack_users_app rails6_users_app rails5_users_app]
+FIXTURE_APPS=[:rack_users_app, :rails6_users_app, :rails5_users_app, :rails7_users_app => {:ruby_version => '>= 2.7'}]
 
 def run_cmd(*cmd)
   $stderr.puts "Running: #{cmd}"
@@ -83,7 +98,17 @@ namespace :build do
     RUBY_VERSIONS.each do |ruby_version|
       namespace ruby_version do
         desc "build:fixtures:#{ruby_version}"
-        FIXTURE_APPS.each do |app|
+        FIXTURE_APPS.each do |app_spec|
+          app = if app_spec.instance_of?(Hash)
+            app_spec = app_spec.flatten
+            version_rqt = Gem::Requirement.create(app_spec[1][:ruby_version])
+            next unless version_rqt =~ (Gem::Version.new(ruby_version))
+            app = app_spec[0]
+          else
+            app = app_spec
+          end.to_s
+
+
           desc app
           task app => ["base:#{ruby_version}"] do
             build_app_image(app, ruby_version)
@@ -109,12 +134,13 @@ def run_specs(ruby_version, task_args)
   # description), because it's not intended to be invoked directly
   RSpec::Core::RakeTask.new("rspec_#{ruby_version}", [:specs]) do |task, args|
     task.exclude_pattern = 'spec/fixtures/**/*_spec.rb'
+    task.rspec_opts = '-f doc'
     if args.count > 0
       # There doesn't appear to be a value for +pattern+ that will
       # cause it to be ignored. Setting it to '' or +nil+ causes an
       # empty argument to get passed to rspec, which confuses it.
       task.pattern = 'never match this'
-      task.rspec_opts = args.to_a.join(' ')
+      task.rspec_opts += " " + args.to_a.join(' ')
     end
   end
 

data/appmap.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'reverse_markdown'
 
   spec.add_development_dependency 'bundler', '>= 1.16'
-  spec.add_development_dependency 'minitest', '= 5.14.4'
+  spec.add_development_dependency 'minitest', '~> 5.14'
   spec.add_development_dependency 'pry-byebug'
   spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rdoc'

data/lib/appmap/config.rb

@@ -450,7 +450,15 @@ module AppMap
 
       # Hook a method which is specified by class and method name.
       def package_for_code_object
-        class_name = cls.to_s.index('#<Class:') == 0 ? cls.to_s['#<Class:'.length...-1] : cls.name
+        class_name = begin
+                       cls.to_s.index('#<Class:') == 0 ? cls.to_s['#<Class:'.length...-1] : cls.name
+                     rescue
+                       # Calling #to_s on some Rails classes
+                       # (e.g. those generated to represent
+                       # associations) will raise an exception. Fall
+                       # back to using the class name.
+                       cls.name
+                     end
         Array(config.gem_hooks[class_name])
           .find { |hook| hook.include_method?(method.name) }
           &.package

data/lib/appmap/swagger/rake_tasks.rb

@@ -20,9 +20,14 @@ module AppMap
           appmap_js = AppMap::NodeCLI.new(verbose: Rake.verbose == true)
 
           FileUtils.mkdir_p configuration.swagger_config.output_dir
+          swagger_template = Tempfile.new('swagger_template')
+
+          swagger_template.write(configuration.swagger_config.template.to_yaml)
+          swagger_template.close
 
           cmd = %w[swagger]
-  
+          cmd << '--openapi-template' << swagger_template.path
+
           swagger_raw, = appmap_js.command(cmd)
 
           gen_swagger = YAML.load(swagger_raw)

data/lib/appmap/version.rb

@@ -3,11 +3,11 @@
 module AppMap
   URL = 'https://github.com/applandinc/appmap-ruby'
 
-  VERSION = '0.77.0'
+  VERSION = '0.77.3'
 
   APPMAP_FORMAT_VERSION = '1.5.1'
 
-  SUPPORTED_RUBY_VERSIONS = %w[2.6 2.7 3.0].freeze
+  SUPPORTED_RUBY_VERSIONS = %w[2.6 2.7 3.0 3.1].freeze
 
   DEFAULT_APPMAP_DIR = 'tmp/appmap'.freeze
   DEFAULT_CONFIG_FILE_PATH = 'appmap.yml'.freeze

data/spec/fixtures/rails7_users_app/.dockerignore

@@ -0,0 +1 @@
+Gemfile.lock

data/spec/fixtures/rails7_users_app/.gitattributes

@@ -0,0 +1,7 @@
+# See https://git-scm.com/docs/gitattributes for more about git attribute files.
+
+# Mark the database schema as having been generated.
+db/schema.rb linguist-generated
+
+# Mark any vendored files as having been vendored.
+vendor/* linguist-vendored

data/spec/fixtures/rails7_users_app/.gitignore

@@ -0,0 +1,31 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore pidfiles, but keep the directory.
+/tmp/pids/*
+!/tmp/pids/
+!/tmp/pids/.keep
+
+# Ignore uploaded files in development.
+/storage/*
+!/storage/.keep
+/tmp/storage/*
+!/tmp/storage/
+!/tmp/storage/.keep
+
+/public/assets
+
+# Ignore master key for decrypting credentials and more.
+/config/master.key

data/spec/fixtures/rails7_users_app/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/spec/fixtures/rails7_users_app/.ruby-version

@@ -0,0 +1 @@
+ruby-3.1.0

data/spec/fixtures/rails7_users_app/Dockerfile

@@ -0,0 +1,30 @@
+ARG GEM_VERSION
+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 mkdir /app
+WORKDIR /app
+
+RUN gem install -N bundler
+
+COPY Gemfile .
+
+RUN bundle
+
+COPY . .
+
+COPY --from=appmap /pkg/appmap.gem /tmp/
+RUN gem install /tmp/appmap.gem && \
+    bundle update --local appmap && \
+    bundle binstubs appmap --force
+
+EXPOSE 3000
+
+HEALTHCHECK --interval=1s --retries=10 CMD curl --fail http://localhost:3000/health || exit 1

data/spec/fixtures/rails7_users_app/Dockerfile.pg

@@ -0,0 +1,3 @@
+FROM postgres:10
+
+HEALTHCHECK --interval=1s --retries=10 CMD psql -U postgres -c "select 1" || exit 1

data/spec/fixtures/rails7_users_app/Gemfile

@@ -0,0 +1,99 @@
+source "https://rubygems.org"
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+# Bundle edge Rails instead: gem "rails", github: "rails/rails", branch: "main"
+gem "rails", "~> 7.0.2", ">= 7.0.2.3"
+
+# The original asset pipeline for Rails [https://github.com/rails/sprockets-rails]
+gem "sprockets-rails"
+
+# Use postgresql as the database for Active Record
+gem "pg", "~> 1.1"
+
+# Use the Puma web server [https://github.com/puma/puma]
+gem "puma", "~> 5.0"
+
+# Use JavaScript with ESM import maps [https://github.com/rails/importmap-rails]
+gem "importmap-rails"
+
+# Hotwire's SPA-like page accelerator [https://turbo.hotwired.dev]
+gem "turbo-rails"
+
+# Hotwire's modest JavaScript framework [https://stimulus.hotwired.dev]
+gem "stimulus-rails"
+
+# Build JSON APIs with ease [https://github.com/rails/jbuilder]
+gem "jbuilder"
+
+# Use Redis adapter to run Action Cable in production
+# gem "redis", "~> 4.0"
+
+# Use Kredis to get higher-level data types in Redis [https://github.com/rails/kredis]
+# gem "kredis"
+
+# Use Active Model has_secure_password [https://guides.rubyonrails.org/active_model_basics.html#securepassword]
+# gem "bcrypt", "~> 3.1.7"
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem "tzinfo-data", platforms: %i[ mingw mswin x64_mingw jruby ]
+
+# Reduces boot times through caching; required in config/boot.rb
+gem "bootsnap", require: false
+
+# Use Sass to process CSS
+# gem "sassc-rails"
+
+# Use Active Storage variants [https://guides.rubyonrails.org/active_storage_overview.html#transforming-images]
+# gem "image_processing", "~> 1.2"
+
+group :development, :test do
+  # See https://guides.rubyonrails.org/debugging_rails_applications.html#debugging-with-the-debug-gem
+  gem "debug", platforms: %i[ mri mingw x64_mingw ]
+end
+
+group :development do
+  # Use console on exceptions pages [https://github.com/rails/web-console]
+  gem "web-console"
+
+  # Add speed badges [https://github.com/MiniProfiler/rack-mini-profiler]
+  # gem "rack-mini-profiler"
+
+  # Speed up commands on slow machines / big apps [https://github.com/rails/spring]
+  # gem "spring"
+end
+
+group :test do
+  # Use system testing [https://guides.rubyonrails.org/testing.html#system-testing]
+  gem "capybara"
+  gem "selenium-webdriver"
+  gem "webdrivers"
+end
+
+appmap_path = \
+  # Support debugging inside the container with volume-mounted source
+  if File.directory?('/src/appmap-ruby')
+    '/src/appmap-ruby'
+  elsif File.exist?('../../../appmap.gemspec')
+    '../../..'
+  end
+
+if appmap_path
+  # Set the branch parameter, so that 'bundle config local.appmap' will work
+  appmap_branch = Dir.chdir appmap_path do
+    `git rev-parse --abbrev-ref HEAD`.strip
+  end
+end
+
+appmap_options = \
+  if appmap_path && appmap_branch
+    { git: appmap_path, branch: appmap_branch }
+  elsif appmap_path
+    { path: appmap_path }
+  else
+    {}
+  end.merge(require: %w[appmap])
+
+group :development, :test do
+  gem 'appmap', appmap_options
+  gem 'pry-byebug', '>=0', '< 99'
+end

data/spec/fixtures/rails7_users_app/README.md

@@ -0,0 +1,24 @@
+# README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...

data/spec/fixtures/rails7_users_app/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative "config/application"
+
+Rails.application.load_tasks

data/spec/fixtures/rails7_users_app/app/assets/config/manifest.js

@@ -0,0 +1,4 @@
+//= link_tree ../images
+//= link_directory ../stylesheets .css
+//= link_tree ../../javascript .js
+//= link_tree ../../../vendor/javascript .js

data/spec/fixtures/rails7_users_app/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS (and SCSS, if configured) file within this directory, lib/assets/stylesheets, or any plugin's
+ * vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/fixtures/rails7_users_app/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/spec/fixtures/rails7_users_app/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/spec/fixtures/rails7_users_app/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/spec/fixtures/rails7_users_app/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/fixtures/rails7_users_app/app/javascript/application.js

@@ -0,0 +1,3 @@
+// Configure your import map in config/importmap.rb. Read more: https://github.com/rails/importmap-rails
+import "@hotwired/turbo-rails"
+import "controllers"

data/spec/fixtures/rails7_users_app/app/javascript/controllers/application.js

@@ -0,0 +1,9 @@
+import { Application } from "@hotwired/stimulus"
+
+const application = Application.start()
+
+// Configure Stimulus development experience
+application.debug = false
+window.Stimulus   = application
+
+export { application }

data/spec/fixtures/rails7_users_app/app/javascript/controllers/hello_controller.js

@@ -0,0 +1,7 @@
+import { Controller } from "@hotwired/stimulus"
+
+export default class extends Controller {
+  connect() {
+    this.element.textContent = "Hello World!"
+  }
+}

data/spec/fixtures/rails7_users_app/app/javascript/controllers/index.js

@@ -0,0 +1,11 @@
+// Import and register all your controllers from the importmap under controllers/*
+
+import { application } from "controllers/application"
+
+// Eager load all controllers defined in the import map under controllers/**/*_controller
+import { eagerLoadControllersFrom } from "@hotwired/stimulus-loading"
+eagerLoadControllersFrom("controllers", application)
+
+// Lazy load controllers as they appear in the DOM (remember not to preload controllers in import map!)
+// import { lazyLoadControllersFrom } from "@hotwired/stimulus-loading"
+// lazyLoadControllersFrom("controllers", application)

data/spec/fixtures/rails7_users_app/app/jobs/application_job.rb

@@ -0,0 +1,7 @@
+class ApplicationJob < ActiveJob::Base
+  # Automatically retry jobs that encountered a deadlock
+  # retry_on ActiveRecord::Deadlocked
+
+  # Most jobs are safe to ignore if the underlying records are no longer available
+  # discard_on ActiveJob::DeserializationError
+end

data/spec/fixtures/rails7_users_app/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: "from@example.com"
+  layout "mailer"
+end

data/spec/fixtures/rails7_users_app/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  primary_abstract_class
+end

data/spec/fixtures/rails7_users_app/app/models/instance.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Instance < ApplicationRecord
+  belongs_to :course
+  has_and_belongs_to_many :instructor
+end
+

data/spec/fixtures/rails7_users_app/app/models/instructor.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Instructor < ApplicationRecord
+  belongs_to :user
+  has_and_belongs_to_many :instance
+end
+

data/spec/fixtures/rails7_users_app/app/views/layouts/application.html.erb

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>App</title>
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+
+    <%= stylesheet_link_tag "application", "data-turbo-track": "reload" %>
+    <%= javascript_importmap_tags %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/fixtures/rails7_users_app/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/fixtures/rails7_users_app/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/spec/fixtures/rails7_users_app/appmap.yml

@@ -0,0 +1,3 @@
+name: rails7_users_app
+packages:
+- path: app