rails_translation_manager 1.5.2 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0586632094e19c18a2fef0977554080b300afd1b590b25396f7212bc699bcf49'
-  data.tar.gz: b40d1c4a33d1ab35e2dd997a28dbf1cf43303e96ef12b87b6f309038bee63754
+  metadata.gz: 4580d7e3e338ff4cccce8e60071752f92d36e592c332c453a741b8680c960108
+  data.tar.gz: de4e1e27b0ce7509710228fae3d1ea749fa4a904288a30cbb953f1d18428793d
 SHA512:
-  metadata.gz: 6f99d23e8366b0d646d0e2e273cc2919cbf156b5b82a28de499ea4195f8c34ec956e00e118c8eefe09a378a07417bba8f7d6197c91559442e43f649081b63c94
-  data.tar.gz: f1e76272d20dad72b019f078302329137308072e44054174591de882db82826f9fd9aca7c71df6a11d238b750e69039092316788e11d960172e7a673f9a01538
+  metadata.gz: ca97bd67bb784adab54ac6fac15abcebb0c99f423b714b887f7a9d6f09f0991c6d584b22f01a102d069828dd1f1e66a03a445aaf64cb6510d97a028d4750a429
+  data.tar.gz: 8b0bea5c616e666fad3a73b1fa8d11351456e78fece8c0418f2dbd3c9581c24d3dcd36d581f6d185a2c9ca0ec84777714c6986d6fd89dfd287729ffdd18f6160

data/.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: bundler
+    directory: /
+    schedule:
+      interval: daily
+  - package-ecosystem: "github-actions"
+    directory: /
+    schedule:
+      interval: daily

data/.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+on: [push, pull_request]
+
+jobs:
+  # This matrix job runs the test suite against multiple Ruby versions
+  test_matrix:
+    strategy:
+      fail-fast: false
+      matrix:
+        # Due to https://github.com/actions/runner/issues/849, we have to use quotes for '3.0'
+        ruby: [ 2.7, '3.0', 3.1 ]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake
+
+  # Branch protection rules cannot directly depend on status checks from matrix jobs.
+  # So instead we define `test` as a dummy job which only runs after the preceding `test_matrix` checks have passed.
+  # Solution inspired by: https://github.community/t/status-check-for-a-matrix-jobs/127354/3
+  test:
+    needs: test_matrix
+    runs-on: ubuntu-latest
+    steps:
+      - run: echo "All matrix tests have passed 🚀"
+
+  publish:
+    needs: test
+    if: ${{ github.ref == 'refs/heads/main' }}
+    permissions:
+      contents: write
+    uses: alphagov/govuk-infrastructure/.github/workflows/publish-rubygem.yaml@main
+    secrets:
+      GEM_HOST_API_KEY: ${{ secrets.ALPHAGOV_RUBYGEMS_API_KEY }}

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+# 1.6.1
+
+* Audits plural rules and ensures consistent formatting https://github.com/alphagov/rails_translation_manager/pull/57
+* Allows all plural rules to be loaded by setting env variable https://github.com/alphagov/rails_translation_manager/pull/58/
+
+# 1.6.0
+
+Update plural file loading https://github.com/alphagov/rails_translation_manager/pull/52
+Update missing English keys checker https://github.com/alphagov/rails_translation_manager/pull/53
+Add missing plurals for Welsh, Maltese and Hong Kong Chinese.
+* https://github.com/alphagov/rails_translation_manager/pull/49
+* https://github.com/alphagov/rails_translation_manager/pull/50
+
 # 1.5.2
 
 Add missing plurals for Gujarati and Yiddish https://github.com/alphagov/rails_translation_manager/pull/44

data/config/locales/plurals.rb

