[Ruby 3.0] Replace obsolete URI.escape with alternatives

[ainame]

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

As per #17931, I've been working on Ruby 3.0 support. Prior to this, I've fixed most deprecation warnings from Ruby 2.7 #18021. It now prevents PRs from making new warnings by checking them in CircleCI.

fastlane/.circleci/config.yml

Lines 106 to 111 in 72ff4fc

	- run:
	name: Check compatibility with Ruby 3.0
	command: |
	touch ~/test-reports/ruby_warnings.txt
	# TODO remove 'grep -v ".bundle"' once 3rd party dependencies support Ruby 3.0
	! cat ~/test-reports/ruby_warnings.txt | grep -v ".bundle" | grep -E "warning:\s.*(deprecated).*$" && echo "No deprecation message found."

However, there is still another type of deprecation warning introduced in Ruby 1.9; warning: URI.escape is obsolete. This message bypassed the above check😂 I recognised this warning before but didn't know URI.escape was finally removed in Ruby 3.0 until I run fastlane on Ruby 3.0, which became possible after #18599.

This PR replace URI.escape with some alternatives. Some of them were fixed in this PR previously #16409 but it had some defects that the PR changed results. This PR also restores previous results.

You can read some history in blog posts; for example
https://docs.knapsackpro.com/2020/uri-escape-is-obsolete-percent-encoding-your-query-string

Description

There's no 100% equivalent to URI.escape. So we need to use alternatives case by case.

1. URI.encode_www_form_component - can be used where you encode a part of URI query parameter
2. URI.encode_www_form - can be used with query parameters in Array on Hash
3. CGI.escape - similar to URI.encode_www_form_component but it follows CGI's spec
4. Addressable::URI.encode - is 3rd party dependency (we've already adopted) but is the closest option to URI.escape

I applied 1 for places where we process query parameters and 3 for the rest of URLs and file paths.

Note that there is different behaviour between URI.escape and URI.encode_www_form_component especially for whitespaces. While URI.escape and Addressable::URI.escape can work well for file paths including whitespaces, URI.encode_www_form_component is only effective for "query parameters" really.

These are examples of differences among those APIs (except for CGI.escape).

[3] pry(main)> URI.escape 'a b'
(pry):3: warning: URI.escape is obsolete
=> "a%20b"
[4] pry(main)> URI.encode_www_form_component 'a b'
=> "a+b"
[5] pry(main)> Addressable::URI.encode('a b')
=> "a%20b"

[2] pry(main)> URI.escape('~/app/fastlane/screenshots/en_US/a 1.jpg')
(pry):2: warning: URI.escape is obsolete
=> "~/app/fastlane/screenshots/en_US/a%201.jpg"
[3] pry(main)> Addressable::URI.encode('~/app/fastlane/screenshots/en_US/a 1.jpg')
=> "~/app/fastlane/screenshots/en_US/a%201.jpg"
[4] pry(main)> URI.encode_www_form_component('~/app/fastlane/screenshots/en_US/a 1.jpg')
=> "%7E%2Fapp%2Ffastlane%2Fscreenshots%2Fen_US%2Fa+1.jpg"

[10] pry(main)> URI.escape('http://fastlane.tools/search?query=あいうえお')
(pry):10: warning: URI.escape is obsolete
=> "http://fastlane.tools/search?query=%E3%81%82%E3%81%84%E3%81%86%E3%81%88%E3%81%8A"
[11] pry(main)> URI.encode_www_form_component('http://fastlane.tools/search?query=あいうえお')
=> "http%3A%2F%2Ffastlane.tools%2Fsearch%3Fquery%3D%E3%81%82%E3%81%84%E3%81%86%E3%81%88%E3%81%8A"
[12] pry(main)> Addressable::URI.encode('http://fastlane.tools/search?query=あいうえお')
=> "http://fastlane.tools/search?query=%E3%81%82%E3%81%84%E3%81%86%E3%81%88%E3%81%8A"

Testing Steps

We can test the followings -

• deliver/lib/assets/summary.html.erb - with deliver command with HTML preview (See if screenshots are correctly shown and linked)
• frameit/lib/frameit/frame_downloader.rb - with fastlane frameit download_frames
• fastlane/lib/fastlane/actions/xcodebuild.rb - with Fastfile below
  • This previously used URI.escape but changed it to URI.encode_www_form_component, which seems wrong. Addressable::URI.encode would be better 5e864f8#diff-cbec5511af30c2da21c2488e6f8baff4eabe4745fb5d01755aa506836b4db920R310-R313

Fastfile

platform :ios do
  desc "Push a new release build to the App Store"
  lane :release do
    app_store_connect_api_key(in_house: false)
    match
    increment_build_number
    
    ENV['XCODE_BUILD_PATH'] = 'build'
    xcarchive(
      sdk: 'iphoneos',
      scheme: 'FastlaneTest'
    )

    xcexport(
      export_path: File.join(ENV['XCODE_BUILD_PATH'], 'export'),
      export_options_plist: {
        method: 'app-store',
        uploadSymbols: true,
        manifest: {
          appURL: 'https://fastlane.tools/search?query=ファストレーン',
          displayImageURL: 'https://fastlane.tools/ファストレーン.jpg',
          fullSizeImageURL: 'https://fastlane.tools/ファストレーン.jpg',
          assetPackManifestURL: 'https://fastlane.tools/ファストレーン.plist',
        }
      }
    )
  end

Result - exportOption.plist (See if the URLs are escaped correctly)

``` manifest appURL https://fastlane.tools/search?query=%E3%83%95%E3%82%A1%E3%82%B9%E3%83%88%E3%83%AC%E3%83%BC%E3%83%B3 assetPackManifestURL https://fastlane.tools/%E3%83%95%E3%82%A1%E3%82%B9%E3%83%88%E3%83%AC%E3%83%BC%E3%83%B3.plist displayImageURL https://fastlane.tools/%E3%83%95%E3%82%A1%E3%82%B9%E3%83%88%E3%83%AC%E3%83%BC%E3%83%B3.jpg fullSizeImageURL https://fastlane.tools/%E3%83%95%E3%82%A1%E3%82%B9%E3%83%88%E3%83%AC%E3%83%BC%E3%83%B3.jpg method app-store teamID 2Q7H62SFG3 uploadSymbols ```

We can't really test them and might be good to consider deprecation/removal😞

• fastlane/lib/fastlane/actions/get_managed_play_store_publishing_rights.rb - Google's API this action uses was removed apparently
  • There is no description about https://play.google.com/apps/publish/delegatePrivateApp?service_account=&continueUrl= https://developers.google.com/android/work/play/custom-app-api/get-started#retrieve_the_developer_account_id
  • It existed on the same page in Nov 2020 http://web.archive.org/web/20201112040731/developers.google.com/android/work/play/custom-app-api/get-started
• fastlane/lib/fastlane/actions/hipchat.rb - Hipchat service ended
• gym/lib/gym/generators/package_command_generator_xcode7.rb - Who uses/keeps Xcode 7 now? 😂

[ainame]

This covers "UI.escape is obsolete" message and 3rd party dependencies now😄

[ainame]

This link was actually broken😅 I fixed it by adding render_relative_path

[ainame]

https://discuss.circleci.com/t/macos-image-users-homebrew-brownout-2021-04-26/39872/2

Apparently, CircleCI provides both old and new macOS images so that some builds succeed with Homebrew v3 others fails with Homebrew v2😞 This way brew update will be called only when a build picks up an old macOS image that has Homebrew v2. This can fall back to unshallow command when the initial attempt of brew update fails.

[joshdholtz]

This is insane 😛 Love it ❤️

[rogerluan]

Nice explanation of the rationale behind your decisions in the PR description 💪

LGTM! 🚀

[minuscorp]

LGTM🚀 great work as always! You rock!❤️

[ainame]

Thank you both!

[joshdholtz]

🔥 as always! Thank you 🥰

[joshdholtz]

This is insane 😛 Love it ❤️

[fastlane-bot]

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