fastlane-plugin-wpmreleasetoolkit 2.2.0 → 3.1.0

data/lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/ios_extract_keys_from_strings_files.rb

@@ -0,0 +1,118 @@
+module Fastlane
+  module Actions
+    class IosExtractKeysFromStringsFilesAction < Action
+      def self.run(params)
+        source_parent_dir = params[:source_parent_dir]
+        target_original_files = params[:target_original_files]
+        keys_to_extract_per_target_file = keys_list_per_target_file(target_original_files)
+
+        # For each locale, extract the right translations from `<source_tablename>.strings` into each target `.strings` file
+        Dir.glob('*.lproj', base: source_parent_dir).each do |lproj_dir_name|
+          source_strings_file = File.join(source_parent_dir, lproj_dir_name, "#{params[:source_tablename]}.strings")
+          translations = Fastlane::Helper::Ios::L10nHelper.read_strings_file_as_hash(path: source_strings_file)
+
+          target_original_files.each do |target_original_file|
+            target_strings_file = File.join(File.dirname(File.dirname(target_original_file)), lproj_dir_name, File.basename(target_original_file))
+            next if target_strings_file == target_original_file # do not generate/overwrite the original locale itself
+
+            keys_to_extract = keys_to_extract_per_target_file[target_original_file]
+            UI.message("Extracting #{keys_to_extract.count} keys into #{target_strings_file}...")
+
+            extracted_translations = translations.slice(*keys_to_extract)
+            FileUtils.mkdir_p(File.dirname(target_strings_file)) # Ensure path up to parent dir exists, create it if not.
+            Fastlane::Helper::Ios::L10nHelper.generate_strings_file_from_hash(translations: extracted_translations, output_path: target_strings_file)
+          rescue StandardError => e
+            UI.user_error!("Error while writing extracted translations to `#{target_strings_file}`: #{e.message}")
+          end
+        rescue StandardError => e
+          UI.user_error!("Error while reading the translations from source file `#{source_strings_file}`: #{e.message}")
+        end
+      end
+
+      # Pre-load the list of keys to extract for each target file.
+      #
+      # @param [Array<String>] original_files array of paths to the originals of target files
+      # @return [Hash<String, Array<String>>] The hash listing the keys to extract for each target file
+      #
+      def self.keys_list_per_target_file(original_files)
+        original_files.map do |original_file|
+          keys = Fastlane::Helper::Ios::L10nHelper.read_strings_file_as_hash(path: original_file).keys
+          [original_file, keys]
+        end.to_h
+      rescue StandardError => e
+        UI.user_error!("Failed to read the keys to extract from originals file: #{e.message}")
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        'Extracts a subset of keys from a `.strings` file into separate `.strings` file(s)'
+      end
+
+      def self.details
+        <<~DETAILS
+          Extracts a subset of keys from a `.strings` file into separate `.strings` file(s), for each `*.lproj` subdirectory.
+
+          This is especially useful to extract, for each locale, the translations for files like `InfoPlist.strings` or
+          `<SomeIntentDefinitionFile>.strings` from the `Localizable.strings` file that we exported/downloaded back from GlotPress.
+
+          Since we typically merge all `*.strings` original files (e.g. `en.lproj/Localizable.strings` + `en.lproj/InfoPlist.strings` + …)
+          via `ios_merge_strings_file` before sending the originals to translations, we then need to extract the relevant keys and
+          translations back into the `*.lproj/InfoPlist.strings` after we pull those translations back from GlotPress
+          (`ios_download_strings_files_from_glotpress`). This is what this `ios_extract_keys_from_strings_files` action is for.
+        DETAILS
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :source_parent_dir,
+                                       env_name: 'FL_IOS_EXTRACT_KEYS_FROM_STRINGS_FILES_SOURCE_PARENT_DIR',
+                                       description: 'The parent directory containing all the `*.lproj` subdirectories in which the source `.strings` files reside',
+                                       type: String,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("`source_parent_dir` should be a path to an existing directory, but found `#{value}`.") unless File.directory?(value)
+                                         UI.user_error!("`source_parent_dir` should contain at least one `.lproj` subdirectory, but `#{value}` does not contain any.") if Dir.glob('*.lproj', base: value).empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :source_tablename,
+                                       env_name: 'FL_IOS_EXTRACT_KEYS_FROM_STRINGS_FILES_SOURCE_TABLENAME',
+                                       description: 'The basename of the `.strings` file (without the extension) to extract the keys and translations from for each locale',
+                                       type: String,
+                                       default_value: 'Localizable'),
+          FastlaneCore::ConfigItem.new(key: :target_original_files,
+                                       env_name: 'FL_IOS_EXTRACT_KEYS_FROM_STRINGS_FILES_TARGET_ORIGINAL_FILES',
+                                       description: 'The path(s) to the `<base-locale>.lproj/<target-tablename>.strings` file(s) for which we want to extract the keys to. ' \
+                                        + 'Each of those files should containing the original strings (typically `en` or `Base` locale) and will be used to determine which keys to extract from the `source_tablename`. ' \
+                                        + 'For each of those, the path(s) in which the translations will be extracted will be the files with the same basename in each of the other `*.lproj` sibling folders',
+                                       type: Array,
+                                       verify_block: proc do |values|
+                                         UI.user_error!('`target_original_files` must contain at least one path to an original `.strings` file.') if values.empty?
+                                         values.each do |v|
+                                           UI.user_error!("Path `#{v}` (found in `target_original_files`) does not exist.") unless File.exist?(v)
+                                           UI.user_error! "Expected `#{v}` (found in `target_original_files`) to be a path ending in a `*.lproj/*.strings`." unless File.extname(v) == '.strings' && File.extname(File.dirname(v)) == '.lproj'
+                                         end
+                                       end),
+        ]
+      end
+
+      def self.return_type
+        # Describes what type of data is expected to be returned
+        # see RETURN_TYPES in https://github.com/fastlane/fastlane/blob/master/fastlane/lib/fastlane/action.rb
+        nil
+      end
+
+      def self.return_value
+        # Freeform textual description of the return value
+      end
+
+      def self.authors
+        ['Automattic']
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :mac].include?(platform)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/ios_generate_strings_file_from_code.rb

@@ -36,7 +36,7 @@ module Fastlane
       #####################################################
 
       def self.description
-        'Generate the .strings files from your Objective-C and Swift code'
+        'Generate the `.strings` files from your Objective-C and Swift code'
       end
 
       def self.details

data/lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/ios_lint_localizations.rb

@@ -17,8 +17,8 @@ module Fastlane
       def self.run_linter(params)
         UI.message 'Linting localizations for parameter placeholders consistency...'
 
-        require_relative '../../helper/ios/ios_l10n_helper'
-        helper = Fastlane::Helper::Ios::L10nHelper.new(
+        require_relative '../../helper/ios/ios_l10n_linter_helper'
+        helper = Fastlane::Helper::Ios::L10nLinterHelper.new(
           install_path: resolve_path(params[:install_path]),
           version: params[:version]
         )
@@ -92,7 +92,7 @@ module Fastlane
             description: 'The path where to install the SwiftGen tooling needed to run the linting process. If a relative path, should be relative to your repo_root',
             type: String,
             optional: true,
-            default_value: "vendor/swiftgen/#{Fastlane::Helper::Ios::L10nHelper::SWIFTGEN_VERSION}"
+            default_value: "vendor/swiftgen/#{Fastlane::Helper::Ios::L10nLinterHelper::SWIFTGEN_VERSION}"
           ),
           FastlaneCore::ConfigItem.new(
             key: :version,
@@ -100,7 +100,7 @@ module Fastlane
             description: 'The version of SwiftGen to install and use for linting',
             type: String,
             optional: true,
-            default_value: Fastlane::Helper::Ios::L10nHelper::SWIFTGEN_VERSION
+            default_value: Fastlane::Helper::Ios::L10nLinterHelper::SWIFTGEN_VERSION
           ),
           FastlaneCore::ConfigItem.new(
             key: :input_dir,
@@ -115,7 +115,7 @@ module Fastlane
             description: 'The language that should be used as the base language that every other language will be compared against',
             type: String,
             optional: true,
-            default_value: Fastlane::Helper::Ios::L10nHelper::DEFAULT_BASE_LANG
+            default_value: Fastlane::Helper::Ios::L10nLinterHelper::DEFAULT_BASE_LANG
           ),
           FastlaneCore::ConfigItem.new(
             key: :only_langs,

data/lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/ios_localize_project.rb

@@ -16,11 +16,11 @@ module Fastlane
       #####################################################
 
       def self.description
-        'Gathers the string to localise'
+        'Gathers the strings to localise. Deprecated'
       end
 
       def self.details
-        'Gathers the string to localise. Deprecated in favor of the new `ios_generate_strings_file_from_code`'
+        'Gathers the strings to localise. Deprecated in favor of the new `ios_generate_strings_file_from_code`'
       end
 
       def self.category

data/lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/ios_merge_strings_files.rb

@@ -0,0 +1,75 @@
+module Fastlane
+  module Actions
+    class IosMergeStringsFilesAction < Action
+      def self.run(params)
+        UI.message "Merging strings files: #{params[:paths].inspect}"
+
+        duplicates = Fastlane::Helper::Ios::L10nHelper.merge_strings(paths: params[:paths], output_path: params[:destination])
+        duplicates.each do |dup_key|
+          UI.important "Duplicate key found while merging the `.strings` files: `#{dup_key}`"
+        end
+        duplicates
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        'Merge multiple `.strings` files into one'
+      end
+
+      def self.details
+        <<~DETAILS
+          Merge multiple `.strings` files into one.
+
+          Especially useful to prepare a single `.strings` file merging strings from both `Localizable.strings` from
+          the app code — typically previously extracted from `ios_generate_strings_file_from_code` —
+          and string files like `InfoPlist.strings` — which values may not be generated from the codebase but
+          manually maintained by developers.
+
+          The action only supports merging files which are in the OpenStep (`"key" = "value";`) text format (which is
+          the most common format for `.strings` files, and the one generated by `genstrings`), but can handle the case
+          of different files using different encodings (UTF8 vs UTF16) and is able to detect and report duplicates.
+          It does not handle `.strings` files in XML or binary-plist formats (which are valid but more rare)
+        DETAILS
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :paths,
+            env_name: 'FL_IOS_MERGE_STRINGS_FILES_PATHS',
+            description: 'The paths of all the `.strings` files to merge together',
+            type: Array,
+            optional: false
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :destination,
+            env_name: 'FL_IOS_MERGE_STRINGS_FILES_DESTINATION',
+            description: 'The path of the merged `.strings` file to generate. If nil, the merge will happen in-place in the first file in the `paths:` list',
+            type: String,
+            optional: true,
+            default_value: nil
+          ),
+        ]
+      end
+
+      def self.return_type
+        :array_of_strings
+      end
+
+      def self.return_value
+        'The list of duplicate keys found while merging the various `.strings` files'
+      end
+
+      def self.authors
+        ['automattic']
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :mac].include? platform
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/wpmreleasetoolkit/helper/android/android_git_helper.rb

