refinerycms-i18n 5.0.1 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bcea55f952652a3a6d9aa9832a38e2f48ec3ac1f2f93761b1f713bf2e22d212e
-  data.tar.gz: 0e449a20fda8a88477829b2081bd9d8188495c096ade12ce649e7784d3b06089
+  metadata.gz: 9c0bbc56d3e341aa95e97b24ff111f12282ea9041ced7d401b55af4ca14b832b
+  data.tar.gz: dd8ce0cc066a9dff7657767d1361fefb1ddea8ee1271ebbd423a2943618df98a
 SHA512:
-  metadata.gz: a2a282bde1823d590255f9f301f709327d29407d9d896adb5c70f911d8862e0d8c187677274654d2e52cb068e4600d57ab8dd99525366158f5dd4364f0052b4b
-  data.tar.gz: 16fe60dd6d7fe847bd4f5223ad1496da72adc9aa26205964fa71b804b7b8b5d87e3ced21cf93d927ac751ba8d526ad1e03f8a1a2dbada4a00d0f43d94a717d67
+  metadata.gz: ddbc4fe467848875424df48aefcf1ab8ad4da8bb5174462d5d2c7288eae42c550101ea81d79312dd1538990d34b984aa2af07e0f687a88aad4bcdfddffc641b4
+  data.tar.gz: e9240d6d049472b194784d545fcc986bc62c447660da89d5b848e0baccae9e5b77059e1e12ca394531c052c0e9a53b8cfc048622dde9fcfccc3774af5248ec8b

data/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: [parndt, bricesanchez]

data/.github/workflows/main.yml

