modulorails 1.4.0.1 → 1.5.0.pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b498ef768fd2c2f4bafdc603425d8e7125428410d2f74a2632df2fb7787767f
-  data.tar.gz: 73eb3a056a2407d5ff4140b63377e56019512a388bed98b4aa78853c69d88569
+  metadata.gz: 928b92b50a47d10967876fd9fec84d9f1e0da9b9082d642a48cb2ee0eb49be89
+  data.tar.gz: 599f3d7b1546dfa9b294e8c09d9f1d429ad9d2b2ce69914c62f53e45cf213776
 SHA512:
-  metadata.gz: 4212615e5046474bc07d0f2a8d1393bd44fe8472fc107301cc3fd70437af2b692b4d14bde4ddc290eee6b5cfb7edd4107ce74579cc7b20960887fc463f8b6ed9
-  data.tar.gz: acd8a6ea0d748f60a8c621219b8a488a8e111158ba6aa0edc83045aab1d81db7a57c608b01c1302c7025e1d1ca61110b835a8ad14f567d035385ea4a8de22a43
+  metadata.gz: 3bcc2bc9acd9c84f41dd80c60036adffdcc85eb4c79c549209852d8dd918806e5d488d40df6b222648512e056b4d09f0f94f894a97215472577d222eea1d996e
+  data.tar.gz: '09cad76576542012ce824cd16891309d6d6e1b380b808e9839799294d099da9b9f6406a71be92a2d7ac8345044fd11c46bf9b8c28580fbb876b12ff06a8d86d3'

data/CHANGELOG.md

@@ -4,6 +4,30 @@ This file is used to list changes made in each version of the gem.
 
 # Unreleased
 
+# 1.5.0
+
+- Update templates according to new standards:
+  - Optimize layers in Dockerfile.prod.
+  - Remove root privileges in Dockerfile.prod.
+  - Exec Docker `CMD` in entrypoints.
+  - Configure Puma and Redis.
+  - Remove docker-compose.prod.
+  - Rename docker-compose.yml to compose.yml.
+  - Remove version from compose.yml.
+  - Auto-stop staging container after 7 days.
+  - Use `rails` chart in Gitlab CI templates.
+  - Move entrypoints locations to `bin` to be rails-standard.
+  - Rewrite Dockerfile.prod for Rails 7.2+ to be more rails-standard.
+- Version Docker generator.
+- Add a generator for project initialization:
+  - Add default configuration for production and staging environments.
+  - Add default locale configuration to application.rb.
+- Add a generator for Git hooks.
+- Update service template to use keyword arguments and add `attr_reader`s.
+- Add optional `data` argument to `with_transaction`.
+- Deprecate `Modulorails::BaseService#log` and `Modulorails::LogsForMethodService`.
+- Add a common base for all generators.
+
 # 1.4.0.1
 
 - Fix auto-update.

data/Gemfile

@@ -5,3 +5,6 @@ gemspec
 
 gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"
+
+gem "activerecord", '>= 4.2.0'
+gem "appraisal"

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

@@ -1,19 +1,17 @@
 # frozen_string_literal: true
 
-require 'rails/generators'
+require 'modulorails/generators/base'
 
-class Modulorails::BundlerauditGenerator < Rails::Generators::Base
+class Modulorails::BundlerauditGenerator < Modulorails::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')
+  protected
 
-    return if File.read(gitlab_config_path).match?(/\s+extends:\s+.bundleraudit\s*$/)
-
-    append_file gitlab_config_path do
+  def create_config
+    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/
@@ -23,4 +21,11 @@ class Modulorails::BundlerauditGenerator < Rails::Generators::Base
     end
   end
 
+  def keep_file_present?
+    @gitlab_config_path = Rails.root.join('.gitlab-ci.yml')
+
+    !@gitlab_config_path.exist? ||
+      @gitlab_config_path.read.match?(/\s+extends:\s+.bundleraudit\s*$/)
+  end
+
 end

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

