locca 2.1.0 → 2.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ff2073ab9c95c9468cba788b05d37cac96ff2a6d
-  data.tar.gz: 0ae04421b2a1f2e8f6ffc3d33a4bb3f2d9f4be75
+SHA256:
+  metadata.gz: cc26bb2f03287b0e7453e9ce7039157d1f002a406c4b056a2bed3679fb0cb39c
+  data.tar.gz: b256544ee1dbb061ae8264fb680efe3f5ed483c4b6654fbc1414a464b5d13a31
 SHA512:
-  metadata.gz: bfc71e2ecf42f5d8d904bdb83cf1e67fdb8437bdf51bc04761bdc85789955e9d70b097761b18b3a9b6fbd755a6a5e60d5b0c5dda8f403cb72379ca8f213dabff
-  data.tar.gz: 057d6f0106c0673f1c431cc95510839babdf56f37179650e5609dcc6fa738878a422e3da5fb7aaa33f716480d8c7cebb90952a467ba8db9314355715896fcfd4
+  metadata.gz: 5a0bf3b7887825323608e8236fec10951f7115f442648566f2e967942c159c8430be69bef88c6c40483f5324ef0d08cff60af284cacf4b886715fe304d35ae50
+  data.tar.gz: 336975865b60608b482bf1b391b18c57ef6ca3249b624534883ce529c34228bbc805b501417701d6b310209b2e065eec93758791db19aa4c5ad84cdc4421381b

data/bin/locca

@@ -109,6 +109,24 @@ command :translate do |c|
     end  
 end
 
+desc 'Audit translation (find missing / extra / untranslated keys)'
+command :audit do |c|
+    c.action do |global_options, options, args|
+        work_dir = global_options['work-dir'.to_sym]
+        if not work_dir
+            work_dir = Dir.getwd
+        end
+
+        success = true
+        projects_in_dir(work_dir).each { |project|  
+            if !$locca.audit(project)
+                success = false
+            end
+        }
+        exit!(success)
+    end
+end
+
 pre do |global, command, options, args|
     $locca = Locca::Locca.new()
     true

data/lib/locca.rb

@@ -33,6 +33,7 @@ require 'locca/projects/android_project'
 require 'locca/config_reader'
 require 'locca/config_validator'
 
+require 'locca/actions/audit_action'
 require 'locca/actions/build_action'
 require 'locca/actions/merge_action'
 require 'locca/actions/onesky_sync_action'
@@ -58,6 +59,42 @@ require 'babelyoda/strings_parser'
 
 module Locca
     class Locca
+        def audit(project)
+            if not project
+                raise 'Can\'t initialize Locca with nil project'
+            end
+
+            action = AuditAction.new(project, project.collection_builder(), project.collections_generator())
+            failed_audit_results = action.execute()
+
+            failed_audit_results.each do |audit_result|
+                puts()
+                puts(">>> #{project.name}/#{audit_result.lang}/#{audit_result.collection_name}")
+                unless audit_result.missing_keys.empty?
+                    puts("Missing Keys:")
+                    audit_result.missing_keys.each do |key|
+                        puts("- #{key}")
+                    end
+                end
+
+                unless audit_result.extra_keys.empty?
+                    puts("Extra Keys:")
+                    audit_result.extra_keys.each do |key|
+                        puts("- #{key}")
+                    end
+                end
+
+                unless audit_result.untranslated_keys.empty?
+                    puts("Untranslated:")
+                    audit_result.untranslated_keys.each do |key|
+                        puts("- #{key}")
+                    end
+                end
+            end
+
+            return failed_audit_results.empty?
+        end
+
         def build(project)
             if not project
                 raise 'Can\'t initialize Locca with nil project'
@@ -96,7 +133,7 @@ module Locca
                 lang = project.base_lang
             end
 
-            action = TranslateAction.new(project, lang, project.collection_builder, project.collection_writer, collection_merger())
+            action = TranslateAction.new(project, lang, project.collection_builder(), project.collection_writer(), collection_merger())
             action.execute()
         end
 

data/lib/locca/actions/audit_action.rb

@@ -0,0 +1,80 @@
+#
+# The MIT License (MIT)
+#
+# Copyright (c) 2014 Evgeny Shurakov
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+#
+
+require 'locca/audit_result'
+
+module Locca
+    class AuditAction
+        def initialize(project, collection_builder, collections_generator)
+            @project = project
+            @collections_generator = collections_generator
+            @collection_builder = collection_builder
+        end
+
+        def execute()
+            generated_collections = @collections_generator.generate()
+
+            audit_ignore = @project.config_value_for_key('audit_ignore')
+            failed_audit_results = []
+
+            @project.collection_names().each do |collection_name|
+                keys_to_ignore = []
+                if audit_ignore != nil && audit_ignore.key?(collection_name)
+                    keys_to_ignore = audit_ignore[collection_name]
+                end
+
+                @project.langs().each do |lang|
+                    collection_path = @project.path_for_collection(collection_name, lang)
+                    collection = @collection_builder.collection_at_path(collection_path)
+                    
+                    audit_result = AuditResult.new(collection_name, lang)
+
+                    generated_collections.each do |generated_collection|
+                        if generated_collection.name == collection.name
+                            generated_collection_keys = generated_collection.all_keys().to_set
+                            collection_keys = collection.all_keys().to_set
+
+                            audit_result.missing_keys = (generated_collection_keys - collection_keys).to_a
+                            audit_result.extra_keys = (collection_keys - generated_collection_keys).to_a
+                        end
+                    end
+
+                    collection.sorted_each do |item|
+                        if item.translated? || keys_to_ignore.include?(item.key) || audit_result.extra_keys.include?(item.key)
+                            next
+                        end
+
+                        audit_result.add_untranslated_key(item.key)
+                    end
+
+                    unless audit_result.passed?
+                        failed_audit_results.push(audit_result)
+                    end
+                end
+            end
+
+            return failed_audit_results
+        end
+    end
+end

data/lib/locca/actions/onesky_sync_action.rb

@@ -65,8 +65,22 @@ module Locca
             # 1
             @generated_collections.each do |generated_collection|
                 @langs.each do |lang|
-                    print "[*] #{@project.name}: fetch: #{lang}/#{generated_collection.name}\n"
-                    data = @onesky.fetch_translations(lang, @project.full_collection_name(generated_collection.name))
+                    max_attempts = 3
+                    for attempt in 1..max_attempts do
+                        print "[*] #{@project.name}: fetch: #{lang}/#{generated_collection.name}\n"
+                        begin
+                            data = @onesky.fetch_translations(lang, @project.full_collection_name(generated_collection.name))
+                        rescue Exception => ex
+                            if attempt == max_attempts
+                                raise ex
+                            end
+                            puts "[!] #{ex}"
+                            sleep 2
+                        else 
+                            break
+                        end
+                    end
+                    
                     fetched_collection = @collection_builder.collection_from_datastring(data)
 
                     local_collection_path = @project.path_for_collection(generated_collection.name, lang)
@@ -113,9 +127,24 @@ module Locca
 
             # 4
             @generated_collections.each do |generated_collection|
-                print "[*] #{@project.name}: upload: #{@project.base_lang}/#{generated_collection.name}\n"
                 collection_path = @project.path_for_collection(generated_collection.name, @project.base_lang())
-                @onesky.upload_file(collection_path, @project.one_sky_file_format, prune_missing_strings)
+
+                max_attempts = 3
+                for attempt in 1..max_attempts do
+                    print "[*] #{@project.name}: upload: #{@project.base_lang}/#{generated_collection.name}\n"
+                    begin    
+                        @onesky.upload_file(collection_path, @project.one_sky_file_format, prune_missing_strings)
+                    rescue Exception => ex
+                        if attempt == max_attempts
+                            raise ex
+                        end
+                        puts "[!] #{ex}"
+                        sleep 2
+                    else 
+                        break
+                    end
+                end
+                
             end
         end
     end

data/lib/locca/android_collection_writer.rb

