dockerfile-rails 0.4.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 438d7f814f08f6180930a72f8b2e6437cb3b53b45ff495d99a0e5abf5c85e361
-  data.tar.gz: 71d21d72fc2aea9062fa9ba15e491083d279caa050f264e36de424a42e70ef44
+  metadata.gz: 0d84e3358f7afd8b5729d49e6b427e03f92eb6fe5da6a258689e933c09d721a2
+  data.tar.gz: 897d2a5f53c344c7162953e757b751ff646192ecd880f61cfb1754da5dfbb76d
 SHA512:
-  metadata.gz: eb59c4587e1f9b0b9dbd93b7e71e49a2211659bb3e8c9c9a58919f39b3d30963a41b954ad182c418c19df2edabbf68578494bce069306bc1947c18af1fcf1c7a
-  data.tar.gz: d3c30f95c8f17c44e1f4bc09639ed67a246e6d3b10646a758602bf97937e0da54507e1156b9728261a15ebba8de6618266002b5e6b5b02699bf0661f45da128b
+  metadata.gz: dd9b469a7c2c562c4cf137670c0d2fa177449c00ccb109e9aca65e0c48cb07d35b0a614c64daaaae699596eb2e191c7da4fcde1fc3da0566c3deed56e1b82494
+  data.tar.gz: 4ec4f71ecc02555da309027504872e137ccffa936b42ef42c935f2d0349b49cbccdfc39924f284653c952096bc3ea8014d9218eed92e7e71cfac15555e860705

data/README.md

@@ -1,6 +1,10 @@
-## Purpose
+## Overview
 
