rails_translation_manager 1.1.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e7ef3e878a1b5ffc7ae48ad8f683887e79073b3f34a5a3439656f5f7abb6e20
-  data.tar.gz: 2aac75f9cae7275812da73da0973de515baf0d78eb63e64182e683f8717696ca
+  metadata.gz: 328572b2e2f76e544577abf6e4294fbc18b39324be6804a41107d7961e3545dd
+  data.tar.gz: cff1f18b58513f7fc12b8b2473aabf1f24fa5841999935ce4288d1a3bb7bd0ec
 SHA512:
-  metadata.gz: f0b2fa6abaadb21ea912976b1092c6459ea0194a8e19092c522e38224da218395d230936d0d4a0aa830e3d37bd9f6eb6ac1e4909bd5406369c0aa99d1a4d13f4
-  data.tar.gz: 0dbbefe8208052b63f5ddc80734340ed7985b199f9113aaf5457c48d50e34e889e7379a20c61963b002343f4fb0d35aacc0307b442a15a2b7fbdea77c25349dd
+  metadata.gz: 2f3f6c481946426f3be7f562dc63487c5b29d16000b309980f581bf08f8089aa17a909389c0caf72be0a719f787ce4453d3cd91f31987a110b953ea4b7aa8c5f
+  data.tar.gz: 4cedacbcb032ca11e17b64bd2c699c7caf802062b768c129d43ef52b0f11e064b7f8990596007f58a020ea053fb5ecb374f99d7980b215f669d3e5673c1e6af5

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## 1.4.0
+
+Add `skip_validation` parameter to `LocaleChecker`. https://github.com/alphagov/rails_translation_manager/pull/35
+
+## 1.3.0
+
+Add remove-unused task wrapper. https://github.com/alphagov/rails_translation_manager/pull/32
+
+## 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
+
 ## 1.1.2
 
 Handle importing files that contain Byte Order Marks. https://github.com/alphagov/rails_translation_manager/pull/27

data/lib/rails_translation_manager/importer.rb

@@ -15,7 +15,9 @@ class RailsTranslationManager::Importer
   end
 
   def import
-    csv = CSV.read(csv_path, encoding: "bom|utf-8", headers: true, header_converters: :downcase)
+    csv = reject_nil_keys(
+      CSV.read(csv_path, encoding: "bom|utf-8", headers: true, header_converters: :downcase)
+    )
 
     multiple_files_per_language ? import_csv_into_multiple_files(csv) : import_csv(csv)
   end
@@ -40,6 +42,14 @@ class RailsTranslationManager::Importer
     write_yaml(import_yml_path, { locale.to_s => data })
   end
 
+  def reject_nil_keys(csv)
+    csv.reject do |row|
+      nil_key = row["key"].nil?
+      puts "Invalid row: #{row.inspect} for csv_path: #{csv_path}\n" if nil_key == true
+      nil_key
+    end
+  end
+
   def parse_translation(translation)
     if translation =~ /^\[/
       values = translation.gsub(/^\[/, '').gsub(/\]$/, '').gsub("\"", '').split(/\s*,\s*/)

data/lib/rails_translation_manager/locale_checker/all_locales.rb

@@ -3,8 +3,9 @@
 class AllLocales
   attr_reader :locale_path
 
-  def initialize(locale_path)
+  def initialize(locale_path, skip_validation = [])
     @locale_path = locale_path
+    @skip_validation = skip_validation
   end
 
   def generate
@@ -15,12 +16,12 @@ class AllLocales
     paths.flat_map do |locale_group|
       {
         locale: locale_group[:locale],
-        keys: all_keys_for_locale(locale_group)
+        keys: all_keys_for_locale(locale_group),
       }
     end
   end
 
-  private
+private
 
   def locale_file_paths
     I18n.available_locales.map do |locale|
@@ -43,6 +44,13 @@ class AllLocales
   def keys_from_file(locale_hash: nil, key_chain: nil, locale_keys: [], file_path: nil)
     locale_hash ||= YAML.load_file(file_path)
     keys = locale_hash.keys
+
+    keys.reject! do |key|
+      key_chain && @skip_validation.map { |prefix|
+        "#{key_chain}.#{key}".start_with? ".#{key_chain.split('.')[1]}.#{prefix}"
+      }.any?
+    end
+
     keys.each do |key|
       if locale_hash.fetch(key).is_a?(Hash)
         keys_from_file(locale_hash: locale_hash.fetch(key), key_chain: "#{key_chain}.#{key}", locale_keys: locale_keys)

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,12 +4,15 @@ 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)
+    def initialize(locale_path, skip_validation = [])
       @locale_path = locale_path
+      @skip_validation = skip_validation
     end
 
     def validate_locales
@@ -19,7 +22,7 @@ module RailsTranslationManager
       false
     end
 
-    private
+  private
 
     def output_result
       errors = checker_errors.compact
@@ -44,7 +47,7 @@ module RailsTranslationManager
     end
 
     def all_locales
-      @all_locales ||= AllLocales.new(locale_path).generate
+      @all_locales ||= AllLocales.new(locale_path, @skip_validation).generate
     end
   end
 end

data/lib/rails_translation_manager/version.rb

@@ -1,3 +1,3 @@
 module RailsTranslationManager
-  VERSION = "1.1.2"
+  VERSION = "1.4.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/lib/tasks/translation.rake

@@ -42,7 +42,7 @@ namespace :translation do
     )
     importer.import
 
