Merge pull request #2128 from mkllnk/2113-i18n-config

2113 Display only selected languages in switcher

app/views/shared/menu/_large_menu.html.haml

@@ -60,12 +60,12 @@
           = t 'powered_by'
           %a{href: '/'}
             = t 'title'
-      - if I18n.available_locales.count > 1
+      - if OpenFoodNetwork::I18nConfig.selectable_locales.count > 1
         %li.language-switcher.has-dropdown
           %a{href: '#'}
             %i.ofn-i_071-globe
           %ul.dropdown
-            - I18n.available_locales.each do |l|
+            - OpenFoodNetwork::I18nConfig.selectable_locales.each do |l|
               %li
                 %a{href: "?locale=#{l.to_s}" }= t('language_name', locale: l)
       - if spree_current_user.nil?

app/views/shared/menu/_mobile_menu.html.haml

@@ -40,13 +40,13 @@
         %span.nav-primary
           %i.ofn-i_036-producers
           = t 'label_producers'
-    - if I18n.available_locales.count > 1
+    - if OpenFoodNetwork::I18nConfig.selectable_locales.count > 1
       %li.language-switcher.li-menu
         %a
           %i.ofn-i_071-globe
           = t('language_name')
         %ul
-          - I18n.available_locales.each do |l|
+          - OpenFoodNetwork::I18nConfig.selectable_locales.each do |l|
             - if I18n.locale != l
               %li
                 %a{href: "?locale=#{l.to_s}" }= t('language_name', locale: l)

config/application.rb

@@ -1,6 +1,7 @@
 require_relative 'boot'
 
 require 'rails/all'
+require_relative "../lib/open_food_network/i18n_config"
 
 if defined?(Bundler)
   # If you precompile assets before deploying to production, use this line
@@ -104,9 +105,8 @@ module Openfoodnetwork
 
     # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
     # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
-    config.i18n.default_locale = ENV["LOCALE"] || ENV["I18N_LOCALE"] || "en"
-    config.i18n.available_locales = ENV["AVAILABLE_LOCALES"].andand.split(/[\s,]/).andand.map(&:strip) || []
-    config.i18n.available_locales = (config.i18n.available_locales + [config.i18n.default_locale, 'en']).uniq
+    config.i18n.default_locale = OpenFoodNetwork::I18nConfig.default_locale
+    config.i18n.available_locales = OpenFoodNetwork::I18nConfig.available_locales
     I18n.locale = config.i18n.locale = config.i18n.default_locale
 
     # Setting this to true causes a performance regression in Rails 3.2.17

lib/open_food_network/i18n_config.rb

@@ -0,0 +1,27 @@
+module OpenFoodNetwork
+  # Provides access to the language settings.
+  # Currently, language settings are read from the environment.
+  # See: config/application.yml
+  class I18nConfig
+    # Locales that can be selected by users.
+    def self.selectable_locales
+      ENV["AVAILABLE_LOCALES"].andand.split(/[\s,]+/) || []
+    end
+
+    # All locales that can be accessed by the application, including fallbacks.
+    def self.available_locales
+      (selectable_locales + [default_locale, source_locale]).uniq
+    end
+
+    # The default locale that is used when the user doesn't have a preference.
+    def self.default_locale
+      ENV["LOCALE"] || ENV["I18N_LOCALE"] || source_locale
+    end
+
+    # This locale is changed with the code and should always be complete.
+    # All translations are done from this locale.
+    def self.source_locale
+      "en"
+    end
+  end
+end

spec/features/consumer/multilingual_spec.rb

@@ -71,11 +71,10 @@ feature 'Multilingual', js: true do
 
   describe "using the language switcher UI" do
     context "when there is only one language available" do
-      around do |example|
-        available_locales = I18n.available_locales
-        I18n.available_locales = ['en']
-        example.run
-        I18n.available_locales = available_locales
+      before do
+        allow(ENV).to receive(:[]).and_call_original
+        allow(ENV).to receive(:[]).with("LOCALE").and_return("en")
+        allow(ENV).to receive(:[]).with("AVAILABLE_LOCALES").and_return("en")
       end
 
       it "hides the dropdown language menu" do
@@ -84,21 +83,29 @@ feature 'Multilingual', js: true do
       end
     end
 
