Add Rails 8.1 support (#119)

darryn02 · web-flow · commit b8ca827cdaae · 2025-10-25T17:35:41.000+02:00
diff --git a/roadie-rails.gemspec b/roadie-rails.gemspec
@@ -21,11 +21,11 @@ Gem::Specification.new do |spec|
   spec.extra_rdoc_files = %w[README.md Changelog.md LICENSE.txt]
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "railties", ">= 5.1", "< 8.1"
+  spec.add_dependency "railties", ">= 5.1", "< 8.2"
   spec.add_dependency "roadie", "~> 5.0"
 
   spec.add_development_dependency "bundler", "~> 2.2"
-  spec.add_development_dependency "rails", ">= 5.1", "< 8.1"
+  spec.add_development_dependency "rails", ">= 5.1", "< 8.2"
   spec.add_development_dependency "rspec", "~> 3.10"
   spec.add_development_dependency "rspec-collection_matchers"
   spec.add_development_dependency "rspec-rails"
diff --git a/spec/integration_spec.rb b/spec/integration_spec.rb
@@ -17,7 +17,8 @@ def parse_html_in_email(mail)
     RailsApp.new("Rails 7.0", "rails_70", min_ruby_version: "2.7"),
     RailsApp.new("Rails 7.1 with sprockets", "rails_71", min_ruby_version: "2.7"),
     RailsApp.new("Rails 7.1 with propshaft", "rails_71_with_propshaft", min_ruby_version: "2.7", asset_pipeline: :propshaft),
-    RailsApp.new("Rails 8.0 with propshaft", "rails_80_with_propshaft", min_ruby_version: "3.2", asset_pipeline: :propshaft)
+    RailsApp.new("Rails 8.0 with propshaft", "rails_80_with_propshaft", min_ruby_version: "3.2", asset_pipeline: :propshaft),
+    RailsApp.new("Rails 8.1 with propshaft", "rails_81_with_propshaft", min_ruby_version: "3.2", asset_pipeline: :propshaft)
   ]
 
   shared_examples "generates valid email" do |message|
