Add support for Ruby 3.x -> 4.0, Rails 6.1 -> 8.1 (#3518)

This PR and its matching PR refinery/refinerycms-i18n#104 allow
`refinerycms` to run with Ruby 3 / Ruby 4.

It has been tested with Ruby 3.2 through 4.0, and with Rails 6.1 through
8.1.

We've removed `coffee-rails` as a dependency and converted those to JS.

---------

Co-authored-by: Philip Arndt <git@p.arndt.io>

Author: anitagraham

.github/workflows/legacy.yml

@@ -0,0 +1,63 @@
+name: Legacy
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        database: [ sqlite3, mysql, postgresql ]
+        extension: [ core, dragonfly, images, pages, resources ]
+        ruby: [ 3.2, 3.3, 3.4, 4.0 ]
+        rails: [ '~> 6.1.0', '~> 7.0.0', '~> 7.1.0' ]
+        exclude:
+          - ruby: 3.4
+            rails: '~> 6.1.0'
+          - ruby: 4.0
+            rails: '~> 6.1.0'
+      fail-fast: false
+    runs-on: ubuntu-latest
+
+    env:
+      CI: true
+      DB: ${{ matrix.database }}
+      MYSQL_PASSWORD: root
+      PGHOST: localhost
+      PGPASSWORD: runner
+      PGUSER: runner
+      RAILS_ENV: test
+      RAILS_VERSION: ${{ matrix.rails }}
+      RETRY_COUNT: 3
+
+    name: rails ${{ matrix.rails }} ruby ${{ matrix.ruby }} refinerycms-${{ matrix.extension }} ${{ matrix.database }}
+    steps:
+      - run: sudo apt-get update && sudo apt-get install libsqlite3-dev -y
+      - uses: actions/checkout@v6
+      - uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: "Install ImageMagick for images extension"
+        if: ${{ matrix.extension == 'images' }}
+        run: sudo apt-get install imagemagick -y
+
+      - name: "Set up MySQL using VM's server"
+        if: ${{ env.DB == 'mysql' }}
+        run: |
+          sudo apt-get install libmysqlclient-dev -y
+          sudo systemctl start mysql.service
+
+      - name: "Set up PostgreSQL using VM's server"
+        if: ${{ env.DB == 'postgresql' }}
+        run: |
+          sudo apt-get install libpq-dev -y
+          sudo systemctl start postgresql.service
+          sudo -u postgres psql -c "CREATE USER runner WITH SUPERUSER PASSWORD 'runner'"
+
+      - run: bin/rake refinery:testing:dummy_app
+      - run: bin/rspec ${{ matrix.extension }}/spec

.github/workflows/main.yml

@@ -10,11 +10,11 @@ jobs:
   test:
     strategy:
       matrix:
-        database: [ mysql, postgresql ]
+        database: [ sqlite3, mysql, postgresql ]
         extension: [ core, dragonfly, images, pages, resources ]
-        ruby: [ 2.7, 2.6 ]
+        ruby: [ 4.0, 3.4, 3.3, 3.2  ]
+        rails: [ '~> 8.1.0', '~> 8.0.0', '~> 7.2.0' ]
       fail-fast: false
-      max-parallel: 20
     runs-on: ubuntu-latest
 
     env:
@@ -25,17 +25,22 @@ jobs:
       PGPASSWORD: runner
       PGUSER: runner
       RAILS_ENV: test
+      RAILS_VERSION: ${{ matrix.rails }}
       RETRY_COUNT: 3
 
-    name: ${{ matrix.extension }} ${{ matrix.ruby }} ${{ matrix.database }}
+    name: rails ${{ matrix.rails }} ruby ${{ matrix.ruby }} refinerycms-${{ matrix.extension }} ${{ matrix.database }}
     steps:
       - run: sudo apt-get update && sudo apt-get install libsqlite3-dev -y
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v6
       - uses: ruby/setup-ruby@v1
         with:
           bundler-cache: true
           ruby-version: ${{ matrix.ruby }}
 
+      - name: "Install ImageMagick for images extension"
+        if: ${{ matrix.extension == 'images' }}
+        run: sudo apt-get install imagemagick -y
+
       - name: "Set up MySQL using VM's server"
         if: ${{ env.DB == 'mysql' }}
         run: |
@@ -50,4 +55,6 @@ jobs:
           sudo -u postgres psql -c "CREATE USER runner WITH SUPERUSER PASSWORD 'runner'"
 
       - run: bin/rake refinery:testing:dummy_app
+      - run: cd spec/dummy && bin/rails assets:precompile
+        if: ${{ matrix.rails == '~> 8.1.0' }}
       - run: bin/rspec ${{ matrix.extension }}/spec

Gemfile

@@ -1,34 +1,55 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec
 
-path "./" do
-  gem "refinerycms-core"
-  gem "refinerycms-images"
-  gem "refinerycms-pages"
-  gem "refinerycms-resources"
+# Allow CI and us to test specific Rails versions
+gem 'rails', ENV['RAILS_VERSION'] if ENV['RAILS_VERSION']
+
+# Ruby 3.4+ extracted mutex_m from stdlib, but older Rails versions need it
+gem 'mutex_m' if RUBY_VERSION >= '3.4' && ENV['RAILS_VERSION']&.match?(/^~> [67]\./)
+
+gem 'net-imap', require: false
+gem 'net-pop', require: false
+gem 'net-smtp', require: false
+
+path './' do
+  gem 'refinerycms-core'
+  gem 'refinerycms-dragonfly'
+  gem 'refinerycms-images'
+  gem 'refinerycms-pages'
+  gem 'refinerycms-resources'
 end
 
-gem 'refinerycms-i18n', github: 'refinery/refinerycms-i18n', branch: 'master'
+gem 'refinerycms-i18n', github: 'refinery/refinerycms-i18n', branch: 'main'
 
 # Add support for refinerycms-acts-as-indexed
-gem 'refinerycms-acts-as-indexed', ['~> 4.0', '>= 4.0.0'],
-  git: 'https://github.com/refinery/refinerycms-acts-as-indexed',
-  branch: 'master'
+gem 'refinerycms-acts-as-indexed', '~> 4.0', '>= 4.0.0',
+  github: 'refinery/refinerycms-acts-as-indexed',
+  branch: 'main'
 
 # Add the default visual editor, for now.
 gem 'refinerycms-wymeditor', ['~> 3.0', '>= 3.0.0']
 
+# Work around Zeitwerk loading issues
+gem 'decorators', github: 'parndt/decorators', branch: 'zeitwerk'
+
 # Database Configuration
-unless ENV['CI']
+if !ENV['CI'] || ENV['DB'] == 'sqlite3'
   gem 'activerecord-jdbcsqlite3-adapter', '>= 1.3.0.rc1', platform: :jruby
-  gem 'sqlite3', platform: :ruby
+  # Rails 6.1 and 7.0 require sqlite3 ~> 1.4, Rails 7.1+ can use newer versions
+  if ENV['RAILS_VERSION']&.match?(/[67]\.[01]/)
+    gem 'sqlite3', '~> 1.4.0', platform: :ruby
+  else
+    gem 'sqlite3', platform: :ruby
+  end
 end
 
 if !ENV['CI'] || ENV['DB'] == 'mysql'
   group :mysql do
     gem 'activerecord-jdbcmysql-adapter', '>= 1.3.0.rc1', platform: :jruby
-    gem 'mysql2', '~> 0.4', :platform => :ruby
+    gem 'mysql2', '~> 0.4', platform: :ruby
   end
 end
 
@@ -43,19 +64,15 @@ group :development, :test do
   gem 'activejob'
   gem 'bootsnap', require: false
   gem 'listen', '~> 3.0'
+  gem 'puma', require: false
+  gem 'rspec-rails'
 end
 
 group :test do
-  gem 'refinerycms-testing', path: './testing'
   gem 'generator_spec', '~> 0.9.3'
   gem 'launchy'
-  gem 'coveralls', require: false
+  gem 'refinerycms-testing', path: './testing'
   gem 'rspec-retry'
-  gem 'falcon'
-  gem 'falcon-capybara'
-
-  # TODO: Use beta source for Rails 6 support
-  gem 'rspec-rails', '~> 4.0.0.beta3'
 end
 
 # Load local gems according to Refinery developer preference.

Rakefile

@@ -1,15 +1,13 @@
 #!/usr/bin/env rake
+
 begin
   require 'bundler/setup'
 rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
 APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
-
-if File.exist?(APP_RAKEFILE)
-  load 'rails/tasks/engine.rake'
-end
+load 'rails/tasks/engine.rake' if File.exist?(APP_RAKEFILE)
 
 Dir[File.expand_path('../tasks/**/*', __FILE__)].each do |task|
   load task

contributing.md

@@ -33,4 +33,4 @@ inclusion.
 
 ## Links ##
 
-See also the [Contributing to Refinery](https://www.refinerycms.com/guides/contributing-to-refinery) guide.
+See also the [Contributing to Refinery](https://github.com/refinery/refinerycms/blob/main/doc/guides/8%20-%20Contributing/1%20-%20Contributing%20to%20Refinery.md) guide.