dockerfile-rails 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7730245e044329345b271524027cd640794a3577c4b49d2a2ce47a3cf21c94c4
-  data.tar.gz: 88fe182e5b8ab19d9725391cfaf1c0010e9d89d7cf44a9e3618f680bbe700315
+  metadata.gz: 8e00977164abc39c9b3b66c636834cda09f32f939045db5a5f496b51a455ee4f
+  data.tar.gz: bc3305fa419473f18eace29a65a9461fbd90c423106ff3cf1c5c42d0ed3b58ba
 SHA512:
-  metadata.gz: 411539b040956ad9a1c437437aa36d2ed96a1769354162a2d8e57244c6a5b7dbf7fb1ff45efbd40f86da990b4741c01c6a871c84ac6be735104c4ab8ff39aa17
-  data.tar.gz: 06b7e3ac3225bca70269b8aae26dcb9e2f9846b911416a09f4af6f0be82137eebd7f365bf815e0ff1a6c0783a7b8d082cf1bf5856f9913e90bb349408868d60f
+  metadata.gz: d92c231f9d0484dcc196837aab9a3f3c3b6158202d5c8d942a61231ec9d5ec3fa0af8cf54a8daffea5d6f1103241aa5bb88a79cb9ea0a29974a08b579f7b2356
+  data.tar.gz: 1e65aec6411ddac4d9785f087f16c2b8645e0895701fe6da58d93369d45d2aa8b71c4cb48c777e64737cf805a08ca4fc4da66a44d0ab007fa36f2351065ffc95

data/README.md

@@ -1,3 +1,28 @@
 ## Purpose
 
-Provide Rails generators to produce Dockerfiles and related files.
+Provide Rails generators to produce Dockerfiles and related files.
+
+## Usage
+
+```
+bundle add dockerfile-rails
+bin/rails generate dockerfile
+```
+
+General options:
+
+* `--force` - overwrite existing files
+* `--ci` - include test gems in bundle
+* `--cache` - use build caching to speed up builds
+* `--parallel` - use multi-stage builds to install gems and node modules in parallel
+
+Dependencies:
+
+Generally the dockerfile generator will be able to determine what dependencies you
+are actually using.  But should you be using DATABASE_URL, for example, at runtime
+additional support may be needed:
+
+* `--mysql` - add mysql libraries
+* `--posgresql` - add posgresql libraries
+* `--redis` - add redis libraries
+* `--sqlite3` - add sqlite3 libraries

data/lib/dockerfile-rails/scanner.rb

@@ -62,14 +62,6 @@ module DockerfileRails
       end
 
       @redis = @redis_cable || @redis_cache || @sidekiq
-
-      ### api-only ###
-
-      @apionly = Rails.application.config.api_only
-
-      ### db:prepare ###
-
-      @dbprep = (Rails::VERSION::MAJOR >= 6) ? 'db:prepare' : 'db:migrate'
     end
   end
 end

data/lib/generators/dockerfile_generator.rb

@@ -1,6 +1,27 @@
 class DockerfileGenerator < Rails::Generators::Base
   include DockerfileRails::Scanner
 
+  class_option :ci, type: :boolean, default: false,
+    desc: 'include test gems in bundle'
+
+  class_option :cache, type: :boolean, default: false,
+    desc: 'use build cache to speed up installs'
+
+  class_option :parallel, type: :boolean, default: false,
+    desc: 'use build stages to install gems and node modules in parallel'
+
+  class_option :redit, type: :boolean, default: false,
+    desc: 'include redis libraries'
+
+  class_option :sqlite3, aliases: '--sqlite', type: :boolean, default: false,
+    desc: 'include sqlite3 libraries'
+
+  class_option :postgresql, aliases: '--postgres', type: :boolean, default: false,
+    desc: 'include postgresql libraries'
+
+  class_option :mysql, type: :boolean, default: false,
+    desc: 'include mysql libraries'
+
   def generate_app
     source_paths.push File.expand_path('./templates', __dir__)
 
@@ -18,7 +39,12 @@ class DockerfileGenerator < Rails::Generators::Base
 private
    
   def using_node?
-    File.exist? 'package.json'
+    return @using_node if @using_node != nil
+    @using_node = File.exist? 'package.json'
+  end
+
+  def parallel?
+    using_node? && options.parallel
   end
 
   def keeps?
@@ -31,17 +57,19 @@ private
     packages = %w(build-essential)
 
     # add databases: sqlite3, postgres, mysql
-    packages += %w(pkg-config libpq-dev default-libmysqlclient-dev)
+    packages << 'pkg-config' if options.sqlite3? or @sqlite3
+    packages << 'libpq-dev' if options.postgresql? or @postgresql
+    packages << 'default-libmysqlclient-dev' if options.mysql or @mysql
 
     # add redis in case Action Cable, caching, or sidekiq are added later
-    packages << "redis"
+    packages << "redis" if options.redis? or @redis
 
     # ActiveStorage preview support
     packages << "libvips" if @gemfile.include? 'ruby-vips'
 
     # node support, including support for building native modules
     if using_node?
-      packages += %w(curl node-gyp) # pkg-config already listed above
+      packages += %w(curl node-gyp pkg-config)
 
       # module build process depends on Python, and debian changed
       # how python is installed with the bullseye release.  Below
@@ -63,15 +91,19 @@ private
       end
     end
 
-    packages.sort
+    packages.sort.uniq
   end
 
   def deploy_packages
+    packages = []
+
     # start with databases: sqlite3, postgres, mysql
