dockerfile-rails 0.3.2 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d9ad7d1afb7766ab99f26cebe531e5242c0e1b045965f8b1b08cdb7d3048b4e
-  data.tar.gz: bce09d700333e1bb6cc3a80d9abcdfede0cbd3fb48157c0655342ea89bb68643
+  metadata.gz: 7267f137214c8c519555cc4b3775f844eb9f4028a01522b1fee0952301f488a5
+  data.tar.gz: a27afadb1ccc74385cc12ddd4c6dea9445487035c48babd26eaab3c4712d539d
 SHA512:
-  metadata.gz: 452a96a35af88b08aca8229ff52be8ebc37712da48ec2b17f5b3ab8147c7901e0ee344698d209c9cd515fd984dfc652d188a01718a3853b00d790cc9bb9ed7f2
-  data.tar.gz: 7b11087072696ef3aae63f895e8680ed048d60500f3d6947319c2ffa47254b9af6a02c7f63584ccf6782affb88e198d2d16eb438703c6cc85d023427b280a1f7
+  metadata.gz: 5ee1cf151c6521cdc3b29e13008716fa392e49649e6bc9614f095c911805c153e235c75704a3d0c09a6f1ffab9cb5bb3d9db92dac32fd441a7e350418bcee3f7
+  data.tar.gz: 993df0bde29fffa8b637cbf142e28403a02143c697f2df5c95021721b0ef4ba85e8a251d6196d99a1156b07e2f9dd82511c009df9641884892d64ec0ec3052bf

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,6 +32,12 @@ 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.
+
 Links:
 
 * [Demos](./DEMO.md)

data/lib/erbtest.rb

@@ -5,6 +5,7 @@ EOF
 
 require 'delegate'
 require 'forwardable'
+require 'ostruct'
 class Scope < SimpleDelegator
 end
 
@@ -20,14 +21,28 @@ class ShoppingList
 
     values = {one: 'One', three: 'tHrEe'}
 
-    scope = (Class.new(SimpleDelegator) do
-      extend Forwardable
-      def_delegators values, :one, :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)
+    end).new(self, values)
 
     puts renderer.result(scope.get_binding)
   end

data/lib/generators/dockerfile_generator.rb

@@ -1,3 +1,5 @@
+require 'erb'
+
 class DockerfileGenerator < Rails::Generators::Base
   include DockerfileRails::Scanner
 
@@ -13,7 +15,7 @@ class DockerfileGenerator < Rails::Generators::Base
   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,
@@ -25,6 +27,15 @@ class DockerfileGenerator < Rails::Generators::Base
   class_option :mysql, type: :boolean, default: false,
     desc: 'include mysql libraries'
 
+  class_option :jemalloc, type: :boolean, default: false,
+    desc: 'use jemalloc alternative malloc implementation'
+  
+  class_option :fullstaq, type: :boolean, default: false,
+    descr: 'use Fullstaq Ruby image from Quay.io'
+
+  class_option :yjit, type: :boolean, default: false,
+    desc: 'enable YJIT optimizing compiler'
+
   def generate_app
     source_paths.push File.expand_path('./templates', __dir__)
 
@@ -43,6 +54,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.strip, trim_mode: '-').result(scope.get_binding)
+  end
+
   def using_node?
     return @using_node if @using_node != nil
     @using_node = File.exist? 'package.json'
@@ -175,7 +210,7 @@ private
   end
 
   def depend_on_bootsnap?
-    @gemfile.include? 'bootstrap'
+    @gemfile.include? 'bootsnap'
   end
 
   def api_only?

data/lib/generators/templates/Dockerfile.erb

@@ -3,39 +3,15 @@
 # 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 %>
+<%= render partial: 'node_client' %>
 
-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 -%>
+<% if options.fullstaq -%>
+FROM quay.io/evl.ms/fullstaq-ruby:${RUBY_VERSION}-<%= @options.jemalloc ? 'jemalloc-' : '' %>slim as base
 <% 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
-
-
-<% end -%>
 FROM ruby:$RUBY_VERSION-slim as base
+<% end -%>
 
 # Rails app lives here
 WORKDIR /rails
@@ -99,12 +75,17 @@ 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? -%>
@@ -125,7 +106,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? -%>
@@ -169,7 +150,10 @@ COPY --from=client /rails/<%= api_client_dir %>/build /rails/public
 
 # Deployment options
 ENV RAILS_LOG_TO_STDOUT="1" \
-    RAILS_SERVE_STATIC_FILES="true"
+    RAILS_SERVE_STATIC_FILES="true"<% if options.yjit %> \
+    RUBY_YJIT_ENABLE="1"<% end %><% if options.jemalloc and not options.fullstaq %> \
+    LD_PRELOAD="/usr/lib/x86_64-linux-gnu/libjemalloc.so.2" \
+    MALLOC_CONF="dirty_decay_ms:1000,narenas:2,background_thread:true"<% end %>
 
 # Entrypoint prepares the database.
 ENTRYPOINT ["/rails/bin/docker-entrypoint"]

data/lib/generators/templates/_node_client.erb

@@ -0,0 +1,29 @@
+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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dockerfile-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.1
 platform: ruby
 authors:
 - Sam Ruby
@@ -39,6 +39,7 @@ files:
 - lib/erbtest.rb
 - lib/generators/dockerfile_generator.rb
 - lib/generators/templates/Dockerfile.erb
+- lib/generators/templates/_node_client.erb
 - lib/generators/templates/docker-compose.yml.erb
 - lib/generators/templates/docker-entrypoint.erb
 - lib/generators/templates/dockerignore.erb