-    puts "Imported CSV from: #{csv_path} to #{import_dir}"
+    puts "\nImported CSV from: #{csv_path} to #{import_dir}"
   end
 
   namespace :import do
@@ -61,7 +61,7 @@ namespace :translation do
         importer.import
       end
 
-      puts "Imported all CSVs from: #{directory} to #{import_dir}"
+      puts "\nImported all CSVs from: #{directory} to #{import_dir}"
     end
   end
 
@@ -84,4 +84,14 @@ namespace :translation do
     I18n::Tasks::CLI.start(option_parser)
     RailsTranslationManager::Cleaner.new(Rails.root.join("config", "locales")).clean
   end
+
+  desc "Remove unused keys"
+  task(:remove_unused, [:locale] => [:environment]) do |t, args|
+    option_parser = RailsTranslationManager::I18nTasksOptionParser.new(
+      ["remove-unused"], args[:locale]
+    ).with_optional_locale
+
+    I18n::Tasks::CLI.start(option_parser)
+    RailsTranslationManager::Cleaner.new(Rails.root.join("config", "locales")).clean
+  end
 end

data/spec/locales/importer/fr.csv

@@ -6,3 +6,4 @@ world_location.sentiment,:whatever,:bof
 shared.price,123,123
 shared.key1,is true,true
 shared.key2,is false,false
+,,

data/spec/rails_translation_manager/importer_spec.rb

@@ -16,6 +16,19 @@ RSpec.describe RailsTranslationManager::Importer do
     expect(File).to exist(import_directory + "/hy.yml")
   end
 
+  it "doesn't try to import a row with a blank key" do
+    importer = described_class.new(
+      locale: "hy",
+      csv_path: "spec/locales/importer/fr.csv",
+      import_directory: import_directory,
+      multiple_files_per_language: false
+    )
+
+    expect { importer.import }.to output(
+      "Invalid row: #<CSV::Row \"key\":nil \"source\":nil \"translation\":nil> for csv_path: spec/locales/importer/fr.csv\n"
+    ).to_stdout
+  end
+
   context "when there is one locale file per language" do
     let(:yaml_translation_data) { YAML.load_file(import_directory + "/fr.yml")["fr"] }
 

data/spec/rails_translation_manager/locale_checker/all_locales_spec.rb

@@ -21,4 +21,28 @@ RSpec.describe AllLocales do
         .to raise_error(AllLocales::NoLocaleFilesFound, 'No locale files found for the supplied path')
     end
   end
+  
+  context "when some keys are excluded" do
+    it "generates an array of hashes without those keys" do
+      expect(described_class.new("spec/locales/out_of_sync/*.yml", skip_validation = %w{wrong_plural.one}).generate)
+        .to eq(
+          [
+            { keys: %w[test wrong_plural wrong_plural.zero], locale: :en },
+            { keys: %w[other_test], locale: :cy }
+          ]
+      )
+    end
+  end
+
+  context "when a key prefix is excluded" do
+    it "generates an array of hashes without those keys" do
+      expect(described_class.new("spec/locales/out_of_sync/*.yml", skip_validation = %w{wrong_plural}).generate)
+        .to eq(
+          [
+            { keys: %w[test], locale: :en },
+            { keys: %w[other_test], locale: :cy }
+          ]
+      )
+    end
+  end
 end

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

data/spec/tasks/translation_spec.rb

@@ -15,7 +15,7 @@ describe "rake tasks" do
 
     it "outputs to stdout" do
       expect { task.execute(csv_path: csv_path) }
-        .to output("Imported CSV from: #{csv_path} to #{Rails.root.join("config", "locales")}\n")
+        .to output("\nImported CSV from: #{csv_path} to #{Rails.root.join("config", "locales")}\n")
         .to_stdout
     end
 
@@ -39,7 +39,7 @@ describe "rake tasks" do
 
     it "outputs to stdout" do
       expect { task.execute(csv_directory: csv_directory) }
-        .to output("Imported all CSVs from: #{csv_directory} to #{Rails.root.join("config", "locales")}\n")
+        .to output("\nImported all CSVs from: #{csv_directory} to #{Rails.root.join("config", "locales")}\n")
         .to_stdout
     end
 
@@ -106,6 +106,28 @@ describe "rake tasks" do
     end
   end
 
+  describe "translation:remove_unused", type: :task do
+    let(:task) { Rake::Task["translation:remove_unused"] }
+    let!(:cleaner_instance) { stub_cleaner }
+
+    before do
+      allow(I18n::Tasks::CLI).to receive(:start)
+    end
+
+    it "triggers Cleaner and allows to receive the right arguments" do
+      task.execute(locale_directory: "config/locales")
+      expect(RailsTranslationManager::Cleaner)
+        .to have_received(:new)
+        .with(Rails.root.join("config", "locales"))
+      expect(cleaner_instance).to have_received(:clean)
+    end
+
+    it "triggers i18n task and allows to receive the right arguments" do
+      task.execute
+      expect(I18n::Tasks::CLI).to have_received(:start).with(["remove-unused"])
+    end
+  end
+
   def stub_importer
     importer_instance = instance_double(RailsTranslationManager::Importer)
     allow(RailsTranslationManager::Importer).to receive(:new)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_translation_manager
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.4.0
 platform: ruby
 authors:
 - Edd Sowden
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-05 00:00:00.000000000 Z
+date: 2022-01-26 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