@@ -1,35 +1,78 @@
 # frozen_string_literal: true
 
-require 'rails/generators'
+require 'modulorails/generators/base'
 
-class Modulorails::DockerGenerator < Rails::Generators::Base
+class Modulorails::DockerGenerator < Modulorails::Generators::Base
 
-  source_root File.expand_path('templates', __dir__)
-  desc 'This generator creates Dockerfiles for an app'
+  VERSION = 2
 
-  def create_config_file
+  desc 'This generator creates Docker configuration for an app'
+
+  protected
+
+  def create_config
     @data = Modulorails.data
     @adapter = @data.adapter
     @webpack_container_needed = @data.webpacker_version.present?
     @image_name = @data.name.parameterize
     @environment_name = @data.environment_name
 
-    template 'Dockerfile'
-    template 'Dockerfile.prod'
-    template 'docker-compose.yml'
-    template 'docker-compose.prod.yml'
-    template 'entrypoints/docker-entrypoint.sh'
-    chmod 'entrypoints/docker-entrypoint.sh', 0755
+    create_dockerfile
+    create_dockerfile_prod
+    create_compose_yml
+    create_docker_entrypoint
     template 'config/database.yml'
     template 'config/cable.yml'
+    template 'config/initializers/0_redis.rb'
+    template 'config/puma.rb'
 
     # Useless unless project is using Webpacker
-    if @webpack_container_needed
-      template 'entrypoints/webpack-entrypoint.sh'
-      chmod 'entrypoints/webpack-entrypoint.sh', 0755
-    end
+    return unless @webpack_container_needed
+
+    create_webpack_entrypoint
   rescue StandardError => e
     warn("[Modulorails] Error: cannot generate Docker configuration: #{e.message}")
   end
 
+  private
+
+  def create_dockerfile
+    say('WARNING: The entrypoint was moved. Check that your Dockerfile still works.') if File.exist?('Dockerfile')
+    template 'dockerfiles/modulotech/Dockerfile', 'Dockerfile'
+  end
+
+  def create_webpack_entrypoint
+    create_new_file('entrypoints/webpack-entrypoint.sh', 'bin/webpack-entrypoint')
+  end
+
+  def create_docker_entrypoint
+    create_new_file 'entrypoints/docker-entrypoint.sh', 'bin/docker-entrypoint'
+  end
+
+  def create_compose_yml
+    create_new_file 'docker-compose.yml', 'compose.yml', executable: false
+  end
+
+  def create_dockerfile_prod
+    if File.exist?('Dockerfile.prod')
+      say('WARNING: The entrypoint was moved. Check that your Dockerfile.prod still works.')
+    end
+
+    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
+  end
+
+  def create_new_file(old_file, new_file, executable: true)
+    if File.exist?(old_file)
+      copy_file old_file, new_file
+      remove_file old_file
+    else
+      template old_file, new_file
+    end
+    chmod new_file, 0o755 if executable
+  end
+
 end

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

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

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

@@ -1,26 +1,14 @@
-<%- if @adapter =~ /mysql/ -%>
 development: &default
+<%- if @adapter =~ /mysql/ -%>
   adapter: mysql2