@@ -57,7 +57,7 @@ module Locca
                     item.value.each do |key, value|
                         nodeItem = Nokogiri::XML::Node.new('item', document)
                         nodeItem["quantity"] = key
-                        nodeItem.content = value
+                        nodeItem.content = prepare_content(value)
                         node.add_child(nodeItem)
                     end
 
@@ -65,7 +65,7 @@ module Locca
                 else
                     node = Nokogiri::XML::Node.new('string', document)
                     node["name"] = item.key
-                    node.content = item.value
+                    node.content = prepare_content(item.value)
                     resources.add_child(node)
                 end
 	        end
@@ -76,6 +76,10 @@ module Locca
                 io << document.to_xml
             end
         end
+
+        def prepare_content(content)
+            return content.gsub(/\n/, "\\n")
+        end
     end
 
 end

data/lib/locca/audit_result.rb

@@ -0,0 +1,49 @@
+#
+# The MIT License (MIT)
+#
+# Copyright (c) 2014 Evgeny Shurakov
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+#
+
+module Locca
+    class AuditResult
+        attr_reader :collection_name
+        attr_reader :lang
+        attr_reader :untranslated_keys
+        attr_accessor :missing_keys
+        attr_accessor :extra_keys
+
+        def initialize(collection_name, lang)
+            @collection_name = collection_name 
+            @lang = lang
+            @untranslated_keys = []
+            @missing_keys = []
+            @extra_keys = []
+        end
+
+        def add_untranslated_key(value)
+            @untranslated_keys.push(value)
+        end
+
+        def passed?
+            return @untranslated_keys.empty? && @missing_keys.empty? && @extra_keys.empty?
+        end
+    end
+end

data/lib/locca/projects/xcode_project.rb

@@ -91,8 +91,10 @@ module Locca
 
         def collections_generator()
             source_files = Array.new()
-            @xcode_target.source_build_phase.files_references.each { |file|  
-                source_files.push(file.real_path.to_s)
+            @xcode_target.source_build_phase.files_references.each { |file| 
+                if !file.path.nil?
+                    source_files.push(file.real_path.to_s)
+                end
             }
             return CollectionsGenerator.new(source_files, Genstrings.new(), collection_builder())
         end

data/lib/locca/version.rb

@@ -22,5 +22,5 @@
 # SOFTWARE.
 #
 module Locca
-  VERSION = '2.1.0'
+  VERSION = '2.2.6'
 end

metadata

@@ -1,141 +1,195 @@
 --- !ruby/object:Gem::Specification
 name: locca
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.6
 platform: ruby
 authors:
 - Shurakov Evgeny
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-12 00:00:00.000000000 Z
+date: 2020-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+    - - ">="
       - !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: '12.0'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: gli
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: xcodeproj
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
 description: 
 email: inbox@shurakov.name
 executables:
@@ -144,9 +198,12 @@ extensions: []
 extra_rdoc_files:
 - README.rdoc
 files:
+- README.rdoc
 - bin/locca
 - lib/babelyoda/strings_lexer.rb
 - lib/babelyoda/strings_parser.rb
+- lib/locca.rb
+- lib/locca/actions/audit_action.rb
 - lib/locca/actions/build_action.rb
 - lib/locca/actions/merge_action.rb
 - lib/locca/actions/onesky_sync_action.rb
@@ -154,6 +211,7 @@ files:
 - lib/locca/android_collection_writer.rb
 - lib/locca/android_collections_generator.rb
 - lib/locca/android_strings_parser.rb
+- lib/locca/audit_result.rb
 - lib/locca/collection.rb
 - lib/locca/collection_builder.rb
 - lib/locca/collection_item.rb
@@ -172,8 +230,6 @@ files:
 - lib/locca/projects/xcode_project.rb
 - lib/locca/sync/onesky.rb
 - lib/locca/version.rb
-- lib/locca.rb
-- README.rdoc
 homepage: https://github.com/eshurakov/locca
 licenses:
 - MIT
@@ -185,17 +241,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Application localization kit