rails_translation_manager 1.3.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7345dfdb610385c480d9434eda36b6be02c37617046eb0029393fe250a37fe4f
-  data.tar.gz: c7d42c8eeb4268b289f96377f5dcee785c97c8c67b1895c53cb7a9b4d984f99d
+  metadata.gz: 2a65778c39b278103e8338f32392a62d043fe00cbe5d17e6f6022430535fe49e
+  data.tar.gz: e6bb43c0f68cf6d11d2da6299119e6c25f1a7164df0e6bf6314f8c3f32b08e6a
 SHA512:
-  metadata.gz: 27a9d0906d1fff39bec4c877368c7118a9e95d209251433f2fa3890c270aeb9d58a2479153c768069aaf2834fd28b74b916f4a0ed36d58ec844a53c2a3cedf2f
-  data.tar.gz: d2ce1ff2d3e9253b2109d4ee6db895ff80476f39b881dc8a9775766936d4b2092429e036d5fe0ed1d9c995a02b2204f06ac6d5fcdfcd064a82fc08b8c3b43a8d
+  metadata.gz: 8c0ef6580950126127bede40d39a56b4702bafbd177c43a22e74d8e1761ab3564a27614e66c26fd8d8d1e6cb3c0ab8cbc0359b295f014fe28b2a07dd27878259
+  data.tar.gz: f289ee8695990b0e1561fc8cab17abf99ecb7aa0f9b63136179d08e0a1ae4b19f5d4fd01100b1d03b8afcf9336016c2b4034e6bd29b5eadf36b66a37c8dba1e5

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+# 1.5.1
+
+Fixes uppercase bug when comparing actual vs available locales. https://github.com/alphagov/rails_translation_manager/pull/43
+
+# 1.5.0
+
+Allow configuring the locale files directory with `RAILS_TRANSLATION_MANAGER_LOCALE_ROOT`. https://github.com/alphagov/rails_translation_manager/pull/38
+
+## 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

data/README.md

@@ -1,35 +1,9 @@
 # Rails Translation Manager
 
-Support for translation workflow in rails applications.
-
-## Nomenclature
-
-- **CSV**: comma separated values, a tabular data format which can be loaded into a
-           spreadsheet package
-- **I18n**: an abbreviation of 'internationalisation', which is the process of adding
-            support for multiple locales and languages to an application.
-            `I18n` is also the name of a ruby gem which supports
-            internationalisation in ruby applications.
-- **interpolation**: a technique used in I18n whereby data is inserted ("interpolated")
-                     into a translated string of text, for example `Hello %{name}`
-                     would become `Hello Sarah` if the variable `name` had the
-                     value `Sarah`.
-- **YAML**: YAML Ain't Markup Language, a textual data format used (in this case) for storing
-            translation strings in rails applications
+Rails Translation Manager (RTM) provides validation for locale files, and exposes several rake tasks which can be used to manage your translations. It can only be used on Rails apps.
 
 ## Technical documentation
 
-This gem provides a rails engine which adds rake tasks to manage translation
-files.
-
-It is intended to be included within your rails application by referencing it
-as a dependency in your `Gemfile`. You will then be able to use the rake tasks
-to manage your translation files and import/export translation strings.
-
-### Dependencies
-
-To date it has only been tested with a rails 3.2.18 app, but it should work with later (and older) rails apps as well.
-
 ### Installation
 
 Add this line to your application's Gemfile:
