i18n-hygiene 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f906fef080e1dbaa668f50b353fc861f709f1ca1
-  data.tar.gz: c79a6e97927517a08ac025ac2d8570a481de6b74
+  metadata.gz: 8a0ed252e0cc76261202f3e8c8224a9d2ba89d82
+  data.tar.gz: 70f696d78272fc56810a9243d8e12471865ec54f
 SHA512:
-  metadata.gz: 854a7ec8e067f52e39dd77a45f649af2a9f036208c25db7e81b0a34a786bcc8fea2e986aad6d3f32c7cc678f918aa3297f69a0aea090d605c752d96e11a21bff
-  data.tar.gz: 50bc730b81a6fd89a9ea58547548f5148c96c8ed8118d780271edb07df8cd540fa8a4d4ff45b6adb3b4b7a10c5e32ce3c12da3f1c46fa7278db0754b82764548
+  metadata.gz: b8226fec6814080e9240c23e6ad77ced8a38e7e301385f40c9f6cc43f5b7c707cfc7447f0fded226b67957c49f0c03ba42700b1e9eb75e4624c26c214cfd24f2
+  data.tar.gz: a49070ce84895f31cb18ce08936643aa7fcfaea784a79b578654181141e910fc7a3de3d90cc3a3098311bc2d4fda29871dbb07db092aea08b7a3fc85b5b35f8c

data/README.md

@@ -0,0 +1,109 @@
+# i18n-hygiene [![Build Status](https://travis-ci.org/conversation/i18n-hygiene.svg?branch=master)](https://travis-ci.org/conversation/i18n-hygiene)
+
+Provides a configurable rake task to help maintain your translations.
+
+Over the lifetime of a project there tends to be a lot of churn in the translation files. Contexts and meanings will change, features will be added and removed. You'll find that soon enough, translations fall out of use, mistakes by developers or translators will creep in. The longer this goes on, the harder it is to keep them neat and tidy.
+
+This tool is intended to be used as part of your continuous integration pipeline to keep your translations healthy and prevent issues from ever making it to production.
+
+## Usage
+
+Include the gem in your gemfile and bundle:
+
+`gem 'i18n-hygiene'`
+
+## Integrating with rake
+
+Create a rake task with the desired configuration. For example, this will create a rake task called `i18n:hygiene`:
+
+```ruby
+namespace :i18n do
+  I18n::Hygiene::RakeTask.new do |config|
+    config.directories = ["app", "lib"]
+  end
+end
+
+```
+
+You can then run the rake task with:
+```
+bundle exec rake i18n:hygiene
+```
+
+You could also create separate rake tasks with different names and configurations, this may be useful if you are in the middle of rolling out a new locale:
+```ruby
+namespace :i18n do
+  I18n::Hygiene::RakeTask.new(:hygiene_live) do |config|
+    config.locales = [:fr]
+  end
+
+  I18n::Hygiene::RakeTask.new(:hygiene_wip) do |config|
+    config.locales = [:es]
+  end
+end
+```
+
+Which could be run like:
+
+```
+bundle exec rake i18n:hygiene_live
+bundle exec rake i18n:hygiene_wip
+```
+
+## Configuration
+
+| Configuration | Default | Description |
+|---|---|---|
+| `concurrency` | Number of CPU cores | How many threads to use for key usage check |
+| `directories` | All | Directories to search for key usage |
+| `exclude_files` | None | Excludes files from key usage check |
+| `exclude_keys` | None | Exclude individual keys  |
+| `exclude_scopes` | None | Exclude groups of keys |
+| `file_extensions` | `rb, erb, coffee, js, jsx` | Only look in files with these extensions for key usage |
+| `primary_locale` | `I18n.default_locale` | Translations from other locales are checked against this |
+| `locales` | `I18n.available_locales` | Translations from these are checked against primary |
+
+Example using all configuration options:
+
+```ruby
+I18n::Hygiene::RakeTask.new do |config|
+  config.concurrency = 16
+  config.directories = ["app", "lib"]
+  config.exclude_files = ["README.md"]
+  config.file_extensions = ["rb", "jsx"]
+  config.primary_locale = :en
+  config.locales = [:ja, :kr]
+  config.exclude_keys = [
+    "my.dynamically.used.key",
+    "another.dynamically.used.key"
+  ]
+  config.exclude_scopes = [
+    "activerecord",
+    "countries"
+  ]
+end
+
+```
+
+#### Without Rails
+
+Using this gem without Rails is possible, but you'll need to load the translations manually first.
+
+```ruby
+namespace :i18n do
+  require 'i18n'
+  require 'i18n/hygiene'
+
+  I18n.load_path = Dir["locales/*.yml"]
+  I18n.backend.load_translations
+
+  I18n::Hygiene::RakeTask.new(:hygiene_live) do |config|
+    config.directories = ["src"]
+    config.locales = [:fr]
+  end
+end
+```
+
+## License
+
+MIT

