From 68ec1d180ae38abca56f2e848db58d23224813de Mon Sep 17 00:00:00 2001
From: gunchleoc <fios@foramnagaidhlig.net>
Date: Wed, 4 Oct 2023 08:23:50 +0100
Subject: [PATCH] Fix language sorting in settings (#27158)

---
 app/helpers/languages_helper.rb               | 18 +++++++++++++
 app/helpers/settings_helper.rb                |  6 ++++-
 .../preferences/appearance/show.html.haml     |  2 +-
 spec/helpers/languages_helper_spec.rb         | 26 +++++++++++++++++++
 4 files changed, 50 insertions(+), 2 deletions(-)

diff --git a/app/helpers/languages_helper.rb b/app/helpers/languages_helper.rb
index c42c4c23e..ddb10aa25 100644
--- a/app/helpers/languages_helper.rb
+++ b/app/helpers/languages_helper.rb
@@ -230,6 +230,24 @@ module LanguagesHelper
     'sr-Latn': 'Srpski (latinica)',
   }.freeze
 
+  # Helper for self.sorted_locale_keys
+  private_class_method def self.locale_name_for_sorting(locale)
+    if locale.blank? || locale == 'und'
+      '000'
+    elsif (supported_locale = SUPPORTED_LOCALES[locale.to_sym])
+      ASCIIFolding.new.fold(supported_locale[1]).downcase
+    elsif (regional_locale = REGIONAL_LOCALE_NAMES[locale.to_sym])
+      ASCIIFolding.new.fold(regional_locale).downcase
+    else
+      locale
+    end
+  end
+
+  # Sort locales by native name for dropdown menus
+  def self.sorted_locale_keys(locale_keys)
+    locale_keys.sort_by { |key, _| locale_name_for_sorting(key) }
+  end
+
   def native_locale_name(locale)
     if locale.blank? || locale == 'und'
       I18n.t('generic.none')
diff --git a/app/helpers/settings_helper.rb b/app/helpers/settings_helper.rb
index 889ca7f40..fce36bf43 100644
--- a/app/helpers/settings_helper.rb
+++ b/app/helpers/settings_helper.rb
@@ -2,7 +2,11 @@
 
 module SettingsHelper
   def filterable_languages
-    LanguagesHelper::SUPPORTED_LOCALES.keys
+    LanguagesHelper.sorted_locale_keys(LanguagesHelper::SUPPORTED_LOCALES.keys)
+  end
+
+  def ui_languages
+    LanguagesHelper.sorted_locale_keys(I18n.available_locales)
   end
 
   def session_device_icon(session)
diff --git a/app/views/settings/preferences/appearance/show.html.haml b/app/views/settings/preferences/appearance/show.html.haml
index ea33487c3..11fa2bfc4 100644
--- a/app/views/settings/preferences/appearance/show.html.haml
+++ b/app/views/settings/preferences/appearance/show.html.haml
@@ -7,7 +7,7 @@
 = simple_form_for current_user, url: settings_preferences_appearance_path, html: { method: :put, id: 'edit_user' } do |f|
   .fields-row
     .fields-group.fields-row__column.fields-row__column-6
-      = f.input :locale, collection: I18n.available_locales, wrapper: :with_label, include_blank: false, label_method: ->(locale) { native_locale_name(locale) }, selected: I18n.locale, hint: false
+      = f.input :locale, collection: ui_languages, wrapper: :with_label, include_blank: false, label_method: ->(locale) { native_locale_name(locale) }, selected: I18n.locale, hint: false
     .fields-group.fields-row__column.fields-row__column-6
       = f.input :time_zone, wrapper: :with_label, collection: ActiveSupport::TimeZone.all.map { |tz| ["(GMT#{tz.formatted_offset}) #{tz.name}", tz.tzinfo.name] }, hint: false
 
diff --git a/spec/helpers/languages_helper_spec.rb b/spec/helpers/languages_helper_spec.rb
index 98c8064a3..99461b293 100644
--- a/spec/helpers/languages_helper_spec.rb
+++ b/spec/helpers/languages_helper_spec.rb
@@ -60,4 +60,30 @@ describe LanguagesHelper do
       end
     end
   end
+
+  describe 'sorted_locales' do
+    context 'when sorting with native name' do
+      it 'returns Suomi after Gàidhlig' do
+        expect(described_class.sorted_locale_keys(%w(fi gd))).to eq(%w(gd fi))
+      end
+    end
+
+    context 'when sorting with diacritics' do
+      it 'returns Íslensk before Suomi' do
+        expect(described_class.sorted_locale_keys(%w(fi is))).to eq(%w(is fi))
+      end
+    end
+
+    context 'when sorting with non-Latin' do
+      it 'returns Suomi before Amharic' do
+        expect(described_class.sorted_locale_keys(%w(am fi))).to eq(%w(fi am))
+      end
+    end
+
+    context 'when sorting with local variants' do
+      it 'returns variant in-line' do
+        expect(described_class.sorted_locale_keys(%w(en eo en-GB))).to eq(%w(en en-GB eo))
+      end
+    end
+  end
 end