Merge pull request #517 from wordpress-mobile/update/ruby3

Ruby 3 Upgrade

Author: iangmaia

.buildkite/pipeline.yml

@@ -8,13 +8,13 @@ common_params:
     - &ci_toolkit
       automattic/a8c-ci-toolkit#2.18.2: ~
     - &docker_plugin
-      docker#v3.8.0:
-        image: &ruby_version "ruby:2.7.4"
+      docker#v5.8.0:
+        image: &ruby_version "public.ecr.aws/docker/library/ruby:3.2.2"
         propagate-environment: true
         environment:
           - "RUBYGEMS_API_KEY"
     - &docker_plugin_with_danger_token
-      docker#v3.8.0:
+      docker#v5.8.0:
         image: *ruby_version
         propagate-environment: true
         environment:
@@ -53,7 +53,6 @@ steps:
         matrix:
           setup:
             ruby:
-              - 2.7.4
               - 3.2.2
 
   #################

.rubocop.yml

@@ -6,7 +6,6 @@ require:
 # Enable new cops when we update rubocop to a newer version
 AllCops:
   NewCops: enable
-  TargetRubyVersion: 2.7
 
 ########## Lint / CodeStyle
 
@@ -56,7 +55,12 @@ Style/StringConcatenation:
 # for more discussion
 Style/FetchEnvVar:
   Enabled: false
-  
+
+# Rule enforced after migrating to Ruby 3, to prevent the new syntax which allows for hash values and keyword arguments
+# omission, such as `myMethod(x:, y:)` and `h = { a:, b: }`.
+Style/HashSyntax:
+  EnforcedShorthandSyntax: never
+
 ########## Gemspec Rules
 
 # This was turned on by default after updating Rubocop to `1.50.2`. We want to disable this for now because
@@ -107,3 +111,6 @@ RSpec/ExampleLength:
 # Same for number of let/subject
 RSpec/MultipleMemoizedHelpers:
   Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false

.rubocop_todo.yml

@@ -1,45 +1,48 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2023-06-14 05:10:53 UTC using RuboCop version 1.50.2.
+# on 2023-09-21 15:44:18 UTC using RuboCop version 1.56.3.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
+# Offense count: 11
+# Configuration parameters: EnforcedStyle, AllowedGems, Include.
+# SupportedStyles: Gemfile, gems.rb, gemspec
+# Include: **/*.gemspec, **/Gemfile, **/gems.rb
+Gemspec/DevelopmentDependencies:
+  Exclude:
+    - 'fastlane-plugin-wpmreleasetoolkit.gemspec'
+
+# Offense count: 1
+# Configuration parameters: Severity, Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'fastlane-plugin-wpmreleasetoolkit.gemspec'
+
 # Offense count: 3
 Lint/NonLocalExitFromIterator:
   Exclude:
     - 'lib/fastlane/plugin/wpmreleasetoolkit/actions/common/extract_release_notes_for_version_action.rb'
     - 'lib/fastlane/plugin/wpmreleasetoolkit/helper/android/android_localize_helper.rb'
 
-# Offense count: 5
-Lint/UselessAssignment:
-  Exclude:
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/actions/android/an_validate_lib_strings_action.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/helper/android/android_localize_helper.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/helper/ios/ios_version_helper.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/helper/promo_screenshots_helper.rb'
-
-# Offense count: 8
+# Offense count: 7
 Naming/AccessorMethodName:
   Exclude:
     - 'lib/fastlane/plugin/wpmreleasetoolkit/actions/configure/configure_update_action.rb'
     - 'lib/fastlane/plugin/wpmreleasetoolkit/helper/android/android_version_helper.rb'
     - 'lib/fastlane/plugin/wpmreleasetoolkit/helper/ios/ios_version_helper.rb'
 
-# Offense count: 19
+# Offense count: 2
 # Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
 # AllowedNames: as, at, by, cc, db, id, if, in, io, ip, of, on, os, pp, to
 Naming/MethodParameterName:
   Exclude:
     - 'lib/fastlane/plugin/wpmreleasetoolkit/actions/android/an_update_metadata_source_action.rb'
     - 'lib/fastlane/plugin/wpmreleasetoolkit/actions/common/gp_update_metadata_source.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/helper/an_metadata_update_helper.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/helper/ios/ios_version_helper.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/helper/metadata_update_helper.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/helper/promo_screenshots_helper.rb'
 
-# Offense count: 111
+# Offense count: 108
 # Configuration parameters: NamePrefix, ForbiddenPrefixes, AllowedMethods, MethodDefinitionMacros.
 # NamePrefix: is_, has_, have_
 # ForbiddenPrefixes: is_, has_, have_
@@ -65,41 +68,25 @@ RSpec/ContextWording:
     - 'spec/git_helper_spec.rb'
     - 'spec/ios_lint_localizations_spec.rb'
 
-# Offense count: 39
+# Offense count: 45
 # Configuration parameters: Include, CustomTransform, IgnoreMethods, SpecSuffixOnly.
 # Include: **/*_spec*rb*, **/spec/**/*
 RSpec/FilePath:
   Enabled: false
 
-# Offense count: 8
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: implicit, each, example
-RSpec/HookArgument:
-  Exclude:
-    - 'spec/configuration_spec.rb'
-    - 'spec/encryption_helper_spec.rb'
-    - 'spec/file_reference_spec.rb'
-    - 'spec/git_helper_spec.rb'
-    - 'spec/ios_lint_localizations_spec.rb'
-
 # Offense count: 25
 # Configuration parameters: AssignmentOnly.
 RSpec/InstanceVariable:
   Exclude:
     - 'spec/git_helper_spec.rb'
     - 'spec/ios_lint_localizations_spec.rb'
 
-# Offense count: 89
+# Offense count: 109
 # Configuration parameters: .
 # SupportedStyles: have_received, receive
 RSpec/MessageSpies:
   EnforcedStyle: receive
 
-# Offense count: 88
-RSpec/MultipleExpectations:
-  Max: 7
-
 # Offense count: 48
 # Configuration parameters: IgnoreSharedExamples.
 RSpec/NamedSubject:
@@ -109,7 +96,7 @@ RSpec/NamedSubject:
     - 'spec/configuration_spec.rb'
     - 'spec/file_reference_spec.rb'
 
-# Offense count: 8
+# Offense count: 10
 RSpec/NestedGroups:
   Max: 5
 
@@ -137,7 +124,7 @@ Security/Open:
     - 'lib/fastlane/plugin/wpmreleasetoolkit/actions/android/an_validate_lib_strings_action.rb'
     - 'lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_create_xml_release_notes.rb'
 
-# Offense count: 126
+# Offense count: 123
 # Configuration parameters: AllowedConstants.
 Style/Documentation:
   Enabled: false
@@ -148,18 +135,6 @@ Style/GlobalVars:
   Exclude:
     - 'lib/fastlane/plugin/wpmreleasetoolkit/helper/promo_screenshots_helper.rb'
 
-# Offense count: 10
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: MinBodyLength, AllowConsecutiveConditionals.
-Style/GuardClause:
-  Exclude:
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/actions/common/extract_release_notes_for_version_action.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/actions/configure/configure_update_action.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/actions/configure/configure_validate_action.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/ios_update_metadata_source.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/helper/android/android_localize_helper.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/helper/configure_helper.rb'
-
 # Offense count: 1
 Style/MixinUsage:
   Exclude:
@@ -171,116 +146,3 @@ Style/MultilineBlockChain:
     - 'lib/fastlane/plugin/wpmreleasetoolkit/actions/common/promo_screenshots_action.rb'
     - 'lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/add_development_certificates_to_provisioning_profiles.rb'
     - 'lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/add_devices_to_provisioning_profiles.rb'
-
-# Offense count: 23
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: EnforcedStyle, AllowedMethods, AllowedPatterns.
-# SupportedStyles: predicate, comparison
-Style/NumericPredicate:
-  Exclude:
-    - 'spec/**/*'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/add_development_certificates_to_provisioning_profiles.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/add_devices_to_provisioning_profiles.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/ios_check_beta_deps.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/helper/an_metadata_update_helper.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/helper/android/android_version_helper.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/helper/configure_helper.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/helper/git_helper.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/helper/ios/ios_adc_app_sizes_helper.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/helper/ios/ios_version_helper.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/helper/metadata_download_helper.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/helper/metadata_update_helper.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-Style/RedundantBegin:
-  Exclude:
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/helper/promo_screenshots_helper.rb'
-
-# Offense count: 54
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowMultipleReturnValues.
-Style/RedundantReturn:
-  Enabled: false
-
-# Offense count: 37
-# This cop supports safe autocorrection (--autocorrect).
-Style/RedundantSelf:
-  Exclude:
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/actions/android/an_update_metadata_source_action.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/actions/common/gp_update_metadata_source.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/actions/common/promo_screenshots_action.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/ios_lint_localizations.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/helper/android/android_version_helper.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/helper/configure_helper.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/models/configuration.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/models/file_reference.rb'
-
-# Offense count: 6
-# This cop supports safe autocorrection (--autocorrect).
-Style/RescueModifier:
-  Exclude:
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/helper/an_metadata_update_helper.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/helper/android/android_version_helper.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/helper/ios/ios_adc_app_sizes_helper.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/helper/ios/ios_version_helper.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/helper/metadata_download_helper.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/helper/metadata_update_helper.rb'
-
-# Offense count: 11
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: implicit, explicit
-Style/RescueStandardError:
-  Exclude:
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/actions/android/an_update_metadata_source_action.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/actions/android/android_build_preflight.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/actions/common/gp_update_metadata_source.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/actions/ios/ios_build_preflight.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/helper/git_helper.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/helper/ios/ios_l10n_linter_helper.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/helper/promo_screenshots_helper.rb'
-
-# Offense count: 2
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: ConvertCodeThatCanStartToReturnNil, AllowedMethods, MaxChainLength.
-# AllowedMethods: present?, blank?, presence, try, try!
-Style/SafeNavigation:
-  Exclude:
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/helper/android/android_localize_helper.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: only_raise, only_fail, semantic
-Style/SignalException:
-  Exclude:
-    - 'Dangerfile'
-
-# Offense count: 1
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: RequireEnglish, EnforcedStyle.
-# SupportedStyles: use_perl_names, use_english_names, use_builtin_english_names
-Style/SpecialGlobalVars:
-  Exclude:
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/helper/configure_helper.rb'
-
-# Offense count: 28
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: .
-# SupportedStyles: percent, brackets
-Style/SymbolArray:
-  EnforcedStyle: percent
-  MinSize: 3
-
-# Offense count: 7
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: AllowMethodsWithArguments, AllowedMethods, AllowedPatterns, AllowComments.
-# AllowedMethods: define_method
-Style/SymbolProc:
-  Exclude:
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/actions/configure/configure_add_files_to_copy_action.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/actions/configure/configure_update_action.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/helper/configure_helper.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/helper/ios/ios_version_helper.rb'
-    - 'lib/fastlane/plugin/wpmreleasetoolkit/models/configuration.rb'

.ruby-version

@@ -1 +1 @@
-2.7.4
+3.2.2

CHANGELOG.md

@@ -6,7 +6,7 @@
 
 ### Breaking Changes
 
-_None_
+- Upgraded the minimum required Ruby version to `3.2.2`. [#517]
 
 ### New Features
 

Dangerfile

@@ -20,7 +20,7 @@ The version in the `Gemfile.lock` (`#{gemfile_lock_version}`) doesn't match the
 
 Please run `bundle install` to make sure they match.
 }
-  fail(message)
+  failure(message)
 end
 
 # Check that the PR contains changes to the CHANGELOG.md file.

MIGRATION.md

@@ -1,5 +1,9 @@
 # Migration Instructions for Major Releases
 
+## From `10.0.0` to `11.0.0`
+
+ - The new minimum required Ruby version is `3.2.2`. Please make sure to upgrade your projects before upgrading to this version to avoid compatibility issues.
+
 ## From `9.0.0` to `10.0.0`
 
  - Action `addbranchprotection` has been renamed `set_branch_protection`. Besides, you might want to use the new `copy_branch_protection(from_branch: to_branch:)` instead (especially for protecting the `release/*` branch after code-freeze).

fastlane-plugin-wpmreleasetoolkit.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/wordpress-mobile/release-toolkit'
   spec.license       = 'MIT'
 
-  spec.required_ruby_version = '>= 2.7'
+  spec.required_ruby_version = '>= 3.2.2'
 
   spec.files = Dir['lib/**/*'] + %w[README.md LICENSE]
 

lib/fastlane/plugin/wpmreleasetoolkit/actions/android/an_localize_libs_action.rb

@@ -56,7 +56,7 @@ def self.available_options
       end
 
       def self.is_supported?(platform)
-        return platform == :android
+        platform == :android
       end
     end
   end

lib/fastlane/plugin/wpmreleasetoolkit/actions/android/an_update_metadata_source_action.rb

@@ -36,7 +36,7 @@ def self.check_source_files(source_files)
       # .po fo the others.
       def self.create_temp_po(params)
         orig = params[:po_file_path]
-        target = self.create_target_file_path(orig)
+        target = create_target_file_path(orig)
 
         # Clear if older exists
         FileUtils.rm_f(target)
@@ -48,7 +48,7 @@ def self.create_temp_po(params)
               write_target_block(fw, fr)
             end
           end
-        rescue
+        rescue StandardError
           FileUtils.rm_f(target)
           raise
         end