dockerfile-rails 0.4.9 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92c7394bd97da528362105514f095458b56872645ce0c3082c748c7bee22c54f
-  data.tar.gz: e7a158e41126aa6321e5b4461951b6323f7fa950f8eef8eb366ee436454c0057
+  metadata.gz: 5146ba972235a473c3018799f3b75bc7856dad4c7c1e1b34a9fc0e87aa0de196
+  data.tar.gz: f9848a9d5103550a9fe7e1be7ee3820d4f99cee50ec39cc53933f568ffe29357
 SHA512:
-  metadata.gz: 35619e605b9ed5176157c841efb21f4cfec9029c6383732d440bd9a440144719c8cc62e43974124148d5dbc1fb2705bd0160d4581f6829aa8ccdeb0040b665bb
-  data.tar.gz: 94b595caa9b67e1d814b863f535eae373dca80a5b14d410122a0b0199fdb46955ddb6d7609f3ce58945e9419047da6128864a751f8af36dbb2d8230bfd87f1d8
+  metadata.gz: 14b6231959a35395703f0019a2c4e38062dd6b8d37d2c5c936dad2920c120118f7c95ad80a4c4d6591449bc2c79fc86c4ffd35bf3ac107ca6894291906ddd23b
+  data.tar.gz: d62ba6ea16c3705de8bc1606d8c1adbca6c91e591ff949d0d132f7f47b315662cc2659919a25febe9628dce5b7a9c34e5215dba0081b79525f6dae99b0fe4c3b

data/README.md

@@ -1,6 +1,6 @@
 ## Overview
 
-Provides Rails generators to produce Dockerfiles and related files.  This is being proposed as the generator to be included in Rails 7.1, and a substantial number of pull requests along those lines have already been merged.  This repository contains fixes and features beyond those pull requests.  Highlights:
+Provides a Rails generator to produce Dockerfiles and related files.  This is being proposed as the generator to be included in Rails 7.1, and a substantial number of pull requests along those lines have already been merged.  This repository contains fixes and features beyond those pull requests.  Highlights:
 
   * Supports all [Rails supported releases](https://guides.rubyonrails.org/maintenance_policy.html), not just Rails 7.1, and likely works with a number of previous releases.
   * Can be customized using flags on the `generate dockerfile` command, and rerun to produce a custom tailored dockerfile based on detecting the actual features used by your application.
@@ -9,7 +9,7 @@ Provides Rails generators to produce Dockerfiles and related files.  This is bei
 ## Usage
 
 ```
-bundle add dockerfile-rails --group development
+bundle add dockerfile-rails --version ">= 0.5.0" --group development
 bin/rails generate dockerfile
 ```
 
@@ -18,6 +18,7 @@ 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.
 * `--cache` - use build caching to speed up builds
 * `--parallel` - use multi-stage builds to install gems and node modules in parallel
@@ -34,13 +35,15 @@ additional support may be needed:
 * `--redis` - add redis libraries
 * `--sqlite3` - add sqlite3 libraries
 
-Optimizations:
+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
 
+Options are saved between runs into `config/dockerfile.yml`.  To invert a boolean options, add or remove a `no-` prefix from the option name.
+
 ## Testing
 
 The current testing strategy is to run `rails new` and `generate dockerfile` with various configurations and compare the generated artifacts with expected results.  `ARG` values in `Dockerfiles` are masked before comparison.
@@ -74,3 +77,4 @@ Many of the following links relate to the current development status with respec
 * [Rails Dockerfile futures](https://discuss.rubyonrails.org/t/rails-dockerfile-futures/82091/1) - rationale for a generator
 * [Fly Cookbooks](https://fly.io/docs/rails/cookbooks/) - deeper dive into Dockerfile design choices
 * [app/templates/Dockerfile.tt](https://github.com/rails/rails/blob/main/railties/lib/rails/generators/rails/app/templates/Dockerfile.tt) - current Rails 7.1 template
+* Fly.io [Cut over to Rails Dockerfile Generator on Sunday 29 Jan 2023](https://community.fly.io/t/cut-over-to-rails-dockerfile-generator-on-sunday-29-jan-2023/10350)

data/lib/dockerfile-rails/scanner.rb

@@ -4,7 +4,7 @@ module DockerfileRails
 
       ### database ###
 
-      database = YAML.load_file('config/database.yml').
+      database = YAML.load_file('config/database.yml', aliases: true).
         dig('production', 'adapter') rescue nil
 
       if database == 'sqlite3'

data/lib/generators/dockerfile_generator.rb

@@ -4,51 +4,87 @@ require_relative '../dockerfile-rails/scanner.rb'
 class DockerfileGenerator < Rails::Generators::Base
   include DockerfileRails::Scanner
 
-  class_option :ci, type: :boolean, default: false,
+  OPTION_DEFAULTS = OpenStruct.new(
+    'bin-cd' => false,
+    'cache' => false,
+    'ci' => false,
+    'compose' => false,
+    'fullstaq' => false,
+    'jemalloc' => false,
+    'mysql' => false,
+    'parallel' => false,
+    'platform' => nil,
+    'postgresql' => false,
+    'prepare' => true,
+    'redis' => false,
+    'swap' => nil,
+    'yjit' => false,
+  )
+
+  # 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
+    end
+  end
+
+  class_option :ci, type: :boolean, default: OPTION_DEFAULTS.ci,
     desc: 'include test gems in bundle'
 
-  class_option 'bin-cd', type: :boolean, default: false,
+  class_option 'bin-cd', type: :boolean, default: OPTION_DEFAULTS['bin-cd'],
     desc: 'modify binstubs to set working directory'
 
-  class_option :cache, type: :boolean, default: false,
+  class_option :cache, type: :boolean, default: OPTION_DEFAULTS.cache,
     desc: 'use build cache to speed up installs'
 
-  class_option :parallel, type: :boolean, default: false,
+  class_option :prepare, type: :boolean, default: OPTION_DEFAULTS.prepare,
+    desc: 'include db:prepare step'
+
+  class_option :parallel, type: :boolean, default: OPTION_DEFAULTS.parallel,
     desc: 'use build stages to install gems and node modules in parallel'
 
-  class_option :swap, type: :string, default: nil,
+  class_option :swap, type: :string, default: OPTION_DEFAULTS.swap,
     desc: 'allocate swapspace'
 
-  class_option :compose, type: :boolean, default: false,
+  class_option :compose, type: :boolean, default: OPTION_DEFAULTS.compose,
     desc: 'generate a docker-compose.yml file'
 
-  class_option :redis, type: :boolean, default: false,
+  class_option :redis, type: :boolean, default: OPTION_DEFAULTS.redis,
     desc: 'include redis libraries'
 
-  class_option :sqlite3, aliases: '--sqlite', type: :boolean, default: false,
+  class_option :sqlite3, aliases: '--sqlite', type: :boolean, default: OPTION_DEFAULTS.sqlite3,
     desc: 'include sqlite3 libraries'
 
-  class_option :postgresql, aliases: '--postgres', type: :boolean, default: false,
+  class_option :postgresql, aliases: '--postgres', type: :boolean, default: OPTION_DEFAULTS.postgresql,
     desc: 'include postgresql libraries'
 
-  class_option :mysql, type: :boolean, default: false,
+  class_option :mysql, type: :boolean, default: OPTION_DEFAULTS.mysql,
     desc: 'include mysql libraries'
 
-  class_option :platform, type: :string, default: nil,
+  class_option :platform, type: :string, default: OPTION_DEFAULTS.platform,
     desc: 'image platform (example: linux/arm64)'
 
-  class_option :jemalloc, type: :boolean, default: false,
+  class_option :jemalloc, type: :boolean, default: OPTION_DEFAULTS.jemalloc,
     desc: 'use jemalloc alternative malloc implementation'
   
-  class_option :fullstaq, type: :boolean, default: false,
+  class_option :fullstaq, type: :boolean, default: OPTION_DEFAULTS.fullstaq,
     descr: 'use Fullstaq Ruby image from Quay.io'
 
-  class_option :yjit, type: :boolean, default: false,
+  class_option :yjit, type: :boolean, default: OPTION_DEFAULTS.yjit,
     desc: 'enable YJIT optimizing compiler'
 
   def generate_app
     source_paths.push File.expand_path('./templates', __dir__)
 
+    # gather up options for config file
+    @dockerfile_config = OPTION_DEFAULTS.dup.to_h.stringify_keys
+    options.to_h.each do |option, value|
+      @dockerfile_config[option] = value if @dockerfile_config.include? option
+    end
+
     scan_rails_app
 
     template 'Dockerfile.erb', 'Dockerfile'
@@ -60,6 +96,8 @@ class DockerfileGenerator < Rails::Generators::Base
     chmod "bin/docker-entrypoint", 0755 & ~File.umask, verbose: false
 
     template 'docker-compose.yml.erb', 'docker-compose.yml' if options.compose
+
+    template 'dockerfile.yml.erb', 'config/dockerfile.yml'
   end
 
 private
@@ -187,6 +225,31 @@ private
     packages.sort
   end
 
+  def deploy_env
+    env = []
+
+    if Rails::VERSION::MAJOR<7 || Rails::VERSION::STRING.start_with?('7.0')
+      env << 'RAILS_LOG_TO_STDOUT="1"'
+      env << 'RAILS_SERVE_STATIC_FILES="true"'
+    end
+
+    if options.yjit
+      env << 'RUBY_YJIT_ENABLE="1"'
+    end
+
+    if options.jemalloc and not options.fullstaq
+      if (options.platform || Gem::Platform::local.cpu).include? 'arm'
+        env << 'LD_PRELOAD="/usr/lib/aarch64-linux-gnu/libjemalloc.so.2"'
+      else
+        env << 'LD_PRELOAD="/usr/lib/x86_64-linux-gnu/libjemalloc.so.2"'
+      end
+
+      env << 'MALLOC_CONF="dirty_decay_ms:1000,narenas:2,background_thread:true"'
+    end
+
+    env
+  end
+
   def binfile_fixups
     # binfiles may have OS specific paths to ruby.  Normalize them.
     shebangs = Dir["bin/*"].map { |file| IO.read(file).lines.first }.join

data/lib/generators/templates/Dockerfile.erb

@@ -126,18 +126,16 @@ COPY --from=build /rails /rails
 COPY --from=client /rails/<%= api_client_dir %>/build /rails/public
 <% end -%>
 
+<% unless deploy_env.empty? -%>
 # Deployment options
-ENV RAILS_LOG_TO_STDOUT="1" \
-    RAILS_SERVE_STATIC_FILES="true"<% if options.yjit %> \
-    RUBY_YJIT_ENABLE="1"<% end %><% if options.jemalloc and not options.fullstaq %> \
-<% if (options.platform || Gem::Platform::local.cpu).include? 'arm' -%>
-    LD_PRELOAD="/usr/lib/aarch64-linux-gnu/libjemalloc.so.2" \
-<% else -%>
-    LD_PRELOAD="/usr/lib/x86_64-linux-gnu/libjemalloc.so.2" \
-<% end -%>
-    MALLOC_CONF="dirty_decay_ms:1000,narenas:2,background_thread:true"<% end %>
+ENV <%= deploy_env.join(" \\\n    ") %>
 
+<% end -%>
+<% if options.prepare -%>
 # Entrypoint prepares the database.
+<% else -%>
+# Entrypoint sets up the container.
+<% end -%>
 ENTRYPOINT ["/rails/bin/docker-entrypoint"]
 
 # Start the server by default, this can be overwritten at runtime

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

@@ -10,9 +10,14 @@ swapon /swapfile
 echo 1 > /proc/sys/vm/overcommit_memory
 
 <% end -%>
+<% if options.prepare -%>
 # If running the rails server then create or migrate existing database
 if [ "${*}" == "./bin/rails server" ]; then
   ./bin/rails <%= dbprep_command %>
 fi
 
+<% elsif !options.swap -%>
+# Add any container initialization steps here
+
+<% end -%>
 exec "${@}"

data/lib/generators/templates/dockerfile.yml.erb

@@ -0,0 +1,3 @@
+# generated by dockerfile-rails
+
+<%= YAML.dump('options' => @dockerfile_config) %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dockerfile-rails
 version: !ruby/object:Gem::Version
-  version: 0.4.9
+  version: 0.5.1
 platform: ruby
 authors:
 - Sam Ruby
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-24 00:00:00.000000000 Z
+date: 2023-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -44,6 +44,7 @@ files:
 - lib/generators/templates/_npm_install.erb
 - lib/generators/templates/docker-compose.yml.erb
 - lib/generators/templates/docker-entrypoint.erb
+- lib/generators/templates/dockerfile.yml.erb
 - lib/generators/templates/dockerignore.erb
 - lib/generators/templates/node-version.erb
 homepage: https://github.com/rubys/dockerfile-rails