i18n-tasks 0.8.7 → 0.9.0.rc1

data/spec/scanners/files/caching_file_finder_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+require 'i18n/tasks/scanners/files/caching_file_finder'
+
+RSpec.describe 'CachingFileFinder' do
+  let(:test_files) {
+    %w(a/a/a/a.txt a/a/a.txt a/a/b.txt a/b/a.txt a/b/b.txt a.txt)
+  }
+  describe '#find_files' do
+    it 'accesses the filesystem only once' do
+      begin
+        TestCodebase.setup(test_files.inject({}) { |h, f| h[f] = ''; h })
+        TestCodebase.in_test_app_dir {
+          finder = I18n::Tasks::Scanners::Files::CachingFileFinder.new
+          expect(finder.find_files).to eq test_files.map { |f| File.join('.', f) }
+          TestCodebase.teardown
+          expect(finder.find_files).to eq test_files.map { |f| File.join('.', f) }
+        }
+      ensure
+        TestCodebase.teardown
+      end
+    end
+  end
+
+  describe '#traverse_files' do
+    it 'accesses the filesystem only once' do
+      begin
+        TestCodebase.setup(test_files.inject({}) { |h, f| h[f] = ''; h })
+        TestCodebase.in_test_app_dir {
+          finder = I18n::Tasks::Scanners::Files::CachingFileFinder.new
+          expect(finder.traverse_files { |f| f }).to eq test_files.map { |f| File.join('.', f) }
+          TestCodebase.teardown
+          expect(finder.traverse_files { |f| f }).to eq test_files.map { |f| File.join('.', f) }
+        }
+      ensure
+        TestCodebase.teardown
+      end
+    end
+  end
+end

data/spec/scanners/files/caching_file_reader_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+require 'i18n/tasks/scanners/files/caching_file_reader'
+
+RSpec.describe 'CachingFileReader' do
+  describe '#read_file' do
+    around do |ex|
+      TestCodebase.setup('test.txt' => 'test')
+      TestCodebase.in_test_app_dir { ex.call }
+      TestCodebase.teardown
+    end
+    it 'reads the file only once' do
+      caching_file_reader = I18n::Tasks::Scanners::Files::CachingFileReader.new
+      expect(caching_file_reader.read_file('test.txt')).to eq('test')
+      File.write('test.txt', 'something else')
+      expect(caching_file_reader.read_file('test.txt')).to eq('test')
+    end
+  end
+end

