fastlane-plugin-wpmreleasetoolkit 14.9.0 → 14.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4682e90d456806e69e70758d89fb49a05470d2ccddf680d967a077b744a2a5c
-  data.tar.gz: a0b958abad01adf90ba744473469674caf4142ef4df833248b1442cfe6f65a4e
+  metadata.gz: 1db5468c63b1d9cec762c5af38e8cb1e3b858214fb15d1a1d2fd3502da09b9cc
+  data.tar.gz: 9fc9c2104373e1161421e38a014af1b7a686a72747febc8284d7acca2b06ba25
 SHA512:
-  metadata.gz: 1d5d9c8f61b57fd12b4cdcf746c66211cec731cc5c17cb4b7be65d9d18fc54a3ddc94ddfbb0e07828d100df042ad60b97eb58d9e14002e109fe569874f67dd8b
-  data.tar.gz: c04ad671d17c8afc2ebe0825db13a3c40cd1326b92d5269c365a3ae0cc2fe86cd76663e58c02de3c13283833c9069154c087ee0799f7fff3e07126cac79c2af4
+  metadata.gz: a984608e0fd91a036759a8700d663aca874af9105732f175c42fa97e4e75a2dca1daa0bbcfa0c79caf77ed4463ddc76a4eaf78a6c902220b0df060337a692a7d
+  data.tar.gz: f97d44bb69c2f8283c061f65d3dac7bffb15ea7fd849ee5f3b3db8795e2129d19b8ad4091871e144f7706f3796678b476c856c2fe01f8aaa8f25040f1cb329eb