data/lib/i18n/hygiene.rb

@@ -1,9 +1,6 @@
-require 'i18n/hygiene/railtie' if defined?(Rails)
 require 'i18n/hygiene/key_usage_checker'
-require 'i18n/hygiene/keys_with_entities'
 require 'i18n/hygiene/keys_with_matched_value'
-require 'i18n/hygiene/keys_with_return_symbol'
-require 'i18n/hygiene/keys_with_script_tags'
 require 'i18n/hygiene/locale_translations'
 require 'i18n/hygiene/variable_checker'
 require 'i18n/hygiene/wrapper'
+require 'i18n/hygiene/rake_task'

data/lib/i18n/hygiene/checks/base.rb

@@ -0,0 +1,26 @@
+module I18n
+  module Hygiene
+    module Checks
+      class Base
+        def initialize(config)
+          raise "Must pass an instance of Config" unless config.is_a?(I18n::Hygiene::Config)
+          @config = config
+        end
+
+        def run
+          raise "#run must be implemented by subclass"
+        end
+
+        protected
+
+        def config
+          @config
+        end
+
+        def all_locales
+          config.all_locales
+        end
+      end
+    end
+  end
+end

data/lib/i18n/hygiene/checks/html_entity.rb

@@ -0,0 +1,40 @@
+require 'i18n/hygiene/checks/base'
+require 'i18n/hygiene/keys_with_matched_value'
+require 'i18n/hygiene/result'
+require 'i18n/hygiene/wrapper'
+require 'i18n/hygiene/error_message_builder'
+
+module I18n
+  module Hygiene
+    module Checks
+      ##
+      # Looks for unexpected HTML entities (`&`, `!`) in translations.
+      class HtmlEntity < Base
+        ENTITY_REGEX = /&\w+;/
+
+        def run
+          wrapper = I18n::Hygiene::Wrapper.new(locales: all_locales, exclude_scopes: config.exclude_scopes)
+
+          keys_with_entities = I18n::Hygiene::KeysWithMatchedValue.new(ENTITY_REGEX, wrapper, reject_keys: reject_keys)
+
+          keys_with_entities.each do |locale, key|
+            message = ErrorMessageBuilder.new
+              .title("Unexpected HTML entity")
+              .locale(locale)
+              .key(key)
+              .translation(wrapper.value(locale, key))
+              .create
+
+            yield Result.new(:failure, message: message)
+          end
+        end
+
+        private
+
+        def reject_keys
+          Proc.new { |key| key.end_with?("_html") || key.end_with?("_markdown") }
+        end
+      end
+    end
+  end
+end

data/lib/i18n/hygiene/checks/key_usage.rb

@@ -0,0 +1,42 @@
+require 'parallel'
+require 'i18n/hygiene/wrapper'
+require 'i18n/hygiene/checks/base'
+require 'i18n/hygiene/key_usage_checker'
+require 'i18n/hygiene/result'
+require 'i18n/hygiene/error_message_builder'
+
+module I18n
+  module Hygiene
+    module Checks
+      ##
+      # Ensures that existing translations are actually used.
+      class KeyUsage < Base
+        def run
+          key_usage_checker = I18n::Hygiene::KeyUsageChecker.new(
+            directories: config.directories,
+            exclude_files: config.exclude_files,
+            file_extensions: config.file_extensions
+          )
+
+          wrapper = I18n::Hygiene::Wrapper.new(
+            exclude_keys: config.exclude_keys,
+            exclude_scopes: config.exclude_scopes
+          )
+
+          Parallel.each(wrapper.keys_to_check(config.primary_locale), in_threads: config.concurrency) do |key|
+            if key_usage_checker.used?(key)
+              yield Result.new(:pass, message: ".")
+            else
+              message = ErrorMessageBuilder.new
+                .title("Unused translation")
+                .key(key)
+                .create
+
+              yield Result.new(:failure, message: message)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/i18n/hygiene/checks/missing_interpolation_variable.rb

