modulorails 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47ac5a151c8230d9ff0e9b775d32bd2a27eddbea284cf30aacf0bc863eb65a47
-  data.tar.gz: 180b663722790df15a3e180fbfe32a13f8743a57e28f6d74005d93ee08bf98b0
+  metadata.gz: 38bfc28b69038bd12e6db5b86c5a81fc29aab339896ee1b2b47429ed6d12c4fe
+  data.tar.gz: 0b0a203652556def30c6e3471acd7e35fecf834310d94d21f58766acafaf9f5b
 SHA512:
-  metadata.gz: a90d84b0c21e644e07d097e6c00b77af37dbfe1d43b1e1b4f75fd614fc7bc87bf86a93343e1362ab78a4321f1f1081bad4e3605a7c10dee082ab31cc346d102d
-  data.tar.gz: 9bcdf33285526a1ecca9dee4b05ab6d5f343280f8e9ec34427e428ab52786a11ab3235cf5ed77c5a1eb59163ff1dfb54d905c280068cf0f10032e47379c3c0e6
+  metadata.gz: d68c37e214e7e996b586775a4f74c805d78c6d6a9f1745e1abfe38ca323b7ce82265f94c89219f2bfa811c92b02b4c160daa8751097019cc1be919844b184009
+  data.tar.gz: 346739b57ded95ac5c96684c4e9d91af1867b4713741d7e71d6484b3ddc68ec651feef1c863c318ab6684f2fa9a93df8ddfb20956880a37e9a87962f21f9414e

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 This file is used to list changes made in each version of the gem.
 
+# 1.3.0
+
+- Update redis configuration in generators.
+- Update mailcatcher docker image for better compatibility with ARM64.
+- Remove possible suffix `Service` in service generator.
+- Update rubocop configuration in template.
+- Add a generator to add Sidekiq to a project.
+- Update docker generator to use valid names for environment variables.
+
 # 1.2.1
 
 - Update rubocop configuration.

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

@@ -15,6 +15,7 @@ class Modulorails::DockerGenerator < Rails::Generators::Base
     template 'entrypoints/docker-entrypoint.sh'
     chmod 'entrypoints/docker-entrypoint.sh', 0755
     template 'config/database.yml'
+    template 'config/cable.yml'
 
     # Useless unless project is using Webpacker
     if Modulorails.data.webpacker_version.present?

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

@@ -0,0 +1,15 @@
+redis_local: &redis_local
+  adapter: redis
+  url: <%= ENV.fetch('REDIS_URL', 'redis://redis:6379') %>
+
+development:
+  <<: *redis_local
+
+test:
+  <<: *redis_local
+
+staging:
+  <<: *redis_local
+
+production:
+  <<: *redis_local

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

@@ -1,29 +1,29 @@
 <%- image_name = Modulorails.data.name.parameterize -%>
-<%- upper_image_name = image_name.upcase -%>
+<%- environment_name = Modulorails.data.environment_name -%>
 <%- adapter = Modulorails.data.adapter -%>
 <%- if adapter =~ /mysql/ -%>
 development: &default
   adapter: mysql2
   encoding: utf8mb4
   collation: utf8mb4_unicode_ci
-  database: <%%= ENV.fetch('<%= upper_image_name %>_DATABASE_NAME', '<%= image_name %>') %>
-  username: <%%= ENV.fetch('<%= upper_image_name %>_DATABASE_USERNAME', 'root') %>
-  password: <%%= ENV.fetch('<%= upper_image_name %>_DATABASE_PASSWORD', '') %>
-  host: <%%= ENV.fetch('<%= upper_image_name %>_DATABASE_HOST', 'database') %>
-  port: <%%= ENV.fetch('<%= upper_image_name %>_DATABASE_PORT', 3306) %>
+  database: <%%= ENV.fetch('<%= environment_name %>_DATABASE_NAME', '<%= image_name %>') %>
+  username: <%%= ENV.fetch('<%= environment_name %>_DATABASE_USERNAME', 'root') %>
+  password: <%%= ENV.fetch('<%= environment_name %>_DATABASE_PASSWORD', '') %>
+  host: <%%= ENV.fetch('<%= environment_name %>_DATABASE_HOST', 'database') %>
+  port: <%%= ENV.fetch('<%= environment_name %>_DATABASE_PORT', 3306) %>
 <%- else -%>
 development: &default
   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') %>
