i18n-tasks 0.9.2 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0b8ce2a23eb7fc9f59cdc7b993e17a0a1f4eb29
-  data.tar.gz: aedad8826903bf2d429f7486dcea8cbdf2b2492d
+  metadata.gz: b5b15ad428fdc29cc404d033f363c08708f5b815
+  data.tar.gz: c5aaaecace6c6024d544ff552c06097b9ec2f252
 SHA512:
-  metadata.gz: 42fb46c4e26ef0f09bdf641b332110b43c43caa3a402371d334e54773cdfa31cfc48da0a5c5fcd7b8baad0695519071aeab4634fec85065a3733e6bcc8e0fbe6
-  data.tar.gz: 0be2ce49e12dc3f2f77222cd8028dcd04de5584435c859bed50a60dcee3c3c685aeb5878c8e5d5959baecf4b91ff1999ec71f93a5f13ab969871ed7fd8c4df41
+  metadata.gz: 54586d8f4fb14861a755a75325ccf73230b9e180bc590f2f7fd383dc6c10c3529943179709d1d8045873148530684625c92a53d9b997281b9078acac51c40699
+  data.tar.gz: 693ff45562b53f09a0c5baf81b0d5418227e35d182f81e51cdff99c740b2a4666c39bbf3ea84f9d64daafb5ce34b454a59410b3c73a03fadf35c3b9ee98244bb

data/README.md

