Add ios_merge_strings_files action & test

Based on previously introduced ios_l10n_helper

Author: AliSoftware

.rubocop_todo.yml

@@ -144,6 +144,7 @@ RSpec/FilePath:
     - 'spec/check_localization_progress_spec.rb'
     - 'spec/ios_generate_strings_file_from_code_spec.rb'
     - 'spec/ios_l10n_helper_spec.rb'
+    - 'spec/ios_merge_strings_files_spec.rb'
 
 # Offense count: 8
 # Cop supports --auto-correct.

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 `.strings` files (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)
+        platform == :ios
+      end
+    end
+  end
+end

spec/ios_merge_strings_files_spec.rb

@@ -0,0 +1,42 @@
+describe Fastlane do
+  describe Fastlane::FastFile do
+    let(:test_data_dir) { File.join(File.dirname(__FILE__), 'test-data', 'translations', 'ios_l10n_helper') }
+
+    def fixture(name)
+      File.join(test_data_dir, name)
+    end
+
+    describe '#ios_merge_strings_files' do
+      it 'calls the action with the proper parameters and warn and return duplicate keys' do
+        # Arrange
+        messages = []
+        allow(FastlaneCore::UI).to receive(:important) do |message|
+          messages.append(message)
+        end
+        inputs = ['Localizable-utf16.strings', 'non-latin-utf16.strings']
+
+        Dir.mktmpdir('a8c-release-toolkit-tests-') do |tmpdir|
+          inputs.each { |f| FileUtils.cp(fixture(f), tmpdir) }
+
+          # Act
+          result = Dir.chdir(tmpdir) do
+            described_class.new.parse("lane :test do
+              ios_merge_strings_files(
+                paths: ['#{inputs[0]}', '#{inputs[1]}'],
+                destination: 'output.strings'
+              )
+            end").runner.execute(:test)
+          end
+
+          # Assert
+          expect(File).to exist(File.join(tmpdir, 'output.strings'))
+          expect(result).to eq(%w[key1 key2])
+          expect(messages).to eq([
+                                   'Duplicate key found while merging the `.strings` files: `key1`',
+                                   'Duplicate key found while merging the `.strings` files: `key2`',
+                                 ])
+        end
+      end
+    end
+  end
+end