rails_translation_manager 0.0.1 → 1.1.0

data/lib/rails_translation_manager.rb

@@ -1,8 +1,27 @@
+# frozen_string_literal: true
+
 require "rails_translation_manager/version"
 require "rails_translation_manager/railtie" if defined?(Rails)
 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_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/all_locales"
+require "rails_translation_manager/locale_checker"
+require "rails_translation_manager/cleaner"
+require "rails_translation_manager/exporter"
+require "rails_translation_manager/importer"
+
 module RailsTranslationManager
-  autoload :Exporter, "rails_translation_manager/exporter"
-  autoload :Importer, "rails_translation_manager/importer"
+  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.concat(
+    Dir["#{rails_i18n_path}/rails/pluralization/*.rb"],
+    ["#{rails_translation_manager}/config/locales/plurals.rb"]
+  )
 end

data/lib/tasks/translation.rake

@@ -1,16 +1,9 @@
-$LOAD_PATH.unshift(File.expand_path("../.."), __FILE__)
 require "rails_translation_manager"
+require "i18n/tasks/cli"
+require_relative "../tasks/translation_helper"
 
 namespace :translation do
 
-  desc "Regenerate all locales from the EN locale - run this after adding keys"
-  task(:regenerate, [:directory] => [:environment]) do |t, args|
-    directory = args[:directory] || "tmp/locale_csv"
-
-    Rake::Task["translation:export:all"].invoke(directory)
-    Rake::Task["translation:import:all"].invoke(directory)
-  end
-
   desc "Export a specific locale to CSV."
   task :export, [:directory, :base_locale, :target_locale] => [:environment] do |t, args|
     FileUtils.mkdir_p(args[:directory]) unless File.exist?(args[:directory])
@@ -37,34 +30,50 @@ namespace :translation do
   end
 
   desc "Import a specific locale CSV to YAML within the app."
-  task :import, [:locale, :path] => [:environment] do |t, args|
-    importer = RailsTranslationManager::Importer.new(args[:locale], args[:path], Rails.root.join("config", "locales"))
+  task :import, [:csv_path, :multiple_files_per_language] => [:environment] do |t, args|
+    import_dir = Rails.root.join("config", "locales")
+    csv_path = args[:csv_path]
+
+    importer = RailsTranslationManager::Importer.new(
+      locale: File.basename(args[:csv_path], ".csv"),
+      csv_path: csv_path,
+      import_directory: Rails.root.join("config", "locales"),
+      multiple_files_per_language: args[:multiple_files_per_language] || false
+    )
     importer.import
+
+    puts "Imported CSV from: #{csv_path} to #{import_dir}"
   end
 
   namespace :import do
     desc "Import all locale CSV files to YAML within the app."
-    task :all, [:directory] => [:environment] do |t, args|
-      directory = args[:directory] || "tmp/locale_csv"
-      Dir[File.join(directory, "*.csv")].each do |csv_path|
-        locale = File.basename(csv_path, ".csv")
-        importer = RailsTranslationManager::Importer.new(locale, csv_path, Rails.root.join("config", "locales"))
+    task :all, [:csv_directory, :multiple_files_per_language] => [:environment] do |t, args|
+      directory = args[:csv_directory] || "tmp/locale_csv"
+      import_dir = Rails.root.join("config", "locales")
+
+      Dir[Rails.root.join(directory, "*.csv")].each do |csv_path|
+        importer = RailsTranslationManager::Importer.new(
+          locale: File.basename(csv_path, ".csv"),
+          csv_path: csv_path,
+          import_directory: import_dir,
+          multiple_files_per_language: args[:multiple_files_per_language] || false
+        )
         importer.import
       end
+
+      puts "Imported all CSVs from: #{directory} to #{import_dir}"
     end
   end
 
-  desc "Check translation files for errors"
-  task :validate do
-    require 'rails_translation_manager/validator'
-    logger = Logger.new(STDOUT)
-    validator = RailsTranslationManager::Validator.new(Rails.root.join('config', 'locales'), logger)
-    errors = validator.check!
-    if errors.any?
-      puts "Found #{errors.size} errors:"
-      puts errors.map(&:to_s).join("\n")
-    else
-      puts "Success! No unexpected interpolation keys found."
-    end
+  desc "Add missing translations"
+  task(:add_missing, [:locale] => [:environment]) do |t, args|
+    I18n::Tasks::CLI.start(TranslationHelper.new(["add-missing", "--nil-value"], args[:locale]).with_optional_locale)
+    RailsTranslationManager::Cleaner.new(Rails.root.join("config", "locales")).clean
+  end
+
+  desc "Normalize translations"
+  task(:normalize, [:locale] => [:environment]) do |t, args|
+    I18n::Tasks::CLI.start(TranslationHelper.new(["normalize"], args[:locale]).with_optional_locale)
+    RailsTranslationManager::Cleaner.new(Rails.root.join("config", "locales")).clean
   end
 end

data/lib/tasks/translation_helper.rb

@@ -0,0 +1,11 @@
+class TranslationHelper
+
+  def initialize(task_options, locale)
+    @task_options = task_options
+    @locale = locale
+  end
+
+  def with_optional_locale
+    @locale ? @task_options << ["-l", @locale] : @task_options
+  end
+end

data/rails_translation_manager.gemspec

@@ -20,8 +20,11 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "rails-i18n"
   spec.add_dependency "activesupport"
+  spec.add_dependency "i18n-tasks"
 
-  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "byebug"
 end

data/spec/locales/cleaner/clean.yml

@@ -0,0 +1,5 @@
+---
+en:
+  test: key
+    key_1: foo
+    key_2: bar

data/spec/locales/cleaner/with_whitespace.yml

@@ -0,0 +1,5 @@
+---
+en:
+  test: key 
+    key_1: foo 
+    key_2: bar 

data/spec/locales/importer/fr.csv

@@ -0,0 +1,8 @@
+key,source,translation
+world_location.type.country,Country,Pays
+world_location.fruit,"[Apples, Bananas, Pears]","[Pommes, Bananes, Poires]"
+world_location.things,nil,nil
+world_location.sentiment,:whatever,:bof
+shared.price,123,123
+shared.key1,is true,true
+shared.key2,is false,false

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

@@ -0,0 +1,12 @@
+---
+cy:
+  in_sync:
+    key: bwyd
+    second_key: cath
+  some_plurals:
+    few:
+    many:
+    one:
+    other:
+    two:
+    zero:

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

@@ -0,0 +1,8 @@
+---
+cy:
+  in_sync:
+    key: food
+    second_key: cat
+  some_plurals:
+    one:
+    other:

data/spec/locales/out_of_sync/cy.yml

@@ -0,0 +1,3 @@
+---
+cy:
+  other_test: key

data/spec/locales/out_of_sync/en.yml

@@ -0,0 +1,6 @@
+---
+en:
+  test: key
+  wrong_plural:
+    one: correct
+    zero: failure

data/spec/rails_translation_manager/cleaner_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+RSpec.describe RailsTranslationManager::Cleaner do
+
+  before(:each) do
+    FileUtils.cp('spec/locales/cleaner/with_whitespace.yml', 'tmp/')
+  end
+
+  it 'removes whitespace at the end of the line' do
+    described_class.new('tmp').clean
+    expect(FileUtils.compare_file('tmp/with_whitespace.yml', 'spec/locales/cleaner/clean.yml')).to be_truthy
+  end
+end

data/spec/rails_translation_manager/importer_spec.rb