@@ -38,207 +12,55 @@ Add this line to your application's Gemfile:
 gem 'rails_translation_manager'
 ```
 
-And then execute:
-
-    $ bundle
-
-The gem depends on your rails application environment so it would not make
-sense to install this gem stand-alone.
-
-### Running the application
-
-The primary usage of this gem is to support translation workflow.
-
-Once you have installed the gem into your application as described above, the
-expected usage is:
-
-1. export translations to a CSV file using:
-
-   ```
-   rake translation:export:all[target_directory]
-   ```
-
-   or
-
-   ```
-   rake translation:export[target_directory,base_locale,target_locale]
-   ```
-
-2. send the appropriate CSV file to a translator
-
-3. wait for translation to happen
-
-4. receive translation file back, check it for [character encoding issues](https://github.com/alphagov/character_encoding_cleaner)
-
-5. import the translation file using either:
-
-   ```
-   rake translation:import:all[source_directory]
-   ```
-
-   or
-
-   ```
-   rake translation:import[locale,path]
-   ```
-
-   this will generate `.yml` files for each translation
-
-6. commit any changed `.yml` files
-
-   ```
-   git add config/locale
-   git commit -m 'added new translations'
-   ```
-
-### Validation of interpolation keys
-
-A second feature supported by this library is the validation of interpolation
-keys.
-
-The I18n library supports 'interpolation' using the following syntax:
-
-```yaml
-en:
-  some_view:
-    greeting: Hello, %{name}
-```
-
-in this case the application can pass in the value of the `name` variable.
-
-If a translation includes an interpolation placeholder which has not been
-given a value by the application backend, then a runtime error will be raised.
-
-Unfortunately the placeholder variables sometimes get changed by mistake, or
-by translators who are not aware that they should not modify text within the
-special curly braces of the interpolation placeholder.
-
-This is obviously not great, and the validation task is intended to guard
-against it.
-
-It will check all translation files and report any which contain placeholders
-which do not exist in the english file.
-
-```
-$ rake translation:validate
-Success! No unexpected interpolation keys found.
-```
-
-### Stealing translations from another app
-
-A third feature is the ability to "steal" one or more locales from an existing
-application. This functionality works by providing a mapping file, which defines
-how the translation keys in the the source app's files map to those in the app
-the gem is installed in.
-
-For example, given a locale file like this in the app to "steal" from:
-
-```yaml
-es:
-  document:
-    type:
-      case_study: Caso de estudio
-      consultation: Consulta
-```
-
-and a mapping file like this:
+After a `bundle install`, this will make a number of rake tasks available to your application.
+See the [Rake command reference](#rake-command-reference) below.
 
-```yaml
-document.type: content_item.format
-```
-
-running `rake translation:steal[es,../other_app,mapping_file_path.yml]` will
-result in the following locale file being created:
-
-```yaml
-es:
-  content_item:
-    format:
-      case_study: Caso de estudio
-      consultation: Consulta
-```
-
-The mapping file can live anywhere, as long as the full path (including filename)
-is given in the rake task invocation.
-
-The process will preserve data already in the output file if it is not
-referenced in the mapping, but will always override data belonging to keys
-that are in the mapping.
-
-
-### Rake command reference
-
-#### Export a specific locale to CSV
-
-```
-rake translation:export[directory,base_locale,target_locale]
-```
-
-#### Export all locales to CSV files
-
-```
-rake translation:export:all[directory]
-```
-
-#### Import a specific locale CSV to YAML within the app
-
-```
-rake translation:import[locale,path]
-```
-
-#### Import all locale CSV files to YAML within the app
+You will now also be able to run tests against your locale files to ensure that they are valid.
+Create a test file as follows.
 
-```
-rake translation:import:all[directory]
-```
-
-#### 
+#### Minitest
 
-#### Regenerate all locales from the EN locale - run this after adding keys
-
-```
-rake translation:regenerate[directory]
+```ruby
+class LocalesValidationTest < ActiveSupport::TestCase
+  test "should validate all locale files" do
+    checker = RailsTranslationManager::LocaleChecker.new("config/locales/*.yml")
+    assert checker.validate_locales
+  end
+end
 ```
 
-#### Check translation files for errors
+#### RSpec
 
