i18n-tasks 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8f89d95e642baf84d0f2db83a184cdbfaca5fdb
-  data.tar.gz: a2051af98f8ea1c9eac7ee7b201ac1680e30b82c
+  metadata.gz: 0268bd9f81bcf59f191082abc4d7659858b01307
+  data.tar.gz: 0feb0bd995b09220bb7ae0843a3cc67c01cfd938
 SHA512:
-  metadata.gz: 6856046b53147ee028f7491f975694769ec069bd3740f288fd44b069764562ca818a253b333520f3bc670091d0fa4dfba4bed25b9e36c48bbbdfa726c10431a7
-  data.tar.gz: 258eae7c4f1909161f8fb494e3bc3d40afa7998058f4e0fbd836838340eec38680d0bc61b88a8234adc4166875a6f5003c864038db75204ca5f79f13b844c707
+  metadata.gz: 3514ce68ee51f2b90028fbb87cd5b1e249cc66ebe41f9b746e65d39e87b00b2a372099f8e3d2abf9f28e829d0e8cb8d6fc68f64c6ac6c25f029aa307d8b37c5e
+  data.tar.gz: 339eec064e4f2fa5b52182113aafe7f819ef2c5d1917901556a0f3d228e85ef661afb640876677b653fdfb1327adc0539ab447e3d2b8c41f8c0fe3327e148d8a

data/CHANGES.md

@@ -1,7 +1,12 @@
+## 0.5.2
+
+* Ignore lines during search with `config.search.ignore_lines`. Ignores comments by default.
+* Fixed minor issues with `i18-tasks config` output.
+
 ## 0.5.1
 
 * Fix [conservative router](https://github.com/glebm/i18n-tasks#conservative-router).
-* Default router is now the default.
+* Conservative router is now the default.
 
 ## 0.5.0
 

data/README.md

@@ -6,7 +6,7 @@ The default approach to locale data management with gems such as [i18n][i18n-gem
 If you use a key that does not exist, this will only blow up at runtime. Keys left over from removed code accumulate
 in the resource files and introduce unnecessary overhead on the translators. Translation files can quickly turn to disarray.
 
-i18n-tasks improves this by i18n-tasks analysing code statically, without running it. It scans calls such as `I18n.t('some.key')` and provides reports on key usage, missing, and unused keys.
+i18n-tasks improves this by analysing code statically, without running it. It scans calls such as `I18n.t('some.key')` and provides reports on key usage, missing, and unused keys.
 It can also pre-fill missing keys, including from Google Translate, and it can remove unused keys as well.
 
 i18n-tasks can be used with any project using [i18n][i18n-gem] (default in Rails), or similar, even if it isn't ruby.
@@ -18,7 +18,7 @@ i18n-tasks can be used with any project using [i18n][i18n-gem] (default in Rails
 Add to Gemfile:
 
 ```ruby
-gem 'i18n-tasks', '~> 0.5.1'
+gem 'i18n-tasks', '~> 0.5.2'
 ```
 
 
@@ -203,13 +203,14 @@ data:
 ##### Conservative router
 
 Conservative router keeps the keys where they are found, or infers the path from base locale.
-If the key is completely new, conservative router will fall back to the pattern router behaviour.
+If the key is completely new, conservative router will fall back to pattern router behaviour.
 Conservative router is the default router.
 
 ```
 data:
   router: conservative_router
   write:
+    - ['devise.*', 'config/locales/devise.%{locale}.yml']
     - 'config/locales/%{locale}.yml'
 ```
 
@@ -243,11 +244,14 @@ search:
     - '*.rb'
     - '*.html.*'
     - '*.text.*'
-  # explicitly exclude files (default: blank = exclude no files)
+  # explicitly exclude files (default: exclude common binary files)
   exclude:
     - '*.js'
   # you can override the default key regex pattern:
   pattern: "\\bt[( ]\\s*(:?\".+?\"|:?'.+?'|:\\w+)"
+  # comments are ignored by default
+  ignore_lines:
+    - "^\\s*[#/](?!\\si18n-tasks-use)"
 ```
 
 To configure paths for relative key resolution:
@@ -327,12 +331,12 @@ describe 'I18n' do
   let(:i18n) { I18n::Tasks::BaseTask.new }
 
   it 'does not have missing keys' do
-    count = i18n.missing_keys.count
+    count = i18n.missing_keys.leaves.count
     fail "There are #{count} missing i18n keys! Run 'i18n-tasks missing' for more details." unless count.zero?
   end
 
   it 'does not have unused keys' do
-    count = i18n.unused_keys.count
+    count = i18n.unused_keys.leaves.count
     fail "There are #{count} unused i18n keys! Run 'i18n-tasks unused' for more details." unless count.zero?
   end
 end

data/lib/i18n/tasks/configuration.rb

@@ -108,7 +108,7 @@ module I18n::Tasks::Configuration
   def config_for_inspect
     # hide empty sections, stringify keys
     Hash[config_sections.reject { |k, v| v.nil? || v.empty? }.map { |k, v|
-      [k.to_s, v.respond_to?(:deep_stringify_keys) ? v.deep_stringify_keys : v] }].tap do |h|
+      [k.to_s, v.respond_to?(:deep_stringify_keys) ? v.deep_stringify_keys.to_hash : v] }].tap do |h|
       h.each do |_k, v|
         if v.is_a?(Hash) && v.key?('config')
           v.merge! v.delete('config')

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

@@ -10,7 +10,7 @@ module I18n::Tasks
     class FileSystemBase
       include ::I18n::Tasks::Data::FileFormats
 
-      attr_reader :config
+      attr_reader :config, :base_locale
 
       DEFAULTS = {
           read:  ['config/locales/%{locale}.yml'],
@@ -18,7 +18,8 @@ module I18n::Tasks
       }.with_indifferent_access
 
       def initialize(config = {})
-        self.config = config
+        @base_locale = config[:base_locale]
+        self.config = config.except(:base_locale)
       end
 
       # get locale tree
@@ -96,7 +97,7 @@ module I18n::Tasks
           if name[0] != name[0].upcase
             name = "I18n::Tasks::Data::Router::#{name.classify}"
           end
-          name.constantize.new(self, @config)
+          name.constantize.new(self, @config.merge(base_locale: base_locale))
         end
       end
       attr_writer :router
@@ -114,10 +115,6 @@ module I18n::Tasks
           end
         end.reduce(:merge!) || Tree::Siblings.null
       end
-
-      def base_locale
-        config[:base_locale]
-      end
     end
   end
 end

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

@@ -66,8 +66,6 @@ module I18n::Tasks::Data::Tree
       !children
     end
 
-    attr_writer :leaf
-
     # a node with key nil is considered Empty. this is to allow for using these nodes instead of nils
     def root?
       !parent?

data/lib/i18n/tasks/ignore_keys.rb

@@ -19,7 +19,7 @@ module I18n::Tasks::IgnoreKeys
         patterns = global + type_ignore
       elsif type_ignore.is_a?(Hash)
         # ignore per locale
-        patterns = global + (type_ignore[:all] || []) +
+        patterns = global + (type_ignore['all'] || []) +
             type_ignore.select { |k, v| k.to_s =~ /\b#{locale}\b/ }.values.flatten(1).compact
       end
       compile_patterns_re patterns

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

@@ -7,10 +7,10 @@ module I18n::Tasks::Scanners
     include ::I18n::Tasks::KeyPatternMatching
     include ::I18n::Tasks::Logging
 
-    attr_reader :config, :key_filter, :record_src_loc
+    attr_reader :config, :key_filter, :ignore_lines_re
 
     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?
         if conf.key?(:exclude)
@@ -19,8 +19,14 @@ module I18n::Tasks::Scanners
           # exclude common binary extensions by default (images and fonts)
           conf[:exclude] = %w(*.jpg *.png *.gif *.svg *.ico *.eot *.ttf *.woff *.pdf)
         end
+        conf[:ignore_lines] ||= %q(^\s*[#/](?!\si18n-tasks-use)).freeze
+        conf[:ignore_lines] = Array(conf[:ignore_lines])
+        @ignore_lines_re = conf[:ignore_lines].map { |line| Regexp.new(line) }
       end
-      @record_src_loc = false
+    end
+
+    def exclude_line?(line)
+      ignore_lines_re.any? { |re| re =~ line }
     end
 
     def key_filter=(value)
@@ -28,21 +34,14 @@ module I18n::Tasks::Scanners
       @key_filter_pattern = compile_key_pattern(value) if @key_filter
     end
 
-    # @return [Array] keys used in source, absolutized and unique
+    # @return [Array<{key,data:{source_locations:[]}}]
     def keys
-      @keys ||= (traverse_files { |path| scan_file(path) }.reduce(:+) || []).uniq(&:first)
-    end
-
-    # @return [Array<{key,usages}]
-    def keys_with_source_locations
-      recording_source_locations do
-        keys = traverse_files { |path|
-          scan_file(path)
-        }.reduce(:+) || []
-        keys.group_by(&:first).map { |key, key_loc|
-          [key, data: {source_locations: key_loc.map { |(k, attr)| attr[:data] }}]
-        }
-      end
+      keys = traverse_files { |path|
+        scan_file(path)
+      }.reduce(:+) || []
+      keys.group_by(&:first).map { |key, key_loc|
+        [key, data: {source_locations: key_loc.map { |(k, attr)| attr[:data] }}]
+      }
     end
 
     def read_file(path)
@@ -87,37 +86,23 @@ module I18n::Tasks::Scanners
       self.key_filter = filter_was
     end
 
-    def recording_source_locations
-      was             = @record_src_loc
-      @record_src_loc = true
-      yield
-    ensure
-      @record_src_loc = was
-    end
-
     protected
 
     def path_fnmatch_any?(path, globs)
       globs.any? { |glob| File.fnmatch(glob, path) }
     end
 
-    def src_location(path, text, src_pos)
-      src = {src_path: path}
-      if @record_src_loc
-        src.merge!(src_text_location(text, src_pos))
+    def src_location(path, text, src_pos, position = true)
+      data = {src_path: path}
+      if position
+        line_begin = text.rindex(/^/, src_pos - 1)
+        line_end   = text.index(/.(?=\n|$)/, src_pos)
+        data.merge! 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
-      src
-    end
-
-    def src_text_location(text, src_pos)
-      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]
-      }
+      data
     end
 
     # remove the leading colon and unwrap quotes from the key match

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

@@ -13,7 +13,10 @@ module I18n::Tasks::Scanners
         src_pos = Regexp.last_match.offset(0).first
         key     = match_to_key(match, path)
         next unless valid_key?(key)
-        keys << [key, data: src_location(path, text, src_pos)]
+        location = src_location(path, text, src_pos)
+        unless exclude_line?(location[:line])
+          keys << [key, data: location]
+        end
       end
       keys
     end
@@ -44,7 +47,7 @@ module I18n::Tasks::Scanners
     end
 
     def translate_call_re
-      /\bt(?:ranslate)?/
+      /(?<=^|[^\w'\-])t(?:ranslate)?/
     end
 
     # Match literals:

data/lib/i18n/tasks/used_keys.rb

@@ -6,12 +6,11 @@ module I18n::Tasks
   module UsedKeys
 
     # find all keys in the source (relative keys are absolutized)
-    # @option opts [false|true] :source_locations
     # @option opts [String] :key_filter
     # @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]
-      key_attrs = opts[:source_locations] ? scanner.keys_with_source_locations : scanner.keys
+      key_attrs = scanner.keys
       Data::Tree::Node.new(
           key: 'used',
           data: {key_filter: scanner.key_filter},

data/lib/i18n/tasks/version.rb

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

data/spec/fixtures/app/views/index.html.slim

@@ -1,3 +1,7 @@
+| x't :fp_quote_before
+| x-t :fp_dash_before
+/ t(:fp_comment)
+/ i18n-tasks-use t(:fn_comment)
 p #{t('ca.a')} #{t 'ca.b'} #{t "ca.c"}
 p #{t 'ca.d'} #{t 'ca.f', i: 'world'} #{t 'ca.e', i: 'world'}
 p #{t 'missing_in_es.a'} #{t 'same_in_es.a'} #{t 'blank_in_es.a'}

data/spec/i18n_tasks_spec.rb

@@ -14,6 +14,7 @@ describe 'i18n-tasks' do
           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.fn_comment
         )
     }
     it 'detects missing or identical' do

data/spec/locale_tree/siblings_spec.rb

@@ -6,7 +6,6 @@ describe 'Tree siblings / forest' do
   context 'Node' do
     it '::new with children' do
       children = I18n::Tasks::Data::Tree::Siblings.from_key_attr([['a', value: 1]])
-      #require 'byebug'; byebug
       node = I18n::Tasks::Data::Tree::Node.new(
           key: 'fr',
           children: children

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-tasks
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - glebm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-22 00:00:00.000000000 Z
+date: 2014-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis
@@ -201,8 +201,6 @@ files:
 - README.md
 - Rakefile
 - bin/i18n-tasks
-- config/locales/en.yml
-- config/locales/es.yml
 - i18n-tasks.gemspec
 - lib/i18n/tasks.rb
 - lib/i18n/tasks/base_task.rb

data/config/locales/en.yml

@@ -1,4 +0,0 @@
----
-en:
-  y: 3
-  z: 4

data/config/locales/es.yml

@@ -1 +0,0 @@
---- {}