dockerfile-rails 0.4.8 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9b601d4f4e8ba2476ebdc5a721aa605f605b54b36cd2ebda0d8959035ed6621
-  data.tar.gz: 8f87d53ade0657596d6b0915c1523b477d213684019dfb66fd48949a86568186
+  metadata.gz: 906eaaf2f4166356a6cece9b347dd58a29324a0e7a3d0f557cfea85054c34816
+  data.tar.gz: 0c071eb1fd4da339676916705498c18fb2d5e08e0115b8f47745def8229390e3
 SHA512:
-  metadata.gz: cfe3dc014ee68c023c65c8dfe1716ba9d05ac6266bf0b1ef478f73968c974be78303d9b108ef91e475cf81fd9398185d46ee4b13ebb9435ca15357db31a71c8a
-  data.tar.gz: 25124c64efc2e59bdd00e608c72758ea6996655051f15cf85242b99311c0d04f700d98c13d936d5e752516eaf58f777964c5e113b0203606a7f0a535e6082ccf
+  metadata.gz: 66b27141d048276513a4384b6dd88fae87f929d2128a9e6a19187cac6a1d75f751d5e261ccd4f94424ae7ae53ca0713141db34163d04cb997a719731a6e39dde
+  data.tar.gz: 7e927389954e205c3cc89e6de75506d85265ac394a749f0b394d9b5263b4de719a5dc935d8ff493f1c1cfdc30854b70f7f5b77f6c48599095a7132f0f050a0cd

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.
@@ -17,6 +17,8 @@ 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
@@ -33,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.
@@ -55,9 +59,14 @@ To assis with this process, outputs of tests can be captured automatically.  Thi
 
 ```
 rake test:capture
-TEST_CAPTURE=1 ruby test/test_minimal.rb
 ```
 
+If you are running a single test, the following environment variables settings may be helpful:
+
+ * `RAILS_ENV=TEST` will match the environment used to produce the captured outputs.
+ * `TEST_CAPTURE=1` will capture test results.
+ * `TEST_KEEP=1` will leave the test app behind for inspection after the test completes.
+
 ## Links
 
 Many of the following links relate to the current development status with respect to Rails 7.1 and will be removed once that is resolved.

data/lib/generators/dockerfile_generator.rb

@@ -4,48 +4,86 @@ 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,
+    '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 :cache, 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: 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'
@@ -57,6 +95,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
@@ -210,6 +250,11 @@ private
       binfixups.unshift "chmod +x bin/*"
     end
 
+    # optionally, adjust cwd
+    if options['bin-cd']
+      binfixups.push %{sed -i '/^#!/aDir.chdir File.expand_path("..", __dir__)' /app/bin/*}
+    end
+
     binfixups
   end
 

data/lib/generators/templates/Dockerfile.erb

@@ -19,7 +19,7 @@ WORKDIR /rails
 # Set production environment
 ENV RAILS_ENV="production" \
     BUNDLE_PATH="vendor/bundle" \
-    BUNDLE_WITHOUT="<%= options.ci? ? 'test' : 'development:test' %>"
+    BUNDLE_WITHOUT="<%= options.ci? ? 'development' : 'development:test' %>"
 
 # Update gems and preinstall the desired version of bundler
 ARG BUNDLER_VERSION=<%= Bundler::VERSION %>
@@ -93,7 +93,11 @@ RUN bundle exec bootsnap precompile app/ lib/
 
 <% end -%>
 <% unless binfile_fixups.empty? -%>
-# Adjust binfiles to be executable on Linux
+<% if options['bin-cd'] and binfile_fixups.length == 1 -%>
+# Adjust binfiles to set current working directory
+<% else -%>
+# Adjust binfiles to be executable on Linux<%= options['bin-cd'] ? ' and set current working directory' : '' %>
+<% end -%>
 <%= "RUN " + binfile_fixups.join(" && \\\n    ") %>
 
 <% end -%>
@@ -133,7 +137,11 @@ ENV RAILS_LOG_TO_STDOUT="1" \
 <% end -%>
     MALLOC_CONF="dirty_decay_ms:1000,narenas:2,background_thread:true"<% 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.8
+  version: 0.5.0
 platform: ruby
 authors:
 - Sam Ruby
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-22 00:00:00.000000000 Z
+date: 2023-01-24 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