i18n-tasks 0.7.8 → 0.7.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: adc5e2843018cd679f4c0ee2b0b424e662d161e5
-  data.tar.gz: e0b636d1930cde221e2c72aac7b46aad29e32130
+  metadata.gz: b44f57ad429c2e9ad05d5f237299ad934190e0dd
+  data.tar.gz: c7cdd740505581db566108513875172f0aad5144
 SHA512:
-  metadata.gz: fd93fca95e142f5b01753b6841b77b1d64f22e4366e38e2777d418dafc6c3b553daacb8ecc3773a28b7816dca3d03f0dd33a10e60882e7147a8eb95c7b9ac6ea
-  data.tar.gz: e2ca0ffa8f077911d495ba53a704ffb1d255a801e6f076e0e1b9b194e047ae7f5d3a412f8b6cb81c27f037cf0a11f50971dadc9aed6dd0dc8a1a8016fa37f0fa
+  metadata.gz: 03118fb5bddbc83d39876598d43442f1d02e9006c1a8d2e4db89b0707f9109551d94afdb1b87aa756af1e596cdca927cb2cbdb7996bd9928ef7229cc6475a113
+  data.tar.gz: ebac18266685ad2eaf436d90aa4a74d833d6486785a642f3918af4c699c234266a9459deaf783fc8fd7dc66adae5d73dc8e3499fde5542f733daa7783d858dca

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 rvm:
-- 2.1.3
+- 2.1.5
 - 2.0.0
 - 1.9.3
 - jruby

data/CHANGES.md

@@ -1,3 +1,8 @@
+## 0.7.9
+
+* Support Rails controller method names by [Jessie A. Young](https://github.com/jessieay). [#46](https://github.com/glebm/i18n-tasks/issues/46)
+* Minor fixes
+
 ## 0.7.8
 
 * Fix Google Translate issues with non-string keys [#100](https://github.com/glebm/i18n-tasks/pull/100)

data/README.md

@@ -1,4 +1,4 @@
-# i18n-tasks [![Build Status][badge-travis]][travis] [![Coverage Status][badge-coverage]][coverage] [![Code Climate][badge-code-climate]][code-climate] [![Gemnasium][badge-gemnasium]][gemnasium]
+# i18n-tasks [![Build Status][badge-travis]][travis] [![Coverage Status][badge-coverage]][coverage] [![Code Climate][badge-code-climate]][code-climate] [![Gemnasium][badge-gemnasium]][gemnasium] [![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/glebm/i18n-tasks?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 i18n-tasks helps you find and manage missing and unused translations.
 
@@ -22,7 +22,7 @@ i18n-tasks can be used with any project using [i18n][i18n-gem] (default in Rails
 Add it to the Gemfile:
 
 ```ruby
-gem 'i18n-tasks', '~> 0.7.8'
+gem 'i18n-tasks', '~> 0.7.9'
 ```
 
 Copy default [configuration file](#configuration) (optional):
@@ -146,7 +146,7 @@ See the full list of tasks with `i18n-tasks --help`.
 
 ✔ Keys relative to the file path they are used in (see [relative roots configuration](#usage-search)) are supported.
 
-✘ Keys relative to `controller.action_name` in Rails controllers are not supported.
+✔ Keys relative to `controller.action_name` in Rails controllers are supported. The closest `def` name is used.
 
 #### Plural keys
 

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

@@ -13,7 +13,7 @@ module I18n
             print_title missing_title(forest)
             print_table headings: [cyan(bold(I18n.t('i18n_tasks.common.locale'))), cyan(bold I18n.t('i18n_tasks.common.key')), I18n.t('i18n_tasks.common.details')] do |t|
               t.rows = sort_by_attr!(forest_to_attr(forest)).map do |a|
-                [{value: cyan(a[:locale]), alignment: :center}, cyan(a[:key]), wrap_string(key_info(a), 60)]
+                [{value: cyan(a[:locale]), alignment: :center}, cyan(a[:key]), key_info(a)]
               end
             end
           else
@@ -143,23 +143,6 @@ module I18n
           [green("#{first[:src_path]}:#{first[:line_num]}"),
            ("(#{I18n.t 'i18n_tasks.common.n_more', count: usages.length - 1})" if usages.length > 1)].compact.join(' ')
         end
-
-        def wrap_string(s, max)
-          chars = []
-          dist  = 0
-          s.chars.each do |c|
-            chars << c
-            dist += 1
-            if c == "\n"
-              dist = 0
-            elsif dist == max
-              dist = 0
-              chars << "\n"
-            end
-          end
-          chars = chars[0..-2] if chars.last == "\n"
-          chars.join
-        end
       end
     end
   end

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

@@ -19,7 +19,7 @@ module I18n::Tasks::Scanners
           conf[:exclude] = Array(conf[:exclude])
         else
           # exclude common binary extensions by default (images and fonts)
-          conf[:exclude] = %w(*.jpg *.png *.gif *.svg *.ico *.eot *.ttf *.woff *.pdf)
+          conf[:exclude] = %w(*.jpg *.png *.gif *.svg *.ico *.eot *.ttf *.woff *.woff2 *.pdf)
         end
         # Regexps for lines to ignore per extension
         if conf[:ignore_lines] && !conf[:ignore_lines].is_a?(Hash)
@@ -28,7 +28,7 @@ module I18n::Tasks::Scanners
         end
         conf[:ignore_lines] ||= {
             'rb'   => %q(^\s*#(?!\si18n-tasks-use)),
-            'haml' => %q(^\s*-\s*#\s*(?!\si18n-tasks-use)),
+            'haml' => %q(^\s*-\s*#(?!\si18n-tasks-use)),
             'slim' => %q(^\s*(?:-#|/)(?!\si18n-tasks-use)),
             'erb'  => %q(^\s*<%\s*#(?!\si18n-tasks-use)),
         }
@@ -126,9 +126,9 @@ module I18n::Tasks::Scanners
       key
     end
 
-    VALID_KEY_CHARS = /[-\w.?!;:]/
+    VALID_KEY_CHARS = /[-\w.?!;]/
     VALID_KEY_RE_STRICT = /^#{VALID_KEY_CHARS}+$/
-    VALID_KEY_RE = /^(#{VALID_KEY_CHARS}|[\#{@}])+$/
+    VALID_KEY_RE = /^(#{VALID_KEY_CHARS}|[:\#{@}])+$/
 
     def valid_key?(key, strict = false)
       return false if @key_filter && @key_filter_pattern !~ key

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

@@ -13,13 +13,13 @@ module I18n::Tasks::Scanners
       text = opts[:text] || read_file(path)
       text.scan(pattern) do |match|
         src_pos = Regexp.last_match.offset(0).first
-        key     = match_to_key(match, path)
-        next unless valid_key?(key, strict)
-        key = key + ':' if key.end_with?('.')
         location = src_location(path, text, src_pos)
-        unless exclude_line?(location[:line], path)
-          keys << [key, data: location]
-        end
+        next if exclude_line?(location[:line], path)
+        key = match_to_key(match, path, location)
+        next unless key
+        key = key + ':' if key.end_with?('.')
+        next unless valid_key?(key, strict)
+        keys << [key, data: location]
       end
       keys
     end
@@ -38,10 +38,31 @@ module I18n::Tasks::Scanners
     # @param [MatchData] match
     # @param [String] path
     # @return [String] full absolute key name
-    def match_to_key(match, path)
+    def match_to_key(match, path, location)
       key = strip_literal(match[0])
-      key = absolutize_key(key, path) if path && key.start_with?('.')
-      key
+      absolute_key(key, path, location)
+    end
+
+    def absolute_key(key, path, location)
+      if key.start_with?('.')
+        if controller_file?(path)
+          absolutize_key(key, path, relative_roots, closest_method(location))
+        else
+          absolutize_key(key, path)
+        end
+      else
+        key
+      end
+    end
+
+    def controller_file?(path)
+      /controllers/.match(path)
+    end
+
+    def closest_method(location)
+      method = File.readlines(location[:src_path]).first(location[:line_num] - 1).reverse_each.find { |x| x=~ /\bdef\b/ }
+      method &&= method.strip.sub(/^def\s*/, '')
+      method
     end
 
     def pattern

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

@@ -20,7 +20,7 @@ module I18n::Tasks::Scanners
     # @param [MatchData] match
     # @param [String] path
     # @return [String] full absolute key name with scope resolved if any
-    def match_to_key(match, path)
+    def match_to_key(match, path, location)
       key   = super
       scope = match[1]
       if scope

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

@@ -6,14 +6,46 @@ module I18n
         # @param key [String] relative i18n key (starts with a .)
         # @param path [String] path to the file containing the key
         # @return [String] absolute version of the key
-        def absolutize_key(key, path, roots = relative_roots)
-          # normalized path
-          path = File.expand_path path
-          (path_root = roots.map { |path| File.expand_path path }.sort.reverse.detect { |root| path.start_with?(root + '/') }) or
-              raise CommandError.new("Error scanning #{path}: cannot resolve relative key \"#{key}\".\nSet relative_roots in config/i18n-tasks.yml (currently #{relative_roots.inspect})")
-          # key prefix based on path
-          prefix = path.gsub(%r(#{path_root}/|(\.[^/]+)*$), '').tr('/', '.').gsub(%r(\._), '.')
-          "#{prefix}#{key}"
+        def absolutize_key(key, path, roots = relative_roots, closest_method = "")
+          normalized_path = File.expand_path(path)
+          path_root(normalized_path, roots) or
+            raise CommandError.new(
+              "Error scanning #{normalized_path}: cannot resolve relative key
+              \"#{key}\".\nSet relative_roots in config/i18n-tasks.yml
+              (currently #{relative_roots.inspect})"
+            )
+
+          prefix_key_based_on_path(key, normalized_path, roots, closest_method: closest_method)
+        end
+
+        private
+
+        # Detect the appropriate relative path root
+        # @param [String] path /full/path
+        # @param [Array<String>] roots array of full paths
+        # @return [String] the closest ancestor root for path
+        def path_root(path, roots)
+          expanded_relative_roots(roots).sort.reverse_each.detect do |root|
+            path.start_with?(root + '/')
+          end
+        end
+
+        def expanded_relative_roots(roots)
+          roots.map { |path| File.expand_path(path) }
+        end
+
+        def prefix_key_based_on_path(key, normalized_path, roots, options = {})
+          "#{prefix(normalized_path, roots, options)}#{key}"
+        end
+
+        def prefix(normalized_path, roots, options = {})
+          file_name = normalized_path.gsub(%r(#{path_root(normalized_path, roots)}/|(\.[^/]+)*$), '')
+
+          if options[:closest_method].present?
+            "#{file_name.split('_').first}.#{options[:closest_method]}"
+          else
+            file_name.tr('/', '.').gsub(%r(\._), '.')
+          end
         end
       end
     end

data/lib/i18n/tasks/version.rb

@@ -1,6 +1,6 @@
 # coding: utf-8
 module I18n
   module Tasks
-    VERSION = '0.7.8'
+    VERSION = '0.7.9'
   end
 end

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

@@ -1,5 +1,8 @@
 # coding: utf-8
 class EventsController < ApplicationController
+  def create
+  end
+
   def show
     redirect_to :edit, notice: I18n.t('cb.a')
 
@@ -26,5 +29,11 @@ class EventsController < ApplicationController
 
     # not missing
     I18n.t "hash.#{stuff}.a"
+
+    # relative key
+    I18n.t(".success")
+  end
+
+  def update
   end
 end

data/spec/fixtures/config/i18n-tasks.yml

@@ -32,7 +32,11 @@ search:
     - '*.file'
   # explicitly exclude files (default: blank = exclude no files)
   exclude: '*.js'
-  # search uses grep under the hood
+  # paths for relative key resolution:
+  relative_roots:
+    - app/views
+    - app/controllers
+
 
 # do not report these keys ever
 ignore:

data/spec/google_translate_spec.rb

@@ -9,7 +9,7 @@ describe 'Google Translation' do
       nil_value_test = ['nil-value-key', nil, nil],
       text_test      = ['key', "Hello - %{user} O'neill!", "Hola - %{user} O'neill!"],
       html_test      = ['html-key.html', "Hello - <b>%{user} O'neill</b>", "Hola - <b>%{user} O'neill</b>"],
-      array_test     = ['array-key', ['Hello.', nil, '', 'Goodbye.'], ['Hola.', nil, '', 'Adiós.']],
+      array_test     = ['array-key', ['Hello.', nil, '', 'Goodbye.'], ['¡Hola.', nil, '', '¡Adiós.']],
       fixnum_test    = ['numeric-key', 1, 1],
   ]
 

data/spec/i18n_spec.rb

@@ -8,11 +8,11 @@ describe 'I18n' do
 
   it 'does not have missing keys' do
     expect(missing_keys).to be_empty,
-                            "Missing #{missing_keys.leaves.count} i18n keys, run `i18n-tasks missing' to show them"
+      "Missing #{missing_keys.leaves.count} i18n keys, run `i18n-tasks missing' to show them"
   end
 
   it 'does not have unused keys' do
-    expect(i18n.unused_keys).to be_empty,
-                                "#{unused_keys.leaves.count} unused i18n keys, run `i18n-tasks unused' to show them"
+    expect(unused_keys).to be_empty,
+      "#{unused_keys.leaves.count} unused i18n keys, run `i18n-tasks unused' to show them"
   end
 end

data/spec/i18n_tasks_spec.rb

@@ -18,21 +18,28 @@ describe 'i18n-tasks' do
 
   describe 'missing' do
     let (:expected_missing_keys) {
-      %w( en.used_but_missing.key en.relative.index.missing
+      %w( en.used_but_missing.key
+          en.relative.index.missing
           es.missing_in_es.a
           en.present_in_es_but_not_en.a
-          en.hash.pattern_missing.a en.hash.pattern_missing.b
-          en.missing_symbol_key en.missing_symbol.key_two en.missing_symbol.key_three
-          es.missing_in_es_plural_1.a es.missing_in_es_plural_2.a
+          en.hash.pattern_missing.a
+          en.hash.pattern_missing.b
+          en.missing_symbol_key
+          en.missing_symbol.key_two
+          en.missing_symbol.key_three
+          es.missing_in_es_plural_1.a
+          es.missing_in_es_plural_2.a
           en.missing-key-with-a-dash.key
           en.missing-key-question?.key
-          en.fn_comment en.only_in_es
+          en.fn_comment
+          en.only_in_es
+          en.events.show.success
         )
     }
     it 'detects missing' do
       capture_stderr do
-        expect(run_cmd :missing).to be_i18n_keys expected_missing_keys
         es_keys = expected_missing_keys.grep(/^es\./)
+        expect(run_cmd :missing).to be_i18n_keys expected_missing_keys
         # locale argument
         expect(run_cmd :missing, locales: %w(es)).to be_i18n_keys es_keys
         expect(run_cmd :missing, arguments: %w(es)).to be_i18n_keys es_keys
@@ -48,8 +55,18 @@ describe 'i18n-tasks' do
     end
   end
 
-  let(:expected_unused_keys) { %w(unused.a unused.numeric unused.plural).map { |k| %w(en es).map { |l| "#{l}.#{k}" } }.reduce(:+) }
-  let(:expected_unused_keys_strict) { expected_unused_keys + %w(hash.pattern.a hash.pattern2.a).map { |k| %w(en es).map { |l| "#{l}.#{k}" } }.reduce(:+) }
+  let(:expected_unused_keys) do
+     %w(unused.a unused.numeric unused.plural).map do |k|
+      %w(en es).map { |l| "#{l}.#{k}" }
+    end.reduce(:+)
+  end
+
+  let(:expected_unused_keys_strict) do
+    expected_unused_keys + %w(hash.pattern.a hash.pattern2.a).map do |k|
+      %w(en es).map { |l| "#{l}.#{k}" }
+    end.reduce(:+)
+  end
+
   describe 'unused' do
     it 'detects unused' do
       capture_stderr do

data/spec/pattern_scanner_spec.rb

@@ -2,21 +2,57 @@
 require 'spec_helper'
 
 describe 'Pattern Scanner' do
-  describe 'default pattern' do
+  describe 'scan_file' do
+    it 'returns absolute keys from controllers' do
+      file_path = 'spec/fixtures/app/controllers/events_controller.rb'
+      scanner = I18n::Tasks::Scanners::PatternScanner.new
+      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=>788,
+            :line_num=>34,
+            :line_pos=>10,
+            :line =>"    I18n.t(\".success\")"}
+           }
+         ]
+      )
+    end
+  end
+
+  describe 'default_pattern' do
     let!(:pattern) { I18n::Tasks::Scanners::PatternScanner.new.default_pattern }
 
-    ['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 |s|
-      it "matches #{s}" do
-        expect(pattern).to match s
+    [
+      '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
       end
     end
 
-    ["t \"a.b'", "t a.b"].each do |s|
-      it "does not match #{s}" do
-        expect(pattern).to_not match s
+    ["t \"a.b'", "t a.b"].each do |string|
+      it "does not match #{string}" do
+        expect(pattern).to_not match string
       end
     end
   end

data/spec/relative_keys_spec.rb

@@ -17,6 +17,19 @@ describe 'Relative keys' do
       end
     end
 
-  end
+    context 'relative key in controller' do
+      it 'works' do
+        base_scanner = I18n::Tasks::Scanners::BaseScanner.new
+
+        key = base_scanner.absolutize_key(
+          '.success',
+          'app/controllers/users_controller.rb',
+          %w(app/controllers),
+          'create'
+        )
 
+        expect(key).to eq('users.create.success')
+      end
+    end
+  end
 end

data/templates/rspec/i18n_spec.rb

@@ -8,11 +8,11 @@ describe 'I18n' do
 
   it 'does not have missing keys' do
     expect(missing_keys).to be_empty,
-                            "Missing #{missing_keys.leaves.count} i18n keys, run `i18n-tasks missing' to show them"
+      "Missing #{missing_keys.leaves.count} i18n keys, run `i18n-tasks missing' to show them"
   end
 
   it 'does not have unused keys' do
-    expect(i18n.unused_keys).to be_empty,
-                                "#{unused_keys.leaves.count} unused i18n keys, run `i18n-tasks unused' to show them"
+    expect(unused_keys).to be_empty,
+      "#{unused_keys.leaves.count} unused i18n keys, run `i18n-tasks unused' to show them"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-tasks
 version: !ruby/object:Gem::Version
-  version: 0.7.8
+  version: 0.7.9
 platform: ruby
 authors:
 - glebm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-22 00:00:00.000000000 Z
+date: 2014-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis
@@ -334,7 +334,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.4.4
 signing_key: 
 specification_version: 4
 summary: Manage localization and translation with the awesome power of static analysis