@@ -0,0 +1,37 @@
+require 'i18n/hygiene/wrapper'
+require 'i18n/hygiene/checks/base'
+require 'i18n/hygiene/variable_checker'
+require 'i18n/hygiene/result'
+require 'i18n/hygiene/error_message_builder'
+
+module I18n
+  module Hygiene
+    module Checks
+      ##
+      # Looks for translations which are missing interpolation variables.
+      class MissingInterpolationVariable < Base
+        def run
+          wrapper = I18n::Hygiene::Wrapper.new(exclude_scopes: config.exclude_scopes)
+
+          wrapper.keys_to_check(config.primary_locale).select do |key|
+            checker = I18n::Hygiene::VariableChecker.new(key, wrapper, config.primary_locale, config.locales)
+
+            checker.mismatched_variables do |locale, key, missing_variables|
+              if missing_variables.any?
+                message = ErrorMessageBuilder.new
+                  .title("Missing interpolation variable(s)")
+                  .locale(locale)
+                  .key(key)
+                  .translation(wrapper.value(locale, key))
+                  .expected(missing_variables.join(", "))
+                  .create
+
+                yield Result.new(:failure, message: message)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/i18n/hygiene/checks/script_tag.rb

@@ -0,0 +1,34 @@
+require 'i18n/hygiene/checks/base'
+require 'i18n/hygiene/keys_with_matched_value'
+require 'i18n/hygiene/result'
+require 'i18n/hygiene/wrapper'
+require 'i18n/hygiene/error_message_builder'
+
+module I18n
+  module Hygiene
+    module Checks
+      ##
+      # Looks for unexpected script tags in translations.
+      class ScriptTag < Base
+        SCRIPT_TAG_REGEX = /<script.*/
+
+        def run
+          wrapper = I18n::Hygiene::Wrapper.new(locales: all_locales, exclude_scopes: config.exclude_scopes)
+
+          keys_with_script_tags = I18n::Hygiene::KeysWithMatchedValue.new(SCRIPT_TAG_REGEX, wrapper)
+
+          keys_with_script_tags.each do |locale, key|
+            message = ErrorMessageBuilder.new
+              .title("Unexpected script tag")
+              .locale(locale)
+              .key(key)
+              .translation(wrapper.value(locale, key))
+              .create
+
+            yield Result.new(:failure, message: message)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/i18n/hygiene/checks/unexpected_return_symbol.rb

@@ -0,0 +1,34 @@
+require 'i18n/hygiene/checks/base'
+require 'i18n/hygiene/keys_with_matched_value'
+require 'i18n/hygiene/result'
+require 'i18n/hygiene/error_message_builder'
+
+module I18n
+  module Hygiene
+    module Checks
+      ##
+      # Looks for unexpected return symbols (U+23CE) in translations.
+      #
+      # This check is fairly specific to PhraseApp, where U+23CE has special meaning.
+      class UnexpectedReturnSymbol < Base
+        RETURN_SYMBOL_REGEX = /\u23ce/
+
+        def run
+          wrapper = I18n::Hygiene::Wrapper.new(locales: all_locales, exclude_scopes: config.exclude_scopes)
+          keys_with_return_symbols = I18n::Hygiene::KeysWithMatchedValue.new(RETURN_SYMBOL_REGEX, wrapper)
+
+          keys_with_return_symbols.each do |locale, key|
+            message = ErrorMessageBuilder.new
+              .title("Unexpected return symbol (U+23CE)")
+              .locale(locale)
+              .key(key)
+              .translation(wrapper.value(locale, key))
+              .create
+
+            yield Result.new(:failure, message: message)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/i18n/hygiene/config.rb

@@ -0,0 +1,52 @@
+require 'parallel'
+
+module I18n
+  module Hygiene
+    class Config
+      attr_writer :exclude_files
+      attr_writer :directories
+      attr_writer :file_extensions
+      attr_writer :primary_locale
+      attr_writer :locales
+      attr_writer :exclude_keys
+      attr_writer :concurrency
+      attr_writer :exclude_scopes
+
+      def exclude_files
+        @exclude_files ||= []
+      end
+
+      def directories
+        @directories ||= []
+      end
+
+      def file_extensions
+        @file_extensions ||= ["rb", "erb", "coffee", "js", "jsx"]
+      end
+
+      def primary_locale
+        @primary_locale ||= ::I18n.default_locale
+      end
+
+      def locales
+        @locales ||= ::I18n.available_locales
+      end
+
+      def all_locales
+        [primary_locale] + locales
+      end
+
+      def exclude_keys
+        @exclude_keys ||= []
+      end
+
+      def concurrency
+        @concurrency || Parallel.processor_count
+      end
+
+      def exclude_scopes
+        @exclude_scopes ||= []
+      end
+    end
+  end
+end

