nimblehq / rails-templates Goto Github PK

We can NOT use the Rails generator to create the model since the Rails version 5.1.4 NOT support pg gem on version 1.0.0.

We need to set the pg gem in Gemfile to something like this.

gem 'pg', '~> 0.21.0'

In order to reduce the size of the Docker image, we should use the alpine version for Ruby. ruby:2.4.2-slim is slim but a project image still weighs at around 400MB or so.

Link to available version: https://hub.docker.com/_/ruby/

Over the years, we have rarely used caching with Rails. And when we did, it was added afterwards in the life of the project, not at the beginning. But performance-wise, the apps we develop would gain a lot. And in terms of efficiency, it would be easier to develop with caching setup and in mind from the start.

Rails 5.2 improve a lot the built-in cache feature, so I think it's time to revisit this topic.

• Review what's new in Rails caching, especially Redis Cache Store
• Enable caching by default in the Rails Template
• Implement a base application with caching working from the start

Website speed is one of the major factor which impacts the ranking in Google. Therefore, we should enable Rack Deflater by default.

References:

• https://thoughtbot.com/blog/content-compression-with-rack-deflater
• https://www.schneems.com/2017/11/08/80-smaller-rails-footprint-with-rack-deflate/

How about adding colorize in development? It adds different colors to the logs.

To replicate just run the rails -n from master. Also use http://hadolint.lukasmartinelli.ch/

 identical  lib/assets/.keep
       exist  log
   identical  log/.keep
       exist  public
   identical  public/404.html
   identical  public/422.html
   identical  public/500.html
   identical  public/apple-touch-icon-precomposed.png
   identical  public/apple-touch-icon.png
   identical  public/favicon.ico
   identical  public/robots.txt
       exist  tmp
   identical  tmp/.keep
       exist  tmp/cache
       exist  tmp/cache/assets
       exist  vendor
   identical  vendor/.keep
   identical  package.json
      remove  config/initializers/cors.rb
      remove  config/initializers/new_framework_defaults_5_1.rb
       apply  /Users/carlos/workspace/rails-templates/rails_docker.rb
/Users/carlos/.rvm/gems/ruby-2.4.1/gems/thor-0.19.4/lib/thor/actions.rb:224:in `instance_eval': /Users/carlos/workspace/rails-templates/rails_docker.rb:33: syntax error, unexpected tCONSTANT, expecting end-of-input (SyntaxError)
remove_file 'Dockerfile'
                       ^
	from /Users/carlos/.rvm/gems/ruby-2.4.1/gems/thor-0.19.4/lib/thor/actions.rb:224:in `apply'
	from /Users/carlos/.rvm/gems/ruby-2.4.1/gems/railties-5.1.1/lib/rails/generators/app_base.rb:166:in `apply_rails_template'
	from (eval):1:in `apply_rails_template'
	from /Users/carlos/.rvm/gems/ruby-2.4.1/gems/thor-0.19.4/lib/thor/command.rb:27:in `run'
	from /Users/carlos/.rvm/gems/ruby-2.4.1/gems/thor-0.19.4/lib/thor/invocation.rb:126:in `invoke_command'
	from /Users/carlos/.rvm/gems/ruby-2.4.1/gems/thor-0.19.4/lib/thor/invocation.rb:133:in `block in invoke_all'
	from /Users/carlos/.rvm/gems/ruby-2.4.1/gems/thor-0.19.4/lib/thor/invocation.rb:133:in `each'
	from /Users/carlos/.rvm/gems/ruby-2.4.1/gems/thor-0.19.4/lib/thor/invocation.rb:133:in `map'
	from /Users/carlos/.rvm/gems/ruby-2.4.1/gems/thor-0.19.4/lib/thor/invocation.rb:133:in `invoke_all'
	from /Users/carlos/.rvm/gems/ruby-2.4.1/gems/thor-0.19.4/lib/thor/group.rb:232:in `dispatch'
	from /Users/carlos/.rvm/gems/ruby-2.4.1/gems/thor-0.19.4/lib/thor/base.rb:444:in `start'
	from /Users/carlos/.rvm/gems/ruby-2.4.1/gems/railties-5.1.1/lib/rails/commands/application/application_command.rb:24:in `perform'
	from /Users/carlos/.rvm/gems/ruby-2.4.1/gems/thor-0.19.4/lib/thor/command.rb:27:in `run'
	from /Users/carlos/.rvm/gems/ruby-2.4.1/gems/thor-0.19.4/lib/thor/invocation.rb:126:in `invoke_command'
	from /Users/carlos/.rvm/gems/ruby-2.4.1/gems/thor-0.19.4/lib/thor.rb:369:in `dispatch'

As we use the livingstyleguide on most of the project, should we add this to the template

We're using Devise for every project, and every time we're creating sign-in and sign-up pages that are quite similar in style.

In order to implement faster, we should have a basic layout defined in the template directly which could then be styled for each project.

Why

The Chrome Driver 2.46 doesn't support the current Chrome Stable Version (Chrome > 77.x) anymore, we have to upgrade Chrome Driver to latest stable version too

Solution

• Using the latest Chrome Driver version on https://chromedriver.chromium.org/downloads

• Don't hardcode the Chrome Driver Version in shared/rspec/support/webdrivers.rb, instead moving it to ENV variable shared/config/application.yml, so later we can easy to adjust it on CI

In order to make styling more agnostic (SCSS, Sass, Les), we could check is it would be good to move to https://stylelint.io/

Here is the plugin for Pronto: https://github.com/kevinjalbert/pronto-stylelint.

Should we enable the Style/FrozenStringLiteralComment

Style/FrozenStringLiteralComment:
  Enabled: false

Once we enabled that rule (by removing the block ⬆️), we need to run rubocop -a to add the # frozen_string_literal: true to each Ruby files.

To set wait_on_first_by_default in Capybara configuration to true because when we use first method in Capybara it won't wait for element to render completely if we chain with click method it will click immediately sometimes it cause test to fail, by adding this configuration will make Capybara wait until the first element appear then invoke chain method.

# spec/support/capybara.rb
...
Capybara.wait_on_first_by_default = true
...

When we use this in Semaphore CI. We don't need to map the port number.

# From
ports:
      - "5432:5432"
# To
ports:
      - "5432"

Please change this on both PosgreSQL and Redis port settings.

As currently we're not including the turbolinks in the project by default. We've already removed turbolinks in gemfile and javascript. But in the layout, there are still turbolinks-related attributes.

<%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track': 'reload' %>
<%= javascript_include_tag 'application', 'data-turbolinks-track': 'reload' %>

We should remove those too.

In the Dockerfile, the Node.js version still set to version 8. I think we should upgrade the version number to the latest version of the LTS release. (Now the latest LTS version is 10.16.3)

When creating a new rails application using rails new test_app -m ./rails_docker.rb -T --api , the process fails as rails_docker.rb is referencing javascript asset paths that don't exist in api mode.

It'd be good to have some guards around code that is looking for directories to be available.

• Add sidekiq service to Docker compose
• Provision addon on Heroku
• Configure sidekiq in the core Rails application

Known issues with heroku:
If you are not using webpacker, add sass-rails, uglifier gems

This error occurs when you start the project by using rails-template. since the rails-templates no .env.test file. It has only .env file.

To prevent this error you must to modify the rails_docker.rb to this.

# from
copy_file 'rails_docker/.env.test', '.env.test'
gsub_file '.env.test', '#{app_name}', "#{app_name}"
# to
copy_file 'rails_docker/.env', '.env'
gsub_file '.env', '#{app_name}', "#{app_name}"

The problem is we want to share the ENV variable between Rails and Node JS on the development environment.

For Rails, the figaro use the application.yml to export the ENV variables.

For Node JS, we use the dotenv to load the ENV on development environment, the ENV variables store in .env file.

So the problem now is we have 2 places to store the ENV variable for the development environment, 1 is application.yml for Rails and 1 is .env for Node JS.

So on Rails, if we change the Gem from figaro to dotenv-rails, we can use the same .env file both Rails and Node JS.

1. Enable eager_load of classes.

2. Enable Bullet errors to indicate N+1 queries.

Issue

In order to increase our test coverage, it would be good to extended Rubocop base cops with Rails-spcific cops:

• Rubocop Rails: Github - RubyGems
• Rubocop Performance: Github
• Rubocop Rspec: Github

What's Next?

Add dependencies in Gemfile

I can NOT run RSpec because the configure is deprecated. To solve this problem we need to remove spec/support/json_matchers.rb file.

See: https://github.com/thoughtbot/json_matchers/tree/v0.9.0#deprecated-global-matcher-options

I can NOT run the Procfile.dev to start the application server because it missing the Redis configuration in the docker file.

please add this to the docker file.

redis:
    image: redis:4.0.9
    container_name: <app-name>_redis
    ports:
      - "6379:6379"

I got some warning like this:
/spec/support/simplecov.rb:2:in <top (required)>': [DEPRECATION] ::[] is deprecated. Use ::new instead.
`
from this line of code:
https://github.com/nimbl3/rails-templates/blob/112521650256f11077061c3f4802f6b0527af09f/shared/rspec/support/simplecov.rb#L2

then I fix it following this document:
https://github.com/colszowka/simplecov#using-multiple-formatters

In spec/support/webpack.rb file, We need to specify the NODE_ENV to test environment. Otherwise, it will compile in the development environment instead.

# Before
RSpec.configure do |config|
  config.before(:suite) do
    if ENV['TEST_SKIP_ASSET'].blank?
      puts 'Prepare webpack assets for test environment'

      `RAILS_ENV=test bin/webpack`
    end
  end
end

# After
RSpec.configure do |config|
  config.before(:suite) do
    if ENV['TEST_SKIP_ASSET'].blank?
      puts 'Prepare webpack assets for test environment'

      `RAILS_ENV=test NODE_ENV=test bin/webpack`
    end
  end
end

The base image point currently points to ruby:2.4.2-slim. So in an effort to keep it up to date, we should move this to ruby:2.5.0-slim.

It could be done at the same time as #58

Based on the discussion in our team we decided to revert the image back to Debian Slim, the reason was mostly because of the performance and missing package that support for Alpine

Relative links:
https://superuser.com/questions/1324269/docker-ubuntu-vs-alpine-speed-differences
https://superuser.com/questions/1219609/why-is-the-alpine-docker-image-over-50-slower-than-the-ubuntu-image
https://dev.to/asyazwan/moving-away-from-alpine-30n4

As it will be the default asset pipeline in Rails 6 and we used in all projects, we should get the head start and make it the default.

Convert CSS unit from px to rem or em is a very tedious task. For improve more productive when you are working on stylesheets. rails-templates will provide rem and em Sass functions.

These functions will look like this when we are using.

rem()

.sample-1 {
  padding: rem(20px); // padding: 1.25rem;
}

.sample-2 {
  padding: rem(20px 16px); // padding: 1.25rem 1rem;
}

.sample-3 {
  padding: rem(20px 16px 32px); // padding: 1.25rem 1rem 2rem;
}

.sample-4 {
  padding: rem(20px 16px 32px auto); // padding: 1.25rem 1rem 2rem auto;
}

em()

.sample-1 {
  padding: em(20px); // padding: 1.25em;
}

.sample-2 {
  padding: em(20px 16px); // padding: 1.25em 1em;
}

.sample-3 {
  padding: em(20px 16px 32px); // padding: 1.25em 1em 2em;
}

.sample-4 {
  padding: em(20px 16px 32px auto); // padding: 1.25em 1em 2em auto;
}

Right now the default Capybara default_max_wait_time on Rails template is 30s on local machine and 60s on CI. But is it the best setting? 🙈

One example is from Braive. When we use Capybara.default_max_wait_time = 30s or 60s like from the Rails template, the Backend, Clinician and Page - System tests become around ~14min. This is much slower than the previous test, which had Capybara.default_max_wait_time = 5s, who have around ~7min testing time.

I think we have to keep the Capybara.default_max_wait_time = 5s or even 2s, like the default, because we already have retry system in place. And when looking at data from this and this, it seems some specs are still failing, even though we had wait for 60s:

See this PR's comment for link to the CI to see the build time.

In ideal world, Capybara shouldn't wait for anything. We already disable all animations when testing (at least on Braive), so Capybara isn't waiting for CSS animation. For waiting for AJAX request, better to use a wait_for_ajax helper:

def wait_for_ajax
    Timeout.timeout(Capybara.default_max_wait_time) do
      loop until finished_all_ajax_requests?
    end
  end

And if we have to wait for something specific, we can use :wait option on each expectation:

expect(page).to have_text('Lorem ipsum', wait: 3)

To be honest, I'm still not sure why some tests are failing randomly, and it isn't passed even when we had wait for 60s. But I think it's faster just to fail early, and make Rspec retry catch the failure and rerun the spec.

The current Rubocop configuration prefer this style

For me, I think it's nicer if we change the Rubocop configuration to support this style (aligned hash key, has value, aligned the equal)

To change that, we need to update the RuboCop/Cop/Layout/AlignHash in the rubocop.yml file.

And update the RuboCop/Cop/Layout/ExtraSpacing in the rubocop.yml file.

To format the code, we can use the Rubocop autocorrect feature rubocop -a

If we prefer the new style, I will open a PR to update the Rails template also open a PR to update the convention on Compass.

Issue

We are using Bootstrap CSS and Bootstrap Native JS in most of the projects, should we add that to our template as well 🤔

Vote

Rationale

As we do use the template on a regular basis (basically only when we start a new project), some issues due to outdated configuration or just plain human mistakes can make their way into the template. It's also hard to do a major Rails version jump by just changing the configuration (that's why the template is still on Rails 5.1.x 😢 ).

The solution would be to set up a test pipeline just like for any project.

Solution

The tests must do the following:

• Create a new Rails application based on the template. Since #70, this would not even require to clone this repo to work
• Tests that the web app can be accessed via the Docker container in all environment. Basically testing the accessibility of port 3000 (development) and 80
• Tests that a PG and Redis containers exist and can be accessed

Because we use RuboCop disabled comment but forgot to re-enable it in the below of the method. To solve this problem we should add the re-enable comment to the below of the method.

# spec/support/disable_animation.rb

# From

# rubocop:disable Metrics/MethodLength
# rubocop:disable Naming/HeredocDelimiterNaming
# rubocop:disable Layout/IndentHeredoc:
def inject(fragment)
  #....
end

# To 

# rubocop:disable Metrics/MethodLength
# rubocop:disable Naming/HeredocDelimiterNaming
# rubocop:disable Layout/IndentHeredoc:
def inject(fragment)
  #....
end
# rubocop:enable Metrics/MethodLength
# rubocop:enable Naming/HeredocDelimiterNaming
# rubocop:enable Layout/IndentHeredoc:

Many gems in the default gems are unused or not the best ones anymore so it's time to trim the fat out.

Let's remove the following gems:

• carrierwave: redundant with Actie Storage
• carrierwave-aws
• chronic: nobody uses it
• font-awesome-sass

Replace the following gems:

• kaminari by pagy: https://github.com/ddnexus/pagy

@olivierobert found that the Paranoia is being replaced by Discard gem

Why should we use Discard

• https://github.com/jhawthorn/discard#why-not-paranoia-or-acts_as_paranoid

We would need to evaluate what to change and how it works. The difference that we notice is on Discard, it does not apply the default scope which means .all returns both kept and discarded. And we would need to check more on how dependent: destroy works.

https://www.rubydoc.info/github/bbatsov/RuboCop/RuboCop/Cop/Layout/ExtraSpacing

For speed improvements, an easy win is to use dns-prefetch for the application assets host and core third-party domains:

<!DOCTYPE html>
<html>
  <head>
    <title> <%= yield(:title) %> </title>
      <% if ActionController::Base.asset_host %>
        <link rel="dns-prefetch" href="<%= ActionController::Base.asset_host %>" />
      <% end %>
      <link rel="dns-prefetch" href="http://www.google-analytics.com">

More info: https://rubyplus.com/articles/5001-Speeding-up-Page-Load-in-Rails-Applications

Why

To set the locale in before_action, there will is a case that the I18n can't get the default locale for some request, I faced that in a project.

For more details:

• ruby-i18n/i18n#381
• rails/rails#34043
• rails/rails#34356
• https://guides.rubyonrails.org/i18n.html#managing-the-locale-across-requests

Solution

I think we should go with the Rails way, using around_action instead - https://guides.rubyonrails.org/i18n.html#managing-the-locale-across-requests

I can NOT generate the template from Github URL. I need to clone from the development branch and generate from the local files.

Expect

rails new < app_name > -m https://raw.githubusercontent.com/nimbl3/rails-templates/master/rails_docker.rb -T

Actual

rails new < app_name > -m ./rails-templates/rails_docker.rb -T

Should we change from the master branch to the development branch?

To speed up UI tests, let's add this spec helper to the default template: https://gist.github.com/keithtom/8763169

Should we add gem webpacker to the Gemfile.txt?
Because It has some issues when trying to create a new project with React environment using webpack.

I use this command --webpack=react.

Issue

As we have SCSS linte and ES linter, and we check that manually, it works but sometimes we forgot to run it and because there is no test for that, so the invalid code can go to production 😱 we should add it to the codebase_spec.rb

  it 'does not offend scsslint' do
    expect(`scss-lint .`).to be_empty
  end

  it 'does not offend eslint' do
    expect(`yarn run eslint .`).to include 'Done'
  end

Then we can get something like this

Vote

The translations file of i18n-js can be automatically generated by the I18n::JS::Middleware.

To do that we need to add

config.middleware.use I18n::JS::Middleware 

to our config/environments/development.rb file.

The current tags were following semantic versioning following Rails but it's not really flexible as we cannot push updates more than once per Rails version 🙃

So let's change all the past releases tags to follow semantic versioning not binded with Rails e.g. 1.0.0, 1.1.0...

https://github.com/roidrage/lograge

Instead of having an unparsable amount of logging output like this:

Started GET "/" for 127.0.0.1 at 2012-03-10 14:28:14 +0100
Processing by HomeController#index as HTML
  Rendered text template within layouts/application (0.0ms)
  Rendered layouts/_assets.html.erb (2.0ms)
  Rendered layouts/_top.html.erb (2.6ms)
  Rendered layouts/_about.html.erb (0.3ms)
  Rendered layouts/_google_analytics.html.erb (0.4ms)
Completed 200 OK in 79ms (Views: 78.8ms | ActiveRecord: 0.0ms)

you get a single line with all the important information, like this:

method=GET path=/jobs/833552.json format=json controller=JobsController  action=show status=200 duration=58.33 view=40.43 db=15.26