Set up Rubocop for the template #320

rosle · 2022-02-03T07:39:16Z

What happened

Set up Rubocop for template
Set up the workflow to run Rubocop - Test Template

Insight

Due to our current template structure, there are some customization on Bundle and Rubocop.

Current structure:

.
├── .template
│   ├── .rspec
│   ├── .rubocop.yml   <--- Rubocop config for template here
│   ├── .ruby-gemset
│   ├── Gemfile.       <--- Gemfile for the template here
│   ├── Gemfile.lock
│   ├── ...
│   ├── addons
│   └── variants
├── bin
│   ├── ...
│   └── template.rb
├── config
│   ├── ...
│   └── template.rb
├── spec
│   ├── ...
│   └── template.rb
└── template.rb.       <--- There are also project template outside (Base template)

The problem is we would need to run rubocop on the root of the project. So it runs tests for all the base template in the root and addon/varient in .template. Hence, we need to:

Bundle - Config the Gemfile path in .bundle/config to point to .template/Gemfile. With this we will able to run bundle install and bundle exec rubocop from the root of the project
Rubocop - Point the config when running rubocop command rubocop --config .template/.rubocop.yml. I've added the script in .template/bin/rubocop.

Due to the current file structure limitation, we need to have these configs in order to run rubocop. Later we can revisit the template structure e.g. consider moving base into .template 🤔

Proof Of Work

Able to run rubocop through .template/bin/rubocop at the root of the project.
The Test Template workflow is run.

rosle · 2022-03-17T04:28:20Z

.template/.rubocop.yml

+Style/GlobalVars:
+  Enabled: false
+
+# TODO: Enable this rule later


I'll enable these rules later in another PR, so this PR is not too big. 🙏

@rosle , here are two of my favorites cops:

Style/GuardClause

Style/OneLineConditional

Is this something we could incorporate, what do you think? Thank you!

Noted. I'll open more PRs to fix these cops and I'll revisit those rules 👍 ✨

@tyrro I revisited these 2 cops, seems we already have it enabled 👍 🚀

rosle · 2022-03-17T04:32:37Z

.template/lib/template/errors.rb

@@ -1 +1,3 @@
+# rubocop:todo Style/ClassAndModuleChildren


I'll fix this when working on refactoring the template - #321. Because it needs to load the template module in prior. 🙏

olivierobert

Looks good to me. I just have one question.

olivierobert · 2022-03-17T08:54:28Z

README.md

+If running on Apple M1:
+
+- Set bundle platform to ruby `bundle config set --global force_ruby_platform true`
+- To build docker image, please make sure to set platform to AMD64 `export DOCKER_DEFAULT_PLATFORM=linux/amd64`


Do you have a reference/source for this workaround? We might need to have it on other templates too.

I have issue when building the image, Chrome is failed to installed

#9 7.669 E: Unable to locate package google-chrome-stable

and seems it is because we need to supply --platform when doing docker build

https://medium.com/no-sliver-bullet/apple-m1-%E8%AE%93%E4%BD%A0%E7%9A%84-docker-build-%E4%B8%8D%E8%B5%B7%E4%BE%86%E4%BA%86%E5%97%8E-bbe133d6d1bb

From docker documentation:

https://docs.docker.com/engine/reference/commandline/build/#options

https://docs.docker.com/desktop/mac/apple-silicon/#known-issues

There are also https://docs.docker.com/desktop/multi-arch/ But I still haven't played much on it. Still don't know about it much.

We can supply that option in many places, --platform when build through cli, platform in docker compose file or through ENV export DOCKER_DEFAULT_PLATFORM=linux/amd64

Now I just set that ENV in my zshrc 👍

For bundle config set --global force_ruby_platform true, without it, the Gemfile.lock will generate

PLATFORMS arm64-darwin-21

(While usually we have platform ruby)

The project is created successfully but when running docker container, it fails (I think maybe because platform is different?). The error is from Nogokiri

https://nokogiri.org/tutorials/installing_nokogiri.html#how-can-i-avoid-using-a-precompiled-native-gem

🛠️ To fix: we can just add ruby to platforms

PLATFORMS arm64-darwin-21 ruby

I found bundle config set --global force_ruby_platform true is easier, so we do not have to keep editing the lock file. 👀

But after I tried to reproduce, it does not happen anymore (maybe because we set platform 💭 ). Now Gemfile.lock in the container is automatically modified to

PLATFORMS arm64-darwin-21 x86_64-linux

I'll revisit this config again tomorrow 🤔

I can confirm bundle config set --global force_ruby_platform true is not required anymore. Maybe it's from platform setting:

On local machine:

Inside container, The additional platform is added:

I've updated the readme on f502949 👍

tyrro

LGTM!

tyrro · 2022-03-17T09:57:48Z

.template/.rubocop.yml

+Style/GlobalVars:
+  Enabled: false
+
+# TODO: Enable this rule later


@rosle , here are two of my favorites cops:

Style/GuardClause

Style/OneLineConditional

Is this something we could incorporate, what do you think? Thank you!

longnd

small tip, maybe you already know:

When linking a PR to an issue, we can use special keywords to close the issue automatically when the PR is merged, e.g.

close #168

longnd · 2022-03-18T03:22:10Z

.template/.rubocop.yml

@@ -0,0 +1,53 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.7


shouldn't we target ruby 3?

Updated in 25f0dc4 ✨

rosle · 2022-03-18T04:07:39Z

When linking a PR to an issue, we can use special keywords to close the issue automatically when the PR is merged, e.g.
close #168

Thank Long 👍 There will be a couple more PRs to fix the disabled Rubocop. I disabled those rules now to prevent the PR from getting too big. I'll do it in the last PR~ ✨

rosle added the type : chore label Feb 3, 2022

rosle added this to the 5.0.0 milestone Feb 3, 2022

rosle self-assigned this Feb 3, 2022

rosle force-pushed the chore/refactor-heredoc branch 3 times, most recently from a43227d to 086e8ad Compare March 16, 2022 03:29

rosle changed the base branch from chore/refactor-heredoc to develop March 16, 2022 03:41

rosle force-pushed the chore/setup-rubocop branch 7 times, most recently from b510ba8 to 07f798f Compare March 16, 2022 05:04

Setup rubocop and fix warnings

97c742c

rosle force-pushed the chore/setup-rubocop branch from 07f798f to 97c742c Compare March 16, 2022 05:05

rosle added 3 commits March 16, 2022 12:29

Add template rubocop script

eb66d95

Fix rubocop warnings and adjust rubocop config

bf920c8

wip

59787bf

rosle force-pushed the chore/setup-rubocop branch from 9c34d96 to 59787bf Compare March 16, 2022 08:38

Fix failed tests

203b26b

rosle commented Mar 17, 2022

View reviewed changes

rosle added 3 commits March 17, 2022 12:00

Update readme

11ff233

Revert workflow trigger

b337ddf

Update readme

4a6596d

rosle requested a review from a team March 17, 2022 08:09

rosle marked this pull request as ready for review March 17, 2022 08:10

olivierobert approved these changes Mar 17, 2022

View reviewed changes

olivierobert requested a review from longnd March 17, 2022 08:59

olivierobert requested review from junan and tyrro March 17, 2022 08:59

tyrro approved these changes Mar 17, 2022

View reviewed changes

longnd reviewed Mar 18, 2022

View reviewed changes

rosle added 2 commits March 18, 2022 10:37

Update target ruby version to 3

25f0dc4

Update readme

f502949

rosle requested a review from longnd March 18, 2022 04:07

junan approved these changes Mar 18, 2022

View reviewed changes

rosle mentioned this pull request Mar 18, 2022

Set up Rubocop for the template - Enable cop rules #324

Merged

rosle merged commit 43311cb into develop Mar 21, 2022

rosle mentioned this pull request Mar 21, 2022

Release/5.0.0 #327

Merged

rosle deleted the chore/setup-rubocop branch March 21, 2022 07:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Set up Rubocop for the template #320

Set up Rubocop for the template #320

rosle commented Feb 3, 2022 •

edited

Loading

rosle Mar 17, 2022

tyrro Mar 17, 2022

rosle Mar 17, 2022

rosle Mar 18, 2022

rosle Mar 17, 2022 •

edited

Loading

olivierobert left a comment

olivierobert Mar 17, 2022

rosle Mar 17, 2022

rosle Mar 17, 2022

rosle Mar 18, 2022

tyrro left a comment

tyrro Mar 17, 2022

longnd left a comment •

edited

Loading

longnd Mar 18, 2022

rosle Mar 18, 2022

rosle commented Mar 18, 2022

Set up Rubocop for the template #320

Set up Rubocop for the template #320

Conversation

rosle commented Feb 3, 2022 • edited Loading

What happened

Insight

Proof Of Work

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

rosle Mar 17, 2022 • edited Loading

Choose a reason for hiding this comment

olivierobert left a comment

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

Choose a reason for hiding this comment

tyrro left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

longnd left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rosle commented Mar 18, 2022

rosle commented Feb 3, 2022 •

edited

Loading

rosle Mar 17, 2022 •

edited

Loading

longnd left a comment •

edited

Loading