dockerfile-rails 1.5.3 → 1.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b14b8dc852c4d34ae6fa48251cb680e89a9c08fe81942d336d21f18418643e38
-  data.tar.gz: 3d61361b94688abd9545d59a43cb22fda5fc4ecd947353a7397ee88e5cfa0b68
+  metadata.gz: fb14492c49c1cf3daf989207c2188413c0311a317a95727330fcec570f79632c
+  data.tar.gz: c18d7c536626010b3befe71e23ef8c99b53095680e7050dfbcfecd59960cba91
 SHA512:
-  metadata.gz: becc43052f96c77dc89fa920039c43151737bfd284a8b533185e7334989506b28db8c6ab87da9748712c9c52de0cb7b344ef0308992d4306fc7b47a6be0eeac6
-  data.tar.gz: 11210697f2034ea5295611f7b6548cad9e5712bdd8906e0acc083edde2e35404f51c22fb2624d8e4c087c02be7319c6f71a7f76d98f5054f85d6472012767fbc
+  metadata.gz: 50725e7ac313645b93fddb4742a2e711b08e01ba1c593bd0126a70135d04f7467b9d2caa476eb2642903392fc805e2a38ff811aede86c4a2c23843aa30be0189
+  data.tar.gz: 85c0608fc27c115b95d42ddeef4b86b2e5c6be63f652338d01d4b24886686036e2572bab94356f41b3f6e18123d07370b2982f4b224eba34997ef0707381f557

data/README.md

@@ -85,6 +85,7 @@ Not all of your needs can be determined by scanning your application.  For examp
 * `--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.
 * `--root` - run application as root
 * `--windows` - make Dockerfile work for Windows users that may have set `git config --global core.autocrlf true`
+* `--private-gemserver-domain=gems.example.com` - set the domain name of your private gemserver.  This is used to tell bundler for what domain to use the credentials of a private gemserver provided via a docker secret
 
 ### Advanced Customization:
 
@@ -119,7 +120,7 @@ rake test
 ruby test/test_minimal.rb
 ```
 