diff --git a/spec/railsapps/rails_81_with_propshaft/Gemfile b/spec/railsapps/rails_81_with_propshaft/Gemfile
@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Bundle edge Rails instead: gem "rails", github: "rails/rails", branch: "main"
+gem "rails", "~> 8.1.0"
+
+# Reduces boot times through caching; required in config/boot.rb
+gem "bootsnap", ">= 1.4.4", require: false
+gem "propshaft"
+gem "roadie-rails", path: "../../.."
diff --git a/spec/railsapps/rails_81_with_propshaft/Rakefile b/spec/railsapps/rails_81_with_propshaft/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
diff --git a/spec/railsapps/rails_81_with_propshaft/app/assets/builds/.gitkeep b/spec/railsapps/rails_81_with_propshaft/app/assets/builds/.gitkeep
diff --git a/spec/railsapps/rails_81_with_propshaft/app/assets/images/rails.png b/spec/railsapps/rails_81_with_propshaft/app/assets/images/rails.png
diff --git a/spec/railsapps/rails_81_with_propshaft/app/assets/stylesheets/email.css b/spec/railsapps/rails_81_with_propshaft/app/assets/stylesheets/email.css
@@ -0,0 +1,2 @@
+body { background-color: green; }
+.image { background: url("/rails.png"); }
diff --git a/spec/railsapps/rails_81_with_propshaft/app/mailers/auto_mailer.rb b/spec/railsapps/rails_81_with_propshaft/app/mailers/auto_mailer.rb
@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+class AutoMailer < ActionMailer::Base
+  include Roadie::Rails::Automatic
+
+  default from: "john@example.com"
+
+  def normal_email
+    generate_email
+  end
+
+  def disabled_email
+    generate_email
+  end
+
+  private
+
+  def roadie_options
+    unless /disabled/.match?(action_name)
+      super.combine(url_options: {protocol: "https"})
+    end
+  end
+
+  def generate_email
+    mail(to: "example@example.org", subject: "Notification for you") do |format|
+      format.html { render :normal_email }
+      format.text { render :normal_email }
+    end
+  end
+end
diff --git a/spec/railsapps/rails_81_with_propshaft/app/mailers/mailer.rb b/spec/railsapps/rails_81_with_propshaft/app/mailers/mailer.rb
@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class Mailer < ActionMailer::Base
+  include Roadie::Rails::Mailer
+
+  default from: "john@example.com"
+
+  def normal_email
+    roadie_mail(to: "example@example.org", subject: "Notification for you") do |format|
+      format.html
+      format.text
+    end
+  end
+
+  private
+
+  def roadie_options
+    super.combine(url_options: {protocol: "https"})
+  end
+end
diff --git a/spec/railsapps/rails_81_with_propshaft/app/views/auto_mailer/normal_email.html.erb b/spec/railsapps/rails_81_with_propshaft/app/views/auto_mailer/normal_email.html.erb
@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="content-type" content="text/html; charset=utf-8">
+    <%= stylesheet_link_tag "email" %>
+  </head>
+  <body>
+    <h1>Normal email</h1>
+    <div class="image"></div>
+  </body>
+</html>
diff --git a/spec/railsapps/rails_81_with_propshaft/app/views/auto_mailer/normal_email.text b/spec/railsapps/rails_81_with_propshaft/app/views/auto_mailer/normal_email.text
@@ -0,0 +1 @@
+Normal email
diff --git a/spec/railsapps/rails_81_with_propshaft/app/views/mailer/normal_email.html.erb b/spec/railsapps/rails_81_with_propshaft/app/views/mailer/normal_email.html.erb
@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="content-type" content="text/html; charset=utf-8">
+    <%= stylesheet_link_tag "email" %>
+  </head>
+  <body>
+    <h1>Normal email</h1>
+    <div class="image"></div>
+  </body>
+</html>
diff --git a/spec/railsapps/rails_81_with_propshaft/app/views/mailer/normal_email.text b/spec/railsapps/rails_81_with_propshaft/app/views/mailer/normal_email.text
@@ -0,0 +1 @@
+Normal email
diff --git a/spec/railsapps/rails_81_with_propshaft/bin/bundle b/spec/railsapps/rails_81_with_propshaft/bin/bundle
@@ -0,0 +1,114 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bundle' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "rubygems"
+
+m = Module.new do
+  module_function
+
+  def invoked_as_script?
+    File.expand_path($0) == File.expand_path(__FILE__)
+  end
+
+  def env_var_version
+    ENV["BUNDLER_VERSION"]
+  end
+
+  def cli_arg_version
+    return unless invoked_as_script? # don't want to hijack other binstubs
+    return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update`
+    bundler_version = nil
+    update_index = nil
+    ARGV.each_with_index do |a, i|
+      if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
+        bundler_version = a
+      end
+      next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/o
+      bundler_version = $1
+      update_index = i
+    end
+    bundler_version
+  end
+
+  def gemfile
+    gemfile = ENV["BUNDLE_GEMFILE"]
+    return gemfile if gemfile && !gemfile.empty?
+
+    File.expand_path("../../Gemfile", __FILE__)
+  end
+
+  def lockfile
+    lockfile =
+      case File.basename(gemfile)
+      when "gems.rb" then gemfile.sub(/\.rb$/, gemfile)
+      else "#{gemfile}.lock"
+      end
+    File.expand_path(lockfile)
+  end
+
+  def lockfile_version
+    return unless File.file?(lockfile)
+    lockfile_contents = File.read(lockfile)
+    return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/o
+    Regexp.last_match(1)
+  end
+
+  def bundler_requirement
+    @bundler_requirement ||=
+      env_var_version || cli_arg_version ||
+      bundler_requirement_for(lockfile_version)
+  end
+
+  def bundler_requirement_for(version)
+    return "#{Gem::Requirement.default}.a" unless version
+
+    bundler_gem_version = Gem::Version.new(version)
+
+    requirement = bundler_gem_version.approximate_recommendation
+
+    return requirement unless Gem::Version.new(Gem::VERSION) < Gem::Version.new("2.7.0")
+
+    requirement += ".a" if bundler_gem_version.prerelease?
+
+    requirement
+  end
+
+  def load_bundler!
+    ENV["BUNDLE_GEMFILE"] ||= gemfile
+
+    activate_bundler
+  end
+
+  def activate_bundler
+    gem_error = activation_error_handling do
+      gem "bundler", bundler_requirement
+    end
+    return if gem_error.nil?
+    require_error = activation_error_handling do
+      require "bundler/version"
+    end
+    return if require_error.nil? && Gem::Requirement.new(bundler_requirement).satisfied_by?(Gem::Version.new(Bundler::VERSION))
+    warn "Activating bundler (#{bundler_requirement}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_requirement}'`"
+    exit 42
+  end
+
+  def activation_error_handling
+    yield
+    nil
+  rescue StandardError, LoadError => e
+    e
+  end
+end
+
+m.load_bundler!
+
+if m.invoked_as_script?
+  load Gem.bin_path("bundler", "bundle")
+end
diff --git a/spec/railsapps/rails_81_with_propshaft/bin/rails b/spec/railsapps/rails_81_with_propshaft/bin/rails
@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path("../config/application", __dir__)
+require_relative "../config/boot"
+require "rails/commands"
diff --git a/spec/railsapps/rails_81_with_propshaft/bin/rake b/spec/railsapps/rails_81_with_propshaft/bin/rake
@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative "../config/boot"
+require "rake"
+Rake.application.run
diff --git a/spec/railsapps/rails_81_with_propshaft/bin/setup b/spec/railsapps/rails_81_with_propshaft/bin/setup
@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+require "fileutils"
+
+# path to your application root.
+APP_ROOT = File.expand_path("..", __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+FileUtils.chdir APP_ROOT do
+  # This script is a way to set up or update your development environment automatically.
+  # This script is idempotent, so that you can run it at any time and get an expectable outcome.
+  # Add necessary setup steps to this file.
+
+  puts "== Installing dependencies =="
+  system! "gem install bundler --conservative"
+  system("bundle check") || system!("bundle install")
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! "bin/rails log:clear tmp:clear"
+
+  puts "\n== Restarting application server =="
+  system! "bin/rails restart"
+end
diff --git a/spec/railsapps/rails_81_with_propshaft/config.ru b/spec/railsapps/rails_81_with_propshaft/config.ru
@@ -0,0 +1,6 @@
+# This file is used by Rack-based servers to start the application.
+
+require_relative "config/environment"
+
+run Rails.application
+Rails.application.load_server
diff --git a/spec/railsapps/rails_81_with_propshaft/config/application.rb b/spec/railsapps/rails_81_with_propshaft/config/application.rb
@@ -0,0 +1,37 @@
+require_relative "boot"
+
+require "rails"
+# Pick the frameworks you want:
+# require "active_model/railtie"
+# require "active_job/railtie"
+# require "active_record/railtie"
+# require "active_storage/engine"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+# require "action_mailbox/engine"
+# require "action_text/engine"
+require "action_view/railtie"
+# require "action_cable/engine"
+# require "rails/test_unit/railtie"
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(*Rails.groups)
+require "propshaft"
+
+module Rails81
+  class Application < Rails::Application
+    # Initialize configuration defaults for originally generated Rails version.
+    config.load_defaults 8.1
+
+    # Configuration for the application, engines, and railties goes here.
+    #
+    # These settings can be overridden in specific environments using the files
+    # in config/environments, which are processed later.
+    #
+    # config.time_zone = "Central Time (US & Canada)"
+    # config.eager_load_paths << Rails.root.join("extras")
+    config.roadie.url_options = {host: "example.app.org"}
+    config.action_view.preload_links_header = false
+  end
+end
diff --git a/spec/railsapps/rails_81_with_propshaft/config/boot.rb b/spec/railsapps/rails_81_with_propshaft/config/boot.rb
@@ -0,0 +1,4 @@
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+require "bundler/setup" # Set up gems listed in the Gemfile.
+require "bootsnap/setup" # Speed up boot time by caching expensive operations.
diff --git a/spec/railsapps/rails_81_with_propshaft/config/environment.rb b/spec/railsapps/rails_81_with_propshaft/config/environment.rb
@@ -0,0 +1,5 @@
+# Load the Rails application.
+require_relative "application"
+
+# Initialize the Rails application.
+Rails.application.initialize!
diff --git a/spec/railsapps/rails_81_with_propshaft/config/environments/development.rb b/spec/railsapps/rails_81_with_propshaft/config/environments/development.rb
@@ -0,0 +1,58 @@
+require "active_support/core_ext/integer/time"
+
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded any time
+  # it changes. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports.
+  config.consider_all_requests_local = true
+
+  # Enable/disable caching. By default caching is disabled.
+  # Run rails dev:cache to toggle caching.
+  if Rails.root.join("tmp/caching-dev.txt").exist?
+    config.action_controller.perform_caching = true
+    config.action_controller.enable_fragment_cache_logging = true
+
+    config.cache_store = :memory_store
+    config.public_file_server.headers = {
+      "Cache-Control" => "public, max-age=#{2.days.to_i}"
+    }
+  else
+    config.action_controller.perform_caching = false
+
+    config.cache_store = :null_store
+  end
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  config.action_mailer.perform_caching = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise exceptions for disallowed deprecations.
+  config.active_support.disallowed_deprecation = :raise
+
+  # Tell Active Support which deprecation messages to disallow.
+  config.active_support.disallowed_deprecation_warnings = []
+
+  # Suppress logger output for asset requests.
+  config.assets.quiet = true
+
+  # Raises error for missing translations.
+  # config.i18n.raise_on_missing_translations = true
+
+  # Annotate rendered view with file names.
+  # config.action_view.annotate_rendered_view_with_filenames = true
+
+  # Uncomment if you wish to allow Action Cable access from any origin.
+  # config.action_cable.disable_request_forgery_protection = true
+end
diff --git a/spec/railsapps/rails_81_with_propshaft/config/initializers/backtrace_silencers.rb b/spec/railsapps/rails_81_with_propshaft/config/initializers/backtrace_silencers.rb
diff --git a/spec/railsapps/rails_81_with_propshaft/config/initializers/content_security_policy.rb b/spec/railsapps/rails_81_with_propshaft/config/initializers/content_security_policy.rb
diff --git a/spec/railsapps/rails_81_with_propshaft/config/initializers/filter_parameter_logging.rb b/spec/railsapps/rails_81_with_propshaft/config/initializers/filter_parameter_logging.rb
diff --git a/spec/railsapps/rails_81_with_propshaft/config/initializers/inflections.rb b/spec/railsapps/rails_81_with_propshaft/config/initializers/inflections.rb
diff --git a/spec/railsapps/rails_81_with_propshaft/config/initializers/mime_types.rb b/spec/railsapps/rails_81_with_propshaft/config/initializers/mime_types.rb
diff --git a/spec/railsapps/rails_81_with_propshaft/config/initializers/permissions_policy.rb b/spec/railsapps/rails_81_with_propshaft/config/initializers/permissions_policy.rb
diff --git a/spec/railsapps/rails_81_with_propshaft/config/initializers/wrap_parameters.rb b/spec/railsapps/rails_81_with_propshaft/config/initializers/wrap_parameters.rb
diff --git a/spec/railsapps/rails_81_with_propshaft/config/routes.rb b/spec/railsapps/rails_81_with_propshaft/config/routes.rb

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,8 @@ def parse_html_in_email(mail)`
`17`	`17`	`RailsApp.new("Rails 7.0", "rails_70", min_ruby_version: "2.7"),`
`18`	`18`	`RailsApp.new("Rails 7.1 with sprockets", "rails_71", min_ruby_version: "2.7"),`
`19`	`19`	`RailsApp.new("Rails 7.1 with propshaft", "rails_71_with_propshaft", min_ruby_version: "2.7", asset_pipeline: :propshaft),`
`20`		`- RailsApp.new("Rails 8.0 with propshaft", "rails_80_with_propshaft", min_ruby_version: "3.2", asset_pipeline: :propshaft)`
	`20`	`+ RailsApp.new("Rails 8.0 with propshaft", "rails_80_with_propshaft", min_ruby_version: "3.2", asset_pipeline: :propshaft),`
	`21`	`+ RailsApp.new("Rails 8.1 with propshaft", "rails_81_with_propshaft", min_ruby_version: "3.2", asset_pipeline: :propshaft)`
`21`	`22`	`]`
`22`	`23`
`23`	`24`	`shared_examples "generates valid email" do \|message\|`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+body { background-color: green; }`
	`2`	`+.image { background: url("/rails.png"); }`