locca 2.2.1 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5978bebc86227a0fe1a3d4107d20195fdbc694203aba39ec7c0d961d9d6d65ea
-  data.tar.gz: e559b2182937946a576c278acab2030c5d7ddfdda62273166434f30cd8b52c50
+  metadata.gz: 85bc8e7332a664e063b3699de43982fa2fa04fc2b9cfe5f1d508ca8921196497
+  data.tar.gz: 05b435158c0e7ab9c0a4ef1f7a14195d28c4ae6a60eaeedb6c633341cde59051
 SHA512:
-  metadata.gz: c957f56a157d38816a1fed311e308d3fa5f3fbcd7d0191778549404914f47960e00808592bf65ee46c60d90a1b9e7ac88b8162d1f11fe559dadd2a9f4b4fb964
-  data.tar.gz: '081b6a36bfddece0aca9a6105f9a873fbad76337cbbbf14dbbea0228c8428ec13a0b0509c0ba98ab7c1abb56929bf2503783e192d0a0b19823d6908266aac37a'
+  metadata.gz: 54dbd87da63f47cd74024614c76b84dd7671a2feda5ca7c87d342728850265553a94411e5449aaa0502337c17053867aeb35eb5b7c39e3835bff80f1594efaf9
+  data.tar.gz: '08c972ce6a53bd9aa149dd9af9b5d808f72089ba11c7d2ebfb0020e8f9d5ef786373fc03e4d0e7ad58906997e2c44ab9efefd1c0a6a747d581ce343b398bc2dd'

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/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/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/version.rb

@@ -22,5 +22,5 @@
 # SOFTWARE.
 #
 module Locca
-  VERSION = '2.2.1'
+  VERSION = '2.2.2'
 end

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
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: locca
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.2.2
 platform: ruby
 authors:
 - Shurakov Evgeny
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-04 00:00:00.000000000 Z
+date: 2019-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -203,6 +203,7 @@ files:
 - 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
@@ -210,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
@@ -249,7 +251,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Application localization kit