modulorails 1.4.0.1 → 1.5.0.pre2

data/lib/generators/modulorails/githooks/templates/dockeruby.sh

@@ -0,0 +1,112 @@
+#!/bin/sh
+set -e
+
+# shellcheck disable=SC2016
+VALID_LAST_INSTRUCTION='exec "${@}"'
+
+# Check if the Dockerfile exists
+check_dockerfile() {
+  if [ -f "Dockerfile" ]; then
+    return 0
+  else
+    echo "No Dockerfile"
+    return 1
+  fi
+}
+
+# Get the entrypoint location from the Dockerfile
+entrypoint_location() {
+  entrypoint_line=$(grep '^ENTRYPOINT' Dockerfile || true)
+
+  if [ -z "$entrypoint_line" ]; then
+    echo ""
+  else
+    echo "$entrypoint_line" | sed -n 's/.*\[\(.*\)\].*/\1/p' | tr -d '"'
+  fi
+}
+
+# Check if the entrypoint is valid
+check_entrypoint() {
+  el=$(entrypoint_location)
+  if [ -z "$el" ]; then
+    return 0
+  fi
+
+  if [ ! -f "$el" ]; then
+    echo "Entrypoint not found at location: $el"
+    return 1
+  fi
+
+  last_line=$(tail -n 1 "$el" | xargs)
+
+  if [ "$last_line" != "$VALID_LAST_INSTRUCTION" ]; then
+    echo "Invalid entrypoint: Last instruction should be '$VALID_LAST_INSTRUCTION' instead of '$last_line'"
+    return 1
+  fi
+
+  return 0
+}
+
+# Run docker with the necessary options
+executer_docker_run() {
+  pwd=$(pwd)
+  working_directory=$(basename "$pwd")
+
+  tty_option=""
+  if [ -t 1 ]; then
+    tty_option="-ti"
+  fi
+
+  command="docker run --rm -v '$pwd:/app/$working_directory' -w '/app/$working_directory' $tty_option $git_environment ezveus/ruby:latest $docker_args"
+  echo "$command"
+  exec "$command"
+}
+
+executer_dockerfile_run() {
+  if check_entrypoint; then
+    entrypoint_option=""
+  else
+    entrypoint_option="--entrypoint \"sh -c\""
+  fi
+
+  command="docker compose build && docker compose run --rm $tty_option $git_environment $entrypoint_option app $docker_args"
+  echo "$command"
+  exec "$command"
+}
+
+# Main function
+main() {
+  args="$*"
+  docker_args=""
+  contains_command=false
+  git_name=$(git config --get user.name || whoami)
+  git_email=$(git config --get user.email || echo "$git_name@local")
+  git_environment="-e \"GIT_AUTHOR_EMAIL=$git_email\" -e \"GIT_AUTHOR_NAME=$git_name\" -e \"GIT_COMMITTER_EMAIL=$git_email\" -e \"GIT_COMMITTER_NAME=$git_name\""
+
+  tty_option=""
+  if [ -t 1 ]; then
+    tty_option="-ti"
+  fi
+
+  for arg in "$@"; do
+    # Check if any argument is not an option (doesn't start with '-')
+    if [ "${arg#-}" = "$arg" ]; then
+      contains_command=true
+      break
+    fi
+  done
+
+  if [ "$contains_command" = false ]; then
+    docker_args="ruby $args"
+  else
+    docker_args="$args"
+  fi
+
+  if check_dockerfile; then
+    executer_dockerfile_run
+  else
+    executer_docker_run "$docker_args"
+  fi
+}
+
+main "$@"

data/lib/generators/modulorails/githooks/templates/post-rewrite.sh

@@ -0,0 +1,5 @@
+#!/bin/sh
+if [ "$1" = "rebase" ]
+then
+  exec ./bin/dockeruby ./bin/refresh_generations
+fi

data/lib/generators/modulorails/githooks/templates/pre-merge-commit.sh

@@ -0,0 +1,2 @@
+#!/bin/sh
+exec ./bin/dockeruby ./bin/refresh_generations

data/lib/generators/modulorails/githooks/templates/refresh_generations.sh

@@ -0,0 +1,25 @@
+#!/bin/sh
+
+echo 'Regenerate Gemfile.lock'
+bundle install
+git add Gemfile.lock
+
+if [ $(cat Gemfile.lock | grep i18n-js | wc -l) -gt 0 ]
+then
+  echo 'Regenerate JS translations'
+  rake i18n:js:export
+  git add app/assets/javascripts/i18n/translations.js
+fi
+
+echo 'Regenerate DB schema'
+export RAILS_ENV=test
+bundle exec rake db:drop db:create db:schema:load db:migrate
+git add db/schema.rb
+export RAILS_ENV=development
+
+if [ "$(git diff --cached --name-only | wc -l)" -ne 0 ]; then
+  echo "Commit regenerated files by $GIT_AUTHOR_NAME <$GIT_AUTHOR_EMAIL>"
+  git commit -m 'hook: Update generated files'
+else
+  echo 'Nothing to commit'
+fi

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

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
 
