i18n-tasks 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 68c94e2f16413ec396e24e366c2d22107423e5e4
-  data.tar.gz: 16680455229c39bbfd63b57e6ebeac977041ff98
+  metadata.gz: 188bad44ecd17931f47d9a52c8c757090f01b44c
+  data.tar.gz: b2be17a08191fed3f80262d829c0a2d6251d3318
 SHA512:
-  metadata.gz: a5410cf4b6b5c92058a751fbde9302b8a0fb5c65e3d640e296b6148364ceba9e93eb4299ea07c84c911d7c616129115d3220c042c6e7d56af2bf20cc9d21e06e
-  data.tar.gz: fff053a40cc87b6c183930cda9b3db27849b94969cfaf32bec104bdf89015e3764d8eb6ca6997fba2c76d51ad994dae2d38302f57a353c281b6281e414bf61af
+  metadata.gz: 2ceecebcd0b87015d6d5487f7a4e6e658f76a066d3960cf7b55e741ecbd7f99445c8110cb5b7a33f18f1319d27c6fbab014a7209e57033c071dc220fd815d419
+  data.tar.gz: 1de63c98ea3c1e7ad37cd00359e8e7e1cda7cdadfa454b44a7e7ae9a84a0b7789c96828d3093e3ac2bd45095f303fe21f9e4d65d7c37cbd356047505139cc077

data/CHANGES.md

@@ -1,3 +1,7 @@
+## v0.3.5
+
+* `config.locales` is now picked up by default from paths do data files. `base_locale` defaults to `en`.
+
 ## v0.3.3..v0.3.4
 
 * Bugfixes

data/README.md

@@ -11,20 +11,12 @@ This information is inferred based on the keys the gem detects used with calls s
 
 ## Installation
 
-1. Add to Gemfile:
+Add to Gemfile:
 
   ```ruby
   gem 'i18n-tasks', '~> 0.3.2'
   ```
 
-2. Create a config file at `config/i18n-tasks.yml`:
-
-  ```yaml
-  # config/i18n-tasks.yml
-  base_locale: en
-  locales: [es, fr] # This includes base_locale by default
-  ```
-
 ## Usage
 
 Run `i18n-tasks` to get the list of tasks with short descriptions.
@@ -112,9 +104,8 @@ Inspect configuration with `i18n-tasks config`.
 
 ### Locales
 
-By default, i18n-tasks will read `I18n.default_locale` and `I18n.available_locales`.
-However, i18n-tasks does not load application environment by default,
-so it is recommended to set locale settings explicitly:
+By default, `base_locale` is set to `en` and `locales` are inferred from the paths to data files.
+You can override these in the config:
 
 ```yaml
 # config/i18n-tasks.yml
@@ -127,6 +118,7 @@ locales: [es, fr] # This includes base_locale by default
 The default data adapter supports YAML and JSON files.
 
 ```yaml
+# config/i18n-tasks.yml
 # i18n data storage
 data:
   # file_system is the default adapter, you can provide a custom class name here:
@@ -156,6 +148,7 @@ data:
 Example:
 
 ```yaml
+# config/i18n-tasks.yml
 data:
   write:
     # store sorcery and simple_form keys in the respective files:
@@ -170,6 +163,7 @@ data:
 Configure usage search in `config/i18n-tasks.yml`:
 
 ```yaml
+# config/i18n-tasks.yml
 # i18n usage search in source
 search:
   # search these directories (relative to your Rails.root directory, default: 'app/')
@@ -191,6 +185,7 @@ search:
 To configure paths for relative key resolution:
 
 ```yaml
+# config/i18n-tasks.yml
 # directories containing relative keys
 relative_roots:
   # default:
@@ -209,6 +204,7 @@ Tasks may incorrectly report framework i18n keys as missing, also some patterns
 When all else fails, use the options below.
 
 ```yaml
+# config/i18n-tasks.yml
 # do not report these keys as unused
 ignore_unused:
   - category.*.db_name
@@ -240,6 +236,7 @@ ignore:
 Put the key in `GOOGLE_TRANSLATE_API_KEY` environment variable or in the config file.
 
 ```yaml
+# config/i18n-tasks.yml
 translation:
   api_key: <Google Translate API key>
 ```

data/bin/i18n-tasks

@@ -28,15 +28,11 @@ if command
   args = command[2]
 
   if opts.empty? && args.empty?
-    if ENV['VERBOSE']
-      STDERR.puts Term::ANSIColor.green "i18n-tasks: run #{meth.tr('_', '-')} without arguments"
-    end
+    ::I18n::Tasks.log_verbose "run #{meth.tr('_', '-')} without arguments"
     cmd.send meth
   else
     opts = opts.merge(arguments: args) unless args.empty?
-    if ENV['VERBOSE']
-      STDERR.puts Term::ANSIColor.green "i18n-tasks: run #{meth.tr('_', '-')} with #{opts.map { |k, v| "#{k}=#{v}" } * ' '}"
-    end
+    ::I18n::Tasks.log_verbose "run #{meth.tr('_', '-')} with #{opts.map { |k, v| "#{k}=#{v}" } * ' '}"
     cmd.send meth, opts
   end
 else

data/i18n-tasks.gemspec

@@ -10,13 +10,12 @@ Gem::Specification.new do |s|
   s.email         = ['glex.spb@gmail.com']
   s.summary       = %q{Manage translations in ruby applications with the awesome power of static analysis — Edit}
   s.description   = %q{
-The basic approach to i18n key management in frameworks such as Rails has many flaws.
-
+The basic approach to i18n key management in frameworks such as Rails is far from perfect.
 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, introducing unnecessary overhead on the translators.
-Translation files can quickly turn to disarray.
+in the resource files, introducing unnecessary overhead on the translators. Translation files can quickly turn to disarray.
 
-i18n-tasks solves this problem with static analysis.
+i18n-tasks improves this by using static analysis. It provides tasks to find and manage missing and unused translations.
+This information is inferred based on the keys the gem detects used with calls such as `I18n.t` when scanning the code.
 }
   s.homepage      = 'https://github.com/glebm/i18n-tasks'
   if s.respond_to?(:metadata=)

data/lib/i18n/tasks.rb

@@ -25,10 +25,7 @@ module I18n
           HashWithIndifferentAccess.new.merge(file.presence || {})
         end
       end
-
-      def warn_deprecated(message)
-        STDERR.puts Term::ANSIColor.yellow Term::ANSIColor.bold "i18n-tasks: [DEPRECATED] #{message}"
-      end
+      include ::I18n::Tasks::Logging
     end
   end
 end

data/lib/i18n/tasks/base_task.rb

@@ -10,6 +10,7 @@ require 'i18n/tasks/missing_keys'
 require 'i18n/tasks/unused_keys'
 require 'i18n/tasks/google_translation'
 require 'i18n/tasks/fill_tasks'
+require 'i18n/tasks/logging'
 
 module I18n
   module Tasks
@@ -26,6 +27,7 @@ module I18n
       include TranslationData
       include FillTasks
       include GoogleTranslation
+      include Logging
 
       def initialize(config = {})
         self.config = config || {}

data/lib/i18n/tasks/commands_base.rb

@@ -1,6 +1,7 @@
 require 'ostruct'
 module I18n::Tasks
   class CommandsBase
+    include ::I18n::Tasks::Logging
     def locales_opt(locales)
       return i18n_task.locales if locales == ['all'] || locales == 'all'
       if locales.present?
@@ -14,9 +15,7 @@ module I18n::Tasks
 
     def locales_opt_or_args(opt)
       locales_opt(opt[:arguments].presence || opt[:locales]).tap do |locales|
-        if ENV['VERBOSE']
-          STDERR.puts Term::ANSIColor.green "i18n-tasks: locales are #{locales.inspect}"
-        end
+        log_verbose "locales for the command are #{locales.inspect}"
       end
     end
 

data/lib/i18n/tasks/configuration.rb

@@ -48,18 +48,26 @@ module I18n::Tasks::Configuration
   # @return [Array<String>] all available locales, base_locale is always first
   def locales
     @config_sections[:locales] ||= begin
-      locales = (config[:locales] || I18n.available_locales).map(&:to_s)
-      if locales.include?(base_locale)
-        [base_locale] + (locales - [base_locale])
+      locales = config[:locales]
+      locales ||= data.available_locales
+      locales = locales.map(&:to_s)
+      locales = if locales.include?(base_locale)
+                  [base_locale] + (locales - [base_locale])
+                else
+                  [base_locale] + locales
+                end
+      if config[:locales]
+        log_verbose "config.locales set to #{locales}"
       else
-        [base_locale] + locales
+        log_verbose "config.locales inferred from data #{locales}"
       end
+      locales
     end
   end
 
   # @return [String] default i18n locale
   def base_locale
-    @config_sections[:base_locale] ||= config[:base_locale] || I18n.default_locale.to_s
+    @config_sections[:base_locale] ||= (config[:base_locale] || 'en').to_s
   end
 
   # evaluated configuration (as the app sees it)

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

@@ -71,6 +71,28 @@ module I18n::Tasks
 
         def reload
           @locale_data = {}
+          @available_locales = nil
+          self
+        end
+
+        # Get available locales from the list of file names to read
+        def available_locales
+          @available_locales ||= begin
+            locales = Set.new
+            @read.map do |pattern|
+              [pattern, Dir.glob(pattern % {locale: '*'})] if pattern.include?('%{locale}')
+            end.compact.each do |pattern, paths|
+              p  = pattern.gsub('\\', '\\\\').gsub('/', '\/').gsub('.', '\.')
+              p  = p.gsub(/(\*+)/) { $1 == '**' ? '.*' : '[^/]*?' }.gsub('%{locale}', '([^/.]+)')
+              re = /\A#{p}\z/
+              paths.each do |path|
+                if re =~ path
+                  locales << $1
+                end
+              end
+            end
+            locales
+          end
         end
 
         protected

data/lib/i18n/tasks/logging.rb

@@ -0,0 +1,15 @@
+module I18n::Tasks::Logging
+  def warn_deprecated(message)
+    log_stderr Term::ANSIColor.yellow Term::ANSIColor.bold "i18n-tasks: [DEPRECATED] #{message}"
+  end
+
+  def log_verbose(message)
+    if ENV['VERBOSE']
+      log_stderr Term::ANSIColor.green "i18n-tasks: #{message}"
+    end
+  end
+
+  def log_stderr(*args)
+    STDERR.puts *args
+  end
+end

data/lib/i18n/tasks/missing_keys.rb

@@ -26,7 +26,7 @@ module I18n::Tasks
     end
 
     def untranslated_keys(locales = nil)
-      I18n::Tasks.warn_deprecated("#untranslated_keys. Please use #missing_keys instead")
+      warn_deprecated '#untranslated_keys. Please use #missing_keys instead'
       missing_keys(locales: locales)
     end
 

data/lib/i18n/tasks/version.rb

@@ -1,5 +1,5 @@
 module I18n
   module Tasks
-    VERSION = '0.3.4'
+    VERSION = '0.3.5'
   end
 end

data/spec/file_system_data_spec.rb

@@ -1,41 +1,73 @@
 require 'spec_helper'
 
 describe 'File system i18n' do
+  describe '#available_locales' do
+    before do
+      TestCodebase.setup(
+          'config/locales/en.yml' => {en: {}},
+          'config/locales/es.yml' => {es: {}},
+          'config/locales/other.fr.yml' => {fr: {}}
+      )
+    end
+    after do
+      TestCodebase.teardown
+    end
+    let(:data) { I18n::Tasks::Data::FileSystem.new }
+    it 'default pattern' do
+      data.config = {read: ['config/locales/%{locale}.yml']}
+      TestCodebase.in_test_app_dir {
+        expect(data.available_locales.sort).to eq(%w(en es).sort)
+      }
+    end
+    it 'more inclusive pattern' do
+      data.config = {read: ['config/locales/*%{locale}.yml']}
+      TestCodebase.in_test_app_dir {
+        expect(data.available_locales.sort).to eq(%w(en es fr).sort)
+      }
+    end
+    it 'another pattern' do
+      data.config = {read: ['config/locales/*.%{locale}.yml']}
+      TestCodebase.in_test_app_dir {
+        expect(data.available_locales.sort).to eq(%w(fr).sort)
+      }
+    end
+  end
+
   describe 'yml' do
-      let!(:data) { I18n::Tasks::Data::FileSystem.new }
-      after { TestCodebase.teardown }
+    let(:data) { I18n::Tasks::Data::FileSystem.new }
+    after { TestCodebase.teardown }
 
-      it 'reads' do
-        data.config = {read: ['a.yml', '{b,c}.yml']}
-        TestCodebase.setup(
-            'a.yml' => {en: {a: 1}}.stringify_keys.to_yaml,
-            'b.yml' => {en: {b: 1}}.stringify_keys.to_yaml,
-            'c.yml' => {en: {c: 1}}.stringify_keys.to_yaml
-        )
-        TestCodebase.in_test_app_dir {
-          data[:en].symbolize_keys.should == {a: 1, b: 1, c: 1}
-        }
-      end
+    it '#get' do
+      data.config = {read: ['a.yml', '{b,c}.yml']}
+      TestCodebase.setup(
+          'a.yml' => {en: {a: 1}}.stringify_keys.to_yaml,
+          'b.yml' => {en: {b: 1}}.stringify_keys.to_yaml,
+          'c.yml' => {en: {c: 1}}.stringify_keys.to_yaml
+      )
+      TestCodebase.in_test_app_dir {
+        expect(data[:en].symbolize_keys).to eq(a: 1, b: 1, c: 1)
+      }
+    end
 
-      it 'writes' do
-        data.config = {read: 'a.yml', write: [['{:}.*', '\1.%{locale}.yml']]}
-        keys        = {'a' => {'b' => 'c'}, 'x' => 'y'}
-        locale_data = {'pizza' => keys, 'sushi' => keys}
-        TestCodebase.setup
-        TestCodebase.in_test_app_dir {
-          data[:en] = locale_data
-          files     = %w(pizza.en.yml sushi.en.yml)
-          Dir['*.yml'].sort.should == files.sort
-          files.each { |f| YAML.load_file(f)['en'].should == {File.basename(f, '.en.yml') => keys} }
-        }
-      end
+    it '#set' do
+      data.config = {read: 'a.yml', write: [['{:}.*', '\1.%{locale}.yml']]}
+      keys        = {'a' => {'b' => 'c'}, 'x' => 'y'}
+      locale_data = {'pizza' => keys, 'sushi' => keys}
+      TestCodebase.setup
+      TestCodebase.in_test_app_dir {
+        data[:en] = locale_data
+        files     = %w(pizza.en.yml sushi.en.yml)
+        Dir['*.yml'].sort.should == files.sort
+        files.each { |f| YAML.load_file(f)['en'].should == {File.basename(f, '.en.yml') => keys} }
+      }
+    end
   end
 
   describe 'json' do
     let!(:data) {
       I18n::Tasks::Data::FileSystem.new(
-        read:  ['config/locales/%{locale}.json'],
-        write: ['config/locales/%{locale}.json']
+          read:  ['config/locales/%{locale}.json'],
+          write: ['config/locales/%{locale}.json']
       )
     }
     after { TestCodebase.teardown }
@@ -48,7 +80,7 @@ describe 'File system i18n' do
           'c.json' => {en: {c: 1}}.stringify_keys.to_json
       )
       TestCodebase.in_test_app_dir {
-        data[:en].symbolize_keys.should == {a: 1, b: 1, c: 1}
+        expect(data[:en].symbolize_keys).to eq(a: 1, b: 1, c: 1)
       }
     end
 

data/spec/plural_keys_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe 'Plural keys' do
+  let(:task) { ::I18n::Tasks::BaseTask.new }
+  before do
+    TestCodebase.setup('config/locales/en.yml' => '')
+    TestCodebase.in_test_app_dir do
+      task.data['en'] = {
+          'regular_key'       => 'a',
+          'plural_key'        => {
+              'one' => 'one', 'other' => '%{count}'
+          },
+          'not_really_plural' => {
+              'one'   => 'a',
+              'green' => 'b'
+          }
+      }
+      task.data['en']
+    end
+  end
+
+  describe '#depluralize_key' do
+    it 'depluralizes plural keys' do
+      expect(depluralize('plural_key.one')).to eq('plural_key')
+    end
+
+    it 'ignores regular keys' do
+      expect(depluralize('regular_key')).to eq('regular_key')
+    end
+
+    it 'ignores keys that look like plural but are not' do
+      expect(depluralize('not_really_plural.one')).to eq('not_really_plural.one')
+    end
+
+    def depluralize(key)
+      task.depluralize_key('en', key)
+    end
+  end
+
+  after do
+    TestCodebase.teardown
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: i18n-tasks
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - glebm
@@ -180,13 +180,12 @@ dependencies:
         version: '0'
 description: |2
 
-  The basic approach to i18n key management in frameworks such as Rails has many flaws.
-
+  The basic approach to i18n key management in frameworks such as Rails is far from perfect.
   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, introducing unnecessary overhead on the translators.
-  Translation files can quickly turn to disarray.
+  in the resource files, introducing unnecessary overhead on the translators. Translation files can quickly turn to disarray.
 
-  i18n-tasks solves this problem with static analysis.
+  i18n-tasks improves this by using static analysis. It provides tasks to find and manage missing and unused translations.
+  This information is inferred based on the keys the gem detects used with calls such as `I18n.t` when scanning the code.
 email:
 - glex.spb@gmail.com
 executables:
@@ -224,6 +223,7 @@ files:
 - lib/i18n/tasks/key/usages.rb
 - lib/i18n/tasks/key_group.rb
 - lib/i18n/tasks/key_pattern_matching.rb
+- lib/i18n/tasks/logging.rb
 - lib/i18n/tasks/missing_keys.rb
 - lib/i18n/tasks/plural_keys.rb
 - lib/i18n/tasks/relative_keys.rb
@@ -249,6 +249,7 @@ files:
 - spec/key_group_spec.rb
 - spec/key_pattern_matching_spec.rb
 - spec/pattern_scanner_spec.rb
+- spec/plural_keys_spec.rb
 - spec/readme_spec.rb
 - spec/relative_keys_spec.rb
 - spec/spec_helper.rb
@@ -297,6 +298,7 @@ test_files:
 - spec/key_group_spec.rb
 - spec/key_pattern_matching_spec.rb
 - spec/pattern_scanner_spec.rb
+- spec/plural_keys_spec.rb
 - spec/readme_spec.rb
 - spec/relative_keys_spec.rb
 - spec/spec_helper.rb