-    it "allows switching language via the main navigation" do
-      visit root_path
-
-      expect(page).to have_content 'SHOPS'
-
-      find('ul.right li.language-switcher').click
-      within'ul.right li.language-switcher ul.dropdown' do
-        expect(page).to have_link I18n.t('language_name', locale: :en), href: '?locale=en'
-        expect(page).to have_link I18n.t('language_name', locale: :es, default: 'Language Name'), href: '?locale=es'
-
-        find('li a[href="?locale=es"]').click
+    context "when there are multiple languages available" do
+      before do
+        allow(ENV).to receive(:[]).and_call_original
+        allow(ENV).to receive(:[]).with("LOCALE").and_return("en")
+        allow(ENV).to receive(:[]).with("AVAILABLE_LOCALES").and_return("en,es")
       end
 
-      expect(page.driver.browser.cookies['locale'].value).to eq 'es'
-      expect(page).to have_content 'TIENDAS'
+      it "allows switching language via the main navigation" do
+        visit root_path
+
+        expect(page).to have_content 'SHOPS'
+
+        find('ul.right li.language-switcher').click
+        within'ul.right li.language-switcher ul.dropdown' do
+          expect(page).to have_link I18n.t('language_name', locale: :en), href: '?locale=en'
+          expect(page).to have_link I18n.t('language_name', locale: :es, default: 'Language Name'), href: '?locale=es'
+
+          find('li a[href="?locale=es"]').click
+        end
+
+        expect(page.driver.browser.cookies['locale'].value).to eq 'es'
+        expect(page).to have_content 'TIENDAS'
+      end
     end
   end
 end

spec/lib/open_food_network/i18n_config_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+require 'open_food_network/i18n_config'
+
+module OpenFoodNetwork
+  describe I18nConfig do
+    context "in default test configuration" do
+      before do
+        allow(ENV).to receive(:[]).with("LOCALE").and_return("en")
+        allow(ENV).to receive(:[]).with("AVAILABLE_LOCALES").and_return("en,es")
+      end
+
+      it "provides the source locale" do
+        expect(I18nConfig.source_locale).to eq "en"
+      end
+
+      it "provides the default locale" do
+        expect(I18nConfig.default_locale).to eq "en"
+      end
+
+      it "provides the default selectable locales" do
+        expect(I18nConfig.selectable_locales).to eq ["en", "es"]
+      end
+
+      it "provides the default available locales" do
+        expect(I18nConfig.available_locales).to eq ["en", "es"]
+      end
+    end
+
+    context "without configuration" do
+      before do
+        allow(ENV).to receive(:[]).with("LOCALE").and_return(nil)
+        allow(ENV).to receive(:[]).with("I18N_LOCALE").and_return(nil)
+        allow(ENV).to receive(:[]).with("AVAILABLE_LOCALES").and_return(nil)
+      end
+
+      it "provides the source locale" do
+        expect(I18nConfig.source_locale).to eq "en"
+      end
+
+      it "provides the default locale" do
+        expect(I18nConfig.default_locale).to eq "en"
+      end
+
+      it "provides the default selectable locales" do
+        expect(I18nConfig.selectable_locales).to eq []
+      end
+
+      it "provides the default available locales" do
+        expect(I18nConfig.available_locales).to eq ["en"]
+      end
+    end
+
+    context "with UK configuration" do
+      before do
+        allow(ENV).to receive(:[]).with("LOCALE").and_return("en_GB")
+        allow(ENV).to receive(:[]).with("I18N_LOCALE").and_return(nil)
+        allow(ENV).to receive(:[]).with("AVAILABLE_LOCALES").and_return("en_GB")
+      end
+
+      it "provides the source locale" do
+        expect(I18nConfig.source_locale).to eq "en"
+      end
+
+      it "provides the default locale" do
+        expect(I18nConfig.default_locale).to eq "en_GB"
+      end
+
+      it "provides the default selectable locales" do
+        expect(I18nConfig.selectable_locales).to eq ["en_GB"]
+      end
+
+      it "provides the default available locales" do
+        expect(I18nConfig.available_locales).to eq ["en_GB", "en"]
+      end
+    end
+
+    context "with human syntax" do
+      before do
+        allow(ENV).to receive(:[]).with("LOCALE").and_return("es")
+        allow(ENV).to receive(:[]).with("AVAILABLE_LOCALES").and_return("es, fr ,, ,de")
+      end
+
+      it "provides the default selectable locales" do
+        expect(I18nConfig.selectable_locales).to eq ["es", "fr", "de"]
+      end
+
+      it "provides the default available locales" do
+        expect(I18nConfig.available_locales).to eq ["es", "fr", "de", "en"]
+      end
+    end
+  end
+end