[Ruby 3.0] Bump rubocop version #18564

ainame · 2021-04-16T14:30:29Z

This PR has about 600 LoC changes in automatically generated files (.rubocop_todo.yml and Gemfile.lock) so the actual changes are small. Don't be scared😇

Checklist

I've run bundle exec rspec from the root directory to see all new and existing tests pass
I've followed the fastlane code style and run bundle exec rubocop -a to ensure the code style is valid
I've read the Contribution Guidelines
I've updated the documentation if necessary.

Motivation and Context

Prior to this PR, as per #17931, I've been working on Ruby 3.0 support tasks. This PR bumps the long-standing very old rubocop version (0.49.1) to the latest (1.12.1) and hopefully enables us to keep it up-to-date. rubocop is the most popular linter tool in Ruby and essential for fastlane to maintain the codebase consistent. However, the version we fix doesn't support Ruby 3.0 due to the version requirement spec in Rubocop. This gem https://github.com/whitequark/parser to parse Ruby code, whose rubocop depends on, don't support Ruby 3.0 until 3.0.0.0. Meaning we won't be able to run the linter against Ruby 3.0 when it gets supported in fastlane until bumping the rubocop version💥 This is how gemspec in rubocop v0.49.1 looks like 😇
https://github.com/rubocop/rubocop/blob/1c2245df09cf0a1659b83acf0abb473e9b927a1a/rubocop.gemspec#L29

That's why this PR is here🙂

Description

The thing is that we need to catch up with many changes in rubocop. rubocop is adding new rules(cops) and improving existing ones continuously so that we can see a lot of warnings when running the latest version against fastlane. I'm going to introduce .rubocop_todo.yml to address that problem.

.rubocop_todo.yml is an automatically generated file that is meant to disable overwhelming rubocop's warnings for existing project for now in order to fix them gradually. This way we don't really need to fix such issues pointed by rubocop in this bumping PR and we can improve them later in future PRs.

https://docs.rubocop.org/rubocop/configuration.html#automatically-generated-configuration

Besides that what I did in this PR are -

Fixed .rubocop.yml to be able to run the latest rubocop (there are some cops that aren't supported any more)
Migrated some cops's department (namespace) as those are renamed to the different department; i.e. Style/VariableName -> Naming/VariableName
Added rubocop-performance to gemspec as it spun off from rubocop gem
Fixed custom cops implemented in fastlane to catch up on the latest API in rubocop
Fixed some issues pointed that are missed by rubocop even though we enabled the rules 6a0598f
Fixed how the plugin's .rubocop.yml is generated to make it work
Update one line of code to stop rubocop's crash 14ea64a

I will add more information about changes with inline comments.

Next, I will submit another PR that applies auto-correction to fastlane in one go based on the latest rubocop so that we can fix many issues in TODO quickly. And then anyone will be able to contribute by picking issues in .rubocop_todo.yml.

Note that rubocop 1.13.0 was released on 20th April but it dropped Ruby 2.4 support so we can't upgrade to it for now but once we support Ruby 3.0 we can keep rubocop up-to-date again🙂

Testing Steps

See if CI passes linter checks

ainame · 2021-04-21T06:37:02Z

.rubocop.yml

  - ./rubocop/fork_usage.rb
  - ./rubocop/missing_keys_on_shared_area.rb
  - ./rubocop/is_string_usage.rb

+AllCops:


This is moved to the top to make it prominent.

ainame · 2021-04-21T06:38:38Z

.rubocop.yml

+  Include:
+    - '**/*.rb'
+    - '**/*file'
+    - '**/*.gemspec'
+    - '*/lib/assets/*Template'
+    - '*/lib/assets/*TemplateAndroid'


This is now required to declare what is included explicitly.

ainame · 2021-04-21T06:54:59Z

.rubocop_todo.yml

+# This configuration was generated by
+# `rubocop --auto-gen-config --exclude-limit 0`
+# on 2021-04-21 06:50:09 UTC using RuboCop version 1.12.1.
+# 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.


This file is generated automatically. So no need to review unless you are interested in seeing what rules are added😄

ainame · 2021-04-21T06:58:21Z

.rubocop.yml

-Metrics/PerceivedComplexity:
-  Max: 18


It seems that logic was changed and some files don't meet this threshold any more. So I removed it here and rubocop put "Max: 26" in the TODO file.

ainame · 2021-04-21T07:03:45Z

fastlane/lib/fastlane/plugins/template/%gem_name%.gemspec.erb

-# coding: utf-8
-
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)


Changes in this file and templates are pointed by rubocop. Unlike others, this is needed to be fixed now otherwise issues will be passed to plugins newly generated😇

This will need an update of all plugins?

No. This doesn't affect existing plugins/gems. This is just style fix. If plugin authors think they want to follow it, they can just do it by themselves.

ainame · 2021-04-21T07:05:14Z

fastlane_core/lib/fastlane_core/languages.rb

@@ -3,14 +3,14 @@ module Languages
    # These are all the languages which are available to use to upload app metadata and screenshots

    # The old format which was used until August 2015 (good old times)
-    ALL_LANGUAGES_LEGACY = ["da-DK", "de-DE", "el-GR", "en-AU", "en-CA", "en-GB", "en-US", "es-ES", "es-MX", "fi-FI", "fr-CA", "fr-FR", "id-ID", "it-IT", "ja-JP", "ko-KR", "ms-MY", "nl-NL", "no-NO", "pt-BR", "pt-PT", "ru-RU", "sv-SE", "th-TH", "tr-TR", "vi-VI", "cmn-Hans", "cmn-Hant"]
+    ALL_LANGUAGES_LEGACY = %w[da-DK de-DE el-GR en-AU en-CA en-GB en-US es-ES es-MX fi-FI fr-CA fr-FR id-ID it-IT ja-JP ko-KR ms-MY nl-NL no-NO pt-BR pt-PT ru-RU sv-SE th-TH tr-TR vi-VI cmn-Hans cmn-Hant]


This exceeded the limit but for some reasons, it wasn't detected.

# The %w might be confusing for new users Style/WordArray: MinSize: 19

ainame · 2021-04-21T07:05:53Z

rubocop/fork_usage.rb

@@ -33,7 +33,7 @@ def on_if(node)
      def on_send(node)
        return unless bad_fork(node)
        return if self.good_nodes.include?(node)
-        add_offense(node, :expression, MSG)
+        add_offense(node, location: :expression, message: MSG)


add_offsense in rubocop no longer support positional arguments and instead, we need to use keyword arguments.

ainame · 2021-04-21T07:06:35Z

deliver/lib/deliver/languages.rb

@@ -2,6 +2,6 @@ module Deliver
  module Languages
    # 2020-08-24 - Available locales are not available as an endpoint in App Store Connect
    # Update with Spaceship::Tunes.client.available_languages.sort (as long as endpoint is avilable)
-    ALL_LANGUAGES = ["ar-SA", "ca", "cs", "da", "de-DE", "el", "en-AU", "en-CA", "en-GB", "en-US", "es-ES", "es-MX", "fi", "fr-CA", "fr-FR", "he", "hi", "hr", "hu", "id", "it", "ja", "ko", "ms", "nl-NL", "no", "pl", "pt-BR", "pt-PT", "ro", "ru", "sk", "sv", "th", "tr", "uk", "vi", "zh-Hans", "zh-Hant"]
+    ALL_LANGUAGES = %w[ar-SA ca cs da de-DE el en-AU en-CA en-GB en-US es-ES es-MX fi fr-CA fr-FR he hi hr hu id it ja ko ms nl-NL no pl pt-BR pt-PT ro ru sk sv th tr uk vi zh-Hans zh-Hant]


This exceeded the limit but for some reasons, it wasn't detected.

# The %w might be confusing for new users Style/WordArray: MinSize: 19

ainame · 2021-04-21T07:13:40Z

fastlane/lib/fastlane/cli_tools_distributor.rb

@@ -23,7 +23,7 @@ def utf8_locale?
      def take_off
        before_import_time = Time.now

-        if !ENV["FASTLANE_DISABLE_ANIMATION"]
+        if ENV["FASTLANE_DISABLE_ANIMATION"].nil?


This stops a crash in rubocop. I would report it to them but in the meantime, we can keep it running with this easy fix.

https://gist.github.com/ainame/b90ba9fc159a0ff2ab8cb417ac9586c0

minuscorp

What a work here! I'm glad that you didn't take all cops by yourself, you did more than enough! ❤️🚀

joshdholtz

Oh my goodness... I can’t thank you enough for this PR 🙏 This was very much needed and you killed it. This is going to great ❤️

fastlane-bot · 2021-04-22T19:30:32Z

Hey @ainame 👋

Thank you for your contribution to fastlane and congrats on getting this pull request merged 🎉
The code change now lives in the master branch, however it wasn't released to RubyGems yet.
We usually ship about once a week, and your PR will be included in the next one.

Please let us know if this change requires an immediate release by adding a comment here 👍
We'll notify you once we shipped a new release with your changes 🚀

fastlane-bot · 2021-05-10T19:30:52Z

Congratulations! 🎉 This was released as part of fastlane 2.182.0 🚀

google-cla bot added the cla: yes label Apr 16, 2021

ainame mentioned this pull request Apr 16, 2021

📣 Plan for Ruby 3.0 support (Released!) #17931

Closed

ainame force-pushed the bump-rubocop-version branch from a9c7f28 to 5610454 Compare April 20, 2021 05:52

Update rubocop version to the latest

6e40f40

ainame force-pushed the bump-rubocop-version branch 2 times, most recently from eb353dd to c63c67b Compare April 21, 2021 06:30

ainame commented Apr 21, 2021

View reviewed changes

ainame added 15 commits April 21, 2021 07:43

Bump rubocop version and fix config to make it work

3c0ba60

Move AllCops section to top

b37c00a

Include ruby files

dbc64d1

Disable new cops

049f0e4

Migrate department of rules

c3006f6

Fix custom cops

0019dbe

Put unhandled cops in .rubocop_todo.yml

5b4c1fc

Remove inherit_from in copied rubocop.yml that causes an error

0f8313d

Apply auto correction of existing cops that are prviously missed

6e43ac6

Exclude .provisionprofile that are included accidentially

09e9400

Fix plugin template's rubocop.yml

370ff4e

Bump Fastlane::RUBOCOP_REQUIREMENT

18219d6

Fix plugin_generator_spec

1584c94

Enable NewCops and re-run --auto-gen-config

d34fb28

Fix rubocop's crash

14ea64a

ainame force-pushed the bump-rubocop-version branch from c63c67b to 14ea64a Compare April 21, 2021 06:53

ainame commented Apr 21, 2021

View reviewed changes

ainame marked this pull request as ready for review April 21, 2021 07:15

ainame requested review from joshdholtz, rogerluan and minuscorp April 21, 2021 07:15

ainame self-assigned this Apr 21, 2021

ainame added the topic: ruby 3.0 label Apr 21, 2021

minuscorp approved these changes Apr 21, 2021

View reviewed changes

joshdholtz approved these changes Apr 22, 2021

View reviewed changes

joshdholtz merged commit ec629c1 into fastlane:master Apr 22, 2021

ainame deleted the bump-rubocop-version branch April 22, 2021 06:21

fastlane-bot added the status: included-in-next-release label Apr 22, 2021

joshdholtz mentioned this pull request May 5, 2021

Version bump to 2.182.0 #18647

Merged

fastlane-bot removed the status: included-in-next-release label May 10, 2021

fastlane-bot added the status: released label May 10, 2021

fastlane locked and limited conversation to collaborators Jul 10, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Ruby 3.0] Bump rubocop version #18564

[Ruby 3.0] Bump rubocop version #18564

ainame commented Apr 16, 2021 •

edited

ainame Apr 21, 2021

ainame Apr 21, 2021

ainame Apr 21, 2021

ainame Apr 21, 2021

ainame Apr 21, 2021 •

edited

minuscorp Apr 21, 2021

ainame Apr 22, 2021 •

edited

ainame Apr 21, 2021

ainame Apr 21, 2021

ainame Apr 21, 2021

ainame Apr 21, 2021 •

edited

minuscorp Apr 21, 2021

minuscorp left a comment

joshdholtz left a comment

fastlane-bot commented Apr 22, 2021

fastlane-bot commented May 10, 2021

		Metrics/PerceivedComplexity:
		Max: 18

[Ruby 3.0] Bump rubocop version #18564

[Ruby 3.0] Bump rubocop version #18564

Conversation

ainame commented Apr 16, 2021 • edited

Checklist

Motivation and Context

Description

Testing Steps

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ainame Apr 21, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ainame Apr 22, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ainame Apr 21, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

minuscorp left a comment

Choose a reason for hiding this comment

joshdholtz left a comment

Choose a reason for hiding this comment

fastlane-bot commented Apr 22, 2021

fastlane-bot commented May 10, 2021

ainame commented Apr 16, 2021 •

edited

ainame Apr 21, 2021 •

edited

ainame Apr 22, 2021 •

edited

ainame Apr 21, 2021 •

edited