dockerfile-rails 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67a9e8789b4664b2bcfe089e2e945aa1c2eee3db60adb3681e40f14cd51c2336
-  data.tar.gz: 830f021a2e7123db896bc8ee0dd990f6e4ee2c72c6bce79677ad84b07e13ab84
+  metadata.gz: 0227d5ff2b7d0a0d42d48ba7e3be63280ea528f3f80417a6419dfebbec44b3a7
+  data.tar.gz: ee9b4b14b72b85193a6e7b54862f6643b02896c5ff4636b294a845e7ae6a1b35
 SHA512:
-  metadata.gz: bc6fe2c172e7643e1cbce78e0e771bcb04db044d59f0125a4b420c6f2edfd984c0edd87402192335d14d6e136d44287e6e6a307bd273675b015aded3827934fe
-  data.tar.gz: 419134947acae57198255a99166fb16bd907ac5b581e0565a0765530591e2e277e8e4a90814ee0d28fc8db6b791d7e9ff5850d33819a448beafc99eb0593c46c
+  metadata.gz: 2e9f99b443c3cab5dca0d5800eb996b7f727ef0dbfcf44ad0e1586edf1ed9691b3cafbf1c608f207a55c63fd9d768e2796c4d3644c3e6715214ca5aa159ae122
+  data.tar.gz: 6980319c05859df14c35649159c874271162ff83ac1c2918e4c959c93f6f39b29f5a4002cbf9305f82404ae8b5d00ee4d0e401e420c37a86abb6b0c8362adcf8

data/DEMO.md

@@ -275,3 +275,31 @@ bin/rails generate dockerfile
 docker buildx build . -t rails-welcome
 docker run -p 3000:3000 -e RAILS_MASTER_KEY=$(cat config/master.key) rails-welcome
 ```
+
+# Demo 5 - Grover / puppeteer / Chrome
+
+This demo runs only on Intel hardware as Google doesn't supply Chrome
+binaries for Linux on ARM.
+
+```bash
+rails new welcome --minimal
+cd welcome
+bundle add grover
+npm install puppeteer
+
+echo 'Rails.application.routes.draw { root "grover#pdf" }' > config/routes.rb
+
+cat << 'EOF' > app/controllers/grover_controller.rb
+class GroverController < ApplicationController
+  def pdf
+    grover = Grover.new('https://google.com', format: 'A4')
+    send_data grover.to_pdf, filename: 'google.pdf', type: :pdf
+  end
+end
+EOF
+
+bundle add dockerfile-rails --group development
+bin/rails generate dockerfile
+docker buildx build . -t rails-welcome
+docker run -p 3000:3000 -e RAILS_MASTER_KEY=$(cat config/master.key) rails-welcome
+```

data/README.md

@@ -10,7 +10,7 @@ Provides a Rails generator to produce Dockerfiles and related files.  This is be
 ## Usage
 
 ```