@@ -0,0 +1,51 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        database: [ sqlite3, mysql, postgresql ]
+        ruby: [ 4.0, 3.4, 3.3, 3.2, 3.1 ]
+      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
+      RETRY_COUNT: 3
+
+    name: ${{ matrix.ruby }} ${{ 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: "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 spec

data/.github/workflows/release.yml

@@ -0,0 +1,27 @@
+name: Release Gem to rubygems.org
+
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  push:
+    if: github.repository == 'refinery/refinerycms-i18n'
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+      id-token: write
+
+    steps:
+      # Set up
+      - uses: actions/checkout@v6
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: ruby
+
+      # Release
+      - uses: rubygems/release-gem@v1

data/.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
+

data/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
@@ -14,24 +13,26 @@ group :development, :test do
   gem "listen"
 end
 
+gem 'routing-filter', git: 'https://github.com/svenfuchs/routing-filter', branch: 'master'
+
 # 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.4.10', :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

data/README.md

@@ -1,4 +1,4 @@
-# Refinery CMS I18n [![Build Status](https://travis-ci.org/refinery/refinerycms-i18n.svg?branch=master)](https://travis-ci.org/refinery/refinerycms-i18n)
+# Refinery CMS I18n
 
 I18n logic extracted from Refinery CMS, for Refinery CMS.
 
@@ -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
 ```

data/Rakefile

@@ -1,16 +1,12 @@
 #!/usr/bin/env rake
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
+require "bundler/gem_helper"
+
+Bundler::GemHelper.install_tasks(name: "refinerycms-i18n")
 
 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)

data/lib/generators/refinery/templates/config/initializers/refinery/i18n.rb.erb

@@ -10,4 +10,6 @@ Refinery::I18n.configure do |config|
   # config.frontend_locales = <%= Refinery::I18n.config.frontend_locales.inspect %>
 
   # config.locales = <%= Refinery::I18n.config.locales.inspect %>
+
+  # config.url_filter_enabled = <%= Refinery::I18n.url_filter_enabled.inspect %>
 end

data/lib/refinery/i18n/engine.rb

@@ -18,38 +18,45 @@ module Refinery
       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 @@ module Refinery
               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
 

data/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

data/lib/refinery/i18n-filter.rb

@@ -24,13 +24,19 @@ module RoutingFilter
 
       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 !~ %r{^/(#{Refinery::Core.backend_route}|wymiframe)}
-          result.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

data/lib/refinery/i18n.rb

@@ -1,8 +1,9 @@
 # Encoding: UTF-8 <-- required, please leave this in.
 require 'mobility'
-require 'refinerycms-core'
 require 'routing-filter'
 require 'rails-i18n'
+require 'refinery/i18n/engine'
+require 'refinery/i18n/override_routing_filter'
 
 module Refinery
   autoload :I18nGenerator, 'generators/refinery/i18n_generator'
@@ -61,7 +62,6 @@ module Refinery
       end
     end
 
-    require 'refinery/i18n/engine'
     require 'refinery/i18n/configuration'
   end
 end

data/lib/refinerycms/i18n.rb

@@ -0,0 +1,2 @@
+require 'refinerycms/core'
+require 'refinery/i18n'

data/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.1.0}
   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,14 +14,9 @@ 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.4'
+  s.add_dependency    'routing-filter',   '~> 0.7'
   s.add_dependency    'rails-i18n',       '>= 5.0'
-  s.add_dependency    'mobility',         '~> 0.8.8'
-
-  s.cert_chain  = [File.expand_path("../certs/parndt.pem", __FILE__)]
-  if $0 =~ /gem\z/ && ARGV.include?("build") && ARGV.include?(__FILE__)
-    s.signing_key = File.expand_path("~/.ssh/gem-private_key.pem")
-  end
+  s.add_dependency    'mobility',         '~> 1.2'
 end

data/spec/controllers/refinery/pages_controller_spec.rb

@@ -10,7 +10,7 @@ module Refinery
       subject { get :show, params: { path: 'test', locale: 'en%20217' } }
 
       it 'redirects to the location with the default frontend locale' do
-        expect(subject).to redirect_to ('/test')
+        expect(subject).to redirect_to('/test')
       end
 
       it 'flashes a notice message' do
@@ -18,4 +18,4 @@ module Refinery
       end
     end
   end
-end
+end

data/spec/features/set_locale_spec.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 require "spec_helper"
 
-describe "set_locale parameter", :type => :feature do
+describe "set_locale parameter", type: :feature do
   refinery_login
 
   it "changes language used in backend" do
@@ -9,7 +9,7 @@ describe "set_locale parameter", :type => :feature do
 
     expect(page).to have_content("Switch to your website")
 
-    visit refinery.admin_pages_path(:set_locale => :cs)
+    visit refinery.admin_pages_path(set_locale: :cs)
 
     expect(page).to have_content("Přepnout na web")
   end

data/spec/support/refinery/refinery_login.rb

@@ -0,0 +1,3 @@
+def refinery_login
+  let(:logged_in_user) { Refinery::Core::NilUser.new }
+end

data/translate-readme.md

@@ -1,9 +1,10 @@
 Translate
 =========
 
-This plugin provides a web interface for translating Rails I18n texts (requires Rails 2.2 or higher) from one locale to another. The plugin has been tested only with the simple I18n backend that ships with Rails. I18n texts are read from and written to YAML files under config/locales.
+This plugin provides a web interface for translating Rails I18n texts (requires Rails 2.2 or higher) from one locale to another. The plugin has been tested only with the simple I18n backend that ships with Rails. I18n texts are read from and written to YAML files under `config/locales`.
 
-To translate to a new locale you need to add a YAML file for that locale that contains the locale as the top key and at least one translation.
+To translate to a new locale you need to add a YAML file for that locale.
+A translation file has the _locale_ as the top key and at least one translation.
 
 Please note that there are certain I18n keys that map to Array objects rather than strings and those are currently not dealt with by the translation UI. This means that Rails built in keys such as date.day_names need to be translated manually directly in the YAML file.
 
@@ -19,21 +20,29 @@ Rake Tasks
 
 In addition to the web UI this plugin adds the following rake tasks:
 
-translate:lost_in_translation
-translate:merge_keys
-translate:google
-translate:changed
+* translate:lost_in_translation
+* translate:merge_keys
+* translate:google
+* translate:changed
 
-The lost_in_translation task shows you any I18n keys in your code that are do not have translations in the YAML file for your default locale, i.e. config/locales/sv.yml.
+### Lost in Translation
+The `translate:lost_in_translation` task shows you any I18n keys in your code that are do not have translations in the YAML file for your default locale, i.e. config/locales/sv.yml.
 
-The merge_keys task is supposed to be used in conjunction with Sven Fuch's Rails I18n TextMate bundle (http://github.com/svenfuchs/rails-i18n/tree/master). Texts and keys extracted with the TextMate bundle end up in the temporary file log/translations.yml. When you run the merge_keys rake task the keys are moved over to the corresponding I18n locale file, i.e. config/locales/sv.yml. The merge_keys task also checks for overwrites of existing keys by warning you that one of your extracted keys already exists with a different translation.
+### Merge Keys
+The `translate:merge_keys` task is supposed to be used in conjunction with Sven Fuch's [Rails I18n TextMate bundle](http://github.com/svenfuchs/rails-i18n/tree/master). 
 
-The google task is used for auto translating from one locale to another using Google Translate.
+Texts and keys extracted with the TextMate bundle end up in a temporary file `log/translations.yml`. 
+When you run the `merge_keys` rake task these keys are moved to the corresponding I18n locale file, i.e. `config/locales/sv.yml`. 
+The `merge_keys` task also warns you if one of your extracted keys will overwrite an existing translation.
 
-The changed rake task can show you between one YAML file to another which keys have had their texts changed.
+### Translate Google
+The `translate:google` task is used for auto translating from one locale to another using Google Translate.
+
+### Translate Changed
+The `translate:changed` task can show you which keys have had their texts changed between one file and another.
+
+## Installation
 
-Installation
-=========
 Obtain the source with:
 
 ./script/plugin install git://github.com/newsdesk/translate.git