Improve RuboCop setup and address some violations (#7472)

Author: mokagio

.rubocop.yml

@@ -1,3 +1,10 @@
+AllCops:
+  Exclude:
+    - DerivedData/**/*
+    - Pods/**/*
+    - vendor/**/*
+  NewCops: enable
+
 Metrics/BlockLength:
   Exclude:
     - fastlane/Fastfile
@@ -12,6 +19,7 @@ Style/AsciiComments:
 Layout/LineLength:
   Exclude:
     - fastlane/Fastfile
+    - Podfile
 
 Naming/FileName:
   Exclude:

Podfile

@@ -327,6 +327,7 @@ post_install do |installer|
 
   # Flag Alpha builds for Tracks
   # ============================
+  # rubocop:disable Style/CombinableLoops
   installer.pods_project.targets.each do |target|
     next unless target.name == 'Automattic-Tracks-iOS'
 
@@ -336,4 +337,5 @@ post_install do |installer|
       config.build_settings['GCC_PREPROCESSOR_DEFINITIONS'] ||= ['$(inherited)', 'ALPHA=1']
     end
   end
+  # rubocop:enable Style/CombinableLoops
 end

fastlane/Deliverfile

@@ -15,7 +15,7 @@ app_identifier 'com.automattic.woocommerce'
 screenshots_path './fastlane/promo_screenshots/'
 
 # Make sure to update these keys for a new version
-app_version "10.1"
+app_version '10.1'
 
 team_id '299112'
 

fastlane/Fastfile

@@ -10,6 +10,8 @@ USER_ENV_FILE_PATH = File.join(Dir.home, '.wcios-env.default')
 SECRETS_DIR = File.join(Dir.home, '.configure', 'woocommerce-ios', 'secrets')
 PROJECT_ENV_FILE_PATH = File.join(SECRETS_DIR, 'project.env')
 
+GHHELPER_REPO = 'woocommerce/woocommerce-ios'
+
 # Constants
 PROJECT_ROOT_FOLDER = File.dirname(File.expand_path(__dir__))
 RESOURCES_FOLDER = File.join(PROJECT_ROOT_FOLDER, 'WooCommerce', 'Resources')
@@ -89,7 +91,7 @@ GLOTPRESS_TO_ASC_METADATA_LOCALE_CODES = {
   'sv' => 'sv',
   'tr' => 'tr',
   'zh-cn' => 'zh-Hans',
-  'zh-tw' => 'zh-Hant',
+  'zh-tw' => 'zh-Hant'
 }.freeze
 
 ASC_KEY_PATH = File.join(SECRETS_DIR, 'app_store_connect_fastlane_api_key.json')
@@ -100,7 +102,7 @@ def get_required_env(key)
   unless ENV.key?(key)
     UI.user_error!("Environment variable '#{key}' is not set. Have you setup #{USER_ENV_FILE_PATH} correctly?")
   end
-  ENV[key]
+  ENV.fetch(key)
 end
 
 before_all do |lane|
@@ -127,17 +129,12 @@ platform :ios do
   ########################################################################
   Dotenv.load(USER_ENV_FILE_PATH)
   Dotenv.load(PROJECT_ENV_FILE_PATH)
-  ENV[GHHELPER_REPO = 'woocommerce/woocommerce-iOS']
   ENV['PROJECT_NAME'] = 'WooCommerce'
   ENV['PUBLIC_CONFIG_FILE'] = 'config/Version.Public.xcconfig'
   ENV['PROJECT_ROOT_FOLDER'] = './'
   ENV['APP_STORE_STRINGS_FILE_NAME'] = 'AppStoreStrings.pot'
   ENV['FL_RELEASE_TOOLKIT_DEFAULT_BRANCH'] = 'trunk'
 
-  # Other defines used across multiple lanes
-  REPOSITORY_NAME = 'woocommerce-ios'
-  GH_ORG_NAME = 'woocommerce'
-
   ########################################################################
   # Release Lanes
   ########################################################################
@@ -334,7 +331,7 @@ platform :ios do
     version = ios_get_app_version
     removebranchprotection(repository: GHHELPER_REPO, branch: "release/#{version}")
     setfrozentag(repository: GHHELPER_REPO, milestone: version, freeze: false)
-    create_new_milestone(repository:GHHELPER_REPO, need_appstore_submission: true, milestone_duration:7, number_of_days_from_code_freeze_to_release: 10)
+    create_new_milestone(repository: GHHELPER_REPO, need_appstore_submission: true, milestone_duration: 7, number_of_days_from_code_freeze_to_release: 10)
     close_milestone(repository: GHHELPER_REPO, milestone: version)
 
     # Start the build
@@ -502,7 +499,7 @@ platform :ios do
       export_method: 'enterprise',
       clean: true,
       output_directory: 'build',
-      export_team_id: ENV['INT_EXPORT_TEAM_ID'],
+      export_team_id: ENV.fetch('INT_EXPORT_TEAM_ID'),
       export_options: { method: 'enterprise', iCloudContainerEnvironment: 'Production' }
     )
 
@@ -540,7 +537,7 @@ platform :ios do
 
     comment_on_pr(
       project: 'woocommerce/woocommerce-ios',
-      pr_number: Integer(ENV['BUILDKITE_PULL_REQUEST']),
+      pr_number: Integer(ENV.fetch('BUILDKITE_PULL_REQUEST')),
       reuse_identifier: 'installable-build-link',
       body: comment_body
     )
@@ -727,7 +724,7 @@ platform :ios do
       runtime = SimCtl.runtime(name: "iOS #{SIMULATOR_VERSION}")
       devicetype = SimCtl.devicetype(name: device)
 
-      device = SimCtl.create_device device, devicetype, runtime
+      SimCtl.create_device(device, devicetype, runtime)
     end
   end
 
@@ -793,11 +790,11 @@ platform :ios do
     # FIXME: Replace this with a call to the future replacement of `gp_downloadmetadata` once it's implemented in the release-toolkit (see paaHJt-31O-p2).
     locales_map = GLOTPRESS_TO_ASC_METADATA_LOCALE_CODES
     target_files = {
-      "v#{ios_get_app_version}-whats-new": { desc: "release_notes.txt", max_size: 4000 },
-      app_store_name: { desc: "name.txt", max_size: 30 },
-      app_store_subtitle: { desc: "subtitle.txt", max_size: 30 },
-      app_store_desc: { desc: "description.txt", max_size: 4000 },
-      app_store_keywords: { desc: "keywords.txt", max_size: 100 },
+      "v#{ios_get_app_version}-whats-new": { desc: 'release_notes.txt', max_size: 4000 },
+      app_store_name: { desc: 'name.txt', max_size: 30 },
+      app_store_subtitle: { desc: 'subtitle.txt', max_size: 30 },
+      app_store_desc: { desc: 'description.txt', max_size: 4000 },
+      app_store_keywords: { desc: 'keywords.txt', max_size: 100 }
     }
 
     gp_downloadmetadata(
@@ -811,14 +808,17 @@ platform :ios do
     # Ensure that none of the `.txt` files in `en-US` would accidentally override our originals in `default`
     target_files.values.map { |h| h[:desc] }.each do |file|
       en_file_path = File.join(metadata_directory, 'en-US', file)
-      UI.user_error!("File `#{en_file_path}` would override the same one in `#{metadata_directory}/default`, but `default/` is the source of truth. " \
-                     + "Delete the `#{en_file_path}` file, ensure the `default/` one has the expected original copy, and try again.") if File.exist?(en_file_path)
+      if File.exist?(en_file_path)
+        UI.user_error!("File `#{en_file_path}` would override the same one in `#{metadata_directory}/default`, but `default/` is the source of truth. " \
+                       + "Delete the `#{en_file_path}` file, ensure the `default/` one has the expected original copy, and try again.")
+      end
     end
 
     # Ensure even empty locale folders have an empty `.gitkeep` file (in case we don't have any translation at all ready for some locales)
-    locales_map.values.each do |locale|
+    locales_map.each_value do |locale|
       gitkeep = File.join(metadata_directory, locale, '.gitkeep')
       next if File.exist?(gitkeep)
+
       FileUtils.mkdir_p(File.dirname(gitkeep))
       FileUtils.touch(gitkeep)
       files_to_commit.append(gitkeep)
@@ -966,11 +966,11 @@ platform :ios do
         'Pods/WordPress*/',
         'Storage/Storage/',
         'Networking/Networking/',
-        'Hardware/Hardware/',
+        'Hardware/Hardware/'
       ],
       exclude: [
         '*Vendor*',
-        'WooCommerce/WooCommerceTests/**', # Some unit tests include localized strings, but we don't want to crowd GlotPress with them
+        'WooCommerce/WooCommerceTests/**' # Some unit tests include localized strings, but we don't want to crowd GlotPress with them
       ],
       output_dir: en_lproj_path
     )
@@ -1081,10 +1081,10 @@ end
 # Generates Installable Build Version Numbers in a Buildkite-specific way
 # -----------------------------------------------------------------------------------
 def generate_installable_build_number
-  if ENV['BUILDKITE']
-    commit = ENV['BUILDKITE_COMMIT'][0, 7]
-    branch = ENV['BUILDKITE_BRANCH']
-    pr_num = ENV['BUILDKITE_PULL_REQUEST']
+  if ENV.key?('BUILDKITE')
+    commit = ENV.fetch('BUILDKITE_COMMIT')[0, 7]
+    branch = ENV.fetch('BUILDKITE_BRANCH')
+    pr_num = ENV.fetch('BUILDKITE_PULL_REQUEST')
 
     pr_num == 'false' ? "#{branch}-#{commit}" : "pr#{pr_num}-#{commit}"
   else