data/lib/i18n/hygiene/error_message_builder.rb

@@ -0,0 +1,82 @@
+require 'rainbow'
+
+module  I18n
+  module Hygiene
+    class ErrorMessageBuilder
+      LEFT_PAD = " " * 2
+      TRUNCATE_LIMIT = 48
+
+      def initialize
+        @title = "Unspecified Error"
+        @key = "unknown_key"
+        @locale = nil
+        @translation = nil
+        @location = nil
+      end
+
+      def title(title)
+        @title = title
+        self
+      end
+
+      def locale(locale)
+        @locale = locale
+        self
+      end
+
+      def key(key)
+        @key = key
+        self
+      end
+
+      def expected(expected)
+        @expected = expected
+        self
+      end
+
+      def translation(translation)
+        @translation = translation
+        self
+      end
+
+      def create
+        s = StringIO.new
+        s << "\n"
+        s << Rainbow("i18n-hygiene/#{@title}:").red
+        s << "\n"
+        s << LEFT_PAD
+
+        if @locale
+          s << "#{@locale}."
+        end
+
+        s << @key
+
+        if @translation
+          s << ": "
+          s << Rainbow("\"#{truncated_translation}\"").yellow
+        end
+
+        if @expected
+          s << "\n"
+          s << LEFT_PAD * 2
+          s << "Expected: "
+          s << Rainbow(@expected).color(:orange)
+        end
+
+        s << "\n"
+        s.string
+      end
+
+      private
+
+      def truncated_translation
+        if @translation.length > TRUNCATE_LIMIT
+          @translation[0..TRUNCATE_LIMIT] + "..."
+        else
+          @translation
+        end
+      end
+    end
+  end
+end

data/lib/i18n/hygiene/key_usage_checker.rb

@@ -1,50 +1,61 @@
 module I18n
   module Hygiene
-    # Checks the usage of i18n keys in the TC codebase.
-    #
-    # TODO: This class needs some work, I had to strip out a bunch of functionality around
-    # the dynamically used keys because it was all specific to TC.
-    #
-    # We need to add a way to configure the hygiene checks to "whitelist" certain dynamic
-    # keys and so on.
-    #
-    # The other issue is that we hard code the folders we scan for fully qualified keys
-    # which should also be configurable.
+    # Checks the usage of i18n keys in the codebase.
     class KeyUsageChecker
 
-      attr_reader :key
+      def initialize(directories:, exclude_files: [], file_extensions: [])
+        @directories = directories
+        @exclude_files = exclude_files
+        @file_extensions = file_extensions
 
-      def initialize(key)
-        @key = key
+        raise "Must have git installed!" unless system("which git > /dev/null")
       end
 
-      def used_in_codebase?
-        fully_qualified_key_used?
+      def used?(key)
+        i18n_config_key?(key) || fully_qualified_key_used?(key)
       end
 
-      def fully_qualified_key_used?(given_key = key)
-        if pluralized_key_used?(given_key)
-          fully_qualified_key_used?(without_last_part)
+      private
+
+      def fully_qualified_key_used?(key)
+        if pluralized_key_used?(key)
+          fully_qualified_key_used?(without_last_part(key))
         else
-          %x<#{ag_or_ack} #{given_key} app lib | wc -l>.strip.to_i > 0
+          %x<git grep #{key} #{git_grep_options} | wc -l>.strip.to_i > 0
         end
       end
 
-      private
+      def git_grep_options
+        [git_grep_include, git_grep_exclude].reject(&:empty?).join(" ")
+      end
 
-      def ag_or_ack
-        if %x<which ag | wc -l>.strip.to_i == 1
-          return "ag"
-        else
-          return "ack --type-add=js=.coffee"
-        end
+      def git_grep_include
+        @directories.map { |dir|
+          if @file_extensions.empty?
+            dir
+          else
+            @file_extensions.map { |ext|
+              "'#{dir}/*.#{ext}'"
+            }
+          end
+        }.flatten.join(" ")
+      end
+
+      def git_grep_exclude
+        @exclude_files.map { |file|
+          "':(exclude)*#{file}'"
+        }.join(" ")
+      end
+
+      def i18n_config_key?(key)
+        key.start_with?("i18n.")
       end
 
       def pluralized_key_used?(key)
         [ "zero", "one", "other" ].include?(key.split(".").last)
       end
 
-      def without_last_part
+      def without_last_part(key)
         key.split(".")[0..-2].join(".")
       end
 

data/lib/i18n/hygiene/keys_with_matched_value.rb

@@ -6,23 +6,20 @@ module I18n
 
       def initialize(regex, i18n_wrapper = nil, reject_keys: nil)
         @regex = regex
-        @i18n = i18n_wrapper || I18n::Hygiene::Wrapper.new
+        @i18n = i18n_wrapper || I18n::Hygiene::Wrapper.new(exclude_keys: [])
         @reject_keys = reject_keys
-        @matching_keys = load_matching_keys
       end
 
       def each(&block)
-        @matching_keys.each(&block)
+        locales.each do |locale|
+          matching_keys(locale).each do |key|
+            block.call(locale, key)
+          end
+        end
       end
 
       private
 
-      def load_matching_keys
-        locales.inject([]) do |results, locale|
-          results + matching_keys(locale).map { |key| "#{locale}: #{key}" }
-        end
-      end
-
       def matching_keys(locale)
         keys_to_check(locale).select { |key| i18n.value(locale, key).to_s.match(regex) }
       end

data/lib/i18n/hygiene/locale_translations.rb

@@ -10,52 +10,30 @@ module I18n
       # These are i18n keys provided by Rails. We cannot exclude them at the :helpers
       # scope level because we do have some TC i18n keys scoped within :helpers.
 
-      # TODO: make this configurable
-      KEYS_TO_SKIP = [
-        "helpers.select.prompt",
-        "helpers.submit.create",
-        "helpers.submit.submit",
-        "helpers.submit.update"
-      ]
-
-      def initialize(translations)
+      def initialize(translations:, exclude_keys:, exclude_scopes:)
         @translations = translations
+        @exclude_keys = exclude_keys || []
+        @exclude_scopes = exclude_scopes || []
       end
 
       def keys_to_check
         fully_qualified_keys(translations_to_check).reject { |key|
-          KEYS_TO_SKIP.include?(key) || EXAMPLE_KEY == key
+          exclude_keys.include?(key) || EXAMPLE_KEY == key
         }.sort
       end
 
       private
 
       def translations_to_check
-        @translations.reject { |k, _v| non_tc_scopes.include? k }
-      end
-
-      def non_tc_scopes
-        scopes_from_rails + scopes_from_devise + scopes_from_kaminari + scopes_from_i18n_country_select + scopes_from_faker
-      end
-
-      def scopes_from_rails
-        [ :activerecord, :date, :datetime, :errors, :number, :support, :time ]
-      end
-
-      def scopes_from_devise
-        [ :devise ]
-      end
-
-      def scopes_from_kaminari
-        [ :views ]
+        @translations.reject { |k, _v| exclude_scopes.include? k }
       end
 
-      def scopes_from_i18n_country_select
-        [ :countries ]
+      def exclude_keys
+        @exclude_keys
       end
 
-      def scopes_from_faker
-        [ :faker ]
+      def exclude_scopes
+        @exclude_scopes
       end
 
       def fully_qualified_keys(hash)

data/lib/i18n/hygiene/rake_task.rb

@@ -0,0 +1,72 @@
+require 'rake'
+require 'rake/tasklib'
+require 'i18n/hygiene/config'
+require 'i18n/hygiene/reporter'
+require 'i18n/hygiene/checks/html_entity'
+require 'i18n/hygiene/checks/key_usage'
+require 'i18n/hygiene/checks/missing_interpolation_variable'
+require 'i18n/hygiene/checks/script_tag'
+require 'i18n/hygiene/checks/unexpected_return_symbol'
+
+module I18n
+  module Hygiene
+    class RakeTask < ::Rake::TaskLib
+      CHECKS = [
+        I18n::Hygiene::Checks::KeyUsage,
+        I18n::Hygiene::Checks::MissingInterpolationVariable,
+        I18n::Hygiene::Checks::HtmlEntity,
+        I18n::Hygiene::Checks::ScriptTag,
+        I18n::Hygiene::Checks::UnexpectedReturnSymbol,
+      ]
+
+      def initialize(task_name = :hygiene, &block)
+        config = Config.new
+
+        if block
+          block.call(config)
+
+          # We always want to exclude the file that is configuring this rake task
+          config.exclude_files = config.exclude_files + [relative_path_for(block.source_location)]
+        end
+
+        unless ::Rake.application.last_description
+          desc %(Check i18n hygiene)
+        end
+
+        task(task_name => dependencies) do
+          checks = configure_checks(config)
+
+          checks.each do |check|
+            check.run do |result|
+              reporter.concat(result)
+            end
+          end
+
+          reporter.report
+
+          exit(1) unless reporter.passed?
+        end
+      end
+
+      private
+
+      def relative_path_for(source_location)
+        source_location[0].gsub("#{pwd}/", "")
+      end
+
+      def reporter
+        @reporter ||= Reporter.new
+      end
+
+      def configure_checks(config)
+        CHECKS.map do |check|
+          check.new(config)
+        end
+      end
+
+      def dependencies
+        [:environment] if defined?(Rails)
+      end
+    end
+  end
+end