@@ -27,26 +27,6 @@ module Fastlane
             )
           end
         end
-
-        # Calls the `tools/update-translations.sh` script from the project repo, then lint them using the provided gradle task
-        #
-        # Deprecated. Use the `android_download_translations` action instead.
-        #
-        # @env PROJECT_ROOT_FOLDER The path to the git root of the project
-        # @env PROJECT_NAME The name of the directory containing the project code (especially containing the `build.gradle` file)
-        #
-        # @param [String] validate_translation_command The name of the gradle task to run to validate the translations
-        #
-        # @todo Remove this once every client has migrated to `android_download_translations` and we got rid of that legacy action.
-        #
-        def self.update_metadata(validate_translation_command)
-          Action.sh('./tools/update-translations.sh')
-          Action.sh('git', 'submodule', 'update', '--init', '--recursive')
-          Action.sh('./gradlew', validate_translation_command)
-
-          res_dir = File.join(ENV['PROJECT_ROOT_FOLDER'], ENV['PROJECT_NAME'], 'src', 'main', 'res')
-          Fastlane::Helper::GitHelper.commit(message: 'Update translations', files: res_dir, push: true)
-        end
       end
     end
   end

data/lib/fastlane/plugin/wpmreleasetoolkit/helper/android/android_localize_helper.rb

@@ -92,6 +92,14 @@ module Fastlane
           UI.user_error!("String #{string_name} [#{string_content}] was found in library #{library[:library]} but not in the main file.")
         end
 
+        # Merge strings from a library into the strings.xml of the main app
+        #
+        # @param [String] main Path to the main strings.xml file (something like `…/res/values/strings.xml`)
+        # @param [Hash] library Hash describing the library to merge. The Hash should contain the following keys:
+        #                       - `:library`: The human readable name of the library, used to display in console messages
+        #                       - `:strings_path`: The path to the strings.xml file of the library to merge into the main one
+        #                       - `:exclusions`: An array of strings keys to exclude during merge. Any of those keys from the library's `strings.xml` will be skipped and won't be merged into the main one.
+        # @return [Boolean] True if at least one string from the library has been added to (or has updated) the main strings file.
         def self.merge_lib(main, library)
           UI.message("Merging #{library[:library]} strings into #{main}")
           main_strings = File.open(main) { |f| Nokogiri::XML(f, nil, Encoding::UTF_8.to_s) }

data/lib/fastlane/plugin/wpmreleasetoolkit/helper/git_helper.rb

@@ -5,6 +5,9 @@ module Fastlane
     # Helper methods to execute git-related operations
     #
     module GitHelper
+      # Fallback default branch of the client repository.
+      DEFAULT_GIT_BRANCH = 'trunk'.freeze
+
       # Checks if the given path, or current directory if no path is given, is
       # inside a Git repository
       #

data/lib/fastlane/plugin/wpmreleasetoolkit/helper/ios/ios_git_helper.rb

@@ -35,8 +35,9 @@ module Fastlane
         # @env PROJECT_ROOT_FOLDER The path to the git root of the project
         # @env PROJECT_NAME The name of the directory containing the project code (especially containing the `build.gradle` file)
         #
-        # @todo Migrate the scripts, currently in each host repo and called by this method, to be helpers and actions
-        #       in the release-toolkit instead, and move this code away from `ios_git_helper`.
+        # @deprecated This method is only used by the `ios_localize_project` action, which is itself deprecated
+        #             in favor of the new `ios_generate_strings_file_from_code` action
+        # @todo [Next Major] Remove this method once we fully remove `ios_localize_project`
         #
         def self.localize_project
           Action.sh("cd #{get_from_env!(key: 'PROJECT_ROOT_FOLDER')} && ./Scripts/localize.py")