dockerfile-rails 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cf90509af5087378fd186d88358f0157d40ca2335e19a66ecdddbf1efd9add4
-  data.tar.gz: 640b5eeb291be5e4168a5da7ffd17236b1ebf49deed3fb8a5d8148e6fe3ba92c
+  metadata.gz: ca1f4e5fe001307e03c7a37ad194cc643b0130d709a3974c453dc036857eb4a8
+  data.tar.gz: 81508d5aa170bfc00062ce1fb52ca54237def089702937b13ce7ae56e95f99a0
 SHA512:
-  metadata.gz: 9390f22b5e4348c6d59345b08c843bec8ae4932e6b20afa69bffac4bf600c3489ae093e9847b9f59cd0b688b448d35c4c5a1815743b2693abd90db97d051a7cd
-  data.tar.gz: 77fe857b46a6aa3b5bda4d7b3ce0f68b24f1907d1a049c927b4e2d0e759d39b2fd771ebf3b5937d92c418f4d3e04b52f07788d939b06d644a0d4f028fb9bd7c2
+  metadata.gz: e2f75d96502988be41600c72ee59a6bfd32d583fc8e0d1c9ea59c3a4c478bcefb484510b4db03fd8c28730d356944f62678244ceb5ac8d4bd4769de166760700
+  data.tar.gz: 9f75d764d9ad5badedfd6c935796db84e7988441a2c87fc12eab78c1a2cbae67eaeffed1f2f14b2a28c89df0f6cb13222c9653c983ef85540cc2acb8986568f0

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
 ```
 
@@ -19,11 +19,12 @@ General options:
 * `--force` - overwrite existing files
 * `--ci` - include test gems in deployed image
 * `--bin-cd` - adjust binstubs to set current working directory
-* `--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.
+* `--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
 * `--cache` - use build caching to speed up builds
 * `--parallel` - use multi-stage builds to install gems and node modules in parallel
 * `--compose` - generate a `docker-compose.yml` file
+* `--label=name:value` - specify docker label.  Can be used multiple times.  See [LABEL](https://docs.docker.com/engine/reference/builder/#label) for details
 
 Dependencies:
 

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

@@ -19,15 +19,21 @@ class DockerfileGenerator < Rails::Generators::Base
     'redis' => false,
     'swap' => nil,
     'yjit' => false,
+    'label' => {},
   )
 
+  @@labels = {}
+
   # load defaults from config file
   if File.exist? 'config/dockerfile.yml'
     options = YAML.safe_load_file('config/dockerfile.yml', symbolize_names: true)[:options]
+
     if options
       OPTION_DEFAULTS.to_h.each do |option, value|
         OPTION_DEFAULTS[option] = options[option] if options.include? option 
       end
+
+      @@labels = options[:label].stringify_keys if options.include? :label
     end
   end
 
@@ -76,9 +82,15 @@ class DockerfileGenerator < Rails::Generators::Base
   class_option :yjit, type: :boolean, default: OPTION_DEFAULTS.yjit,
     desc: 'enable YJIT optimizing compiler'
 
+  class_option :label, type: :hash, default: {},
+    desc: 'Add Docker label(s)'
+
   def generate_app
     source_paths.push File.expand_path('./templates', __dir__)
 
+    # merge options
+    options.label.replace(@@labels.merge(options.label).select {|key, value| value != ''})
+
     # gather up options for config file
     @dockerfile_config = OPTION_DEFAULTS.dup.to_h.stringify_keys
     options.to_h.each do |option, value|
@@ -142,7 +154,7 @@ private
   end
 
   def using_redis?
-    options.redis? or @redis
+    options.redis? or @redis or @gemfile.include?('sidekiq')
   end
 
   def using_execjs?
@@ -150,7 +162,11 @@ private
   end
 
   def using_puppeteer?
-    @gemfile.include?('grover')
+    @gemfile.include?('grover') or @gemfile.include?('puppeteer-ruby')
+  end
+
+  def using_sidekiq?
+    @gemfile.include?('sidekiq')
   end
 
   def parallel?
@@ -176,6 +192,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)
@@ -188,7 +225,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
@@ -200,7 +237,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
@@ -240,7 +277,9 @@ 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?

data/lib/generators/templates/Dockerfile.erb

@@ -13,6 +13,12 @@ FROM <%= platform %>quay.io/evl.ms/fullstaq-ruby:${RUBY_VERSION}-<%= @options.je
 FROM <%= platform %>ruby:$RUBY_VERSION-slim as base
 <% end -%>
 
+<% unless options.label.empty? -%>
+<% options.label.each do |key, value| -%>
+LABEL <%= key =~ /^\w[.\w]*$/ ? key : key.inspect %>=<%= value.inspect %>
+<% end -%>
+
+<% end -%>
 # Rails app lives here
 WORKDIR /rails
 
@@ -26,15 +32,12 @@ ARG BUNDLER_VERSION=<%= Bundler::VERSION %>
 RUN gem update --system --no-document && \
     gem install -N bundler -v ${BUNDLER_VERSION}
 
-<% if using_execjs? -%>
-<% if using_puppeteer? -%>
-# Install packages needed to install nodejs and chrome
-<%= render partial: 'apt_install', locals: {packages: %w(curl gnupg unzip), clean: true, repos: ''} %>
-<% else -%>
-# Install packages needed to install nodejs
-<%= render partial: 'apt_install', locals: {packages: %w(curl unzip), clean: true, repos: ''} %>
-<% end -%>
+<% 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 -%>

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.1
+  version: 1.0.3
 platform: ruby
 authors:
 - Sam Ruby
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-30 00:00:00.000000000 Z
+date: 2023-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails