translation 1.18 → 1.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e21e49a9aac4d9fec598b037a0411544b374003fd08ba033bcd3c4f27e7c118
-  data.tar.gz: 06de16c4833d428ba8ab90b441dda1c58b130ef1e5c03294e34971a262bec576
+  metadata.gz: ff2388659bd454e1ff1cbcad7133161a66902007d08e4735b80c628289665c15
+  data.tar.gz: d9a4222b6014f21dc2b29cc9de1afb60d725301d6d93a9cd7f0ba5b0cbc8d2e8
 SHA512:
-  metadata.gz: 1e0c55227bb61dba3b05273b2ee5289bbc4b74ce290d4fce1a7f5aa495da3db60cd56a31eaa5ffca276fc1c1c7c48469ffc0d2cf7addd51ebcbe45bbee89d238
-  data.tar.gz: 484b10782d68c7f626c3c68c337087223ac28610d622fca6b08300642a2cb8acb4ee185ed7903cd19d3ee72130ce1dda5168b26127f05ed52f8f3eeab3d07115
+  metadata.gz: 917f60afd4befcabb144943a3b9ebd26d2d4cd372ef286432d0bc0c03aafc9aff6bae7e4b956abcc11506f35be33e752cd011ff10f1b8a7b77e84038a0bf783f
+  data.tar.gz: 8a9b12a2c66a7f060f2861150ad171ab4ebeb94b87fb18bc4763c2529871f8b58963c221cd9844844a3ef56dd9e4e32c262cf85b5df751a650f19e97e0de2a7e

data/README.md

@@ -46,6 +46,7 @@ Table of contents
    * [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)
+   * [GetText Object Class Monkey-Patching](#gettext-object-class-monkey-patching)
  * [Pure Ruby (without Rails)](#pure-ruby-without-rails)
  * [Testing](#testing)
  * [Contributing](#contributing)
@@ -316,14 +317,14 @@ For example:
 TranslationIO.configure do |config|
   ...
   config.ignored_key_prefixes = [
-    'number.human.',
-    'admin.',
-    'errors.messages.',
-    'activerecord.errors.messages.',
-    'will_paginate.',
-    'helpers.page_entries_info.',
-    'views.pagination.',
-    'enumerize.visibility.'
+    'number.human',
+    'admin',
+    'errors.messages',
+    'activerecord.errors.messages',
+    'will_paginate',
+    'helpers.page_entries_info',
+    'views.pagination',
+    'enumerize.visibility'
   ]
   ...
 end
@@ -403,6 +404,30 @@ TranslationIO.configure do |config|
 end
 ```
 
+### GetText Object Class Monkey-Patching
+
+GetText methods (`_('')`, etc.) are available everywhere in your application.
+This is made by extending the global `Object` class.
+
+You can disable the built-in `Object` monkey-patching if you
+prefer a more granular approach:
+
+```ruby
+TranslationIO.configure do |config|
+  ...
+  config.gettext_object_delegate = false
+  ...
+end
+```
+
+Don't forget to manually include the GetText methods where needed:
+
+```ruby
+class Contact < ApplicationRecord
+  extend TranslationIO::Proxy
+end
+```
+
 ## Pure Ruby (without Rails)
 
 This gem was created specifically for Rails, but you can also use it in a pure Ruby project by making some arrangements:
@@ -505,9 +530,16 @@ Credits: [@deecewan](https://github.com/deecewan)
 
 ### Others
 
-If you want to create a new client for your favorite language or framework, feel
-free to reach us on [contact@translation.io](mailto:contact@translation.io) and
-we'll assist you with the workflow logic and send you API docs.
+If you want to create a new client for your favorite language or framework, please read our
+[Create a Translation.io Library](https://translation.io/docs/create-library)
+guide and use the special
+[init](https://translation.io/docs/create-library#initialization) and
+[sync](https://translation.io/docs/create-library#synchronization) endpoints.
+
+You can also use the more [traditional API](https://translation.io/docs/api).
+
+Feel free to contact us on [contact@translation.io](mailto:contact@translation.io) if
+you need some help or if you want to share your library.
 
 ## License
 

data/lib/translation.rb

@@ -51,7 +51,10 @@ module TranslationIO
         end
 
         Proxy.textdomain(@config.text_domain)
-        Object.delegate *GETTEXT_METHODS, :to => Proxy
+
+        if @config.gettext_object_delegate
+          Object.delegate *GETTEXT_METHODS, :to => Proxy
+        end
       end
 
       @client = Client.new(@config.api_key, @config.endpoint)

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

@@ -19,7 +19,7 @@ module TranslationIO
 
               yaml_data = YAMLConversion.get_yaml_data_from_po_data(@parsed_response["yaml_po_data_#{target_locale}"], target_locale)
 
-              top_comment = <<EOS
+              top_comment = <<-EOS
 # WARNING. THIS FILE WAS AUTO-GENERATED BY THE TRANSLATION GEM.
 # IF YOU UPDATE IT, YOUR CHANGES WILL BE LOST AT THE NEXT SYNC.
 #

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

@@ -24,6 +24,8 @@ module TranslationIO
             YamlEntry.localization?(key, value)
           end
 
+          params = {}
+
           @target_locales.each do |target_locale|
             yaml_path = File.join(@yaml_locales_path, "localization.#{target_locale}.yml")
 
@@ -35,32 +37,36 @@ module TranslationIO
 
             yaml_data = YAMLConversion.get_yaml_data_from_flat_translations(target_flat_special_translations)
 
-            File.open(yaml_path, 'wb') do |file|
-              file.write(self.class.top_comment)
-              file.write(yaml_data)
-            end
-          end
+            params["yaml_data_#{target_locale}"] = yaml_data
 
-          if not TranslationIO.config.test
-            # Get YAML localization entries
-            params = {}
-            @target_locales.each do |target_locale|
-              yaml_path = File.join(@yaml_locales_path, "localization.#{target_locale}.yml")
-              params["yaml_data_#{target_locale}"] = File.read(yaml_path)
+            # To have a localization.xx.yml file during tests (without call to backend)
+            if TranslationIO.config.test
+              if YAML::load(yaml_data).present?
+                File.open(yaml_path, 'wb') do |file|
+                  file.write(self.class.top_comment)
+                  file.write(yaml_data)
+                end
+              end
             end
+          end
 
-            TranslationIO.info "Collecting YAML localization entries from server."
+          TranslationIO.info "Collecting YAML localization entries from server."
 
+          # To have a localization.xx.yml file with call to backend
+          if !TranslationIO.config.test
             uri             = URI("#{TranslationIO.client.endpoint}/projects/#{TranslationIO.client.api_key}/fill_yaml_localizations")
             parsed_response = BaseOperation.perform_request(uri, params)
 
-            unless parsed_response.nil?
+            if !parsed_response.nil?
               @target_locales.each do |target_locale|
                 yaml_path = File.join(@yaml_locales_path, "localization.#{target_locale}.yml")
+                yaml_data = parsed_response["yaml_data_#{target_locale}"]
 
-                File.open(yaml_path, 'wb') do |file|
-                  file.write(self.class.top_comment)
-                  file.write(parsed_response["yaml_data_#{target_locale}"])
+                if yaml_data.present? && YAML::load(yaml_data).present?
+                  File.open(yaml_path, 'wb') do |file|
+                    file.write(self.class.top_comment)
+                    file.write(yaml_data)
+                  end
                 end
               end
             end
@@ -68,7 +74,7 @@ module TranslationIO
         end
 
         def self.top_comment
-          <<EOS
+          <<-EOS
 # THIS FILE CONTAINS LOCALIZATION KEYS : date and number formats, number precisions,
 # number separators and all non-textual values depending on the language.
 # These values must not reach the translator, so they are separated in this file.

data/lib/translation_io/client/init_operation.rb

@@ -62,7 +62,7 @@ module TranslationIO
       end
 
       def warn_source_locale_unfound(source_locale, all_used_yaml_locales)
-        is_source_locale_unfound = !source_locale.in?(all_used_yaml_locales)
+        is_source_locale_unfound = !all_used_yaml_locales.include?(source_locale)
 
         if is_source_locale_unfound
           puts
@@ -88,7 +88,7 @@ module TranslationIO
           puts
           puts "----------"
           puts "Your `config.target_locales` are [#{target_locales.sort.join(', ')}]."
-          puts "But we haven't found any YAML key for [#{target_locales_unfound.join(', ')}], is this normal?"
+          puts "But we haven't found any YAML key for [#{target_locales_unfound.sort.join(', ')}], is this normal?"
           puts "If not, check that you haven't misspelled the locale (ex. 'en-GB' instead of 'en')."
           puts "----------"
           puts "Do you want to continue? (y/N)"

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

@@ -13,22 +13,28 @@ module TranslationIO
           @yaml_file_paths.each do |locale_file_path|
             if locale_file_removable?(locale_file_path)
               if File.exist?(locale_file_path)
-                content_hash = YAML::load(File.read(locale_file_path))
+                content_hash        = YAML::load(File.read(locale_file_path)) || {}
+                source_content_hash = content_hash.select { |k| k.to_s == @source_locale.to_s }
 
-                if content_hash
-                  new_content_hash = content_hash.keep_if { |k| k.to_s == @source_locale.to_s }
-                else # loading an empty file returns false
-                  new_content_hash = {}
-                end
-
-                if new_content_hash.keys.any?
+                if source_content_hash.empty?
+                  TranslationIO.info "Removing #{locale_file_path}", 2, 2
+                  FileUtils.rm(locale_file_path)
+                elsif content_hash != source_content_hash # in case of mixed languages in source YAML file
                   TranslationIO.info "Rewriting #{locale_file_path}", 2, 2
+
+                  if TranslationIO.config.yaml_line_width
+                    file_content = source_content_hash.to_yaml(:line_width => TranslationIO.config.yaml_line_width)
+                  else
+                    file_content = source_content_hash.to_yaml
+                  end
+
+                  file_content = file_content.gsub(/ $/, '') # remove trailing spaces
+
                   File.open(locale_file_path, 'wb') do |file|
-                    file.write(new_content_hash.to_yaml)
+                    file.write(file_content)
                   end
                 else
-                  TranslationIO.info "Removing #{locale_file_path}", 2, 2
-                  FileUtils.rm(locale_file_path)
+                  # don't touch source
                 end
               end
             end

data/lib/translation_io/client/sync_operation/apply_yaml_source_edits_step.rb

@@ -31,8 +31,10 @@ module TranslationIO
                       if locale_file_path_in_project?(file_path)
                         flat_yaml_hash[key] = source_edit['new_text']
 
+                        file_content = to_hash_to_yaml(flat_yaml_hash)
+
                         File.open(file_path, 'w') do |f|
-                          f.write(FlatHash.to_hash(flat_yaml_hash).to_yaml)
+                          f.write(file_content)
                         end
                       else # override source text of gem
                         yaml_path = File.join(TranslationIO.config.yaml_locales_path, "#{@source_locale}.yml")
@@ -47,8 +49,10 @@ module TranslationIO
 
                         flat_yaml_hash["#{@source_locale}.#{source_edit['key']}"] = source_edit['new_text']
 
+                        file_content = to_hash_to_yaml(flat_yaml_hash)
+
                         File.open(yaml_path, 'w') do |f|
-                          f.write(FlatHash.to_hash(flat_yaml_hash).to_yaml)
+                          f.write(file_content)
                         end
                       end
 
@@ -72,6 +76,18 @@ module TranslationIO
 
         private
 
+        def to_hash_to_yaml(flat_yaml_hash)
+          yaml_hash = FlatHash.to_hash(flat_yaml_hash)
+
+          if TranslationIO.config.yaml_line_width
+            content = yaml_hash.to_yaml(:line_width => TranslationIO.config.yaml_line_width)
+          else
+            content = yaml_hash.to_yaml
+          end
+
+          content.gsub(/ $/, '') # remove trailing spaces
+        end
+
         def metadata_timestamp
           if File.exist?(TranslationIO.config.metadata_path)
             metadata_content = File.read(TranslationIO.config.metadata_path)

data/lib/translation_io/config.rb

@@ -13,9 +13,12 @@ module TranslationIO
     attr_accessor :yaml_locales_path
     attr_accessor :ignored_key_prefixes
     attr_accessor :localization_key_prefixes
+    attr_accessor :yaml_line_width
 
     attr_accessor :disable_gettext
 
+    attr_accessor :gettext_object_delegate
+
     attr_accessor :locales_path
 
     attr_accessor :ignored_source_paths
@@ -67,17 +70,25 @@ module TranslationIO
       # Cf. https://github.com/translation/rails#custom-localization-key-prefixes
       self.localization_key_prefixes = []
 
+      # Define max line width of generated YAML files:
+      # Can be nil (default behaviour of Ruby version), -1 (no wrapping) or positive integer (wrapping)
+      # Cf. https://github.com/translation/rails/issues/19
+      self.yaml_line_width = nil
+
       #######
       # GetText options
       #######
 
       self.disable_gettext = false
 
+      # Cf. https://github.com/translation/rails#gettext-object-class-monkey-patching
+      self.gettext_object_delegate = true
+
       # 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_paths = ['vendor/', 'tmp/', 'node_modules/', 'logs/', '.git/', 'public/', 'private/']
       self.ignored_source_files = []
 
       # These gems will be parsed by GetText (use gem names)
@@ -130,27 +141,45 @@ module TranslationIO
     end
 
     def source_files_for_formats(formats)
-      file_paths = Dir["**/*.{#{formats.join(',')}}"]
+      file_paths = []
+      root_paths = ['.']
 
-      # Add gems that need to be parsed by GetText
+      # Add gem paths that need to be parsed by GetText ("parsed_gem" option)
       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(',')}}"]
+          root_paths << Gem.loaded_specs[gem_name].full_gem_path
         end
       end
 
-      # remove ignored files
-      file_paths = file_paths - ignored_source_files
-
-      # remove ignored paths
-      ignored_source_paths.each do |ignored_source_path|
-        file_paths = file_paths.select { |file_path| !file_path.start_with?(ignored_source_path) }
+      root_paths.each do |root_path|
+        Pathname.new(root_path).find do |path|
+          if path.directory?
+            if is_ignored_path?(path)
+              Find.prune
+            end
+          else
+            if formats.include?(path.extname[1..-1]) && !is_ignored_file?(path)
+              file_paths << path.to_s
+            end
+          end
+        end
       end
 
       file_paths
     end
 
+    def is_ignored_path?(path)
+      ignored_source_paths.any? do |ignored_source_path|
+        path == Pathname.new(ignored_source_path).cleanpath
+      end
+    end
+
+    def is_ignored_file?(path)
+      ignored_source_files.any? do |ignored_source_file|
+        path == Pathname.new(ignored_source_file).cleanpath
+      end
+    end
+
     def to_s
       "API Key: #{api_key} | Languages: #{source_locale} => [#{target_locales.join(', ')}]"
     end

data/lib/translation_io/flat_hash.rb

@@ -7,9 +7,13 @@ module TranslationIO
         get_flat_hash_for_level(hash)
       end
 
-      def to_hash(flat_hash)
+      def to_hash(flat_hash, remove_empty_keys = false)
         hash = {}
 
+        if remove_empty_keys
+          flat_hash = flat_hash.reject { |k, v| v.nil? && !k.end_with?(']') }
+        end
+
         flat_hash.each_pair do |key, value|
           build_hash_with_flat(hash, key, value)
         end

data/lib/translation_io/railtie.rb

@@ -49,8 +49,12 @@ if defined?(GetText)
             begin
               parse_path(path, po)
             rescue SystemExit => e
-              # puts(_("Error parsing %{path}") % {:path => path})
               puts
+              puts "---------------"
+              puts "Error while parsing this file for GetText: #{path}"
+              puts "Are you sure the file is correctly formatted?"
+              puts "Feel free to contact us to get some help: contact@translation.io"
+              puts "---------------"
               puts
             end
           end

data/lib/translation_io/yaml_conversion.rb

@@ -37,7 +37,14 @@ module TranslationIO
 
       def get_yaml_data_from_flat_translations(flat_translations)
         translations = FlatHash.to_hash(flat_translations)
-        return translations.to_yaml
+
+        if TranslationIO.config.yaml_line_width
+          data = translations.to_yaml(:line_width => TranslationIO.config.yaml_line_width)
+        else
+          data = translations.to_yaml
+        end
+
+        data.gsub(/ $/, '') # remove trailing spaces
       end
 
     end

data/lib/translation_io/yaml_entry.rb

@@ -2,7 +2,7 @@ module TranslationIO
   module YamlEntry
 
     IGNORED_KEY_PREFIXES = [
-      'faker.'
+      'faker'
     ]
 
     LOCALIZATION_KEY_PREFIXES = [
@@ -31,7 +31,7 @@ module TranslationIO
       end
 
       def ignored?(key)
-        key.present? && ignored_key_prefixes.any? { |p| key_without_locale(key).start_with?(p) }
+        key.present? && ignored_key_prefixes.any? { |p| key_without_locale(key).match(/^#{p}\b/) != nil }
       end
 
       def localization?(key, value)
@@ -40,7 +40,7 @@ module TranslationIO
 
       def localization_prefix?(key)
         localization_key_prefixes.any? do |prefix|
-          key_without_locale(key).start_with?(prefix)
+          key_without_locale(key).match(/^#{prefix}\b/) != nil
         end
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: translation
 version: !ruby/object:Gem::Version
-  version: '1.18'
+  version: '1.19'
 platform: ruby
 authors:
 - Michael Hoste
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-05 00:00:00.000000000 Z
+date: 2019-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gettext
@@ -80,9 +80,6 @@ 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
@@ -90,9 +87,6 @@ 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