data/lib/i18n/hygiene/reporter.rb

@@ -0,0 +1,43 @@
+require 'rainbow'
+
+module I18n
+  module Hygiene
+    class Reporter
+      def concat(result)
+        print_progress(result)
+
+        results.push(result)
+      end
+
+      def results
+        @results ||= []
+      end
+
+      def passed?
+        results.all? { |result| result.passed? }
+      end
+
+      def report
+        if passed?
+          puts Rainbow("\ni18n hygiene checks passed.").green
+        else
+          puts Rainbow("\ni18n hygiene checks failed.").red
+        end
+      end
+
+      private
+
+      def result_color(result)
+        if result.passed?
+          :green
+        else
+          :red
+        end
+      end
+
+      def print_progress(result)
+        print Rainbow(result.message).color(result_color(result))
+      end
+    end
+  end
+end

data/lib/i18n/hygiene/result.rb

@@ -0,0 +1,23 @@
+module I18n
+  module Hygiene
+    class Result
+      attr_reader :message
+
+      def initialize(status, message: "")
+        @status = status
+        @message = message
+      end
+
+      def passed?
+        case @status
+        when :pass
+          true
+        when :failure
+          false
+        else
+          raise "Unsupported status"
+        end
+      end
+    end
+  end
+end

data/lib/i18n/hygiene/variable_checker.rb

@@ -4,55 +4,29 @@ module I18n
     # as defined in :en contains an interpolation variable, the value for that key as defined
     # in any other locale must have a matching variable name.
     class VariableChecker
-
-      NON_ENGLISH_LOCALES_TO_CHECK = [ :fr_fr ]
-
-      def initialize(key, i18n_wrapper)
+      def initialize(key, i18n_wrapper, primary_locale, locales = [])
         @key = key
         @i18n_wrapper = i18n_wrapper
+        @primary_locale = primary_locale
+        @locales = locales
       end
 
-      def mismatched_variables_found?
-        NON_ENGLISH_LOCALES_TO_CHECK.each do |locale|
-          if key_defined?(locale)
-            return true unless variables_match?(locale)
-          end
-        end
-        false
-      end
-
-      def mismatch_details
-        if mismatched_variables_found?
-          details_array = []
-          NON_ENGLISH_LOCALES_TO_CHECK.each do |locale|
-            if key_defined?(locale)
-              details_array << mismatch_details_for_locale(locale) unless variables_match?(locale)
-            end
-          end
-          return details_array.join("\n")
-        else
-          return "#{@key}: no missing interpolation variables found."
-        end
+      def mismatched_variables
+        @locales.each { |locale| yield locale, @key, missing_variables(locale) }
       end
 
       private
 
-      def mismatch_details_for_locale(locale)
-        "#{@key} for locale #{locale} is missing interpolation variable(s): #{missing_variables(locale)}"
-      end
-
       def missing_variables(locale)
-        variables(:en).reject { |v| variables(locale).include?(v) }.join(', ')
+        return [] unless key_defined?(locale)
+
+        variables(@primary_locale).reject { |v| variables(locale).include?(v) }
       end
 
       def key_defined?(locale)
         @i18n_wrapper.key_found?(locale, @key)
       end
 
-      def variables_match?(locale)
-        variables(locale) == variables(:en)
-      end
-
       def variables(locale)
         collect_variables(@i18n_wrapper.value(locale, @key))
       end

data/lib/i18n/hygiene/wrapper.rb

@@ -1,3 +1,6 @@
+require 'i18n'
+require 'i18n/hygiene/locale_translations'
+
 module I18n
   module Hygiene
     # Utility class for interacting with i18n definitions. This is not intended to be used
@@ -5,12 +8,22 @@ module I18n
     # queryable.
     class Wrapper
 
