Support Ruby 3.x through 4.0

.github/workflows/main.yml

@@ -10,10 +10,9 @@ jobs:
   test:
     strategy:
       matrix:
-        database: [ mysql, postgresql ]
-        ruby: [ 2.7, 2.6 ]
+        database: [ sqlite3, mysql, postgresql ]
+        ruby: [ 4.0, 3.4, 3.3, 3.2, 3.1 ]
       fail-fast: false
-      max-parallel: 20
     runs-on: ubuntu-latest
 
     env:
@@ -29,7 +28,7 @@ jobs:
     name: ${{ matrix.ruby }} ${{ 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

.gitignore

@@ -87,3 +87,83 @@ spec/dummy
 
 # Local Gemfile for developing without sharing dependencies
 .gemfile
+# Rails
+.bundle
+db/*.sqlite3
+db/*.sqlite3-journal
+*.log
+tmp
+tmp/**/*
+
+# Documentation
+doc/api
+doc/app
+.yardoc
+.yardopts
+coverage
+
+# Public Uploads
+public/system/*
+public/themes/*
+
+# Public Cache
+public/javascripts/cache
+public/stylesheets/cache
+public/refinery/*
+
+# Vendor Cache
+vendor/cache
+
+# Acts as Indexed
+index/**/*
+
+# Refinery Specific
+*.tmproj
+*.autobackupbyrefinery.*
+refinerycms-*.gem
+
+# Mac
+.DS_Store
+
+# Windows
+Thumbs.db
+
+# NetBeans
+nbproject
+
+# Eclipse
+.project
+
+# Redcar
+.redcar
+
+# Rubinius
+*.rbc
+
+# Vim
+*.swp
+*.swo
+
+# RubyMine
+.idea
+
+# E-texteditor
+.eprj
+
+# Backup
+*~
+
+# Capybara Bug
+capybara-*html
+
+# sass
+.sass-cache
+.sass-cache/*
+
+#rvm
+.rvmrc
+.rvmrc.*
+
+# vendor/extensions dummy applications.
+vendor/extensions/**/spec/dummy
+

Gemfile

@@ -1,8 +1,7 @@
 source "https://rubygems.org"
-
 gemspec
-
-git "https://github.com/refinery/refinerycms", branch: "master" do
+#
+git "https://github.com/anitagraham/refinerycms", branch: "ruby3" do
   gem "refinerycms"
 
   group :test do
@@ -18,22 +17,22 @@ gem 'routing-filter', git: 'https://github.com/svenfuchs/routing-filter', branch
 
 # Database Configuration
 unless ENV["TRAVIS"]
-  gem "activerecord-jdbcsqlite3-adapter", :platform => :jruby
-  gem "sqlite3", :platform => :ruby
+  gem "activerecord-jdbcsqlite3-adapter", platform: :jruby
+  gem "sqlite3", platform: :ruby
 end
 
 if !ENV["TRAVIS"] || ENV["DB"] == "mysql"
-  gem "activerecord-jdbcmysql-adapter", :platform => :jruby
-  gem "jdbc-mysql", "= 5.1.13", :platform => :jruby
-  gem 'mysql2', '~> 0.5.3', :platform => :ruby
+  gem "activerecord-jdbcmysql-adapter", platform: :jruby
+  gem "jdbc-mysql", "= 5.1.13", platform: :jruby
+  gem 'mysql2', '~> 0.5.3', platform: :ruby
 end
 
 if !ENV["TRAVIS"] || ENV["DB"] == "postgresql"
-  gem "activerecord-jdbcpostgresql-adapter", :platform => :jruby
-  gem "pg", :platform => :ruby
+  gem "activerecord-jdbcpostgresql-adapter", platform: :jruby
+  gem "pg", platform: :ruby
 end
 
-gem "jruby-openssl", :platform => :jruby
+gem "jruby-openssl", platform: :jruby
 
 # Refinery/rails should pull in the proper versions of these
 group :assets do

README.md

@@ -10,15 +10,37 @@ rails g refinery:i18n
 
 ```ruby
 Refinery::I18n.configure do |config|
-   config.default_locale = :en
+  config.default_locale = :en
 
   # config.current_locale = :en
 
   # config.default_frontend_locale = :en
 
-   config.frontend_locales = [:en,:ar]
+  config.frontend_locales = [:en, :ar]
 
-   config.locales = {:en=>"English", :ar=>"Arabic"}
-   #, :nl=>"Nederlands", :pt=>"Português", :"pt-BR"=>"Português brasileiro", :da=>"Dansk", :nb=>"Norsk Bokmål", :sl=>"Slovenian", :es=>"Español", :it=>"Italiano", :de=>"Deutsch", :lv=>"Latviski", :ru=>"Русский", :sv=>"Svenska", :pl=>"Polski", :"zh-CN"=>"简体中文", :"zh-TW"=>"繁體中文", :el=>"Ελληνικά", :rs=>"Srpski", :cs=>"Česky", :sk=>"Slovenský", :ja=>"日本語", :bg=>"Български", :hu=>"Hungarian", :uk=>"Українська"}
+  config.locales = { en: "English", ar: "Arabic" }
+  # { nl: "Nederlands",
+  #   pt: "Português",
+  #   "pt-BR": "Português brasileiro",
+  #   da: "Dansk",
+  #   nb: "Norsk Bokmål",
+  #   sl: "Slovenian",
+  #   es: "Español",
+  #   it: "Italiano",
+  #   de: "Deutsch",
+  #   lv: "Latviski",
+  #   ru: "Русский",
+  #   sv: "Svenska",
+  #   pl: "Polski",
+  #   "zh-CN": "简体中文",
+  #   "zh-TW": "繁體中文",
+  #   el: "Ελληνικά",
+  #   rs: "Srpski",
+  #   cs: "Česky",
+  #   sk: "Slovenský",
+  #   ja: "日本語",
+  #   bg: "Български",
+  #   hu: "Hungarian",
+  #   uk: "Українська" }
 end
 ```

Rakefile

@@ -8,9 +8,7 @@ end
 ENGINE_PATH = File.dirname(__FILE__)
 APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
 
-if File.exists?(APP_RAKEFILE)
-  load 'rails/tasks/engine.rake'
-end
+load 'rails/tasks/engine.rake' if File.exist?(APP_RAKEFILE)
 
 require "refinerycms-testing"
 Refinery::Testing::Railtie.load_dummy_tasks(ENGINE_PATH)

lib/refinery/i18n-filter.rb

@@ -24,13 +24,19 @@ def around_generate(params, &block)
 
       yield.tap do |result|
         result = result.is_a?(Array) ? result.first : result
-        if ::Refinery::I18n.url_filter_enabled? and
-           locale != ::Refinery::I18n.default_frontend_locale and
-           result.url !~ %r{^/(#{Refinery::Core.backend_route}|wymiframe)}
-          result.url.sub!(%r(^(http.?://[^/]*)?(.*))) { "#{$1}/#{locale}#{$2}" }
-        end
+        insert_locale(result.url, locale) if url_needs_locale?(result.url, locale)
       end
     end
 
+    # locale should be inserted if filtering AND not in default locale AND not a backend url
+    private def url_needs_locale?(url, locale)
+      ::Refinery::I18n.url_filter_enabled? &&
+        locale != ::Refinery::I18n.default_frontend_locale &&
+        url !~ %r{^/(#{Refinery::Core.backend_route}|wymiframe)}
+    end
+
+    private def insert_locale(url, locale)
+      url.sub!(%r(^(http.?://[^/]*)?(.*))) { "#{$1}/#{locale}#{$2}" }
+    end
   end
 end

lib/refinery/i18n.rb

@@ -3,6 +3,7 @@
 require 'routing-filter'
 require 'rails-i18n'
 require 'refinery/i18n/engine'
+require 'refinery/i18n/override_routing_filter'
 
 module Refinery
   autoload :I18nGenerator, 'generators/refinery/i18n_generator'

lib/refinery/i18n/engine.rb

@@ -18,38 +18,45 @@ class Engine < Rails::Engine
       config.to_prepare do
         ::ApplicationController.module_eval do
           def default_url_options
-            super.reverse_merge ({ locale: ::I18n.locale })
+            super.reverse_merge({ locale: ::I18n.locale })
           end
 
           def find_or_set_locale
-            ::I18n.locale = ::Refinery::I18n.current_frontend_locale
+            locale = params[:locale]&.to_sym
+            ::I18n.locale = ::Refinery::I18n.default_frontend_locale
 
-            if ::Refinery::I18n.has_locale?(locale = params[:locale].try(:to_sym))
-              ::I18n.locale = locale
-            elsif locale.present? && locale != ::Refinery::I18n.default_frontend_locale
-              ::I18n.locale = ::Refinery::I18n.default_frontend_locale
+            if locale.nil? || valid_locale?(locale) || locale == ::Refinery::I18n.default_frontend_locale
+              ::I18n.locale = locale || ::Refinery::I18n.default_frontend_locale
+            else
               redirect_to(params.permit(:locale).merge(locale: ::I18n.locale),
                           notice: "The locale '#{locale}' is not supported.") and return
-            else
-              ::I18n.locale = ::Refinery::I18n.default_frontend_locale
             end
             Mobility.locale = ::I18n.locale
           end
 
+          def valid_locale?(locale)
+            locale && ::Refinery::I18n.locales.keys.include?(locale)
+          end
+
           prepend_before_action :find_or_set_locale
           protected :default_url_options, :find_or_set_locale
         end
 
         ::Refinery::AdminController.class_eval do
           def find_or_set_locale
-            if (params[:set_locale] && ::Refinery::I18n.locales.keys.map(&:to_sym).include?(params[:set_locale].to_sym))
-              ::Refinery::I18n.current_locale = params[:set_locale].to_sym
+            locale = params[:set_locale]&.to_sym
+            if valid_locale?(locale)
+              ::Refinery::I18n.current_locale = locale
               redirect_back_or_default(refinery.admin_root_path) and return
             else
               ::I18n.locale = ::Refinery::I18n.current_locale
             end
           end
 
+          def valid_locale?(locale)
+            locale && ::Refinery::I18n.locales.keys.include?(locale)
+          end
+
           def globalize!
             if ::Refinery::I18n.frontend_locales.any?
               if params[:switch_locale]
@@ -61,9 +68,11 @@ def globalize!
               end
             end
           end
+
           # globalize! should be prepended first so that it runs after find_or_set_locale
           prepend_before_action :globalize!, :find_or_set_locale
           protected :globalize!, :find_or_set_locale
+          private :valid_locale?
         end
       end
 

lib/refinery/i18n/override_routing_filter.rb

@@ -0,0 +1,70 @@
+module RoutingFilterOverrideShared
+  private
+
+  def apply_routing_filters(path, env)
+    filter_parameters = {}
+    original_path = path.dup
+
+    @routes.filters.run(:around_recognize, path, env) do
+      filter_parameters
+    end
+
+    [path, original_path, filter_parameters]
+  end
+end
+
+if Rails::VERSION::MAJOR == 8 && Rails::VERSION::MINOR >= 1
+  # from: https://github.com/svenfuchs/routing-filter/pull/87
+  # Removing the (existing) broken find_routes override from the routing-filter gem first
+  if defined?(ActionDispatchJourneyRouterWithFiltering) &&
+    ActionDispatchJourneyRouterWithFiltering.method_defined?(:find_routes)
+    ActionDispatchJourneyRouterWithFiltering.remove_method(:find_routes)
+  end
+
+  # Rails 8.1+ uses recognize method instead of find_routes
+  module CustomOverridesActionDispatchJourneyRouterRails8
+    include RoutingFilterOverrideShared
+
+    def recognize(req, &block)
+      path, original_path, filter_parameters = apply_routing_filters(req.path_info, req.env)
+      req.path_info = path
+
+      ##### OVERRIDE STARTS #####
+      super(req) do |route, parameters|
+        parameters.merge!(filter_parameters)
+        req.path_info = original_path
+        yield route, parameters
+      end.tap { req.path_info = original_path }
+      ##### OVERRIDE ENDS #####
+    end
+  end
+
+  ActionDispatch::Journey::Router.prepend(CustomOverridesActionDispatchJourneyRouterRails8)
+elsif Rails::VERSION::MAJOR == 8 || (Rails::VERSION::MAJOR == 7 && Rails::VERSION::MINOR >= 1)
+  # from: https://github.com/svenfuchs/routing-filter/pull/87
+  # Removing the (existing) broken find_routes override from the routing-filter gem first
+  if defined?(ActionDispatchJourneyRouterWithFiltering) &&
+    ActionDispatchJourneyRouterWithFiltering.method_defined?(:find_routes)
+    ActionDispatchJourneyRouterWithFiltering.remove_method(:find_routes)
+  end
+
+  # Rails < 8.1 uses find_routes method
+  module CustomOverridesActionDispatchJourneyRouterWithFiltering
+    include RoutingFilterOverrideShared
+
+    def find_routes(env)
+      path = env.is_a?(Hash) ? env['PATH_INFO'] : env.path_info
+      path, original_path, filter_parameters = apply_routing_filters(path, env)
+
+      ##### OVERRIDE STARTS #####
+      super(env) do |match, parameters, route|
+        parameters = parameters.merge(filter_parameters)
+        env.is_a?(Hash) ? env['PATH_INFO'] = original_path : env.path_info = original_path
+        yield [match, parameters, route]
+      end
+      ##### OVERRIDE ENDS #####
+    end
+  end
+
+  ActionDispatch::Journey::Router.prepend(CustomOverridesActionDispatchJourneyRouterWithFiltering)
+end

refinerycms-i18n.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name              = %q{refinerycms-i18n}
-  s.version           = %q{5.0.1}
+  s.version           = %q{5.0.2}
   s.description       = %q{i18n logic extracted from Refinery CMS, for Refinery CMS.}
   s.summary           = %q{i18n logic for Refinery CMS.}
   s.email             = %q{info@refinerycms.com}
@@ -14,11 +14,11 @@ Gem::Specification.new do |s|
   s.files             = `git ls-files`.split("\n")
   s.test_files        = `git ls-files -- spec/*`.split("\n")
 
-  s.required_ruby_version = '>= 2.2.9'
+  s.required_ruby_version = '>= 2.7'
 
-  s.add_dependency    'routing-filter',   '~> 0.6'
+  s.add_dependency    'routing-filter',   '~> 0.7'
   s.add_dependency    'rails-i18n',       '>= 5.0'
-  s.add_dependency    'mobility',         '~> 0.8.8'
+  s.add_dependency    'mobility',         '~> 1.2'
 
   s.cert_chain  = [File.expand_path("../certs/parndt.pem", __FILE__)]
   if $0 =~ /gem\z/ && ARGV.include?("build") && ARGV.include?(__FILE__)