rails_translation_manager 0.0.1 → 1.1.0

data/spec/rails_translation_manager/locale_checker_spec.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe RailsTranslationManager::LocaleChecker do
+  context "when the locales are valid" do
+    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
+    end
+
+    it "outputs a confirmation" do
+      expect { described_class.new("spec/locales/in_sync/**/*.yml").validate_locales }
+        .to output("Locale files are in sync, nice job!\n").to_stdout
+    end
+
+    it "returns true" do
+      expect(described_class.new("spec/locales/in_sync/**/*.yml").validate_locales)
+        .to eq(true)
+    end
+  end
+
+  context "when the locales are not valid" do
+    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
+    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)
+    end
+
+    it "returns false" do
+      expect(described_class.new("spec/locales/out_of_sync/*.yml").validate_locales)
+        .to eq(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)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "rails_translation_manager"
+
+RSpec.configure do |config|
+  config.before do
+    I18n.available_locales = %i[en cy]
+    config.before { allow($stdout).to receive(:puts) }
+  end
+
+  def capture_stdout(&blk)
+    old = $stdout
+    $stdout = fake = StringIO.new
+    blk.call
+    fake.string
+  ensure
+    $stdout = old
+  end
+end

data/spec/support/tasks.rb

@@ -0,0 +1,7 @@
+require 'rake'
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    Dir.glob('lib/tasks/*.rake').each { |r| Rake::DefaultLoader.new.load r }
+  end
+end

data/spec/tasks/translation_spec.rb

@@ -0,0 +1,123 @@
+require "spec_helper"
+require_relative "../../spec/support/tasks"
+
+describe "rake tasks" do
+  before do
+    fake_rails = double()
+    fake_rails.stub(:root) { Pathname.new("spec") }
+    stub_const("Rails", fake_rails)
+  end
+
+  describe "translation:import", type: :task do
+    let(:task) { Rake::Task["translation:import"] }
+    let(:csv_path) { "path/to/import/fr.csv" }
+    let!(:importer_instance) { stub_importer }
+
+    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_stdout
+    end
+
+    it "calls the Importer class with the csv and import paths" do
+      task.execute(csv_path: csv_path)
+
+      expect(RailsTranslationManager::Importer)
+        .to have_received(:new)
+        .with(locale: "fr",
+              csv_path: csv_path,
+              import_directory: Rails.root.join("config", "locales"),
+              multiple_files_per_language: false)
+      expect(importer_instance).to have_received(:import)
+    end
+  end
+
+  describe "translation:import:all", type: :task do
+    let(:task) { Rake::Task["translation:import:all"] }
+    let(:csv_directory) { "locales/importer" }
+    let!(:importer_instance) { stub_importer }
+
+    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_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)
+    end
+  end
+
+  describe "translation:add_missing", type: :task do
+    let(:task) { Rake::Task["translation:add_missing"] }
+    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
+      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(locale: "fr")
+      expect(I18n::Tasks::CLI).to have_received(:start).with(
+        ["add-missing", "--nil-value", ["-l", "fr"]]
+      )
+    end
+  end
+
+  describe "translation:normalize", type: :task do
+    let(:task) { Rake::Task["translation:normalize"] }
+    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(["normalize"])
+    end
+  end
+
+  def stub_importer
+    importer_instance = instance_double(RailsTranslationManager::Importer)
+    allow(RailsTranslationManager::Importer).to receive(:new)
+      .and_return(importer_instance)
+    allow(importer_instance).to receive(:import)
+
+    importer_instance
+  end
+
+  def stub_cleaner
+    cleaner_instance = instance_double(RailsTranslationManager::Cleaner)
+    allow(RailsTranslationManager::Cleaner)
+      .to receive(:new)
+      .and_return(cleaner_instance)
+    allow(cleaner_instance).to receive(:clean)
+
+    cleaner_instance
+  end
+end

data/test/rails_translation_manager/yaml_writer_test.rb

@@ -0,0 +1,60 @@
+require "test_helper"
+require "rails_translation_manager/yaml_writer"
+module RailsTranslationManager
+  class DummyWriter
+    include YAMLWriter
+  end
+
+  class WriterTest < Minitest::Test
+
+    def setup
+      @output_file = Tempfile.new('fr')
+    end
+
+    def teardown
+      @output_file.close
+      @output_file.unlink
+    end
+
+    test 'outputs YAML without the header --- line for consistency with convention' do
+      data = {"fr" => {
+        key1: [:source, :translation],
+        "key2" => ["value", "le value"],
+      }}
+
+      DummyWriter.new.write_yaml(output_file, data)
+
+      assert_equal "fr:", File.readlines(output_file).first.strip
+    end
+
+    test 'outputs a newline at the end of the YAML for consistency with code editors' do
+      data = {"fr" => {
+        key1: [:source, :translation],
+        "key2" => ["value", "le value"],
+      }}
+
+      DummyWriter.new.write_yaml(output_file, data)
+
+      assert_match /\n$/, File.readlines(output_file).last
+    end
+
+    test 'strips whitespace from the end of lines for consistency with code editors' do
+      data = {fr: {
+        key1: [:source, :translation],
+        "key2" => ["value", nil],
+      }}
+
+      DummyWriter.new.write_yaml(output_file, data)
+
+      lines = File.readlines(output_file)
+      refute lines.any? { |line| line =~ /\s\n$/ }
+    end
+
+  private
+
+    def output_file
+      @output_file.path
+    end
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_translation_manager
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Edd Sowden
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-09 00:00:00.000000000 Z
+date: 2021-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails-i18n
@@ -38,20 +38,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ''
 email:
 - edd.sowden@digital.cabinet-office.gov.uk
@@ -90,23 +132,55 @@ files:
 - ".gitignore"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
+- Jenkinsfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- config/locales/plurals.rb
 - lib/rails_translation_manager.rb
+- lib/rails_translation_manager/cleaner.rb
 - lib/rails_translation_manager/exporter.rb
 - lib/rails_translation_manager/importer.rb
+- lib/rails_translation_manager/locale_checker.rb
+- lib/rails_translation_manager/locale_checker/all_locales.rb
+- 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_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/railtie.rb
-- lib/rails_translation_manager/validator.rb
 - lib/rails_translation_manager/version.rb
+- lib/rails_translation_manager/yaml_writer.rb
 - lib/tasks/translation.rake
+- lib/tasks/translation_helper.rb
 - rails_translation_manager.gemspec
+- spec/locales/cleaner/clean.yml
+- spec/locales/cleaner/with_whitespace.yml
+- spec/locales/importer/fr.csv
+- spec/locales/in_sync/cy/browse.yml
+- spec/locales/in_sync/en/browse.yml
+- spec/locales/out_of_sync/cy.yml
+- spec/locales/out_of_sync/en.yml
+- spec/rails_translation_manager/cleaner_spec.rb
+- spec/rails_translation_manager/importer_spec.rb
+- 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_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_spec.rb
+- spec/spec_helper.rb
+- spec/support/tasks.rb
+- spec/tasks/translation_spec.rb
 - test/rails_translation_manager/exporter_test.rb
-- test/rails_translation_manager/importer_test.rb
-- test/rails_translation_manager/validator_test.rb
+- test/rails_translation_manager/yaml_writer_test.rb
 - test/test_helper.rb
+- tmp/.gitkeep
 homepage: ''
 licenses:
 - MIT
@@ -126,13 +200,30 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Tasks to manage translation files
 test_files:
+- spec/locales/cleaner/clean.yml
+- spec/locales/cleaner/with_whitespace.yml
+- spec/locales/importer/fr.csv
+- spec/locales/in_sync/cy/browse.yml
+- spec/locales/in_sync/en/browse.yml
+- spec/locales/out_of_sync/cy.yml
+- spec/locales/out_of_sync/en.yml
+- spec/rails_translation_manager/cleaner_spec.rb
+- spec/rails_translation_manager/importer_spec.rb
+- 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_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_spec.rb
+- spec/spec_helper.rb
+- spec/support/tasks.rb
+- spec/tasks/translation_spec.rb
 - test/rails_translation_manager/exporter_test.rb
-- test/rails_translation_manager/importer_test.rb
-- test/rails_translation_manager/validator_test.rb
+- test/rails_translation_manager/yaml_writer_test.rb
 - test/test_helper.rb

data/lib/rails_translation_manager/validator.rb

@@ -1,92 +0,0 @@
-require 'yaml'
-require 'logger'
-
-class RailsTranslationManager::Validator
-  def initialize(translation_file_path, logger = Logger.new(nil))
-    @translation_file_path = translation_file_path
-    @logger = logger
-  end
-
-  def check!
-    @logger.info "Checking translation files in '#{@translation_file_path}' for unexpected interpolation keys"
-    @logger.info "Loading reference file (#{reference_file_name})"
-    @logger.info "Checking..."
-    reference = load_translation_file("#{@translation_file_path}/#{reference_file_name}")
-    Dir["#{@translation_file_path}/*.yml"].reject do |entry|
-      File.basename(entry) == reference_file_name
-    end.inject([]) do |errors, entry|
-      translation_file = load_translation_file(entry)
-      errors + unexpected_substitution_keys(reference, translation_file)
-    end
-  end
-
-  def unexpected_substitution_keys(reference, translation_file)
-    reference_substitutions = substitutions_in(reference)
-    target_substitutions = substitutions_in(translation_file)
-
-    targets_by_path = target_substitutions.each_with_object({}) do |target, hash|
-      hash[exclude_locale_from_path(target.path)] = target
-    end
-
-    reference_substitutions.each_with_object([]) do |reference, unexpected_substitutions|
-      target = targets_by_path[exclude_locale_from_path(reference.path)]
-      next if target.nil? || reference.has_all_substitutions?(target)
-      unexpected_substitutions << UnexpectedSubstition.new(target, reference)
-    end
-  end
-
-  def substitutions_in(translation_file)
-    flatten(translation_file).reject do |translation|
-      translation.substitutions.empty?
-    end
-  end
-
-  class TranslationEntry < Struct.new(:path, :value)
-    def substitutions
-      @substitutions ||= self.value.scan(/%{([^}]*)}/)
-    end
-
-    def has_all_substitutions?(other)
-      (other.substitutions - self.substitutions).empty?
-    end
-  end
-
-  class UnexpectedSubstition < Struct.new(:target, :reference)
-    def to_s
-      missing = (self.reference.substitutions - self.target.substitutions)
-      extras = (self.target.substitutions - self.reference.substitutions)
-      message = %Q{Key "#{target.path.join('.')}":}
-      if extras.any?
-        message << %Q{ Extra substitutions: ["#{extras.join('", "')}"].}
-      end
-      if missing.any?
-        message << %Q{ Missing substitutions: ["#{missing.join('", "')}"].}
-      end
-      message
-    end
-  end
-
-  def flatten(translation_file, path = [])
-    translation_file.map do |key, value|
-      case value
-      when Hash
-        flatten(value, path + [key])
-      else
-        TranslationEntry.new(path + [key], value || "")
-      end
-    end.flatten
-  end
-
-  def load_translation_file(filename)
-    YAML.load_file(filename)
-  end
-
-  def reference_file_name
-    "en.yml"
-  end
-
-private
-  def exclude_locale_from_path(path)
-    path[1..-1]
-  end
-end