Fix broken tests caused by locale configuration (#1875)

* Fix broken tests caused by locale configuration

- Add LocaleSet
- Add LocaleFormatter to force proper string formats
- Rename I18n formats to use hyphen
- Add rake task for updating existing languages on DB
- Fix instances of US english in the templates

* Fix FastGettext initializer loader

* Add Amazon S3 creds for Travis

* Revert "Add Amazon S3 creds for Travis"

This reverts commit 366c1a7.

* Fix Faker localization for rake tasks

Was breaking rake db:seed file

.travis.yml

@@ -21,6 +21,10 @@ addons:
       - nodejs
       - wkhtmltopdf
 
+  addons:
+    artifacts:
+      s3_region: "eu-west-2"
+
 matrix:
   fast_finish: true
   include:

app/models/language.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # == Schema Information
 #
 # Table name: languages
@@ -10,6 +12,7 @@
 #
 
 class Language < ActiveRecord::Base
+
   # frozen_string_literal: true
 
   include ValidationValues
@@ -20,7 +23,7 @@ class Language < ActiveRecord::Base
 
   ABBREVIATION_MAXIMUM_LENGTH = 5
 
-  ABBREVIATION_FORMAT = /\A[a-z]{2}(\_[A-Z]{2})?\Z/
+  ABBREVIATION_FORMAT = /\A[a-z]{2}(\-[A-Z]{2})?\Z/
 
   NAME_MAXIMUM_LENGTH = 20
 
@@ -47,6 +50,12 @@ class Language < ActiveRecord::Base
 
   validates :default_language, inclusion: { in: BOOLEAN_VALUES }
 
+  # =============
+  # = Callbacks =
+  # =============
+
+  before_validation :format_abbreviation, if: :abbreviation_changed?
+
   # ==========
   # = Scopes =
   # ==========
@@ -58,7 +67,20 @@ class Language < ActiveRecord::Base
     where(abbreviation: abbreviation).pluck(:id).first
   }
 
+  # ========================
+  # = Public class methods =
+  # ========================
+
   def self.many?
     Rails.cache.fetch([model_name, "many?"], expires_in: 1.hour) { all.many? }
   end
+
+  private
+
+  def format_abbreviation
+    abbreviation.downcase!
+    return if abbreviation.blank? || abbreviation =~ /\A[a-z]{2}\Z/i
+    self.abbreviation = LocaleFormatter.new(abbreviation, format: :i18n).to_s
+  end
+
 end

app/views/org_admin/phases/_phase.html.erb

@@ -6,7 +6,7 @@
         <%= phase.title %>
         <div class="pull-right">
           <% if template.customization_of.present? && template.latest? %>
-            <%= link_to _('Customize phase'), org_admin_template_phase_path(template.id, phase.id), { class: "btn btn-default", role: 'button' } %>
+            <%= link_to _('Customise phase'), org_admin_template_phase_path(template.id, phase.id), { class: "btn btn-default", role: 'button' } %>
           <% elsif modifiable %>
             <%= link_to _('Edit phase'), edit_org_admin_template_phase_path(template.id, phase.id), { class: "btn btn-default", role: 'button' } %>
           <% else %>

app/views/org_admin/templates/_show.html.erb

@@ -16,14 +16,14 @@
       <%= _('Original funder template has changed!') %>
     <% else %>
       <% if template.published? %>
-        <%= template.customization_of.present? ? _('Customizations are published') : _('Published') %>
+        <%= template.customization_of.present? ? _('Customisations are published') : _('Published') %>
       <% elsif template.draft? %>
         <% tooltip = _('You have unpublished changes! Select "Publish changes" in the Actions menu when you are ready to make them available to users.') %>
-        <%= template.customization_of.present? ? _('Customizations are published') :_('Published')%>
+        <%= template.customization_of.present? ? _('Customisations are published') :_('Published')%>
         <em class="sr-only"><%= tooltip %></em>
         &nbsp;&nbsp;<i class="fa fa-pencil-square-o red" aria-hidden="true" data-toggle="tooltip" title="<%= tooltip %>"></i>
       <% else %>
-        <%= template.customization_of.present? ? _('Customizations are unpublished') :_('Unpublished') %>
+        <%= template.customization_of.present? ? _('Customisations are unpublished') :_('Unpublished') %>
       <% end %>
     <% end %>
   </dd>

app/views/org_admin/templates/index.html.erb

@@ -59,7 +59,7 @@
       <% if !current_user.org.funder_only? %>
         <li role="presentation"
             class="<%= action_name == 'customisable' ? 'active' : '' %>">
