rails_translation_manager 1.1.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbbde3519b97f6c9881189908af474ef24b5ad5dae1a3c6e3a590df8ca4b9885
-  data.tar.gz: f6ad0e6bf5584f6fa9db3b39d3a7d52c1b04786368c9297090a480690e2cf1e7
+  metadata.gz: 1698a9fc00bbc68d6a07e11ab9a61fa009cdf11ab0556c1634e6586ea7f8043f
+  data.tar.gz: b93eba9d7309f7e7184a548487592a684bc508afd87af84a6270a4abaa66f624
 SHA512:
-  metadata.gz: befae5c31f13ce323a367033180d58d7969220cde8eded8dd213a0de5405fd82246f0b775c3761d45e2412b25699630538896d6b2ec9692a4f030ea751f9282c
-  data.tar.gz: 25979414b9918d47b58e3f87caa2ba967dcca0bc233c37854f270b8e93f0f95940b3c0f54b7f658ea4ed144b463b740569bebe4c0dfd98907a8e82d02c10fd6f
+  metadata.gz: e8877d5f9a8b3baff02a1f62df4b5b8645297774cbb6fc583ff04b3c23c41298d093f8455253f803f7d21fbdbdf4a832b93d5b0582dda96df0a67eff49041be5
+  data.tar.gz: bd9f568b8f7c330c005b9c897179d3a37d0f4a88dd718af7135544fd47cd7719329139799c4d050f2a85de20a134b62bb85ad771017002f408faac92a3097e34

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.2.0
+
+Add two new checker classes. https://github.com/alphagov/rails_translation_manager/pull/30
+
 ## 1.1.3
 
 Handle importing files that contain rows with a blank "key". https://github.com/alphagov/rails_translation_manager/pull/28

data/lib/rails_translation_manager/locale_checker/missing_declared_locales.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+class MissingDeclaredLocales < BaseChecker
+  include LocaleCheckerHelper
+
+  def report
+    diff = compare
+    format_error_message(diff) unless diff.empty?
+  end
+
+  private
+
+  def format_error_message(locales)
+    <<~OUTPUT.chomp
+    \e[31m[ERROR]\e[0m No locale files detected for:
+
+    #{locales.join("\n\n")}
+
+    \e[1mEither create these locale files or remove these locales from your I18n `available_locales` config.\e[22m
+    OUTPUT
+  end
+
+  def actual_locales
+    all_locales.map { |l| l[:locale] }
+  end
+
+  def compare
+    I18n.available_locales - actual_locales
+  end
+end

data/lib/rails_translation_manager/locale_checker/undeclared_locale_files.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+class UndeclaredLocaleFiles < BaseChecker
+  include LocaleCheckerHelper
+
+  def report
+    diff = compare
+    format_error_message(diff) unless diff.empty?
+  end
+
+  private
+
+  def format_error_message(locales)
+    <<~OUTPUT.chomp
+    \e[31m[ERROR]\e[0m Undeclared locale file(s) detected for:
+
+    #{locales.join("\n\n")}
+
+    \e[1mEither declare these locale files or remove them from your locale files directory.\e[22m
+    OUTPUT
+  end
+
+  def actual_locales
+    all_locales.map { |l| l[:locale] }
+  end
+
+  def compare
+    actual_locales - I18n.available_locales
+  end
+end

data/lib/rails_translation_manager/locale_checker.rb

@@ -4,9 +4,11 @@ module RailsTranslationManager
   class LocaleChecker
     attr_reader :locale_path
 
-    CHECKER_CLASSES = [MissingEnglishLocales,
+    CHECKER_CLASSES = [IncompatiblePlurals,
+                       MissingDeclaredLocales,
+                       MissingEnglishLocales,
                        MissingForeignLocales,
-                       IncompatiblePlurals].freeze
+                       UndeclaredLocaleFiles].freeze
 
     def initialize(locale_path)
       @locale_path = locale_path

data/lib/rails_translation_manager/version.rb

@@ -1,3 +1,3 @@
 module RailsTranslationManager
-  VERSION = "1.1.3"
+  VERSION = "1.2.0"
 end

data/lib/rails_translation_manager.rb

@@ -6,10 +6,12 @@ require "rails-i18n"
 
 require "rails_translation_manager/locale_checker/base_checker"
 require "rails_translation_manager/locale_checker/locale_checker_helper"
+require "rails_translation_manager/locale_checker/missing_declared_locales"
 require "rails_translation_manager/locale_checker/missing_foreign_locales"
 require "rails_translation_manager/locale_checker/missing_english_locales"
 require "rails_translation_manager/locale_checker/plural_forms"
 require "rails_translation_manager/locale_checker/incompatible_plurals"
+require "rails_translation_manager/locale_checker/undeclared_locale_files"
 require "rails_translation_manager/locale_checker/all_locales"
 require "rails_translation_manager/locale_checker"
 require "rails_translation_manager/cleaner"

data/spec/rails_translation_manager/locale_checker/missing_declared_locales_spec.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe MissingDeclaredLocales do
+  let(:all_locales) do
+    [
+      {
+        locale: :en,
+        keys: %w[browse.same_key]
+      },
+      {
+        locale: :cy,
+        keys: %w[browse.same_key]
+      }
+    ]
+  end
+
+  context "when there are missing locales" do
+    before do
+      I18n.available_locales = [:en, :cy, :pt]
+    end
+
+    it "outputs the missing locales" do
+      expect(described_class.new(all_locales).report)
+        .to eq(
+          <<~OUTPUT.chomp
+          \e[31m[ERROR]\e[0m No locale files detected for:
+
+          pt
+
+          \e[1mEither create these locale files or remove these locales from your I18n `available_locales` config.\e[22m
+          OUTPUT
+        )
+    end
+  end
+
+  context "when there aren't missing locales" do
+    before do
+      I18n.available_locales = [:en, :cy]
+    end
+
+    it "outputs nil" do
+      expect(described_class.new(all_locales).report)
+        .to be_nil
+    end
+  end
+end

data/spec/rails_translation_manager/locale_checker/missing_english_locales_spec.rb

@@ -44,7 +44,7 @@ RSpec.describe MissingEnglishLocales do
       ]
     end
 
-    it 'outputs nil' do
+    it "outputs nil" do
       expect(described_class.new(all_locales).report)
         .to be_nil
     end

data/spec/rails_translation_manager/locale_checker/undeclared_locale_files_spec.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe UndeclaredLocaleFiles do
+  let(:all_locales) do
+    [
+      {
+        locale: :en,
+        keys: %w[browse.same_key]
+      },
+      {
+        locale: :cy,
+        keys: %w[browse.same_key]
+      }
+    ]
+  end
+
+  context "when there are undeclared locales" do
+    before do
+      I18n.available_locales = [:en]
+    end
+
+    it "outputs the missing locales" do
+      expect(described_class.new(all_locales).report)
+        .to eq(
+          <<~OUTPUT.chomp
+          \e[31m[ERROR]\e[0m Undeclared locale file(s) detected for:
+
+          cy
+
+          \e[1mEither declare these locale files or remove them from your locale files directory.\e[22m
+          OUTPUT
+        )
+    end
+  end
+
+  context "when there aren't undeclared locales" do
+    before do
+      I18n.available_locales = [:en, :cy]
+    end
+
+    it "outputs nil" do
+      expect(described_class.new(all_locales).report)
+        .to be_nil
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_translation_manager
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.0
 platform: ruby
 authors:
 - Edd Sowden
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-10 00:00:00.000000000 Z
+date: 2021-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -164,9 +164,11 @@ files:
 - lib/rails_translation_manager/locale_checker/base_checker.rb
 - lib/rails_translation_manager/locale_checker/incompatible_plurals.rb
 - lib/rails_translation_manager/locale_checker/locale_checker_helper.rb
+- lib/rails_translation_manager/locale_checker/missing_declared_locales.rb
 - lib/rails_translation_manager/locale_checker/missing_english_locales.rb
 - lib/rails_translation_manager/locale_checker/missing_foreign_locales.rb
 - lib/rails_translation_manager/locale_checker/plural_forms.rb
+- lib/rails_translation_manager/locale_checker/undeclared_locale_files.rb
 - lib/rails_translation_manager/railtie.rb
 - lib/rails_translation_manager/version.rb
 - lib/rails_translation_manager/yaml_writer.rb
@@ -185,9 +187,11 @@ files:
 - spec/rails_translation_manager/locale_checker/all_locales_spec.rb
 - spec/rails_translation_manager/locale_checker/incompatible_plurals_spec.rb
 - spec/rails_translation_manager/locale_checker/locale_checker_helper_spec.rb
+- spec/rails_translation_manager/locale_checker/missing_declared_locales_spec.rb
 - spec/rails_translation_manager/locale_checker/missing_english_locales_spec.rb
 - spec/rails_translation_manager/locale_checker/missing_foreign_locales_spec.rb
 - spec/rails_translation_manager/locale_checker/plural_forms_spec.rb
+- spec/rails_translation_manager/locale_checker/undeclared_locale_files_spec.rb
 - spec/rails_translation_manager/locale_checker_spec.rb
 - spec/spec_helper.rb
 - spec/support/tasks.rb
@@ -233,9 +237,11 @@ test_files:
 - spec/rails_translation_manager/locale_checker/all_locales_spec.rb
 - spec/rails_translation_manager/locale_checker/incompatible_plurals_spec.rb
 - spec/rails_translation_manager/locale_checker/locale_checker_helper_spec.rb
+- spec/rails_translation_manager/locale_checker/missing_declared_locales_spec.rb
 - spec/rails_translation_manager/locale_checker/missing_english_locales_spec.rb
 - spec/rails_translation_manager/locale_checker/missing_foreign_locales_spec.rb
 - spec/rails_translation_manager/locale_checker/plural_forms_spec.rb
+- spec/rails_translation_manager/locale_checker/undeclared_locale_files_spec.rb
 - spec/rails_translation_manager/locale_checker_spec.rb
 - spec/spec_helper.rb
 - spec/support/tasks.rb