modulorails 1.5.2.pre.1 → 1.6.0

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

@@ -0,0 +1,97 @@
+services:
+  app:
+    image: modulotechgroup/<%= @image_name %>:dev
+    build:
+      context: ..
+      dockerfile: .devcontainer/Dockerfile
+    depends_on:
+      - database
+      - redis
+    volumes:
+      - ..:/rails
+    environment:
+      RAILS_ENV: development
+      URL: http://localhost:3000
+    env_file:
+      - path: .env
+        required: false
+    stdin_open: true
+    tty: true
+
+<%- if @adapter =~ /mysql/ -%>
+  database:
+    image: mysql/mysql-server:8.0
+    volumes:
+      - db_data:/var/lib/mysql
+    expose:
+      - '3306'
+    environment:
+      MYSQL_ALLOW_EMPTY_PASSWORD: 'true'
+      MYSQL_DATABASE: <%= @image_name %>
+      MYSQL_ROOT_HOST: '%'
+<%- else -%>
+  database:
+    image: postgres:16-alpine
+    volumes:
+      - db_data:/var/lib/postgresql/data
+    expose:
+      - '5432'
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: postgres
+      POSTGRES_DB: <%= @image_name %>
+      LC_COLLATE: 'en_US.UTF-8'
+      LC_CTYPE: 'en_US.UTF-8'
+<%- end -%>
+
+  redis:
+    image: redis:7-alpine
+    volumes:
+      - redis_data:/data
+
+  mailcatcher:
+    image: dockage/mailcatcher
+    expose:
+      - '1080'
+      - '1025'
+
+<%- case @js_engine -%>
+<%- when :webpacker -%>
+  webpack:
+    image: modulotechgroup/<%= @image_name %>:dev
+    build:
+      context: ..
+      dockerfile: .devcontainer/Dockerfile
+    command: ./bin/webpack-dev-server
+    volumes:
+      - ..:/rails
+    environment:
+      NODE_ENV: development
+      RAILS_ENV: development
+<%- when :bun -%>
+  js:
+    image: modulotechgroup/<%= @image_name %>:dev
+    build:
+      context: ..
+      dockerfile: .devcontainer/Dockerfile
+    command: bun run build --watch
+    volumes:
+      - ..:/rails
+    environment:
+      NODE_ENV: development
+
+  css:
+    image: modulotechgroup/<%= @image_name %>:dev
+    build:
+      context: ..
+      dockerfile: .devcontainer/Dockerfile
+    command: bun run watch:css
+    volumes:
+      - ..:/rails
+    environment:
+      NODE_ENV: development
+<%- end -%>
+
+volumes:
+  db_data:
+  redis_data:

data/lib/generators/modulorails/docker/devcontainer/templates/devcontainer/devcontainer.json.tt

