Rubocop change documentation

[pengyin-shan]

Part of 3.1.0 migration is to enable rubocop Github test again. For the current rubocop workflow, rubocop is using the version in Gemfile.lock, while in the main codebase, rubocop uses the default version with ruby 2.7.6.

I noticed that since DMP Assisant 3.0.4-15 has upgraded to ruby 2.7.6 because a bug fix only applied to ruby>=2.7, thus DMP Assisant 3.1.0 will use ruby 2.7.6 with Rails 5.2.8.1. An initial update shows that rubocop is 1.39.0 with RUBY VERSION 2.6.3p62 and BUNDLED WITH 2.3.25.

• In the main code base, robucup stays the same verson till v4.0. Robucup was 1.26.1 with RUBY VERSION ruby 2.6.3p62 BUNDLED WITH 2.2.33.
• From 4.0 upgraded to 1.37.1 with RUBY VERSION 2.7.6p219 and BUNDLED WITH 2.3.15.

The next step is to test if 1.39.0 will generate similar results to 1.26.1 and 1.37.1.

• found github action ruby 'version not valid' issue in the development process #265
• the latest version of wkhtmltopdf-binary(0.12.6.5,the latest version from https://rubygems.org/gems/wkhtmltopdf-binary) hasn't added support to Ubuntu 22.04, thus need to hard-set Github actions ubuntu versions to 20.0.4 for supporting issue #266
• Clarification of String and Array behavior for plan exports #268

[pengyin-shan]

3.1.0 initial version: using rubop 1.39.0 with Rails 5 and ruby 2.7.6. updated rubocop.yml to be same as the main codebase.

• A initial run of Rubocop got 573 files inspected, 251 offenses detected, 102 offenses autocorrectable
• rubocop -A got:

573 files inspected, 264 offenses detected, 183 offenses corrected
The following RuboCop extension libraries are installed but not loaded in the config:
  * rubocop-rails # main codebase disabled it in Gemfile
  * rubocop-rspec # main codebase disabled it in Gemfile

• A re-run of Rubocop got 573 files inspected, 79 offenses detected
• While same rubocop running in development branch of main code base is fully passed:

558 files inspected, no offenses detected

Tip: Based on detected gems, the following RuboCop extension libraries might be helpful:
  * rubocop-rails (https://rubygems.org/gems/rubocop-rails)
  * rubocop-rspec (https://rubygems.org/gems/rubocop-rspec)

---

A check of the 79 offenses:

Although we see many offenses, it only belongs to following 23 files (from the excel file I used for record) :

All blue ones are DMP Assisant config/customized related files. We changed them and should be good to go in the future.
All yellow ones are app model or controller but with our customization, such as exportable_plan.rb

---

Overall speaking, a rubocop one-time fix should be actionable. The offenses were not as many as I estimated before.

[pengyin-shan]

Compared to the main codebase, the rubocop auto-fix seems didn't cause any difference (checked plan_controller.rb as example). Will continue to watch it

[pengyin-shan]

As a note, the attached full status file marks the issues, 3.1.0 status, my notes and which are issues that need to be turned back in future migrations:

Make sure to check this in 3.1.1 migration and future migration:
result.json.xlsx

[pengyin-shan]

The Excel file
result.json.xlsx
contains highlighted rubocop status. Rubocop and sub-issues have all been fixed in 3.1.0. Close this ticket for now.