-          <%= link_to(_('Customizable Templates'),
+          <%= link_to(_('Customisable Templates'),
               customisable_org_admin_templates_path, { role: 'tab' }) %>
         </li>
       <% end %>

config/environments/development.rb

@@ -1,7 +1,5 @@
 Rails.application.configure do
 
-  config.i18n.available_locales = %w[en en_GB]
-
   # Settings specified here will take precedence over those in config/application.rb.
   # In the development environment your application's code is reloaded on
   # every request. This slows down response time but is perfect for development

config/environments/test.rb

@@ -4,10 +4,6 @@
   # Disable memory store cache set in application.rb
   config.cache_store = :null_store
 
-  # This is required for the Faker gem. See this issue here:
-  # https://github.com/stympy/faker/issues/266
-  config.i18n.available_locales = %w[en en_GB]
-
   # The test environment is used exclusively to run your application's
   # test suite. You never need to work with it otherwise. Remember that
   # your test database is "scratch space" for the test suite and is wiped

config/initializers/fast_gettext.rb

@@ -1,19 +1,21 @@
 # When Travis runs this, the DB isn't always built yet.
 if Language.table_exists?
   def default_locale
-    Language.default.try(:abbreviation) || 'en_GB'
+    Language.default.try(:abbreviation) || 'en-GB'
   end
 
   def available_locales
-    Language.sorted_by_abbreviation.pluck(:abbreviation).presence || [default_locale]
+    LocaleSet.new(
+      Language.sorted_by_abbreviation.pluck(:abbreviation).presence || [default_locale]
+    )
   end
 else
   def default_locale
-    Rails.application.config.i18n.available_locales.first
+    Rails.application.config.i18n.available_locales.first || 'en-GB'
   end
 
   def available_locales
-    Rails.application.config.i18n.available_locales
+    Rails.application.config.i18n.available_locales = LocaleSet.new(['en-GB', 'en'])
   end
 end
 
@@ -24,6 +26,10 @@ def available_locales
   report_warning: false,
 })
 
+I18n.available_locales += available_locales.for(:i18n)
+FastGettext.default_available_locales = available_locales.for(:fast_gettext)
+
 FastGettext.default_text_domain       = 'app'
-FastGettext.default_locale            = default_locale
-FastGettext.default_available_locales = available_locales
+
+I18n.default_locale        = available_locales.for(:i18n).first
+FastGettext.default_locale = available_locales.for(:fast_gettext).first

config/initializers/locale.rb

@@ -1,24 +1,7 @@
-# This initilializer should not be removed unless all internationalisation is handled by gettext_rails
-DMPRoadmap::Application.config.i18n.load_path += Dir[Rails.root.join('config', 'locales', '**', '*.{rb,yml}').to_s]
-module I18n
-    class Config
-        def locale
-            FastGettext.locale
-        end
-        def locale=(new_locale)
-            FastGettext.locale = (new_locale)
-        end
-        def default_locale
-            FastGettext.default_locale
-        end
-        def default_locale=(new_default_locale)
-            FastGettext.default_locale = (new_default_locale)
-        end
-        def available_locales
-            FastGettext.default_available_locales
-        end
-        def available_locales=(new_available_locales)
-            FastGettext.default_available_locales = (new_available_locales)
-        end
-    end
-end
+# frozen_string_literal: true
+
+# This initilializer should not be removed unless all internationalisation is handled by
+# gettext_rails
+DMPRoadmap::Application.config.i18n.load_path += Dir[
+  Rails.root.join('config', 'locales', '**', '*.yml').to_s
+]

config/locales/bootstrap/en_GB.bootstrap.yml → config/locales/bootstrap/en-GB.bootstrap.yml

@@ -1,7 +1,7 @@
 # Sample localization file for English. Add more files in this directory for other locales.
 # See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
 
-en_GB:
+en-GB:
   helpers:
     actions: "Actions"
     links:

config/locales/bootstrap/en_US.bootstrap.yml → config/locales/bootstrap/en-US.bootstrap.yml

@@ -1,7 +1,7 @@
 # Sample localization file for English. Add more files in this directory for other locales.
 # See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
 
-en_US:
+en-US:
   helpers:
     actions: "Actions"
     links:

config/locales/bootstrap/fr_FR.bootstrap.yml → config/locales/bootstrap/fr-FR.bootstrap.yml

@@ -1,5 +1,5 @@
 
-fr_FR:
+fr-FR:
   helpers:
     actions: "Actions"
     links:

config/locales/bootstrap/pt_BR.bootstrap.yml → config/locales/bootstrap/pt-BR.bootstrap.yml

@@ -1,7 +1,7 @@
 # Sample localization file for English. Add more files in this directory for other locales.
 # See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
 
-pt_BR:
+pt-BR:
   helpers:
     actions: "Ações"
     links:

config/locales/contact_us/contact_us.en_GB.yml → config/locales/contact_us/contact_us.en-GB.yml

@@ -1,7 +1,7 @@
 # Sample localization file for English. Add more files in this directory for other locales.
 # See http://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
 
-en_GB:
+en-GB:
   contact_us:
     contact_mailer:
       contact_email:

config/locales/contact_us/contact_us.en_US.yml → config/locales/contact_us/contact_us.en-US.yml

@@ -1,7 +1,7 @@
 # Sample localization file for English. Add more files in this directory for other locales.
 # See http://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
 
-en_US:
+en-US:
   contact_us:
     contact_mailer:
       contact_email:

config/locales/contact_us/contact_us.fr_FR.yml → config/locales/contact_us/contact_us.fr-FR.yml

