fastlane-plugin-wpmreleasetoolkit 1.0.0 → 1.3.1

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

@@ -21,7 +21,7 @@ module Fastlane
 
         UI.message("Merging in: #{strings_folder}")
 
-        tmp_main_file = main_file + '.tmp'
+        tmp_main_file = "#{main_file}.tmp"
         FileUtils.cp(main_file, tmp_main_file)
 
         join_files = Dir.glob(File.join(strings_folder, 'strings-*.xml'))

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

@@ -2,13 +2,15 @@ module Fastlane
   module Actions
     class AndroidTagBuildAction < Action
       def self.run(params)
-        require_relative '../../helper/android/android_version_helper.rb'
-        require_relative '../../helper/android/android_git_helper.rb'
+        require_relative '../../helper/android/android_version_helper'
+        require_relative '../../helper/android/android_git_helper'
 
-        release_ver = Fastlane::Helper::Android::VersionHelper.get_release_version()
-        alpha_ver = Fastlane::Helper::Android::VersionHelper.get_alpha_version() unless ENV['HAS_ALPHA_VERSION'].nil?
+        app = ENV['PROJECT_NAME'].nil? ? params[:app] : ENV['PROJECT_NAME']
+
+        release_ver = Fastlane::Helper::Android::VersionHelper.get_release_version(product_name: app)
+        alpha_ver = Fastlane::Helper::Android::VersionHelper.get_alpha_version(app)
         Fastlane::Helper::GitHelper.create_tag(release_ver[Fastlane::Helper::Android::VersionHelper::VERSION_NAME])
-        Fastlane::Helper::GitHelper.create_tag(alpha_ver[Fastlane::Helper::Android::VersionHelper::VERSION_NAME]) unless ENV['HAS_ALPHA_VERSION'].nil? || (params[:tag_alpha] == false)
+        Fastlane::Helper::GitHelper.create_tag(alpha_ver[Fastlane::Helper::Android::VersionHelper::VERSION_NAME]) unless alpha_ver.nil? || (params[:tag_alpha] == false)
       end
 
       #####################################################
@@ -30,6 +32,10 @@ module Fastlane
                                        description: 'True to skip tagging the alpha version',
                                        is_string: false,
                                        default_value: true),
+          FastlaneCore::ConfigItem.new(key: :app,
+                                       env_name: 'PROJECT_NAME',
+                                       description: 'The name of the app to get the release version for',
+                                       is_string: true), # true: verifies the input is a string, false: every kind of value
         ]
       end
 

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

@@ -6,7 +6,7 @@ module Fastlane
 
     class AndroidUpdateMetadataAction < Action
       def self.run(params)
-        require_relative '../../helper/android/android_git_helper.rb'
+        require_relative '../../helper/android/android_git_helper'
 
         Fastlane::Helper::Android::GitHelper.update_metadata(ENV['validate_translations'])
       end

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

@@ -4,9 +4,9 @@ module Fastlane
       def self.run(params)
         UI.message 'Updating the release notes...'
 
-        require_relative '../../helper/android/android_version_helper.rb'
-        require_relative '../../helper/release_notes_helper.rb'
-        require_relative '../../helper/git_helper.rb'
+        require_relative '../../helper/android/android_version_helper'
+        require_relative '../../helper/release_notes_helper'
+        require_relative '../../helper/git_helper'
 
         path = File.join(ENV['PROJECT_ROOT_FOLDER'] || '.', 'RELEASE-NOTES.txt')
         next_version = Fastlane::Helper::Android::VersionHelper.calc_next_release_short_version(params[:new_version])

data/lib/fastlane/plugin/wpmreleasetoolkit/actions/common/check_for_toolkit_updates_action.rb

