feat: Add support for Ruby 3.0, and drop Ruby 2.5

Ruby 2.5 is no longer supported by the dev team.

Author: kgilpin

.travis.yml

@@ -1,9 +1,9 @@
 language: ruby
 
 rbenv:
-- 2.5
 - 2.6
 - 2.7
+- 3.0
 
 addons:
   apt:

README.md

@@ -117,11 +117,11 @@ root@6fab5f89125f:/src/app# bundle
 ```
 
 At this point, the bundle is built with the `appmap` gem located  in `/src/appmap`, which is volume-mounted from the host.
-So you can edit the fixture code and the appmap code and run test commands such as `rspec` and `cucumber` in the container.
+So you can edit the fixture code and the appmap code and run test commands such as `rspec` in the container.
 For example:
 
 ```sh-session
-root@6fab5f89125f:/src/app# bundle exec rspec
+root@6fab5f89125f:/src/app# APPMAP=true bundle exec rspec
 Configuring AppMap from path appmap.yml
 ....
 

Rakefile

@@ -28,7 +28,7 @@ namespace 'gem' do
   end
 end
 
-RUBY_VERSIONS=%w[2.5 2.6 2.7].select do |version|
+RUBY_VERSIONS=%w[2.6 2.7 3.0].select do |version|
   travis_ruby_version = ENV['TRAVIS_RUBY_VERSION']
   next true unless travis_ruby_version
 

lib/appmap/command/agent_setup/init.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'json'
+require 'yaml'
 require 'appmap/service/guesser'
 
 module AppMap

lib/appmap/config.rb

