dockerfile-rails 1.0.12 → 1.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 043aa3c0a4b14ac51fc30d0266ff8d2447d01728e7b5ecaafafcebddbf16901f
-  data.tar.gz: e8dedad246afe6219ca847f025dffacc3e38f4792fc4320165d38690a2da0e21
+  metadata.gz: 850bc5224e5a60f46df7ddf4c7c31374d891d27fc2145a15cb1eb021f798f63f
+  data.tar.gz: a4254547f34fbd026215ec07c1f4c81a1eef9a15780cbc5b664cb05df5e70ef3
 SHA512:
-  metadata.gz: acedc8f05a1aab43223b1e45b4f9be5d66641c1910fefe48d357bfeb815cb20d599db1e7621db2e6412952dddde8d06ad775ae1d7d724549a3f35e5633e1e602
-  data.tar.gz: e67da6cf703d44c0c098da03431cd3d43aa89ddfc5ca6482c064d5c6a0fcd3180387578b94775dd471f8e868712ac30f268c6ca849f0c98483b3d1fe36e45f72
+  metadata.gz: 30e21fea124f3293d384c0fcaae6f1001985a81e5ed229b8b49d321733f61b98c8f46f5cd9586ad35c37198604e90ddbd107ad54e2a09a0d1b96067791c31c48
+  data.tar.gz: 52eed0118d7eb11ffe6833f4e6339d7736174d2035e94eee369d05586e6c0fe44051907481ec065e1e4d88212abc692277838c3ea34865dbbb2e3053e68de505

data/README.md