-```
-rake translation:validate
+```ruby
+RSpec.describe "locales files" do
+  it "should meet all locale validation requirements" do
+    checker = RailsTranslationManager::LocaleChecker.new("config/locales/*/*.yml")
+    expect(checker.validate_locales).to be_truthy
+  end
+end
 ```
 
-#### Steal a specific locale file from another app
+### Running the test suite
 
-```
-rake translation:steal[locale,source_app_path,mapping_file_path]
-```
+To run the test suite just run `bundle exec rake` from within the
+`rails_translation_manager` directory.
 
-#### Steal all locale files from another app
+### Further documentation
 
-```
-rake translation:steal:all[source_app_path,mapping_file_path]
-```
+- [Adding and editing plural forms](docs/adding-editing-plural-forms.md)
+- [Rake command reference](docs/rake-command-reference.md)
+- [Translating locale files](docs/translating-locale-files.md) using RTM
 
-### Running the test suite
+#### i18n-tasks
 
-To run the test suite just run `bundle exec rake` from within the
-`rails_translation_manager` directory.
+RTM uses [i18n-tasks](https://github.com/glebm/i18n-tasks) under the hood.
+For advanced tasks, refer to the i18n-tasks documentation:
 
-You will need to clone the repository locally and run `bundle install` the
-first time you do this, eg.:
+- [Move / rename / merge keys](https://github.com/glebm/i18n-tasks#move--rename--merge-keys)
+- [Delete keys](https://github.com/glebm/i18n-tasks#delete-keys)
 
-```sh
-$ git clone git@github.com:alphagov/rails_translation_manager.git
-$ cd rails_translation_manager
-$ bundle install
-$ bundle exec rake
-...
-```
+Read [why we architected RTM in this way](https://docs.google.com/document/d/1bao4KfXtZOwoUZ4ZGRSKi1TagKMq-zsy8xAc-2GZlgo/edit).
 
 ## Licence
 
 [MIT License](LICENSE.txt)
-
-## Versioning policy
-
-We use [semantic versioning](http://semver.org/), and bump the version
-on master only. Please don't submit your own proposed version numbers.

data/docs/adding-editing-plural-forms.md

@@ -0,0 +1,31 @@
+# Adding a language's plural form
+
+We maintain our own [plurals.rb](https://github.com/alphagov/rails_translation_manager/blob/master/config/locales/plurals.rb) configuration file. If adding a language to Rails Translation Manager, that doesn't exist in [rails-i18n](https://github.com/svenfuchs/rails-i18n), you may need to edit this file.
+
+This config is needed to correctly distinguish the [plural rules](https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html) for locales not included in `rails-i18n`, as it is needed for plural validation checks.
+
+Note that there is currently a [duplicate list in `govuk_app_config](https://github.com/alphagov/govuk_app_config/blob/main/lib/govuk_app_config/govuk_i18n.rb). The intention is for this to be removed and for the Rails Translation Manager version to be the sole version.
+
+## Editing plural forms
+
+Keys with incorrect plural forms are more complex to adjust. If there are keys with additional unnecessary plural forms, they can be deleted:
+
+```
+sed -i '' '/^ \+one:/d' config/locales/xx.yml
+```
+
+This commonly occurs for e.g. Chinese and Vietnamese which are expected to have only an `:other` and not a `:one` form.
+
+Keys which need a plural form added can be automated with caution. If every key of a specific translation needs the new plural added, it can be done by adding a blank key before every `other:` key:
+
+```
+perl -0777 -p -i -e 's/\n(\s+)other:/\n\1nmany:\n\1other:/g' config/locales/xx.yml
+```
+
+Or if only a specific key needs the plural added:
+
+```
+perl -0777 -p -i -e 's/(key_with_missing_plural:\n)(\s+)/\1\2zero:\n\2/g' config/locales/xx.yml
+```
+
+This commonly occurs for Slavic languages and Arabic, for example, which have plural forms other than just `:one` and `:other`.

data/docs/rake-command-reference.md

@@ -0,0 +1,84 @@
+# Rake command reference
+
+±Export a specific locale to CSV:
+
+```
+rake translation:export[directory,base_locale,target_locale]
+```
+
+±Export all locales to CSV files:
+
+```
+rake translation:export:all[directory]
+```
+
+> ± These tasks won't work in [multi-file setups](#multi-file-setups).
+
+Import a specific locale CSV to YAML within the app:
+
+```
+rake translation:import[locale,path,multiple_files_per_language]
+```
+
+Import all locale CSV files to YAML within the app:
+
+```
+rake translation:import:all[directory,multiple_files_per_language]
+```
+
+> The `multiple_files_per_language` parameter is optional and defaults to `false`. See [multi-file setups](#multi-file-setups).
+
+Add missing keys with placeholders:
+
+```
+rake translation:add_missing
+```
+
+Normalize your locales (remove whitespace, sort keys alphabetically, etc):
+
+```
+rake translation:normalize
+```
+
+Remove keys that are not used anywhere in your application:
+
+```
+rake translation:remove_unused
+```
+
+Sometimes RTM might remove keys that actually _are_ used by your application. This happens when the keys are referenced dynamically. You can make RTM ignore these keys by creating a `/config/i18n-tasks.yml` file with an `ignore_unused` key. For example:
+
+```yaml
+ignore_unused:
+  - 'content_item.schema_name.*.{one,other,zero,few,many,two}'
+  - 'corporate_information_page.*'
+  - 'travel_advice.alert_status.*'
+```
+
+## Multi-file setups
+
+Locale files can follow a single-file structure. For example:
+
+```
+config/
+  locales/
+    en/
+      en.yml
+    fr/
+      fr.yml
+```
+
+They can also follow a multi-file structure. For example:
+
+```
+config/
+  locales/
+    en/
+      bar.yml
+      foo.yml
+    fr/
+      bar.yml
+      foo.yml
+```
+
+Some tasks will work with both structures, but others are limited to only one structure type, due to lack of development time. Ideally, all tasks would work with both types.

data/docs/translating-locale-files.md

@@ -0,0 +1,44 @@
+# Translating locale files
+
+This document explains how to use Rails Translation Manager to create locale files.
+
+Once you have installed the gem into your application, the expected usage is:
+
+1. export translations to a CSV file using:
+
+   ```
+   rake translation:export:all[target_directory]
+   ```
+
+   or
+
+   ```
+   rake translation:export[target_directory,base_locale,target_locale]
+   ```
+
+2. send the appropriate CSV file to a translator
+
+3. wait for translation to happen
+
+4. receive translation file back
+
+5. import the translation file using either:
+
+   ```
+   rake translation:import:all[source_directory]
+   ```
+
+   or
+
+   ```
+   rake translation:import[locale,path]
+   ```
+
+   this will generate `.yml` files for each translation
+
+6. commit any changed `.yml` files
+
+   ```
+   git add config/locale
+   git commit -m 'added new translations'
+   ```

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/incompatible_plurals.rb

@@ -24,7 +24,7 @@ class IncompatiblePlurals < BaseChecker
       plural_form = all_plural_forms[plurals[:locale]]
 
       if plural_form.blank?
-        "- \e[31m[ERROR]\e[0m Please add plural form for '#{plurals[:locale]}' <link to future documentation>"
+        "- \e[31m[ERROR]\e[0m Please add plural form for '#{plurals[:locale]}'. See https://github.com/alphagov/rails_translation_manager/tree/master/docs/adding-editing-plural-forms.md"
       else
         incompatible_plurals(plurals, plural_form)
       end

data/lib/rails_translation_manager/locale_checker/missing_declared_locales.rb

@@ -25,6 +25,6 @@ class MissingDeclaredLocales < BaseChecker
   end
 
   def compare
-    I18n.available_locales - actual_locales
+    I18n.available_locales.map(&:downcase) - actual_locales
   end
 end

data/lib/rails_translation_manager/locale_checker.rb

@@ -10,8 +10,9 @@ module RailsTranslationManager
                        MissingForeignLocales,
                        UndeclaredLocaleFiles].freeze
 
-    def initialize(locale_path)
+    def initialize(locale_path, skip_validation = [])
       @locale_path = locale_path
+      @skip_validation = skip_validation
     end
 
     def validate_locales
@@ -21,7 +22,7 @@ module RailsTranslationManager
       false
     end
 
-    private
+  private
 
     def output_result
       errors = checker_errors.compact
@@ -46,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.3.0"
+  VERSION = "1.5.1"
 end

data/lib/rails_translation_manager.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 require "rails_translation_manager/version"
-require "rails_translation_manager/railtie" if defined?(Rails)
+require "rails"
+require "rails_translation_manager/railtie"
 require "rails-i18n"
 
 require "rails_translation_manager/locale_checker/base_checker"
@@ -26,4 +27,12 @@ module RailsTranslationManager
     Dir["#{rails_i18n_path}/rails/pluralization/*.rb"],
     ["#{rails_translation_manager}/config/locales/plurals.rb"]
   )
+
+  def self.locale_root
+    if ENV["RAILS_TRANSLATION_MANAGER_LOCALE_ROOT"]
+      Pathname.new(ENV["RAILS_TRANSLATION_MANAGER_LOCALE_ROOT"])
+    else
+      Rails.root.join("config/locales")
+    end
+  end
 end

data/lib/tasks/translation.rake

@@ -6,9 +6,10 @@ namespace :translation do
 
   desc "Export a specific locale to CSV."
   task :export, [:directory, :base_locale, :target_locale] => [:environment] do |t, args|
+    locale_root = RailsTranslationManager.locale_root
     FileUtils.mkdir_p(args[:directory]) unless File.exist?(args[:directory])
-    base_locale = Rails.root.join("config", "locales", args[:base_locale] + ".yml")
-    target_locale_path = Rails.root.join("config", "locales", args[:target_locale] + ".yml")
+    base_locale = locale_root.join(args[:base_locale] + ".yml")
+    target_locale_path = locale_root.join(args[:target_locale] + ".yml")
     exporter = RailsTranslationManager::Exporter.new(args[:directory], base_locale, target_locale_path)
     exporter.export
   end
@@ -16,10 +17,11 @@ namespace :translation do
   namespace :export do
     desc "Export all locales to CSV files."
     task :all, [:directory] => [:environment] do |t, args|
+      locale_root = RailsTranslationManager.locale_root
       directory = args[:directory] || "tmp/locale_csv"
       FileUtils.mkdir_p(directory) unless File.exist?(directory)
-      locales = Dir[Rails.root.join("config", "locales", "*.yml")]
-      base_locale = Rails.root.join("config", "locales", "en.yml")
+      locales = Dir[locale_root.join("*.yml")]
+      base_locale = locale_root.join("en.yml")
       target_locales = locales - [base_locale.to_s]
       target_locales.each do |target_locale_path|
         exporter = RailsTranslationManager::Exporter.new(directory, base_locale, target_locale_path)
@@ -31,37 +33,35 @@ namespace :translation do
 
   desc "Import a specific locale CSV to YAML within the app."
   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"),
+      import_directory: RailsTranslationManager.locale_root,
       multiple_files_per_language: args[:multiple_files_per_language] || false
     )
     importer.import
 
-    puts "\nImported CSV from: #{csv_path} to #{import_dir}"
+    puts "\nImported CSV from: #{csv_path} to #{RailsTranslationManager.locale_root}"
   end
 
   namespace :import do
     desc "Import all locale CSV files to YAML within the app."
     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|
+      Dir["#{directory}/*.csv"].each do |csv_path|
         importer = RailsTranslationManager::Importer.new(
           locale: File.basename(csv_path, ".csv"),
           csv_path: csv_path,
-          import_directory: import_dir,
+          import_directory: RailsTranslationManager.locale_root,
           multiple_files_per_language: args[:multiple_files_per_language] || false
         )
         importer.import
       end
 
-      puts "\nImported all CSVs from: #{directory} to #{import_dir}"
+      puts "\nImported all CSVs from: #{directory} to #{RailsTranslationManager.locale_root}"
     end
   end
 