-require 'rails/generators'
+require 'modulorails/generators/base'
 
-class Modulorails::GitlabciGenerator < Rails::Generators::Base
+class Modulorails::GitlabciGenerator < Modulorails::Generators::Base
 
-  source_root File.expand_path('templates', __dir__)
   desc 'This generator creates a template for a .gitlab-ci.yml file at root'
 
-  def create_config_file
+  protected
+
+  def create_config
     @data = Modulorails.data
     @image_name = @data.name.parameterize
     @environment_name = @data.environment_name
@@ -25,23 +26,8 @@ class Modulorails::GitlabciGenerator < Rails::Generators::Base
     # Remove the database-ci template if it exists.
     # It used to be referenced by the gitlab-ci template.
     remove_file 'config/database-ci.yml'
-
-    # Create file to avoid this generator on next modulorails launch
-    create_keep_file
   rescue StandardError => e
     warn("[Modulorails] Error: cannot generate CI configuration: #{e.message}")
   end
 
-  private
-
-  def create_keep_file
-    file = '.modulorails-gitlab-ci'
-
-    # Create file to avoid this generator on next modulorails launch
-    copy_file(file, file)
-
-    say "Add #{file} to git"
-    `git add #{file}`
-  end
-
 end

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

@@ -55,7 +55,7 @@ deploy_review:
   variables:
     NAMESPACE: <%= @image_name %>-$CI_ENVIRONMENT_SLUG
     NAME: <%= @image_name %>
-    CHART_NAME: <%= @image_name %>
+    CHART_NAME: rails
     CONFIG_FILE: config/deploy/review.yaml
     EXTRA_VARS: --set image.tag=$CI_COMMIT_SHORT_SHA --set ingress.hosts[0].host=${CI_ENVIRONMENT_SLUG}.<%= @review_base_url %> --set ingress.tls[0].hosts[0]=${CI_ENVIRONMENT_SLUG}.<%= @review_base_url %> --set env.url=${CI_ENVIRONMENT_SLUG}.<%= @review_base_url %> --set database.url=$DATABASE_URL --set master_key.key=$MASTER_KEY
   environment:
@@ -81,14 +81,26 @@ deploy_staging:
   variables:
     NAMESPACE: <%= @image_name %>
     NAME: <%= @image_name %>
-    CHART_NAME: <%= @image_name %>
+    CHART_NAME: rails
     CONFIG_FILE: config/deploy/staging.yaml
     EXTRA_VARS: --set image.tag=$CI_COMMIT_SHORT_SHA --set database.url=$DATABASE_URL --set master_key.key=$MASTER_KEY
   environment:
     name: staging
     url: https://<%= @staging_url %>
+    on_stop: stop_staging
+    auto_stop_in: 7 days
   only:
     - staging
+
+stop_staging:
+  extends: .stop_staging
+  variables:
+    NAMESPACE: <%= @image_name %>
+    NAME: <%= @image_name %>
+  only:
+    - staging
+  needs:
+    - docker_build
 <%- end -%>
 
 <%- if @production_url.present? -%>
@@ -97,7 +109,7 @@ deploy_production:
   variables:
     NAMESPACE: <%= @image_name %>
     NAME: <%= @image_name %>
-    CHART_NAME: <%= @image_name %>
+    CHART_NAME: rails
     CONFIG_FILE: config/deploy/production.yaml
     EXTRA_VARS: --set image.tag=$CI_COMMIT_SHORT_SHA
   environment:

data/lib/generators/modulorails/gitlabci/templates/config/deploy/production.yaml.tt

@@ -41,3 +41,18 @@ env:
 redis:
   enabled: false
   existingSecret: 'redis-credential'
+
+sidekiq:
+  enabled: false
+#  resources:
+#    requests:
+#      cpu: 100m
+#      memory: 512Mi
+#    limits:
+#      cpu: 100m
+#      memory: 512Mi
+#  autoscaling:
+#    enabled: true
+#    minReplicas: 1
+#    maxReplicas: 10
+#    targetCPUUtilizationPercentage: 80

data/lib/generators/modulorails/gitlabci/templates/config/deploy/review.yaml.tt

@@ -40,3 +40,18 @@ env:
 
 redis:
   enabled: true
+
+sidekiq:
+  enabled: true
+#  resources:
+#    requests:
+#      cpu: 100m
+#      memory: 512Mi
+#    limits:
+#      cpu: 100m
+#      memory: 512Mi
+#  autoscaling:
+#    enabled: true
+#    minReplicas: 1
+#    maxReplicas: 10
+#    targetCPUUtilizationPercentage: 80

