fastlane-plugin-wpmreleasetoolkit 1.0.0

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

@@ -0,0 +1,121 @@
+require_relative '../../helper/ios/ios_adc_app_sizes_helper.rb'
+
+module Fastlane
+  module Actions
+    class IosGetStoreAppSizesAction < Action
+      Helper = Fastlane::Helper::Ios::ADCAppSizesHelper
+
+      def self.run(params)
+        app_sizes = Helper.get_adc_sizes(
+          adc_user: params[:adc_user],
+          adc_team: params[:adc_team],
+          bundle_id: params[:bundle_id],
+          only_version: params[:version],
+          limit: params[:limit]
+        )
+
+        devices = params[:devices]
+
+        case params[:format]
+        when 'csv'
+          csv = Helper.format_csv(app_sizes, devices: devices)
+          UI.message "Result (CSV)\n\n#{csv}\n"
+        when 'markdown'
+          tables = Helper.format_markdown(app_sizes, devices: devices)
+          tables.each do |table|
+            UI.message "Result (Markdown)\n\n#{table}\n"
+          end
+        end
+
+        return app_sizes
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        'Gets the size of the app as reported in Apple Developer Portal for recent versions'
+      end
+
+      def self.details
+        'Gets the download + installed size of the app from the Apple Developer Portail for various app versions release to AppStore and various device types'
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :adc_user,
+            env_name: 'FL_IOS_STOREAPPSIZES_USER',
+            description: 'The ADC user to use to log into ADC',
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :adc_team,
+            env_name: 'FL_IOS_STOREAPPSIZES_TEAM',
+            description: 'The ADC team name to use to log into ADC',
+            type: String,
+            optional: true,
+            default_value: 'Automattic, Inc.'
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :bundle_id,
+            env_name: 'FL_IOS_STOREAPPSIZES_BUNDLEID',
+            description: 'The bundleID of the app to retrieve sizes from',
+            type: String
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :version,
+            env_name: 'FL_IOS_STOREAPPSIZES_VERSION',
+            description: 'The version to retrive the data for. Keep nil to retrieve data for all the last {limit} versions',
+            type: String,
+            optional: true
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :limit,
+            env_name: 'FL_IOS_STOREAPPSIZES_LIMIT',
+            description: 'The maximum number of past versions to retrieve information from',
+            type: Integer,
+            optional: true,
+            default_value: 10
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :devices,
+            env_name: 'FL_IOS_STOREAPPSIZES_DEVICES',
+            description: 'The list of devices to print the app size for. If nil, will print data for all device types returned by ADC',
+            type: Array,
+            optional: true
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :format,
+            env_name: 'FL_IOS_STOREAPPSIZES_FORMAT',
+            description: "The output format used to print the result. Can be one of 'csv' or 'markdown', or nil to print nothing (raw data will always be available as the the action's return value)",
+            type: String,
+            optional: true
+          ),
+        ]
+      end
+
+      def self.output
+        # Define the shared values you are going to provide
+      end
+
+      def self.return_type
+        :hash
+      end
+
+      def self.return_value
+        'Return a Hash containing the details of download and install app size, for various device models, all that for each requested version of the app'
+      end
+
+      def self.authors
+        # So no one will ever forget your contribution to fastlane :) You are awesome btw!
+        ['AliSoftware']
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :mac].include?(platform)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,78 @@
+module Fastlane
+  module Actions
+    class IosHotfixPrechecksAction < Action
+      def self.run(params)
+        UI.message "Skip confirm: #{params[:skip_confirm]}"
+        UI.message ''
+
+        require_relative '../../helper/ios/ios_version_helper.rb'
+        require_relative '../../helper/ios/ios_git_helper.rb'
+
+        # Evaluate previous tag
+        new_ver = params[:version]
+        prev_ver = Fastlane::Helper::Ios::VersionHelper.calc_prev_hotfix_version(new_ver)
+
+        # Confirm
+        message = "Requested Hotfix version: #{new_ver}\n"
+        message << "Branching from: #{prev_ver}\n"
+
+        if !params[:skip_confirm]
+          UI.user_error!('Aborted by user request') unless UI.confirm("#{message}Do you want to continue?")
+        else
+          UI.message(message)
+        end
+
+        # Check tags
+        UI.crash!("Version #{new_ver} already exists! Abort!") if other_action.git_tag_exists(tag: new_ver)
+
+        UI.crash!("Version #{prev_ver} is not tagged! Can't branch. Abort!") unless other_action.git_tag_exists(tag: prev_ver)
+
+        # Check local repo status
+        other_action.ensure_git_status_clean()
+
+        # Return the current version
+        prev_ver
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        'Runs some prechecks before preparing for a new hotfix'
+      end
+
+      def self.details
+        'Checks out a new branch from a tag and updates tags'
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :version,
+                                       env_name: 'FL_IOS_HOTFIX_PRECHECKS_VERSION',
+                                       description: 'The version to work on', # a short description of this parameter
+                                       is_string: true),
+          FastlaneCore::ConfigItem.new(key: :skip_confirm,
+                                       env_name: 'FL_IOS_HOTFIX_PRECHECKS_SKIPCONFIRM',
+                                       description: 'Skips confirmation',
+                                       is_string: false, # true: verifies the input is a string, false: every kind of value
+                                       default_value: false), # the default value if the user didn't provide one
+        ]
+      end
+
+      def self.output
+      end
+
+      def self.return_value
+      end
+
+      def self.authors
+        ['loremattei']
+      end
+
+      def self.is_supported?(platform)
+        platform == :ios
+      end
+    end
+  end
+end

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

@@ -0,0 +1,167 @@
+module Fastlane
+  module Actions
+    class IosLintLocalizationsAction < Action
+      def self.run(params)
+        violations = {}
+
+        loop do
+          violations = self.run_linter(params)
+          break unless !violations.empty? && params[:allow_retry] && UI.confirm(RETRY_MESSAGE)
+        end
+
+        UI.abort_with_message!(ABORT_MESSAGE) if !violations.empty? && params[:abort_on_violations]
+
+        violations
+      end
+
+      def self.run_linter(params)
+        UI.message 'Linting localizations for parameter placeholders consistency...'
+
+        require_relative '../../helper/ios/ios_l10n_helper.rb'
+        helper = Fastlane::Helper::Ios::L10nHelper.new(
+          install_path: resolve_path(params[:install_path]),
+          version: params[:version]
+        )
+        violations = helper.run(
+          input_dir: resolve_path(params[:input_dir]),
+          base_lang: params[:base_lang],
+          only_langs: params[:only_langs]
+        )
+
+        violations.each do |lang, diff|
+          UI.error "Inconsistencies found between '#{params[:base_lang]}' and '#{lang}':\n\n#{diff}\n"
+        end
+
+        violations
+      end
+
+      RETRY_MESSAGE = <<~MSG
+        Inconsistencies found during Localization linting.
+        You need to fix them before continuing. From this point on, you should either:
+
+        - Cancel this lane (reply 'No' below), then work with polyglots in #i18n
+          to fix those directly in GlotPress – by rejecting the inconsistent
+          translations, or by submitting a fixed copy. Rerun the lane when everything
+          has been fixed.
+
+          This is the recommended way to go, as it will fix the issues at their source.
+
+        - Or manually edit the `Localizable.strings` files to fix the inconsistencies
+          locally, commit them, then reply 'Yes' below to re-lint and validate that all
+          inconsistencies have been fixed locally so you can continue with the build.
+
+          This is only a workaround to allow you to submit a build if translators are
+          not available to help you fix the issues in GlotPress in time. You will still
+          need to let the translators know that they will need to fix those copies
+          at some point before the next build to fix the root of the issue.
+
+        Did you fix the `.strings` files locally and want to lint them again?
+      MSG
+
+      ABORT_MESSAGE = <<~MSG
+        Inconsistencies found during Localization linting. Aborting.
+      MSG
+
+      def self.repo_root
+        @repo_root || `git rev-parse --show-toplevel`.chomp
+      end
+
+      # If the path is relative, makes the path absolute by resolving it relative to the repository's root.
+      # If the path is already absolute, it will not affect it and return it as-is.
+      def self.resolve_path(path)
+        File.absolute_path(path, repo_root)
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        'Lint the different *.lproj/.strings files for each locale and ensure the parameter placeholders are consistent.'
+      end
+
+      def self.details
+        'Compares the translations against a base language to find potential mismatches for the %s/%d/… parameter placeholders between locales.'
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :install_path,
+            env_name: 'FL_IOS_LINT_TRANSLATIONS_INSTALL_PATH',
+            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}"
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :version,
+            env_name: 'FL_IOS_LINT_TRANSLATIONS_SWIFTGEN_VERSION',
+            description: 'The version of SwiftGen to install and use for linting',
+            type: String,
+            optional: true,
+            default_value: Fastlane::Helper::Ios::L10nHelper::SWIFTGEN_VERSION
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :input_dir,
+            env_name: 'FL_IOS_LINT_TRANSLATIONS_INPUT_DIR',
+            description: 'The path to the directory containing the .lproj folders to lint, relative to your git repo root',
+            type: String,
+            optional: false
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :base_lang,
+            env_name: 'FL_IOS_LINT_TRANSLATIONS_BASE_LANG',
+            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
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :only_langs,
+            env_name: 'FL_IOS_LINT_TRANSLATIONS_ONLY_LANGS',
+            description: 'The list of languages to limit the analysis to',
+            type: Array,
+            optional: true
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :abort_on_violations,
+            env_name: 'FL_IOS_LINT_TRANSLATIONS_ABORT',
+            description: 'Should we abort the rest of the lane with a global error if any violations are found?',
+            optional: true,
+            default_value: true,
+            is_string: false # https://docs.fastlane.tools/advanced/actions/#boolean-parameters
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :allow_retry,
+            env_name: 'FL_IOS_LINT_TRANSLATIONS_ALLOW_RETRY',
+            description: 'If any violations are found, show an interactive prompt allowing the user to manually fix the issues locally and retry the linting',
+            optional: true,
+            default_value: false,
+            is_string: false # https://docs.fastlane.tools/advanced/actions/#boolean-parameters
+          ),
+        ]
+      end
+
+      def self.output
+        nil
+      end
+
+      def self.return_type
+        :hash_of_strings
+      end
+
+      def self.return_value
+        'A hash, keyed by language code, whose values are the diff found for said language'
+      end
+
+      def self.authors
+        ['AliSoftware']
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :mac].include?(platform)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+module Fastlane
+  module Actions
+    class IosLocalizeProjectAction < Action
+      def self.run(params)
+        UI.message 'Updating project localisation...'
+
+        require_relative '../../helper/ios/ios_git_helper.rb'
+        other_action.cocoapods()
+        Fastlane::Helper::Ios::GitHelper.localize_project()
+
+        UI.message 'Done.'
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        'Gathers the string to localise'
+      end
+
+      def self.details
+        'Gathers the string to localise'
+      end
+
+      def self.available_options
+      end
+
+      def self.output
+      end
+
+      def self.return_value
+      end
+
+      def self.authors
+        ['loremattei']
+      end
+
+      def self.is_supported?(platform)
+        platform == :ios
+      end
+    end
+  end
+end

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

@@ -0,0 +1,93 @@
+require 'fastlane/action'
+require 'date'
+require_relative '../../helper/github_helper'
+require_relative '../../helper/ios/ios_version_helper'
+module Fastlane
+  module Actions
+    class IosMergeTranslatorsStringsAction < Action
+      def self.run(params)
+        folder_path = File.expand_path(params[:strings_folder])
+
+        subfolders = Dir.entries(folder_path)
+        subfolders.each do |strings_folder|
+          merge_folder(File.join(folder_path, strings_folder)) if strings_folder.ends_with?('.lproj')
+        end
+      end
+
+      def self.merge_folder(strings_folder)
+        main_file = File.join(strings_folder, 'Localizable.strings')
+        tmp_main_file = File.join(strings_folder, 'Localizable_current.strings')
+        return unless File.exist?(main_file) && File.exist?(tmp_main_file)
+
+        UI.message("Merging in: #{strings_folder}")
+
+        join_files = Dir.glob(File.join(strings_folder, 'Localizable_*.strings')) - [tmp_main_file]
+        extra_strings = []
+        extra_keys = []
+        join_files.each do |join_strings|
+          my_strings = File.read(join_strings).split("\n")
+          my_strings.each do |string|
+            if string[/^\"(.*)\" = \"(.*)\";$/]
+              /^\"(?<string_key>.*)\" = \"/i =~ string
+              unless extra_keys.include?(string_key)
+                extra_strings << string
+                extra_keys << string_key
+              end
+            end
+          end
+
+          File.delete(join_strings)
+        end
+
+        File.open(main_file, 'w') do |f|
+          File.open(tmp_main_file).each do |line|
+            f.puts(check_line(line, extra_keys))
+          end
+          f.puts(extra_strings)
+        end
+
+        File.delete(tmp_main_file)
+      end
+
+      def self.check_line(line, extra_keys)
+        return line unless line[/^\"(.*)\" = \"(.*)\";$/]
+
+        /^\"(?<line_key>.*)\" = \"/i =~ line
+        return '' if extra_keys.include?(line_key)
+
+        return line
+      end
+
+      def self.description
+        'Merge strings for translators'
+      end
+
+      def self.authors
+        ['Lorenzo Mattei']
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        # Optional:
+        'Merges waiting and fuzzy strings into the main file for translators'
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :strings_folder,
+                                       env_name: 'IMTS_STRING_FOLDER',
+                                       description: 'The folder that contains all the translations',
+                                       optional: false,
+                                       type: String),
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end