@@ -0,0 +1,80 @@
+// For format details, see https://containers.dev/implementors/json_reference/.
+// For config options, see the README at: https://github.com/devcontainers/templates/tree/main/src/ruby
+{
+	"name": "<%= @image_name %>",
+	"dockerComposeFile": "./compose.yml",
+	"service": "app",
+	"workspaceFolder": "/rails",
+	"shutdownAction": "stopCompose",
+
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	"features": {
+		"ghcr.io/cirolosapio/devcontainers-features/alpine-docker-outside-of-docker:0": {}
+	},
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+<%- if @adapter =~ /mysql/ -%>
+	"forwardPorts": [3000, "database:3306", "mailcatcher:1080"],
+<%- else -%>
+	"forwardPorts": [3000, "database:5432", "mailcatcher:1080"],
+<%- end -%>
+
+	// Configure tool-specific properties.
+	"customizations": {
+		"vscode": {
+			"yard.spacers.beforeDescription": false,
+			"yard.spacers.afterDescription": false,
+			"yard.spacers.beforeTags": false,
+			"yard.spacers.separateTags": false,
+			"yard.spacers.afterTags": false,
+			"yard.spacers.beforeSingleTag": false,
+			"yard.spacers.afterSingleTag": false,
+			"yard.tags.paramNameBeforeType": true,
+			"extensions": [
+				"ecmel.vscode-html-css",
+				"Shopify.ruby-lsp",
+				"ms-vscode-remote.remote-containers",
+				"KoichiSasada.vscode-rdbg",
+				"pavlitsky.yard",
+				"eamodio.gitlens",
+				"GrapeCity.gc-excelviewer",
+				"smoore.yaml-path"
+			],
+			"settings": {
+				"terminal.integrated.profiles.linux": {
+					"JavaScript Debug Terminal": null,
+					"Rails console": {
+						"path": "rails",
+						"env": {
+							"DEV_LOG_LEVEL": "error",
+							"USE_CACHE": "YES"
+						},
+						"args": [
+							"c"
+						],
+						"icon": "ruby",
+						"color": "terminal.ansiRed"
+					},
+					"Rails server": {
+						"path": "rails",
+						"env": {
+							"DEV_LOG_LEVEL": "error",
+							"USE_CACHE": "YES"
+						},
+						"args": [
+							"s"
+						],
+						"icon": "ruby",
+						"color": "terminal.ansiRed"
+					}
+				}
+			}
+		}
+	},
+
+	// Uncomment to connect as root instead. More info: https://containers.dev/implementors/json_reference/#remoteUser.
+	// "remoteUser": "root",
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	"postCreateCommand": "bin/setup --skip-server"
+}

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

@@ -5,6 +5,7 @@ require 'generators/modulorails/docker/entrypoint/entrypoint_generator'
 require 'generators/modulorails/docker/dockerfile/dockerfile_generator'
 require 'generators/modulorails/docker/compose/compose_generator'
 require 'generators/modulorails/docker/config/config_generator'
+require 'generators/modulorails/docker/devcontainer/devcontainer_generator'
 
 module Modulorails
 
@@ -17,6 +18,11 @@ module Modulorails
     protected
 
     def create_config
+      Modulorails.deprecator.warn(<<~MESSAGE)
+        Modulorails::DockerGenerator is deprecated and will be removed in version 2.0.
+        Use Moduloproject 3.0 (available later) to initialize new projects with Docker configuration.
+      MESSAGE
+
       remove_old_keepfile('.modulorails-docker')
 
       # Running first since the Dockerfile generator checks for existence of entrypoint
@@ -24,6 +30,7 @@ module Modulorails
       Modulorails::Docker::DockerfileGenerator.new([], {}, {}).invoke_all
       Modulorails::Docker::ComposeGenerator.new([], {}, {}).invoke_all
       Modulorails::Docker::ConfigGenerator.new([], {}, {}).invoke_all
+      Modulorails::Docker::DevcontainerGenerator.new([], {}, {}).invoke_all
     rescue StandardError => e
       warn("[Modulorails] Error: cannot generate Docker configuration: #{e.message}")
     end

data/lib/generators/modulorails/docker/dockerfile/dockerfile_generator.rb

@@ -8,36 +8,40 @@ module Modulorails
 
     class DockerfileGenerator < ::Modulorails::Generators::DockerBase
 
-      VERSION = 1
+      VERSION = 2
 
       desc 'This generator creates Dockerfiles'
 
       protected
 
       def create_config
+        Modulorails.deprecator.warn(<<~MESSAGE)
+          Modulorails::Docker::DockerfileGenerator is deprecated and will be removed in version 2.0.
+          Use Moduloproject 3.0 (available later) to initialize new projects with Docker configuration.
+        MESSAGE
+
         @data = Modulorails.data
         @adapter = @data.adapter
-        @webpack_container_needed = @data.webpacker_version.present?
+        @js_engine = @data.js_engine
 
         EntrypointGenerator.new([], {}, {}).invoke_all unless File.exist?('bin/docker-entrypoint')
