i18n-tasks 0.2.20 → 0.2.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab1b5fe079fcb795dc047f1e0e4f3d777b83c2ef
-  data.tar.gz: 23b4a9f9e87b2f0ed8ac2c8c8a2b1992edc7b90d
+  metadata.gz: 3d02f77ecd3ceb644a2a5a86d1b5dc622880e170
+  data.tar.gz: e859f73a4891034d5e1e95b7b5938aa7d3dace73
 SHA512:
-  metadata.gz: 4100f55d87da5b5131c3adf1794ae10d2fb4b1de691966ff6b24129bf660fca3035a857d841707ceb8946214926646b28aad8f0b2154b77b294a98422b533cd3
-  data.tar.gz: 335f197c93d93fc41c27600815a74a964851778050d1d699de15be38998f17a3f5e3354dddcb52708ec50151a5a058cab41fd232de814c6b47e18ddfb6768595
+  metadata.gz: 4d821eab3b6e9f54870ccaa4c76869cea3ca79dc7eebdd62566c2464997bcd08485826b98a2d3d83f27d4ee8c609f502db9f1f5c528f1f1db133894e48f7835d
+  data.tar.gz: 44be3b83606e217455633dbb806e972bac6071a238c5f9f74b499a3fc883199d2edb22804dc160e8c5f3708e0f22c122680a6ea2bbe007d15f15f72873f1986f

data/CHANGES.md

@@ -1,3 +1,8 @@
+## v0.2.21
+
+* `rake i18n:usages[pattern]`
+* performance regression fixes
+
 ## v0.2.20
 
 * `rake i18n:usages` report

data/README.md

@@ -10,7 +10,7 @@ Tasks to manage translations in ruby applications using I18n.
 Simply add to Gemfile:
 
 ```ruby
-gem 'i18n-tasks', '~> 0.2.20'
+gem 'i18n-tasks', '~> 0.2.21'
 ```
 
 If not using Rails, require the tasks in Rakefile:
