govuk_app_config 9.16.11 → 9.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef31f116da13cbf5b977462f7a0f01dd6fe9094fb3a4d7930098ef7e1779b55b
-  data.tar.gz: d01c8f36ec8b6696d0a69ccefe81633ff8864a704e217efb9bfda6e7e99b16ba
+  metadata.gz: 5130dcd8e16063ab71e12f3d0dce77b28c0d4f83b4d7ea7a60c530f914d69e7d
+  data.tar.gz: 7d16c3739eaadebaabb1c6e4f62ae2c63f0bc7f05551bf55b2190d345db76637
 SHA512:
-  metadata.gz: 7f00e5c356a1a22d346ab031d808f3d831ee4810ef315da4b74e0e9769c5ba1b9c6e959cb34711ab17df25d62869684d92b23618d7130b2f2c2abd133ab8ef19
-  data.tar.gz: 60fd7d473af6a45420bc09043e35e823979fa150f84dc29e5bb914e000bbdba90b8276e799b2635d4fb1c44723bdc89dc15275c32ae102c8de32bf4fddd78155
+  metadata.gz: b2f2de9a6e91294a626277231414f90b8ea58911683b12c7ab84daec70f4fb13cd817fc8652faea32372ca7debff613c4b9f15358bdb7ab6230f4571ff0898a9
+  data.tar.gz: 9f0dfbff9e68c7d600dc90a4038acaee82620daae3cf52b0a35dfdfe56a65f196b59a2eff876b549a899022a659d35d87e50cb328ed45420612a0f172146554f

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 9.17.0
+
+* Add support for internationalisation of Rails framework strings ([#444](https://github.com/alphagov/govuk_app_config/pull/444))
+
 # 9.16.11
 
 * Update dependencies

data/README.md

@@ -178,9 +178,19 @@ app with the following content:
 GovukContentSecurityPolicy.configure
 ```
 
-## Internationalisation rules
+## Internationalisation
 
-Some frontend apps support languages that are not defined in the i18n gem. This provides them with our own custom rules for these languages.
+Some frontend apps support languages that are not yet defined in the [rails-i18n](https://github.com/svenfuchs/rails-i18n) gem that is bundled with Rails.
+
+The missing translations can be added to a locale file in the folder [`lib/govuk_app_config/govuk_i8n`](lib/govuk_app_config/govuk_i18n/). The [`:en`](https://github.com/svenfuchs/rails-i18n/blob/master/rails/locale/en-GB.yml) locale file in the Rails repo  can be used as a guide to key names, as it contains all the keys that Rails uses for a fully internationalised language. It is not necessary to add all of these keys to your file.
+
+See [example.yml](lib/govuk_app_config/govuk_i18n/docs/example.yml) for the most likely structure.
+
+The translations can be enabled in the frontend application by creating a file at `config/initializers/govuk_i18n.rb` with the following content:
+
+```ruby
+GovukI18n.configure
+```
 
 ## Time zone
 

data/lib/govuk_app_config/govuk_i18n/docs/example.yml

@@ -0,0 +1,113 @@
+## Example locale file structure
+---
+#  example:
+#    date:
+#      abbr_day_names:
+#      - Sun
+#      - Mon
+#      - Tue
+#      - Wed
+#      - Thu
+#      - Fri
+#      - Sat
+#      abbr_month_names:
+#      - Jan
+#      - Feb
+#      - Mar
+#      - Apr
+#      - May
+#      - Jun
+#      - Jul
+#      - Aug
+#      - Sep
+#      - Oct
+#      - Nov
+#      - Dec
+#      day_names:
+#      - Sunday
+#      - Monday
+#      - Tuesday
+#      - Wednesday
+#      - Thursday
+#      - Friday
+#      - Saturday
+#      formats:
+#        default: "%Y-%m-%d"
+#        long: "%B %d, %Y"
+#        short: "%b %d"
+#      month_names:
+#      -
+#      - January
+#      - February
+#      - માર્ચ
+#      - April
+#      - May
+#      - જૂન
+#      - July
+#      - August
+#      - September
+#      - October
+#      - November
+#      - December
+#      order:
+#      - year
+#      - month
+#      - day
+#    datetime:
+#      distance_in_words:
+#        about_x_hours:
+#          one: about %{count} hour
+#          other: about %{count} hours
+#        about_x_months:
+#          one: about %{count} month
+#          other: about %{count} months
+#        about_x_years:
+#          one: about %{count} year
+#          other: about %{count} years
+#        almost_x_years:
+#          one: almost %{count} year
+#          other: almost %{count} years
+#        half_a_minute: half a minute
+#        less_than_x_seconds:
+#          one: less than %{count} second
+#          other: less than %{count} seconds
+#        less_than_x_minutes:
+#          one: less than a minute
+#          other: less than %{count} minutes
+#        over_x_years:
+#          one: over %{count} year
+#          other: over %{count} years
+#        x_seconds:
+#          one: "%{count} second"
+#          other: "%{count} seconds"
+#        x_minutes:
+#          one: "%{count} minute"
+#          other: "%{count} minutes"
+#        x_days:
+#          one: "%{count} day"
+#          other: "%{count} days"
+#        x_months:
+#          one: "%{count} month"
+#          other: "%{count} months"
+#        x_years:
+#          one: "%{count} year"
+#          other: "%{count} years"
+#      prompts:
+#        second: Seconds
+#        minute: Minute
+#        hour: Hour
+#        day: Day
+#        month: Month
+#        year: Year
+#    support:
+#      array:
+#        last_word_connector: ", and "
+#        two_words_connector: " and "
+#        words_connector: ", "
+#    time:
+#      am: am
+#      formats:
+#        default: "%a, %d %b %Y %H:%M:%S %z"
+#        long: "%B %d, %Y %H:%M"
+#        short: "%d %b %H:%M"
+#      pm: pm

data/lib/govuk_app_config/govuk_i18n.rb

@@ -0,0 +1,7 @@
+module GovukI18n
+  GOVUK_APP_CONFIG_PATH = Gem.loaded_specs["govuk_app_config"].gem_dir
+
+  def self.configure
+    I18n.load_path += Dir[File.join(GOVUK_APP_CONFIG_PATH, "lib", "govuk_app_config", "govuk_i18n", "*.{yml}").to_s]
+  end
+end

data/lib/govuk_app_config/version.rb

@@ -1,3 +1,3 @@
 module GovukAppConfig
-  VERSION = "9.16.11".freeze
+  VERSION = "9.17.0".freeze
 end

data/lib/govuk_app_config.rb

@@ -1,14 +1,15 @@
-require "govuk_app_config/version"
-require "govuk_app_config/govuk_statsd"
 require "govuk_app_config/govuk_error"
-require "govuk_app_config/govuk_proxy/static_proxy"
 require "govuk_app_config/govuk_healthcheck"
 require "govuk_app_config/govuk_open_telemetry"
 require "govuk_app_config/govuk_prometheus_exporter"
+require "govuk_app_config/govuk_proxy/static_proxy"
+require "govuk_app_config/govuk_statsd"
+require "govuk_app_config/version"
 
 if defined?(Rails)
-  require "govuk_app_config/govuk_json_logging"
   require "govuk_app_config/govuk_content_security_policy"
+  require "govuk_app_config/govuk_i18n"
+  require "govuk_app_config/govuk_json_logging"
   require "govuk_app_config/govuk_timezone"
   require "govuk_app_config/railtie"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_app_config
 version: !ruby/object:Gem::Version
-  version: 9.16.11
+  version: 9.17.0
 platform: ruby
 authors:
 - GOV.UK Dev
@@ -366,6 +366,8 @@ files:
 - lib/govuk_app_config/govuk_healthcheck/rails_cache.rb
 - lib/govuk_app_config/govuk_healthcheck/redis.rb
 - lib/govuk_app_config/govuk_healthcheck/sidekiq_redis.rb
+- lib/govuk_app_config/govuk_i18n.rb
+- lib/govuk_app_config/govuk_i18n/docs/example.yml
 - lib/govuk_app_config/govuk_json_logging.rb
 - lib/govuk_app_config/govuk_json_logging/rails_ext/action_controller/metal/instrumentation.rb
 - lib/govuk_app_config/govuk_open_telemetry.rb
@@ -394,7 +396,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.8
 specification_version: 4
 summary: Base configuration for GOV.UK applications
 test_files: []