-      def keys_to_check(locale = :en)
-        I18n::Hygiene::LocaleTranslations.new(translations[locale]).keys_to_check
+      def initialize(exclude_keys: [], exclude_scopes: [], locales: ::I18n.available_locales)
+        @locales = locales
+        @exclude_keys = exclude_keys
+        @exclude_scopes = exclude_scopes
+      end
+
+      def keys_to_check(locale)
+        I18n::Hygiene::LocaleTranslations.new(
+          translations: translations[locale],
+          exclude_keys: exclude_keys,
+          exclude_scopes: exclude_scopes
+        ).keys_to_check
       end
 
       def locales
-        translations.keys
+        @locales
       end
 
       def key_found?(locale, key)
@@ -21,7 +34,7 @@ module I18n
 
       def value(locale, key)
         I18n.with_locale(locale) do
-          I18n.t(key)
+          I18n.t(key, resolve: false)
         end
       end
 
@@ -36,6 +49,14 @@ module I18n
         ::I18n.backend.send(:init_translations)
       end
 
+      def exclude_keys
+        @exclude_keys
+      end
+
+      def exclude_scopes
+        @exclude_scopes
+      end
+
     end
   end
 end

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: i18n-hygiene
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
+- Eleanor Kiefel Haggerty
+- Keith Pitty
 - Nick Browne
-- " Keith Pitty"
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-26 00:00:00.000000000 Z
+date: 2017-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -45,6 +46,40 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.99.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.99.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.7
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -59,29 +94,57 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Provides rake tasks to help maintain translations.
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  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: Provides a configurable rake task that checks locale data for likely
+  issues. Intended to be used in build pipelines to detect problems before they reach
+  production
 email: dev@theconversation.edu.au
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
+- README.md
 - lib/i18n/hygiene.rb
+- lib/i18n/hygiene/checks/base.rb
+- lib/i18n/hygiene/checks/html_entity.rb
+- lib/i18n/hygiene/checks/key_usage.rb
+- lib/i18n/hygiene/checks/missing_interpolation_variable.rb
+- lib/i18n/hygiene/checks/script_tag.rb
+- lib/i18n/hygiene/checks/unexpected_return_symbol.rb
+- lib/i18n/hygiene/config.rb
+- lib/i18n/hygiene/error_message_builder.rb
 - lib/i18n/hygiene/key_usage_checker.rb
-- lib/i18n/hygiene/keys_with_entities.rb
 - lib/i18n/hygiene/keys_with_matched_value.rb
-- lib/i18n/hygiene/keys_with_return_symbol.rb
-- lib/i18n/hygiene/keys_with_script_tags.rb
 - lib/i18n/hygiene/locale_translations.rb
-- lib/i18n/hygiene/railtie.rb
+- lib/i18n/hygiene/rake_task.rb
+- lib/i18n/hygiene/reporter.rb
+- lib/i18n/hygiene/result.rb
 - lib/i18n/hygiene/variable_checker.rb
 - lib/i18n/hygiene/wrapper.rb
-- lib/tasks/i18n_hygiene.rake
 homepage: https://github.com/conversation/i18n-hygiene
 licenses:
 - MIT
 metadata: {}
 post_install_message: 
-rdoc_options: []
+rdoc_options:
+- "--title"
+- i18n-hygiene documentation
+- "--main"
+- README.md
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -96,8 +159,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
-summary: Helps maintain translations.
+summary: A linter for translation data in ruby applications
 test_files: []

data/lib/i18n/hygiene/keys_with_entities.rb

@@ -1,29 +0,0 @@
-require 'enumerator'
-
-module I18n
-  module Hygiene
-    # A collection of Strings that indicate the i18n keys in any locale that contain
-    # entities which are likely to be rendered incorrectly. Only keys ending in _html
-    # or _markdown may contain entities.
-    #
-    class KeysWithEntities
-      include Enumerable
-
-      ENTITY_REGEX = /&\w+;/
-
-      def initialize(i18nwrapper: nil)
-        @matcher = I18n::Hygiene::KeysWithMatchedValue.new(ENTITY_REGEX, i18nwrapper, reject_keys: reject_keys)
-      end
-
-      def each(&block)
-        @matcher.each(&block)
-      end
-
-      private
-
-      def reject_keys
-        Proc.new { |key| key.end_with?("_html") || key.end_with?("_markdown") }
-      end
-    end
-  end
-end

data/lib/i18n/hygiene/keys_with_return_symbol.rb

