dockerfile-rails 1.2.3 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98b182ee88ad6c1ba34edb41778c9d59dd329eefb6b199ede26697ded174aedb
-  data.tar.gz: 94e946801bc23ae53ce8ba8a4c7f8129a58e04aad1db4b9cf05bc5d43b22cebb
+  metadata.gz: e81390f34a7074b21fb4fc08e82b3b378bf40b0bf32529d94a55a3fb8f5b55c1
+  data.tar.gz: 6e83d04de7615de96f75edf66dde5aa8d39624a2e745ae2de796d352559c097e
 SHA512:
-  metadata.gz: f20bb484ad3637c100cf2ff9a786404a686e961db71dbfdc1d48d0b33ea461c8031bb2ddacc05ebd3857aaa5d318fe2d49c2ecc21cd760b1fa08fac9e963a28f
-  data.tar.gz: 80f23221cf71777312e57165a23b93a165feae6db3af97ac8c836e71295493ff952ca34f36e2a190f392508fb0e8a92b56a42c090262076063d75b386b96be56
+  metadata.gz: 16a4fc1e67c1583555b7fdae5af6346c8c2b06503d51b5896a89bd86c55d60e1506a65f50f3b5987f5962c6d14f4cfb1217d379884df168469f18b8f28f76d61
+  data.tar.gz: 031c86b3c27e7c594eef1fc3f653ada551a0fdae2919f753c46a339fdb30e378d7770b2db987acd10d2e0f84c36680a2c6190d5966b19383b36854ebfc6686ff

data/README.md

