dockerfile-rails 0.4.1 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7267f137214c8c519555cc4b3775f844eb9f4028a01522b1fee0952301f488a5
-  data.tar.gz: a27afadb1ccc74385cc12ddd4c6dea9445487035c48babd26eaab3c4712d539d
+  metadata.gz: 68a853a1d2a0a40c1912a99dd77fe1664abe12bf1678eb4dc07a17873259bc39
+  data.tar.gz: 90bcd80ae9f8a6c8c27cc806235bdec6b9bf308ca3a3ebf10712304f7a52a10e
 SHA512:
-  metadata.gz: 5ee1cf151c6521cdc3b29e13008716fa392e49649e6bc9614f095c911805c153e235c75704a3d0c09a6f1ffab9cb5bb3d9db92dac32fd441a7e350418bcee3f7
-  data.tar.gz: 993df0bde29fffa8b637cbf142e28403a02143c697f2df5c95021721b0ef4ba85e8a251d6196d99a1156b07e2f9dd82511c009df9641884892d64ec0ec3052bf
+  metadata.gz: 693b078d6d664fdd7366c036dbbb9f95732c79b0f058a2bfe7300c886c479885b33ba075d9d598a1266b2a030bf6bfc588aee6c9074a570e6bd9720749765d28
+  data.tar.gz: a74d6fe97db12495762f5b6dfcd5ff3cf9c32f2807f9402f9e159f485a5e5c8562347811d12fbdf7601ce6755592c7413ebb6402b2c8c606a90c7c0d5e43148e

data/README.md

@@ -17,6 +17,7 @@ General options:
 
 * `--force` - overwrite existing files
 * `--ci` - include test gems in deployed image
+* `--platform=s` - specify target platform.  See [FROM](https://docs.docker.com/engine/reference/builder/#from) for details.
 * `--cache` - use build caching to speed up builds
 * `--parallel` - use multi-stage builds to install gems and node modules in parallel
 * `--compose` - generate a `docker-compose.yml` file
@@ -36,7 +37,8 @@ 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.
+* `--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:
 
@@ -44,3 +46,4 @@ Links:
 * [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

@@ -12,6 +12,9 @@ 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'
 
@@ -27,6 +30,9 @@ class DockerfileGenerator < Rails::Generators::Base
   class_option :mysql, type: :boolean, default: false,
     desc: 'include mysql libraries'
 
+  class_option :platform, type: :string, default: nil,
+    desc: 'image platform (example: linux/arm64)'
+
   class_option :jemalloc, type: :boolean, default: false,
     desc: 'use jemalloc alternative malloc implementation'
   
@@ -75,7 +81,15 @@ private
     end).new(self, options[:locals] || {})
 
     template = IO.read(File.join(source_paths.last, "_#{options[:partial]}.erb"))
-    ERB.new(template.strip, trim_mode: '-').result(scope.get_binding)
+    ERB.new(template, trim_mode: '-').result(scope.get_binding).strip
+  end
+
+  def platform
+    if options.platform
+      "--platform #{options.platform} "
+    else
+      ""
+    end
   end
 
   def using_node?
@@ -87,6 +101,10 @@ private
     options.redis? or @redis
   end
 
+  def using_execjs?
+    @gemfile.include? 'execjs'
+  end
+
   def parallel?
     using_node? && options.parallel
   end
@@ -114,9 +132,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
@@ -155,6 +177,9 @@ private
     # ActiveStorage preview support
     packages << "libvips" if @gemfile.include? 'ruby-vips'
 
+    # Rmagick gem
+    packages << 'imagemagick' if @gemfile.include? 'rmagick'
+
     packages.sort
   end
 

data/lib/generators/templates/Dockerfile.erb

@@ -8,9 +8,9 @@ ARG RUBY_VERSION=<%= RUBY_VERSION %>
 
 <% end -%>
 <% if options.fullstaq -%>
-FROM quay.io/evl.ms/fullstaq-ruby:${RUBY_VERSION}-<%= @options.jemalloc ? 'jemalloc-' : '' %>slim as base
+FROM <%= platform %>quay.io/evl.ms/fullstaq-ruby:${RUBY_VERSION}-<%= @options.jemalloc ? 'jemalloc-' : '' %>slim as base
 <% else -%>
-FROM ruby:$RUBY_VERSION-slim as base
+FROM <%= platform %>ruby:$RUBY_VERSION-slim as base
 <% end -%>
 
 # Rails app lives here
@@ -21,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? -%>
 
@@ -45,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
@@ -91,14 +79,7 @@ RUN bundle _${BUNDLER_VERSION}_ install<% if depend_on_bootsnap? -%> && \
 <% 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
@@ -124,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
@@ -152,7 +124,11 @@ COPY --from=client /rails/<%= api_client_dir %>/build /rails/public
 ENV RAILS_LOG_TO_STDOUT="1" \
     RAILS_SERVE_STATIC_FILES="true"<% if options.yjit %> \
     RUBY_YJIT_ENABLE="1"<% end %><% if options.jemalloc and not options.fullstaq %> \
+<% if (options.platform || Gem::Platform::local.cpu).include? 'arm' -%>
+    LD_PRELOAD="/usr/lib/aarch64-linux-gnu/libjemalloc.so.2" \
+<% else -%>
     LD_PRELOAD="/usr/lib/x86_64-linux-gnu/libjemalloc.so.2" \
+<% end -%>
     MALLOC_CONF="dirty_decay_ms:1000,narenas:2,background_thread:true"<% end %>
 
 # Entrypoint prepares the database.

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

@@ -1,28 +1,12 @@
 ARG NODE_VERSION=<%= node_version %>
 
-FROM node:$NODE_VERSION-slim as client
+FROM <%= platform %>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 -%>
+<%= render partial: 'npm_install', locals: {sources: api_client_files} %>
 
 # build client application
 COPY <%= api_client_dir %> .

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.1
+  version: 0.4.3
 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,10 +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,56 +0,0 @@
-TEMPLATE = <<-EOF
-  value is <%= five %>
-  other is <%= three %>
-EOF
-
-require 'delegate'
-require 'forwardable'
-require 'ostruct'
-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 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
-
-      def three
-        3
-      end
-    end).new(self, values)
-
-    puts renderer.result(scope.get_binding)
-  end
-
-  def get_binding
-    binding
-  end
-end
-
-puts '?'
-test = ShoppingList.new