Add support for Rails 8.1

Author: n-rodriguez

.github/workflows/ci.yml

@@ -44,6 +44,7 @@ jobs:
           - '3.2'
           - 'head'
         rails:
+          - rails_8.1
           - rails_8.0
           - rails_7.2
 

.rubocop.yml

@@ -14,6 +14,7 @@ AllCops:
     - gemfiles/*
     - spec/dummy/**/*
     - lib/route_translator/core_ext/mapper_patch.rb
+    - lib/route_translator/core_ext/mapper_patch81.rb
 
 Gemspec/RequireMFA:
   Enabled: false

Appraisals

@@ -8,3 +8,7 @@ end
 appraise 'rails_8.0' do
   gem 'rails', '~> 8.0.0'
 end
+
+appraise 'rails_8.1' do
+  gem 'rails', '~> 8.1.0.rc1'
+end

gemfiles/rails_8.1.gemfile

@@ -0,0 +1,25 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal", git: "https://github.com/thoughtbot/appraisal.git"
+gem "dbg-rb"
+gem "puma"
+gem "rake"
+gem "rspec-rails"
+gem "simplecov"
+gem "sqlite3", "~> 2.1.0"
+gem "warning"
+gem "bar", path: "../spec/dummy/engines/bar"
+gem "baz", path: "../spec/dummy/engines/baz"
+gem "foo", path: "../spec/dummy/engines/foo"
+gem "guard-rspec", require: false
+gem "rubocop", require: false
+gem "rubocop-performance", require: false
+gem "rubocop-rails", require: false
+gem "rubocop-rake", require: false
+gem "rubocop-rspec", require: false
+gem "rubocop-rspec_rails", require: false
+gem "rails", "~> 8.1.0.rc1"
+
+gemspec path: "../"

lib/route_translator.rb

@@ -27,4 +27,9 @@ def self.translator_for(engine)
     @translators[engine]
   end
 
+
+  def self.rails_81?
+    Gem::Version.new(Rails::VERSION::STRING) >= Gem::Version.new('8.1.0.rc1')
+  end
+
 end

lib/route_translator/core_ext/mapper_patch81.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module RouteTranslator
+  module CoreExt
+    module MapperPatch81
+      extend ActiveSupport::Concern
+
+      URI_PARSER = defined?(URI::RFC2396_PARSER) ? URI::RFC2396_PARSER : URI::DEFAULT_PARSER
+      private_constant :URI_PARSER
+
+
+      def localized(engine)
+        @localized = true
+        @engine = engine
+        yield
+        @localized = false
+        @engine = nil
+      end
+
+
+      private
+
+
+        def add_route(action, controller, as, options_action, _path, to, via, formatted, anchor, options_constraints, internal, options_mapping)
+          return super unless @localized
+
+          localized_add_route(action, controller, as, options_action, _path, to, via, formatted, anchor, options_constraints, internal, options_mapping)
+        end
+
+
+        def localized_add_route(action, controller, as, options_action, _path, to, via, formatted, anchor, options_constraints, internal, options_mapping)
+          # From Rails source
+          # See: https://github.com/rails/rails/blob/main/actionpack/lib/action_dispatch/routing/mapper.rb#L2195
+          path = path_for_action(action, _path)
+          raise ArgumentError, "path is required" if path.blank?
+
+          action = action.to_s
+
+          default_action = options_action || @scope[:action]
+
+          if /^[\w\-\/]+$/.match?(action)
+            default_action ||= action.tr("-", "_") unless action.include?("/")
+          else
+            action = nil
+          end
+
+          as   = name_for_action(as, action) if as
+          path = ActionDispatch::Routing::Mapper::Mapping.normalize_path URI_PARSER.escape(path), formatted
+          ast  = ActionDispatch::Journey::Parser.parse path
+
+          mapping = ActionDispatch::Routing::Mapper::Mapping.build(@scope, @set, ast, controller, default_action, to, via, formatted, options_constraints, anchor, internal, options_mapping)
+          # End of Rails source
+
+          # Original
+          # @set.add_route(mapping, as)
+
+          # Our override
+          _add_localized_route(@scope, @set, ast, controller, default_action, to, via, formatted, options_constraints, anchor, internal, options_mapping, mapping, as, path, @engine)
+        end
+
+
+        def _add_localized_route(scope, set, ast, controller, default_action, to, via, formatted, options_constraints, anchor, internal, options_mapping, mapping, as, path, engine)
+          route = RouteTranslator::Route.new(set, path, as, options_constraints, options_mapping, mapping)
+          translator = RouteTranslator.translator_for(engine)
+
+          raise RouteTranslator::TranslatorNotFound, "RouteTranslator is not configured for current engine : #{engine}" if translator.nil?
+
+          translator.translations_for(route) do |locale, translated_name, translated_path, translated_options_constraints, translated_options|
+            translated_path_ast = ::ActionDispatch::Journey::Parser.parse(translated_path)
+            translated_mapping  = _translate_mapping(locale, set, translated_options, translated_path_ast, scope, controller, default_action, to, formatted, via, translated_options_constraints, anchor, internal)
+
+            # call original method
+            set.add_route translated_mapping, translated_name
+          end
+        end
+
+
+        def _translate_mapping(locale, route_set, translated_options, translated_path_ast, scope, controller, default_action, to, formatted, via, translated_options_constraints, anchor, internal)
+          scope_params = {
+            blocks:      scope[:blocks] || [],
+            constraints: scope[:constraints] || {},
+            defaults:    (scope[:defaults] || {}).dup,
+            module:      scope[:module],
+            options:     scope[:options] ? scope[:options].merge(translated_options) : translated_options
+          }
+
+          ::ActionDispatch::Routing::Mapper::Mapping.build scope_params, route_set, translated_path_ast, controller, default_action, to, via, formatted, translated_options_constraints, anchor, internal, translated_options
+        end
+
+    end
+  end
+end

lib/route_translator/railtie.rb

@@ -20,7 +20,8 @@ def add_route_translator_for(engine, opts = {})
 
 
     initializer 'route_translator.patch' do
-      ActionDispatch::Routing::Mapper.prepend(RouteTranslator::CoreExt::MapperPatch)
+      mapper_patch = RouteTranslator.rails_81? ? 'RouteTranslator::CoreExt::MapperPatch81' : 'RouteTranslator::CoreExt::MapperPatch'
+      ActionDispatch::Routing::Mapper.prepend(mapper_patch.constantize)
     end
 
   end

spec/spec_helper.rb

@@ -23,6 +23,7 @@
 # Start SimpleCov
 SimpleCov.start do
   formatter SimpleCov::Formatter::MultiFormatter.new([SimpleCov::Formatter::HTMLFormatter, SimpleCov::Formatter::JSONFormatter])
+  add_filter 'gemfiles/'
   add_filter 'spec/'
 end