-To assis with this process, outputs of tests can be captured automatically.  This is useful when adding new tests and when making a change that affects many tests.  Be sure to inspect the output (e.g., by using `git diff`) before committing.
+To assist with this process, outputs of tests can be captured automatically.  This is useful when adding new tests and when making a change that affects many tests.  Be sure to inspect the output (e.g., by using `git diff`) before committing.
 
 ```
 rake test:capture

data/lib/generators/dockerfile_generator.rb

@@ -28,6 +28,7 @@ class DockerfileGenerator < Rails::Generators::Base
     "postgresql" => false,
     "precompile" => nil,
     "prepare" => true,
+    "private-gemserver-domain" => nil,
     "procfile" => "",
     "redis" => false,
     "registry" => "",
@@ -183,6 +184,9 @@ class DockerfileGenerator < Rails::Generators::Base
   class_option "procfile", type: :string, default: OPTION_DEFAULTS.procfile,
     desc: "custom procfile to start services"
 
+  class_option "private-gemserver-domain", type: :string, default: OPTION_DEFAULTS["private-gemserver-domain"],
+    desc: "domain name of a private gemserver used when installing application gems"
+
 
   class_option "add-base", type: :array, default: [],
     desc: "additional packages to install for both build and deploy"
@@ -538,6 +542,7 @@ private
     # start with the essentials
     packages = %w(build-essential)
     packages += @@packages["build"] if @@packages["build"]
+    packages += %w(nodejs npm) if node_version == "lts"
 
     # add databases: sqlite3, postgres, mysql
     packages << "pkg-config" if options.sqlite3? || @sqlite3
@@ -849,7 +854,9 @@ private
 
   def binfile_fixups
     # binfiles may have OS specific paths to ruby.  Normalize them.
-    shebangs = Dir["bin/*"].map { |file| IO.read(file).lines.first }.join
+    shebangs = Dir["bin/*"].map do |file|
+      IO.read(file).lines.first.encode("UTF-8", "binary", invalid: :replace, undef: :replace, replace: "")
+    end.join
     rubies = shebangs.scan(%r{#!/usr/bin/env (ruby.*)}).flatten.uniq
 
     binfixups = (rubies - %w(ruby)).map do |ruby|
@@ -1039,6 +1046,19 @@ private
     nil
   end
 
+  # Takes the domain of the private gemserver and returns the name of the
+  # environment variable, as expected by bundler.
+  #
+  # For example, if the domain is "gems.example.com", the environment variable
+  # name will be "BUNDLE_GEMS__EXAMPLE__COM".
+  def private_gemserver_env_variable_name
+    option = options["private-gemserver-domain"]
+
+    return nil if option.blank?
+
+    "BUNDLE_#{option.upcase.gsub(".", "__")}"
+  end
+
   # if running on fly v2, make a best effort to attach consul
   def fly_attach_consul
     # certainly not fly unless there is a fly.toml

data/lib/generators/templates/Dockerfile.erb

@@ -86,10 +86,15 @@ ENV <%= build_env.join(" \\\n    ") %>
 COPY<% if options.link? %> --link<% end %> Gemfile Gemfile.lock ./
 <% if options.cache? -%>
 RUN --mount=type=cache,id=bld-gem-cache,sharing=locked,target=/srv/vendor \
+<% if private_gemserver_env_variable_name -%>
+    --mount=type=secret,id=gemserver_credentials,dst=/kaniko/gemserver_credentials \
+    <%= private_gemserver_env_variable_name %>="$(cat /kaniko/gemserver_credentials)" && \
+    export <%= private_gemserver_env_variable_name %> && \
+<% end -%>
     bundle config set app_config .bundle && \
     bundle config set path /srv/vendor && \
     bundle install && \
-<% if depend_on_bootsnap? -%>
+<% if depend_on_bootsnap? && options.precompile != "defer" -%>
     bundle exec bootsnap precompile --gemfile && \
 <% end -%>
     bundle clean && \
@@ -98,8 +103,16 @@ RUN --mount=type=cache,id=bld-gem-cache,sharing=locked,target=/srv/vendor \
     cp -ar /srv/vendor .
 
 <% else -%>
-RUN bundle install<% if depend_on_bootsnap? -%> && \
+<% if private_gemserver_env_variable_name -%>
+RUN --mount=type=secret,id=gemserver_credentials,dst=/kaniko/gemserver_credentials \
+    <%= private_gemserver_env_variable_name %>="$(cat /kaniko/gemserver_credentials)" && \
+    export <%= private_gemserver_env_variable_name %> && \
+    bundle install<% if depend_on_bootsnap? && options.precompile != "defer" -%> && \
     bundle exec bootsnap precompile --gemfile<% end %> && \
+<% else -%>
+RUN bundle install<% if depend_on_bootsnap? && options.precompile != "defer" -%> && \
+    bundle exec bootsnap precompile --gemfile<% end %> && \
+<% end -%>
     rm -rf ~/.bundle/ $BUNDLE_PATH/ruby/*/cache $BUNDLE_PATH/ruby/*/bundler/gems/*/.git
 
 <% end -%>
@@ -115,7 +128,7 @@ COPY --from=node /usr/local/node /usr/local/node
 ENV PATH=/usr/local/node/bin:$PATH
 
 <% elsif using_node? -%>
-<%= render partial: 'npm_install', locals: {sources: Dir[*%w(package.json package-lock.json yarn.lock)]} %>
+<%= render partial: 'npm_install', locals: {sources: Dir[*%w(.npmrc .yarnrc package.json package-lock.json yarn.lock)]} %>
 
 <% end -%>
 # Copy application code

data/lib/generators/templates/_install_node.erb

@@ -5,13 +5,13 @@
 <% elsif yarn_version -%>
 # Install yarn
 <% end -%>
-<% if node_version -%>
+<% if node_version && node_version != 'lts' -%>
 ARG NODE_VERSION=<%= node_version %>
 <% end -%>
 <% if yarn_version -%>
 ARG YARN_VERSION=<%= yarn_version %>
 <% end -%>
-<% if node_version -%>
+<% if node_version && node_version != 'lts' -%>
 ENV PATH=/usr/local/node/bin:$PATH
 RUN curl -sL https://github.com/nodenv/node-build/archive/master.tar.gz | tar xz -C /tmp/ && \
     /tmp/node-build-master/bin/node-build "${NODE_VERSION}" /usr/local/node && \

data/lib/generators/templates/_npm_install.erb

@@ -1,5 +1,8 @@
 # Install node modules
 COPY<% if options.link? %> --link<% end %> <%= sources.join(' ') %> ./
+<% if sources.join.include?('.yarnrc') && !Dir['.yarn/releases/*'].empty? -%>
+COPY<% if options.link? %> --link<% end %> .yarn/releases/* .yarn/releases/
+<% end -%>
 <% if sources.join.include? 'yarn' -%>
 RUN <% if options.cache? -%>--mount=type=cache,id=bld-yarn-cache,target=/root/.yarn \
     YARN_CACHE_FOLDER=/root/.yarn <% end -%>yarn install<% if options.lock? %> --frozen-lockfile<% end %>

data/lib/generators/templates/docker-compose.yml.erb

@@ -3,6 +3,10 @@ services:
   web:
 <% if all_args.empty? -%>
     build: .
+<% if private_gemserver_env_variable_name -%>
+    secrets:
+      - gemserver_credentials
+<% end -%>
 <% else -%>
     build:
       context: .
@@ -10,6 +14,10 @@ services:
 <% all_args.each do |name, value| -%>
         <%= name %>: <%= value.html_safe? ? value : "\"#{Shellwords.escape(value)}\"" %>
 <% end -%>
+<% if private_gemserver_env_variable_name -%>
+    secrets:
+      - gemserver_credentials
+<% end -%>
 <% end -%>
     ports:
       - "3000:3000"
@@ -110,3 +118,9 @@ services:
         condition: service_healthy
 <% end -%>
 <% end -%>
+<% if private_gemserver_env_variable_name -%>
+
+secrets:
+  gemserver_credentials:
+    file: ./GEMSERVER_CREDENTIALS.secret.txt
+<% end -%>

data/lib/generators/templates/dockerignore.erb

@@ -39,6 +39,11 @@
 <% end -%>
 <% unless options.api? -%>
 
+<% if private_gemserver_env_variable_name -%>
+# Ignore gemserver credentials.
+GEMSERVER_CREDENTIALS.secret.txt
+
+<% end -%>
 # Ignore assets.
 /node_modules/
 /app/assets/builds/*

metadata

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