-  host: <%%= ENV.fetch('<%= upper_image_name %>_DATABASE_HOST', 'database') %>
-  port: <%%= ENV.fetch('<%= upper_image_name %>_DATABASE_PORT', 5432) %>
+  database: <%%= ENV.fetch('<%= environment_name %>_DATABASE_NAME', '<%= image_name %>') %>
+  username: <%%= ENV.fetch('<%= environment_name %>_DATABASE_USERNAME', 'postgres') %>
+  password: <%%= ENV.fetch('<%= environment_name %>_DATABASE_PASSWORD', 'postgres') %>
+  host: <%%= ENV.fetch('<%= environment_name %>_DATABASE_HOST', 'database') %>
+  port: <%%= ENV.fetch('<%= environment_name %>_DATABASE_PORT', 5432) %>
 <%- end -%>
 
 test:
   <<: *default
-  database: <%%= ENV.fetch('<%= upper_image_name %>_TEST_DATABASE_NAME', '<%= image_name %>_test') %>
+  database: <%%= ENV.fetch('<%= environment_name %>_TEST_DATABASE_NAME', '<%= image_name %>_test') %>
 
 staging:
   <<: *default

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

@@ -1,6 +1,7 @@
 version: '3.7'
 
 <%- image_name = Modulorails.data.name.parameterize -%>
+<%- environment_name = Modulorails.data.environment_name -%>
 services:
   app:
     image: modulotechgroup/<%= image_name %>
@@ -15,9 +16,10 @@ services:
     environment:
       RAILS_ENV: production
       URL: http://localhost:3000
-      <%= image_name.upcase %>_DATABASE_HOST: database
-      <%= image_name.upcase %>_DATABASE_NAME: <%= image_name %>
+      <%= environment_name %>_DATABASE_HOST: database
+      <%= environment_name %>_DATABASE_NAME: <%= image_name %>
       RAILS_SERVE_STATIC_FILES: 'true'
+      REDIS_URL: redis://redis:6379/1
 
   <%- adapter = Modulorails.data.adapter -%>
   <%- if adapter =~ /mysql/ -%>

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

@@ -1,6 +1,7 @@
 version: '3.7'
 
 <%- image_name = Modulorails.data.name.parameterize -%>
+<%- environment_name = Modulorails.data.environment_name -%>
 services:
   app:
     image: modulotechgroup/<%= image_name %>:dev
@@ -17,8 +18,9 @@ services:
     environment:
       RAILS_ENV: development
       URL: http://localhost:3000
-      <%= image_name.upcase %>_DATABASE_HOST: database
-      <%= image_name.upcase %>_DATABASE_NAME: <%= image_name %>
+      <%= environment_name %>_DATABASE_HOST: database
+      <%= environment_name %>_DATABASE_NAME: <%= image_name %>
+      REDIS_URL: redis://redis:6379/1
     entrypoint: ./entrypoints/docker-entrypoint.sh
     stdin_open: true
     tty: true
@@ -50,9 +52,9 @@ services:
     image: redis:6.2-alpine
 
   mailcatcher:
-    image: tophfr/mailcatcher
+    image: dockage/mailcatcher
     ports:
-      - 1080:80
+      - 1080:1080
 
   <%- webpack_container_needed = Modulorails.data.webpacker_version.present? -%>
   <%- if webpack_container_needed -%>

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

@@ -1,4 +1,5 @@
 <%- image_name = Modulorails.data.name.parameterize -%>
+<%- environment_name = Modulorails.data.environment_name -%>
 include:
   - project: 'modulosource/modulotech/devops/gitlab-ci-templates'
     file:
@@ -20,12 +21,12 @@ variables:
   <%- if adapter =~ /mysql/ -%>
   MYSQL_DATABASE: <%= image_name %>_test
   MYSQL_ALLOW_EMPTY_PASSWORD: 'true'
-  <%= image_name.upcase %>_DATABASE_HOST: mysql
+  <%= environment_name %>_DATABASE_HOST: mysql
   <%- else -%>
   POSTGRES_DB: <%= image_name %>_test
   POSTGRES_USER: postgres
   POSTGRES_PASSWORD: postgres
-  <%= image_name.upcase %>_DATABASE_HOST: postgres
+  <%= environment_name %>_DATABASE_HOST: postgres
   <%- end -%>
 
 stages:

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

@@ -13,11 +13,7 @@ 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
-      end
+      inject_into_file 'config/routes.rb', "  health_check_routes\n\n", after: "Rails.application.routes.draw do\n"
     end
 
     # Update the gem and the Gemfile.lock

data/lib/generators/modulorails/healthcheck/templates/config/initializers/health_check.rb.tt

@@ -83,7 +83,7 @@ HealthCheck.setup do |config|
   # config.rabbitmq_config = {}
 
   # When redis url/password is non-standard
-  config.redis_url = ENV['REDIS_URL']
+  config.redis_url = ENV.fetch('REDIS_URL', 'redis://redis:6379')
   # Only included if set, as url can optionally include passwords as well
   # config.redis_password = 'redis_password' # default ENV['REDIS_PASSWORD']
 

data/lib/generators/modulorails/rubocop/templates/rubocop.yml.tt

@@ -101,12 +101,12 @@ Metrics/CyclomaticComplexity:
 
 # Commonly used screens these days easily fit more than 80 characters.
 Layout/LineLength:
-  Max: 100
+  Max: 120
 
 # 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
+  Max: 25
 
 # The guiding principle of classes is SRP, SRP can't be accurately measured by LoC
 Metrics/ClassLength:
@@ -265,3 +265,7 @@ Style/ParallelAssignment:
 # Checks the style of children definitions at classes and modules.
 Style/ClassAndModuleChildren:
   Enabled: false
+
+# Useful to display but it really is a bother to change it: hence the `info` severity.
+Rails/I18nLocaleTexts:
+  Severity: info

data/lib/generators/modulorails/service/USAGE

@@ -0,0 +1,14 @@
+Description:
+    Generates a new Modulorails service. Pass the service name, either
+    CamelCased or under_scored, and a list of parameters as arguments.
+
+    To create a service within a module, specify the service name as a
+    path like 'parent_module/service_name'.
+
+    This generates a service class in app/services.
+
+Example:
+    `bin/rails generate modulorails:service Missions::Search word page per`
+
+    Mission::Search service with positional parameters word, page and per.
+        Service: app/services/missions/search_service.rb

data/lib/generators/modulorails/service/service_generator.rb

@@ -8,8 +8,20 @@ class Modulorails::ServiceGenerator < Rails::Generators::NamedBase
   desc 'This generator creates a service inheriting Modulorails::BaseService'
   argument :arguments, type: :array, default: [], banner: 'argument argument'
 
+  check_class_collision suffix: "Service"
+
   def create_service_files
     template 'service.rb', File.join('app/services', class_path, "#{file_name}_service.rb")
   end
 
+  private
+
+  def file_name
+    @_file_name ||= remove_possible_suffix(super)
+  end
+
+  def remove_possible_suffix(name)
+    name.sub(/_?service$/i, '')
+  end
+
 end

data/lib/generators/modulorails/sidekiq/sidekiq_generator.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+class Modulorails::SidekiqGenerator < Rails::Generators::Base
+
+  source_root File.expand_path('templates', __dir__)
+
+  desc 'This generator adds Sidekiq to the project'
+
+  def add_to_docker_compose
+    add_to_docker_compose_yml_file(Rails.root.join('docker-compose.yml'))
+  end
+
+  def add_to_docker_compose_prod
+    add_to_docker_compose_yml_file(Rails.root.join('docker-compose.prod.yml'))
+  end
+
+  def add_to_gemfile
+    gemfile_path = Rails.root.join('Gemfile')
+
+    # Add gem redis unless already present
+    unless File.read(gemfile_path).match?(/^\s*gem ['"]redis['"]/)
+      append_to_file(gemfile_path, "gem 'redis'\n")
+    end
+
+    # Add gem sidekiq unless already present
+    unless File.read(gemfile_path).match?(/^\s*gem ['"]sidekiq['"]/)
+      append_to_file(gemfile_path, "gem 'sidekiq'\n")
+    end
+  end
+
+  def add_to_config
+    Dir.glob(Rails.root.join('config/environments/*.rb')) do |file|
+      add_to_config_file(file)
+    end
+  end
+
+  def add_initializer
+    template 'config/initializers/sidekiq.rb'
+  end
+
+  def add_routes
+    routes_path = Rails.root.join('config/routes.rb')
+
+    unless File.read(routes_path).match?(%r{require ['"]sidekiq/web["']})
+      inject_into_file routes_path, after: "Rails.application.routes.draw do\n" do
+        <<-RUBY
+  require 'sidekiq/web'
+  mount Sidekiq::Web => '/sidekiq'
+
+        RUBY
+      end
+    end
+  end
+
+  def add_health_check
+    file_path = Rails.root.join('config/initializers/health_check.rb')
+
+    unless File.read(file_path).match?(%r{add_custom_check\s*\(?\s*['"]sidekiq-queues['"]\s*\)?})
+      inject_into_file file_path, after: /^HealthCheck.setup do \|config\|\n$/ do
+        <<-RUBY
+
+  # Add one or more custom checks that return a blank string if ok, or an error message if there is an error
+  config.add_custom_check('sidekiq-queues') do
+    queues = Sidekiq::Queue.all
+
+    # No queues, means no jobs, ok!
+    next '' if queues.empty?
+
+    enqueued_jobs_count = queues.each.map { |queue| queue.count }.sum
+
+    # Less than 200 enqueued jobs, ok!
+    enqueued_jobs_count < 200 ? '' : "\#{enqueued_jobs_count} are currently enqueued."
+  end
+
+  # Add one or more custom checks that return a blank string if ok, or an error message if there is an error
+  config.add_custom_check('sidekiq-retries') do
+    retry_jobs_count = Sidekiq::RetrySet.new.count
+
+    # Less than 200 jobs to retry, ok!
+    retry_jobs_count < 200 ? '' : "\#{retry_jobs_count} are waiting for retry."
+  end
+        RUBY
+      end
+    end
+  end
+
+  def add_entrypoint
+    template 'entrypoints/sidekiq-entrypoint.sh'
+    chmod 'entrypoints/sidekiq-entrypoint.sh', 0755
+  end
+
+  private
+
+  def add_to_docker_compose_yml_file(file_path)
+    @image_name ||= Modulorails.data.name.parameterize
+
+    # Create docker-compose.yml unless present
+    unless File.exist?(file_path)
+      # Modulorails::GitlabciGenerator.new([], {}, {}).invoke_all
+      invoke(Modulorails::DockerGenerator, [])
+    end
+
+    return if File.read(file_path).match?(/^ {2}sidekiq:$/)
+
+    insert_into_file file_path, after: /^services:/ do
+      <<-YAML
+
+  sidekiq:
+    image: modulotechgroup/#{@image_name}:dev
+    build:
+      context: .
+      dockerfile: Dockerfile
+    depends_on:
+      - database
+      - redis
+    volumes:
+      - .:/app
+    environment:
+      RAILS_ENV: development
+      URL: http://app:3000
+      #{@image_name.upcase}_DATABASE_HOST: database
+      #{@image_name.upcase}_DATABASE_NAME: #{@image_name}
+      REDIS_URL: redis://redis:6379/1
+    entrypoint: ./entrypoints/sidekiq-entrypoint.sh
+    stdin_open: true
+    tty: true
+      YAML
+    end
+  end
+
+  def add_to_config_file(file_path)
+    pattern = /^(?>\s*)(?>#\s*)?(\w+)\.active_job\.queue_adapter = .+$/
+
+    if File.read(file_path).match?(pattern)
+      gsub_file file_path, pattern, '  \1.active_job.queue_adapter = :sidekiq'
+    else
+      append_file file_path, after: "configure do\n" do
+        <<-RUBY
+  config.active_job.queue_adapter = :sidekiq
+        RUBY
+      end
+    end
+  end
+end

data/lib/generators/modulorails/sidekiq/templates/config/initializers/sidekiq.rb.tt

@@ -0,0 +1,9 @@
+redis_url = Rails.application.config_for('cable')['url']
+
+Sidekiq.configure_server do |config|
+  config.redis = { url: redis_url }
+end
+
+Sidekiq.configure_client do |config|
+  config.redis = { url: redis_url }
+end

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

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+# Exit immediately if a command exits with a non-zero status
+set -e
+
+# Launch Sidekiq
+exec ./bin/bundle exec sidekiq

data/lib/modulorails/data.rb

@@ -15,6 +15,7 @@ module Modulorails
       bundler_version modulorails_version adapter db_version adapter_version webpacker_version
       importmap_version jsbundling_version
       production_url staging_url review_base_url
+      environment_name
     ].freeze
 
     # Useful if the gem's user need to read one of the data
@@ -73,6 +74,9 @@ module Modulorails
       # The name is the usual name of the project, the one used in conversations at Modulotech
       @name = configuration.name
 
+      # A version of the name suitable to name environment variables
+      @environment_name = @name.parameterize.gsub('-', '_').gsub(/\b(\d)/, 'MT_\1').upcase
+
       # The main developer, the lead developer, in short the developer to call when something's
       # wrong with the application ;)
       @main_developer = configuration.main_developer

data/lib/modulorails/version.rb

@@ -1,6 +1,6 @@
 module Modulorails
 
-  VERSION = '1.2.1'.freeze
+  VERSION = '1.3.0'.freeze
 
   # Useful to compare the current Ruby version
   COMPARABLE_RUBY_VERSION = Gem::Version.new(RUBY_VERSION)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: modulorails
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Matthieu Ciappara
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-09 00:00:00.000000000 Z
+date: 2023-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -202,6 +202,7 @@ files:
 - lib/generators/modulorails/docker/docker_generator.rb
 - lib/generators/modulorails/docker/templates/Dockerfile.prod.tt
 - lib/generators/modulorails/docker/templates/Dockerfile.tt
+- lib/generators/modulorails/docker/templates/config/cable.yml.tt
 - lib/generators/modulorails/docker/templates/config/database.yml.tt
 - lib/generators/modulorails/docker/templates/docker-compose.prod.yml.tt
 - lib/generators/modulorails/docker/templates/docker-compose.yml.tt
@@ -216,8 +217,12 @@ files:
 - lib/generators/modulorails/rubocop/rubocop_generator.rb
 - lib/generators/modulorails/rubocop/templates/rubocop.yml.tt
 - lib/generators/modulorails/self_update/self_update_generator.rb
+- lib/generators/modulorails/service/USAGE
 - lib/generators/modulorails/service/service_generator.rb
 - lib/generators/modulorails/service/templates/service.rb.tt
+- lib/generators/modulorails/sidekiq/sidekiq_generator.rb
+- lib/generators/modulorails/sidekiq/templates/config/initializers/sidekiq.rb.tt
+- lib/generators/modulorails/sidekiq/templates/entrypoints/sidekiq-entrypoint.sh.tt
 - lib/modulorails.rb
 - lib/modulorails/configuration.rb
 - lib/modulorails/data.rb