@@ -1,10 +1,27 @@
 # frozen_string_literal: true
 
 {
+  # Azerbaijani
+  az: { i18n: { plural: { keys: %i[one other], rule: ->(n) { n == 1 ? :one : :other } } } },
+  # Welsh
+  cy: { i18n: { plural: { keys: %i[zero one two few many other],
+                          rule:
+                            lambda do |n|
+                              case n
+                              when 0 then :zero
+                              when 1 then :one
+                              when 2 then :two
+                              when 3 then :few
+                              when 6 then :many
+                              else :other
+                              end
+                            end } } },
   # Dari - this isn't an iso code. Probably should be 'prs' as per ISO 639-3.
   dr: { i18n: { plural: { keys: %i[one other], rule: ->(n) { n == 1 ? :one : :other } } } },
   # Latin America and Caribbean Spanish
   "es-419": { i18n: { plural: { keys: %i[one other], rule: ->(n) { n == 1 ? :one : :other } } } },
+  # Persian
+  fa: { i18n: { plural: { keys: %i[one other], rule: ->(n) { [0, 1].include?(n) ? :one : :other } } } },
   # Gujarati
   gu: { i18n: { plural: { keys: %i[one other], rule: ->(n) { [0, 1].include?(n) ? :one : :other } } } },
   # Scottish Gaelic
@@ -24,10 +41,27 @@
   hy: { i18n: { plural: { keys: %i[one other], rule: ->(n) { [0, 1].include?(n) ? :one : :other } } } },
   # Kazakh
   kk: { i18n: { plural: { keys: %i[one other], rule: ->(n) { n == 1 ? :one : :other } } } },
-  # Pashto
-  ps: { i18n: { plural: { keys: %i[one other], rule: ->(n) { n == 1 ? :one : :other } } } },
+  # Maltese
+  mt: { i18n: { plural: { keys: %i[one few many other],
+                          rule:
+                            lambda do |n|
+                              n ||= 0
+                              mod100 = n % 100
+
+                              if n == 1
+                                :one
+                              elsif n.zero? || (2..10).to_a.include?(mod100)
+                                :few
+                              elsif (11..19).to_a.include?(mod100)
+                                :many
+                              else
+                                :other
+                              end
+                            end } } },
   # Punjabi Shahmukhi
   "pa-pk": { i18n: { plural: { keys: %i[one other], rule: ->(n) { [0, 1].include?(n) ? :one : :other } } } },
+  # Pashto
+  ps: { i18n: { plural: { keys: %i[one other], rule: ->(n) { n == 1 ? :one : :other } } } },
   # Sinhalese
   si: { i18n: { plural: { keys: %i[one other], rule: ->(n) { [0, 1].include?(n) ? :one : :other } } } },
   # Somali
@@ -43,9 +77,11 @@
   # Uzbek
   uz: { i18n: { plural: { keys: %i[one other], rule: ->(n) { n == 1 ? :one : :other } } } },
   # Yiddish
-  yi: { i18n: { plural: { keys: %i[one other], rule: ->(n) { [0, 1].include?(n) ? :one : :other } } } },
+  yi: { i18n: { plural: { keys: %i[one other], rule: ->(n) { n == 1 ? :one : :other } } } },
+  # Chinese
+  zh: { i18n: { plural: { keys: %i[other], rule: -> { :other } } } },
   # Chinese Hong Kong
-  'zh-hk' => { i18n: { plural: { keys: %i[other], rule: -> { :other } } } },
+  "zh-hk": { i18n: { plural: { keys: %i[other], rule: -> { :other } } } },
   # Chinese Taiwan
-  'zh-tw' => { i18n: { plural: { keys: %i[other], rule: -> { :other } } } }
+  "zh-tw": { i18n: { plural: { keys: %i[other], rule: -> { :other } } } }
 }

data/lib/rails_translation_manager/locale_checker/missing_english_locales.rb

@@ -13,19 +13,23 @@ class MissingEnglishLocales < BaseChecker
 
   def format_missing_english_locales(keys)
     formatted_keys = keys.to_a.map do |group|
-      "\e[1mMissing English keys:\e[22m #{group[0]}\n\e[1mFound in:\e[22m #{group[1]}"
+      "\e[1mMissing English locales:\e[22m #{group[0]}\n\e[1mFound in:\e[22m #{group[1]}"
     end
 
-    "\e[31m[ERROR]\e[0m Missing English locales, either remove these keys from the foreign locales or add them to the English locales\n\n#{formatted_keys.join("\n\n")}"
+    "\e[31m[ERROR]\e[0m Missing English locales, either remove them from the foreign locale files or add them to the English locale files\n\n#{formatted_keys.join("\n\n")}"
   end
 
   def missing_english_locales
-    all_locales.each_with_object({}) do |locale, hsh|
-      missing_keys = exclude_plurals(locale[:keys]) - english_keys_excluding_plurals(all_locales)
+    all_locales.each_with_object({}) do |group, hsh|
+      next if group[:locale] == :en
+
+      keys = exclude_plurals(group[:keys])
+
+      missing_keys = keys.reject { |key| I18n.exists?(key) }
 
       next if missing_keys.blank?
 