@@ -22,8 +22,13 @@ Runtime 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
+* `--yjit` - enable [YJIT](https://github.com/ruby/ruby/blob/master/doc/yjit/yjit.md) optimizing compiler
+
+Build optimizations:
+
+* `--cache` - use build caching to speed up builds
+* `--parallel` - use multi-stage builds to install gems and node modules in parallel
 
 Features:
 
@@ -31,11 +36,6 @@ Features:
 * `--compose` - generate a `docker-compose.yml` file
 * `--nginx` - serve static files via [nginx](https://www.nginx.com/)
 
-Build:
-
-* `--cache` - use build caching to speed up builds
-* `--parallel` - use multi-stage builds to install gems and node modules in parallel
-
 Dependencies:
 
 Generally the dockerfile generator will be able to determine what dependencies you
@@ -50,9 +50,10 @@ additional support may be needed:
 Configuration:
 
 * `--bin-cd` - adjust binstubs to set current working directory
+* `--label=name:value` - specify docker label.  Can be used multiple times.  See [LABEL](https://docs.docker.com/engine/reference/builder/#label) for detail
 * `--no-prepare` - omit `db:prepare`.  Useful for cloud platforms with [release](https://devcenter.heroku.com/articles/release-phase) phases
 * `--platform=s` - specify target platform.  See [FROM](https://docs.docker.com/engine/reference/builder/#from) for details
-* `--label=name:value` - specify docker label.  Can be used multiple times.  See [LABEL](https://docs.docker.com/engine/reference/builder/#label) for detail
+* `--precompile=defer` - may be needed when your configuration requires access to secrets that are not available at build time.  Results in larger images and slower deployments.
 
 Options are saved between runs into `config/dockerfile.yml`.  To invert a boolean options, add or remove a `no-` prefix from the option name.
 

data/lib/generators/dockerfile_generator.rb

@@ -15,6 +15,7 @@ class DockerfileGenerator < Rails::Generators::Base
     'parallel' => false,
     'platform' => nil,
     'postgresql' => false,
+    'precompile' => nil,
     'prepare' => true,
     'redis' => false,
     'swap' => nil,
@@ -41,6 +42,9 @@ class DockerfileGenerator < Rails::Generators::Base
   class_option :ci, type: :boolean, default: OPTION_DEFAULTS.ci,
     desc: 'include test gems in bundle'
 
+  class_option :precompile, type: :string, default: OPTION_DEFAULTS.precompile,
+    desc: 'if set to "defer", assets:precompile will be done at deploy time'
+
   class_option 'bin-cd', type: :boolean, default: OPTION_DEFAULTS['bin-cd'],
     desc: 'modify binstubs to set working directory'
 
@@ -118,6 +122,17 @@ class DockerfileGenerator < Rails::Generators::Base
     template 'docker-compose.yml.erb', 'docker-compose.yml' if options.compose
 
     template 'dockerfile.yml.erb', 'config/dockerfile.yml', force: true
+
+    if @gemfile.include?('vite_ruby')
+      package = JSON.load_file('package.json')
+      unless package.dig('scripts', 'build')
+        package['scripts'] ||= {}
+        package['scripts']['build'] = 'vite build --outDir public'
+
+        say_status :update, 'package.json'
+        IO.write('package.json', JSON.pretty_generate(package))
+      end
+    end
   end
 
 private
@@ -260,11 +275,11 @@ private
       # how python is installed with the bullseye release.  Below
       # is based on debian release included with the Ruby images on
       # Dockerhub.
-      case Gem.ruby_version
+      case RUBY_VERSION
       when /^2.7/
-        bullseye = ruby_version >= "2.7.4"
+        bullseye = RUBY_VERSION >= "2.7.4"
       when /^3.0/
-        bullseye = ruby_version >= "3.0.2"
+        bullseye = RUBY_VERSION >= "3.0.2"
       else
         bullseye = true
       end
@@ -495,4 +510,15 @@ private
       }
     end
   end
+
+  def more_docker_ignores
+    more = ''
+
+    if @gemfile.include?('vite_ruby')
+      lines = IO.read('.gitignore')[/^# Vite.*?\n\n/m].to_s.chomp.lines -
+         ["node_modules\n"]
+
+      more += "\n" + lines.join
+    end
+  end
 end

data/lib/generators/templates/Dockerfile.erb

@@ -8,9 +8,9 @@ ARG RUBY_VERSION=<%= RUBY_VERSION %>
 
 <% end -%>
 <% if options.fullstaq -%>
-FROM <%= platform %>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<% unless options.precompile == "defer" %> as base<% end %>
 <% else -%>
-FROM <%= platform %>ruby:$RUBY_VERSION-slim as base
+FROM <%= platform %>ruby:$RUBY_VERSION-slim<% unless options.precompile == "defer" %> as base<% end %>
 <% end -%>
 
 <% unless options.label.empty? -%>
@@ -44,10 +44,12 @@ RUN gem update --system --no-document && \
 <%= render partial: 'install_node', locals: {yarn_version: nil} %>
 
 <% end -%>
+<% unless options.precompile == "defer" -%>
 
 # Throw-away build stage<%= parallel? ? 's' : '' %> to reduce size of final image
 FROM base as <%= parallel? ? 'pre' : '' %>build
 
+<% end -%>
 # Install packages needed to build gems<%= using_node? ? " and node modules" : "" %>
 <%= render partial: 'apt_install', locals: {packages: build_packages, clean: false, repos: ''} %>
 
@@ -112,6 +114,7 @@ RUN bundle exec bootsnap precompile app/ lib/
 <%= "RUN " + binfile_fixups.join(" && \\\n    ") %>
 
 <% end -%>
+<% unless options.precompile == "defer" -%>
 <% if Dir.exist?('app/assets') and !api_only? -%>
 # Precompiling assets for production without requiring secret RAILS_MASTER_KEY
 RUN SECRET_KEY_BASE<%= Rails::VERSION::MAJOR<7 || Rails::VERSION::STRING.start_with?('7.0') ? '=DUMMY' : '_DUMMY=1' %> ./bin/rails assets:precompile
@@ -120,8 +123,9 @@ RUN SECRET_KEY_BASE<%= Rails::VERSION::MAJOR<7 || Rails::VERSION::STRING.start_w
 
 # Final stage for app image
 FROM base
-<% unless deploy_packages.empty? -%>
 
+<% end -%>
+<% unless deploy_packages.empty? -%>
 # Install packages needed for deployment
 <%= render partial: 'apt_install', locals: {packages: deploy_packages, clean: true, repos: deploy_repos} %>
 <% end -%>
@@ -133,6 +137,7 @@ FROM base
 RUN gem install foreman
 
 <% end -%>
+<% unless options.precompile == "defer" -%>
 # Copy built application from previous stage
 COPY --from=build /rails /rails
 <% if api_client_dir -%>
@@ -141,6 +146,7 @@ COPY --from=build /rails /rails
 COPY --from=client /rails/<%= api_client_dir %>/build /rails/public
 <% end -%>
 
+<% end -%>
 <% unless deploy_env.empty? -%>
 # Deployment options
 ENV <%= deploy_env.join(" \\\n    ") %>

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

@@ -17,6 +17,9 @@ if [ "${*}" == "foreman start --procfile=Procfile.prod" ]; then
 <% else -%>
 # If running the rails server then create or migrate existing database
 if [ "${*}" == "./bin/rails server" ]; then
+<% end -%>
+<% if options.precompile == "defer" -%>
+  ./bin/rails assets:precompile
 <% end -%>
   ./bin/rails <%= dbprep_command %>
 fi

data/lib/generators/templates/dockerignore.erb

@@ -45,3 +45,4 @@
 <% end -%>
 /public/assets
 <% end -%>
+<%= more_docker_ignores -%>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dockerfile-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.12
+  version: 1.0.14
 platform: ruby
 authors:
 - Sam Ruby
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-09 00:00:00.000000000 Z
+date: 2023-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails