translation 1.20 → 1.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39f833e4f98c4424feca4172a7f70c3b9639f24df3aaaa8e873632a54a5bb290
-  data.tar.gz: c76f080ced71805a079f47f6475412f1a1f4b24574e6470e77aa0d924ffd4211
+  metadata.gz: 8ce80b91f3c556815df4339c5fc0b98f5749dd2babb378826053fe99751e5aec
+  data.tar.gz: 1d4126693818e8220f41fa74f56e4d4eec61df651ac52f6429930fda9294a5b6
 SHA512:
-  metadata.gz: 40fb09a74db12309e1dc787cc9ced44874cbc96250d6eb62cafe6b8f63962557756560f70c64f33e0e520a12a87bff14809b04b8a86c593fe4c1f48363977272
-  data.tar.gz: 834e92a56f1d11c178905db2326e346f9108f3237bf83645a59605680344878f15a9c79d5d22295fa05804fc3374942b7999852848affb82dfa55c1f5057b5dc
+  metadata.gz: b17f56630fba322a948c31b84fb7ed006ef647f4cba40fe2f7ef78fd63e470f5dbbfd01f1ceb31627caabda3d27c0ea6e6c441f377709cc4291dbda07d5f4dc4
+  data.tar.gz: cf424585ff16540e92679195faaa0dff8db5b30faa1b9355ed203fa0e07f1d5a114c643a071f22c4afb7545d2e82d553cd7012a88200319679528a870603bbc6

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

@@ -12,72 +12,113 @@ module TranslationIO
 
           params.merge!({ :timestamp => metadata_timestamp })
           parsed_response = perform_source_edits_request(params)
+          source_edits    = parsed_response['source_edits'].to_a
 
-          unless parsed_response.nil?
-            TranslationIO.info "Applying YAML source editions."
+          TranslationIO.info "Applying YAML source editions."
 
-            parsed_response['source_edits'].each do |source_edit|
-              inserted = false
+          source_edits.each do |source_edit|
+            applied = false
 
-              sort_by_project_locales_first(@yaml_file_paths).each do |file_path|
-                yaml_hash      = YAML::load(File.read(file_path))
-                flat_yaml_hash = FlatHash.to_flat_hash(yaml_hash)
+            reload_or_reuse_yaml_sources
 
-                flat_yaml_hash.each do |key, value|
-                  if key == "#{@source_locale}.#{source_edit['key']}"
-                    if value == source_edit['old_text']
-                      TranslationIO.info "#{source_edit['key']} | #{source_edit['old_text']} -> #{source_edit['new_text']}", 2, 2
+            @yaml_sources.each do |yaml_source|
+              yaml_file_path = yaml_source[:yaml_file_path]
+              yaml_flat_hash = yaml_source[:yaml_flat_hash]
 
-                      if locale_file_path_in_project?(file_path)
-                        flat_yaml_hash[key] = source_edit['new_text']
+              yaml_flat_hash.each do |full_key, value|
+                if full_key == "#{@source_locale}.#{source_edit['key']}"
+                  apply_source_edit(source_edit, yaml_file_path, yaml_flat_hash)
+                  applied = true
+                  break
+                end
+              end
 
-                        file_content = to_hash_to_yaml(flat_yaml_hash)
+              break if applied
+            end
+          end
 
-                        File.open(file_path, 'w') do |f|
-                          f.write(file_content)
-                        end
-                      else # override source text of gem
-                        yaml_path = File.join(TranslationIO.config.yaml_locales_path, "#{@source_locale}.yml")
+          update_metadata_timestamp
+        end
 
-                        if File.exists?(yaml_path) # source yaml file
-                          yaml_hash      = YAML::load(File.read(yaml_path))
-                          flat_yaml_hash = FlatHash.to_flat_hash(yaml_hash)
-                        else
-                          FileUtils::mkdir_p File.dirname(yaml_path)
-                          flat_yaml_hash = {}
-                        end
+        private
 
-                        flat_yaml_hash["#{@source_locale}.#{source_edit['key']}"] = source_edit['new_text']
+        def reload_or_reuse_yaml_sources
+          if yaml_sources_reload_needed?
+            @yaml_sources = sort_by_project_locales_first(@yaml_file_paths).collect do |yaml_file_path|
+              yaml_content   = File.read(yaml_file_path)
+              yaml_hash      = YAML::load(yaml_content)
+              yaml_flat_hash = FlatHash.to_flat_hash(yaml_hash)
+
+              {
+                :yaml_file_path => yaml_file_path,
+                :yaml_flat_hash => yaml_flat_hash
+              }
+            end
+          else
+            @yaml_sources
+          end
+        end
 
-                        file_content = to_hash_to_yaml(flat_yaml_hash)
+        def yaml_sources_reload_needed?
+          @yaml_file_paths.sort != @yaml_sources.to_a.collect { |y_s| y_s[:yaml_file_path] }.sort
+        end
+
+        # Sort YAML file paths by project locales first, gem locales after
+        # (to replace "overridden" source first)
+        def sort_by_project_locales_first(yaml_file_paths)
+          yaml_file_paths.sort do |x, y|
+            a = locale_file_path_in_project?(x)
+            b = locale_file_path_in_project?(y)
+            (!a && b) ? 1 : ((a && !b) ? -1 : 0)
+          end
+        end
 
-                        File.open(yaml_path, 'w') do |f|
-                          f.write(file_content)
-                        end
-                      end
+        def apply_source_edit(source_edit, yaml_file_path, yaml_flat_hash)
+          full_key = "#{@source_locale}.#{source_edit['key']}"
 
-                      inserted = true
-                      break
-                    else
-                      TranslationIO.info "#{source_edit['key']} | Ignored because translation was also updated in source YAML file", 2, 2
-                    end
-                  end
-                end
+          if yaml_flat_hash[full_key] == source_edit['old_text']
+            TranslationIO.info "#{source_edit['key']} | #{source_edit['old_text']} -> #{source_edit['new_text']}", 2, 2
 
-                break if inserted
-              end
+            if locale_file_path_in_project?(yaml_file_path)
+              apply_application_source_edit(source_edit, yaml_file_path, yaml_flat_hash)
+            else # Override source text of gem inside the app
+              apply_gem_source_edit(source_edit)
             end
+          else
+            TranslationIO.info "#{source_edit['key']} | #{source_edit['old_text']} -> #{source_edit['new_text']} | Ignored because translation was also updated in source YAML file", 2, 2
           end
+        end
 
-          File.open(TranslationIO.config.metadata_path, 'w') do |f|
-            f.write({ 'timestamp' => Time.now.utc.to_i }.to_yaml)
+        def apply_application_source_edit(source_edit, yaml_file_path, yaml_flat_hash)
+          full_key                 = "#{@source_locale}.#{source_edit['key']}"
+          yaml_flat_hash[full_key] = source_edit['new_text']
+          file_content             = to_hash_to_yaml(yaml_flat_hash)
+
+          File.open(yaml_file_path, 'w') do |f|
+            f.write(file_content)
           end
         end
 
-        private
+        def apply_gem_source_edit(source_edit)
+          # Source yaml file like config/locales/en.yml
+          yaml_file_path = File.expand_path(File.join(TranslationIO.config.yaml_locales_path, "#{@source_locale}.yml"))
 
-        def to_hash_to_yaml(flat_yaml_hash)
-          yaml_hash = FlatHash.to_hash(flat_yaml_hash)
+          if File.exists?(yaml_file_path)
+            # Complete existing hash if YAML file already exists
+            existing_yaml_source = @yaml_sources.detect { |y_s| normalize_path(y_s[:yaml_file_path]) == normalize_path(yaml_file_path) }
+            yaml_flat_hash       = existing_yaml_source[:yaml_flat_hash]
+          else
+            # Create new hash if YAML file doesn't exist yet
+            FileUtils::mkdir_p File.dirname(yaml_file_path)
+            yaml_flat_hash = {}
+            @yaml_file_paths.push(yaml_file_path) # Application YAML are at the end of the list
+          end
+
+          apply_application_source_edit(source_edit, yaml_file_path, yaml_flat_hash)
+        end
+
+        def to_hash_to_yaml(yaml_flat_hash)
+          yaml_hash = FlatHash.to_hash(yaml_flat_hash)
 
           if TranslationIO.config.yaml_line_width
             content = yaml_hash.to_yaml(:line_width => TranslationIO.config.yaml_line_width)
@@ -103,26 +144,26 @@ module TranslationIO
           end
         end
 
+        def update_metadata_timestamp
+          File.open(TranslationIO.config.metadata_path, 'w') do |f|
+            f.write({ 'timestamp' => Time.now.utc.to_i }.to_yaml)
+          end
+        end
+
         def perform_source_edits_request(params)
           uri             = URI("#{TranslationIO.client.endpoint}/projects/#{TranslationIO.client.api_key}/source_edits")
           parsed_response = BaseOperation.perform_request(uri, params)
         end
 
-        # Sort YAML file paths by project locales first, gem locales after
-        # (to replace "overridden" source first)
-        def sort_by_project_locales_first(yaml_file_paths)
-          yaml_file_paths.sort do |x, y|
-            a = locale_file_path_in_project?(x)
-            b = locale_file_path_in_project?(y)
-            (!a && b) ? 1 : ((a && !b) ? -1 : 0)
-          end
-        end
-
         def locale_file_path_in_project?(locale_file_path)
-          TranslationIO.normalize_path(locale_file_path).start_with?(
-            TranslationIO.normalize_path(TranslationIO.config.yaml_locales_path)
+          normalize_path(locale_file_path).start_with?(
+            normalize_path(TranslationIO.config.yaml_locales_path)
           )
         end
+
+        def normalize_path(path)
+          TranslationIO.normalize_path(path)
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: translation
 version: !ruby/object:Gem::Version
-  version: '1.20'
+  version: '1.21'
 platform: ruby
 authors:
 - Michael Hoste
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-10 00:00:00.000000000 Z
+date: 2019-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gettext