modulorails 1.5.2.pre.2 → 1.7.0

data/lib/generators/modulorails/docker/dockerfile/templates/dockerfiles/dockerignore.tt

@@ -0,0 +1,120 @@
+# Created by https://www.gitignore.io/api/osx,rails
+
+dump.rdb
+
+coverage
+*.xlsx
+
+### OSX ###
+*.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+# Thumbnails
+._*
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### Rails ###
+*.rbc
+capybara-*.html
+/db/*.sqlite3
+/db/*.sqlite3-journal
+/public/system
+/public/uploads
+/coverage/
+/spec/tmp
+**.orig
+rerun.txt
+pickle-email-*.html
+
+config/initializers/secret_token.rb
+
+# Only include if you have production secrets in this file, which is no longer a Rails default
+# config/secrets.yml
+
+# dotenv
+.env
+.env.sh
+
+## Environment normalization:
+/.bundle
+/vendor/bundle
+
+# these should all be checked in to normalize the environment:
+# Gemfile.lock, .ruby-version, .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# if using bower-rails ignore default bower_components path bower.json files
+/vendor/assets/bower_components
+*.bowerrc
+bower.json
+
+# Ignore pow environment settings
+.powenv
+
+# Ignore Byebug command history file.
+.byebug_history
+
+**/.classpath
+**/.dockerignore
+**/.env
+**/.gitignore
+**/.project
+**/.settings
+**/.toolstarget
+**/.vs
+**/.vscode
+**/*.*proj.user
+**/*.dbmdl
+**/*.jfm
+**/azds.yaml
+**/charts
+**/docker-compose*
+**/compose*
+**/Dockerfile*
+**/node_modules
+**/npm-debug.log
+**/obj
+**/secrets.dev.yaml
+**/values.dev.yaml
+README.md
+
+.browserslistrc
+.gitignore
+.gitlab
+.gitlab-ci.yml
+.modulorails-gitlab-ci
+.nvmrc
+.rubocop.yml
+.ruby-gemset
+.ruby-version
+
+/public/packs
+/public/packs-test
+/node_modules
+/yarn-error.log
+yarn-debug.log*
+.yarn-integrity
+
+/log/*
+/tmp
+
+rspec.xml
+rspec_results.txt

data/lib/generators/modulorails/docker/entrypoint/entrypoint_generator.rb

@@ -9,18 +9,23 @@ module Modulorails
 
     class EntrypointGenerator < Modulorails::Generators::DockerBase
 
-      VERSION = 1
+      VERSION = 2
 
       desc 'This generator creates Docker entrypoints'
 
       protected
 
       def create_config
+        Modulorails.deprecator.warn(<<~MESSAGE)
+          Modulorails::Docker::EntrypointGenerator is deprecated and will be removed in version 2.0.
+          Use Moduloproject 3.0 (available later) to initialize new projects with Docker configuration.
+        MESSAGE
+
         create_docker_entrypoint
-        create_webpack_entrypoint if Modulorails.data.webpacker_version.present?
+        remove_webpack_entrypoint
 
         if File.exist?('entrypoints/sidekiq-entrypoint.sh') || File.exist?('bin/sidekiq-entrypoint')
-          SidekiqGenerator.new([], {}, {}).invoke('add_entrypoint')
+          SidekiqGenerator.new([], {}, {}).invoke('remove_entrypoint')
         end
       rescue StandardError => e
         warn("[Modulorails] Error: cannot generate Docker entrypoints: #{e.message}")
@@ -28,8 +33,9 @@ module Modulorails
 
       private
 
-      def create_webpack_entrypoint
-        create_new_file('entrypoints/webpack-entrypoint.sh', 'bin/webpack-entrypoint')
+      def remove_webpack_entrypoint
+        remove_file('entrypoints/webpack-entrypoint.sh')
+        remove_file('bin/webpack-entrypoint')
       end
 
       def create_docker_entrypoint

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

@@ -1,5 +1,10 @@
 #!/bin/sh -e
 
+# For non-rails command (webpack, bun, yarn, etc.), we skip all rails-related processes and checks.
+if ! echo "${@}" | grep -qE '\b(rails|bin/rails)\b'; then
+  exec "${@}"
+fi
+
 # Enable jemalloc for reduced memory usage and latency.
 jemalloc_lib=$(find /usr/lib/ -name "libjemalloc.so.2" 2>/dev/null | head -n 1)
 

data/lib/generators/modulorails/githooks/githooks_generator.rb

@@ -6,7 +6,7 @@ module Modulorails
 
   class GithooksGenerator < Modulorails::Generators::Base
 
-    VERSION = 1
+    VERSION = 2
 
     protected
 
@@ -21,8 +21,10 @@ module Modulorails
     private
 
     def create_hook_executor
-      template 'dockeruby.rb', 'bin/dockeruby'
-      chmod 'bin/dockeruby', 0o755
+      template 'dc.sh', 'bin/dc'
+      chmod 'bin/dc', 0o755
+      template 'dcr.sh', 'bin/dcr'
+      chmod 'bin/dcr', 0o755
     end
 
     def create_refresh_generations_script

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

@@ -0,0 +1,30 @@
+#!/usr/bin/env bash
+
+# Function to run the main docker command
+run_command() {
+    local docker_args="$1"
+
+    # Build the docker command
+    local command="docker compose --project-name \"\$(basename \$(pwd))_devcontainer\" -f .devcontainer/compose.yml"
+
+    # Execute the command with additional arguments
+    eval "$command $docker_args"
+}
+
+main() {
+    # Check for apk command to determine if we're in an Alpine Linux container
+    if ! command -v apk >/dev/null 2>&1; then
+        # Escape arguments and pass them to the docker command
+        local escaped_args=()
+        for arg in "$@"; do
+            escaped_args+=("$(printf '%q' "$arg")")
+        done
+        run_command "${escaped_args[*]}"
+    else
+        # Execute the given arguments without wrapping
+        exec "$@"
+    fi
+}
+
+# Pass all the script's arguments to the main function
+main "$@"

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

@@ -0,0 +1,47 @@
+#!/usr/bin/env bash
+
+# Function to run the main docker command
+run_command() {
+    local docker_args="$1"
+
+    # Get Git configuration
+    local git_email
+    git_email=$(git config --get user.email)
+    local git_name
+    git_name=$(git config --get user.name)
+
+    # Check if the shell is a TTY
+    local tty_option
+    if [ -t 1 ]; then
+        tty_option='-ti'
+    else
+        tty_option=''
+    fi
+
+    # Build the docker command
+    local command="docker compose -f .devcontainer/compose.yml build && \
+        docker compose --project-name \"\$(basename \$(pwd))_devcontainer\" -f .devcontainer/compose.yml run --rm $tty_option \
+        -e \"GIT_AUTHOR_EMAIL=$git_email\" -e \"GIT_AUTHOR_NAME=$git_name\" \
+        -e \"GIT_COMMITTER_EMAIL=$git_email\" -e \"GIT_COMMITTER_NAME=$git_name\" app"
+
+    # Execute the command with additional arguments
+    eval "$command $docker_args"
+}
+
+main() {
+    # Check for apk command to determine if we're in an Alpine Linux container
+    if ! command -v apk >/dev/null 2>&1; then
+        # Escape arguments and pass them to the docker command
+        local escaped_args=()
+        for arg in "$@"; do
+            escaped_args+=("$(printf '%q' "$arg")")
+        done
+        run_command "${escaped_args[*]}"
+    else
+        # Execute the given arguments without wrapping
+        exec "$@"
+    fi
+}
+
+# Pass all the script's arguments to the main function
+main "$@"

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

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

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

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

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

@@ -1,21 +1,29 @@
 #!/bin/sh
 
-echo 'Regenerate Gemfile.lock'
-bundle install
-git add Gemfile.lock
+modified_files=$(git diff --cached --name-only)
 
-if [ $(cat Gemfile.lock | grep i18n-js | wc -l) -gt 0 ]
+if echo "$modified_files" | grep -q "Gemfile.lock"
+then
+  echo 'Regenerate Gemfile.lock'
+  bundle install
+  git add Gemfile.lock
+fi
+
+if [ "$(cat Gemfile.lock | grep i18n-js | wc -l)" -gt 0 ] && echo "$modified_files" | grep -q "translations.js"
 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 echo "$modified_files" | grep -q "schema.rb"
+then
+  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
+fi
 
 if [ "$(git diff --cached --name-only | wc -l)" -ne 0 ]; then
   echo "Commit regenerated files by $GIT_AUTHOR_NAME <$GIT_AUTHOR_EMAIL>"

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

@@ -4,13 +4,18 @@ require 'modulorails/generators/base'
 
 class Modulorails::GitlabciGenerator < Modulorails::Generators::Base
 
-  VERSION = 1
+  VERSION = 2
 
   desc 'This generator creates a template for a .gitlab-ci.yml file at root'
 
   protected
 
   def create_config
+    Modulorails.deprecator.warn(<<~MESSAGE)
+      Modulorails::GitlabciGenerator is deprecated and will be removed in version 2.0.
+      Use Moduloproject 3.0 (available later) to initialize new projects with GitLab CI configuration.
+    MESSAGE
+
     remove_old_keepfile('.modulorails-gitlab-ci')
     remove_old_keepfile('.modulorails-gitlabci')
 
@@ -24,6 +29,7 @@ class Modulorails::GitlabciGenerator < Modulorails::Generators::Base
 
     # Update the gitlab-ci template
     template '.gitlab-ci.yml'
+    template 'bin/test.sh', 'bin/test'
     template 'config/deploy/production.yaml' if @production_url.present?
     template 'config/deploy/staging.yaml' if @staging_url.present?
     template 'config/deploy/review.yaml' if @review_base_url.present?

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

@@ -7,16 +7,6 @@ include:
 
 variables:
   IMAGE_NAME: <%= @image_name %>
-  <%- if @adapter =~ /mysql/ -%>
-  MYSQL_DATABASE: <%= @image_name %>_test
-  MYSQL_ALLOW_EMPTY_PASSWORD: 'true'
-  <%= @environment_name %>_DATABASE_HOST: mysql
-  <%- else -%>
-  POSTGRES_DB: <%= @image_name %>_test
-  POSTGRES_USER: postgres
-  POSTGRES_PASSWORD: postgres
-  <%= @environment_name %>_DATABASE_HOST: postgres
-  <%- end -%>
 
 stages:
   - test
@@ -25,6 +15,8 @@ stages:
 
 build_integration_image:
   extends: .build_integration_image
+  variables:
+    DOCKERFILE: .devcontainer/Dockerfile
 
 test:
   extends: .test
@@ -37,13 +29,23 @@ test:
     - redis:7-alpine
   variables:
     RAILS_ENV: test
+    <%- if @adapter =~ /mysql/ -%>
+    MYSQL_DATABASE: <%= @image_name %>-test
+    MYSQL_ALLOW_EMPTY_PASSWORD: 'true'
+    DATABASE_TEST_URL: 'mysql2://root@mysql/<%= @image_name %>-test'
+    <%- else -%>
+    POSTGRES_DB: <%= @image_name %>-test
+    POSTGRES_USER: postgres
+    POSTGRES_PASSWORD: postgres
+    DATABASE_TEST_URL: 'postgresql://postgres:postgres@postgres/<%= @image_name %>-test'
+    <%- end -%>
   script:
-    - bundle exec rake db:create
-    - bundle exec rake db:migrate:reset
-    - bundle exec rspec --format progress --format RspecJunitFormatter --out rspec.xml
+    - bin/test
 
 docker_build:
   extends: .docker_buildx_push
+  variables:
+    DOCKERFILE: Dockerfile
   only:
     - merge_requests
     - staging

data/lib/generators/modulorails/gitlabci/templates/bin/test.sh.tt

@@ -0,0 +1,36 @@
+#!/usr/bin/env sh
+
+export RAILS_ENV=test
+
+if ! grep -q rspec Gemfile
+then
+  echo 'Install RSpec and add some tests:'
+  echo '  bundle add rspec-rails rspec_junit_formatter'
+  echo '  bundle exec rails generate rspec:install'
+  exit 0
+end
+
+if [ -z "$1" ]
+then
+  bundle exec rake db:drop db:create db:schema:load db:migrate
+  <%- case @js_engine -%>
+  <%- when :webpacker -%>
+  bundle exec yarn install
+  bundle exec rails webpacker:compile
+  <%- when :bun -%>
+  bun install
+  bun run build
+  bun run build:css
+  <%- end -%>
+fi
+
+if [ -z "$CI" ]
+then
+  # For dev environment, we use the options specified in `.rspec` file
+  bundle exec rspec --profile "$@"
+elif grep -q rspec_junit_formatter Gemfile
+then
+  bundle exec rspec --format progress --format RspecJunitFormatter --out rspec.xml --profile "$@"
+else
+  bundle exec rspec --format progress --profile "$@"
+fi

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

@@ -18,9 +18,9 @@ ingress:
 resources:
   requests:
     cpu: 100m
-    memory: 512Mi
+    memory: 1024Mi
   limits:
-    memory: 512Mi
+    memory: 1024Mi
 
 autoscaling:
   enabled: true
@@ -47,10 +47,10 @@ sidekiq:
 #  resources:
 #    requests:
 #      cpu: 100m
-#      memory: 512Mi
+#      memory: 1024Mi
 #    limits:
 #      cpu: 100m
-#      memory: 512Mi
+#      memory: 1024Mi
 #  autoscaling:
 #    enabled: true
 #    minReplicas: 1

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

@@ -18,9 +18,9 @@ ingress:
 resources:
   requests:
     cpu: 100m
-    memory: 512Mi
+    memory: 1024Mi
   limits:
-    memory: 512Mi
+    memory: 1024Mi
 
 autoscaling:
   enabled: true
@@ -46,10 +46,10 @@ sidekiq:
 #  resources:
 #    requests:
 #      cpu: 100m
-#      memory: 512Mi
+#      memory: 1024Mi
 #    limits:
 #      cpu: 100m
-#      memory: 512Mi
+#      memory: 1024Mi
 #  autoscaling:
 #    enabled: true
 #    minReplicas: 1

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

@@ -18,14 +18,14 @@ ingress:
 resources:
   requests:
     cpu: 100m
-    memory: 512Mi
+    memory: 1024Mi
   limits:
-    memory: 512Mi
+    memory: 1024Mi
 
 autoscaling:
   enabled: true
   minReplicas: 1
-  maxReplicas: 10
+  maxReplicas: 2
   targetCPUUtilizationPercentage: 80
 
 database:
@@ -42,16 +42,16 @@ redis:
   enabled: true
 
 sidekiq:
-  enabled: true
+  enabled: false
 #  resources:
 #    requests:
 #      cpu: 100m
-#      memory: 512Mi
+#      memory: 1024Mi
 #    limits:
 #      cpu: 100m
-#      memory: 512Mi
+#      memory: 1024Mi
 #  autoscaling:
 #    enabled: true
 #    minReplicas: 1
-#    maxReplicas: 10
+#    maxReplicas: 2
 #    targetCPUUtilizationPercentage: 80

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

@@ -4,16 +4,21 @@ require 'rails/generators'
 
 class Modulorails::ModuloprojectGenerator < Modulorails::Generators::Base
 
-  VERSION = 1
+  VERSION = 2
 
   desc 'This generator creates templates for Moduloproject'
 
   def create_config
+    Modulorails.deprecator.warn(<<~MESSAGE)
+      Modulorails::ModuloprojectGenerator is deprecated and will be removed in version 2.0.
+      This generator will be moved to Moduloproject 3.0 (available later).
+    MESSAGE
+
     remove_old_keepfile(".modulorails-#{generator_name}")
-    template 'config/environments/production.rb'
+    template 'config/environments/production.rb', force: true
     copy_file('config/environments/production.rb', 'config/environments/staging.rb')
     update_application_rb
-    create_file('config/locales/fr.yml', "--\nfr: {}\n")
+    create_file('config/locales/fr.yml', "fr: {}\n")
   rescue StandardError => e
     warn("[Modulorails] Error: cannot generate Moduloproject configuration: #{e.message}")
   end

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

@@ -6,55 +6,25 @@ Rails.application.configure do
   # 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.
+  # Eager load code on boot for better performance and memory savings (ignored by Rake tasks).
   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.
+  # Full error reports are disabled.
   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
+  # Turn on fragment caching in view templates.
+  config.action_controller.perform_caching = true
 
-  # Do not fallback to assets pipeline if a precompiled asset is missed.
-  config.assets.compile = false
+  # Cache assets for far-future expiry since they are all digest stamped.
+  config.public_file_server.headers = { "cache-control" => "public, max-age=#{1.year.to_i}" }
 
   # 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.
@@ -63,27 +33,26 @@ Rails.application.configure do
   # 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
+  # Log to STDOUT with the current request id as a default log tag.
+  config.log_tags = [ :request_id ]
   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".
+  # Change to "debug" to log everything (including potentially personally-identifiable information!)
   config.log_level = ENV.fetch("RAILS_LOG_LEVEL", "info")
 
-  # Use a different cache store in production.
+  # Prevent health checks from clogging up the logs.
+  config.silence_healthcheck_path = "/up"
+
+  # Don't log any deprecations.
+  config.active_support.report_deprecations = false
+
+  # Use Redis as a cache store
   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).
+  # Replace the default in-process and non-durable queuing backend for Active Job.
   # 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.
@@ -93,17 +62,18 @@ Rails.application.configure do
   # 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
 
+  # Only use :id for inspections in production.
+  config.active_record.attributes_for_inspect = [ :id ]
+
   # 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