-bundle add dockerfile-rails --version ">= 0.5.0" --group development
+bundle add dockerfile-rails --optimistic --group development
 bin/rails generate dockerfile
 ```
 

data/lib/dockerfile-rails/scanner.rb

@@ -40,9 +40,7 @@ module DockerfileRails
         end
       end
 
-      @sidekiq = @gemfile.include? 'sidekiq'
       @anycable = @gemfile.include? 'anycable-rails'
-      @rmagick = @gemfile.include? 'rmagick'
       @vips = @gemfile.include? 'ruby-vips'
       @bootstrap = @gemfile.include? 'bootstrap'
       @puppeteer = @gemfile.include? 'puppeteer'
@@ -73,7 +71,7 @@ module DockerfileRails
         @redis_cache = true
       end
 
-      @redis = @redis_cable || @redis_cache || @sidekiq
+      @redis = @redis_cable || @redis_cache
     end
   end
 end

data/lib/generators/dockerfile_generator.rb

@@ -142,11 +142,19 @@ private
   end
 
   def using_redis?
-    options.redis? or @redis
+    options.redis? or @redis or @gemfile.include?('sidekiq')
   end
 
   def using_execjs?
-    @gemfile.include? 'execjs'
+    @gemfile.include?('execjs') or @gemfile.include?('grover')
+  end
+
+  def using_puppeteer?
+    @gemfile.include?('grover') or @gemfile.include?('puppeteer-ruby')
+  end
+
+  def using_sidekiq?
+    @gemfile.include?('sidekiq')
   end
 
   def parallel?
@@ -172,6 +180,27 @@ private
     end
   end
 
+  def base_packages
+    packages = []
+
+    if using_execjs?
+      packages += %w(curl unzip)
+    end
+
+    if using_puppeteer?
+      packages += %w(curl gnupg)
+    end
+
+    packages.sort.uniq
+  end
+
+  def base_requirements
+    requirements = []
+    requirements << 'nodejs' if using_execjs?
+    requirements << 'chrome' if using_puppeteer?
+    requirements.join(' and ')
+  end
+
   def build_packages
     # start with the essentials
     packages = %w(build-essential)
@@ -184,7 +213,7 @@ private
     # add git if needed to install gems
     packages << 'git' if @git
 
-    # add redis in case Action Cable, caching, or sidekiq are added later
+    # add redis if Action Cable, caching, or sidekiq are used
     packages << "redis" if options.redis? or using_redis?
 
     # ActiveStorage preview support
@@ -196,7 +225,7 @@ private
     # node support, including support for building native modules
     if using_node?
       packages += %w(node-gyp pkg-config)
-      packages += %w(curl unzip) unless using_execjs?
+      packages += %w(curl unzip) unless using_execjs? or using_puppeteer?
 
       # module build process depends on Python, and debian changed
       # how python is installed with the bullseye release.  Below
@@ -236,11 +265,34 @@ private
     packages << "libvips" if @gemfile.include? 'ruby-vips'
 
     # Rmagick gem
-    packages << 'imagemagick' if @gemfile.include? 'rmagick'
+    if @gemfile.include?('rmagick') or @gemfile.include?('mini_magick')
+      packages << 'imagemagick'
+    end
+
+    # Puppeteer
+    packages << 'google-chrome-stable' if using_puppeteer?
 
     packages.sort
   end
 
+  def deploy_repos
+    repos = []
+
+    if using_puppeteer?
+      repos += [
+       "curl https://dl-ssl.google.com/linux/linux_signing_key.pub |",
+       "gpg --dearmor > /etc/apt/trusted.gpg.d/google-archive.gpg &&",
+       'echo "deb http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list'
+      ]
+    end
+
+    if repos.empty?
+      ''
+    else
+      repos.join(" \\\n    ") + " && \\\n    "
+    end
+  end
+
   def deploy_env
     env = []
 
@@ -263,6 +315,11 @@ private
       env << 'MALLOC_CONF="dirty_decay_ms:1000,narenas:2,background_thread:true"'
     end
 
+    if using_puppeteer?
+      env << 'GROVER_NO_SANDBOX="true"' if @gemfile.include? 'grover'
+      env << 'PUPPETEER_EXECUTABLE_PATH="/usr/bin/google-chrome"'
+    end
+
     env
   end
 

data/lib/generators/templates/Dockerfile.erb

@@ -26,10 +26,12 @@ 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} %>
+<% unless base_requirements.empty? -%>
+# Install packages needed to install <%= base_requirements %>
+<%= render partial: 'apt_install', locals: {packages: base_packages, clean: true, repos: ''} %>
 
+<% end -%>
+<% if using_execjs? -%>
 <%= render partial: 'install_node', locals: {yarn_version: nil} %>
 
 <% end -%>
@@ -38,15 +40,15 @@ RUN gem update --system --no-document && \
 FROM base as <%= parallel? ? 'pre' : '' %>build
 
 # Install packages needed to build gems<%= using_node? ? " and node modules" : "" %>
-<%= render partial: 'apt_install', locals: {packages: build_packages, clean: false} %>
+<%= render partial: 'apt_install', locals: {packages: build_packages, clean: false, repos: ''} %>
 
 <% if parallel? -%>
 
 FROM prebuild as node
 
 <% end -%>
-<% if using_node? -%>
-<%= render partial: 'install_node', locals: {node_version: using_execjs? ? nil : node_version} %>
+<% if using_node? and (!using_execjs? || File.exist?('yarn.lock')) -%>
+<%= render partial: 'install_node', locals: {node_version: using_execjs? ? nil : node_version, yarn_version: File.exist?('yarn.lock') ? yarn_version : nil} %>
 
 <% end -%>
 <% if parallel? -%>
@@ -81,7 +83,7 @@ RUN bundle _${BUNDLER_VERSION}_ install<% if depend_on_bootsnap? -%> && \
 COPY --from=node /rails/node_modules /rails/node_modules
 
 <% elsif using_node? -%>
-<%= render partial: 'npm_install', locals: {sources: %w(package.json yarn.lock)} %>
+<%= render partial: 'npm_install', locals: {sources: Dir[*%w(package.json package-lock.json yarn.lock)]} %>
 
 <% end -%>
 # Copy application code
@@ -112,7 +114,7 @@ FROM base
 <% unless deploy_packages.empty? -%>
 
 # Install packages needed for deployment
-<%= render partial: 'apt_install', locals: {packages: deploy_packages, clean: true} %>
+<%= render partial: 'apt_install', locals: {packages: deploy_packages, clean: true, repos: deploy_repos} %>
 <% end -%>
 
 # Copy built application from previous stage

data/lib/generators/templates/_apt_install.erb

@@ -1,10 +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 && \
+    <%= repos %>apt-get update -qq && \
     apt-get install --no-install-recommends -y <%= packages.join(" ") %>
 <% else -%>
-RUN apt-get update -qq && \
+RUN <%= repos %>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 -%>
@@ -17,4 +17,4 @@ RUN apt-get update -qq && \
  		make && \
  		make install
  <% end -%>
- 
+

data/lib/generators/templates/_npm_install.erb

@@ -1,4 +1,7 @@
 # Install node modules
+<% if using_puppeteer? -%>
+ENV PUPPETEER_SKIP_CHROMIUM_DOWNLOAD="true"
+<% end -%>
 COPY <%=sources.join(' ') %> .
 <% if sources.join.include? 'yarn' -%>
 <% if options.cache? -%>
@@ -14,4 +17,4 @@ RUN --mount=type=cache,id=bld-npm-cache,target=/root/.npm \
 <% else -%>
 RUN npm install
 <% end -%>
-<% end -%>
+<% end -%>

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

@@ -68,4 +68,27 @@ services:
 
   redis-db:
     image: redis
+<% end -%>
+<% if using_sidekiq? and deploy_database != 'sqlite3' -%>
+
+  sidekiq:
+    build: .
+    environment:
+      - RAILS_MASTER_KEY=$RAILS_MASTER_KEY
+      - REDIS_URL=redis://redis-db:6379
+<% if deploy_database == 'postgresql' -%>
+      - DATABASE_URL=postgres://root:password@postgres-db/
+<% elsif deploy_database == 'mysql' -%>
+      - DATABASE_URL=mysql2://root:password@mysql-db/
+<% end -%>
+    depends_on:
+      redis-db:
+        condition: service_started
+<% if deploy_database == 'postgresql' -%>
+      postgres-db:
+        condition: service_healthy
+<% elsif deploy_database == 'mysql' -%>
+      mysql-db:
+        condition: service_healthy
+<% end -%>
 <% end -%>

metadata

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