data/lib/generators/modulorails/gitlabci/templates/config/deploy/staging.yaml.tt

@@ -40,3 +40,18 @@ env:
 
 redis:
   enabled: true
+
+sidekiq:
+  enabled: true
+#  resources:
+#    requests:
+#      cpu: 100m
+#      memory: 512Mi
+#    limits:
+#      cpu: 100m
+#      memory: 512Mi
+#  autoscaling:
+#    enabled: true
+#    minReplicas: 1
+#    maxReplicas: 10
+#    targetCPUUtilizationPercentage: 80

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'modulorails/generators/base'
+
+class Modulorails::HealthCheckGenerator < Modulorails::Generators::Base
+
+  VERSION = 1
+
+  desc 'This generator creates a configuration for the health_check gem'
+
+  protected
+
+  def create_config
+    # Update the template
+    template 'config/initializers/health_check.rb'
+
+    # Add the route
+    return if Rails.root.join('config/routes.rb').read.match?('health_check_routes')
+
+    inject_into_file 'config/routes.rb', "  health_check_routes\n\n", after: "Rails.application.routes.draw do\n"
+  rescue StandardError => e
+    warn("[Modulorails] Error: cannot generate health_check configuration: #{e.message}")
+  end
+
+  def keep_file_name
+    '.modulorails-health_check'
+  end
+
+end

data/lib/generators/modulorails/{healthcheck → health_check}/templates/.modulorails-health_check

@@ -1,3 +1,5 @@
+Version: <%= Modulorails::HealthCheckGenerator::VERSION %>
+
 This file ensures the modulorails gem will not try to override your current
 config/initializers/health_check.rb file on Rails start.
 

data/lib/generators/modulorails/moduloproject/moduloproject_generator.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+class Modulorails::ModuloprojectGenerator < Modulorails::Generators::Base
+
+  desc 'This generator creates templates for Moduloproject'
+
+  def create_config
+    template 'config/environments/production.rb'
+    copy_file('config/environments/production.rb', 'config/environments/staging.rb')
+    update_application_rb
+    create_file('config/locales/fr.yml', "--\nfr: {}\n")
+  rescue StandardError => e
+    warn("[Modulorails] Error: cannot generate Moduloproject configuration: #{e.message}")
+  end
+
+  private
+
+  def update_application_rb
+    file = 'config/application.rb'
+    pattern = /^(?>\s*)(?>#\s*)?config.time_zone = .+$/
+
+    config = <<-RUBY
+
+    config.time_zone = 'Europe/Paris'
+    I18n.available_locales = %i[fr en]
+    I18n.default_locale = 'fr'
+
+    uri = URI.parse(ENV.fetch('URL', 'http://localhost:3000'))
+    config.url = uri
+    Rails.application.routes.default_url_options = { protocol: uri.scheme, host: uri.host, port: uri.port }
+    RUBY
+
+    if File.read(file).match?(pattern)
+      gsub_file(file, pattern, config)
+    else
+      append_file(file, "\n#{config.chomp}", after: /^(?>\s*)(?>#\s*)?config.load_defaults.+$/)
+    end
+  end
+
+end

data/lib/generators/modulorails/moduloproject/templates/config/environments/production.rb.tt

@@ -0,0 +1,109 @@
+require "active_support/core_ext/integer/time"
+
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.enable_reloading = false
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both threaded web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Custom directories with classes and modules you want to be autoloadable.
+  # config.eager_load_paths += %W[
+  #  #{config.root}/lib/constraints
+  # ]
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local = false
+  config.action_controller.perform_caching = true
+
+  # Ensures that a master key has been made available in ENV["RAILS_MASTER_KEY"], config/master.key, or an environment
+  # key such as config/credentials/production.key. This key is used to decrypt credentials (and other encrypted files).
+  # config.require_master_key = true
+
+  # Disable serving static files from `public/`, relying on NGINX/Apache to do so instead.
+  config.public_file_server.enabled = ENV['RAILS_SERVE_STATIC_FILES'].present?
+
+  # Compress CSS using a preprocessor.
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.asset_host = "http://assets.example.com"
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for Apache
+  # config.action_dispatch.x_sendfile_header = "X-Accel-Redirect" # for NGINX
+
+  # Store uploaded files on the local file system (see config/storage.yml for options).
+  config.active_storage.service = :local
+
+  # Mount Action Cable outside main process or domain.
+  # config.action_cable.mount_path = nil
+  # host = URI(ENV.fetch('URL', 'http://localhost:3000/')).host
+  # config.action_cable.url = "wss://#{host}/cable"
+  # config.action_cable.disable_request_forgery_protection = true
+  # config.action_cable.allowed_request_origins = [
+  #  %r{(https|wss)://host}
+  # ]
+
+  # Assume all access to the app is happening through a SSL-terminating reverse proxy.
+  # Can be used together with config.force_ssl for Strict-Transport-Security and secure cookies.
+  config.assume_ssl = true
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  config.force_ssl = false
+
+  # Skip http-to-https redirect for the default health check endpoint.
+  # config.ssl_options = { redirect: { exclude: ->(request) { request.path == "/up" } } }
+
+  # Log to STDOUT by default
+  config.logger = ActiveSupport::Logger.new(STDOUT)
+                                       .tap { |logger| logger.formatter = ::Logger::Formatter.new }
+                                       .then { |logger| ActiveSupport::TaggedLogging.new(logger) }
+
+  # Prepend all log lines with the following tags.
+  config.log_tags = [:request_id]
+
+  # Info include generic and useful information about system operation, but avoids logging too much
+  # information to avoid inadvertent exposure of personally identifiable information (PII). If you
+  # want to log everything, set the level to "debug".
+  config.log_level = ENV.fetch("RAILS_LOG_LEVEL", "info")
+
+  # Use a different cache store in production.
+  config.cache_store = :redis_cache_store, { url: ENV['REDIS_URL'], expires_in: 6.hours }
+
+  # Use a real queuing backend for Active Job (and separate queues per environment).
+  # config.active_job.queue_adapter = :sidekiq
+  # config.active_job.queue_name_prefix = "<%= Modulorails.data.rails_name.underscore %>_production"
+
+  config.action_mailer.perform_caching = false
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation cannot be found).
+  config.i18n.fallbacks = true
+
+  # Don't log any deprecations.
+  config.active_support.report_deprecations = false
+
+  # Do not dump schema after migrations.
+  config.active_record.dump_schema_after_migration = false
+
+  # Enable DNS rebinding protection and other `Host` header attacks.
+  # config.hosts = [
+  #   "example.com",     # Allow requests from example.com
+  #   /.*\.example\.com/ # Allow requests from subdomains like `www.example.com`
+  # ]
+  # Skip DNS rebinding protection for the default health check endpoint.
+  # config.host_authorization = { exclude: ->(request) { request.path == "/up" } }
+end

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

@@ -17,6 +17,7 @@ class Modulorails::RubocopGenerator < Rails::Generators::Base
 
     append_file gitlab_config_path do
       <<~YAML
+
         rubocop:
           extends: .lint
       YAML

data/lib/generators/modulorails/self_update/self_update_generator.rb

@@ -13,7 +13,8 @@ class Modulorails::SelfUpdateGenerator < Rails::Generators::Base
 
   def create_config_file
     # Get the last published version
-    last_published_version = HTTParty.get(LATEST_VERSION_URL).parsed_response.first
+    versions = HTTParty.get(LATEST_VERSION_URL).parsed_response
+    last_published_version = versions&.reject { |version| Gem::Version.new(version['number']).prerelease? }&.first
 
     # Do nothing if we could not fetch the last published version (whatever the reason)
     return if last_published_version.nil?
@@ -35,7 +36,7 @@ class Modulorails::SelfUpdateGenerator < Rails::Generators::Base
               "gem 'modulorails', '= #{version}'"
 
     # Update the gem and the Gemfile.lock
-    system('bundle install')
+    run('bundle install -q')
   rescue StandardError => e
     warn("[Modulorails] Error: cannot generate health_check configuration: #{e.message}")
   end

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

@@ -8,7 +8,7 @@ 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"
+  check_class_collision suffix: 'Service'
 
   def create_service_files
     template 'service.rb', File.join('app/services', class_path, "#{file_name}_service.rb")
@@ -17,7 +17,7 @@ class Modulorails::ServiceGenerator < Rails::Generators::NamedBase
   private
 
   def file_name
-    @_file_name ||= remove_possible_suffix(super)
+    @file_name ||= remove_possible_suffix(super)
   end
 
   def remove_possible_suffix(name)

data/lib/generators/modulorails/service/templates/service.rb.tt

@@ -1,17 +1,10 @@
 <% module_namespacing do -%>
-# @author <INSERT YOUR NAME HERE>
-# <DESCRIBE YOUR CLASS HERE>
-<%- if arguments.size >= 1 -%>
-#
-<%- arguments.each do |argument| -%>
-# @!attribute <%= argument %>
-#   @return <DESCRIBE YOUR ARGUMENT HERE>
-<%- end -%>
-<%- end -%>
-class <%= class_name %>Service < ::ApplicationService
+class <%= class_name %>Service < ApplicationService
   <%- if arguments.size >= 1 -%>
 
-  def initialize(<%= arguments.join(', ') %>)
+  attr_reader <%= arguments.map { |arg| ":#{arg}" }.join(', ') %>
+
+  def initialize(<%= arguments.map { |arg| "#{arg}:" }.join(', ') %>)
     super()
 
     <%- arguments.each do |argument| -%>