-Provide Rails generators to produce Dockerfiles and related files.
+Provides Rails generators to produce Dockerfiles and related files.  This is being proposed as the generator to be included in Rails 7.1, and a substantial number of pull requests along those lines have already been merged.  This repository contains fixes and features beyond those pull requests.  Highlights:
+
+  * Supports all [Rails supported releases](https://guides.rubyonrails.org/maintenance_policy.html), not just Rails 7.1, and likely works with a number of previous releases.
+  * Can be customized using flags on the `generate dockerfile` command, and rerun to produce a custom tailored dockerfile based on detecting the actual features used by your application.
+  * Can produce a `docker-compose.yml` file for locally testing your configuration before deploying.
 
 ## Usage
 
@@ -28,9 +32,17 @@ additional support may be needed:
 * `--redis` - add redis libraries
 * `--sqlite3` - add sqlite3 libraries
 
+Optimizations:
+
+* `--fullstaq` - use [fullstaq](https://fullstaqruby.org/) [images](https://github.com/evilmartians/fullstaq-ruby-docker) on [quay.io](https://quay.io/repository/evl.ms/fullstaq-ruby?tab=tags&tag=latest)
+* `--jemalloc` - use [jemalloc](https://jemalloc.net/) memory allocator
+* `--yjit` - enable [YJIT](https://github.com/ruby/ruby/blob/master/doc/yjit/yjit.md) optimizing compiler.
+* `--swap=n` - allocate swap space.  See [falloc options](https://man7.org/linux/man-pages/man1/fallocate.1.html#OPTIONS) for suffixes.
+
 Links:
 
 * [Demos](./DEMO.md)
 * [Preparations for Rails 7.1](https://community.fly.io/t/preparations-for-rails-7-1/9512)
 * [Rails Dockerfile futures](https://discuss.rubyonrails.org/t/rails-dockerfile-futures/82091/1)
 * [Fly Cookbooks](https://fly.io/docs/rails/cookbooks/)
+* [app/templates/Dockerfile.tt](https://github.com/rails/rails/blob/main/railties/lib/rails/generators/rails/app/templates/Dockerfile.tt)

data/lib/generators/dockerfile_generator.rb

@@ -1,3 +1,5 @@
+require 'erb'
+
 class DockerfileGenerator < Rails::Generators::Base
   include DockerfileRails::Scanner
 
@@ -10,10 +12,13 @@ class DockerfileGenerator < Rails::Generators::Base
   class_option :parallel, type: :boolean, default: false,
     desc: 'use build stages to install gems and node modules in parallel'
 
+  class_option :swap, type: :string, default: nil,
+    desc: 'allocate swapspace'
+
   class_option :compose, type: :boolean, default: false,
     desc: 'generate a docker-compose.yml file'
 
-  class_option :redit, type: :boolean, default: false,
+  class_option :redis, type: :boolean, default: false,
     desc: 'include redis libraries'
 
   class_option :sqlite3, aliases: '--sqlite', type: :boolean, default: false,
@@ -52,6 +57,30 @@ class DockerfileGenerator < Rails::Generators::Base
 
 private
    
+  def render(options)
+    scope = (Class.new do
+      def initialize(obj, locals)
+        @_obj = obj
+        @_locals = OpenStruct.new(locals)
+      end
+
+      def method_missing(method, *args, &block)
+        if @_locals.respond_to? method
+          @_locals.send method, *args, &block
+        else
+          @_obj.send method, *args, &block
+        end
+      end
+
+      def get_binding
+        binding
+      end
+    end).new(self, options[:locals] || {})
+
+    template = IO.read(File.join(source_paths.last, "_#{options[:partial]}.erb"))
+    ERB.new(template, trim_mode: '-').result(scope.get_binding).strip
+  end
+
   def using_node?
     return @using_node if @using_node != nil
     @using_node = File.exist? 'package.json'
@@ -61,6 +90,10 @@ private
     options.redis? or @redis
   end
 
+  def using_execjs?
+    @gemfile.include? 'execjs'
+  end
+
   def parallel?
     using_node? && options.parallel
   end
@@ -88,9 +121,13 @@ private
     # ActiveStorage preview support
     packages << "libvips" if @gemfile.include? 'ruby-vips'
 
+    # Rmagick gem
+    packages += %w[pkg-config libmagickwand-dev] if @gemfile.include? 'rmagick'
+
     # node support, including support for building native modules
     if using_node?
-      packages += %w(curl unzip node-gyp pkg-config)
+      packages += %w(node-gyp pkg-config)
+      packages += %w(curl unzip) unless using_execjs?
 
       # module build process depends on Python, and debian changed
       # how python is installed with the bullseye release.  Below
@@ -129,6 +166,9 @@ private
     # ActiveStorage preview support
     packages << "libvips" if @gemfile.include? 'ruby-vips'
 
+    # Rmagick gem
+    packages << 'imagemagick' if @gemfile.include? 'rmagick'
+
     packages.sort
   end
 
@@ -184,7 +224,7 @@ private
   end
 
   def depend_on_bootsnap?
-    @gemfile.include? 'bootstrap'
+    @gemfile.include? 'bootsnap'
   end
 
   def api_only?

data/lib/generators/templates/Dockerfile.erb

@@ -3,35 +3,7 @@
 # Make sure RUBY_VERSION matches the Ruby version in .ruby-version and Gemfile
 ARG RUBY_VERSION=<%= RUBY_VERSION %>
 <% if api_client_dir -%>
-ARG NODE_VERSION=<%= node_version %>
-
-FROM node:$NODE_VERSION-slim as client
-
-WORKDIR /rails/<%= api_client_dir %>
-
-ENV NODE_ENV=production
-
-# Install node modules
-COPY <%= api_client_files.join(' ') %> .
-<% if api_client_files.join.include? 'yarn' -%>
-<% if options.cache? -%>
-RUN --mount=type=cache,id=bld-yarn-cache,target=/root/.yarn \
-    YARN_CACHE_FOLDER=/root/.yarn yarn install
-<% else -%>
-RUN yarn install
-<% end -%>
-<% else -%>
-<% if options.cache? -%>
-RUN --mount=type=cache,id=bld-yarn-cache,target=/root/.npm \
-    npm install
-<% else -%>
-RUN npm install
-<% end -%>
-<% end -%>
-
-# build client application
-COPY <%= api_client_dir %> .
-RUN npm run build
+<%= render partial: 'node_client' %>
 
 
 <% end -%>
@@ -49,23 +21,24 @@ ENV RAILS_ENV="production" \
     BUNDLE_PATH="vendor/bundle" \
     BUNDLE_WITHOUT="<%= options.ci? ? 'test' : 'development:test' %>"
 
+# Update gems and preinstall the desired version of bundler
 ARG BUNDLER_VERSION=<%= Bundler::VERSION %>
 RUN gem update --system --no-document && \
     gem install -N bundler -v ${BUNDLER_VERSION}
 
+<% if using_execjs? -%>
+# Install packages needed to install nodejs
+<%= render partial: 'apt_install', locals: {packages: %w(curl unzip), clean: true} %>
+
+<%= render partial: 'install_node', locals: {yarn_version: nil} %>
+
+<% end -%>
 
 # Throw-away build stage<%= parallel? ? 's' : '' %> to reduce size of final image
 FROM base as <%= parallel? ? 'pre' : '' %>build
 
-# Install packages need to build gems<%= using_node? ? " and node modules" : "" %>
-<% if options.cache? %>
-RUN --mount=type=cache,id=dev-apt-cache,sharing=locked,target=/var/cache/apt \
-    --mount=type=cache,id=dev-apt-lib,sharing=locked,target=/var/lib/apt \
-    apt-get update -qq && \
-<% else -%>
-RUN apt-get update -qq && \
-<% end -%>
-    apt-get install -y <%= build_packages.join(" ") %>
+# Install packages needed to build gems<%= using_node? ? " and node modules" : "" %>
+<%= render partial: 'apt_install', locals: {packages: build_packages, clean: false} %>
 
 <% if parallel? -%>
 
@@ -73,24 +46,11 @@ FROM prebuild as node
 
 <% end -%>
 <% if using_node? -%>
-# Install JavaScript dependencies
-ARG NODE_VERSION=<%= node_version %>
-ARG YARN_VERSION=<%= yarn_version %>
-RUN curl -fsSL https://fnm.vercel.app/install | bash && \
-    /root/.local/share/fnm/fnm install $NODE_VERSION
-ENV PATH=/root/.local/share/fnm/aliases/default/bin/:$PATH
-RUN npm install -g yarn@$YARN_VERSION
+<%= render partial: 'install_node', locals: {node_version: using_execjs? ? nil : node_version} %>
 
 <% end -%>
 <% if parallel? -%>
-# Install node modules
-COPY package.json yarn.lock ./
-<% if options.cache? -%>
-RUN --mount=type=cache,id=bld-yarn-cache,target=/root/.yarn \
-    YARN_CACHE_FOLDER=/root/.yarn yarn install
-<% else -%>
-RUN yarn install
-<% end -%>
+<%= render partial: 'npm_install', locals: {sources: %w(package.json yarn.lock)} %>
 
 
 FROM prebuild as build
@@ -103,25 +63,23 @@ RUN --mount=type=cache,id=bld-gem-cache,sharing=locked,target=/srv/vendor \
     bundle config set app_config .bundle && \
     bundle config set path /srv/vendor && \
     bundle _${BUNDLER_VERSION}_ install && \
+<% if depend_on_bootsnap? -%> && \
+    bundle exec bootsnap precompile --gemfile && \
+<% end -%>
     bundle clean && \
     mkdir -p vendor && \
     bundle config set path vendor && \
     cp -ar /srv/vendor .
 <% else -%>
-RUN bundle _${BUNDLER_VERSION}_ install
+RUN bundle _${BUNDLER_VERSION}_ install<% if depend_on_bootsnap? -%> && \
+    bundle exec bootsnap precompile --gemfile
+<% end -%>
 <% end -%>
 
 <% if parallel? -%>
 asdf
 <% elsif using_node? -%>
-# Install node modules
-COPY package.json yarn.lock ./
-<% if options.cache? -%>
-RUN --mount=type=cache,id=bld-yarn-cache,target=/root/.yarn \
-    YARN_CACHE_FOLDER=/root/.yarn yarn install
-<% else -%>
-RUN yarn install
-<% end -%>
+<%= render partial: 'npm_install', locals: {sources: %w(package.json yarn.lock)} %>
 
 <% end -%>
 # Copy application code
@@ -129,7 +87,7 @@ COPY . .
 
 <% if depend_on_bootsnap? -%>
 # Precompile bootsnap code for faster boot times
-RUN bundle exec bootsnap precompile --gemfile app/ lib/
+RUN bundle exec bootsnap precompile app/ lib/
 
 <% end -%>
 <% unless binfile_fixups.empty? -%>
@@ -147,17 +105,8 @@ RUN SECRET_KEY_BASE<%= Rails::VERSION::MAJOR<7 || Rails::VERSION::STRING.start_w
 FROM base
 <% unless deploy_packages.empty? -%>
 
-# Install packages need for deployment
-<% if options.cache? -%>
-RUN --mount=type=cache,id=dev-apt-cache,sharing=locked,target=/var/cache/apt \
-    --mount=type=cache,id=dev-apt-lib,sharing=locked,target=/var/lib/apt \
-    apt-get update -qq && \
-    apt-get install --no-install-recommends -y <%= deploy_packages.join(" ") %>
-<% else -%>
-RUN apt-get update -qq && \
-    apt-get install --no-install-recommends -y <%= deploy_packages.join(" ") %> && \
-    rm -rf /var/lib/apt/lists /var/cache/apt/archives
-<% end -%>
+# Install packages needed for deployment
+<%= render partial: 'apt_install', locals: {packages: deploy_packages, clean: true} %>
 <% end -%>
 
 # Copy built application from previous stage

data/lib/generators/templates/_apt_install.erb

@@ -0,0 +1,10 @@
+<% if options.cache? -%>
+RUN --mount=type=cache,id=dev-apt-cache,sharing=locked,target=/var/cache/apt \
+    --mount=type=cache,id=dev-apt-lib,sharing=locked,target=/var/lib/apt \
+    apt-get update -qq && \
+    apt-get install --no-install-recommends -y <%= packages.join(" ") %>
+<% else -%>
+RUN apt-get update -qq && \
+    apt-get install --no-install-recommends -y <%= packages.join(" ") %><% if clean %> && \
+    rm -rf /var/lib/apt/lists /var/cache/apt/archives<% end %>
+<% end -%>

data/lib/generators/templates/_install_node.erb

@@ -0,0 +1,21 @@
+<% if node_version and yarn_version -%>
+# Install JavaScript dependencies
+<% elsif node_version -%>
+# Install Node.js
+<% elsif yarn_version -%>
+# Install yarn
+<% end -%>
+<% if node_version -%>
+ARG NODE_VERSION=<%= node_version %>
+<% end -%>
+<% if yarn_version -%>
+ARG YARN_VERSION=<%= yarn_version %>
+<% end -%>
+<% if node_version -%>
+RUN curl -fsSL https://fnm.vercel.app/install | bash && \
+    /root/.local/share/fnm/fnm install $NODE_VERSION
+ENV PATH=/root/.local/share/fnm/aliases/default/bin/:$PATH
+<% end -%>
+<% if yarn_version -%>
+RUN npm install -g yarn@$YARN_VERSION
+<% end -%>

data/lib/generators/templates/_node_client.erb

@@ -0,0 +1,13 @@
+ARG NODE_VERSION=<%= node_version %>
+
+FROM node:$NODE_VERSION-slim as client
+
+WORKDIR /rails/<%= api_client_dir %>
+
+ENV NODE_ENV=production
+
+<%= render partial: 'npm_install', locals: {sources: api_client_files} %>
+
+# build client application
+COPY <%= api_client_dir %> .
+RUN npm run build

data/lib/generators/templates/_npm_install.erb

@@ -0,0 +1,17 @@
+# Install node modules
+COPY <%=sources.join(' ') %> .
+<% if sources.join.include? 'yarn' -%>
+<% if options.cache? -%>
+RUN --mount=type=cache,id=bld-yarn-cache,target=/root/.yarn \
+    YARN_CACHE_FOLDER=/root/.yarn yarn install
+<% else -%>
+RUN yarn install
+<% end -%>
+<% else -%>
+<% if options.cache? -%>
+RUN --mount=type=cache,id=bld-npm-cache,target=/root/.npm \
+    npm install
+<% else -%>
+RUN npm install
+<% end -%>
+<% end -%>

data/lib/generators/templates/docker-entrypoint.erb

@@ -1,5 +1,15 @@
 #!/bin/bash
 
+<% if options.swap -%>
+# allocate swap space
+fallocate -l <%= options.swap %> /swapfile
+chmod 0600 /swapfile
+mkswap /swapfile
+echo 10 > /proc/sys/vm/swappiness
+swapon /swapfile
+echo 1 > /proc/sys/vm/overcommit_memory
+
+<% end -%>
 # If running the rails server then create or migrate existing database
 if [ "${*}" == "./bin/rails server" ]; then
   ./bin/rails <%= dbprep_command %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dockerfile-rails
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Sam Ruby
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-16 00:00:00.000000000 Z
+date: 2023-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -36,9 +36,12 @@ files:
 - Rakefile
 - lib/dockerfile-rails.rb
 - lib/dockerfile-rails/scanner.rb
-- lib/erbtest.rb
 - lib/generators/dockerfile_generator.rb
 - lib/generators/templates/Dockerfile.erb
+- lib/generators/templates/_apt_install.erb
+- lib/generators/templates/_install_node.erb
+- lib/generators/templates/_node_client.erb
+- lib/generators/templates/_npm_install.erb
 - lib/generators/templates/docker-compose.yml.erb
 - lib/generators/templates/docker-entrypoint.erb
 - lib/generators/templates/dockerignore.erb

data/lib/erbtest.rb

@@ -1,41 +0,0 @@
-TEMPLATE = <<-EOF
-  value is <%= five %>
-  other is <%= three %>
-EOF
-
-require 'delegate'
-require 'forwardable'
-class Scope < SimpleDelegator
-end
-
-require 'erb'
-class ShoppingList
-  def five
-    'FiVe'
-  end
-  
-  def initialize
-    renderer = ERB.new(TEMPLATE)
-    puts '***'
-
-    values = {one: 'One', three: 'tHrEe'}
-
-    scope = (Class.new(SimpleDelegator) do
-      extend Forwardable
-      def_delegators values, :one, :three
-
-      def three
-        3
-      end
-    end).new(self)
-
-    puts renderer.result(scope.get_binding)
-  end
-
-  def get_binding
-    binding
-  end
-end
-
-puts '?'
-test = ShoppingList.new