@@ -0,0 +1,81 @@
+require "spec_helper"
+require "tmpdir"
+
+RSpec.describe RailsTranslationManager::Importer do
+  let(:import_directory) { Dir.mktmpdir }
+
+  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(
+        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(File).to exist(import_directory + "/fr.yml")
+    end
+
+    it "imports nested locales" do
+      expected = { "type" => { "country" => "Pays" } }
+      expect(yaml_translation_data).to include("world_location" => hash_including(expected))
+    end
+
+    it "imports arrays from CSV as arrays" do
+      expected =  { "fruit" => ["Pommes", "Bananes", "Poires"] }
+      expect(yaml_translation_data).to include("world_location" => hash_including(expected))
+    end
+
+    it "imports string 'nil' as nil" do
+      expected = { "things" => nil }
+      expect(yaml_translation_data).to include("world_location" => hash_including(expected))
+    end
+
+    it "imports string ':thing' as symbol" do
+      expected = { "sentiment" => :bof }
+      expect(yaml_translation_data).to include("world_location" => hash_including(expected))
+    end
+
+    it "imports integer strings as integers" do
+      expected = { "price" => 123 }
+      expect(yaml_translation_data).to include("shared" => hash_including(expected))
+    end
+
+    it "imports boolean values as booleans, not strings" do
+      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(
+        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(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
+      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
+      yaml_translation_data = YAML.load_file(import_directory + "/fr/shared.yml")["fr"]
+      expect(yaml_translation_data).to match("shared" => anything)
+    end
+  end
+end

data/spec/rails_translation_manager/locale_checker/all_locales_spec.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe AllLocales do
+  context "when there are locale files" do
+    it "generates an array of hashes for all locales" do
+      expect(described_class.new("spec/locales/out_of_sync/*.yml").generate)
+        .to eq(
+          [
+            { keys: %w[test wrong_plural wrong_plural.one wrong_plural.zero], locale: :en },
+            { keys: %w[other_test], locale: :cy }
+          ]
+      )
+    end
+  end
+
+  context "when there aren't any locale files present" do
+    it "raises an error" do
+      expect { described_class.new("path/to/none/existant/locale/files").generate }
+        .to raise_error(AllLocales::NoLocaleFilesFound, 'No locale files found for the supplied path')
+    end
+  end
+end

data/spec/rails_translation_manager/locale_checker/incompatible_plurals_spec.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe IncompatiblePlurals do
+  context "when there are missing plurals" do
+    let(:all_locales) do
+      [
+        {
+          locale: :en,
+          keys: %w[browse.some_key.other browse.some_other_key.one]
+        }
+      ]
+    end
+
+    before do
+      allow(PluralForms).to receive(:all).and_return({ en: %i[one other] })
+    end
+
+    it "returns the missing plural forms" do
+      expect(described_class.new(all_locales).report)
+        .to eq(
+          <<~OUTPUT.chomp
+            \e[31m[ERROR]\e[0m Incompatible plural forms, for:
+
+            - 'en', with parent 'browse.some_key'. Expected: [:one, :other], actual: [:other]
+
+            - 'en', with parent 'browse.some_other_key'. Expected: [:one, :other], actual: [:one]
+
+            \e[1mIf the keys reported above are not plurals, rename them avoiding plural keywords: #{LocaleCheckerHelper::PLURAL_KEYS}\e[22m
+          OUTPUT
+        )
+    end
+  end
+
+  context "when there aren't any missing plurals" do
+    let(:all_locales) do
+      [
+        {
+          locale: :en,
+          keys: %w[browse.some_key.other browse.some_key.one]
+        }
+      ]
+    end
+
+    before do
+      allow(PluralForms).to receive(:all).and_return({ en: %i[one other] })
+    end
+
+    it "returns nil" do
+      expect(described_class.new(all_locales).report)
+        .to be_nil
+    end
+  end
+
+  context "when plural forms aren't available for the locales" do
+    let(:all_locales) do
+      [
+        {
+          locale: :en,
+          keys: %w[browse.some_key.one browse.some_key.other]
+        },
+        {
+          locale: :cy,
+          keys: %w[browse.some_key.few
+                   browse.some_key.many
+                   browse.some_key.one
+                   browse.some_key.other
+                   browse.some_key.two
+                   browse.some_key.zero]
+        }
+      ]
+    end
+
+    before do
+      allow(PluralForms).to receive(:all).and_return({ cy: nil, en: nil })
+    end
+
+    it "outputs the missing plural forms" do
+      expect(described_class.new(all_locales).report)
+        .to eq(
+          <<~OUTPUT.chomp
+            \e[31m[ERROR]\e[0m Incompatible plural forms, for:
+
+            - \e[31m[ERROR]\e[0m Please add plural form for 'en' <link to future documentation>
+
+            - \e[31m[ERROR]\e[0m Please add plural form for 'cy' <link to future documentation>
+
+            \e[1mIf the keys reported above are not plurals, rename them avoiding plural keywords: #{LocaleCheckerHelper::PLURAL_KEYS}\e[22m
+          OUTPUT
+        )
+    end
+  end
+end

data/spec/rails_translation_manager/locale_checker/locale_checker_helper_spec.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe LocaleCheckerHelper do
+  include LocaleCheckerHelper
+
+  describe "#exclude_plurals" do
+    it "excludes plural groups" do
+      expect(exclude_plurals(%w[key.one key.other]))
+        .to eq([])
+    end
+
+    it "doesn't exclude non-plurals" do
+      expect(exclude_plurals(%w[thing.bing red.blue]))
+        .to eq(%w[thing.bing red.blue])
+    end
+  end
+
+  describe "#group_keys" do
+    it "groups locales by keys" do
+      keys = {
+        en: %w[key.first key.second],
+        fr: %w[key.first key.second],
+        es: %w[key.second]
+      }
+
+      expect(group_keys(keys))
+        .to eq(
+          {
+            %w[key.first key.second] => %i[en fr],
+            %w[key.second] => %i[es]
+          }
+        )
+    end
+  end
+
+  describe "#english_keys_excluding_plurals" do
+    it "returns english keys excluding plurals" do
+      keys = [
+        { locale: :en, keys: %w[key.english plural.other] },
+        { locale: :fr, keys: %w[key.french] }
+      ]
+
+      expect(english_keys_excluding_plurals(keys))
+        .to eq(%w[key.english])
+    end
+  end
+
+  describe "#key_is_plural?" do
+    it "returns true if key is a plural keyword" do
+      expect(key_is_plural?("other"))
+        .to eq(true)
+    end
+
+    it "returns false if key isn't a plural keyword" do
+      expect(key_is_plural?("random"))
+        .to eq(false)
+    end
+  end
+end

data/spec/rails_translation_manager/locale_checker/missing_english_locales_spec.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe MissingEnglishLocales do
+  context "where there are missing English locales" do
+    let(:all_locales) do
+      [
+        {
+          locale: :en,
+          keys: %w[browse.same_key]
+        },
+        {
+          locale: :cy,
+          keys: %w[browse.same_key browse.extra_key]
+        }
+      ]
+    end
+
+    it "outputs the missing locales" 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[1mMissing English keys:\e[22m ["browse.extra_key"]
+            \e[1mFound in:\e[22m [:cy]
+          OUTPUT
+        )
+    end
+  end
+
+  context "where there aren't missing English locales" do
+    let(:all_locales) do
+      [
+        {
+          locale: :en,
+          keys: %w[browse.same_key]
+        },
+        {
+          locale: :cy,
+          keys: %w[browse.same_key]
+        }
+      ]
+    end
+
+    it 'outputs nil' do
+      expect(described_class.new(all_locales).report)
+        .to be_nil
+    end
+  end
+
+  context "when there are plurals" do
+    let(:all_locales) do
+      [
+        {
+          locale: :en,
+          keys: []
+        },
+        {
+          locale: :cy,
+          keys: %w[browse.plurals.one browse.fake_plurals.other]
+        }
+      ]
+    end
+
+    it "doesn't include them in the report" do
+      expect(described_class.new(all_locales).report)
+        .to be_nil
+    end
+  end
+end

data/spec/rails_translation_manager/locale_checker/missing_foreign_locales_spec.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe MissingForeignLocales do
+  context "when there are missing foreign locales" do
+    let(:all_locales) do
+      [
+        {
+          locale: :en,
+          keys: %w[browse.same_key browse.extra_nested_key.nest]
+        },
+        {
+          locale: :cy,
+          keys: %w[browse.same_key]
+        },
+        {
+          locale: :fr,
+          keys: %w[browse.same_key]
+        }
+      ]
+    end
+
+    before do
+      I18n.available_locales << %i[fr]
+    end
+
+    it "outputs the missing locales and groups them by common keys" do
+      expect(described_class.new(all_locales).report)
+        .to eq(
+          <<~OUTPUT.chomp
+            \e[31m[ERROR]\e[0m Missing foreign locales, either add these keys to the foreign locales or remove them from the English locales\e[0m
+
+            \e[1mMissing foreign keys:\e[22m ["browse.extra_nested_key.nest"]
+            \e[1mAbsent from:\e[22m [:cy, :fr]
+          OUTPUT
+        )
+    end
+  end
+
+  context "when there aren't missing foreign locales" do
+    let(:all_locales) do
+      [
+        {
+          locale: :en,
+          keys: %w[browse.same_key]
+        },
+        {
+          locale: :cy,
+          keys: %w[browse.same_key]
+        }
+      ]
+    end
+
+    it "outputs nil" do
+      expect(described_class.new(all_locales).report)
+        .to be_nil
+    end
+  end
+
+  context "when there are plurals" do
+    let(:all_locales) do
+      [
+        {
+          locale: :en,
+          keys: %w[browse.plurals.one browse.fake_plurals.other]
+        },
+        {
+          locale: :cy,
+          keys: []
+        }
+      ]
+    end
+
+    it "doesn't include them in the report" do
+      expect(described_class.new(all_locales).report)
+        .to be_nil
+    end
+  end
+end

data/spec/rails_translation_manager/locale_checker/plural_forms_spec.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe PluralForms do
+  it "returns plural forms" do
+    expect(described_class.all).to include(
+      { cy: %i[few many one other two zero], en: %i[one other] }
+    )
+  end
+
+  context "when there are missing plural forms" do
+    around do |example|
+      load_path = I18n.load_path
+      # strips I18n of all pluralization files (rules)
+      I18n.load_path = I18n.load_path.flatten.reject { |path| path =~ /plural/ }
+
+      example.run
+
+      I18n.load_path = load_path
+    end
+
+    it "returns nil for associated locales" do
+      expect(described_class.all).to include({ cy: nil, en: nil })
+    end
+  end
+end