data/lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_prune_orphaned_translations_action.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+require 'fastlane/action'
+require 'nokogiri'
+
+module Fastlane
+  module Actions
+    class AndroidPruneOrphanedTranslationsAction < Action
+      # Matches an Android `values-<qualifier>` directory whose qualifier is a locale: a 2- or 3-letter language
+      # code (`fr`, `kmr`), an optional region (`pt-rBR`, `es-r419`), or a BCP-47 `b+` form (`b+sr+Latn`), so
+      # non-locale qualifier dirs (e.g. `values-night`, `values-v21`, `values-land`) are left untouched.
+      LOCALE_VALUES_DIR_REGEX = /\Avalues-(?:b\+[a-zA-Z]+(?:\+[a-zA-Z0-9]+)*|[a-z]{2,3}(?:-r(?:[A-Z]{2}|\d{3}))?)\z/
+
+      # Android UI-mode qualifiers, which are never locales:
+      # https://developer.android.com/guide/topics/resources/providing-resources#UiModeQualifier
+      # `car` is indistinguishable by shape from a 3-letter ISO 639 language code, so `LOCALE_VALUES_DIR_REGEX`
+      # would otherwise treat `values-car` as a locale and prune its (valid) car-mode resources. There's no purely
+      # syntactic way to tell the two apart, so we exclude the documented UI-mode qualifiers explicitly. (`car` is
+      # the only one short enough to currently match the regex; the rest are listed to capture the full set.)
+      UI_MODE_QUALIFIERS = %w[car desk television appliance watch vrheadset].freeze
+
+      DEFAULT_SOURCE_STRINGS_FILE_NAME = 'strings.xml'
+      DEFAULT_SOURCE_STRINGS_RELATIVE_PATH = File.join('values', DEFAULT_SOURCE_STRINGS_FILE_NAME).freeze
+
+      def self.run(params)
+        res_dir = params[:res_dir]
+        source_paths = [File.join(res_dir, DEFAULT_SOURCE_STRINGS_RELATIVE_PATH)] + params[:additional_source_strings_paths]
+        valid_keys = collect_keys(source_paths)
+
+        locale_files = Dir.glob(File.join(res_dir, 'values-*', DEFAULT_SOURCE_STRINGS_FILE_NAME)).select do |file|
+          dir_name = File.basename(File.dirname(file))
+          dir_name.match?(LOCALE_VALUES_DIR_REGEX) && !UI_MODE_QUALIFIERS.include?(dir_name.delete_prefix('values-'))
+        end
+        total_pruned = 0
+
+        locale_files.each do |file|
+          pruned = prune_file(file: file, valid_keys: valid_keys)
+          next if pruned.empty?
+
+          total_pruned += pruned.count
+          UI.message("Pruned #{pruned.count} orphaned entries from `#{file}`: #{pruned.join(', ')}")
+        end
+
+        UI.success("Pruned #{total_pruned} orphaned translation entries across #{locale_files.count} locale file(s).")
+        total_pruned
+      end
+
+      # Collects the set of resource names (string, string-array, plurals, …) declared in the given strings files.
+      #
+      # @param [Array<String>] paths The strings.xml files to read the valid keys from.
+      # @return [Set<String>] The set of declared resource names.
+      def self.collect_keys(paths)
+        paths.each_with_object(Set.new) do |path, keys|
+          doc = File.open(path) { |f| Nokogiri::XML(f, nil, Encoding::UTF_8.to_s) }
+          doc.xpath('/resources/*[@name]').each { |node| keys << node['name'] }
+        end
+      end
+
+      # Removes from `file` any resource entry whose `name` is not in `valid_keys`, preserving the rest of the
+      # file's formatting (so the change shows up as a minimal diff).
+      #
+      # @param [String] file The locale strings.xml file to prune.
+      # @param [Set<String>] valid_keys The set of names that are allowed to remain.
+      # @return [Array<String>] The names of the entries that were pruned.
+      def self.prune_file(file:, valid_keys:)
+        doc = File.open(file) { |f| Nokogiri::XML(f, nil, Encoding::UTF_8.to_s) }
+        orphans = doc.xpath('/resources/*[@name]').reject { |node| valid_keys.include?(node['name']) }
+        return [] if orphans.empty?
+
+        names = orphans.map { |node| node['name'] }
+        orphans.each do |node|
+          # Drop the indentation/newline text node right before the element too, to avoid leaving a blank line.
+          previous = node.previous_sibling
+          previous.remove if previous&.text? && previous.text.strip.empty?
+          node.remove
+        end
+
+        File.open(file, 'w') { |f| doc.write_to(f, encoding: Encoding::UTF_8.to_s, indent: 4) }
+        names
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        'Removes translations whose keys are not present in the source strings, to avoid Lint `ExtraTranslation` errors'
+      end
+
+      def self.details
+        <<~DETAILS
+          When downloading translations from GlotPress, the export may include keys that are no longer present in
+          the app's source strings (e.g. removed or renamed since the GlotPress source was last synced). Android
+          Lint flags these orphaned translations as `ExtraTranslation` errors.
+
+          This action removes — from every `values-*/strings.xml` under `res_dir` — any `<string>`, `<string-array>`
+          or `<plurals>` entry whose `name` is not declared in the default `values/strings.xml` of `res_dir`,
+          optionally unioned with `additional_source_strings_paths` (useful when a product flavor overlays a base
+          module's resources at build time, so the base module's keys are valid too).
+        DETAILS
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :res_dir,
+            description: "Path to the Android project's `res` directory containing the `values-*` locale subdirectories to prune",
+            type: String,
+            optional: false,
+            verify_block: proc do |value|
+              source_path = File.join(value, DEFAULT_SOURCE_STRINGS_RELATIVE_PATH)
+              UI.user_error!("Source strings file not found: `#{source_path}`") unless File.file?(source_path)
+            end
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :additional_source_strings_paths,
+            description: 'Paths to additional default `strings.xml` files whose keys should also be treated as valid ' \
+                         '(e.g. a base module that the pruned `res_dir` overlays at build time)',
+            type: Array,
+            optional: true,
+            default_value: [],
+            verify_block: proc do |value|
+              value.each do |path|
+                UI.user_error!("Source strings file not found: `#{path}`") unless File.file?(path)
+              end
+            end
+          ),
+        ]
+      end
+
+      def self.return_value
+        'The total number of orphaned translation entries that were pruned'
+      end
+
+      def self.authors
+        ['Automattic']
+      end
+
+      def self.is_supported?(platform)
+        platform == :android
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/wpmreleasetoolkit/version.rb

@@ -3,6 +3,6 @@
 module Fastlane
   module Wpmreleasetoolkit
     NAME = 'fastlane-plugin-wpmreleasetoolkit'
-    VERSION = '14.9.0'
+    VERSION = '14.10.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-wpmreleasetoolkit
 version: !ruby/object:Gem::Version
-  version: 14.9.0
+  version: 14.10.0
 platform: ruby
 authors:
 - Automattic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-06-30 00:00:00.000000000 Z
+date: 2026-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: buildkit
@@ -131,7 +131,7 @@ dependencies:
         version: '1.19'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.19.3
+        version: 1.19.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -141,7 +141,7 @@ dependencies:
         version: '1.19'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.19.3
+        version: 1.19.4
 - !ruby/object:Gem::Dependency
   name: octokit
   requirement: !ruby/object:Gem::Requirement
@@ -421,6 +421,7 @@ files:
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_download_translations_action.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_firebase_test.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_launch_emulator_action.rb
+- lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_prune_orphaned_translations_action.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_send_app_size_metrics.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_shutdown_emulator_action.rb
 - lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_update_release_notes.rb