data/spec/scanners/files/file_finder_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+require 'i18n/tasks/scanners/files/file_finder'
+
+RSpec.describe 'FileFinder' do
+  let(:test_files) {
+    %w(a/a/a/a.txt a/a/a.txt a/a/b.txt a/b/a.txt a/b/b.txt a.txt)
+  }
+  around do |ex|
+    TestCodebase.setup(test_files.inject({}) { |h, f| h[f] = ''; h })
+    TestCodebase.in_test_app_dir { ex.call }
+    TestCodebase.teardown
+  end
+
+  describe '#find_files' do
+    it 'finds all the files in the current directory with default options' do
+      finder = I18n::Tasks::Scanners::Files::FileFinder.new
+      expect(finder.find_files).to eq test_files.map { |f| File.join('.', f) }
+    end
+
+    it 'finds only the files in paths' do
+      finder = I18n::Tasks::Scanners::Files::FileFinder.new(paths: %w(a/a a/b/a.txt))
+      expect(finder.find_files).to eq test_files.select { |f| f.start_with?('a/a/') || f == 'a/b/a.txt' }
+    end
+
+    it 'find only the files specified by the inclusion patterns' do
+      finder = I18n::Tasks::Scanners::Files::FileFinder.new(
+          paths: %w(a), include: %w(a/a/**))
+      expect(finder.find_files).to eq test_files.select { |f| f.start_with?('a/a/') }
+    end
+
+    it 'finds only the files not specified by the exclusion patterns' do
+      finder = I18n::Tasks::Scanners::Files::FileFinder.new(
+          exclude: %w(./a/a/**))
+      expect(finder.find_files).to eq test_files.select { |f| !f.start_with?('a/a/') }.map { |f| File.join('.', f) }
+    end
+  end
+
+  describe '#traverse_files' do
+    let(:finder) { I18n::Tasks::Scanners::Files::FileFinder.new }
+
+    it 'yields all the files' do
+      actual = []
+      finder.traverse_files { |f| actual << f }
+      expect(actual).to eq(test_files.map { |f| File.join('.', f) })
+    end
+
+    it 'returns the results from the block' do
+      i = 0
+      expect(finder.traverse_files { |_f| i += 1 }).to eq((1..test_files.length).to_a)
+    end
+  end
+end

data/spec/scanners/files/file_reader_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+require 'i18n/tasks/scanners/files/file_reader'
+
+RSpec.describe 'FileReader' do
+  describe '#read_file' do
+    around do |ex|
+      TestCodebase.setup('test.txt' => 'test')
+      TestCodebase.in_test_app_dir { ex.call }
+      TestCodebase.teardown
+    end
+    it 'reads the file' do
+      expect(I18n::Tasks::Scanners::Files::FileReader.new.read_file('test.txt')).to eq('test')
+    end
+  end
+end

data/spec/scanners/scanner_multiplexer_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+require 'i18n/tasks/scanners/scanner_multiplexer'
+
+RSpec.describe 'ScannerMultiplexer' do
+  describe '#keys' do
+    let(:key_a) { make_key_occurrences 'key.a', [{path: 'a'}] }
+    let(:key_b_1) { make_key_occurrences 'key.b', [{path: 'b1'}] }
+    let(:key_b_2) { make_key_occurrences 'key.b', [{path: 'b2'}] }
+    let(:key_c) { make_key_occurrences 'key.c', [{path: 'c'}] }
+
+    scanner_mock = Struct.new(:keys)
+    let(:scanner_one) { scanner_mock.new([key_a, key_b_1]) }
+    let(:scanner_two) { scanner_mock.new([key_b_2, key_c]) }
+
+    let(:expected_key_occurrences) {
+      [key_a,
+       I18n::Tasks::Scanners::KeyOccurrences.new(key: 'key.b', occurrences: key_b_1.occurrences + key_b_2.occurrences),
+       key_c]
+    }
+
+    it 'returns the merged results' do
+      scanner_multiplexer = I18n::Tasks::Scanners::ScannerMultiplexer.new(scanners: [scanner_one, scanner_two])
+      expect(scanner_multiplexer.keys).to eq expected_key_occurrences
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 ENV['RAILS_ENV'] = ENV['RAKE_ENV'] = 'test'
 
 if ENV['TRAVIS'] && !(defined?(RUBY_ENGINE) && RUBY_ENGINE == 'rbx')
@@ -21,4 +20,5 @@ RSpec.configure do |config|
   config.include FixturesSupport
   config.include CaptureStd
   config.include Trees
+  config.include KeysAndOccurrences
 end

data/spec/support/capture_std.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 require 'active_support/core_ext/kernel/reporting'
 module CaptureStd
   def capture_stderr

data/spec/support/fixtures.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 # quick'n'dirty fixture loader
 module FixturesSupport
   def fixtures_contents

data/spec/support/i18n_tasks_output_matcher.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 RSpec::Matchers.define :be_i18n_keys do |expected|
   def locale_re
     /^\w{2}\b/

data/spec/support/key_pattern_matcher.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 RSpec::Matchers.define :match_key do |key|
   include I18n::Tasks::KeyPatternMatching
 

data/spec/support/keys_and_occurrences.rb

@@ -0,0 +1,27 @@
+module KeysAndOccurrences
+  def make_occurrence(path: '', line: '', pos: 1, line_pos: 1, line_num: 1)
+    ::I18n::Tasks::Scanners::Occurrence.new(path: path, line: line, pos: pos, line_pos: line_pos, line_num: line_num)
+  end
+
+  def make_occurrences(occurrences)
+    occurrences.map { |attr| make_occurrence(attr) }
+  end
+
+  def make_key_occurrences(key, occurrences)
+    ::I18n::Tasks::Scanners::KeyOccurrences.new(key: key, occurrences: make_occurrences(occurrences))
+  end
+
+  # adjust position to account for \r on Windows
+  def adjust_occurrences(data)
+    if Gem.win_platform?
+      data = data.dup
+      data[:occurrences].map! { |occ| adjust_occurrence occ }
+    end
+    data
+  end
+
+  # adjust position to account for \r on Windows
+  def adjust_occurrence(occurrence)
+    occurrence.dup.tap { |o| o.instance_variable_set(:@pos, o.pos + o.line_num - 1) }
+  end
+end

data/spec/support/test_codebase.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 require 'fileutils'
 require 'yaml'
 require_relative 'capture_std'

data/spec/support/trees.rb

@@ -1,13 +1,7 @@
-# coding: utf-8
 module Trees
   def expect_node_key_data(node, key, data)
     expect(node.full_key(root: false)).to eq key
-    if Gem.win_platform?
-      # adjust position to account for \r on Windows
-      data = data.dup
-      data[:source_occurrences].map! { |occ| occ.dup.tap { |o| o[:pos] += o[:line_num] - 1 } }
-    end
-    expect(node.data).to eq data
+    expect(node.data).to eq adjust_occurrences(data)
   end
 
   def build_tree(hash)

data/spec/used_keys_spec.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 require 'spec_helper'
 
 RSpec.describe 'UsedKeys' do
@@ -19,34 +18,34 @@ h1 = t 'b'
     TestCodebase.teardown
   end
 
-  it '#used_keys(source_occurrences: true)' do
-    used   = task.used_tree(source_occurrences: true)
+  it '#used_keys' do
+    used   = task.used_tree
     leaves = used.leaves.to_a
     expect(leaves.size).to eq 2
     expect_node_key_data(
         leaves[0],
         'a',
-        source_occurrences:
-            [{src_path: 'a.html.slim', pos: 6, line_num: 1, line_pos: 7, line: "div = t 'a'"},
-             {src_path: 'a.html.slim', pos: 18, line_num: 2, line_pos: 7, line: "  p = t 'a'"}]
+        occurrences: make_occurrences(
+                         [{path: 'a.html.slim', 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'"}])
     )
 
     expect_node_key_data(
         leaves[1],
         'b',
-        source_occurrences:
-            [{src_path: 'a.html.slim', pos: 29, line_num: 3, line_pos: 6, line: "h1 = t 'b'"}]
+        occurrences: make_occurrences(
+                         [{path: 'a.html.slim', pos: 29, line_num: 3, line_pos: 6, line: "h1 = t 'b'"}])
     )
   end
 
-  it '#used_keys(source_occurrences: true, key_filter: "b*")' do
-    used_keys = task.used_tree(key_filter: 'b*', source_occurrences: true)
+  it '#used_keys(key_filter: "b*")' do
+    used_keys = task.used_tree(key_filter: 'b*')
     expect(used_keys.size).to eq 1
     expect_node_key_data(
         used_keys.leaves.first,
         'b',
-        source_occurrences:
-            [{src_path: 'a.html.slim', pos: 29, line_num: 3, line_pos: 6, line: "h1 = t 'b'"}]
+        occurrences: make_occurrences(
+                         [{path: 'a.html.slim', pos: 29, line_num: 3, line_pos: 6, line: "h1 = t 'b'"}])
     )
   end
 
@@ -61,14 +60,14 @@ h1 = t 'b'
     end
 
     it '#used_keys(source_occurences: true)' do
-      used_keys = task.used_tree(source_occurrences: true)
+      used_keys = task.used_tree
       expect(used_keys.size).to eq 1
       expect_node_key_data(
           used_keys.leaves.first,
           'a',
-          source_occurrences:
-              [{src_path: 'a.html.haml', pos: 15, line_num: 1, line_pos: 16, line: "#first{ title: t('a') }"},
-               {src_path: 'a.html.haml', pos: 40, line_num: 2, line_pos: 17, line: ".second{ title: t('a') }"}]
+          occurrences: make_occurrences(
+                           [{path: 'a.html.haml', pos: 15, line_num: 1, line_pos: 16, line: "#first{ title: t('a') }"},
+                            {path: 'a.html.haml', pos: 40, line_num: 2, line_pos: 17, line: ".second{ title: t('a') }"}])
       )
     end
   end

data/templates/config/i18n-tasks.yml

@@ -70,8 +70,15 @@ search:
   ## If specified, this settings takes priority over `exclude`, but `exclude` still applies.
   # include: ["*.rb", "*.html.slim"]
 
-  ## Default scanner finds t() and I18n.t() calls.
-  # scanner: I18n::Tasks::Scanners::PatternWithScopeScanner
+  ## If `strict` is `false`, guess usages such as t("categories.#{category}.title"). The default is `true`.
+  # strict: true
+
+  ## Multiple scanners can be used. Their results are merged.
+  ## The options specified above are passed down to each scanner. Per-scanner options can be specified as well.
+  ## An array of [scanner class name, scanner options]:
+  # scanners:
+  #   - - I18n::Tasks::Scanners::PatternWithScopeScanner
+  #     - {}
 
 ## Google Translate
 # translation:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-tasks
 version: !ruby/object:Gem::Version
-  version: 0.8.7
+  version: 0.9.0.rc1
 platform: ruby
 authors:
 - glebm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-07 00:00:00.000000000 Z
+date: 2015-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.18
+        version: 4.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.18
+        version: 4.0.2
 - !ruby/object:Gem::Dependency
   name: easy_translate
   requirement: !ruby/object:Gem::Requirement
@@ -253,10 +253,18 @@ files:
 - lib/i18n/tasks/reports/base.rb
 - lib/i18n/tasks/reports/spreadsheet.rb
 - lib/i18n/tasks/reports/terminal.rb
-- lib/i18n/tasks/scanners/base_scanner.rb
+- lib/i18n/tasks/scanners/files/caching_file_finder.rb
+- lib/i18n/tasks/scanners/files/caching_file_finder_provider.rb
+- lib/i18n/tasks/scanners/files/caching_file_reader.rb
+- lib/i18n/tasks/scanners/files/file_finder.rb
+- lib/i18n/tasks/scanners/files/file_reader.rb
+- lib/i18n/tasks/scanners/key_occurrences.rb
+- lib/i18n/tasks/scanners/occurence.rb
 - lib/i18n/tasks/scanners/pattern_scanner.rb
 - lib/i18n/tasks/scanners/pattern_with_scope_scanner.rb
 - lib/i18n/tasks/scanners/relative_keys.rb
+- lib/i18n/tasks/scanners/scanner.rb
+- lib/i18n/tasks/scanners/scanner_multiplexer.rb
 - lib/i18n/tasks/split_key.rb
 - lib/i18n/tasks/stats.rb
 - lib/i18n/tasks/string_interpolation.rb
@@ -264,7 +272,6 @@ files:
 - lib/i18n/tasks/used_keys.rb
 - lib/i18n/tasks/version.rb
 - spec/commands/data_commands_spec.rb
-- spec/commands/missing_commands_spec.rb
 - spec/commands/tree_commands_spec.rb
 - spec/conservative_router_spec.rb
 - spec/file_system_data_spec.rb
@@ -285,12 +292,19 @@ files:
 - spec/plural_keys_spec.rb
 - spec/readme_spec.rb
 - spec/relative_keys_spec.rb
+- spec/scanners/files/caching_file_finder_provider_spec.rb
+- spec/scanners/files/caching_file_finder_spec.rb
+- spec/scanners/files/caching_file_reader_spec.rb
+- spec/scanners/files/file_finder_spec.rb
+- spec/scanners/files/file_reader_spec.rb
+- spec/scanners/scanner_multiplexer_spec.rb
 - spec/spec_helper.rb
 - spec/split_key_spec.rb
 - spec/support/capture_std.rb
 - spec/support/fixtures.rb
 - spec/support/i18n_tasks_output_matcher.rb
 - spec/support/key_pattern_matcher.rb
+- spec/support/keys_and_occurrences.rb
 - spec/support/test_codebase.rb
 - spec/support/trees.rb
 - spec/used_keys_spec.rb
@@ -316,9 +330,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.5
@@ -327,7 +341,6 @@ specification_version: 4
 summary: Manage localization and translation with the awesome power of static analysis
 test_files:
 - spec/commands/data_commands_spec.rb
-- spec/commands/missing_commands_spec.rb
 - spec/commands/tree_commands_spec.rb
 - spec/conservative_router_spec.rb
 - spec/file_system_data_spec.rb
@@ -348,12 +361,19 @@ test_files:
 - spec/plural_keys_spec.rb
 - spec/readme_spec.rb
 - spec/relative_keys_spec.rb
+- spec/scanners/files/caching_file_finder_provider_spec.rb
+- spec/scanners/files/caching_file_finder_spec.rb
+- spec/scanners/files/caching_file_reader_spec.rb
+- spec/scanners/files/file_finder_spec.rb
+- spec/scanners/files/file_reader_spec.rb
+- spec/scanners/scanner_multiplexer_spec.rb
 - spec/spec_helper.rb
 - spec/split_key_spec.rb
 - spec/support/capture_std.rb
 - spec/support/fixtures.rb
 - spec/support/i18n_tasks_output_matcher.rb
 - spec/support/key_pattern_matcher.rb
+- spec/support/keys_and_occurrences.rb
 - spec/support/test_codebase.rb
 - spec/support/trees.rb
 - spec/used_keys_spec.rb