-        create_dockerfile
         create_dockerfile_prod
+        create_dockerignore
       rescue StandardError => e
         warn("[Modulorails] Error: cannot generate Dockerfiles: #{e.message}")
       end
 
       private
 
-      def create_dockerfile
-        template 'dockerfiles/modulotech/Dockerfile', 'Dockerfile'
+      def create_dockerfile_prod
+        @rails_72_and_more = Gem::Version.new(@data.rails_version) >= Gem::Version.new('7.2')
+
+        remove_file 'Dockerfile.prod'
+        template 'dockerfiles/Dockerfile.prod', 'Dockerfile', force: true
       end
 
-      def create_dockerfile_prod
-        if Gem::Version.new(@data.rails_version) >= Gem::Version.new('7.2')
-          template 'dockerfiles/rails/Dockerfile.prod', 'Dockerfile.prod'
-        else
-          template 'dockerfiles/modulotech/Dockerfile.prod', 'Dockerfile.prod'
-        end
+      def create_dockerignore
+        template 'dockerfiles/dockerignore', '.dockerignore'
       end
 
     end

data/lib/generators/modulorails/docker/dockerfile/templates/dockerfiles/{rails/Dockerfile.prod.tt → Dockerfile.prod.tt}

@@ -17,11 +17,11 @@ RUN apk add --update --no-cache \
     vim \
     jemalloc \
     vips \
-    <%- if @adapter =~ /mysql/ -%>
+  <%- if @adapter =~ /mysql/ -%>
     mysql-client
-    <%- else -%>
+  <%- else -%>
     postgresql-client
-    <%- end -%>
+  <%- end -%>
 
 # Set production environment
 ENV RAILS_ENV="production" \
@@ -37,27 +37,45 @@ RUN apk add --update --no-cache \
     alpine-sdk \
     nodejs \
     tzdata \
-    yarn \
     shared-mime-info \
     gcompat \
-    <%- if @adapter =~ /mysql/ -%>
+    yaml-dev \
+    curl \
+    bash \
+  <%- if @adapter =~ /mysql/ -%>
     mysql-dev
-    <%- else -%>
+  <%- else -%>
     postgresql-dev
-    <%- end -%>
+  <%- end -%>
 
 # Install application gems
 RUN gem install bundler -v <%= @data.bundler_version %>
 
+<%- case @js_engine -%>
+<%- when :webpacker -%>
+RUN apk add yarn
+<%- when :bun -%>
+# Install bun
+ENV BUN_INSTALL=/usr/local/bun
+ENV PATH="$BUN_INSTALL/bin:$PATH"
+RUN curl -fsSL https://bun.sh/install | bash
+<%- end -%>
+
 COPY Gemfile Gemfile.lock ./
 RUN bundle install && \
     rm -rf ~/.bundle/ "${BUNDLE_PATH}"/ruby/*/cache "${BUNDLE_PATH}"/ruby/*/bundler/gems/*/.git && \
     bundle exec bootsnap precompile --gemfile
 
-<%- if @webpack_container_needed -%>
+<%- case @js_engine -%>
+<%- when :webpacker -%>
+# Install node modules
 COPY package.json yarn.lock ./
 RUN yarn install
-<%- end-%>
+<%- when :bun -%>
+# Install node modules
+COPY package.json bun.lock ./
+RUN bun install --frozen-lockfile
+<%- end -%>
 
 # Copy application code
 COPY . .
@@ -66,10 +84,11 @@ COPY . .
 RUN bundle exec bootsnap precompile app/ lib/
 
 # Precompiling assets for production without requiring secret RAILS_MASTER_KEY
+<%- if @rails_72_and_more -%>
 RUN SECRET_KEY_BASE_DUMMY=1 ./bin/rails assets:precompile
-
-
-
+<%- else -%>
+RUN SECRET_KEY_BASE=1 ./bin/rails assets:precompile
+<%- end -%>
 
 # Final stage for app image
 FROM base

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>"