@@ -254,7 +254,7 @@ def initialize(name,
       functions.each do |func|
         package_options = {}
         package_options[:labels] = func.labels if func.labels
-        @hooked_methods[func.cls] << TargetMethods.new(func.function_names, Package.build_from_path(func.package, package_options))
+        @hooked_methods[func.cls] << TargetMethods.new(func.function_names, Package.build_from_path(func.package, **package_options))
       end
 
       @hooked_methods.each_value do |hooks|
@@ -367,7 +367,7 @@ def load(config_data)
           config_params[:depends_config] = depends_config
         end
 
-        Config.new name, config_params
+        Config.new name, **config_params
       end
     end
 

lib/appmap/service/validator/config_validator.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'appmap/service/validator/violation'
+require 'yaml'
 
 module AppMap
   module Service
@@ -76,7 +77,10 @@ def validate_rails_presence
         end
 
         def validate_ruby_version
-          unless RUBY_VERSION =~ AppMap::SUPPORTED_RUBY_VERSIONS_REGEX
+          major, minor, _ = RUBY_VERSION.split('.')
+          version = [ major, minor ].join('.')
+
+          unless AppMap::SUPPORTED_RUBY_VERSIONS.member?(version)
             @violations << Violation.error(
               message: "AppMap does not support Ruby #{RUBY_VERSION}. " \
                 "Supported versions are: #{AppMap::SUPPORTED_RUBY_VERSIONS.join(', ')}."

lib/appmap/version.rb

@@ -7,8 +7,7 @@ module AppMap
 
   APPMAP_FORMAT_VERSION = '1.5.1'
 
-  SUPPORTED_RUBY_VERSIONS_REGEX = /^2\.[567]\./.freeze
-  SUPPORTED_RUBY_VERSIONS = %w[2.5 2.6 2.7].freeze
+  SUPPORTED_RUBY_VERSIONS = %w[2.6 2.7 3.0].freeze
 
   DEFAULT_APPMAP_DIR = 'tmp/appmap'.freeze
   DEFAULT_CONFIG_FILE_PATH = 'appmap.yml'.freeze

spec/depends/api_spec.rb

@@ -55,7 +55,7 @@ def minitest_select_tests_method(test_files)
   describe '.inspect_test_files' do
     it 'reports metadata, added, removed, changed, failed' do
       test_report = api.inspect_test_files(appmap_dir: DEPENDS_TEST_DIR, test_file_patterns: %w[spec/fixtures/depends/spec/*_spec.rb])
-      expect(test_report.metadata_files).to eq(%w[spec/fixtures/depends/user_page_scenario/metadata.json spec/fixtures/depends/revoke_api_key/metadata.json])
+      expect(test_report.metadata_files.sort).to eq(%w[spec/fixtures/depends/revoke_api_key/metadata.json spec/fixtures/depends/user_page_scenario/metadata.json])
       expect(test_report.added).to be_empty
       expect(test_report.removed).to be_empty
       expect(test_report.changed).to be_empty

spec/fixtures/rails6_users_app/Gemfile

@@ -7,7 +7,7 @@ gem 'haml-rails'
 
 gem 'activerecord', require: false
 gem 'pg'
-gem 'sequel', '= 5.20.0', require: false
+gem 'sequel', '>= 5.43.0', require: false
 gem 'sequel-rails', require: false
 gem 'sequel_secure_password', require: false
 

spec/fixtures/rails6_users_app/docker-compose.yml

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

spec/hook_spec.rb

@@ -987,10 +987,12 @@ def secure_compare(a, b)
   end
 
   describe 'kwargs handling' do
-    # https://github.com/applandinc/appmap-ruby/issues/153
-    it 'empty hash for **kwrest can be proxied as a regular function argument', github_issue: 153 do
-      invoke_test_file 'spec/fixtures/hook/kwargs.rb' do
-        expect(Kwargs.has_kwrest_calls_no_kwargs(nil, {})).to eq({})
+    if ruby_2?
+      # https://github.com/applandinc/appmap-ruby/issues/153
+      it 'empty hash for **kwrest can be proxied as a regular function argument', github_issue: 153 do
+        invoke_test_file 'spec/fixtures/hook/kwargs.rb' do
+          expect(Kwargs.has_kwrest_calls_no_kwargs(nil, {})).to eq({})
+        end
       end
     end
   end

spec/rails_recording_spec.rb

@@ -1,7 +1,10 @@
 require 'rails_spec_helper'
 
+# Rails5 doesn't work with Ruby 3.x
+RailsVersions = ruby_2? ? [ 5, 6 ] : [ 6 ]
+
 describe 'Rails' do
-  %w[5 6].each do |rails_major_version| # rubocop:disable Metrics/BlockLength
+  RailsVersions.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'
@@ -239,7 +242,7 @@ def run_spec(spec_name)
   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 app pg database', "spec/fixtures/rails6_users_app" unless use_existing_data?
     include_context 'rails integration test setup'
 
     def run_spec(spec_name)

spec/railtie_spec.rb

@@ -1,7 +1,7 @@
 require 'rails_spec_helper'
 
 describe 'AppMap tracer via Railtie' do
-  include_context 'Rails app pg database', 'spec/fixtures/rails5_users_app' do 
+  include_context 'Rails app pg database', 'spec/fixtures/rails6_users_app' do 
     let(:env) { {} }
 
     let(:cmd) { %(docker-compose run --rm -e RAILS_ENV=development -e APPMAP app ./bin/rails r "puts AppMap.instance_variable_get('@configuration').nil?") }
@@ -10,13 +10,13 @@
       Open3.capture3(env, cmd, chdir: fixture_dir).tap do |result|
         unless result[2] == 0
           warn <<~STDERR
-            Failed to run rails5_users_app container
+            Failed to run rails6_users_app container
             <<< Output:
             #{result[0]}
             #{result[1]}
             >>> End of output
           STDERR
-          raise 'Failed to run rails5_users_app container'
+          raise 'Failed to run rails6_users_app container'
         end
       end
     end

spec/record_sql_rails_pg_spec.rb

@@ -1,7 +1,7 @@
 require 'rails_spec_helper'
 
 describe 'SQL events' do
-  include_context 'Rails app pg database', 'spec/fixtures/rails5_users_app' do
+  include_context 'Rails app pg database', 'spec/fixtures/rails6_users_app' do
     around(:each) do |example|
       FileUtils.rm_rf tmpdir
       FileUtils.mkdir_p tmpdir

spec/remote_recording_spec.rb

@@ -3,9 +3,9 @@
 require 'socket'
 
 describe 'remote recording', :order => :defined do
-  include_context 'Rails app pg database', 'spec/fixtures/rails5_users_app' do
+  include_context 'Rails app pg database', 'spec/fixtures/rails6_users_app' do
     before(:all) do
-      fixture_dir = 'spec/fixtures/rails5_users_app'
+      fixture_dir = 'spec/fixtures/rails6_users_app'
       start_cmd = 'docker-compose up -d app'
       run_cmd({ 'ORM_MODULE' => 'sequel', 'APPMAP' => 'true' }, start_cmd, chdir: fixture_dir)
       Dir.chdir fixture_dir do
@@ -44,7 +44,7 @@ def json_body(res)
     end
 
     after(:all) do
-      fixture_dir = 'spec/fixtures/rails5_users_app'
+      fixture_dir = 'spec/fixtures/rails6_users_app'
       run_cmd 'docker-compose rm -fs app', chdir: fixture_dir
     end
 

spec/spec_helper.rb

@@ -21,6 +21,10 @@ def use_existing_data?
   ENV['USE_EXISTING_DATA'] == 'true'
 end
 
+def ruby_2?
+  RUBY_VERSION.split('.')[0].to_i == 2
+end
+
 shared_context 'collect events' do
   def collect_events(tracer)
     [].tap do |events|