i18n-tasks 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 334c00605d3e55a82e36c72359bdf31a17bd54f2
-  data.tar.gz: f0240ff3e7452b1509c18cc0b5c33f6eecd8b7ec
+  metadata.gz: f361cd15dc7c4dbe60aedba3245481fb4180b91e
+  data.tar.gz: 5c1fa95a09f2cf826c12eb913145f91e2906758a
 SHA512:
-  metadata.gz: 53a6c2668b4a31bc8049b2c0b08ea4c76aa0e30e6740c83a70878820965a77efa8d47f2639407b21e8b306ea6a9e581c344933b484f737a650dd4f3df0991392
-  data.tar.gz: 9a50045d591c8aa773e31e2223739eb814ab9010e8a7d6f9b603c76fe0bbd791c643ebbbd8acc1954eec3b241febefaf652a4f67a7514b59552dacaf68d2f9fb
+  metadata.gz: db244b5be78460bac7f310996b389fd71296a788509700d07ae86b2f4ac68e920b70dc1293febebba07e5b7871a4c4b42c3856ec042fdbd9e64d2a13a1e71624
+  data.tar.gz: 24a7dff3fb48aa9d4b8371143669a491d079bbffc1630a97964607627293b7ae70a9576d4dda4241dbf9b11f8eea44a6f1c7b697cb3c9910f28a77a9dbd54301

data/CHANGES.md

@@ -1,3 +1,10 @@
+## 0.6.2
+
+* New task to show locale data: `i18n-tasks data`
+* New output format: `keys`, e.g. `i18n-tasks data -fkeys`
+* Fix an issue with a top-level dynamic key breaking unused detection [#75](https://github.com/glebm/i18n-tasks/issues/75)
+* Document [magic comment hints](https://github.com/glebm/i18n-tasks#fine-tuning)
+
 ## 0.6.1
 
 * Fix Google Translate issue with plural keys and missing billing info error

data/README.md

@@ -11,14 +11,14 @@ It can also pre-fill missing keys, including from Google Translate, and it can r
 
 i18n-tasks can be used with any project using [i18n][i18n-gem] (default in Rails), or similar, even if it isn't ruby.
 
-<img width="534" height="288" src="https://raw.github.com/glebm/i18n-tasks/master/doc/img/i18n-tasks.png">
+<img width="539" height="331" src="https://raw.github.com/glebm/i18n-tasks/master/doc/img/i18n-tasks.png">
 
 ## Installation
 
 Add to Gemfile:
 
 ```ruby
-gem 'i18n-tasks', '~> 0.6.0'
+gem 'i18n-tasks', '~> 0.6.2'
 ```
 
 
@@ -267,8 +267,14 @@ See this basic [pattern scanner](/lib/i18n/tasks/scanners/pattern_scanner.rb) fo
 
 ### Fine-tuning
 
-Tasks may incorrectly report framework i18n keys as missing, also some patterns may not be detected.
-When all else fails, use the options below.
+Add hints to static analysis with magic comment hints (lines starting with `(#|/) i18n-tasks-use` by default):
+
+```ruby
+# i18n-tasks-use t('activerecord.models.user') # let i18n-tasks know the key is used
+User.model_name.human
+```
+
+You can also explicitly ignore keys appearing in locale files:
 
 ```yaml
 # config/i18n-tasks.yml

data/i18n-tasks.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.version       = I18n::Tasks::VERSION
   s.authors       = ['glebm']
   s.email         = ['glex.spb@gmail.com']
-  s.summary       = %q{Manage translations in ruby applications with the awesome power of static analysis — Edit}
+  s.summary       = %q{Manage localization and translation with the awesome power of static analysis}
   s.description   = %q{
 i18n-tasks helps you find and manage missing and unused translations.
 

data/lib/i18n/tasks/commands.rb

@@ -17,7 +17,7 @@ module I18n::Tasks
         },
         format: proc {
           on '-f', :format=,
-             'Format: terminal-table, terminal-tree, json, yaml. Default: terminal-table.',
+             "Output format: #{VALID_TREE_FORMATS * ', '}. Default: terminal-table.",
              {default: 'terminal-table', argument: true, optional: false}
         }
     }
@@ -61,6 +61,15 @@ module I18n::Tasks
       print_locale_tree i18n.used_tree(key_filter: opt[:filter].presence, source_locations: true), opt, :used_keys
     end
 
+    desc 'show locale data'
+    opts do
+      instance_exec &OPT[:locale]
+      instance_exec &OPT[:format]
+    end
+    cmd :data do |opt = {}|
+      parse_locales! opt
+      print_locale_tree i18n.data_forest(opt[:locales]), opt
+    end
 
     desc 'translate missing keys with Google Translate'
     opts do

data/lib/i18n/tasks/commands_base.rb

@@ -27,7 +27,7 @@ module I18n::Tasks
     end
 
 
-    VALID_TREE_FORMATS = %w(terminal-table yaml json inspect)
+    VALID_TREE_FORMATS = %w(terminal-table yaml json keys inspect)
 
     def print_locale_tree(tree, opt, version = :show_tree)
       format = opt[:format] || VALID_TREE_FORMATS.first
@@ -37,7 +37,9 @@ module I18n::Tasks
           terminal_report.send(version, tree)
         when 'inspect'
           puts tree.inspect
-        else
+        when 'keys'
+          puts tree.key_names(root: true)
+        when *i18n.data.adapter_names.map(&:to_s)
           puts i18n.data.adapter_dump tree, i18n.data.adapter_by_name(format)
       end
     end

data/lib/i18n/tasks/data.rb

@@ -17,6 +17,12 @@ module I18n::Tasks
       end
     end
 
+    def data_forest(locales = self.locales)
+      locales.inject(Tree::Siblings.new) do |tree, locale|
+        tree.merge! data[locale]
+      end
+    end
+
     def t(key, locale = base_locale)
       data.t(key, locale)
     end

data/lib/i18n/tasks/data/file_formats.rb

@@ -17,6 +17,10 @@ module I18n
           self.class.adapter_by_name(path)
         end
 
+        def adapter_names
+          self.class.adapter_names
+        end
+
         def adapter_dump(tree, adapter_info)
           adapter_name, adapter_pattern, adapter = adapter_info
           adapter_options = (config[adapter_name] || {})[:write]
@@ -51,6 +55,10 @@ module I18n
             } or raise CommandError.new("Adapter not found for #{path}. Registered adapters: #{@fn_patterns.inspect}")
           end
 
+          def adapter_names
+            @fn_patterns.map(&:first)
+          end
+
           def adapter_by_name(name)
             name = name.to_s
             @fn_patterns.detect { |(adapter_name, _pattern, _adapter)|

data/lib/i18n/tasks/key_pattern_matching.rb

@@ -33,7 +33,7 @@ module I18n::Tasks::KeyPatternMatching
   def key_match_pattern(k)
     @key_match_pattern ||= {}
     @key_match_pattern[k] ||= begin
-      "#{k.gsub(KEY_INTERPOLATION_RE, '*')}#{'*' if k.end_with?('.')}"
+      "#{k.gsub(KEY_INTERPOLATION_RE, ':')}#{':' if k.end_with?('.')}"
     end
   end
 

data/lib/i18n/tasks/used_keys.rb

@@ -44,7 +44,12 @@ 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| key_match_pattern(k) }
+        patterns = used_key_names.select { |k| key_expression?(k) }.map { |k|
+          pattern = key_match_pattern(k)
+          # disallow patterns with no keys
+          next if pattern =~ /\A(:\.)*:\z/
+          pattern
+        }.compact
         compile_key_pattern "{#{patterns * ','}}"
       end
     end

data/lib/i18n/tasks/version.rb

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

data/templates/config/i18n-tasks.yml

@@ -1,4 +1,4 @@
-# i18n-tasks find and manage missing and unused translations ⚙ https://github.com/glebm/i18n-tasks
+# i18n-tasks finds and manages missing and unused translations ⚙ https://github.com/glebm/i18n-tasks
 
 base_locale: en
 ## i18n-tasks detects locales automatically from the existing locale files
@@ -60,6 +60,11 @@ search:
   # ignore_lines:
   #  - "^\\s*[#/](?!\\si18n-tasks-use)"
 
+## Google Translate
+# translation:
+#   # Get an API key and set billing info at https://code.google.com/apis/console to use Google Translate
+#   api_key: "AbC-dEf5"
+
 ## Consider these keys not missing
 # ignore_missing:
 #   - pagination.views.*

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-tasks
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - glebm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-17 00:00:00.000000000 Z
+date: 2014-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis
@@ -292,8 +292,7 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Manage translations in ruby applications with the awesome power of static
-  analysis — Edit
+summary: Manage localization and translation with the awesome power of static analysis
 test_files:
 - spec/conservative_router_spec.rb
 - spec/file_system_data_spec.rb