i18n-tasks 0.2.19 → 0.2.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c8a1d39250f5a17141d7e2ef77087cfbb2350723
-  data.tar.gz: 4c24ee7926d87036337ef73c85fd19963f512c9c
+  metadata.gz: ab1b5fe079fcb795dc047f1e0e4f3d777b83c2ef
+  data.tar.gz: 23b4a9f9e87b2f0ed8ac2c8c8a2b1992edc7b90d
 SHA512:
-  metadata.gz: fda620af8e5ed8bb3481d2aa64f7961086eed48ad8958f28f54df723bec60e35f2ad006f01d33e9a51abdd0ce1bf338741c9959cc1c5d286e6f93a8026f6d1c1
-  data.tar.gz: 8f971a9e3024f79310958b5701e9ec255fb14278e3e90464338c42a097cc5fbcbfeaa3e8455975ad5651fc0ceb494f7a5f6c88bce37eecb3d387f8d1871547ce
+  metadata.gz: 4100f55d87da5b5131c3adf1794ae10d2fb4b1de691966ff6b24129bf660fca3035a857d841707ceb8946214926646b28aad8f0b2154b77b294a98422b533cd3
+  data.tar.gz: 335f197c93d93fc41c27600815a74a964851778050d1d699de15be38998f17a3f5e3354dddcb52708ec50151a5a058cab41fd232de814c6b47e18ddfb6768595

data/CHANGES.md

@@ -1,4 +1,8 @@
-## v0.2.17..v0.2.18
+## v0.2.20
+
+* `rake i18n:usages` report
+
+## v0.2.17..v0.2.19
 
 * Bugfixes
 

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Gleb Mazovetskiy
+Copyright (c) 2013-2014 Gleb Mazovetskiy
 
 MIT License
 

data/README.md

@@ -5,6 +5,21 @@ Tasks to manage translations in ruby applications using I18n.
 
 ![i18n-screenshot](https://raw.github.com/glebm/i18n-tasks/master/doc/img/i18n-tasks.gif "i18n-tasks output screenshot")
 
+## Installation
+
+Simply add to Gemfile:
+
+```ruby
+gem 'i18n-tasks', '~> 0.2.20'
+```
+
+If not using Rails, require the tasks in Rakefile:
+
+```ruby
+# Rakefile
+load 'tasks/i18n-tasks.rake'
+```
+
 ## Usage
 
 Use `rake -T i18n` to get the list of tasks with descriptions. These are [the tasks](/lib/tasks/i18n-tasks.rake) available:
@@ -56,29 +71,13 @@ rake i18n:normalize
 `i18n:unused` will detect pattern translations and not report them, e.g.:
 
 ```ruby
-t 'category.' + category.key # 'category.arts_and_crafts' considered used
+t 'category.' + category.key # category.* keys are all considered used
 t "category.#{category.key}" # also works
 ```
 
 Relative keys (`t '.title'`) and plural keys (key.one/many/other/etc) are fully supported.
 
-For more examples see [the tests](/spec/i18n_tasks_spec.rb).
-
-
-## Installation
-
-Simply add to Gemfile:
-
-```ruby
-gem 'i18n-tasks', '~> 0.2.10'
-```
-
-If not using Rails, require the tasks in Rakefile:
-
-```ruby
-# Rakefile
-load 'tasks/i18n-tasks.rake'
-```
+Translation data storage, key usage search, and other [settings](#configuration) are compatible with Rails by default.
 
 ## Configuration
 
@@ -92,24 +91,31 @@ base_locale: en
 locales: [es, fr]
 ```
 
+On Rails, if locales are set in the config file, you can make i18n tasks a lot faster by adding this to `Rakefile`:
+
+```ruby
+# disable loading :environment for i18n-tasks
+Rake::Task['i18n:setup'].clear_prerequisites
+```
+
 ### Storage
 
 ```yaml
 # i18n data storage
 data:
-  # The default YAML adapter supports reading from and writing to YAML files
-  adapter: yaml
+  # The default file adapter supports YAML and JSON files. You can provide a custom class name here.
+  adapter: file_system
   # a list of file globs to read from per-locale
   read: 
-    # this one is default:
+    # default:
     - 'config/locales/%{locale}.yml'
-    # add this one to also read from namespaced files, e.g. simple_form.en.yml:
+    # to also read from namespaced files, e.g. simple_form.en.yml:
     - 'config/locales/*.%{locale}.yml'
   # a list of {key pattern => file} routes, matched top to bottom
   write:
-    # this would save all devise keys in it's own file (per locale):
+    # save all devise keys in it's own file (per locale):
     - ['devise.*', 'config/locales/devise.%{locale}.yml']
-    # this is the default catch-all:
+    # default catch-all:
     - 'config/locales/%{locale}.yml' # path is short for ['*', path]
 ```
 
@@ -127,13 +133,24 @@ Example:
 data:
   write:
     # store sorcery and simple_form keys in the respective files:
-    - ['{sorcery,simple_form}.*', 'config/locales/\\1.%{locale}.yml']
-    # write every namespace to its own file:
+    - ['{sorcery,simple_form}.*', 'config/locales/\1.%{locale}.yml']
+    # write every key namespace to its own file:
     - ['{:}.*', 'config/locales/\1.%{locale}.yml']
 ```
 
 ### Usage search
 
+Inspect all the usages with:
+
+```bash
+rake i18n:usages
+```
+
+![i18n-screenshot](https://raw.github.com/glebm/i18n-tasks/master/doc/img/i18n-usages.png "rake i18n:usages output screenshot")
+
+
+Configure usage search in `config/i18n-tasks.yml`:
+
 ```yaml
 # i18n usage search in source
 search:
@@ -164,8 +181,8 @@ relative_roots:
   - app/views-mobile
 ```
 
-It is also possible to use a key scanner by setting `search.scanner`.
-See [the default scanner](/lib/i18n/tasks/scanners/pattern_scanner.rb) for reference.
+It is also possible to use a custom key usage scanner by setting `search.scanner` to a class name.
+See [the default pattern scanner](/lib/i18n/tasks/scanners/pattern_scanner.rb) for reference.
 
 
 ### Fine-tuning
@@ -215,24 +232,23 @@ You might want to test for missing and unused translations as part of your test
 This is how you can do it with rspec:
 
 ```ruby
-# spec_helper.rb
+# spec/i18n_keys_spec.rb:
+require 'spec_helper'
+
 require 'i18n/tasks'
-require 'i18n/tasks/base_task'
 
-# spec/i18n_keys_spec.rb
-require 'spec_helper'
-describe 'translation keys'  do
+describe 'Translation keys'  do
   let(:i18n) { I18n::Tasks::BaseTask.new }
 
   it 'are all present' do
-    expect(i18n.untranslated_keys).to have(0).keys
+    expect(i18n.missing_keys).to have(0).keys
   end
 
   it 'are all used' do
     expect(i18n.unused_keys).to have(0).keys
   end
-
 end
+
 ```
 
 ## XLSX
@@ -253,7 +269,3 @@ While i18n-tasks does not provide an HTML version of the report, you can add [on
 This was originally developed for [Zuigo](http://zuigo.com/), a platform to organize and discover events.
 
 [MIT license](/LICENSE.txt)
-
-
-[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/glebm/i18n-tasks/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
-

data/i18n-tasks.gemspec

@@ -34,6 +34,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'axlsx', '~> 2.0'
   s.add_development_dependency 'bundler', '~> 1.3'
   s.add_development_dependency 'rake'
-  s.add_development_dependency 'rspec-rails'
+  s.add_development_dependency 'rspec'
   s.add_development_dependency 'yard'
 end

data/lib/i18n/tasks.rb

@@ -1,4 +1,3 @@
-require 'i18n/tasks/version'
 require 'active_support/core_ext/hash'
 require 'active_support/core_ext/string'
 require 'active_support/core_ext/module/delegation'
@@ -6,7 +5,11 @@ require 'active_support/core_ext/object/try'
 require 'active_support/core_ext/object/blank'
 require 'term/ansicolor'
 require 'erubis'
-require 'i18n/tasks/railtie' if defined?(Rails)
+
+require 'i18n/tasks/version'
+require 'i18n/tasks/key'
+require 'i18n/tasks/key_group'
+require 'i18n/tasks/base_task'
 
 module I18n
   module Tasks
@@ -29,3 +32,5 @@ module I18n
     end
   end
 end
+
+require 'i18n/tasks/railtie' if defined?(Rails)

data/lib/i18n/tasks/base_task.rb

@@ -3,11 +3,10 @@ require 'i18n/tasks/configuration'
 require 'i18n/tasks/key_pattern_matching'
 require 'i18n/tasks/relative_keys'
 require 'i18n/tasks/plural_keys'
-require 'i18n/tasks/source_keys'
+require 'i18n/tasks/used_keys'
 require 'i18n/tasks/translation_data'
 require 'i18n/tasks/ignore_keys'
 require 'i18n/tasks/missing_keys'
-require 'i18n/tasks/untranslated_keys'
 require 'i18n/tasks/unused_keys'
 require 'i18n/tasks/google_translation'
 require 'i18n/tasks/fill_tasks'
@@ -21,9 +20,8 @@ module I18n
       include DataTraversal
       include RelativeKeys
       include PluralKeys
-      include SourceKeys
+      include UsedKeys
       include MissingKeys
-      include UntranslatedKeys
       include UnusedKeys
       include TranslationData
       include FillTasks

data/lib/i18n/tasks/configuration.rb

@@ -1,6 +1,4 @@
 module I18n::Tasks::Configuration
-  extend ::ActiveSupport::Concern
-
   # i18n-tasks config (defaults + config/i18n-tasks.yml)
   # @return [Hash{String => String,Hash,Array}]
   def config
@@ -18,7 +16,7 @@ module I18n::Tasks::Configuration
   def data_config
     @config_sections[:data] ||= begin
       conf    = (config[:data] || {}).with_indifferent_access
-      adapter = (conf[:adapter].presence || conf[:class].presence || :yaml).to_s
+      adapter = (conf[:adapter].presence || conf[:class].presence || :file_system).to_s
       if adapter !~ /[A-Z]/
         adapter = "I18n::Tasks::Data::#{adapter.camelize}"
       end
@@ -34,7 +32,7 @@ module I18n::Tasks::Configuration
   # @return [Hash{String => String,Hash,Array}]
   def translation_config
     @config_sections[:translation] ||= begin
-      conf           = (config[:translation] ||= {}).with_indifferent_access
+      conf           = (config[:translation] || {}).with_indifferent_access
       conf[:api_key] ||= ENV['GOOGLE_TRANSLATE_API_KEY']
       conf
     end

data/lib/i18n/tasks/data/adapter/json_adapter.rb

@@ -0,0 +1,22 @@
+require 'json'
+
+module I18n::Tasks
+  module Data
+    module Adapter
+      module JsonAdapter
+        extend self
+
+        # @return [Hash] locale tree
+        def parse(str)
+          JSON.parse(str)
+        end
+
+        # @return [String]
+        def dump(tree)
+          JSON.generate(tree)
+        end
+
+      end
+    end
+  end
+end

data/lib/i18n/tasks/data/adapter/yaml_adapter.rb

@@ -0,0 +1,21 @@
+require 'yaml'
+module I18n::Tasks
+  module Data
+    module Adapter
+      module YamlAdapter
+        extend self
+
+        # @return [Hash] locale tree
+        def parse(str)
+          YAML.load(str)
+        end
+
+        # @return [String]
+        def dump(tree)
+          tree.to_yaml
+        end
+
+      end
+    end
+  end
+end

data/lib/i18n/tasks/data/file_system.rb

@@ -0,0 +1,13 @@
+require 'i18n/tasks/data/storage/file_storage'
+require 'i18n/tasks/data/adapter/json_adapter'
+require 'i18n/tasks/data/adapter/yaml_adapter'
+
+module I18n::Tasks
+  module Data
+    class FileSystem
+      include Storage::FileStorage
+      register_adapter '*.yml', Adapter::YamlAdapter
+      register_adapter '*.json', Adapter::JsonAdapter
+    end
+  end
+end

data/lib/i18n/tasks/data/storage/file_storage.rb

@@ -0,0 +1,105 @@
+require 'i18n/tasks/data_traversal'
+require 'i18n/tasks/key_pattern_matching'
+
+module I18n::Tasks
+  module Data
+    module Storage
+      module FileStorage
+
+        def self.included(base)
+          base.extend KlassMethods
+        end
+
+        include ::I18n::Tasks::DataTraversal
+        include ::I18n::Tasks::KeyPatternMatching
+        attr_reader :config
+
+        DEFAULTS = {
+            read:  ['config/locales/%{locale}.yml'],
+            write: ['config/locales/%{locale}.yml']
+        }.with_indifferent_access
+
+        def initialize(config = {})
+          self.config = config
+        end
+
+        def config=(config)
+          opt          = DEFAULTS.deep_merge((config || {}).with_indifferent_access)
+          @read        = opt[:read]
+          @write       = opt[:write].map { |x| x.is_a?(String) ? ['*', x] : x }.map { |x|
+            [compile_key_pattern(x[0]), x[1]]
+          }
+          @locale_data = {}
+        end
+
+        # get locale tree
+        def get(locale)
+          locale               = locale.to_s
+          @locale_data[locale] ||= begin
+            @read.map do |path|
+              Dir.glob path % {locale: locale}
+            end.flatten.map do |locale_file|
+              load_file locale_file
+            end.inject({}) do |hash, locale_data|
+              hash.deep_merge! locale_data || {}
+              hash
+            end[locale.to_s] || {}
+          end
+        end
+
+        alias [] get
+
+        # set locale tree
+        def set(locale, value_tree)
+          locale = locale.to_s
+          out    = {}
+          traverse value_tree do |key, value|
+            route     = @write.detect { |route| route[0] =~ key }
+            key_match = $~
+            path      = route[1] % {locale: locale}
+            path.gsub!(/[\\]\d+/) { |m| key_match[m[1..-1].to_i] }
+            (out[path] ||= []) << [key, value]
+          end
+          out.each do |path, data|
+            tree = {locale => list_to_tree(data)}
+            write_tree(path, tree)
+          end
+          @locale_data[locale] = nil
+        end
+
+        alias []= set
+
+        def reload
+          @locale_data = {}
+        end
+
+        protected
+
+        def load_file(file)
+          adapter_for(file).parse ::File.read(file)
+        end
+
+        def write_tree(path, tree)
+          ::File.open(path, 'w') { |f| f.write(adapter_for(path).dump(tree)) }
+        end
+
+        def adapter_for(file)
+          self.class.adapter_for(file)
+        end
+
+        module KlassMethods
+          # @param pattern [String] File.fnmatch pattern
+          # @param adapter [responds to parse(string)->hash and dump(hash)->string]
+          def register_adapter(pattern, adapter)
+            (@fn_patterns ||= {})[pattern] = adapter
+          end
+
+          def adapter_for(path)
+            @fn_patterns.detect { |pattern, adapter| ::File.fnmatch(pattern, path) }[1] or
+                raise "Adapter not found for #{path}. Registered adapters: #{@fn_patterns.inspect}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/i18n/tasks/data/yaml.rb

@@ -1,72 +1,13 @@
-require 'i18n/tasks/data_traversal'
-require 'i18n/tasks/key_pattern_matching'
-require 'yaml'
+require 'i18n/tasks/data/file_system'
 
 module I18n::Tasks
   module Data
-    class Yaml
-      include ::I18n::Tasks::DataTraversal
-      include ::I18n::Tasks::KeyPatternMatching
-      attr_reader :config
-
-      DEFAULTS = {
-          read:  ['config/locales/%{locale}.yml'],
-          write: ['config/locales/%{locale}.yml']
-      }.with_indifferent_access
-
-      def initialize(config = {})
-        self.config = config
-      end
-
-      def config=(config)
-        opt    = DEFAULTS.deep_merge((config || {}).with_indifferent_access)
-        @read  = opt[:read]
-        @write = opt[:write].map { |x| x.is_a?(String) ? ['*', x] : x }.map { |x|
-          [compile_key_pattern(x[0]), x[1]]
-        }
-        @locale_data = {}
-      end
-
-      # get locale tree
-      def get(locale)
-        locale = locale.to_s
-        @locale_data[locale] ||= begin
-          @read.map do |path|
-            Dir.glob path % {locale: locale}
-          end.flatten.map do |locale_file|
-            YAML.load_file locale_file
-          end.inject({}) do |hash, locale_data|
-            hash.deep_merge! locale_data || {}
-            hash
-          end[locale.to_s] || {}
-        end
-      end
-
-      alias [] get
-
-      # set locale tree
-      def set(locale, value_tree)
-        locale = locale.to_s
-        out = {}
-        traverse value_tree do |key, value|
-          route = @write.detect { |route| route[0] =~ key }
-          key_match = $~
-          path = route[1] % {locale: locale}
-          path.gsub!(/[\\]\d+/) { |m| key_match[m[1..-1].to_i] }
-          (out[path] ||= []) << [key, value]
-        end
-        out.each do |path, data|
-          tree = { locale => list_to_tree(data) }
-          File.open(path, 'w') { |f| f.write(tree.to_yaml) }
-        end
-        @locale_data[locale] = nil
-      end
-
-      alias []= set
-
-      def reload
-        @locale_data = {}
+    class Yaml < FileSystem
+      def initialize(*args)
+        super
+        I18n::Tasks.warn_deprecated "data.adapter set to 'yaml'. please use 'file_system' instead"
       end
+      register_adapter '*.yml', Adapter::YamlAdapter
     end
   end
 end