@@ -0,0 +1,99 @@
+require 'fastlane/action'
+require 'rubygems/command_manager'
+
+module Fastlane
+  module Actions
+    class CheckForToolkitUpdatesAction < Action
+      TOOLKIT_SPEC_NAME = 'fastlane-plugin-wpmreleasetoolkit'.freeze
+
+      def self.run(params)
+        updater = Gem::CommandManager.instance[:update]
+        installed_gems = updater.highest_installed_gems.select { |spec| spec == TOOLKIT_SPEC_NAME }
+        local_version = Gem::Version.new(installed_gems[TOOLKIT_SPEC_NAME].version)
+        UI.message("Currently using release toolkit version #{local_version.to_s.yellow}.")
+        UI.message('Checking for updates now...')
+        updates_needed = updater.which_to_update(installed_gems, [TOOLKIT_SPEC_NAME])
+
+        if updates_needed.empty?
+          UI.success('Your release toolkit is up-to-date! ✅')
+          return nil
+        end
+
+        # Return type of which_to_update differs before/after RubyGems 3.1.0, so normalize to always use Gem::NameTuple
+        updates_needed = Gem::NameTuple.from_list(updates_needed)
+        latest_version = updates_needed.find { |gem_info| gem_info.name == TOOLKIT_SPEC_NAME }.version
+
+        UI.message(['There is a newest version '.yellow, latest_version.to_s.red, ' of the release toolkit!'.yellow].join)
+        warn_on_breaking_update(local_version, latest_version)
+
+        return latest_version if params[:skip_update_suggestion] || !UI.confirm('Do you want to run bundle update now?')
+
+        sh('bundle', 'update', TOOLKIT_SPEC_NAME)
+        UI.abort_with_message! <<~UPDATE_MESSAGE
+          #{TOOLKIT_SPEC_NAME} have been updated. Please check and commit the changes in your Gemfile.lock file,
+          then restart your previous invocation of fastlane to use the new toolkit.
+        UPDATE_MESSAGE
+      end
+
+      def self.warn_on_breaking_update(current_version, latest_version)
+        current_semver_requirement = Gem::Requirement.new(current_version.approximate_recommendation)
+        compatible_update = current_semver_requirement.satisfied_by?(latest_version)
+        return if compatible_update
+
+        new_semver_requirement = latest_version.approximate_recommendation
+        UI.important <<~BREAKING_CHANGE_MESSAGE
+          The latest version available (#{latest_version}) introduces breaking changes compared to the #{current_version} you are currently using.
+
+           - To update to #{latest_version}, first edit your \`Pluginfile\` to use '#{new_semver_requirement}', run \`bundle update\`,
+             then be sure to make all the necessary changes to your \`Fastfile\` (see the toolkit's CHANGELOG)
+             to take those breaking changes into account.
+
+           - If you are not ready to make the major version bump, you can still try to update to the latest compatible,
+             non-breaking version by running \`bundle update\` now. This will not update to the latest #{latest_version}, but
+             might still update to a newer version compatible with '#{current_semver_requirement}' if one exists; which is still valuable
+             to at least get bugfixes, until you are ready to jump to the next major version later.
+        BREAKING_CHANGE_MESSAGE
+      end
+
+      def self.description
+        'Check that we are on the latest version of the release toolkit, and propose to update if not'
+      end
+
+      def self.authors
+        ['Olivier Halligon']
+      end
+
+      def self.return_value
+        'Returns the latest version of the toolkit available if your toolkit is not up-to-date, or nil if you are already up-to-date.'
+      end
+
+      def self.details
+        <<~DETAILS
+          Check that we are on the latest version of the release toolkit, and propose to update if not.
+
+          This action will check if you are on the *latest* version, regardless of the version requirement restriction you might have
+          set in your Gemfile/Pluginfile; which means that even if you agree to the prompt suggesting you to run bundle update, it might not
+          actually end up updating to the *latest* version automatically (esp. if the latest introduces breaking changes).
+
+          Note that if it finds an update and you then agree to the prompt and run bundle update, the action will abort your fastlane invocation
+          after running bundle update. This will let you check and commit the changes, before restarting the lane by re-invoking fastlane.
+          This is also needed to ensure fastlane loads the new toolkit version after update on second run.
+        DETAILS
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :skip_update_suggestion,
+                                       env_name: 'CHECK_FOR_TOOLKIT_UPDATES_SKIP_UPDATE_SUGGESTION',
+                                       description: 'If true, will still check for new versions, but will not ask if you want to run bundle update if an update is found',
+                                       is_string: false, # Boolean
+                                       default_value: false),
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/wpmreleasetoolkit/actions/common/check_translation_progress.rb

@@ -0,0 +1,147 @@
+module Fastlane
+  module Actions
+    class CheckTranslationProgressAction < Action
+      def self.run(params)
+        require_relative '../../helper/glotpress_helper'
+
+        UI.message('Checking translations status...')
+
+        under_threshold_langs = check_translations(
+          glotpress_url: params[:glotpress_url],
+          language_codes: params[:language_codes],
+          abort_on_violations: params[:abort_on_violations],
+          threshold: params[:min_acceptable_translation_percentage]
+        )
+
+        unless under_threshold_langs.empty?
+          check_results(
+            under_threshold_langs: under_threshold_langs,
+            threshold: params[:min_acceptable_translation_percentage],
+            skip_confirm: params[:skip_confirm]
+          )
+        end
+
+        UI.success('Done')
+      end
+
+      # Check the status of the translations and returns the list of violations
+      #
+      # @param [String] URL to the GlotPress project.
+      # @param [String] The list of codes (in GlotPress format) of the languages to check.
+      # @param [Bool] Whether to abort on the first found violation or not.
+      # @param [Integer] The minimum acceptable percentage of translated strings.
+      #
+      # @return [Array] The list of violations (array of hashes of "language code" and "current percentage")
+      #
+      def self.check_translations(glotpress_url:, language_codes:, abort_on_violations:, threshold:)
+        under_threshold_langs = []
+
+        data = begin
+          Fastlane::Helper::GlotPressHelper.get_translation_status_data(glotpress_url: glotpress_url)
+        rescue StandardError
+          nil
+        end
+        UI.abort_with_message!("Can't retrieve data from #{glotpress_url}") if data.nil? || data.empty?
+
+        language_codes.each do |language_code|
+          UI.message("> Getting translation status for #{language_code}")
+          progress = begin
+            Fastlane::Helper::GlotPressHelper.get_translation_status(
+              data: data,
+              language_code: language_code
+            )
+          rescue StandardError
+            -1
+          end
+
+          if abort_on_violations
+            UI.abort_with_message!("Can't get data for language #{language_code}") if progress == -1
+            UI.abort_with_message!("#{language_code} is translated #{progress}% which is under the required #{threshold}%.") if progress < threshold
+          end
+
+          UI.message("Language #{language_code} is #{progress}% translated.")
+          under_threshold_langs.push({ lang: language_code, progress: progress }) if progress < threshold
+        end
+
+        under_threshold_langs
+      end
+
+      # Report the status of the translations and verify whether to abort or not
+      #
+      # @param [Array] The list of violations (array of hashes of "language code" and "current percentage")
+      # @param [Integer] The minimum acceptable percentage of translated strings.
+      # @param [Bool] If true, continue after the report without asking the user.
+      #
+      def self.check_results(under_threshold_langs:, threshold:, skip_confirm:)
+        message = "The translations for the following languages are below the #{threshold}% threshold:\n"
+
+        under_threshold_langs.each do |lang|
+          message << " - #{lang[:lang]} is at #{lang[:progress]}%.\n"
+        end
+
+        if skip_confirm
+          UI.important(message)
+        elsif UI.interactive?
+          UI.abort_with_message!('Aborted by user!') unless UI.confirm("#{message}Do you want to continue?")
+        else
+          UI.abort_with_message!(message)
+        end
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        'Raises an error if the translation percentage is lower than the provided threshold'
+      end
+
+      def self.details
+        'This actions checks the current status of the translations on GlotPress ' \
+        'and raises an error if it\'s below the provided threshold'
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :glotpress_url,
+                                       env_name: 'FL_CHECK_TRANSLATION_PROGRESS_GLOTPRESS_URL',
+                                       description: 'URL to the GlotPress project',
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :language_codes,
+                                       env_name: 'FL_CHECK_TRANSLATION_PROGRESS_LANGUAGE_CODES',
+                                       description: 'The list of the codes of the languages to check',
+                                       type: Array,
+                                       optional: true,
+                                       # Default to Mag16.
+                                       default_value: 'ar de es fr he id it ja ko nl pt-br ru sv tr zh-cn zh-tw'.split()),
+          FastlaneCore::ConfigItem.new(key: :min_acceptable_translation_percentage,
+                                       env_name: 'FL_CHECK_TRANSLATION_PROGRESS_MIN_ACCEPTABLE_TRANSLATION_PERCENTAGE',
+                                       description: 'The threshold under which an error is raised',
+                                       type: Integer,
+                                       optional: true,
+                                       default_value: 100),
+          FastlaneCore::ConfigItem.new(key: :abort_on_violations,
+                                       env_name: 'FL_CHECK_TRANSLATION_ABORT_ON_VIOLATIONS',
+                                       description: 'Should we abort with a global error if any violations are found?',
+                                       optional: true,
+                                       default_value: true,
+                                       is_string: false),
+          FastlaneCore::ConfigItem.new(key: :skip_confirm,
+                                       env_name: 'FL_CHECK_TRANSLATION_SKIP_CONFIRM',
+                                       description: 'Move ahead without requesting confirmation if violations are found. Only works if "abort_on_violations" is disabled',
+                                       optional: true,
+                                       default_value: false,
+                                       is_string: false),
+        ]
+      end
+
+      def self.authors
+        ['loremattei']
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/wpmreleasetoolkit/actions/common/circleci_trigger_job_action.rb

@@ -2,7 +2,7 @@ module Fastlane
   module Actions
     class CircleciTriggerJobAction < Action
       def self.run(params)
-        require_relative '../../helper/ci_helper.rb'
+        require_relative '../../helper/ci_helper'
 
         UI.message "Triggering job #{params[:job_params]} on branch #{params[:branch]}"
 

data/lib/fastlane/plugin/wpmreleasetoolkit/actions/common/gp_downloadmetadata_action.rb

@@ -1,5 +1,5 @@
 require 'fastlane/action'
-require_relative '../../helper/metadata_download_helper.rb'
+require_relative '../../helper/metadata_download_helper'
 
 module Fastlane
   module Actions

data/lib/fastlane/plugin/wpmreleasetoolkit/actions/common/gp_update_metadata_source.rb

@@ -1,5 +1,5 @@
 require 'fastlane/action'
-require_relative '../../helper/metadata_update_helper.rb'
+require_relative '../../helper/metadata_update_helper'
 
 module Fastlane
   module Actions
@@ -23,7 +23,7 @@ module Fastlane
       # Verifies that all the source files are available
       # to this action
       def self.check_source_files(source_files)
-        source_files.values.each do |file_path|
+        source_files.each_value do |file_path|
           UI.user_error!("Couldn't find file at path '#{file_path}'") unless File.exist?(file_path)
         end
       end
@@ -75,9 +75,10 @@ module Fastlane
 
         # Init special handlers
         block_files.each do |key, file_path|
-          if key == :release_note
+          case key
+          when :release_note
             @blocks.push Fastlane::Helper::ReleaseNoteMetadataBlock.new(key, file_path, release_version)
-          elsif key == :whats_new
+          when :whats_new
             @blocks.push Fastlane::Helper::WhatsNewMetadataBlock.new(key, file_path, release_version)
           else
             @blocks.push Fastlane::Helper::StandardMetadataBlock.new(key, file_path)
@@ -91,7 +92,7 @@ module Fastlane
       # Manages tags depending on the type
       def self.write_target_block(fw, line)
         if is_block_id(line)
-          key = line.split(' ')[1].tr('\"', '')
+          key = line.split[1].tr('\"', '')
           @blocks.each do |block|
             @current_block = block if block.is_handler_for(key)
           end

data/lib/fastlane/plugin/wpmreleasetoolkit/actions/common/promo_screenshots_action.rb

@@ -1,7 +1,7 @@
 require 'fileutils'
 require 'fastlane/action'
 require 'active_support/all'
-require_relative '../../helper/promo_screenshots_helper.rb'
+require_relative '../../helper/promo_screenshots_helper'
 
 module Fastlane
   module Actions
@@ -43,7 +43,7 @@ module Fastlane
 
         # Create a hash of devices, keyed by device name
         devices = config['devices']
-        devices = Hash[devices.map { |device| device['name'] }.zip(devices)]
+        devices = devices.map { |device| device['name'] }.zip(devices).to_h
 
         stylesheet_path = config['stylesheet']
 

data/lib/fastlane/plugin/wpmreleasetoolkit/actions/common/removebranchprotection_action.rb

@@ -9,10 +9,10 @@ module Fastlane
         branch_name = params[:branch]
         branch_prot = {}
 
-        branch_url = "https://api.github.com/repos/#{repository}/branches/" + branch_name
-        branch_prot[:restrictions] = { url: branch_url + '/protection/restrictions', users_url: branch_url + '/protection/restrictions/users', teams_url: branch_url + '/protection/restrictions/teams', users: [], teams: [] }
+        branch_url = "https://api.github.com/repos/#{repository}/branches/#{branch_name}"
+        branch_prot[:restrictions] = { url: "#{branch_url}/protection/restrictions", users_url: "#{branch_url}/protection/restrictions/users", teams_url: "#{branch_url}/protection/restrictions/teams", users: [], teams: [] }
         branch_prot[:enforce_admins] = nil
-        branch_prot[:required_pull_request_reviews] = { url: branch_url + '/protection/required_pull_request_reviews', dismiss_stale_reviews: false, require_code_owner_reviews: false }
+        branch_prot[:required_pull_request_reviews] = { url: "#{branch_url}/protection/required_pull_request_reviews", dismiss_stale_reviews: false, require_code_owner_reviews: false }
 
         Fastlane::Helper::GithubHelper.github_client().unprotect_branch(repository, branch_name, branch_prot)
       end

data/lib/fastlane/plugin/wpmreleasetoolkit/actions/common/setbranchprotection_action.rb

@@ -9,10 +9,10 @@ module Fastlane
         branch_name = params[:branch]
         branch_prot = {}
 
-        branch_url = "https://api.github.com/repos/#{repository}/branches/" + branch_name
-        branch_prot[:restrictions] = { url: branch_url + '/protection/restrictions', users_url: branch_url + '/protection/restrictions/users', teams_url: branch_url + '/protection/restrictions/teams', users: [], teams: [] }
+        branch_url = "https://api.github.com/repos/#{repository}/branches/#{branch_name}"
+        branch_prot[:restrictions] = { url: "#{branch_url}/protection/restrictions", users_url: "#{branch_url}/protection/restrictions/users", teams_url: "#{branch_url}/protection/restrictions/teams", users: [], teams: [] }
         branch_prot[:enforce_admins] = nil
-        branch_prot[:required_pull_request_reviews] = { url: branch_url + '/protection/required_pull_request_reviews', dismiss_stale_reviews: false, require_code_owner_reviews: false }
+        branch_prot[:required_pull_request_reviews] = { url: "#{branch_url}/protection/required_pull_request_reviews", dismiss_stale_reviews: false, require_code_owner_reviews: false }
         Fastlane::Helper::GithubHelper.github_client().protect_branch(repository, branch_name, branch_prot)
       end
 

data/lib/fastlane/plugin/wpmreleasetoolkit/actions/common/setfrozentag_action.rb

@@ -21,7 +21,7 @@ module Fastlane
             return # Already frozen: nothing to do
           end
 
-          mile_title = mile_title + ' ❄️'
+          mile_title = "#{mile_title} ❄️"
         else
           mile_title = milestone_title
         end

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

@@ -5,8 +5,8 @@ module Fastlane
         UI.message "Skip confirm: #{params[:skip_confirm]}"
         UI.message "Work on version: #{params[:base_version]}" unless params[:base_version].nil?
 
-        require_relative '../../helper/ios/ios_version_helper.rb'
-        require_relative '../../helper/ios/ios_git_helper.rb'
+        require_relative '../../helper/ios/ios_version_helper'
+        require_relative '../../helper/ios/ios_git_helper'
 
         # Checkout develop and update
         Fastlane::Helper::GitHelper.checkout_and_pull('develop')
@@ -25,10 +25,10 @@ module Fastlane
 
         # Verify
         message << "Updating branch to version: #{next_version}.\n"
-        if !params[:skip_confirm]
-          UI.user_error!('Aborted by user request') unless UI.confirm("#{message}Do you want to continue?")
-        else
+        if params[:skip_confirm]
           UI.message(message)
+        else
+          UI.user_error!('Aborted by user request') unless UI.confirm("#{message}Do you want to continue?")
         end
 
         # Check local repo status