@@ -24,7 +24,7 @@ i18n-tasks can be used with any project using the ruby [i18n gem][i18n-gem] (def
 Add i18n-tasks to the Gemfile:
 
 ```ruby
-gem 'i18n-tasks', '~> 0.9.1'
+gem 'i18n-tasks', '~> 0.9.3'
 ```
 
 Copy the default [configuration file](#configuration):
@@ -159,6 +159,11 @@ See the full list of tasks with `i18n-tasks --help`.
 
 ✔ Plural keys, such as `key.{one,many,other,...}` are fully supported.
 
+#### Reference keys
+
+✔ Reference keys (keys with `:symbol` values) are fully supported. These keys are copied as-is in
+`add/translate-missing`, and can be looked up by reference or value in `find`.
+
 #### `t()` keyword arguments
 
 ✔ `scope` keyword argument is fully supported by the AST scanner, and also by the Regexp scanner but only when it is the first argument.

data/lib/i18n/tasks.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # define all the modules to be able to use ::
 module I18n
   module Tasks

data/lib/i18n/tasks/base_task.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
 require 'i18n/tasks/command_error'
 require 'i18n/tasks/split_key'
 require 'i18n/tasks/key_pattern_matching'
 require 'i18n/tasks/logging'
 require 'i18n/tasks/plural_keys'
+require 'i18n/tasks/references'
 require 'i18n/tasks/html_keys'
 require 'i18n/tasks/used_keys'
 require 'i18n/tasks/ignore_keys'
@@ -22,6 +24,7 @@ module I18n
       include SplitKey
       include KeyPatternMatching
       include PluralKeys
+      include References
       include HtmlKeys
       include UsedKeys
       include IgnoreKeys

data/lib/i18n/tasks/cli.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'i18n/tasks'
 require 'i18n/tasks/commands'
 require 'optparse'

data/lib/i18n/tasks/command/collection.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'i18n/tasks/command/dsl'
 require 'i18n/tasks/command/options/common'
 require 'i18n/tasks/command/options/locales'

data/lib/i18n/tasks/command/commander.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'i18n/tasks/cli'
 require 'i18n/tasks/reports/terminal'
 require 'i18n/tasks/reports/spreadsheet'

data/lib/i18n/tasks/command/commands/data.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module I18n::Tasks
   module Command
     module Commands

data/lib/i18n/tasks/command/commands/eq_base.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module I18n::Tasks
   module Command
     module Commands

data/lib/i18n/tasks/command/commands/health.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module I18n::Tasks
   module Command
     module Commands

data/lib/i18n/tasks/command/commands/meta.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module I18n::Tasks
   module Command
     module Commands

data/lib/i18n/tasks/command/commands/missing.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'i18n/tasks/command/collection'
 
 module I18n::Tasks

data/lib/i18n/tasks/command/commands/tree.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module I18n::Tasks
   module Command
     module Commands

data/lib/i18n/tasks/command/commands/usages.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module I18n::Tasks
   module Command
     module Commands
@@ -15,7 +16,7 @@ module I18n::Tasks
 
         def find(opt = {})
           opt[:filter] ||= opt.delete(:pattern) || opt[:arguments].try(:first)
-          print_forest i18n.used_tree(strict: opt[:strict], key_filter: opt[:filter].presence), opt, :used_keys
+          print_forest i18n.used_tree(strict: opt[:strict], key_filter: opt[:filter].presence, include_raw_references: true), opt, :used_keys
         end
 
         cmd :unused,

data/lib/i18n/tasks/command/commands/xlsx.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module I18n::Tasks
   module Command
     module Commands

data/lib/i18n/tasks/command/dsl.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module I18n::Tasks
   module Command
     module DSL

data/lib/i18n/tasks/command/option_parsers/enum.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module I18n::Tasks
   module Command
     module OptionParsers

data/lib/i18n/tasks/command/option_parsers/locale.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module I18n::Tasks
   module Command
     module OptionParsers

data/lib/i18n/tasks/command/options/common.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'i18n/tasks/command/dsl'
 
 module I18n::Tasks

data/lib/i18n/tasks/command/options/data.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'i18n/tasks/command/option_parsers/enum'
 
 module I18n::Tasks

data/lib/i18n/tasks/command/options/locales.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'i18n/tasks/command/option_parsers/locale'
 
 module I18n::Tasks

data/lib/i18n/tasks/command_error.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module I18n
   module Tasks
     # When this type of error is caught:

data/lib/i18n/tasks/commands.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'i18n/tasks/command/dsl'
 require 'i18n/tasks/command/collection'
 require 'i18n/tasks/command/commands/health'

data/lib/i18n/tasks/configuration.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module I18n::Tasks::Configuration
   DEFAULTS = {
       base_locale:     'en'.freeze,

data/lib/i18n/tasks/console_context.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module I18n::Tasks
   class ConsoleContext < BaseTask
     def to_s

data/lib/i18n/tasks/data.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'i18n/tasks/data/file_system'
 
 module I18n::Tasks
@@ -10,7 +11,7 @@ module I18n::Tasks
     # @see I18n::Tasks::Data::FileSystem
     def data
       @data ||= begin
-        data_config   = (config[:data] || {}).deep_symbolize_keys
+        data_config = (config[:data] || {}).deep_symbolize_keys
         data_config.merge!(base_locale: base_locale, locales: config[:locales])
         adapter_class = data_config[:adapter].presence || data_config[:class].presence || DATA_DEFAULTS[:adapter]
         adapter_class = adapter_class.to_s

data/lib/i18n/tasks/data/adapter/json_adapter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'json'
 
 module I18n::Tasks

data/lib/i18n/tasks/data/adapter/yaml_adapter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'yaml'
 module I18n::Tasks
   module Data

data/lib/i18n/tasks/data/file_formats.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'fileutils'
 
 module I18n

data/lib/i18n/tasks/data/file_system.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'i18n/tasks/data/file_system_base'
 require 'i18n/tasks/data/adapter/json_adapter'
 require 'i18n/tasks/data/adapter/yaml_adapter'

data/lib/i18n/tasks/data/file_system_base.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'i18n/tasks/data/tree/node'
 require 'i18n/tasks/data/router/pattern_router'
 require 'i18n/tasks/data/router/conservative_router'

data/lib/i18n/tasks/data/router/conservative_router.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'i18n/tasks/data/router/pattern_router'
 
 module I18n::Tasks

data/lib/i18n/tasks/data/router/pattern_router.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'i18n/tasks/key_pattern_matching'
 require 'i18n/tasks/data/tree/node'
 

data/lib/i18n/tasks/data/tree/node.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 require 'i18n/tasks/data/tree/traversal'
 require 'i18n/tasks/data/tree/siblings'
@@ -73,6 +74,10 @@ module I18n::Tasks::Data::Tree
       @data.present?
     end
 
+    def reference?
+      value.is_a?(Symbol)
+    end
+
     def get(key)
       children.get(key)
     end

data/lib/i18n/tasks/data/tree/nodes.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 require 'i18n/tasks/data/tree/traversal'
 module I18n::Tasks::Data::Tree

data/lib/i18n/tasks/data/tree/siblings.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'set'
 require 'i18n/tasks/split_key'
 require 'i18n/tasks/data/tree/nodes'
@@ -108,13 +109,12 @@ module I18n::Tasks::Data::Tree
       derive.append!(nodes)
     end
 
-    def merge!(nodes)
+    # @param on_leaves_merge [Proc] invoked when a leaf is merged with another leaf
+    def merge!(nodes, on_leaves_merge: nil)
       nodes = Siblings.from_nested_hash(nodes) if nodes.is_a?(Hash)
       nodes.each do |node|
-        merge_node! node
+        merge_node! node, on_leaves_merge: on_leaves_merge
       end
-      @list = key_to_node.values
-      dirty!
       self
     end
 
@@ -131,10 +131,23 @@ module I18n::Tasks::Data::Tree
       remove_nodes_collapsing_emptied_ancestors to_remove
     end
 
+    def subtract_keys!(keys)
+      to_remove = Set.new
+      keys.each do |full_key|
+        node = get full_key
+        to_remove << node if node
+      end
+      remove_nodes_collapsing_emptied_ancestors! to_remove
+    end
+
     def subtract_by_key(other)
       subtract_keys other.key_names(root: true)
     end
 
+    def subtract_by_key!(other)
+      subtract_keys! other.key_names(root: true)
+    end
+
     def set_root_key!(new_key, data = nil)
       return self if empty?
       rename_key first.key, new_key
@@ -142,7 +155,8 @@ module I18n::Tasks::Data::Tree
       self
     end
 
-    def merge_node!(node)
+    # @param on_leaves_merge [Proc] invoked when a leaf is merged with another leaf
+    def merge_node!(node, on_leaves_merge: nil)
       if key_to_node.key?(node.key)
         our = key_to_node[node.key]
         return if our == node
@@ -155,9 +169,12 @@ module I18n::Tasks::Data::Tree
             warn_add_children_to_leaf our
             our.children = node.children
           end
+        elsif on_leaves_merge
+          on_leaves_merge.call(our, node)
         end
       else
-        key_to_node[node.key] = node.derive(parent: parent)
+        @list << (key_to_node[node.key] = node.derive(parent: parent))
+        dirty!
       end
     end
 

data/lib/i18n/tasks/data/tree/traversal.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module I18n::Tasks
   module Data::Tree
     # Any Enumerable that yields nodes can mix in this module
@@ -145,6 +146,7 @@ module I18n::Tasks
       def set_each_value!(val_pattern, key_pattern = nil, &value_proc)
         value_proc ||= proc { |node|
           node_value = node.value
+          next node_value if node.reference?
           human_key  = ActiveSupport::Inflector.humanize(node.key.to_s)
           full_key   = node.full_key
           StringInterpolation.interpolate_soft(

data/lib/i18n/tasks/google_translation.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'easy_translate'
 require 'i18n/tasks/html_keys'
 
@@ -22,9 +23,13 @@ module I18n::Tasks
       opts[:key] ||= translation_config[:api_key]
       validate_google_translate_api_key! opts[:key]
       key_pos = list.each_with_index.inject({}) { |idx, ((k, _v), i)| idx[k] = i; idx }
+      # copy reference keys as is, instead of translating
+      reference_key_vals = list.select { |_k, v| v.is_a? Symbol } || []
+      list -= reference_key_vals
       result  = list.group_by { |k_v| HtmlKeys.html_key? k_v[0] }.map { |is_html, list_slice|
         fetch_google_translations list_slice, opts.merge(is_html ? {html: true} : {format: 'text'})
       }.reduce(:+) || []
+      result.concat(reference_key_vals)
       result.sort! { |a, b| key_pos[a[0]] <=> key_pos[b[0]] }
       result
     end

data/lib/i18n/tasks/html_keys.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module I18n::Tasks
   module HtmlKeys
     extend self

data/lib/i18n/tasks/ignore_keys.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module I18n::Tasks::IgnoreKeys
   # whether to ignore the key
   # will also apply global ignore rules

data/lib/i18n/tasks/key_pattern_matching.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+require 'strscan'
+
 module I18n::Tasks::KeyPatternMatching
   extend self
   MATCH_NOTHING = /\z\A/.freeze
@@ -29,21 +32,4 @@ module I18n::Tasks::KeyPatternMatching
         gsub(/:/, '(?<=^|\.)[^.]+?(?=\.|$)'.freeze).
         gsub(/\{(.*?)}/) { "(#{$1.strip.gsub /\s*,\s*/, '|'.freeze})" }
   end
-
-  def key_match_pattern(k)
-    @key_match_pattern ||= {}
-    @key_match_pattern[k] ||= begin
-      "#{k.gsub(KEY_INTERPOLATION_RE, ':'.freeze)}#{':'.freeze if k.end_with?('.'.freeze)}"
-    end
-  end
-
-  # @return true if the key looks like an expression
-  KEY_INTERPOLATION_RE = /(?:\#{.*?}|\*+|\:+)/.freeze
-  def key_expression?(k)
-    @key_is_expr ||= {}
-    if @key_is_expr[k].nil?
-      @key_is_expr[k] = (k =~ KEY_INTERPOLATION_RE || k.end_with?('.'.freeze))
-    end
-    @key_is_expr[k]
-  end
 end

data/lib/i18n/tasks/locale_list.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module I18n::Tasks
   module LocaleList
     extend self

data/lib/i18n/tasks/locale_pathname.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module I18n::Tasks
   module LocalePathname
     extend self

data/lib/i18n/tasks/logging.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module I18n::Tasks::Logging
   extend self
 

data/lib/i18n/tasks/missing_keys.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'set'
 module I18n::Tasks
   module MissingKeys
@@ -79,7 +80,7 @@ module I18n::Tasks
       base = data[compare_to].first.children
       data[locale].select_keys(root: false) { |key, node|
         other_node = base[key]
-        other_node && node.value == other_node.value && !ignore_key?(key, :eq_base, locale)
+        other_node && !node.reference? && node.value == other_node.value && !ignore_key?(key, :eq_base, locale)
       }.set_root_key!(locale, type: :eq_base)
     end
 

data/lib/i18n/tasks/plural_keys.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'set'
 module I18n::Tasks::PluralKeys
   PLURAL_KEY_SUFFIXES = Set.new %w(zero one two few many other)

data/lib/i18n/tasks/references.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+module I18n::Tasks
+  module References
+    # Given a raw usage tree and a tree of reference keys in the data, return 3 trees:
+    # 1. Raw references -- a subset of the usages tree with keys that are reference key usages.
+    # 2. Resolved references -- all the used references in their fully resolved form.
+    # 3. Reference keys -- all the used reference keys.
+    def process_references(usages, data_references = merge_reference_trees(data_forest.select_keys { |_, node| node.reference? }))
+      fail ArgumentError.new('usages must be a Data::Tree::Instance') unless usages.is_a?(Data::Tree::Siblings)
+      fail ArgumentError.new('all_references must be a Data::Tree::Instance') unless data_references.is_a?(Data::Tree::Siblings)
+      raw_refs      = empty_forest
+      resolved_refs = empty_forest
+      refs          = empty_forest
+      data_references.key_to_node.each do |ref_key_part, ref_node|
+        usages.each do |usage_node|
+          next unless usage_node.key == ref_key_part
+          if ref_node.leaf?
+            unless refs.key_to_node.key?(ref_node.key)
+              refs.merge_node!(Data::Tree::Node.new(key: ref_node.key, data: usage_node.data))
+            end
+            resolved_refs.merge!(
+                Data::Tree::Siblings.from_key_names([ref_node.value.to_s]) { |_, resolved_node|
+                  raw_refs.merge_node!(usage_node)
+                  if usage_node.leaf?
+                    resolved_node.data.merge!(usage_node.data)
+                  else
+                    resolved_node.children = usage_node.children
+                  end
+                }.tap { |new_resolved_refs|
+                  refs.key_to_node[ref_node.key].data.tap { |ref_data|
+                    ref_data[:occurrences] ||= []
+                    new_resolved_refs.leaves { |leaf| ref_data[:occurrences].concat(leaf.data[:occurrences] || []) }
+                    ref_data[:occurrences].sort_by!(&:path)
+                    ref_data[:occurrences].uniq!
+                  }
+                })
+          else
+            child_raw_refs, child_resolved_refs, child_refs = process_references(usage_node.children, ref_node.children)
+            raw_refs.merge_node! Data::Tree::Node.new(key: ref_node.key, children: child_raw_refs) unless child_raw_refs.empty?
+            resolved_refs.merge! child_resolved_refs
+            refs.merge_node! Data::Tree::Node.new(key: ref_node.key, children: child_refs) unless child_refs.empty?
+          end
+        end
+      end
+      [raw_refs, resolved_refs, refs]
+    end
+
+    # Given a forest of references, merge trees into one tree, ensuring there are no conflicting references.
+    # @param roots [Data::Tree::Siblings]
+    # @return [Data::Tree::Siblings]
+    def merge_reference_trees(roots)
+      roots.inject(empty_forest) do |forest, root|
+        root.keys { |full_key, node|
+          log_warn(
+              "Self-referencing key #{node.full_key(root: false).inspect} in #{node.data[:locale].inspect}"
+          ) if full_key == node.value.to_s
+        }
+        forest.merge!(
+            root.children,
+            on_leaves_merge: -> (node, other) {
+              log_warn(
+                  "Conflicting references: #{node.full_key(root: false)} ⮕ #{node.value} in #{node.data[:locale]}, but ⮕ #{other.value} in #{other.data[:locale]}"
+              ) if node.value != other.value
+            })
+      end
+    end
+  end
+end

data/lib/i18n/tasks/reports/base.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module I18n::Tasks::Reports
   class Base
     include I18n::Tasks::Logging
@@ -27,11 +28,9 @@ module I18n::Tasks::Reports
       "Same value as #{locale} (#{key_values.count || '∅'})"
     end
 
-    def used_title(used_tree)
-      leaves = used_tree.leaves.to_a
-      filter = used_tree.first.root.data[:key_filter]
-      used_n = leaves.map { |node| node.data[:occurrences].size }.reduce(:+).to_i
-      "#{leaves.length} key#{'s' if leaves.size != 1}#{" matching '#{filter}'" if filter}#{" (#{used_n} usage#{'s' if used_n != 1})" if used_n > 0}"
+    def used_title(keys_nodes, filter)
+      used_n = keys_nodes.map { |_k, node| node.data[:occurrences].size }.reduce(:+).to_i
+      "#{keys_nodes.size} key#{'s' if keys_nodes.size != 1}#{" matching '#{filter}'" if filter}#{" (#{used_n} usage#{'s' if used_n != 1})" if used_n > 0}"
     end
 
     # Sort keys by their attributes in order

data/lib/i18n/tasks/reports/spreadsheet.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'i18n/tasks/reports/base'
 require 'fileutils'
 

data/lib/i18n/tasks/reports/terminal.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'i18n/tasks/reports/base'
 require 'terminal-table'
 module I18n
@@ -29,8 +30,12 @@ module I18n
         end
 
         def used_keys(used_tree = task.used_tree)
-          print_title used_title(used_tree)
-          keys_nodes = used_tree.keys.to_a
+          # For the used tree we may have usage nodes that are not leaves as references.
+          keys_nodes = used_tree.nodes.select { |node| !!node.data[:occurrences] }.map { |node|
+            [node.full_key(root: false), node]
+          }
+          print_title used_title(keys_nodes, used_tree.first.root.data[:key_filter])
+          # Group multiple nodes
           if keys_nodes.present?
             keys_nodes.sort! { |a, b| a[0] <=> b[0] }.each do |key, node|
               print_occurrences node, key
@@ -80,13 +85,31 @@ module I18n
           if leaf[:type] == :missing_used
             first_occurrence leaf
           else
-            "#{cyan leaf[:data][:missing_diff_locale]} #{leaf[:value].to_s.strip}"
+            "#{cyan leaf[:data][:missing_diff_locale]} #{format_value(leaf[:value].is_a?(String) ? leaf[:value].strip : leaf[:value])}"
           end
         end
 
+        def format_value(val)
+          val.is_a?(Symbol) ? "#{bold(yellow('⮕ '))}#{yellow(val.to_s)}" : val.to_s.strip
+        end
+
+        def format_reference_desc(node)
+            case node.data[:type]
+              when :reference_usage
+                bold(yellow('(reference)'))
+              when :reference_usage_resolved
+                bold(yellow('(resolved reference)'))
+              when :reference_usage_key
+                bold(yellow('(reference key)'))
+            end
+        end
+
         def print_occurrences(node, full_key = node.full_key)
           occurrences = node.data[:occurrences]
-          puts "#{bold "#{full_key}"} #{green(occurrences.size.to_s) if occurrences.size > 1}"
+          puts [bold("#{full_key}"),
+                format_reference_desc(node),
+                (green(occurrences.size.to_s) if occurrences.size > 1)
+               ].compact.join ' '
           occurrences.each do |occurrence|
             puts "  #{key_occurrence full_key, occurrence}"
           end
@@ -98,7 +121,7 @@ module I18n
                                    bold(cyan(I18n.t('i18n_tasks.common.key'))),
                                    I18n.t('i18n_tasks.common.value')] do |t|
               t.rows = locale_key_values.map { |(locale, k, v)|
-                [{value: cyan(locale), alignment: :center}, cyan(k), v.to_s]
+                [{value: cyan(locale), alignment: :center}, cyan(k), format_value(v)]
               }
             end
           else
@@ -133,7 +156,7 @@ module I18n
 
         def key_occurrence(full_key, occurrence)
           location = green "#{occurrence.path}:#{occurrence.line_num}"
-          source   = highlight_key(full_key, occurrence.line, occurrence.line_pos..-1).strip
+          source   = highlight_key(occurrence.raw_key || full_key, occurrence.line, occurrence.line_pos..-1).strip
           "#{location} #{source}"
         end
 

data/lib/i18n/tasks/scanners/file_scanner.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'i18n/tasks/scanners/scanner'
 
 module I18n::Tasks::Scanners

data/lib/i18n/tasks/scanners/files/caching_file_finder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'i18n/tasks/scanners/files/file_finder'
 module I18n::Tasks::Scanners::Files
   # Finds the files in the specified search paths with support for exclusion / inclusion patterns.

data/lib/i18n/tasks/scanners/files/caching_file_finder_provider.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'i18n/tasks/scanners/files/caching_file_finder'
 
 module I18n::Tasks::Scanners::Files

data/lib/i18n/tasks/scanners/files/caching_file_reader.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'i18n/tasks/scanners/files/file_reader'
 module I18n::Tasks::Scanners::Files
   # Reads the files in 'rb' mode and UTF-8 encoding.

data/lib/i18n/tasks/scanners/files/file_finder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module I18n::Tasks::Scanners::Files
   # Finds the files in the specified search paths with support for exclusion / inclusion patterns.
   #

data/lib/i18n/tasks/scanners/files/file_reader.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module I18n::Tasks::Scanners::Files
   # Reads the files in 'rb' mode and UTF-8 encoding.
   #

data/lib/i18n/tasks/scanners/occurrence_from_position.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module I18n
   module Tasks
     module Scanners
@@ -9,7 +10,7 @@ module I18n
         # @param contents [String] contents of the file at the path.
         # @param position [Fixnum] position just before the beginning of the match.
         # @return [Results::Occurrence]
-        def occurrence_from_position(path, contents, position)
+        def occurrence_from_position(path, contents, position, raw_key: nil)
           line_begin = contents.rindex(/^/, position - 1)
           line_end   = contents.index(/.(?=\r?\n|$)/, position)
           Results::Occurrence.new(
@@ -17,7 +18,8 @@ module I18n
               pos:      position,
               line_num: contents[0..position].count("\n".freeze) + 1,
               line_pos: position - line_begin + 1,
-              line:     contents[line_begin..line_end])
+              line:     contents[line_begin..line_end],
+              raw_key: raw_key)
         end
       end
     end

data/lib/i18n/tasks/scanners/pattern_scanner.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'i18n/tasks/scanners/file_scanner'
 require 'i18n/tasks/scanners/relative_keys'
 require 'i18n/tasks/scanners/occurrence_from_position'
@@ -17,13 +18,13 @@ module I18n::Tasks::Scanners
     protected
 
     # Extract i18n keys from file based on the pattern which must capture the key literal.
-    # @return [Array<[key, Results::KeyOccurrence]>] each occurrence found in the file
+    # @return [Array<[key, Results::Occurrence]>] each occurrence found in the file
     def scan_file(path)
       keys = []
       text = read_file(path)
       text.scan(@pattern) do |match|
         src_pos  = Regexp.last_match.offset(0).first
-        location = occurrence_from_position(path, text, src_pos)
+        location = occurrence_from_position(path, text, src_pos, raw_key: strip_literal(match[0]))
         next if exclude_line?(location.line, path)
         key = match_to_key(match, path, location)
         next unless key

data/lib/i18n/tasks/scanners/pattern_with_scope_scanner.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'i18n/tasks/scanners/pattern_scanner'
 
 module I18n::Tasks::Scanners

data/lib/i18n/tasks/scanners/relative_keys.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module I18n
   module Tasks
     module Scanners

data/lib/i18n/tasks/scanners/results/key_occurrences.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'i18n/tasks/scanners/results/occurrence'
 
 module I18n::Tasks::Scanners::Results

data/lib/i18n/tasks/scanners/results/occurrence.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module I18n::Tasks
   module Scanners
     module Results
@@ -23,27 +24,33 @@ module I18n::Tasks
         # @return [String, nil] the value of the `default:` argument of the translate call.
         attr_reader :default_arg
 
+        # @return [String, nil] the raw key (for relative keys and references)
+        attr_accessor :raw_key
+
         # @param path        [String]
         # @param pos         [Fixnum]
         # @param line_num    [Fixnum]
         # @param line_pos    [Fixnum]
         # @param line        [String]
+        # @param raw_key     [String, nil]
         # @param default_arg [String, nil]
-        def initialize(path:, pos:, line_num:, line_pos:, line:, default_arg: nil)
+        def initialize(path:, pos:, line_num:, line_pos:, line:, raw_key: nil, default_arg: nil)
           @path        = path
           @pos         = pos
           @line_num    = line_num
           @line_pos    = line_pos
           @line        = line
+          @raw_key     = raw_key
           @default_arg = default_arg
         end
 
         def inspect
-          "Occurrence(#{@path}:#{@line_num}:#{@line_pos}:(#{@pos})"
+          "Occurrence(#{@path}:#{@line_num}:#{@line_pos}:#{@pos}:#{@raw_key}:#{@default_arg})"
         end
 
         def ==(other)
-          other.path == @path && other.pos == @pos && other.line_num == @line_num && other.line == @line
+          other.path == @path && other.pos == @pos && other.line_num == @line_num && other.line == @line &&
+              other.raw_key == @raw_key && other.default_arg == @default_arg
         end
 
         def eql?(other)

data/lib/i18n/tasks/scanners/ruby_ast_call_finder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'ast'
 require 'set'
 module I18n::Tasks::Scanners

data/lib/i18n/tasks/scanners/ruby_ast_scanner.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'i18n/tasks/scanners/file_scanner'
 require 'i18n/tasks/scanners/relative_keys'
 require 'i18n/tasks/scanners/ruby_ast_call_finder'
@@ -75,7 +76,7 @@ module I18n::Tasks::Scanners
                    else
                      key
                    end
-        [full_key, range_to_occurrence(location.expression, default_arg: default_arg)]
+        [full_key, range_to_occurrence(key, location.expression, default_arg: default_arg)]
       end
     end
 
@@ -163,16 +164,18 @@ module I18n::Tasks::Scanners
       /controllers|mailers/.match(path)
     end
 
+    # @param raw_key [String]
     # @param range [Parser::Source::Range]
     # @param default_arg [String, nil]
     # @return [Results::Occurrence]
-    def range_to_occurrence(range, default_arg: nil)
+    def range_to_occurrence(raw_key, range, default_arg: nil)
       Results::Occurrence.new(
           path:        range.source_buffer.name,
           pos:         range.begin_pos,
           line_num:    range.line,
           line_pos:    range.column,
           line:        range.source_line,
+          raw_key:     raw_key,
           default_arg: default_arg)
     end
 

data/lib/i18n/tasks/scanners/scanner.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'i18n/tasks/scanners/results/key_occurrences'
 
 module I18n::Tasks::Scanners

data/lib/i18n/tasks/scanners/scanner_multiplexer.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'i18n/tasks/scanners/scanner'
 
 module I18n::Tasks::Scanners

data/lib/i18n/tasks/split_key.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module I18n
   module Tasks
     module SplitKey

data/lib/i18n/tasks/stats.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module I18n::Tasks
   module Stats
     def forest_stats(forest)

data/lib/i18n/tasks/string_interpolation.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module I18n::Tasks
   module StringInterpolation
     extend self

data/lib/i18n/tasks/unused_keys.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'set'
 
 module I18n
@@ -11,10 +12,13 @@ module I18n
       # @param [String] locale
       # @param [Boolean] strict if true, do not match dynamic keys
       def unused_tree(locale: base_locale, strict: nil)
+        used_key_names = used_tree(strict: true).keys.reject {|_key, node|
+          node.data[:type] == :used_reference_key_raw
+        }.map(&:first)
         collapse_plural_nodes! data[locale].select_keys { |key, _node|
           !ignore_key?(key, :unused) &&
               (strict || !used_in_expr?(key)) &&
-              !used_key?(depluralize_key(key, locale))
+              !used_key_names.include?(depluralize_key(key, locale))
         }
       end
     end

data/lib/i18n/tasks/used_keys.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'find'
 require 'i18n/tasks/scanners/pattern_with_scope_scanner'
 require 'i18n/tasks/scanners/ruby_ast_scanner'
@@ -30,8 +31,26 @@ module I18n::Tasks
     # @param key_filter [String] only return keys matching this pattern.
     # @param strict [Boolean] if true, dynamic keys are excluded (e.g. `t("category.#{ category.key }")`)
     # @return [Data::Tree::Siblings]
-    def used_tree(key_filter: nil, strict: nil)
-      keys = ((@used_tree ||= {})[strict?(strict)] ||= scanner(strict: strict).keys.freeze)
+    def used_tree(key_filter: nil, strict: nil, include_raw_references: false)
+      src_tree = used_in_source_tree(key_filter: key_filter, strict: strict)
+
+      raw_refs, resolved_refs, used_refs = process_references(src_tree['used'].children)
+      raw_refs.leaves { |node| node.data[:type] = :reference_usage }
+      resolved_refs.leaves { |node| node.data[:type] = :reference_usage_resolved }
+      used_refs.leaves { |node| node.data[:type] = :reference_usage_key }
+      src_tree.tap do |result|
+        tree = result['used'].children
+        tree.subtract_by_key!(raw_refs)
+        if include_raw_references
+          tree.merge!(raw_refs)
+        end
+        tree.merge!(used_refs).merge!(resolved_refs)
+      end
+    end
+
+    def used_in_source_tree(key_filter: nil, strict: nil)
+      keys = ((@keys_used_in_source_tree ||= {})[strict?(strict)] ||=
+          scanner(strict: strict).keys.freeze)
       if key_filter
         key_filter_re = compile_key_pattern(key_filter)
         keys          = keys.reject { |k| k.key !~ key_filter_re }
@@ -43,6 +62,7 @@ module I18n::Tasks
       ).to_siblings
     end
 
+
     def scanner(strict: nil)
       (@scanner ||= {})[strict?(strict)] ||= begin
         shared_options = search_config.dup
@@ -102,20 +122,13 @@ module I18n::Tasks
       @caching_file_reader ||= Scanners::Files::CachingFileReader.new
     end
 
-    def used_key_names(strict: nil)
-      (@used_key_names ||= {})[strict?(strict)] ||= used_tree(strict: strict).key_names
-    end
-
-    # whether the key is used in the source
-    def used_key?(key)
-      used_key_names(strict: true).include?(key)
-    end
-
     # @return whether the key is potentially used in a code expression such as `t("category.#{ category_key }")`
     def used_in_expr?(key)
       !!(key =~ expr_key_re)
     end
 
+    private
+
     # @param strict [Boolean, nil]
     # @return [Boolean]
     def strict?(strict)
@@ -123,16 +136,43 @@ module I18n::Tasks
     end
 
     # keys in the source that end with a ., e.g. t("category.#{ cat.i18n_key }") or t("category." + category.key)
-    def expr_key_re
+    # @param [String] replacement for interpolated values.
+    def expr_key_re(replacement: ':'.freeze)
       @expr_key_re ||= begin
-        patterns = used_key_names(strict: false).select { |k| key_expression?(k) }.map { |k|
-          pattern = key_match_pattern(k)
-          # disallow patterns with no keys
-          next if pattern =~ /\A(:\.)*:\z/
+        # disallow patterns with no keys
+        ignore_pattern_re = /\A[\.#{replacement}]*\z/
+        patterns          = used_in_source_tree(strict: false).key_names.select { |k|
+          k.end_with?('.'.freeze) || k =~ /\#{/.freeze
+        }.map { |k|
+          pattern = "#{replace_key_exp(k, replacement)}#{replacement if k.end_with?('.'.freeze)}"
+          next if pattern =~ ignore_pattern_re
           pattern
         }.compact
         compile_key_pattern "{#{patterns * ','}}"
       end
     end
+
+    # Replace interpolations in dynamic keys such as "category.#{category.i18n_key}".
+    # @param key [String]
+    # @param replacement [String]
+    # @return [String]
+    def replace_key_exp(key, replacement)
+      scanner = StringScanner.new(key)
+      braces  = []
+      result  = []
+      while (match_until = scanner.scan_until(/(?:#?\{|})/.freeze))
+        if scanner.matched == '#{'.freeze
+          braces << scanner.matched
+          result << match_until[0..-3] if braces.length == 1
+        elsif scanner.matched == '}'
+          prev_brace = braces.pop
+          result << replacement if braces.empty? && prev_brace == '#{'.freeze
+        else
+          braces << '{'.freeze
+        end
+      end
+      result << key[scanner.pos..-1] unless scanner.eos?
+      result.join
+    end
   end
 end

data/lib/i18n/tasks/version.rb

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 module I18n
   module Tasks
-    VERSION = '0.9.2'
+    VERSION = '0.9.3'
   end
 end

data/templates/rspec/i18n_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'i18n/tasks'
 
 RSpec.describe 'I18n' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-tasks
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.3
 platform: ruby
 authors:
 - glebm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-23 00:00:00.000000000 Z
+date: 2016-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -270,6 +270,7 @@ files:
 - lib/i18n/tasks/logging.rb
 - lib/i18n/tasks/missing_keys.rb
 - lib/i18n/tasks/plural_keys.rb
+- lib/i18n/tasks/references.rb
 - lib/i18n/tasks/reports/base.rb
 - lib/i18n/tasks/reports/spreadsheet.rb
 - lib/i18n/tasks/reports/terminal.rb
@@ -322,7 +323,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Manage localization and translation with the awesome power of static analysis