-      hsh[locale[:locale]] = missing_keys
+      hsh[group[:locale]] = missing_keys
     end
   end
 end

data/lib/rails_translation_manager/locale_checker/plural_forms.rb

@@ -4,7 +4,7 @@ class PluralForms
   def self.all
     I18n.available_locales.each_with_object({}) do |locale, hsh|
       begin
-        # fetches plural form (rule) from rails-i18n for locale
+        # fetches plural form (rule) from rails-i18n or config/locales/plurals.rb for locale
         plural_form = I18n.with_locale(locale) { I18n.t!("i18n.plural.keys") }.sort
       rescue I18n::MissingTranslationData
         plural_form = nil

data/lib/rails_translation_manager/version.rb

@@ -1,3 +1,3 @@
 module RailsTranslationManager
-  VERSION = "1.5.2"
+  VERSION = "1.6.1"
 end

data/lib/rails_translation_manager.rb

@@ -20,13 +20,13 @@ require "rails_translation_manager/exporter"
 require "rails_translation_manager/importer"
 
 module RailsTranslationManager
-  rails_i18n_path = Gem::Specification.find_by_name("rails-i18n").gem_dir
   rails_translation_manager = Gem::Specification.find_by_name("rails_translation_manager").gem_dir
+  I18n.load_path += ["#{rails_translation_manager}/config/locales/plurals.rb"]
 
-  I18n.load_path.concat(
-    Dir["#{rails_i18n_path}/rails/pluralization/*.rb"],
-    ["#{rails_translation_manager}/config/locales/plurals.rb"]
-  )
+  if ENV["RAILS_TRANSLATION_MANAGER_LOAD_ALL_PLURAL_RULES"]
+    rails_i18n_path = Gem::Specification.find_by_name("rails-i18n").gem_dir
+    I18n.load_path += Dir["#{rails_i18n_path}/rails/pluralization/*.rb"]
+  end
 
   def self.locale_root
     if ENV["RAILS_TRANSLATION_MANAGER_LOCALE_ROOT"]

data/rails_translation_manager.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "climate_control"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "byebug"

data/spec/locales/in_sync/en/browse.yml

@@ -1,5 +1,5 @@
 ---
-cy:
+en:
   in_sync:
     key: food
     second_key: cat

data/spec/rails_translation_manager/importer_spec.rb

@@ -32,73 +32,81 @@ RSpec.describe RailsTranslationManager::Importer do
   context "when there is one locale file per language" do
     let(:yaml_translation_data) { YAML.load_file(import_directory + "/fr.yml")["fr"] }
 
