modulorails 1.0.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b121fa34b63e6fbbfdf692179220af29060c9b0efc74f1979add163f88fb4b1
-  data.tar.gz: d88cf22d0ab3638b2c3e9816efbbcfc7560ef182e049a553901cc46d9c00a076
+  metadata.gz: 74b7d68847f4e32d43a53990e8e400702a1c667334ad7c862e2e9f6d4197c31b
+  data.tar.gz: 4aedbb6cc5e066b49f710d43a721f8b3a5a4e6869c98979815f8564b1a34fa5d
 SHA512:
-  metadata.gz: 9a343a8f832ef6c6e3461140c1d4bcca427610424a0dfb81d582503b44b1a37b955c5a6c614166df18870bde41372dabe6658b3d7a57971b8548ed8ba02b2986
-  data.tar.gz: 132aebb2697f088e6a528647b24ef577291eac1796b5d72ea77b3eebd4ac20d2ea32166ece2cf2f0cafb9a483948a024562d8a4f2ad00af055307f2021855021
+  metadata.gz: b079774bb4f3e9cfb2eb18bd31745f641d68712426498a859ac6bb8033b1ab274f1fbb708ff9d8519484d39b2dd28676845ed2809b1d04e622bf849a696bcfe8
+  data.tar.gz: d29668cb45b4078b5d7b780d25281cd700cdb96f1d24e6679af5e6aa8871ae23ce1cc71b613ad1b8522c85b23ddd3c60fad766d62f61916bcbb0f0363e1b4fce

data/.rubocop.yml

@@ -12,27 +12,30 @@
 # Enabling Rails-specific cops.
 require: rubocop-rails
 
+inherit_mode:
+  merge:
+    - Exclude
+    - Include
+
 AllCops:
-  # Disable all cops by default to ease the migration. This will probably be removed one day.
-  DisabledByDefault: true
   # No suggestions since the gem is the sole truth for rubocop configuration.
   SuggestExtensions: false
 
+  # Enable new cops by default
+  NewCops: enable
+
   # Excluding most directories with generated files and directories with configuration files.
   Exclude:
     - 'vendor/**/*'
     - 'db/**/*'
     - 'tmp/**/*'
-    - 'bin/**/*'
-    - 'builds/**/*'
-    - 'Gemfile'
-    - 'config/environments/*'
-    - 'config/puma.rb'
-    - 'config/spring.rb'
-    - 'test/application_system_test_case.rb'
-    - 'test/test_helper.rb'
-    - 'config/initializers/*.rb'
-    - 'spec/spec_helper.rb'
+    - 'bin'
+    - '**/Gemfile'
+    - '**/Guardfile'
+    - '**/Capfile'
+    - '**/Rakefile'
+    - 'config/**/*'
+    - 'test/**/*'
     - 'node_modules/**/*'
     - 'spec/**/*'
 
@@ -60,3 +63,204 @@ Style/QuotedSymbols:
 Lint/SymbolConversion:
   Enabled: true
   EnforcedStyle: strict
+
+# Useless cop. It checks for unnecessary safe navigations.
+# Example:
+# obj&.a && obj.b
+# Triggers rubocop error: it requires to add safe navigation for "obj.b" call => "obj&.b".
+# but it is not necessary. obj&.a will return nil if obj is nil, and it will stop
+# execution of the operation because `&&` right part executes only when left part is truthy.
+Lint/SafeNavigationConsistency:
+  Enabled: false
+
+# Checks for places where keyword arguments can be used instead of boolean arguments when defining methods.
+# Disabled because moving from default arguments to keywords is not that easy.
+Style/OptionalBooleanParameter:
+  Enabled: false
+
+# Checks for use of the lambda.(args) syntax.
+# Disabled while the Ruby team has not voted on this.
+Style/LambdaCall:
+  Enabled: false
+  EnforcedStyle: braces
+
+# Checks for presence or absence of braces around hash literal as a last array item depending on configuration.
+# Disabled because it would break a lot of permitted_params definitions
+Style/HashAsLastArrayItem:
+  Enabled: false
+
+# Checks for grouping of accessors in class and module bodies.
+# Useless.
+Style/AccessorGrouping:
+  Enabled: false
+
+# Makes our lives happier: we don't need to disable it in each case/when method
+# with more than 5 "when"s.
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+# Commonly used screens these days easily fit more than 80 characters.
+Layout/LineLength:
+  Max: 100
+
+# Too short methods lead to extraction of single-use methods, which can make
+# the code easier to read (by naming things), but can also clutter the class
+Metrics/MethodLength:
+  Max: 20
+
+# The guiding principle of classes is SRP, SRP can't be accurately measured by LoC
+Metrics/ClassLength:
+  Max: 1500
+
+# No space makes the method definition shorter and differentiates
+# from a regular assignment.
+Layout/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+
+# We do not need to support Ruby 1.9, so this is good to use.
+Style/SymbolArray:
+  Enabled: true
+
+# Most readable form.
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+# Mixing the styles looks just silly.
+Style/HashSyntax:
+  EnforcedStyle: ruby19_no_mixed_keys
+
+# has_key? and has_value? are far more readable than key? and value?
+Style/PreferredHashMethods:
+  Enabled: false
+
+# String#% is by far the least verbose and only object oriented variant.
+Style/FormatString:
+  EnforcedStyle: percent
+
+# Annotated or template are too verbose and rarely needed.
+Style/FormatStringToken:
+  EnforcedStyle: unannotated
+
+Style/CollectionMethods:
+  Enabled: true
+  PreferredMethods:
+    # inject seems more common in the community.
+    reduce: "inject"
+
+# Either allow this style or don't. Marking it as safe with parenthesis
+# is silly. Let's try to live without them for now.
+Style/ParenthesesAroundCondition:
+  AllowSafeAssignment: false
+Lint/AssignmentInCondition:
+  AllowSafeAssignment: false
+
+# A specialized exception class will take one or more arguments and construct the message from it.
+# So both variants make sense.
+Style/RaiseArgs:
+  Enabled: false
+
+# Indenting the chained dots beneath each other is not supported by this cop,
+# see https://github.com/bbatsov/rubocop/issues/1633
+Layout/MultilineOperationIndentation:
+  Enabled: false
+
+# Fail is an alias of raise. Avoid aliases, it's more cognitive load for no gain.
+# The argument that fail should be used to abort the program is wrong too,
+# there's Kernel#abort for that.
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+# Suppressing exceptions can be perfectly fine, and be it to avoid to
+# explicitly type nil into the rescue since that's what you want to return,
+# or suppressing LoadError for optional dependencies
+Lint/SuppressedException:
+  Enabled: false
+
+# { ... } for multi-line blocks is okay, follow Weirichs rule instead:
+# https://web.archive.org/web/20140221124509/http://onestepback.org/index.cgi/Tech/Ruby/BraceVsDoEnd.rdoc
+Style/BlockDelimiters:
+  Enabled: false
+
+# do / end blocks should be used for side effects,
+# methods that run a block for side effects and have
+# a useful return value are rare, assign the return
+# value to a local variable for those cases.
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+
+# Enforcing the names of variables? To single letter ones? Just no.
+Style/SingleLineBlockParams:
+  Enabled: false
+
+# Shadowing outer local variables with block parameters is often useful
+# to not reinvent a new name for the same thing, it highlights the relation
+# between the outer variable and the parameter. The cases where it's actually
+# confusing are rare, and usually bad for other reasons already, for example
+# because the method is too long.
+Lint/ShadowingOuterLocalVariable:
+  Enabled: false
+
+# Check with yard instead.
+Style/Documentation:
+  Enabled: false
+
+# This is just silly. Calling the argument `other` in all cases makes no sense.
+Naming/BinaryOperatorParameterName:
+  Enabled: false
+
+# Disable frozen string
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# Disable No ASCII char in comments
+Style/AsciiComments:
+  Enabled: false
+
+# Disable ordered Gems By ascii
+Bundler/OrderedGems:
+  Enabled: false
+
+# Change ABC max value
+Metrics/AbcSize:
+  Max: 35
+
+# Disable empty method in one line
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+# Disable max height block
+Metrics/BlockLength:
+  Enabled: true
+  Exclude:
+    - 'app/admin/**/*'
+
+# Checks if empty lines around the bodies of classes match the configuration.
+Layout/EmptyLinesAroundClassBody:
+  EnforcedStyle: empty_lines
+# Checks if empty lines around the bodies of modules match the configuration.
+Layout/EmptyLinesAroundModuleBody:
+  EnforcedStyle: empty_lines
+
+# Enforces the consistent usage of %-literal delimiters.
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    default: '()'
+    '%i': '[]'
+    '%I': '[]'
+    '%r': '{}'
+    '%w': '[]'
+    '%W': '[]'
+
+# Unnecessary cop. In what universe "A || B && C" or "A && B || C && D" is ambiguous? looks
+# like a cop for those who can't in boolean.
+Lint/AmbiguousOperatorPrecedence:
+  Enabled: false
+
+# Checks for simple usages of parallel assignment.
+Style/ParallelAssignment:
+  Enabled: false
+
+# Checks the style of children definitions at classes and modules.
+Style/ClassAndModuleChildren:
+  Enabled: false

data/Appraisals

@@ -1,18 +1,18 @@
-appraise "rails-52" do
+appraise 'rails-52' do
   gem 'rails', '~> 5.2', '>= 5.2.6'
 end
 
-appraise "rails-60" do
+appraise 'rails-60' do
   gem 'rails', '~> 6.0', '>= 6.0.4.4'
 end
 
-appraise "rails-61" do
+appraise 'rails-61' do
   gem 'rails', '~> 6.1', '>= 6.1.4.4'
 end
 
 # Rails 7 requires at least Ruby 2.7
 if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.7')
-    appraise "rails-70" do
-      gem 'rails', '~> 7.0'
-    end
+  appraise 'rails-70' do
+    gem 'rails', '~> 7.0'
+  end
 end

data/CHANGELOG.md

@@ -2,6 +2,24 @@
 
 This file is used to list changes made in each version of the gem.
 
+# 1.2.0
+
+The 'audit' release.
+
+- Add bundler-audit in CI.
+- Make the rubocop configuration work during CI.
+- Fix generation of .gitlab-ci.yml for PG databases.
+- Remove deprecated `--deployment` flag from Dockerfile.prod
+
+# 1.1.0
+
+The 'new project' release.
+
+- Add lot of Rubocop rules.
+- Fix rubocop offenses for the gem.
+- Ensure Modulorails will work with Moduloproject.
+- Add `webpacker`, `importmap` and `jsbundling` versions to `Modulorails::Data`.
+
 # 1.0.2
 
 Fix error in with_transaction: `uninitialized constant Modulorails::BaseService::ErrorData`.

data/app/helpers/modulorails/application_helper.rb

@@ -1,8 +1,10 @@
 # @author Matthieu CIAPPARA <ciappa_m@modulotech.fr>
 module Modulorails::ApplicationHelper
+
   def powered_by
-    link_to('https://www.modulotech.fr/', target: '_blank', class: 'modulolink') do
-      raw("Powered by modulo<span>Tech</span>")
+    link_to('https://www.modulotech.fr/', target: '_blank', class: 'modulolink', rel: 'noopener') do
+      safe_join(['Powered by modulo', content_tag(:span, 'Tech')])
     end
   end
+
 end

data/gemfiles/rails_52.gemfile

@@ -1,9 +1,9 @@
 # This file was generated by Appraisal
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"
-gem "rails", "~> 5.2", ">= 5.2.6"
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+gem 'rails', '~> 5.2', '>= 5.2.6'
 
-gemspec path: "../"
+gemspec path: '../'

data/gemfiles/rails_60.gemfile

@@ -1,9 +1,9 @@
 # This file was generated by Appraisal
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"
-gem "rails", "~> 6.0", ">= 6.0.4.4"
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+gem 'rails', '~> 6.0', '>= 6.0.4.4'
 
-gemspec path: "../"
+gemspec path: '../'

data/gemfiles/rails_61.gemfile

@@ -1,9 +1,9 @@
 # This file was generated by Appraisal
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"
-gem "rails", "~> 6.1", ">= 6.1.4.4"
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+gem 'rails', '~> 6.1', '>= 6.1.4.4'
 
-gemspec path: "../"
+gemspec path: '../'

data/gemfiles/rails_70.gemfile

@@ -1,9 +1,9 @@
 # This file was generated by Appraisal
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"
-gem "rails", "~> 7.0"
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+gem 'rails', '~> 7.0'
 
-gemspec path: "../"
+gemspec path: '../'

data/lib/generators/modulorails/bundleraudit/bundleraudit_generator.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+class Modulorails::BundlerauditGenerator < Rails::Generators::Base
+
+  source_root File.expand_path('templates', __dir__)
+  desc 'This generator creates a configuration for Bundler-Audit'
+
+  def create_config_files
+    gitlab_config_path       = Rails.root.join('.gitlab-ci.yml')
+
+    return if File.read(gitlab_config_path).match?(/\s+extends:\s+.bundleraudit\s*$/)
+
+    append_file gitlab_config_path do
+      <<~YAML
+        # Scan Gemfile.lock for Common Vulnerabilities and Exposures
+        # https://en.wikipedia.org/wiki/Common_Vulnerabilities_and_Exposures
+        # https://www.cve.org/
+        bundleraudit:
+          extends: .bundleraudit
+      YAML
+    end
+  end
+
+end

data/lib/generators/modulorails/docker/docker_generator.rb

@@ -3,6 +3,7 @@
 require 'rails/generators'
 
 class Modulorails::DockerGenerator < Rails::Generators::Base
+
   source_root File.expand_path('templates', __dir__)
   desc 'This generator creates Dockerfiles for an app'
 
@@ -12,8 +13,16 @@ class Modulorails::DockerGenerator < Rails::Generators::Base
     template 'docker-compose.yml'
     template 'docker-compose.prod.yml'
     template 'entrypoints/docker-entrypoint.sh'
+    chmod 'entrypoints/docker-entrypoint.sh', 0755
     template 'config/database.yml'
+
+    # Useless unless project is using Webpacker
+    if Modulorails.data.webpacker_version.present?
+      template 'entrypoints/webpack-entrypoint.sh'
+      chmod 'entrypoints/webpack-entrypoint.sh', 0755
+    end
   rescue StandardError => e
-    $stderr.puts("[Modulorails] Error: cannot generate Docker configuration: #{e.message}")
+    warn("[Modulorails] Error: cannot generate Docker configuration: #{e.message}")
   end
+
 end

data/lib/generators/modulorails/docker/templates/Dockerfile.prod.tt

@@ -10,6 +10,7 @@ RUN apk add --update --no-cache \
     tzdata \
     yarn \
     shared-mime-info \
+    gcompat \
     <%- adapter = Modulorails.data.adapter -%>
     <%- if adapter =~ /mysql/ -%>
     mysql-dev
@@ -19,7 +20,8 @@ RUN apk add --update --no-cache \
 RUN gem install bundler -v <%= Modulorails.data.bundler_version %>
 
 COPY Gemfile Gemfile.lock ./
-RUN bundle check || bundle install --deployment --jobs=2 \
+RUN bundle config set --local deployment 'true'
+RUN bundle check || bundle install --jobs=2 \
     && rm -rf vendor/bundle/ruby/*/cache/*
 
 COPY package.json yarn.lock ./
@@ -31,6 +33,8 @@ RUN bundle exec rake assets:precompile
 # FINAL IMAGE
 FROM ruby:<%= Modulorails.data.ruby_version %>-alpine
 
+ENV RAILS_ENV=development
+ENV EDITOR=vim
 WORKDIR /app
 
 RUN apk add --update --no-cache \
@@ -39,6 +43,7 @@ RUN apk add --update --no-cache \
     nodejs \
     tzdata \
     shared-mime-info \
+    vim \
     <%- adapter = Modulorails.data.adapter -%>
     <%- if adapter =~ /mysql/ -%>
     mysql-dev \

data/lib/generators/modulorails/docker/templates/Dockerfile.tt

@@ -1,6 +1,7 @@
 FROM ruby:<%= Modulorails.data.ruby_version %>-alpine
 
 ENV RAILS_ENV=development
+ENV EDITOR=vim
 WORKDIR /app
 
 RUN apk add --update --no-cache \
@@ -8,6 +9,8 @@ RUN apk add --update --no-cache \
     nodejs \
     yarn \
     tzdata \
+    gcompat \
+    vim \
     <%- adapter = Modulorails.data.adapter -%>
     <%- if adapter =~ /mysql/ -%>
     mysql-dev

data/lib/generators/modulorails/docker/templates/config/database.yml.tt

@@ -13,7 +13,7 @@ development: &default
   port: <%%= ENV.fetch('<%= upper_image_name %>_DATABASE_PORT', 3306) %>
 <%- else -%>
 development: &default
-  adapter: pg
+  adapter: postgresql
   database: <%%= ENV.fetch('<%= upper_image_name %>_DATABASE_NAME', '<%= image_name %>') %>
   username: <%%= ENV.fetch('<%= upper_image_name %>_DATABASE_USERNAME', 'postgres') %>
   password: <%%= ENV.fetch('<%= upper_image_name %>_DATABASE_PASSWORD', 'postgres') %>

data/lib/generators/modulorails/docker/templates/docker-compose.yml.tt

@@ -20,6 +20,8 @@ services:
       <%= image_name.upcase %>_DATABASE_HOST: database
       <%= image_name.upcase %>_DATABASE_NAME: <%= image_name %>
     entrypoint: ./entrypoints/docker-entrypoint.sh
+    stdin_open: true
+    tty: true
 
   <%- adapter = Modulorails.data.adapter -%>
   <%- if adapter =~ /mysql/ -%>
@@ -52,7 +54,9 @@ services:
     ports:
       - 1080:80
 
- webpack:
+  <%- webpack_container_needed = Modulorails.data.webpacker_version.present? -%>
+  <%- if webpack_container_needed -%>
+  webpack:
    image: modulotechgroup/<%= image_name %>:dev
    build:
      context: .
@@ -66,6 +70,7 @@ services:
      NODE_ENV: development
      RAILS_ENV: development
      WEBPACKER_DEV_SERVER_HOST: 0.0.0.0
+  <%- end-%>
 
 volumes:
   db_data:

data/lib/generators/modulorails/docker/templates/entrypoints/docker-entrypoint.sh.tt

@@ -4,8 +4,8 @@
 set -e
 
 # No `node_modules` directory means `yarn install` was never launched.
-# It is mandatory to install yarn dependencies.
-if [ ! -d node_modules ]
+# It is mandatory to install yarn dependencies IF there is a `package.json` file.
+if [ -f package.json ] && [ ! -d node_modules ]
 then
   yarn install
 fi

data/lib/generators/modulorails/gitlabci/gitlabci_generator.rb

@@ -3,6 +3,7 @@
 require 'rails/generators'
 
 class Modulorails::GitlabciGenerator < Rails::Generators::Base
+
   source_root File.expand_path('templates', __dir__)
   desc 'This generator creates a template for a .gitlab-ci.yml file at root'
 
@@ -17,7 +18,7 @@ class Modulorails::GitlabciGenerator < Rails::Generators::Base
     # Create file to avoid this generator on next modulorails launch
     create_keep_file
   rescue StandardError => e
-    $stderr.puts("[Modulorails] Error: cannot generate CI configuration: #{e.message}")
+    warn("[Modulorails] Error: cannot generate CI configuration: #{e.message}")
   end
 
   private
@@ -29,6 +30,7 @@ class Modulorails::GitlabciGenerator < Rails::Generators::Base
     copy_file(file, file)
 
     say "Add #{file} to git"
-    %x(git add #{file})
+    `git add #{file}`
   end
+
 end

data/lib/generators/modulorails/gitlabci/templates/.gitlab-ci.yml.tt

@@ -17,9 +17,16 @@ services:
 
 variables:
   IMAGE_NAME: <%= image_name %>
+  <%- if adapter =~ /mysql/ -%>
   MYSQL_DATABASE: <%= image_name %>_test
   MYSQL_ALLOW_EMPTY_PASSWORD: 'true'
   <%= image_name.upcase %>_DATABASE_HOST: mysql
+  <%- else -%>
+  POSTGRES_DB: <%= image_name %>_test
+  POSTGRES_USER: postgres
+  POSTGRES_PASSWORD: postgres
+  <%= image_name.upcase %>_DATABASE_HOST: postgres
+  <%- end -%>
 
 stages:
   - test

data/lib/generators/modulorails/healthcheck/health_check_generator.rb

@@ -3,6 +3,7 @@
 require 'rails/generators'
 
 class Modulorails::HealthCheckGenerator < Rails::Generators::Base
+
   source_root File.expand_path('templates', __dir__)
   desc 'This generator creates a configuration for the health_check gem'
 
@@ -12,9 +13,10 @@ class Modulorails::HealthCheckGenerator < Rails::Generators::Base
 
     # Add the route
     unless File.read(Rails.root.join('config/routes.rb')).match?('health_check_routes')
-      inject_into_file 'config/routes.rb', after: "Rails.application.routes.draw do\n" do <<~'RUBY'
-        health_check_routes
-      RUBY
+      inject_into_file 'config/routes.rb', after: "Rails.application.routes.draw do\n" do
+        <<~'RUBY'
+          health_check_routes
+        RUBY
       end
     end
 
@@ -24,7 +26,7 @@ class Modulorails::HealthCheckGenerator < Rails::Generators::Base
     # Create file to avoid this generator on next modulorails launch
     create_keep_file
   rescue StandardError => e
-    $stderr.puts("[Modulorails] Error: cannot generate health_check configuration: #{e.message}")
+    warn("[Modulorails] Error: cannot generate health_check configuration: #{e.message}")
   end
 
   private
@@ -36,6 +38,7 @@ class Modulorails::HealthCheckGenerator < Rails::Generators::Base
     copy_file(file, file)
 
     say "Add #{file} to git"
-    %x(git add #{file})
+    `git add #{file}`
   end
+
 end

data/lib/generators/modulorails/rubocop/rubocop_generator.rb

@@ -3,6 +3,7 @@
 require 'rails/generators'
 
 class Modulorails::RubocopGenerator < Rails::Generators::Base
+
   source_root File.expand_path('templates', __dir__)
   desc 'This generator creates a configuration for Rubocop'
 
@@ -10,15 +11,16 @@ class Modulorails::RubocopGenerator < Rails::Generators::Base
     rubocop_config_path = Rails.root.join('.rubocop.yml')
     gitlab_config_path  = Rails.root.join('.gitlab-ci.yml')
 
-    template "rubocop.yml", rubocop_config_path, force: true
+    template 'rubocop.yml', rubocop_config_path, force: true
+
+    return if File.read(gitlab_config_path).match?(/\s+extends:\s+.lint\s*$/)
 
-    unless File.read(gitlab_config_path).match?(/\s+extends:\s+.lint\s*$/)
-      append_file gitlab_config_path do
-        <<~YAML
+    append_file gitlab_config_path do
+      <<~YAML
         rubocop:
           extends: .lint
-        YAML
-      end
+      YAML
     end
   end
+
 end