dockerfile-rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7730245e044329345b271524027cd640794a3577c4b49d2a2ce47a3cf21c94c4
+  data.tar.gz: 88fe182e5b8ab19d9725391cfaf1c0010e9d89d7cf44a9e3618f680bbe700315
+SHA512:
+  metadata.gz: 411539b040956ad9a1c437437aa36d2ed96a1769354162a2d8e57244c6a5b7dbf7fb1ff45efbd40f86da990b4741c01c6a871c84ac6be735104c4ab8ff39aa17
+  data.tar.gz: 06b7e3ac3225bca70269b8aae26dcb9e2f9846b911416a09f4af6f0be82137eebd7f365bf815e0ff1a6c0783a7b8d082cf1bf5856f9913e90bb349408868d60f

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2005-2022 David Heinemeier Hansson
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,3 @@
+## Purpose
+
+Provide Rails generators to produce Dockerfiles and related files.

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/gem_tasks"
+
+# Run `rake release` to release a new version of the gem.

data/lib/dockerfile-rails/scanner.rb

@@ -0,0 +1,75 @@
+module DockerfileRails
+  module Scanner
+    def scan_rails_app
+
+      ### database ###
+
+      database = YAML.load_file('config/database.yml').
+        dig('production', 'adapter') rescue nil
+
+      if database == 'sqlite3'
+        @sqlite3 = true
+      elsif database == 'postgresql'
+        @postgresql = true
+      elsif database == 'mysql' or database == 'mysql2'
+        @mysql = true
+      end
+
+      ### ruby gems ###
+
+      @gemfile = []
+
+      if File.exist? 'Gemfile.lock'
+        parser = Bundler::LockfileParser.new(Bundler.read_file('Gemfile.lock'))
+        @gemfile += parser.specs.map { |spec, version| spec.name }
+      end
+      
+      if File.exist? 'Gemfile'
+        @gemfile += Bundler::Definition.build('Gemfile', nil, []).dependencies.map(&:name)
+      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'
+      @bootsnap = @gemfile.include? 'bootsnap'
+
+      ### node modules ###
+
+      @package_json = []
+
+      if File.exist? 'package.json'
+        @package_json += JSON.load_file('package.json')['dependencies'].keys rescue []
+      end
+
+      @puppeteer ||= @package_json.include? 'puppeteer'
+
+      ### cable/redis ###
+
+      @cable = ! Dir['app/channels/*.rb'].empty?
+
+      if @cable
+        @redis_cable = true
+        if (YAML.load_file('config/cable.yml').dig('production', 'adapter') rescue '').include? 'any_cable'
+          @anycable = true
+        end
+      end
+
+      if (IO.read('config/environments/production.rb') =~ /redis/i rescue false)
+        @redis_cache = true
+      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/dockerfile-rails.rb

@@ -0,0 +1,5 @@
+require 'rails'
+require 'dockerfile-rails/scanner'
+
+class DockerRailsRailtie < Rails::Railtie
+end

data/lib/generators/dockerfile_generator.rb

@@ -0,0 +1,130 @@
+class DockerfileGenerator < Rails::Generators::Base
+  include DockerfileRails::Scanner
+
+  def generate_app
+    source_paths.push File.expand_path('./templates', __dir__)
+
+    scan_rails_app
+
+    template 'Dockerfile.erb', 'Dockerfile'
+    template 'dockerignore.erb', '.dockerignore'
+
+    template 'node-version.erb', '.node-version' if using_node?
+
+    template 'docker-entrypoint.erb', 'bin/docker-entrypoint'
+    chmod "bin/docker-entrypoint", 0755 & ~File.umask, verbose: false
+  end
+
+private
+   
+  def using_node?
+    File.exist? 'package.json'
+  end
+
+  def keeps?
+    return @keeps if @keeps != nil
+    @keeps = !Dir['**/.keep']
+  end
+
+  def build_packages
+    # start with the essentials
+    packages = %w(build-essential)
+
+    # add databases: sqlite3, postgres, mysql
+    packages += %w(pkg-config libpq-dev default-libmysqlclient-dev)
+
+    # add redis in case Action Cable, caching, or sidekiq are added later
+    packages << "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
+
+      # module build process depends on Python, and debian changed
+      # how python is installed with the bullseye release.  Below
+      # is based on debian release included with the Ruby images on
+      # Dockerhub.
+      case Gem.ruby_version
+      when /^2.7/
+        bullseye = ruby_version >= "2.7.4"
+      when /^3.0/
+        bullseye = ruby_version >= "3.0.2"
+      else
+        bullseye = true
+      end
+
+      if bullseye
+        packages << "python-is-python3"
+      else
+        packages << "python"
+      end
+    end
+
+    packages.sort
+  end
+
+  def deploy_packages
+    # start with databases: sqlite3, postgres, mysql
+    packages = %w(libsqlite3-0 postgresql-client default-mysql-client)
+
+    # add redis in case Action Cable, caching, or sidekiq are added later
+    packages << "redis"
+
+    # ActiveStorage preview support
+    packages << "libvips" if @gemfile.include? 'ruby-vips'
+
+    packages.sort
+  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
+    rubies = shebangs.scan(%r{#!/usr/bin/env (ruby.*)}).flatten.uniq
+  
+    binfixups = (rubies - %w(ruby)).map do |ruby|
+      "sed -i 's/#{Regexp.quote(ruby)}$/ruby/' bin/*"
+    end
+                                        
+    # Windows line endings will cause scripts to fail.  If any
+    # or found OR this generation is run on a windows platform 
+    # and there are other binfixups required, then convert 
+    # line endings.  This avoids adding unnecessary fixups if
+    # none are required, but prepares for the need to do the
+    # fix line endings if other fixups are required.
+    has_cr = Dir["bin/*"].any? { |file| IO.read(file).include? "\r" }
+    if has_cr || (Gem.win_platform? && !binfixups.empty?)
+      binfixups.unshift 'sed -i "s/\r$//g" bin/*'
+    end
+    
+    # Windows file systems may not have the concept of executable.
+    # In such cases, fix up during the build.
+    unless Dir["bin/*"].all? { |file| File.executable? file }
+      binfixups.unshift "chmod +x bin/*"
+    end
+
+    binfixups
+  end
+
+  def node_version
+    using_node? and `node --version`[/\d+\.\d+\.\d+/]
+  rescue
+    "lts" 
+  end
+
+  def yarn_version
+    using_node? and `yarn --version`[/\d+\.\d+\.\d+/]
+  rescue
+    "latest"
+  end
+
+  def depend_on_bootsnap?
+    @gemfile.include? 'bootstrap'
+  end
+
+  def api_only?
+    Rails.application.config.api_only
+  end
+end

data/lib/generators/templates/Dockerfile.erb

@@ -0,0 +1,81 @@
+# syntax = docker/dockerfile:1
+
+# Make sure it matches the Ruby version in .ruby-version and Gemfile
+ARG RUBY_VERSION=<%= Gem.ruby_version %>
+FROM ruby:$RUBY_VERSION-slim as base
+
+# Rails app lives here
+WORKDIR /rails
+
+# Set production environment
+ENV RAILS_ENV="production" \
+    BUNDLE_PATH="vendor/bundle" \
+    BUNDLE_WITHOUT="development:test"
+
+
+# Throw-away build stage to reduce size of final image
+FROM base as build
+
+# Install packages need to build gems<%= using_node? ? " and node modules" : "" %>
+RUN apt-get update -qq && \
+    apt-get install -y <%= build_packages.join(" ") %>
+
+<% if using_node? -%>
+# Install JavaScript dependencies
+ARG NODE_VERSION=<%= node_version %>
+ARG YARN_VERSION=<%= yarn_version %>
+ENV VOLTA_HOME="/usr/local"
+RUN curl https://get.volta.sh | bash && \
+    volta install node@$NODE_VERSION yarn@$YARN_VERSION
+
+<% end -%>
+# Install application gems
+COPY Gemfile Gemfile.lock ./
+RUN bundle install
+
+<% if using_node? -%>
+# Install node modules
+COPY package.json yarn.lock ./
+RUN yarn install
+
+<% end -%>
+# Copy application code
+COPY . .
+
+<% if depend_on_bootsnap? -%>
+# Precompile bootsnap code for faster boot times
+RUN bundle exec bootsnap precompile --gemfile app/ lib/
+
+<% end -%>
+<% unless binfile_fixups.empty? -%>
+# Adjust binfiles to be executable on Linux
+<%= "RUN " + binfile_fixups.join(" && \\\n    ") %>
+
+<% end -%>
+<% unless api_only? -%>
+# Precompiling assets for production without requiring secret RAILS_MASTER_KEY
+RUN SECRET_KEY_BASE_DUMMY=1 ./bin/rails assets:precompile
+
+<% end -%>
+
+# Final stage for app image
+FROM base
+
+# Install packages need for deployment
+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
+
+# Copy built application from second stage
+COPY --from=build /rails /rails
+
+# Deployment options
+ENV RAILS_LOG_TO_STDOUT="1" \
+    RAILS_SERVE_STATIC_FILES="true"
+
+# Entrypoint prepares the database.
+ENTRYPOINT ["/rails/bin/docker-entrypoint"]
+
+# Start the server by default, this can be overwritten at runtime
+EXPOSE 3000
+CMD ["./bin/rails", "server"]

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

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+# If running the rails server then create or migrate existing database
+if [ "${*}" == "./bin/rails server" ]; then
+  ./bin/rails db:prepare
+fi
+
+exec "${@}"

data/lib/generators/templates/dockerignore.erb

@@ -0,0 +1,45 @@
+# See https://docs.docker.com/engine/reference/builder/#dockerignore-file for more about ignoring files.
+
+# Ignore git directory.
+/.git/
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore all default key files.
+/config/master.key
+/config/credentials/*.key
+
+# Ignore all environment files.
+/.env*
+!/.env.example
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+<% if keeps? -%>
+!/log/.keep
+!/tmp/.keep
+
+# Ignore pidfiles, but keep the directory.
+/tmp/pids/*
+!/tmp/pids/
+!/tmp/pids/.keep
+<% end -%>
+
+# Ignore storage (uploaded files in development and any SQLite databases).
+/storage/*
+<% if keeps? -%>
+!/storage/.keep
+/tmp/storage/*
+!/tmp/storage/
+!/tmp/storage/.keep
+<% end -%>
+<% unless options.api? -%>
+
+# Ignore assets.
+/node_modules/
+/app/assets/builds/*
+!/app/assets/builds/.keep
+/public/assets
+<% end -%>

data/lib/generators/templates/node-version.erb

@@ -0,0 +1 @@
+<%= ENV["NODE_VERSION"] || node_version %>

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: dockerfile-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sam Ruby
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email: rubys@intertwingly.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/dockerfile-rails.rb
+- lib/dockerfile-rails/scanner.rb
+- lib/generators/dockerfile_generator.rb
+- lib/generators/templates/Dockerfile.erb
+- lib/generators/templates/docker-entrypoint.erb
+- lib/generators/templates/dockerignore.erb
+- lib/generators/templates/node-version.erb
+homepage: https://github.com/rubys/docker-rails
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/rubys/docker-rails
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.2
+signing_key:
+specification_version: 4
+summary: Dockerfile generator for Rails
+test_files: []