-    before do
-      importer = described_class.new(
+    let(:importer) do
+      described_class.new(
         locale: "fr",
         csv_path: "spec/locales/importer/fr.csv",
         import_directory: import_directory,
         multiple_files_per_language: false
       )
-      importer.import
     end
 
     it "creates one YAML file per language" do
+      expect { importer.import }.to output.to_stdout
       expect(File).to exist(import_directory + "/fr.yml")
     end
 
     it "imports nested locales" do
+      expect { importer.import }.to output.to_stdout
       expected = { "type" => { "country" => "Pays" } }
       expect(yaml_translation_data).to include("world_location" => hash_including(expected))
     end
 
     it "imports arrays from CSV as arrays" do
+      expect { importer.import }.to output.to_stdout
       expected =  { "fruit" => ["Pommes", "Bananes", "Poires"] }
       expect(yaml_translation_data).to include("world_location" => hash_including(expected))
     end
 
     it "imports string 'nil' as nil" do
+      expect { importer.import }.to output.to_stdout
       expected = { "things" => nil }
       expect(yaml_translation_data).to include("world_location" => hash_including(expected))
     end
 
     it "imports string ':thing' as symbol" do
+      expect { importer.import }.to output.to_stdout
       expected = { "sentiment" => :bof }
       expect(yaml_translation_data).to include("world_location" => hash_including(expected))
     end
 
     it "imports integer strings as integers" do
+      expect { importer.import }.to output.to_stdout
       expected = { "price" => 123 }
       expect(yaml_translation_data).to include("shared" => hash_including(expected))
     end
 
     it "imports boolean values as booleans, not strings" do
+      expect { importer.import }.to output.to_stdout
       expected = { "key1" => true, "key2" => false }
       expect(yaml_translation_data).to include("shared" => hash_including(expected))
     end
   end
 
   context "when there are multiple files per locale" do
-    before do
-      importer = described_class.new(
+    let(:importer) do
+      described_class.new(
         locale: "fr",
         csv_path: "spec/locales/importer/fr.csv",
         import_directory: import_directory,
         multiple_files_per_language: true
       )
-      importer.import
     end
 
     it "creates multiple YAML files per language in the language's directory" do
+      expect { importer.import }.to output.to_stdout
       expect(File).to exist(import_directory + "/fr/world_location.yml")
                   .and exist(import_directory + "/fr/shared.yml")
     end
 
     it "imports only 'world_location' locales to the relevant file" do
+      expect { importer.import }.to output.to_stdout
       yaml_translation_data = YAML.load_file(import_directory + "/fr/world_location.yml")["fr"]
       expect(yaml_translation_data).to match("world_location" => anything)
     end
 
     it "imports only 'shared' locales to the relevant file" do
+      expect { importer.import }.to output.to_stdout
       yaml_translation_data = YAML.load_file(import_directory + "/fr/shared.yml")["fr"]
       expect(yaml_translation_data).to match("shared" => anything)
     end

data/spec/rails_translation_manager/locale_checker/missing_english_locales_spec.rb

@@ -4,6 +4,12 @@ require "spec_helper"
 
 RSpec.describe MissingEnglishLocales do
   context "where there are missing English locales" do
+    before do
+      I18n.backend.store_translations :en, { browse: { same_key: "value" } }
+      I18n.backend.store_translations :cy, { browse: { same_key: "value" } }
+      I18n.backend.store_translations :cy, { browse: { extra_key: "extra_key" } }
+    end
+
     let(:all_locales) do
       [
         {
@@ -21,9 +27,9 @@ RSpec.describe MissingEnglishLocales do
       expect(described_class.new(all_locales).report)
         .to eq(
           <<~OUTPUT.chomp
-            \e[31m[ERROR]\e[0m Missing English locales, either remove these keys from the foreign locales or add them to the English locales
+            \e[31m[ERROR]\e[0m Missing English locales, either remove them from the foreign locale files or add them to the English locale files
 
-            \e[1mMissing English keys:\e[22m ["browse.extra_key"]
+            \e[1mMissing English locales:\e[22m ["browse.extra_key"]
             \e[1mFound in:\e[22m [:cy]
           OUTPUT
         )
@@ -31,6 +37,11 @@ RSpec.describe MissingEnglishLocales do
   end
 
   context "where there aren't missing English locales" do
+    before do
+      I18n.backend.store_translations :en, { browse: { same_key: "value" } }
+      I18n.backend.store_translations :cy, { browse: { same_key: "value" } }
+    end
+
     let(:all_locales) do
       [
         {

data/spec/rails_translation_manager/locale_checker/plural_forms_spec.rb

@@ -21,6 +21,9 @@ RSpec.describe PluralForms do
     end
 
     it "returns nil for associated locales" do
+      # clears any in-memory translations
+      I18n.backend.reload!
+
       expect(described_class.all).to include({ cy: nil, en: nil })
     end
   end

data/spec/rails_translation_manager/locale_checker_spec.rb

@@ -4,12 +4,19 @@ require "spec_helper"
 
 RSpec.describe RailsTranslationManager::LocaleChecker do
   context "when the locales are valid" do
+    before do
+      I18n.backend.load_translations(
+        ["spec/locales/in_sync/cy/browse.yml", "spec/locales/in_sync/en/browse.yml"]
+      )
+    end
+
     it "calls each checker class" do
       described_class::CHECKER_CLASSES.each do |checker|
         expect_any_instance_of(checker).to receive(:report)
       end
 
-      described_class.new("spec/locales/in_sync/**/*.yml").validate_locales
+      expect { described_class.new("spec/locales/in_sync/**/*.yml").validate_locales }
+        .to output.to_stdout
     end
 
     it "outputs a confirmation" do
@@ -18,51 +25,51 @@ RSpec.describe RailsTranslationManager::LocaleChecker do
     end
 
     it "returns true" do
-      expect(described_class.new("spec/locales/in_sync/**/*.yml").validate_locales)
-        .to eq(true)
+      outcome = nil
+      expect { outcome = described_class.new("spec/locales/in_sync/**/*.yml").validate_locales }.to output.to_stdout
+      expect(outcome).to be(true)
     end
   end
 
   context "when the locales are not valid" do
+    before do
+      I18n.backend.load_translations(
+        ["spec/locales/out_of_sync/cy.yml", "spec/locales/out_of_sync/en.yml"]
+      )
+    end
+
     it "calls each checker class" do
       described_class::CHECKER_CLASSES.each do |checker|
         expect_any_instance_of(checker).to receive(:report)
       end
 
-      described_class.new("spec/locales/out_of_sync/*.yml").validate_locales
+      expect { described_class.new("spec/locales/out_of_sync/*.yml").validate_locales }
+        .to output.to_stdout
     end
 
     it "outputs the report" do
-      printed = capture_stdout do
-        described_class.new("spec/locales/out_of_sync/*.yml").validate_locales
-      end
-
-      expect(printed.scan(/\[ERROR\]/).count).to eq(3)
+      # expect output to contain 3 errors ([ERROR])
+      expect { described_class.new("spec/locales/out_of_sync/*.yml").validate_locales }
+        .to output(/(?:\[ERROR\](?:.|\n)*){3}/).to_stdout
     end
 
     it "returns false" do
-      expect(described_class.new("spec/locales/out_of_sync/*.yml").validate_locales)
-        .to eq(false)
+      outcome = nil
+      expect { outcome = described_class.new("spec/locales/out_of_sync/*.yml").validate_locales }.to output.to_stdout
+      expect(outcome).to be(false)
     end
   end
 
   context "when the locale path doesn't relate to any YAML files" do
-    it "doesn't call any checker classes" do
-      described_class::CHECKER_CLASSES.each do |checker|
-        expect_any_instance_of(checker).to_not receive(:report)
-      end
-
-      described_class.new("some/random/path").validate_locales
-    end
-
     it "outputs an error message" do
       expect { described_class.new("some/random/path").validate_locales }
         .to output("No locale files found for the supplied path\n").to_stdout
     end
 
     it "returns false" do
-      expect(described_class.new("some/random/path").validate_locales)
-        .to eq(false)
+      outcome = nil
+      expect { outcome = described_class.new("some/random/path").validate_locales }.to output.to_stdout
+      expect(outcome).to be(false)
     end
   end
 end

data/spec/spec_helper.rb

@@ -6,15 +6,23 @@ require "climate_control"
 RSpec.configure do |config|
   config.before do
     I18n.available_locales = %i[en cy]
-    config.before { allow($stdout).to receive(:puts) }
-  end
+    I18n.backend.store_translations :en, i18n: { plural: { keys: %i[one other],
+                                                           rule:
+                                                             lambda do |n|
+                                                               n == 1 ? :one : :other
+                                                             end } }
+    I18n.backend.store_translations :cy, i18n: { plural: { keys: %i[zero one two few many other],
+                                                           rule:
+                                                             lambda do |n|
+                                                               case n
+                                                               when 0 then :zero
+                                                               when 1 then :one
+                                                               when 2 then :two
+                                                               when 3 then :few
+                                                               when 6 then :many
+                                                               else :other
+                                                               end
+                                                             end } }
 
-  def capture_stdout(&blk)
-    old = $stdout
-    $stdout = fake = StringIO.new
-    blk.call
-    fake.string
-  ensure
-    $stdout = old
   end
 end

data/spec/tasks/translation_spec.rb

@@ -20,7 +20,7 @@ describe "rake tasks" do
     end
 
     it "calls the Importer class with the csv and import paths" do
-      task.execute(csv_path: csv_path)
+      expect { task.execute(csv_path: csv_path) }.to output.to_stdout
 
       expect(RailsTranslationManager::Importer)
         .to have_received(:new)
@@ -44,7 +44,10 @@ describe "rake tasks" do
     end
 
     it "calls the importer class for each target path" do
-      task.execute(csv_directory: csv_directory, multiple_files_per_language: true)
+      expect { task.execute(csv_directory: csv_directory, multiple_files_per_language: true) }
+        .to output
+        .to_stdout
+
       import_paths = Dir["spec/locales/importer/*.csv"]
 
       import_paths.each do |csv_path|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_translation_manager
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.6.1
 platform: ruby
 authors:
 - Edd Sowden
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-07 00:00:00.000000000 Z
+date: 2022-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -157,11 +157,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".ruby-version"
 - CHANGELOG.md
 - Gemfile
-- Jenkinsfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -235,7 +236,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Tasks to manage translation files

data/Jenkinsfile

@@ -1,9 +0,0 @@
-#!/usr/bin/env groovy
-
-library("govuk")
-
-node {
-  govuk.buildProject(
-    cleanWorkspace: true,
-  )
-}