@@ -1,21 +0,0 @@
-require 'enumerator'
-
-module I18n
-  module Hygiene
-    # Checks to see if any i18n values contain the U+23CE character.
-    # It has been included in PhraseApp translations but is unwanted.
-    class KeysWithReturnSymbol
-      include Enumerable
-
-      RETURN_SYMBOL_REGEX = /\u23ce/
-
-      def initialize(i18n_wrapper: nil)
-        @matcher = I18n::Hygiene::KeysWithMatchedValue.new(RETURN_SYMBOL_REGEX, i18n_wrapper)
-      end
-
-      def each(&block)
-        @matcher.each(&block)
-      end
-    end
-  end
-end

data/lib/i18n/hygiene/keys_with_script_tags.rb

@@ -1,21 +0,0 @@
-require 'enumerator'
-
-module I18n
-  module Hygiene
-    # Checks to see if any i18n values contain script tags.
-    # We should never allow script tags!
-    class KeysWithScriptTags
-      include Enumerable
-
-      SCRIPT_TAG_REGEX = /<script>.*<\/script>/
-
-      def initialize(i18n_wrapper: nil)
-        @matcher = I18n::Hygiene::KeysWithMatchedValue.new(SCRIPT_TAG_REGEX, i18n_wrapper)
-      end
-
-      def each(&block)
-        @matcher.each(&block)
-      end
-    end
-  end
-end

data/lib/i18n/hygiene/railtie.rb

@@ -1,9 +0,0 @@
-module I18n
-  module Hygiene
-    class Railtie < Rails::Railtie
-      rake_tasks do
-        load "tasks/i18n_hygiene.rake"
-      end
-    end
-  end
-end

data/lib/tasks/i18n_hygiene.rake

@@ -1,87 +0,0 @@
-namespace :i18n do
-  namespace :hygiene do
-
-    desc 'run all the i18n hygiene checks'
-    task all: [:check_key_usage, :check_variables, :check_entities, :check_return_symbols, :check_script_tags]
-
-    desc "check usage of all EN keys"
-    task check_key_usage: :environment do
-      require 'parallel'
-
-      puts "Checking usage of EN keys..."
-      puts "(Please be patient while the codebase is searched for key usage)"
-
-      unused_keys = Parallel.map(I18n::Hygiene::Wrapper.new.keys_to_check) { |key|
-        key unless I18n::Hygiene::KeyUsageChecker.new(key).used_in_codebase?
-      }.compact
-
-      unused_keys.each do |key|
-        puts "#{key} is unused."
-      end
-
-      puts "Finished checking.\n\n"
-
-      exit(1) if unused_keys.any?
-    end
-
-    desc "check for mismatching interpolation variables"
-    task check_variables: :environment do
-      puts "Checking for mismatching interpolation variables..."
-
-      wrapper = I18n::Hygiene::Wrapper.new
-
-      mismatched_variables = wrapper.keys_to_check.select do |key|
-        checker = I18n::Hygiene::VariableChecker.new(key, wrapper)
-        checker.mismatch_details if checker.mismatched_variables_found?
-      end
-
-      mismatched_variables.each { |details| puts details }
-
-      puts "Finished checking.\n\n"
-
-      exit(1) if mismatched_variables.any?
-    end
-
-    desc "check for i18n phrases that contain entities"
-    task check_entities: :environment do
-      puts "Checking for phrases that contain entities but probably shouldn't..."
-
-      keys_with_entities = I18n::Hygiene::KeysWithEntities.new
-
-      keys_with_entities.each do |key|
-        puts "- #{key}"
-      end
-
-      puts "Finished checking.\n\n"
-
-      exit(1) if keys_with_entities.any?
-    end
-
-    desc "Check there are no values containing return symbols"
-    task check_return_symbols: :environment do
-      puts "Checking that no values contain return symbols i.e. U+23CE ..."
-
-      keys_with_return_symbols = I18n::Hygiene::KeysWithReturnSymbol.new
-
-      keys_with_return_symbols.each { |key| puts "- #{key}" }
-
-      puts "Finished checking.\n\n"
-
-      exit(1) if keys_with_return_symbols.any?
-    end
-
-    desc "Check there are no values containing scripts"
-    task check_script_tags: :environment do
-      puts "Checking that no values contain script tags ..."
-
-      keys_with_script_tags = I18n::Hygiene::KeysWithScriptTags.new
-
-      keys_with_script_tags.each { |key| puts " - #{key}" }
-
-      puts "Finished checking.\n\n"
-
-      exit(1) if keys_with_script_tags.any?
-    end
-
-  end
-end