rails_translation_manager 1.1.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 234b68e06027a3335015a5818993014afea669efe42729d87f4de40efd4dc487
-  data.tar.gz: 54a16b4f583813415a6801c62fda5eb9ee603e84bf65206700c0bc33b295b238
+  metadata.gz: 7345dfdb610385c480d9434eda36b6be02c37617046eb0029393fe250a37fe4f
+  data.tar.gz: c7d42c8eeb4268b289f96377f5dcee785c97c8c67b1895c53cb7a9b4d984f99d
 SHA512:
-  metadata.gz: 2ab59ec749b2827c011728fe5711c850099d379d9089c2d73fc112def0f02c994b58ed646f42fe106c2d15d56cd5aaad1db636d7afe1504740109b57baca3c2f
-  data.tar.gz: 9313168a8704e4985ae4a57d89fb6bc8dc47a5ac2f1ae6cdd73686aeec0fe657617776620db6a65c0c45b708ec2de06dc390d546509198a836b6ff7a14212ca3
+  metadata.gz: 27a9d0906d1fff39bec4c877368c7118a9e95d209251433f2fa3890c270aeb9d58a2479153c768069aaf2834fd28b74b916f4a0ed36d58ec844a53c2a3cedf2f
+  data.tar.gz: d2ce1ff2d3e9253b2109d4ee6db895ff80476f39b881dc8a9775766936d4b2092429e036d5fe0ed1d9c995a02b2204f06ac6d5fcdfcd064a82fc08b8c3b43a8d

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## 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
+
 ## 1.1.1
 
 Fix Rails Translation Manager / Rails naming clash for class. https://github.com/alphagov/rails_translation_manager/pull/26

data/lib/rails_translation_manager/importer.rb

@@ -15,7 +15,9 @@ class RailsTranslationManager::Importer
   end
 
   def import
-    csv = CSV.read(csv_path, 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/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.1"
+  VERSION = "1.3.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/rails_translation_manager.gemspec

@@ -18,9 +18,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "rails-i18n"
   spec.add_dependency "activesupport"
+  spec.add_dependency "csv", "~> 3.2"
   spec.add_dependency "i18n-tasks"
+  spec.add_dependency "rails-i18n"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 10.0"

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/locales/importer/hy_with_byte_order_mark.csv

@@ -0,0 +1,4 @@
+key,source,translation
+unpublishing.title,The page you're looking for is no longer available,Ձեր փնտրած էջն այլևս հասանելի չէ
+working_group.contact_details,Contact details,Կոնտակտային տվյալներ
+working_group.policies,Policies,Քաղաքականություններ

data/spec/rails_translation_manager/importer_spec.rb

@@ -4,6 +4,31 @@ require "tmpdir"
 RSpec.describe RailsTranslationManager::Importer do
   let(:import_directory) { Dir.mktmpdir }
 
+  it "imports CSV containing a byte order mark" do
+    importer = described_class.new(
+      locale: "hy",
+      csv_path: "spec/locales/importer/hy_with_byte_order_mark.csv",
+      import_directory: import_directory,
+      multiple_files_per_language: false
+    )
+    importer.import
+
+    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/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,20 +39,24 @@ 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
 
     it "calls the importer class for each target path" do
       task.execute(csv_directory: csv_directory, multiple_files_per_language: true)
-
-      expect(RailsTranslationManager::Importer)
-        .to have_received(:new)
-        .with(locale: "fr",
-              csv_path: "spec/locales/importer/fr.csv",
-              import_directory: Rails.root.join("config", "locales"),
-              multiple_files_per_language: true)
-      expect(importer_instance).to have_received(:import)
+      import_paths = Dir["spec/locales/importer/*.csv"]
+
+      import_paths.each do |csv_path|
+        expect(RailsTranslationManager::Importer)
+          .to have_received(:new)
+          .with(locale: File.basename(csv_path, ".csv"),
+                csv_path: csv_path,
+                import_directory: Rails.root.join("config", "locales"),
+                multiple_files_per_language: true)
+      end
+
+      expect(importer_instance).to have_received(:import).exactly(import_paths.count)
     end
   end
 
@@ -102,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,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: rails_translation_manager
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Edd Sowden
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-04 00:00:00.000000000 Z
+date: 2021-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails-i18n
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: i18n-tasks
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: i18n-tasks
+  name: rails-i18n
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -150,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
@@ -161,6 +177,7 @@ files:
 - spec/locales/cleaner/clean.yml
 - spec/locales/cleaner/with_whitespace.yml
 - spec/locales/importer/fr.csv
+- spec/locales/importer/hy_with_byte_order_mark.csv
 - spec/locales/in_sync/cy/browse.yml
 - spec/locales/in_sync/en/browse.yml
 - spec/locales/out_of_sync/cy.yml
@@ -170,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
@@ -208,6 +227,7 @@ test_files:
 - spec/locales/cleaner/clean.yml
 - spec/locales/cleaner/with_whitespace.yml
 - spec/locales/importer/fr.csv
+- spec/locales/importer/hy_with_byte_order_mark.csv
 - spec/locales/in_sync/cy/browse.yml
 - spec/locales/in_sync/en/browse.yml
 - spec/locales/out_of_sync/cy.yml
@@ -217,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