@@ -41,7 +41,9 @@ bin/rails generate dockerfile
 * `--ci` - include test gems in deployed image
 * `--compose` - generate a `docker-compose.yml` file
 * `--nginx` - serve static files via [nginx](https://www.nginx.com/).  May require `--root` on some targets to access `/dev/stdout`
+* `--no-link` - don't add [--link](https://docs.docker.com/engine/reference/builder/#copy---link) to COPY statements.  Some tools (like at the moment, [buildah](https://www.redhat.com/en/topics/containers/what-is-buildah)) don't yet support this feature.
 * `--no-lock` - don't add linux platforms, set `BUNDLE_DEPLOY`, or `--frozen-lockfile`.  May be needed at times to work around a [rubygems bug](https://github.com/rubygems/rubygems/issues/6082#issuecomment-1329756343).
+* `--sudo` - install and configure sudo to enable `sudo -iu rails` access to full environment
 
 ### Add a Database:
 

data/Rakefile

@@ -36,7 +36,7 @@ namespace :test do
         'Rails.application.routes.draw {get "/up", to: proc {[200, {}, ["ok"]]}}'
       sh "docker buildx build . --load -t system:test"
       key = IO.read("config/master.key")
-      sh "docker run -p 3000:3000 -e RAILS_MASTER_KEY=#{key} system:test"
+      sh "docker run -p 3000:3000 -e RAILS_MASTER_KEY=#{key} --rm system:test"
     end
   ensure
     rm_rf "test/tmp/system_test"

data/lib/generators/dockerfile_generator.rb

@@ -6,7 +6,7 @@ require_relative "../dockerfile-rails/scanner.rb"
 class DockerfileGenerator < Rails::Generators::Base
   include DockerfileRails::Scanner
 
-  OPTION_DEFAULTS = {
+  BASE_DEFAULTS = {
     "bin-cd" => false,
     "cache" => false,
     "ci" => false,
@@ -14,6 +14,7 @@ class DockerfileGenerator < Rails::Generators::Base
     "fullstaq" => false,
     "jemalloc" => false,
     "label" => {},
+    "link" => true,
     "lock" => true,
     "mysql" => false,
     "nginx" => false,
@@ -25,10 +26,13 @@ class DockerfileGenerator < Rails::Generators::Base
     "redis" => false,
     "root" => false,
     "sqlite3" => false,
+    "sudo" => false,
     "swap" => nil,
     "yjit" => false,
   }.then { |hash| Struct.new(*hash.keys.map(&:to_sym)).new(*hash.values) }
 
+  OPTION_DEFAULTS = BASE_DEFAULTS.dup
+
   @@labels = {}
   @@packages = { "base" => [], "build" => [], "deploy" => [] }
   @@vars = { "base" => {}, "build" => {}, "deploy" => {} }
@@ -68,6 +72,9 @@ class DockerfileGenerator < Rails::Generators::Base
   class_option :ci, type: :boolean, default: OPTION_DEFAULTS.ci,
     desc: "include test gems in bundle"
 
+  class_option :link, type: :boolean, default: OPTION_DEFAULTS.lock,
+    desc: "use COPY --link whenever possible"
+
   class_option :lock, type: :boolean, default: OPTION_DEFAULTS.lock,
     desc: "lock Gemfile/package.json"
 
@@ -125,6 +132,8 @@ class DockerfileGenerator < Rails::Generators::Base
   class_option :root, type: :boolean, default: OPTION_DEFAULTS.root,
     desc: "Run application as root user"
 
+  class_option :sudo, type: :boolean, default: OPTION_DEFAULTS.sudo,
+    desc: "Install and configure sudo to enable running as rails with full environment"
 
   class_option "add-base", type: :array, default: [],
     desc: "additional packages to install for both build and deploy"
@@ -212,18 +221,27 @@ 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"
+        package["scripts"]["build"] = "vite build --outDir public"
 
         say_status :update, "package.json"
         IO.write("package.json", JSON.pretty_generate(package))
       end
     end
+
+    @dockerfile_config = (@dockerfile_config.to_a - BASE_DEFAULTS.to_h.stringify_keys.to_a).to_h
+    %w(packages envs args).each do |key|
+      @dockerfile_config.delete key if @dockerfile_config[key].empty?
+    end
+
+    if !@dockerfile_config.empty?
+      template "dockerfile.yml.erb", "config/dockerfile.yml", force: true
+    elsif File.exist? "config/dockerfile.yml"
+      remove_file "config/dockerfile.yml"
+    end
   end
 
 private
@@ -301,6 +319,10 @@ private
 
     gemfile = IO.read("Gemfile")
 
+    unless /^\s*source\s/.match?(gemfile)
+      gemfile = %{source "https://rubygems.org"\n} + gemfile
+    end
+
     if options.postgresql? || @postgresql
       system "bundle add pg --skip-install" unless @gemfile.include? "pg"
     end
@@ -343,6 +365,16 @@ private
     end
   end
 
+  def base_gems
+    gems = ["bundler"]
+
+    if options.ci? && options.lock? && @gemfile.include?("debug")
+      gems += %w(irb reline) - @gemfile
+    end
+
+    gems.sort
+  end
+
   def base_packages
     packages = []
     packages += @@packages["base"] if @@packages["base"]
@@ -454,6 +486,9 @@ private
     # nginx
     packages << "nginx" if options.nginx?
 
+    # sudo
+    packages << "sudo" if options.sudo?
+
     packages.sort
   end
 

data/lib/generators/templates/Dockerfile.erb

@@ -32,10 +32,7 @@ ENV <%= base_env.join(" \\\n    ") %>
 
 # Update gems and bundler
 RUN gem update --system --no-document && \
-<% if options.ci? and options.lock? -%>
-    gem install -N irb reline && \
-<% end -%>
-    gem install -N bundler
+    gem install -N <%= base_gems.join(" ") %>
 
 <% unless base_requirements.empty? -%>
 # Install packages needed to install <%= base_requirements %>
@@ -82,7 +79,7 @@ ENV <%= build_env.join(" \\\n    ") %>
 
 <% end -%>
 # Install application gems
-COPY Gemfile Gemfile.lock .
+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 \
     bundle config set app_config .bundle && \
@@ -98,7 +95,8 @@ RUN --mount=type=cache,id=bld-gem-cache,sharing=locked,target=/srv/vendor \
 
 <% else -%>
 RUN bundle install<% if depend_on_bootsnap? -%> && \
-    bundle exec bootsnap precompile --gemfile<% end %>
+    bundle exec bootsnap precompile --gemfile<% end %> && \
+    rm -rf ~/.bundle/ $BUNDLE_PATH/ruby/*/cache $BUNDLE_PATH/ruby/*/bundler/gems/*/.git
 
 <% end -%>
 <% if parallel? -%>
@@ -110,7 +108,7 @@ COPY --from=node /rails/node_modules /rails/node_modules
 
 <% end -%>
 # Copy application code
-COPY . .
+COPY<% if options.link? %> --link<% end %> . .
 
 <% if depend_on_bootsnap? -%>
 # Precompile bootsnap code for faster boot times
@@ -161,7 +159,7 @@ ARG UID=1000 \
     GID=1000
 RUN groupadd -f -g $GID rails && \
     useradd -u $UID -g $GID rails<% else -%>
-RUN useradd rails<% end -%><% if options.nginx? %> && \
+RUN useradd rails<% end -%> --home /rails --shell /bin/bash<% if options.nginx? %> && \
     chown rails:rails /var/lib/nginx /var/log/nginx/*<% end %>
 <% unless options.swap -%>
 USER rails:rails

data/lib/generators/templates/_apt_install.erb

@@ -6,6 +6,9 @@ RUN --mount=type=cache,id=dev-apt-cache,sharing=locked,target=/var/cache/apt \
 <% else -%>
 RUN <%= repos %>apt-get update -qq && \
     apt-get install --no-install-recommends -y <%= packages.join(" ") %><% if clean %> && \
+<% if packages.include?("sudo") && options.sudo? -%>
+    sed -i 's/env_reset/env_keep="*"/' /etc/sudoers && \
+<% end -%>
     rm -rf /var/lib/apt/lists /var/cache/apt/archives<% end %>
 <% end -%>
 <% if @sqlserver -%>

data/lib/generators/templates/_node_client.erb

@@ -9,5 +9,5 @@ ENV NODE_ENV=production
 <%= render partial: 'npm_install', locals: {sources: api_client_files} %>
 
 # build client application
-COPY <%= api_client_dir %> .
-RUN npm run build
+COPY<% if options.link? %> --link<% end %> <%= api_client_dir %> .
+RUN npm run build

data/lib/generators/templates/_npm_install.erb

@@ -1,5 +1,5 @@
 # Install node modules
-COPY <%=sources.join(' ') %> .
+COPY<% if options.link? %> --link<% end %> <%= sources.join(' ') %> ./
 <% 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 %>

metadata

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