-    packages = %w(libsqlite3-0 postgresql-client default-mysql-client)
+    packages << 'libsqlite3-0' if options.sqlite3? or @sqlite3
+    packages << 'postgresql-client' if options.postgresql? or @postgresql
+    packages << 'default-mysql-client' if options.mysql or @mysql
 
     # add redis in case Action Cable, caching, or sidekiq are added later
-    packages << "redis"
+    packages << "redis" if options.redis? or @redis
 
     # ActiveStorage preview support
     packages << "libvips" if @gemfile.include? 'ruby-vips'
@@ -127,4 +159,12 @@ private
   def api_only?
     Rails.application.config.api_only
   end
+
+  def dbprep_command
+    if Rails::VERSION::MAJOR >= 6
+      'db:prepare'
+    else
+      'db:migrate'
+    end
+  end
 end

data/lib/generators/templates/Dockerfile.erb

@@ -10,16 +10,31 @@ WORKDIR /rails
 # Set production environment
 ENV RAILS_ENV="production" \
     BUNDLE_PATH="vendor/bundle" \
-    BUNDLE_WITHOUT="development:test"
+    BUNDLE_WITHOUT="<%= options.ci? ? 'test' : 'development:test' %>"
 
+ARG BUNDLER_VERSION=<%= Bundler::VERSION %>
+RUN gem update --system --no-document && \
+    gem install -N bundler -v ${BUNDLER_VERSION}
 
-# Throw-away build stage to reduce size of final image
-FROM base as build
+
+# Throw-away build stage<%= parallel? ? 's' : '' %> to reduce size of final image
+FROM base as <%= parallel? ? 'pre' : '' %>build
 
 # Install packages need to build gems<%= using_node? ? " and node modules" : "" %>
+<% 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 && \
+<% else -%>
 RUN apt-get update -qq && \
+<% end -%>
     apt-get install -y <%= build_packages.join(" ") %>
 
+<% if parallel? -%>
+
+FROM prebuild as node
+
+<% end -%>
 <% if using_node? -%>
 # Install JavaScript dependencies
 ARG NODE_VERSION=<%= node_version %>
@@ -28,15 +43,47 @@ ENV VOLTA_HOME="/usr/local"
 RUN curl https://get.volta.sh | bash && \
     volta install node@$NODE_VERSION yarn@$YARN_VERSION
 
+<% end -%>
+<% if parallel? -%>
+# Install node modules
+COPY package.json yarn.lock ./
+<% if options.cache? -%>
+RUN --mount=type=cache,id=bld-yarn-cache,target=/root/.yarn \
+    YARN_CACHE_FOLDER=/root/.yarn yarn install
+<% else -%>
+RUN yarn install
+<% end -%>
+
+
+FROM prebuild as build
+
 <% end -%>
 # Install application gems
 COPY Gemfile Gemfile.lock ./
-RUN bundle install
+<% if options.cache? -%>
+RUN --mount=type=cache,id=bld-gem-cache,sharing=locked,target=/srv/vendor \
+    bundle config set app_config .bundle && \
+    bundle config set path /srv/vendor && \
+    bundle _${BUNDLER_VERSION}_ install && \
+    bundle clean && \
+    mkdir -p vendor && \
+    bundle config set path vendor && \
+    cp -ar /srv/vendor .
+<% else -%>
+RUN bundle _${BUNDLER_VERSION}_ install
+<% end -%>
 
-<% if using_node? -%>
+<% if parallel? -%>
+asdf
+<% elsif using_node? -%>
 # Install node modules
 COPY package.json yarn.lock ./
+<% if options.cache? -%>
+RUN --mount=type=cache,id=bld-yarn-cache,target=/root/.yarn \
+    YARN_CACHE_FOLDER=/root/.yarn yarn install
+<% else -%>
 RUN yarn install
+<% end -%>
 
 <% end -%>
 # Copy application code
@@ -54,19 +101,31 @@ RUN bundle exec bootsnap precompile --gemfile app/ lib/
 <% end -%>
 <% unless api_only? -%>
 # Precompiling assets for production without requiring secret RAILS_MASTER_KEY
-RUN SECRET_KEY_BASE_DUMMY=1 ./bin/rails assets:precompile
+RUN SECRET_KEY_BASE<%= Rails::VERSION::MAJOR<7 || Rails::VERSION::STRING.start_with?('7.0') ? '=DUMMY' : '_DUMMY=1' %> ./bin/rails assets:precompile
 
 <% end -%>
 
 # Final stage for app image
 FROM base
+<% unless deploy_packages.empty? -%>
 
 # Install packages need for deployment
+<% 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 && \
+    apt-get install --no-install-recommends -y <%= deploy_packages.join(" ") %>
+<% else -%>
 RUN apt-get update -qq && \
     apt-get install --no-install-recommends -y <%= deploy_packages.join(" ") %> && \
     rm -rf /var/lib/apt/lists /var/cache/apt/archives
+<% end -%>
+<% end -%>
 
 # Copy built application from second stage
+<% if options.ci? -%>
+COPY --from=build /usr/local/bundle /usr/local/bundle
+<% end -%>
 COPY --from=build /rails /rails
 
 # Deployment options

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

@@ -2,7 +2,7 @@
 
 # If running the rails server then create or migrate existing database
 if [ "${*}" == "./bin/rails server" ]; then
-  ./bin/rails db:prepare
+  ./bin/rails <%= dbprep_command %>
 fi
 
 exec "${@}"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dockerfile-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Sam Ruby