@@ -1,7 +1,7 @@
 # Sample localization file for English. Add more files in this directory for other locales.
 # See http://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
 
-fr_FR:
+fr-FR:
   contact_us:
     contact_mailer:
       contact_email:

config/locales/contact_us/contact_us.zh-TW.yml

@@ -1,4 +1,4 @@
-zh:
+zh-TW:
   contact_us:
     contact_mailer:
       contact_email:

config/locales/devise/devise.en_GB.yml → config/locales/devise/devise.en-GB.yml

@@ -1,6 +1,6 @@
 # Additional translations at https://github.com/plataformatec/devise/wiki/I18n
 
-en_GB:
+en-GB:
   devise:
     confirmations:
       confirmed: "Your account was successfully confirmed. Please sign in."

config/locales/devise/devise.en_US.yml → config/locales/devise/devise.en-US.yml

@@ -1,6 +1,6 @@
 # Additional translations at https://github.com/plataformatec/devise/wiki/I18n
 
-en_US:
+en-US:
   devise:
     confirmations:
       confirmed: "Your account was successfully confirmed. Please sign in."

config/locales/devise/devise.fr_FR.yml → config/locales/devise/devise.fr-FR.yml

@@ -1,11 +1,11 @@
 # Additional translations at https://github.com/plataformatec/devise/wiki/I18n
 
-fr_FR:
+fr-FR:
   devise:
     confirmations:
       confirmed: "Votre compte a bien été validé. Veuillez vous connecter."
       send_instructions: "Vous recevrez dans quelques minutes un courriel contenant les directives pour activer votre compte."
-      resend_instructions: "Envoyer de nouveau les directives" 
+      resend_instructions: "Envoyer de nouveau les directives"
       send_paranoid_instructions: "Si votre adresse électronique existe dans notre base de données, vous recevrez dans quelques minutes un courriel contenant les directives pour valider votre compte."
     failure:
       already_authenticated: "Vous êtes déjà connecté(e)."
@@ -63,7 +63,7 @@ fr_FR:
     unlocks:
       send_instructions: "Vous recevrez dans quelques minutes un courriel contenant les directives pour déverrouiller votre compte."
       send_paranoid_instructions: "Si votre compte existe, vous recevrez dans quelques minutes un courriel contenant les directives pour le déverrouiller."
-      resend_unlock_instructions: "Envoyer de nouveau les directives de déverouillage." 
+      resend_unlock_instructions: "Envoyer de nouveau les directives de déverouillage."
       unlocked: "Votre compte a bien été déverrouillé. Veuillez vous connecter pour continuer."
   errors:
     messages:

config/locales/devise/devise.pt_BR.yml → config/locales/devise/devise.pt-BR.yml

@@ -1,6 +1,6 @@
 # Additional translations at https://github.com/plataformatec/devise/wiki/I18n
 
-pt_BR:
+pt-BR:
   devise:
     confirmations:
       confirmed: "Sua conta foi confirmada com sucesso. Por favor, inscreva-se."

config/locales/devise/devise_invitable.en_GB.yml → config/locales/devise/devise_invitable.en-GB.yml

@@ -1,4 +1,4 @@
-en_GB:
+en-GB:
   devise:
     invitations:
       send_instructions: 'An invitation email has been sent to %{email}.'

config/locales/devise/devise_invitable.en_US.yml → config/locales/devise/devise_invitable.en-US.yml

@@ -1,4 +1,4 @@
-en_US:
+en-US:
   devise:
     invitations:
       send_instructions: 'An invitation email has been sent to %{email}.'

config/locales/devise/devise_invitable.fr_FR.yml → config/locales/devise/devise_invitable.fr-FR.yml

@@ -1,4 +1,4 @@
-fr_FR:
+fr-FR:
   devise:
     invitations:
       send_instructions: "Un courriel d'invitation a été envoyé à %{email}."

config/locales/en_GB.yml → config/locales/en-GB.yml

@@ -1,5 +1,5 @@
 ---
-en_GB:
+en-GB:
   activerecord:
     errors:
       messages:
@@ -95,7 +95,7 @@ en_GB:
         other: "%{count} months"
       x_years:
         one: 1 year
-        other: "%{count} years"    
+        other: "%{count} years"
       x_seconds:
         one: 1 second
         other: "%{count} seconds"

config/locales/en_US.yml → config/locales/en-US.yml

@@ -1,5 +1,5 @@
 ---
-en_US:
+en-US:
   activerecord:
     errors:
       messages:

config/locales/faker/faker.en_GB.yml → config/locales/faker/faker.en-GB.yml

@@ -1,5 +1,5 @@
 ---
-en_GB:
+en-GB:
   faker:
     language:
       names:

config/locales/fr_CA.yml → config/locales/fr-CA.yml

@@ -1,5 +1,5 @@
 ---
-fr_CA:
+fr-CA:
   activerecord:
     errors:
       messages:

config/locales/fr_FR.yml → config/locales/fr-FR.yml

@@ -1,5 +1,5 @@
 ---
-fr_FR:
+fr-FR:
   activerecord:
     errors:
       messages: