translation 1.17 → 1.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 12113892c41a14c8d164e01d9d9c2339a92436f8
-  data.tar.gz: 403abefb4765377f59d145bb39fcfe477099cde3
+SHA256:
+  metadata.gz: 2e21e49a9aac4d9fec598b037a0411544b374003fd08ba033bcd3c4f27e7c118
+  data.tar.gz: 06de16c4833d428ba8ab90b441dda1c58b130ef1e5c03294e34971a262bec576
 SHA512:
-  metadata.gz: c67cb77f2af77d56b26cfa9869196df3d62f478c3236a11cfdc5fa180d500c5795bbaab08a75920d5e88a1bd48c46a54d97e290dc48772b9ef1920d54582e7a6
-  data.tar.gz: 196ada47e46d5bebdb347b314ca02f3035018341b18d9d57fa4ef39943705588546b1c96173af53ab0f543e1eb7bdaac4b8b788733806f371c6dc768405db555
+  metadata.gz: 1e0c55227bb61dba3b05273b2ee5289bbc4b74ce290d4fce1a7f5aa495da3db60cd56a31eaa5ffca276fc1c1c7c48469ffc0d2cf7addd51ebcbe45bbee89d238
+  data.tar.gz: 484b10782d68c7f626c3c68c337087223ac28610d622fca6b08300642a2cb8acb4ee185ed7903cd19d3ee72130ce1dda5168b26127f05ed52f8f3eeab3d07115

data/README.md

@@ -40,9 +40,10 @@ Table of contents
    * [Locally](#locally)
  * [Continuous Integration](#continuous-integration)
  * [Advanced Configuration Options](#advanced-configuration-options)
-   * [Disable GetText](#disable-gettext)
+   * [Disable GetText or YAML](#disable-gettext-or-yaml)
    * [Ignored YAML keys](#ignored-yaml-keys)
    * [Source file formats (for GetText)](#source-file-formats-for-gettext)
+   * [Gems with GetText strings](#gems-with-gettext-strings)
    * [Custom localization key prefixes](#custom-localization-key-prefixes)
    * [Paths where locales are stored (not recommended)](#paths-where-locales-are-stored-not-recommended)
  * [Pure Ruby (without Rails)](#pure-ruby-without-rails)
@@ -265,9 +266,9 @@ More examples here: https://translation.io/blog/rails-i18n-with-locale
 
 ## Continuous Integration
 
-If you want fresh translations in your Continuous Integration workflow, you may find yourself calling `bundle exec rake translation:sync` very frequently. 
+If you want fresh translations in your Continuous Integration workflow, you may find yourself calling `bundle exec rake translation:sync` very frequently.
 
-Since this task can't be concurrently executed (we have a [mutex](https://en.wikipedia.org/wiki/Mutual_exclusion) strategy with a queue but it returns an error under heavy load), we implemented this threadsafe readonly task: 
+Since this task can't be concurrently executed (we have a [mutex](https://en.wikipedia.org/wiki/Mutual_exclusion) strategy with a queue but it returns an error under heavy load), we implemented this threadsafe readonly task:
 
 ```bash
 $ bundle exec rake translation:sync_readonly
@@ -281,12 +282,9 @@ The `TranslationIO.configure` block in `config/initializers/translation.rb` can
 
 Some options are described below but for an exhaustive list, please refer to [config.rb](https://github.com/translation/rails/blob/master/lib/translation_io/config.rb).
 
-### Disable GetText
+### Disable GetText or YAML
 
-Sometimes, you only want to use YAML and don't want to be bothered by GetText at all.
-For these cases, you just have to add `disable_gettext` in the config file.
-
-For example:
+If you want to only use YAML files and totally ignore GetText syntax, use:
 
 ```ruby
 TranslationIO.configure do |config|
@@ -296,6 +294,17 @@ TranslationIO.configure do |config|
 end
 ```
 
+In contrast, if you only want to synchronize GetText files and leave the YAML
+files unchanged, use:
+
+```ruby
+TranslationIO.configure do |config|
+  ...
+  config.disable_yaml = true
+  ...
+end
+```
+
 ### Ignored YAML keys
 
 Sometimes you would like to ignore some YAML keys coming from gems or so.
@@ -342,6 +351,19 @@ TranslationIO.configure do |config|
 end
 ```
 
+### Gems with GetText strings
+
+Public gems usually don't make use of GetText strings, but if you created and localized your own gems
+with the GetText syntax, you'll want to be able to synchronize them:
+
+```ruby
+TranslationIO.configure do |config|
+  ...
+  config.parsed_gems = ['your_gem_name']
+  ...
+end
+```
+
 ### Custom localization key prefixes
 
 Rails YAML files contain not only translation strings but also localization values (integers, arrays, booleans)

data/lib/translation.rb

@@ -5,8 +5,6 @@ module TranslationIO
     :nsgettext, :pgettext, :npgettext, :sgettext, :ngettext, :gettext,
     :np_, :ns_, :Nn_, :n_, :p_, :s_, :N_, :_
   ]
-
-  TEXT_DOMAIN = 'app'
 end
 
 require 'translation_io/config'
@@ -33,7 +31,7 @@ module TranslationIO
 
       yield @config
 
-      unless @config.disable_gettext
+      if !@config.disable_gettext
         require_gettext_dependencies
         add_missing_locales
         add_parser_for_erb_source_formats(@config.erb_source_formats)
@@ -45,12 +43,14 @@ module TranslationIO
         # include is private until Ruby 2.1
         Proxy.send(:include, GetText)
 
-        Proxy.bindtextdomain(TEXT_DOMAIN, {
-          :path           => @config.locales_path,
-          :output_charset => @config.charset
-        })
+        @config.bound_text_domains.each do |bound_text_domain|
+          Proxy.bindtextdomain(bound_text_domain, {
+            :path           => @config.locales_path,
+            :output_charset => @config.charset
+          })
+        end
 
-        Proxy.textdomain(TEXT_DOMAIN)
+        Proxy.textdomain(@config.text_domain)
         Object.delegate *GETTEXT_METHODS, :to => Proxy
       end
 

data/lib/translation_io/client/base_operation/create_new_mo_files_step.rb

@@ -9,8 +9,10 @@ module TranslationIO
         def run
           TranslationIO.info "Creating new MO files."
 
-          Dir["#{@locales_path}/*/#{TEXT_DOMAIN}.po"].each do |po_path|
-            mo_path = "#{File.dirname(po_path)}/LC_MESSAGES/app.mo"
+          text_domain = TranslationIO.config.text_domain
+
+          Dir["#{@locales_path}/*/#{text_domain}.po"].each do |po_path|
+            mo_path = "#{File.dirname(po_path)}/LC_MESSAGES/#{text_domain}.mo"
             TranslationIO.info mo_path, 2, 2
             FileUtils.mkdir_p(File.dirname(mo_path))
             GetText::Tools::MsgFmt.run(po_path, '-o', mo_path)

data/lib/translation_io/client/base_operation/save_new_po_files_step.rb

@@ -11,9 +11,11 @@ module TranslationIO
         def run
           TranslationIO.info "Saving new PO files."
 
+          text_domain = TranslationIO.config.text_domain
+
           @target_locales.each do |target_locale|
             if @parsed_response.has_key?("po_data_#{target_locale}")
-              po_path = File.join(@locales_path, Locale::Tag.parse(target_locale).to_s, "#{TEXT_DOMAIN}.po")
+              po_path = File.join(@locales_path, Locale::Tag.parse(target_locale).to_s, "#{text_domain}.po")
               FileUtils.mkdir_p(File.dirname(po_path))
               TranslationIO.info po_path, 2, 2
 

data/lib/translation_io/client/init_operation.rb

@@ -19,7 +19,7 @@ module TranslationIO
         yaml_locales_path = config.yaml_locales_path
         yaml_file_paths   = config.yaml_file_paths
 
-        unless config.disable_gettext
+        if !config.disable_gettext
           BaseOperation::DumpMarkupGettextKeysStep.new(haml_source_files, :haml).run
           BaseOperation::DumpMarkupGettextKeysStep.new(slim_source_files, :slim).run
         end
@@ -27,27 +27,34 @@ module TranslationIO
         UpdatePotFileStep.new(pot_path, source_files + erb_source_files).run(params)
         UpdateAndCollectPoFilesStep.new(target_locales, pot_path, locales_path).run(params)
 
-        create_yaml_pot_files_step = CreateYamlPoFilesStep.new(source_locale, target_locales, yaml_file_paths)
-        create_yaml_pot_files_step.run(params)
+        if !config.disable_yaml
+          create_yaml_pot_files_step = CreateYamlPoFilesStep.new(source_locale, target_locales, yaml_file_paths)
+          create_yaml_pot_files_step.run(params)
 
-        all_used_yaml_locales = create_yaml_pot_files_step.all_used_yaml_locales.to_a.map(&:to_s).sort
+          all_used_yaml_locales = create_yaml_pot_files_step.all_used_yaml_locales.to_a.map(&:to_s).sort
 
-        warn_source_locale_unfound(source_locale, all_used_yaml_locales)
-        warn_target_locale_unfound(target_locales, all_used_yaml_locales)
+          warn_source_locale_unfound(source_locale, all_used_yaml_locales)
+          warn_target_locale_unfound(target_locales, all_used_yaml_locales)
+        end
 
         TranslationIO.info "Sending data to server (it may take some time, please be patient. Sync will be faster)."
 
         uri             = URI("#{client.endpoint}/projects/#{client.api_key}/init")
         parsed_response = BaseOperation.perform_request(uri, params)
 
-        unless parsed_response.nil?
-          BaseOperation::SaveNewPoFilesStep.new(target_locales, locales_path, parsed_response).run
-          BaseOperation::SaveNewYamlFilesStep.new(target_locales, yaml_locales_path, parsed_response).run
-          BaseOperation::SaveSpecialYamlFilesStep.new(source_locale, target_locales, yaml_locales_path, yaml_file_paths).run
-          CleanupYamlFilesStep.new(source_locale, target_locales, yaml_file_paths, yaml_locales_path).run
-          BaseOperation::CreateNewMoFilesStep.new(locales_path).run
+        if !parsed_response.nil?
+          if !config.disable_gettext
+            BaseOperation::SaveNewPoFilesStep.new(target_locales, locales_path, parsed_response).run
+            BaseOperation::CreateNewMoFilesStep.new(locales_path).run
+          end
+
+          if !config.disable_yaml
+            BaseOperation::SaveNewYamlFilesStep.new(target_locales, yaml_locales_path, parsed_response).run
+            BaseOperation::SaveSpecialYamlFilesStep.new(source_locale, target_locales, yaml_locales_path, yaml_file_paths).run
+            CleanupYamlFilesStep.new(source_locale, target_locales, yaml_file_paths, yaml_locales_path).run
+            info_yaml_directory_structure
+          end
 
-          info_yaml_directory_structure
           info_project_url(parsed_response)
         end
 

data/lib/translation_io/client/init_operation/update_and_collect_po_files_step.rb

@@ -11,8 +11,10 @@ module TranslationIO
         def run(params)
           TranslationIO.info "Updating PO files."
 
+          text_domain = TranslationIO.config.text_domain
+
           @target_locales.each do |target_locale|
-            po_path = "#{@locales_path}/#{Locale::Tag.parse(target_locale).to_s}/#{TEXT_DOMAIN}.po"
+            po_path = "#{@locales_path}/#{Locale::Tag.parse(target_locale).to_s}/#{text_domain}.po"
             TranslationIO.info po_path, 2, 2
 
             if File.exist?(po_path)

data/lib/translation_io/client/sync_operation.rb

@@ -22,15 +22,20 @@ module TranslationIO
         yaml_locales_path = config.yaml_locales_path
         yaml_file_paths   = config.yaml_file_paths
 
-        ApplyYamlSourceEditsStep.new(yaml_file_paths, source_locale).run(params)
+        if !config.disable_yaml
+          ApplyYamlSourceEditsStep.new(yaml_file_paths, source_locale).run(params)
+        end
 
-        unless config.disable_gettext
+        if !config.disable_gettext
           BaseOperation::DumpMarkupGettextKeysStep.new(haml_source_files, :haml).run
           BaseOperation::DumpMarkupGettextKeysStep.new(slim_source_files, :slim).run
         end
 
         UpdatePotFileStep.new(pot_path, source_files + erb_source_files).run(params)
-        CreateYamlPotFileStep.new(source_locale, yaml_file_paths).run(params)
+
+        if !config.disable_yaml
+          CreateYamlPotFileStep.new(source_locale, yaml_file_paths).run(params)
+        end
 
         if purge
           params['purge'] = 'true'
@@ -45,11 +50,16 @@ module TranslationIO
         uri             = URI("#{client.endpoint}/projects/#{client.api_key}/sync")
         parsed_response = BaseOperation.perform_request(uri, params)
 
-        unless parsed_response.nil?
-          BaseOperation::SaveNewPoFilesStep.new(target_locales, locales_path, parsed_response).run
-          BaseOperation::CreateNewMoFilesStep.new(locales_path).run
-          BaseOperation::SaveNewYamlFilesStep.new(target_locales, yaml_locales_path, parsed_response).run
-          BaseOperation::SaveSpecialYamlFilesStep.new(source_locale, target_locales, yaml_locales_path, yaml_file_paths).run
+        if !parsed_response.nil?
+          if !config.disable_gettext
+            BaseOperation::SaveNewPoFilesStep.new(target_locales, locales_path, parsed_response).run
+            BaseOperation::CreateNewMoFilesStep.new(locales_path).run
+          end
+
+          if !config.disable_yaml
+            BaseOperation::SaveNewYamlFilesStep.new(target_locales, yaml_locales_path, parsed_response).run
+            BaseOperation::SaveSpecialYamlFilesStep.new(source_locale, target_locales, yaml_locales_path, yaml_file_paths).run
+          end
 
           display_unused_segments(parsed_response, show_purgeable, purge)
 

data/lib/translation_io/config.rb

@@ -1,24 +1,36 @@
 module TranslationIO
   class Config
-    attr_accessor :api_key, :locales_path, :yaml_locales_path
-    attr_accessor :source_locale, :target_locales
+    attr_accessor :api_key
+    attr_accessor :source_locale
+    attr_accessor :target_locales
     attr_accessor :endpoint
+    attr_accessor :metadata_path
     attr_accessor :verbose
     attr_accessor :test
 
+    attr_accessor :disable_yaml
+
+    attr_accessor :yaml_locales_path
     attr_accessor :ignored_key_prefixes
+    attr_accessor :localization_key_prefixes
+
+    attr_accessor :disable_gettext
+
+    attr_accessor :locales_path
+
     attr_accessor :ignored_source_paths
     attr_accessor :ignored_source_files
 
+    attr_accessor :parsed_gems
+
     attr_accessor :source_formats
     attr_accessor :erb_source_formats
     attr_accessor :haml_source_formats
     attr_accessor :slim_source_formats
 
-    attr_accessor :localization_key_prefixes
-    attr_accessor :disable_gettext
+    attr_accessor :text_domain
+    attr_accessor :bound_text_domains
     attr_accessor :charset
-    attr_accessor :metadata_path
 
     attr_accessor :pot_msgid_bugs_address
     attr_accessor :pot_package_name
@@ -27,37 +39,72 @@ module TranslationIO
     attr_accessor :pot_copyright_year
 
     def initialize
-      self.locales_path              = File.join('config', 'locales', 'gettext')
-      self.yaml_locales_path         = File.join('config', 'locales')
-      self.source_locale             = :en
-      self.target_locales            = []
-      self.endpoint                  = 'https://translation.io/api'
-      self.verbose                   = 1
-      self.test                      = false
-
-      self.ignored_key_prefixes      = []
-      self.ignored_source_paths      = ['vendor/', 'tmp/']
-      self.ignored_source_files      = [] # Files not parsed for GetText entries
-
-      self.source_formats            = ['rb', 'ruby', 'rabl']
-      self.erb_source_formats        = ['erb', 'inky']
-      self.haml_source_formats       = ['haml', 'mjmlhaml']
-      self.slim_source_formats       = ['slim', 'mjmlslim']
 
+      #######
+      # Global options
+      #######
+
+      self.api_key        = ''
+      self.source_locale  = :en
+      self.target_locales = []
+      self.endpoint       = 'https://translation.io/api'
+      self.metadata_path  = File.join('config', 'locales', '.translation_io')
+      self.verbose        = 1
+      self.test           = false
+
+      #######
+      # YAML options
+      #######
+
+      self.disable_yaml = false
+
+      # YAML directory
+      self.yaml_locales_path = File.join('config', 'locales')
+
+      # Ignored YAML key prefixes (like 'will_paginate.')
+      self.ignored_key_prefixes = []
+
+      # Cf. https://github.com/translation/rails#custom-localization-key-prefixes
       self.localization_key_prefixes = []
-      self.disable_gettext           = false
-      self.charset                   = 'UTF-8'
-      self.metadata_path             = File.join('config', 'locales', '.translation_io')
-
-      self.pot_msgid_bugs_address    = 'contact@translation.io'
-      self.pot_package_name          = File.basename(Dir.pwd)
-      self.pot_package_version       = '1.0'
-      self.pot_copyright_holder      = File.basename(Dir.pwd)
-      self.pot_copyright_year        = Date.today.year
+
+      #######
+      # GetText options
+      #######
+
+      self.disable_gettext = false
+
+      # GetText directory for PO and MO files
+      self.locales_path = File.join('config', 'locales', 'gettext')
+
+      # These paths and files will not be parsed for GetText entries
+      self.ignored_source_paths = ['vendor/', 'tmp/', 'node_modules/', 'logs/', '.git/']
+      self.ignored_source_files = []
+
+      # These gems will be parsed by GetText (use gem names)
+      self.parsed_gems = []
+
+      # Extensions for rb/erb/haml/slim file parsers
+      self.source_formats      = ['rb', 'ruby', 'rabl']
+      self.erb_source_formats  = ['erb', 'inky']
+      self.haml_source_formats = ['haml', 'mjmlhaml']
+      self.slim_source_formats = ['slim', 'mjmlslim']
+
+      # 'text_domain' will be synced (name of .po/.mo files)
+      # 'bound_text_domains' will be read during execution (in that priority order)
+      self.text_domain        = 'app'
+      self.bound_text_domains = ['app']
+      self.charset            = 'UTF-8'
+
+      # POT header informations
+      self.pot_msgid_bugs_address = 'contact@translation.io'
+      self.pot_package_name       = File.basename(Dir.pwd)
+      self.pot_package_version    = '1.0'
+      self.pot_copyright_holder   = File.basename(Dir.pwd)
+      self.pot_copyright_year     = Date.today.year
     end
 
     def pot_path
-      File.join(locales_path, "#{TEXT_DOMAIN}.pot")
+      File.join(locales_path, "#{text_domain}.pot")
     end
 
     def yaml_file_paths
@@ -85,6 +132,14 @@ module TranslationIO
     def source_files_for_formats(formats)
       file_paths = Dir["**/*.{#{formats.join(',')}}"]
 
+      # Add gems that need to be parsed by GetText
+      parsed_gems.each do |gem_name|
+        if Gem.loaded_specs[gem_name]
+          gem_path   = Gem.loaded_specs[gem_name].full_gem_path
+          file_paths += Dir["#{gem_path}/**/*.{#{formats.join(',')}}"]
+        end
+      end
+
       # remove ignored files
       file_paths = file_paths - ignored_source_files
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: translation
 version: !ruby/object:Gem::Version
-  version: '1.17'
+  version: '1.18'
 platform: ruby
 authors:
 - Michael Hoste
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-12 00:00:00.000000000 Z
+date: 2019-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gettext
@@ -35,30 +35,30 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -87,6 +90,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 description: Localize your app using either t(".keys") or _("source text") and type
   "rake translation:sync" to synchronize with your translators on Translation.io.
 email: contact@translation.io
@@ -143,11 +149,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Localize your app with YAML or GetText. Synchronize with your translators
   on Translation.io.
 test_files: []
-has_rdoc: false