i18n-tasks 0.8.7 → 0.9.0.rc1

data/lib/i18n/tasks/unused_keys.rb

@@ -1,17 +1,16 @@
-# coding: utf-8
 require 'set'
 
 module I18n
   module Tasks
     module UnusedKeys
-      def unused_keys(opts = {})
-        locales = Array(opts[:locales]).presence || self.locales
-        locales.map { |locale| unused_tree locale, opts[:strict] }.compact.reduce(:merge!)
+      def unused_keys(locales: nil, strict: nil)
+        locales = Array(locales).presence || self.locales
+        locales.map { |locale| unused_tree(locale: locale, strict: strict) }.compact.reduce(:merge!)
       end
 
       # @param [String] locale
       # @param [Boolean] strict if true, do not match dynamic keys
-      def unused_tree(locale = base_locale, strict = false)
+      def unused_tree(locale: base_locale, strict: nil)
         collapse_plural_nodes! data[locale].select_keys { |key, _node|
           !ignore_key?(key, :unused) &&
               (strict || !used_in_expr?(key)) &&

data/lib/i18n/tasks/used_keys.rb

@@ -1,42 +1,95 @@
-# coding: utf-8
 require 'find'
 require 'i18n/tasks/scanners/pattern_with_scope_scanner'
+require 'i18n/tasks/scanners/scanner_multiplexer'
+require 'i18n/tasks/scanners/files/caching_file_finder_provider'
+require 'i18n/tasks/scanners/files/caching_file_reader'
 
 module I18n::Tasks
   module UsedKeys
+    STRICT_DEFAULT = true
 
-    # find all keys in the source (relative keys are absolutized)
-    # @option opts [String] :key_filter
-    # @option opts [Boolean] :strict if true dynamic keys are excluded (e.g. `t("category.#{category.key}")`)
-    # @return [Array<String>]
-    def used_tree(opts = {})
-      return scanner.with_key_filter(opts[:key_filter]) { used_tree(opts.except(:key_filter)) } if opts[:key_filter]
+    # Find all keys in the source and return a forest with the keys in absolute form and their occurrences.
+    #
+    # @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 = scanner(strict: strict).keys
+      if key_filter
+        key_filter_re = compile_key_pattern(key_filter)
+        keys.select! { |k| k.key =~ key_filter_re }
+      end
       Data::Tree::Node.new(
-          key: 'used',
-          data: {key_filter: scanner.key_filter},
-          children: Data::Tree::Siblings.from_key_attr(scanner.keys(opts.slice(:strict)))
+          key:      'used',
+          data:     {key_filter: key_filter},
+          children: Data::Tree::Siblings.from_key_occurrences(keys)
       ).to_siblings
     end
 
-    def scanner
-      @scanner ||= begin
-        search_config = (config[:search] || {}).with_indifferent_access
-        class_name    = search_config[:scanner] || '::I18n::Tasks::Scanners::PatternWithScopeScanner'
-        ActiveSupport::Inflector.constantize(class_name).new search_config
+    def scanner(strict: nil)
+      (@scanner ||= {})[strict.nil? ? STRICT_DEFAULT : strict] ||= begin
+        config = search_config
+        config[:strict] = strict unless strict.nil?
+        Scanners::ScannerMultiplexer.new(
+            scanners: search_config[:scanners].map { |(class_name, args)|
+              ActiveSupport::Inflector.constantize(class_name).new(
+                  config:               search_config.deep_merge(args || {}),
+                  file_finder_provider: caching_file_finder_provider,
+                  file_reader:          caching_file_reader)
+            })
       end
     end
 
-    def used_key_names(strict = false)
-      if strict
-        @used_key_names ||= used_tree(strict: true).key_names
-      else
-        @used_key_names ||= used_tree.key_names
+    def search_config
+      @search_config ||= apply_default_scanner_config((config[:search] || {}).dup.deep_symbolize_keys)
+    end
+
+    def apply_default_scanner_config(conf)
+      conf[:strict] = STRICT_DEFAULT unless conf.key?(:strict)
+      if conf[:scanner]
+        warn_deprecated 'search.scanner is now search.scanners, an array of [ScannerClass, options]'
+        conf[:scanners] = [[conf.delete(:scanner)]]
       end
+      conf[:scanners] ||= [['::I18n::Tasks::Scanners::PatternWithScopeScanner']]
+      if conf[:relative_roots].blank?
+        conf[:relative_roots] = %w(app/controllers app/helpers app/mailers app/presenters app/views)
+      end
+      conf[:paths]   = %w(app/) if conf[:paths].blank?
+      conf[:include] = Array(conf[:include]) if conf[:include].present?
+      conf[:exclude] = Array(conf[:exclude]) + %w(
+          *.jpg *.png *.gif *.svg *.ico *.eot *.otf *.ttf *.woff *.woff2 *.pdf *.css *.sass *.scss *.less *.yml *.json)
+      # Regexps for lines to ignore per extension
+      if conf[:ignore_lines] && !conf[:ignore_lines].is_a?(Hash)
+        warn_deprecated "search.ignore_lines must be a Hash, found #{conf[:ignore_lines].class.name}"
+        conf[:ignore_lines] = nil
+      end
+      conf[:ignore_lines] ||= {
+          'rb'     => %q(^\s*#(?!\si18n-tasks-use)),
+          'opal'   => %q(^\s*#(?!\si18n-tasks-use)),
+          'haml'   => %q(^\s*-\s*#(?!\si18n-tasks-use)),
+          'slim'   => %q(^\s*(?:-#|/)(?!\si18n-tasks-use)),
+          'coffee' => %q(^\s*#(?!\si18n-tasks-use)),
+          'erb'    => %q(^\s*<%\s*#(?!\si18n-tasks-use)),
+      }
+      conf
+    end
+
+
+    def caching_file_finder_provider
+      @caching_file_finder_provider ||= Scanners::Files::CachingFileFinderProvider.new
+    end
+
+    def caching_file_reader
+      @caching_file_reader ||= Scanners::Files::CachingFileReader.new
+    end
+
+    def used_key_names(strict: nil)
+      (@used_key_names ||= {})[strict.nil? ? STRICT_DEFAULT : strict] ||= used_tree(strict: strict).key_names
     end
 
     # whether the key is used in the source
-    def used_key?(key, strict = false)
-      used_key_names(strict).include?(key)
+    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:
@@ -48,7 +101,7 @@ module I18n::Tasks
     # keys in the source that end with a ., e.g. t("category.#{cat.i18n_key}") or t("category." + category.key)
     def expr_key_re
       @expr_key_re ||= begin
-        patterns = used_key_names.select { |k| key_expression?(k) }.map { |k|
+        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/

data/lib/i18n/tasks/version.rb

@@ -1,6 +1,5 @@
-# coding: utf-8
 module I18n
   module Tasks
-    VERSION = '0.8.7'
+    VERSION = '0.9.0.rc1'
   end
 end

data/spec/conservative_router_spec.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 require 'spec_helper'
 
 RSpec.describe 'Conservative router' do

data/spec/file_system_data_spec.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 require 'spec_helper'
 
 RSpec.describe 'File system i18n' do

data/spec/fixtures/app/controllers/events_controller.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 class EventsController < ApplicationController
   def create
   end
@@ -31,7 +30,7 @@ class EventsController < ApplicationController
     I18n.t "hash.#{stuff}.a"
 
     # relative key
-    I18n.t(".success")
+    t(".success")
   end
 
   def update

data/spec/google_translate_spec.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 require 'spec_helper'
 require 'i18n/tasks/commands'
 

data/spec/i18n_tasks_spec.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 require 'spec_helper'
 require 'fileutils'
 require 'open3'
@@ -10,6 +9,7 @@ RSpec.describe 'i18n-tasks' do
 
   describe 'bin/i18n-tasks' do
     it 'shows help when invoked with no arguments, shows version on --version' do
+      next if defined?(RUBY_ENGINE) && RUBY_ENGINE == 'jruby'
       # These bin/i18n-tasks tests are executed in parallel for performance
       in_test_app_dir do
         [
@@ -23,7 +23,7 @@ RSpec.describe 'i18n-tasks' do
               expect(err).to include('greet')
             },
             proc {
-              expect(%x[../../bin/i18n-tasks --version].chomp).to eq(I18n::Tasks::VERSION)
+              expect(%x[bundle exec ../../bin/i18n-tasks --version].chomp).to eq(I18n::Tasks::VERSION)
             }
         ].map { |test| Thread.start(&test) }.each(&:join)
       end
@@ -98,8 +98,8 @@ RSpec.describe 'i18n-tasks' do
   end
 
   describe 'unused' do
-    it 'detects unused' do
-      out, result = run_cmd_capture_stdout_and_result 'unused'
+    it 'detects unused (--no-strict)' do
+      out, result = run_cmd_capture_stdout_and_result('unused', '--no-strict')
       expect(result).to eq :exit_1
       expect(out).to be_i18n_keys expected_unused_keys
     end
@@ -211,17 +211,6 @@ RSpec.describe 'i18n-tasks' do
         expect(YAML.load_file('config/locales/en.yml')['en']['present_in_es_but_not_en']['a']).to eq 'TRME ES_TEXT'
       }
     end
-
-    it '--value with %{key}' do
-      in_test_app_dir {
-        expect(YAML.load_file('config/locales/es.yml')['es']['missing_in_es']).to be_nil
-      }
-      run_cmd 'add-missing', '-v', 'TRME %{key}'
-      in_test_app_dir {
-        expect(YAML.load_file('config/locales/es.yml')['es']['missing_in_es']['a']).to eq 'TRME es.missing_in_es.a'
-        expect(YAML.load_file('config/locales/en.yml')['en']['present_in_es_but_not_en']['a']).to eq 'TRME en.present_in_es_but_not_en.a'
-      }
-    end
   end
 
   describe 'config' do

data/spec/key_pattern_matching_spec.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 require 'spec_helper'
 
 RSpec.describe 'Key pattern' do

data/spec/locale_tree/siblings_spec.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 require 'spec_helper'
 
 RSpec.describe 'Tree siblings / forest' do

data/spec/pattern_scanner_spec.rb

@@ -1,49 +1,47 @@
-# coding: utf-8
 require 'spec_helper'
 
-RSpec.describe 'Pattern Scanner' do
-  describe 'scan_file' do
+RSpec.describe 'PatternScanner' do
+  describe '#keys' do
+    let(:expected_key) {
+      'events.show.success'
+    }
+
+    let(:expected_occurrence) {
+      {path:     'spec/fixtures/app/controllers/events_controller.rb',
+       pos:      769,
+       line_num: 33,
+       line_pos: 5,
+       line:     '    t(".success")'}
+    }
+
     it 'returns absolute keys from controllers' do
       file_path = 'spec/fixtures/app/controllers/events_controller.rb'
-      scanner = I18n::Tasks::Scanners::PatternScanner.new
+      scanner   = I18n::Tasks::Scanners::PatternScanner.new(
+          config: {paths: ['spec/fixtures/'], include: [file_path], relative_roots: ['spec/fixtures/app/controllers']})
       allow(scanner).to receive(:relative_roots).and_return(['spec/fixtures/app/controllers'])
-
-      keys = scanner.scan_file(file_path)
-
-      expect(keys).to include(
-        ["events.show.success",
-         {:data=>
-          {
-            :src_path=>"spec/fixtures/app/controllers/events_controller.rb",
-            :pos=>790,
-            :line_num=>34,
-            :line_pos=>10,
-            :line =>"    I18n.t(\".success\")"}
-           }
-         ]
-      )
+      expect(scanner.keys.detect { |key_occurrences| key_occurrences.key =~ /success/ }).to(
+          eq make_key_occurrences(expected_key, [expected_occurrence]))
     end
   end
 
   describe 'default_pattern' do
-    let!(:pattern) { I18n::Tasks::Scanners::PatternScanner.new.default_pattern }
+    let!(:pattern) { I18n::Tasks::Scanners::PatternScanner.new.send(:default_pattern) }
 
-    [
-      't(".a.b")',
-      't "a.b"',
-      "t 'a.b'",
-      't("a.b")',
-      "t('a.b')",
-      "t('a.b', :arg => val)",
-      "t('a.b', arg: val)",
-      "t :a_b",
-      "t :'a.b'",
-      't :"a.b"',
-      "t(:ab)",
-      "t(:'a.b')",
-      't(:"a.b")',
-      'I18n.t("a.b")',
-      'I18n.translate("a.b")'
+    ['t(".a.b")',
+     't "a.b"',
+     "t 'a.b'",
+     't("a.b")',
+     "t('a.b')",
+     "t('a.b', :arg => val)",
+     "t('a.b', arg: val)",
+     "t :a_b",
+     "t :'a.b'",
+     't :"a.b"',
+     "t(:ab)",
+     "t(:'a.b')",
+     't(:"a.b")',
+     'I18n.t("a.b")',
+     'I18n.translate("a.b")'
     ].each do |string|
       it "matches #{string}" do
         expect(pattern).to match string

data/spec/plural_keys_spec.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 require 'spec_helper'
 
 RSpec.describe 'Plural keys' do

data/spec/readme_spec.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 
 RSpec.describe 'README.md' do
   let(:readme) { File.read('README.md', encoding: 'UTF-8') }

data/spec/relative_keys_spec.rb

@@ -1,25 +1,30 @@
-# coding: utf-8
 require 'spec_helper'
+require 'i18n/tasks/scanners/relative_keys'
+
 RSpec.describe 'Relative keys' do
-  let(:scanner) { I18n::Tasks::Scanners::BaseScanner.new }
+  class RelativeKeysUser
+    include ::I18n::Tasks::Scanners::RelativeKeys
+  end
+  
+  let(:relative_keys) { RelativeKeysUser.new }
 
   describe 'absolutize_key' do
 
     context 'default settings' do
       it 'works' do
-        expect(scanner.absolutize_key('.title', 'app/views/movies/show.html.slim', %w(app/views))).to eq('movies.show.title')
+        expect(relative_keys.absolutize_key('.title', 'app/views/movies/show.html.slim', %w(app/views))).to eq('movies.show.title')
       end
     end
 
     context 'custom roots' do
       it 'works' do
-        expect(scanner.absolutize_key('.title', 'app/views-mobile/movies/show.html.slim', %w(app/views app/views-mobile))).to eq('movies.show.title')
+        expect(relative_keys.absolutize_key('.title', 'app/views-mobile/movies/show.html.slim', %w(app/views app/views-mobile))).to eq('movies.show.title')
       end
     end
 
     context 'relative key in controller' do
       it 'works' do
-        key = scanner.absolutize_key(
+        key = relative_keys.absolutize_key(
           '.success',
           'app/controllers/users_controller.rb',
           %w(app/controllers),
@@ -31,7 +36,7 @@ RSpec.describe 'Relative keys' do
 
       context 'multiple words in controller name' do
         it 'works' do
-          key = scanner.absolutize_key(
+          key = relative_keys.absolutize_key(
             '.success',
             'app/controllers/admin_users_controller.rb',
             %w(app/controllers),
@@ -44,7 +49,7 @@ RSpec.describe 'Relative keys' do
 
       context 'nested in module' do
         it 'works' do
-          key = scanner.absolutize_key(
+          key = relative_keys.absolutize_key(
             '.success',
             'app/controllers/nested/users_controller.rb',
             %w(app/controllers),
@@ -58,7 +63,7 @@ RSpec.describe 'Relative keys' do
 
     context 'relative key in mailer' do
       it 'works' do
-        key = scanner.absolutize_key(
+        key = relative_keys.absolutize_key(
           '.subject',
           'app/mailers/user_mailer.rb',
           %w(app/mailers),
@@ -70,7 +75,7 @@ RSpec.describe 'Relative keys' do
 
       context 'multiple words in mailer name' do
         it 'works' do
-          key = scanner.absolutize_key(
+          key = relative_keys.absolutize_key(
             '.subject',
             'app/mailers/admin_user_mailer.rb',
             %w(app/mailers),
@@ -83,7 +88,7 @@ RSpec.describe 'Relative keys' do
 
       context 'nested in module' do
         it 'works' do
-          key = scanner.absolutize_key(
+          key = relative_keys.absolutize_key(
             '.subject',
             'app/mailers/nested/user_mailer.rb',
             %w(app/mailers),

data/spec/scanners/files/caching_file_finder_provider_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+require 'i18n/tasks/scanners/files/caching_file_finder_provider'
+
+RSpec.describe 'CachingFileFinderProvider' do
+  describe '#get' do
+    it 'provides the same instance for the same arguments' do
+      provider = I18n::Tasks::Scanners::Files::CachingFileFinderProvider.new
+      expect(provider.get(include: ['./a'])).to(
+          be(provider.get(include: ['./a'])))
+    end
+
+    it 'provides different instances for different arguments' do
+      provider = I18n::Tasks::Scanners::Files::CachingFileFinderProvider.new
+      expect(provider.get(include: ['./a'])).to_not(
+          be(provider.get(include: ['./b'])))
+    end
+  end
+end