@@ -72,7 +72,7 @@ namespace :translation do
     ).with_optional_locale
 
     I18n::Tasks::CLI.start(option_parser)
-    RailsTranslationManager::Cleaner.new(Rails.root.join("config", "locales")).clean
+    RailsTranslationManager::Cleaner.new(RailsTranslationManager.locale_root).clean
   end
 
   desc "Normalize translations"
@@ -82,7 +82,7 @@ namespace :translation do
     ).with_optional_locale
 
     I18n::Tasks::CLI.start(option_parser)
-    RailsTranslationManager::Cleaner.new(Rails.root.join("config", "locales")).clean
+    RailsTranslationManager::Cleaner.new(RailsTranslationManager.locale_root).clean
   end
 
   desc "Remove unused keys"
@@ -92,6 +92,6 @@ namespace :translation do
     ).with_optional_locale
 
     I18n::Tasks::CLI.start(option_parser)
-    RailsTranslationManager::Cleaner.new(Rails.root.join("config", "locales")).clean
+    RailsTranslationManager::Cleaner.new(RailsTranslationManager.locale_root).clean
   end
 end

data/rails_translation_manager.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "rails-i18n"
 
   spec.add_development_dependency "bundler"
+  spec.add_development_dependency "climate_control"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "rspec"

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/incompatible_plurals_spec.rb

@@ -82,9 +82,9 @@ RSpec.describe IncompatiblePlurals do
           <<~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 'en'. See https://github.com/alphagov/rails_translation_manager/tree/master/docs/adding-editing-plural-forms.md
 
-            - \e[31m[ERROR]\e[0m Please add plural form for 'cy' <link to future documentation>
+            - \e[31m[ERROR]\e[0m Please add plural form for 'cy'. See https://github.com/alphagov/rails_translation_manager/tree/master/docs/adding-editing-plural-forms.md
 
             \e[1mIf the keys reported above are not plurals, rename them avoiding plural keywords: #{LocaleCheckerHelper::PLURAL_KEYS}\e[22m
           OUTPUT

data/spec/rails_translation_manager/locale_checker/missing_declared_locales_spec.rb

@@ -18,7 +18,7 @@ RSpec.describe MissingDeclaredLocales do
 
   context "when there are missing locales" do
     before do
-      I18n.available_locales = [:en, :cy, :pt]
+      I18n.available_locales = [:en, :CY, :pt]
     end
 
     it "outputs the missing locales" do

data/spec/rails_translation_manager_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+RSpec.describe RailsTranslationManager do
+  describe ".locale_root" do
+    it "uses the value of the environment variable RAILS_TRANSLATION_MANAGER_LOCALE_ROOT if this is set" do
+      ClimateControl.modify(RAILS_TRANSLATION_MANAGER_LOCALE_ROOT: "/path/to/locales") do
+        expect(RailsTranslationManager.locale_root).to eq(Pathname.new("/path/to/locales"))
+      end
+    end
+
+    it "will fall back to Rails default locale location if the environment isn't set" do
+      allow(Rails).to receive(:root).and_return(Pathname.new("/rails"))
+
+      ClimateControl.modify(RAILS_TRANSLATION_MANAGER_LOCALE_ROOT: nil) do
+        expect(RailsTranslationManager.locale_root).to eq(Pathname.new("/rails/config/locales"))
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "rails_translation_manager"
+require "climate_control"
 
 RSpec.configure do |config|
   config.before do

data/spec/tasks/translation_spec.rb

@@ -3,9 +3,9 @@ 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)
+    allow(RailsTranslationManager)
+      .to receive(:locale_root)
+      .and_return(Pathname.new("spec/config/locales"))
   end
 
   describe "translation:import", type: :task do
@@ -15,7 +15,7 @@ describe "rake tasks" do
 
     it "outputs to stdout" do
       expect { task.execute(csv_path: csv_path) }
-        .to output("\nImported CSV from: #{csv_path} to #{Rails.root.join("config", "locales")}\n")
+        .to output("\nImported CSV from: #{csv_path} to #{RailsTranslationManager.locale_root}\n")
         .to_stdout
     end
 
@@ -26,7 +26,7 @@ describe "rake tasks" do
         .to have_received(:new)
         .with(locale: "fr",
               csv_path: csv_path,
-              import_directory: Rails.root.join("config", "locales"),
+              import_directory: RailsTranslationManager.locale_root,
               multiple_files_per_language: false)
       expect(importer_instance).to have_received(:import)
     end
@@ -34,12 +34,12 @@ describe "rake tasks" do
 
   describe "translation:import:all", type: :task do
     let(:task) { Rake::Task["translation:import:all"] }
-    let(:csv_directory) { "locales/importer" }
+    let(:csv_directory) { "spec/locales/importer" }
     let!(:importer_instance) { stub_importer }
 
     it "outputs to stdout" do
       expect { task.execute(csv_directory: csv_directory) }
-        .to output("\nImported all CSVs from: #{csv_directory} to #{Rails.root.join("config", "locales")}\n")
+        .to output("\nImported all CSVs from: #{csv_directory} to #{RailsTranslationManager.locale_root}\n")
         .to_stdout
     end
 
@@ -52,7 +52,7 @@ describe "rake tasks" do
           .to have_received(:new)
           .with(locale: File.basename(csv_path, ".csv"),
                 csv_path: csv_path,
-                import_directory: Rails.root.join("config", "locales"),
+                import_directory: RailsTranslationManager.locale_root,
                 multiple_files_per_language: true)
       end
 
@@ -72,7 +72,7 @@ describe "rake tasks" do
       task.execute
       expect(RailsTranslationManager::Cleaner)
         .to have_received(:new)
-        .with(Rails.root.join("config", "locales"))
+        .with(RailsTranslationManager.locale_root)
       expect(cleaner_instance).to have_received(:clean)
     end
 
@@ -96,7 +96,7 @@ describe "rake tasks" do
       task.execute(locale_directory: "config/locales")
       expect(RailsTranslationManager::Cleaner)
         .to have_received(:new)
-        .with(Rails.root.join("config", "locales"))
+        .with(RailsTranslationManager.locale_root)
       expect(cleaner_instance).to have_received(:clean)
     end
 
@@ -118,7 +118,7 @@ describe "rake tasks" do
       task.execute(locale_directory: "config/locales")
       expect(RailsTranslationManager::Cleaner)
         .to have_received(:new)
-        .with(Rails.root.join("config", "locales"))
+        .with(RailsTranslationManager.locale_root)
       expect(cleaner_instance).to have_received(:clean)
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_translation_manager
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Edd Sowden
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-15 00:00:00.000000000 Z
+date: 2022-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: climate_control
+  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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -145,15 +159,16 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".ruby-version"
-- ".travis.yml"
 - CHANGELOG.md
-- CONTRIBUTING.md
 - Gemfile
 - Jenkinsfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - config/locales/plurals.rb
+- docs/adding-editing-plural-forms.md
+- docs/rake-command-reference.md
+- docs/translating-locale-files.md
 - lib/rails_translation_manager.rb
 - lib/rails_translation_manager/cleaner.rb
 - lib/rails_translation_manager/exporter.rb
@@ -193,6 +208,7 @@ files:
 - 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/rails_translation_manager_spec.rb
 - spec/spec_helper.rb
 - spec/support/tasks.rb
 - spec/tasks/translation_spec.rb
@@ -243,6 +259,7 @@ test_files:
 - 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/rails_translation_manager_spec.rb
 - spec/spec_helper.rb
 - spec/support/tasks.rb
 - spec/tasks/translation_spec.rb

data/.travis.yml

@@ -1,2 +0,0 @@
-rvm:
-  - 2.1.4

data/CONTRIBUTING.md

@@ -1,7 +0,0 @@
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request