-  encoding: utf8mb4
-  collation: utf8mb4_unicode_ci
-  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('<%= @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 -%>
+  url: <%%= ENV['DATABASE_URL'] %>
 
 test:
   <<: *default
-  database: <%%= ENV.fetch('<%= @environment_name %>_TEST_DATABASE_NAME', '<%= @image_name %>_test') %>
+  database: <%%= ENV['DTABASE_TEST_URL'] %>
 
 staging:
   <<: *default

data/lib/generators/modulorails/docker/templates/config/initializers/0_redis.rb

@@ -0,0 +1,2 @@
+REDIS_URL = ENV.fetch('REDIS_URL', 'redis://redis:6379')
+REDIS_CLI = Redis.new(url: REDIS_URL)

data/lib/generators/modulorails/docker/templates/config/puma.rb

@@ -0,0 +1,41 @@
+# This configuration file will be evaluated by Puma. The top-level methods that
+# are invoked here are part of Puma's configuration DSL. For more information
+# about methods provided by the DSL, see https://puma.io/puma/Puma/DSL.html.
+
+# Puma starts a configurable number of processes (workers) and each process
+# serves each request in a thread from an internal thread pool.
+#
+# The ideal number of threads per worker depends both on how much time the
+# application spends waiting for IO operations and on how much you wish to
+# to prioritize throughput over latency.
+#
+# As a rule of thumb, increasing the number of threads will increase how much
+# traffic a given process can handle (throughput), but due to CRuby's
+# Global VM Lock (GVL) it has diminishing returns and will degrade the
+# response time (latency) of the application.
+#
+# The default is set to 3 threads as it's deemed a decent compromise between
+# throughput and latency for the average Rails application.
+#
+# Any libraries that use a connection pool or another resource pool should
+# be configured to provide at least as many connections as the number of
+# threads. This includes Active Record's `pool` parameter in `database.yml`.
+threads_count = ENV.fetch('RAILS_MAX_THREADS', 3)
+threads threads_count, threads_count
+
+# Specifies the worker count.
+if ENV['RAILS_ENV'] == 'production'
+  require 'concurrent-ruby'
+  worker_count = Integer(ENV.fetch('WEB_CONCURRENCY', 4))
+  workers worker_count if worker_count > 1
+end
+
+# Specifies the `port` that Puma will listen on to receive requests; default is 3000.
+bind "tcp://0.0.0.0:#{ENV.fetch('PORT', 3000)}"
+
+# Allow puma to be restarted by `bin/rails restart` command.
+plugin :tmp_restart
+
+# Specify the PID file. Defaults to tmp/pids/server.pid in development.
+# In other environments, only set the PID file if requested.
+pidfile ENV['PIDFILE'] if ENV['PIDFILE']

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

@@ -1,5 +1,3 @@
-version: '3.7'
-
 services:
   app:
     image: modulotechgroup/<%= @image_name %>:dev
@@ -16,10 +14,14 @@ services:
     environment:
       RAILS_ENV: development
       URL: http://localhost:3000
-      <%= @environment_name %>_DATABASE_HOST: database
-      <%= @environment_name %>_DATABASE_NAME: <%= @image_name %>
+      <%- if @adapter =~ /mysql/ -%>
+      DATABASE_URL: mysql2://root@database/<%= @image_name %>
+      DATABASE_TEST_URL: mysql2://root@database/<%= @image_name %>-test
+      <%- else -%>
+      DATABASE_URL: postgresql://postgres:postgres@database/<%= @image_name %>
+      DATABASE_TEST_URL: postgresql://postgres:postgres@database/<%= @image_name %>-test
+      <%- end -%>
       REDIS_URL: redis://redis:6379/1
-    entrypoint: ./entrypoints/docker-entrypoint.sh
     stdin_open: true
     tty: true
 
@@ -28,6 +30,8 @@ services:
     image: mysql/mysql-server:8.0
     volumes:
       - db_data:/var/lib/mysql
+    ports:
+      - '3306:3306'
     environment:
       MYSQL_ALLOW_EMPTY_PASSWORD: 'true'
       MYSQL_DATABASE: <%= @image_name %>
@@ -37,6 +41,8 @@ services:
     image: postgres:16-alpine
     volumes:
       - db_data:/var/lib/postgresql/data
+    ports:
+      - '5432:5432'
     environment:
       POSTGRES_USER: postgres
       POSTGRES_PASSWORD: postgres
@@ -51,7 +57,8 @@ services:
   mailcatcher:
     image: dockage/mailcatcher
     ports:
-      - 1080:1080
+      - '1080:1080'
+      - '1025:1025'
 
   <%- if @webpack_container_needed -%>
   webpack:
@@ -59,7 +66,7 @@ services:
    build:
      context: .
      dockerfile: Dockerfile
-   entrypoint: ./entrypoints/webpack-entrypoint.sh
+   entrypoint: ./bin/webpack-entrypoint
    volumes:
      - .:/app
    ports:

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

@@ -20,8 +20,8 @@ RUN apk add --update --no-cache \
 RUN gem install bundler -v <%= @data.bundler_version %>
 
 COPY Gemfile Gemfile.lock ./
-RUN bundle config set --local deployment 'true'
-RUN bundle check || bundle install --jobs=2 \
+RUN bundle config set --local deployment 'true' \
+    && bundle check || bundle install --jobs=2 \
     && rm -rf vendor/bundle/ruby/*/cache/*
 
 <%- if @webpack_container_needed -%>
@@ -35,12 +35,12 @@ RUN bundle exec rake assets:precompile
 # FINAL IMAGE
 FROM ruby:<%= @data.ruby_version %>-alpine
 
-ENV RAILS_ENV=development
-ENV EDITOR=vim
+ENV RAILS_ENV=development \
+    EDITOR=vim
 WORKDIR /app
+RUN adduser -D user
 
 RUN apk add --update --no-cache \
-    curl \
     git \
     nodejs \
     tzdata \
@@ -54,11 +54,13 @@ RUN apk add --update --no-cache \
     && rm -rf .git/
 RUN gem install bundler -v <%= @data.bundler_version %>
 
-COPY --from=builder /app .
+COPY --chown=user:user --from=builder /app .
 
 RUN bundle config --local path vendor/bundle \
     && bundle config --local without development:test:assets
 
 EXPOSE 3000
 
-ENTRYPOINT ["./entrypoints/docker-entrypoint.sh"]
+ENTRYPOINT ["./bin/docker-entrypoint"]
+
+CMD ["./bin/rails", "server"]

data/lib/generators/modulorails/docker/templates/{Dockerfile.tt → dockerfiles/modulotech/Dockerfile.tt}

@@ -25,4 +25,6 @@ COPY . .
 
 EXPOSE 3000
 
-ENTRYPOINT ["./entrypoints/docker-entrypoint.sh"]
+ENTRYPOINT ["./bin/docker-entrypoint"]
+
+CMD ["./bin/rails", "server"]

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

@@ -0,0 +1,87 @@
+# syntax = docker/dockerfile:1
+
+# This Dockerfile is designed for production, not development.
+# It is adapted from Rails 7.2 default Dockerfile with Modulotech's twist to fit the use of Alpine.
+
+# Make sure RUBY_VERSION matches the Ruby version in .ruby-version
+ARG RUBY_VERSION=<%= @data.ruby_version %>
+FROM docker.io/library/ruby:$RUBY_VERSION-alpine AS base
+
+# Rails app lives here
+WORKDIR /rails
+
+# Install base packages
+RUN apk add --update --no-cache \
+    tzdata \
+    shared-mime-info \
+    vim \
+    jemalloc \
+    vips \
+    <%- if @adapter =~ /mysql/ -%>
+    mysql-client
+    <%- else -%>
+    postgresql-client
+    <%- end -%>
+
+# Set production environment
+ENV RAILS_ENV="production" \
+    BUNDLE_DEPLOYMENT="1" \
+    BUNDLE_PATH="/usr/local/bundle" \
+    BUNDLE_WITHOUT="development"
+
+# Throw-away build stage to reduce size of final image
+FROM base AS build
+
+# Install packages needed to build gems
+RUN apk add --update --no-cache \
+    alpine-sdk \
+    nodejs \
+    tzdata \
+    yarn \
+    shared-mime-info \
+    gcompat \
+    <%- if @adapter =~ /mysql/ -%>
+    mysql-dev
+    <%- else -%>
+    postgresql-dev
+    <%- end -%>
+
+# Install application gems
+RUN gem install bundler -v <%= @data.bundler_version %>
+
+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
+
+# Copy application code
+COPY . .
+
+# Precompile bootsnap code for faster boot times
+RUN bundle exec bootsnap precompile app/ lib/
+
+# Precompiling assets for production without requiring secret RAILS_MASTER_KEY
+RUN SECRET_KEY_BASE_DUMMY=1 ./bin/rails assets:precompile
+
+
+
+
+# Final stage for app image
+FROM base
+
+# Copy built artifacts: gems, application
+COPY --from=build "${BUNDLE_PATH}" "${BUNDLE_PATH}"
+COPY --from=build /rails /rails
+
+# Run and own only the runtime files as a non-root user for security
+RUN addgroup -S -g 1000 rails && \
+    adduser rails -u 1000 -G rails -h /home/rails -s /bin/sh -D && \
+    chown -R rails:rails db log storage tmp
+USER 1000:1000
+
+# Entrypoint prepares the database.
+ENTRYPOINT ["/rails/bin/docker-entrypoint"]
+
+# Start the server by default, this can be overwritten at runtime
+EXPOSE 3000
+CMD ["./bin/rails", "server"]

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

@@ -1,7 +1,12 @@
-#!/bin/sh
+#!/bin/sh -e
 
-# Exit immediately if a command exits with a non-zero status
-set -e
+# Enable jemalloc for reduced memory usage and latency.
+jemalloc_lib=$(find /usr/lib/ -name "libjemalloc.so.2" 2>/dev/null | head -n 1)
+
+if [ -z "${LD_PRELOAD+x}" ] && [ -n "$jemalloc_lib" ]; then
+  LD_PRELOAD="$jemalloc_lib"
+  export LD_PRELOAD
+fi
 
 # No `node_modules` directory means `yarn install` was never launched.
 # It is mandatory to install yarn dependencies IF there is a `package.json` file.
@@ -10,11 +15,10 @@ then
   yarn install
 fi
 
-# Remove pidfile if it exists else the server will not launch
-if [ -f tmp/pids/server.pid ]
-then
-  rm tmp/pids/server.pid
+# If running the rails server then create or migrate existing database
+if [ "$1" = "./bin/rails" ] && [ "$2" = "server" ]; then
+  ./bin/rails db:prepare
 fi
 
-# Launch the application listening from all origins on port 3000
-exec ./bin/bundle exec rails s -b 0.0.0.0 -p 3000
+# Execute the CMD
+exec "$@"

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'modulorails/generators/base'
+
+module Modulorails
+
+  class GithooksGenerator < Modulorails::Generators::Base
+
+    protected
+
+    def create_config
+      create_hook_executor
+      create_refresh_generations_script
+      create_git_hooks
+      update_gitattributes
+    end
+
+    private
+
+    def create_hook_executor
+      template 'dockeruby.sh', 'bin/dockeruby'
+      chmod 'bin/dockeruby', 0o755
+    end
+
+    def create_refresh_generations_script
+      template 'refresh_generations.sh', 'bin/refresh_generations'
+      chmod 'bin/refresh_generations', 0o755
+    end
+
+    def create_git_hooks
+      %w[post-rewrite pre-merge-commit].each do |hook|
+        template "#{hook}.sh", ".git/hooks/#{hook}"
+        chmod ".git/hooks/#{hook}", 0o755
+      end
+    end
+
+    def update_gitattributes
+      content = <<~CONTENT
+        # See https://git-scm.com/docs/gitattributes for more about git attribute files.
+
+        # Mark any vendored files as having been vendored.
+        vendor/* linguist-vendored
+
+        config/credentials/*.yml.enc diff=rails_credentials
+        config/credentials.yml.enc diff=rails_credentials
+
+        Gemfile.lock merge=ours
+        app/assets/javascripts/i18n/translations.js merge=ours
+        db/schema.rb merge=ours
+      CONTENT
+
+      create_file '.gitattributes', content, force: true
+    end
+
+  end
+
+end