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

* Enable regex literal style

* Enable global var style

* Enable frozen string literal style

* Enable filename naming

* Fix default addon message

.gitignore.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 append_to_file '.gitignore' do
   <<~IGNORE
 

.template/.rubocop.yml

@@ -31,22 +31,15 @@ Metrics/PerceivedComplexity:
     - '**/template.rb'
 
 Naming/FileName:
-  Enabled: false
+  Exclude:
+    - '**/.tool-versions.rb'
+    - '**/Dangerfile.rb'
+    - '**/Gemfile.rb'
+    - '**/Procfile.dev.rb'
 
 Style/Documentation:
   Enabled: false
 
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
-# TODO: Enable this rule later
-Style/GlobalVars:
-  Enabled: false
-
-# TODO: Enable this rule later
-Style/RegexpLiteral:
-  Enabled: false
-
 Style/TrivialAccessors:
   Exclude:
     - '../template.rb'

.template/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gem 'docker-api' # A lightweight Ruby client for the Docker Remote API

.template/addons/bootstrap/application.scss.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-insert_into_file 'app/assets/stylesheets/application.scss', after: /\/\/ Dependencies\n/ do
+insert_into_file 'app/assets/stylesheets/application.scss', after: %r{// Dependencies\n} do
   <<~SCSS
     @import './vendor';
   SCSS

.template/addons/devise/Gemfile.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 insert_into_file 'Gemfile', after: /# Authentications & Authorizations.*\n/ do
   <<~RUBY
     gem 'devise' # Authentication solution for Rails with Warden

.template/addons/devise/spec_support.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 file 'spec/support/devise.rb', <<~RUBY
   RSpec.configure do |config|
     config.include Devise::Test::ControllerHelpers, type: :controller

.template/addons/devise/template.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 apply '.template/addons/devise/Gemfile.rb'
 apply '.template/addons/devise/spec_support.rb'
 

.template/addons/docker/template.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 use_source_path __dir__
 
 template 'Dockerfile.tt'

.template/addons/github/template.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 use_source_path __dir__
 
 directory '.github'

.template/addons/heroku/template.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 use_source_path __dir__
 
 template 'Dockerfile.web.tt'

.template/addons/nginx/bin/start.sh.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 insert_into_file 'bin/start.sh', after: "fi\n" do
   <<~SHELL
 

.template/addons/nginx/bin/template.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 use_source_path __dir__
 
 apply 'start.sh.rb'

.template/addons/nginx/config/environments/production.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 gsub_file(
   'config/environments/production.rb',
   /config.public_file_server.enabled.*/,

.template/addons/nginx/config/template.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 use_source_path __dir__
 
 apply 'config/environments/production.rb'

.template/addons/nginx/docker.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 insert_into_file 'Dockerfile', after: 'unzip ' do
   'nginx '
 end
 
-insert_into_file 'Dockerfile', after: %r{WORKDIR.+\n} do
+insert_into_file 'Dockerfile', after: /WORKDIR.+\n/ do
   <<~DOCKERFILE
 
     # Nginx config

.template/addons/nginx/template.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 use_source_path __dir__
 
 apply 'bin/template.rb'

.template/addons/phrase_app/spec/codebase/codebase_spec.rb

@@ -1,4 +1,6 @@
-insert_into_file 'spec/codebase/codebase_spec.rb', before: %r{end\Z} do
+# frozen_string_literal: true
+
+insert_into_file 'spec/codebase/codebase_spec.rb', before: /end\Z/ do
   <<~RUBY.indent(2)
 
     # rubocop:disable RSpec/ExampleLength

.template/addons/phrase_app/spec/template.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 apply 'spec/codebase/codebase_spec.rb'

.template/addons/phrase_app/template.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 after_bundle do
   use_source_path __dir__
 

.template/addons/semaphore/template.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 use_source_path __dir__
 
 directory '.semaphore'

.template/addons/slim/template.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 apply '.template/addons/slim/Gemfile.rb'
 apply '.template/addons/slim/Dangerfile.rb'

.template/hooks/before_complete/fix_rubocop.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 def fixing_rubocop
   after_bundle do
     use_source_path __dir__

.template/hooks/before_complete/report.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 def report
   after_bundle do
     say "\n🚀 The project has been successfully created 🚀\n", :green

.template/lib/template.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Template
   require_relative 'template/messages'
   require_relative 'template/errors'

.template/lib/template/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # rubocop:todo Style/ClassAndModuleChildren
 class Template::Errors < Template::Messages; end
 # rubocop:enable Style/ClassAndModuleChildren

.template/lib/template/messages.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # rubocop:todo Style/ClassAndModuleChildren
 class Template::Messages
   delegate :empty?, to: :messages

.template/spec/addons/base/devise/gemfile_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 describe 'Devise Addon - Gemfile' do
   subject { file('Gemfile') }
 

.template/spec/addons/base/devise/template_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 describe 'Devise addon - template' do
   it 'creates the Devise spec support file' do
     expect(file('spec/support/devise.rb')).to exist

.template/spec/addons/base/docker/template_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 describe 'Docker addon - template' do
   it 'creates the Dockerfile' do
     expect(file('Dockerfile')).to exist

.template/spec/addons/base/github/template_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 describe 'Github addon - template' do
   it 'creates the PULL_REQUEST_TEMPLATE file' do
     expect(file('.github/PULL_REQUEST_TEMPLATE.md')).to exist

.template/spec/addons/base/nginx/template_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 describe 'Nginx addon - template' do
   it 'creates the inject_port_into_nginx script' do
     expect(file('bin/inject_port_into_nginx.sh')).to exist

.template/spec/addons/base/phrase_app/template.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 describe 'PhraseApp addon - template' do
   it 'creates .phraseapp.yml file' do
     expect(file('.phraseapp.yml')).to exist

.template/spec/addons/base/semaphore/template_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 describe 'Semaphore addon - template' do
   it 'creates the Dockerfile.web' do
     expect(file('Dockerfile.web')).to exist

.template/spec/addons/variants/api/nginx/template_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 describe 'Nginx addon - template' do
   it 'creates config/nginx/app.conf.template file' do
     expect(file('config/nginx/app.conf.template')).not_to contain('gzip on;')

.template/spec/addons/variants/web/bootstrap/application_js_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 describe 'Bootstrap Addon - application.js' do
   subject { file('app/javascript/application.js') }
 

.template/spec/addons/variants/web/bootstrap/application_scss_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 describe 'Bootstrap Addon - application.scss' do
   subject { file('app/assets/stylesheets/application.scss') }
 

.template/spec/addons/variants/web/bootstrap/package_json_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 describe 'Bootstrap addon - package.json' do
   subject do
     JSON.parse(file('package.json').content)

.template/spec/addons/variants/web/bootstrap/template_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 describe 'Bootstrap addon - template' do
   it 'creates app/assets/stylesheets/vendor/index.scss' do
     expect(file('app/assets/stylesheets/vendor/index.scss')).to exist

.template/spec/addons/variants/web/nginx/template_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 describe 'Nginx addon - template' do
   it 'creates config/nginx/app.conf.template file' do
     expect(file('config/nginx/app.conf.template')).to contain('gzip on;')

.template/spec/addons/variants/web/slim/dangerfile_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 describe 'Slim Addon - Dangerfile' do
   subject { file('Dangerfile') }
 

.template/spec/addons/variants/web/slim/gemfile_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 describe 'Slim Addon - Gemfile' do
   subject { file('Gemfile') }
 

.template/spec/base/app/controllers/concerns/localization_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 describe 'localization concern' do
   subject { file('app/controllers/concerns/localization.rb') }
 

.template/spec/base/application_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 describe 'Application' do
   it 'is listening on port 80' do
     # Config the wait time to 1 minute in case if the container has not fully started.

.template/spec/base/bin/template_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 describe '/bin template' do
   it 'creates the envsetup script' do
     expect(file('bin/envsetup.sh')).to exist

.template/spec/base/config/application_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 describe 'config/application.rb' do
   subject { file('config/application.rb') }
 

.template/spec/base/config/environments/development_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 describe 'config/environments/development.rb' do
   subject { file('config/environments/development.rb') }
 

.template/spec/base/config/environments/production_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 describe 'config/environments/production.rb' do
   subject { file('config/environments/production.rb') }
 

.template/spec/base/config/environments/test_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 describe 'config/environments/test.rb' do
   subject { file('config/environments/test.rb') }
 

.template/spec/base/config/template_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 describe '/config template' do
   it 'creates the Figaro configuration for application variables' do
     expect(file('config/application.yml')).to exist

.template/spec/base/spec/template_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 describe '/spec template' do
   it 'creates the base spec directory' do
     expect(file('spec/codebase')).to be_directory

.template/spec/base/template_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 describe 'Base template' do
   it 'creates Rubocop configuration files' do
     expect(file('.rubocop.yml')).to exist

.template/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rspec/wait'
 
 Dir[[__dir__, 'support', '**', '*.rb'].join('/')].each { |f| require f }

.template/spec/support/serverspec.rb

@@ -1,20 +1,31 @@
+# frozen_string_literal: true
+
 require 'serverspec'
 require 'docker-api'
 
+module ServerSpecHelpers
+  # Prebuild and run docker image before running the test
+  # Because the docker api does not support docker compose
+  def self.test_container
+    container_id = `docker ps -qf "name=#{ENV.fetch('APP_NAME')}_test"`
+
+    Docker::Container.get(container_id.strip)
+  end
+end
+
 RSpec.configure do |config|
   config.before(:suite) do
-    # Prebuild and run docker image before running the test
-    # Because the docker api does not support docker compose
-    container_id = `docker ps -qf "name=#{ENV.fetch('APP_NAME')}_test"`
-    $container = Docker::Container.get(container_id.strip)
+    container = ServerSpecHelpers.test_container
 
     set :os, family: :debian
     set :backend, :docker
-    set :docker_container, $container.id
+    set :docker_container, container.id
   end
 
   config.after(:suite) do
-    $container.stop
-    $container.remove(force: true)
+    container = ServerSpecHelpers.test_container
+
+    container.stop
+    container.remove(force: true)
   end
 end

.template/spec/variants/api/template_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 describe 'Api variant - template' do
   context 'Controllers' do
     it 'creates the localization concern' do

.template/spec/variants/web/app/template_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 describe 'Web variant - /app template' do
   context 'Javascript' do
     it 'creates base javascript directory' do

.template/spec/variants/web/config/application_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 describe 'Web variant - config/application.rb' do
   subject { file('config/application.rb') }