@@ -144,6 +144,10 @@ Inspect all the usages with:
 
 ```bash
 rake i18n:usages
+# Filter by a key pattern
+rake i18n:usages[auth.*]
+# Because commas are not allowed inside rake arguments, + is used here instead
+rake i18n:usages['{number+currency}.format.*']
 ```
 
 ![i18n-screenshot](https://raw.github.com/glebm/i18n-tasks/master/doc/img/i18n-usages.png "rake i18n:usages output screenshot")

data/lib/i18n/tasks/key.rb

@@ -9,7 +9,7 @@ module I18n
                     elsif key_or_attr.is_a?(Hash)
                       key_or_attr.merge(own_attr)
                     else
-                      own_attr.merge(key: key_or_attr)
+                      (own_attr || {}).merge(key: key_or_attr)
                     end
 
         @own_attr[:key] = @own_attr[:key].to_s

data/lib/i18n/tasks/key_group.rb

@@ -4,7 +4,7 @@ module I18n
     class KeyGroup
       attr_reader :keys, :attr, :key_names
 
-      delegate :size, :length, :each, :[], to: :keys
+      delegate :size, :length, :each, :[], :blank?, to: :keys
       include Enumerable
 
       def initialize(keys, attr = {})

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

@@ -27,7 +27,9 @@ module I18n::Tasks::Reports
     end
 
     def used_title(keys)
-      "#{keys.length} keys used #{keys.map { |k| k[:usages].size }.reduce(:+)} times"
+      filter = keys.attr[:key_filter]
+      used_n = keys.map { |k| k[:usages].size }.reduce(:+).to_i
+      "#{keys.length} key#{'s' if keys.size != 1}#{" ~ '#{filter}'" if filter}#{" (#{used_n} usage#{'s' if used_n != 1})" if used_n > 0}"
     end
   end
 end

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

@@ -12,7 +12,7 @@ module I18n
           print_title missing_title(keys)
           if keys.present?
 
-            $stderr.puts "#{bold 'Types:'} #{missing_types.values.map { |t| "#{t[:glyph]} #{t[:summary]}" } * ', '}"
+            print_info "#{bold 'Types:'} #{missing_types.values.map { |t| "#{t[:glyph]} #{t[:summary]}" } * ', '}"
 
             print_table headings: [magenta(bold('Locale')), bold('Type'), magenta('i18n Key'), bold(cyan "Base value (#{base_locale})")] do |t|
               t.rows = keys.map { |key|
@@ -36,22 +36,22 @@ module I18n
           end
         end
 
-        def used_keys(keys = task.used_keys)
+        def used_keys(keys = task.used_keys(true))
           print_title used_title(keys)
           keys.sort_by_attr!(key: :asc)
           if keys.present?
             keys.each do |k|
-              puts "#{bold k.key} (#{k[:usages].size}):"
+              puts "#{bold "#{k.key}"} #{k[:usages].size if k[:usages].size > 1}"
               k[:usages].each do |u|
-                line = faint u[:line].dup.tap { |line|
-                  line.sub!(k[:key], underline(k[:key]))
+                line = u[:line].dup.tap { |line|
                   line.strip!
+                  line.sub!(/(.*?)(#{k[:key]})(.*)$/) { dark($1) + underline($2) + dark($3)}
                 }
-                puts "  #{u[:path]}:#{u[:line_num]}: #{faint line}"
+                puts "  #{green "#{u[:path]}:#{u[:line_num]}"} #{line}"
               end
             end
           else
-            print_error 'No key usages found. Please check configuration in config/i18n-tasks.yml'
+            print_error 'No key usages found'
           end
         end
 
@@ -69,15 +69,19 @@ module I18n
         private
 
         def print_title(title)
-          $stderr.puts "#{bold cyan title.strip} #{dark "|"} #{bold "i18n-tasks v#{I18n::Tasks::VERSION}"}"
+          print_info "#{bold cyan title.strip} #{dark "|"} #{bold "i18n-tasks v#{I18n::Tasks::VERSION}"}"
         end
 
         def print_success(message)
-          $stderr.puts(bold green message)
+          print_info(bold green message)
         end
 
         def print_error(message)
-          $stderr.puts(bold red message)
+          print_info(bold red message)
+        end
+        
+        def print_info(*args)
+          $stderr.puts(*args)
         end
 
         def indent(txt, n = 2)

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

@@ -2,38 +2,40 @@ require 'i18n/tasks/relative_keys'
 module I18n::Tasks::Scanners
   class BaseScanner
     include ::I18n::Tasks::RelativeKeys
-    attr_reader :config
+    include ::I18n::Tasks::KeyPatternMatching
+    attr_reader :config, :key_filter, :record_usages
 
     def initialize(config)
-      @config = config.dup.with_indifferent_access.tap do |conf|
+      @config        = config.dup.with_indifferent_access.tap do |conf|
         conf[:paths]   = %w(app/) if conf[:paths].blank?
         conf[:include] = Array(conf[:include]) if conf[:include].present?
         conf[:exclude] = Array(conf[:exclude])
       end
+      @record_usages = false
+    end
+
+    def key_filter=(value)
+      @key_filter = value
+      @key_filter_pattern = compile_key_pattern(value) if @key_filter
     end
 
     # @return [Array] found key usages, absolutized and unique
     def keys
-      @keys ||= begin
-        @keys_by_name = {}
-        keys   = []
-        usages = traverse_files { |path|
-          ::I18n::Tasks::KeyGroup.new(scan_file(path), src_path: path) }.map(&:keys).flatten
-        usages.group_by(&:key).each do |key, instances|
-          key = {
-              key: key,
-              usages: instances.map { |inst| inst[:src].merge(path: inst[:src_path]) }
-          }
-          @keys_by_name[key.to_s] = key
-          keys << key
-        end
-        keys
+      if @record_usages
+        keys_with_usages
+      else
+        @keys ||= traverse_files { |path| scan_file(path, read_file(path)).map(&:key) }.reduce(:+).uniq
       end
     end
 
-    def key_usages(key)
-      keys
-      @keys_by_name[key.to_s][:usages]
+    def keys_with_usages
+      with_usages do
+        traverse_files { |path|
+          ::I18n::Tasks::KeyGroup.new(scan_file(path, read_file(path)), src_path: path)
+        }.map(&:keys).reduce(:+).group_by(&:key).map { |key, key_usages|
+          {key: key, usages: key_usages.map { |usage| usage[:src].merge(path: usage[:src_path]) }}
+        }
+      end
     end
 
     def read_file(path)
@@ -52,23 +54,47 @@ module I18n::Tasks::Scanners
     def traverse_files
       result = []
       Find.find(*config[:paths]) do |path|
-        next if File.directory?(path)
-        next if config[:include] and !config[:include].any? { |glob| File.fnmatch(glob, path) }
-        next if config[:exclude].any? { |glob| File.fnmatch(glob, path) }
+        next if File.directory?(path) ||
+            config[:include] && !path_fnmatch_any?(path, config[:include]) ||
+            path_fnmatch_any?(path, config[:exclude])
         result << yield(path)
       end
       result
     end
 
+    def path_fnmatch_any?(path, globs)
+      globs.any? { |glob| File.fnmatch(glob, path) }
+    end
+    protected :path_fnmatch_any?
+
+    def with_key_filter(key_filter = nil)
+      filter_was      = @key_filter
+      self.key_filter = key_filter
+      result          = yield
+      self.key_filter = filter_was
+      result
+    end
+
+    def with_usages
+      was            = @record_usages
+      @record_usages = true
+      result         = yield
+      @record_usages = was
+      result
+    end
+
     protected
 
     def usage_context(text, src_pos)
+      return nil unless @record_usages
       line_begin = text.rindex(/^/, src_pos - 1)
       line_end   = text.index(/.(?=\n|$)/, src_pos)
-      {pos:      src_pos,
-       line_num: text[0..src_pos].count("\n") + 1,
-       line_pos: src_pos - line_begin + 1,
-       line:     text[line_begin..line_end]}
+      {src: {
+          pos:      src_pos,
+          line_num: text[0..src_pos].count("\n") + 1,
+          line_pos: src_pos - line_begin + 1,
+          line:     text[line_begin..line_end]
+      }}
     end
 
     def extract_key_from_match(match, path)
@@ -88,7 +114,7 @@ module I18n::Tasks::Scanners
     VALID_KEY_RE = /^[\w.\#{}]+$/
 
     def valid_key?(key)
-      key =~ VALID_KEY_RE
+      key =~ VALID_KEY_RE && !(@key_filter && @key_filter_pattern !~ key)
     end
 
     def relative_roots

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

@@ -1,11 +1,13 @@
-# Scans for I18n.t usages
 require 'i18n/tasks/scanners/base_scanner'
+
 module I18n::Tasks::Scanners
+  # Scans for I18n.t usages
+  #
   class PatternScanner < BaseScanner
     LITERAL_RE      = /:?".+?"|:?'.+?'|:\w+/
     DEFAULT_PATTERN = /\bt(?:ranslate)?[( ]\s*(#{LITERAL_RE})/
 
-    # Extract i18n keys from file based on the pattern. The pattern must capture key literal.
+    # Extract i18n keys from file based on the pattern which must capture the key literal.
     # @return [String] keys found in file
     def scan_file(path, text = read_file(path))
       keys = []
@@ -13,14 +15,13 @@ module I18n::Tasks::Scanners
         src_pos = Regexp.last_match.offset(0).first
         key     = extract_key_from_match(match, path)
         next unless valid_key?(key)
-        keys << ::I18n::Tasks::Key.new(key, src: usage_context(text, src_pos))
+        keys << ::I18n::Tasks::Key.new(key, usage_context(text, src_pos))
       end
       keys
     end
 
     protected
 
-
     def pattern
       @pattern ||= config[:pattern].present? ? Regexp.new(config[:pattern]) : DEFAULT_PATTERN
     end

data/lib/i18n/tasks/used_keys.rb

@@ -4,8 +4,12 @@ require 'i18n/tasks/scanners/pattern_scanner'
 module I18n::Tasks::UsedKeys
   # find all keys in the source (relative keys are absolutized)
   # @return [Array<String>]
-  def used_keys
-    @used_keys ||= I18n::Tasks::KeyGroup.new(scanner.keys, type: :used)
+  def used_keys(with_usages = false)
+    if with_usages
+      I18n::Tasks::KeyGroup.new(scanner.keys_with_usages, type: :used, key_filter: scanner.key_filter)
+    else
+      @used_keys ||= I18n::Tasks::KeyGroup.new(scanner.keys, type: :used, key_filter: scanner.key_filter)
+    end
   end
 
   def scanner

data/lib/i18n/tasks/version.rb

@@ -1,5 +1,5 @@
 module I18n
   module Tasks
-    VERSION = '0.2.20'
+    VERSION = '0.2.21'
   end
 end

data/lib/tasks/i18n-tasks.rake

@@ -57,9 +57,14 @@ namespace :i18n do
     end
   end
   
-  desc 'show usages'
-  task :usages => 'i18n:setup' do
-    i18n_report.used_keys
+  desc 'show usages of the keys in the codebase'
+  task :usages, [:filter] => 'i18n:setup' do |t, args|
+    filter = args[:filter] ? args[:filter].tr('+', ',') : nil
+    i18n_report.used_keys(
+        i18n_task.scanner.with_key_filter(filter) {
+          i18n_task.used_keys(true)
+        }
+    )
   end
 
   desc 'normalize translation data: sort and move to the right files'

data/spec/i18n_tasks_spec.rb

@@ -85,7 +85,7 @@ describe 'rake i18n' do
   end
 
   # --- setup ---
-  BENCH_KEYS = 30
+  BENCH_KEYS = 100
   before do
     gen_data = ->(v) {
       v_num = v.chars.map(&:ord).join('').to_i

data/spec/used_keys_spec.rb

@@ -1,22 +1,40 @@
 require 'spec_helper'
 
 describe 'UsedKeys' do
-  let(:task) { I18n::Tasks::BaseTask.new }
+  let!(:task) { I18n::Tasks::BaseTask.new }
 
-  it 'shows usages' do
+  around do |ex|
     task.config[:search] = {paths: ['a.html.slim']}
     TestCodebase.setup('a.html.slim' => <<-SLIM)
 div = t 'a'
   p = t 'a'
+h1 = t 'b'
     SLIM
-    TestCodebase.in_test_app_dir {
-      used_keys = task.used_keys
-      expect(used_keys.size).to eq 1
-      usages_expected = [
-          {pos: 6, line_num: 1, line_pos: 7, line: "div = t 'a'", path: 'a.html.slim'},
-          {pos: 18, line_num: 2, line_pos: 7, line: "  p = t 'a'", path: 'a.html.slim'}
-      ]
-      expect(used_keys[0].attr).to eq(type: :used, key: 'a', usages: usages_expected)
+    TestCodebase.in_test_app_dir { ex.run }
+  end
+
+  it '#used_keys(true) finds usages' do
+    used_keys = task.used_keys(true)
+    expect(used_keys.size).to eq 2
+    expect(used_keys[0].own_attr).to(
+        eq(key:    'a',
+           usages: [{pos: 6, line_num: 1, line_pos: 7, line: "div = t 'a'", path: 'a.html.slim'},
+                    {pos: 18, line_num: 2, line_pos: 7, line: "  p = t 'a'", path: 'a.html.slim'}])
+    )
+    expect(used_keys[1].own_attr).to(
+        eq(key:    'b',
+           usages: [{pos: 29, line_num: 3, line_pos: 6, line: "h1 = t 'b'", path: 'a.html.slim'}])
+    )
+  end
+
+  it '#used_keys(true) finds usages with filter' do
+    used_keys = task.scanner.with_key_filter('b*') {
+      task.used_keys(true)
     }
+    expect(used_keys.size).to eq 1
+    expect(used_keys[0].own_attr).to(
+        eq(key:    'b',
+           usages: [{pos: 29, line_num: 3, line_pos: 6, line: "h1 = t 'b'", path: 'a.html.slim'}])
+    )
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: i18n-tasks
 version: !ruby/object:Gem::Version
-  version: 0.2.20
+  version: 0.2.21
 platform: ruby
 authors:
 - glebm