dockerfile-rails 0.0.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e00977164abc39c9b3b66c636834cda09f32f939045db5a5f496b51a455ee4f
-  data.tar.gz: bc3305fa419473f18eace29a65a9461fbd90c423106ff3cf1c5c42d0ed3b58ba
+  metadata.gz: b317d73db1dda4043a0cf7ad8bc237cc909cf6fe08550960e57190651fe15f5a
+  data.tar.gz: 15454b9d5fee80e253dff57fe4f708f9e2c0bc729a1c1b506e2e96a7f1c13666
 SHA512:
-  metadata.gz: d92c231f9d0484dcc196837aab9a3f3c3b6158202d5c8d942a61231ec9d5ec3fa0af8cf54a8daffea5d6f1103241aa5bb88a79cb9ea0a29974a08b579f7b2356
-  data.tar.gz: 1e65aec6411ddac4d9785f087f16c2b8645e0895701fe6da58d93369d45d2aa8b71c4cb48c777e64737cf805a08ca4fc4da66a44d0ab007fa36f2351065ffc95
+  metadata.gz: ff075f1ab57a0a7bf5a6f084bc8c552f5a9a4b2e16a9452fec6d07b5f245dd7e8cc56e74d447af3083906926747fb868e0a76a99da8f0cba20c61273fd7f7010
+  data.tar.gz: c6306db9e351812343158cad19c59da387889f1fb449006e73806329d8b375d3ff8534e9f4c358c9b34368f1ea9e98d3e0b23d5833067477ccf6a68fe744bf9b

data/README.md

@@ -5,16 +5,17 @@ Provide Rails generators to produce Dockerfiles and related files.
 ## Usage
 
 ```
-bundle add dockerfile-rails
+bundle add dockerfile-rails --group development
 bin/rails generate dockerfile
 ```
 
 General options:
 
 * `--force` - overwrite existing files
-* `--ci` - include test gems in bundle
+* `--ci` - include test gems in deployed image
 * `--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
 
 Dependencies:
 
@@ -25,4 +26,10 @@ additional support may be needed:
 * `--mysql` - add mysql libraries
 * `--posgresql` - add posgresql libraries
 * `--redis` - add redis libraries
-* `--sqlite3` - add sqlite3 libraries
+* `--sqlite3` - add sqlite3 libraries
+
+Links:
+
+* [Demos](./DEMO.md)
+* [Preparations for Rails 7.1](https://community.fly.io/t/preparations-for-rails-7-1/9512)
+* [Rails Dockerfile futures](https://discuss.rubyonrails.org/t/rails-dockerfile-futures/82091/1)

data/lib/dockerfile-rails/scanner.rb

@@ -18,6 +18,7 @@ module DockerfileRails
       ### ruby gems ###
 
       @gemfile = []
+      @git = false
 
       if File.exist? 'Gemfile.lock'
         parser = Bundler::LockfileParser.new(Bundler.read_file('Gemfile.lock'))
@@ -25,7 +26,9 @@ module DockerfileRails
       end
       
       if File.exist? 'Gemfile'
-        @gemfile += Bundler::Definition.build('Gemfile', nil, []).dependencies.map(&:name)
+        gemfile_definition = Bundler::Definition.build('Gemfile', nil, [])
+        @gemfile += gemfile_definition.dependencies.map(&:name)
+        @git = !gemfile_definition.spec_git_paths.empty?
       end
 
       @sidekiq = @gemfile.include? 'sidekiq'

data/lib/generators/dockerfile_generator.rb

@@ -10,6 +10,9 @@ class DockerfileGenerator < Rails::Generators::Base
   class_option :parallel, type: :boolean, default: false,
     desc: 'use build stages to install gems and node modules in parallel'
 
+  class_option :compose, type: :boolean, default: false,
+    desc: 'generate a docker-compose.yml file'
+
   class_option :redit, type: :boolean, default: false,
     desc: 'include redis libraries'
 
@@ -34,6 +37,8 @@ class DockerfileGenerator < Rails::Generators::Base
 
     template 'docker-entrypoint.erb', 'bin/docker-entrypoint'
     chmod "bin/docker-entrypoint", 0755 & ~File.umask, verbose: false
+
+    template 'docker-compose.yml.erb', 'docker-compose.yml'
   end
 
 private
@@ -43,6 +48,10 @@ private
     @using_node = File.exist? 'package.json'
   end
 
+  def using_redis?
+    options.redis? or @redis
+  end
+
   def parallel?
     using_node? && options.parallel
   end
@@ -61,8 +70,11 @@ private
     packages << 'libpq-dev' if options.postgresql? or @postgresql
     packages << 'default-libmysqlclient-dev' if options.mysql or @mysql
 
+    # add git if needed to install gems
+    packages << 'git' if @git
+
     # add redis in case Action Cable, caching, or sidekiq are added later
-    packages << "redis" if options.redis? or @redis
+    packages << "redis" if using_redis?
 
     # ActiveStorage preview support
     packages << "libvips" if @gemfile.include? 'ruby-vips'
@@ -103,7 +115,7 @@ private
     packages << 'default-mysql-client' if options.mysql or @mysql
 
     # add redis in case Action Cable, caching, or sidekiq are added later
-    packages << "redis" if options.redis? or @redis
+    packages << "redis" if using_redis?
 
     # ActiveStorage preview support
     packages << "libvips" if @gemfile.include? 'ruby-vips'
@@ -140,14 +152,24 @@ private
     binfixups
   end
 
+  def deploy_database
+    if options.postgresql? or @postgresql
+      'postgresql'
+    elsif options.mysql or @mysql
+      'mysql'
+    else
+      'sqlite3'
+    end
+  end
+
   def node_version
-    using_node? and `node --version`[/\d+\.\d+\.\d+/]
+    `node --version`[/\d+\.\d+\.\d+/]
   rescue
     "lts" 
   end
 
   def yarn_version
-    using_node? and `yarn --version`[/\d+\.\d+\.\d+/]
+    `yarn --version`[/\d+\.\d+\.\d+/]
   rescue
     "latest"
   end
@@ -160,6 +182,23 @@ private
     Rails.application.config.api_only
   end
 
+  def api_client_dir
+    return unless api_only?
+
+    file = Dir['*/package.json'].find do |file|
+      JSON.load_file(file).dig('scripts', 'build')
+    end
+
+    file && File.dirname(file)
+  end
+
+  def api_client_files
+    client = api_client_dir
+    return unless client
+
+    Dir["#{client}/{package.json,package-lock.json,yarn.lock}"]
+  end
+
   def dbprep_command
     if Rails::VERSION::MAJOR >= 6
       'db:prepare'

data/lib/generators/templates/Dockerfile.erb

@@ -1,7 +1,40 @@
 # syntax = docker/dockerfile:1
 
-# Make sure it matches the Ruby version in .ruby-version and Gemfile
+# Make sure RUBY_VERSION matches the Ruby version in .ruby-version and Gemfile
 ARG RUBY_VERSION=<%= Gem.ruby_version %>
+<% if api_client_dir -%>
+ARG NODE_VERSION=<%= node_version %>
+
+FROM node:$NODE_VERSION-slim as client
+
+WORKDIR /rails/<%= api_client_dir %>
+
+ENV NODE_ENV=production
+
+# Install node modules
+COPY <%= api_client_files.join(' ') %> .
+<% if api_client_files.join.include? 'yarn' -%>
+<% 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 -%>
+<% else -%>
+<% if options.cache? -%>
+RUN --mount=type=cache,id=bld-yarn-cache,target=/root/.npm \
+    npm install
+<% else -%>
+RUN npm install
+<% end -%>
+<% end -%>
+
+# build client application
+COPY <%= api_client_dir %> .
+RUN npm run build
+
+
+<% end -%>
 FROM ruby:$RUBY_VERSION-slim as base
 
 # Rails app lives here
@@ -122,11 +155,16 @@ RUN apt-get update -qq && \
 <% end -%>
 <% end -%>
 
-# Copy built application from second stage
+# Copy built application from previous stage
 <% if options.ci? -%>
 COPY --from=build /usr/local/bundle /usr/local/bundle
 <% end -%>
 COPY --from=build /rails /rails
+<% if api_client_dir -%>
+
+# Copy built client
+COPY --from=client /rails/<%= api_client_dir %>/build /rails/public
+<% end -%>
 
 # Deployment options
 ENV RAILS_LOG_TO_STDOUT="1" \

data/lib/generators/templates/docker-compose.yml.erb

@@ -0,0 +1,71 @@
+version: "3.8"
+services:
+  web:
+    build: .
+    ports:
+      - "3000:3000"
+    environment:
+      - RAILS_MASTER_KEY=$RAILS_MASTER_KEY
+<% if using_redis? -%>
+      - REDIS_URL=redis://redis-db:6379
+<% end -%>
+<% if deploy_database == 'postgresql' -%>
+      - DATABASE_URL=postgres://root:password@postgres-db/
+<% elsif deploy_database == 'mysql' -%>
+      - DATABASE_URL=mysql2://root:password@mysql-db/
+<% end -%>
+<% if deploy_database == 'sqlite3' -%>
+    volumes:
+      - ./db:/rails/db
+<% end -%>
+<% if using_redis? or deploy_database != 'sqlite3' -%>
+    depends_on:
+<% if using_redis? -%>
+      redis-db:
+        condition: service_started
+<% end -%>
+<% if deploy_database == 'postgresql' -%>
+      postgres-db:
+        condition: service_healthy
+<% elsif deploy_database == 'mysql' -%>
+      mysql-db:
+        condition: service_healthy
+<% end -%>
+<% if deploy_database == 'postgresql' -%>
+
+  postgres-db:
+    image: postgres
+    environment:
+      POSTGRES_USER: root
+      POSTGRES_PASSWORD: password
+    volumes:
+      - ./tmp/db:/var/lib/postgresql/data
+    ports:
+      - "5432:5432"
+    healthcheck:
+      test: pg_isready
+      interval: 2s
+      timeout: 5s
+      retries: 30
+<% elsif deploy_database == 'mysql' -%>
+
+  mysql-db:
+    image: mysql
+    command:
+      - --default-authentication-plugin=mysql_native_password
+    environment:
+      MYSQL_ROOT_PASSWORD: password
+    volumes:
+      - ./tmp/db:/var/lib/mysql
+    healthcheck:
+      test: mysqladmin ping -h 127.0.0.1 -u root --password=password
+      interval: 2s
+      timeout: 5s
+      retries: 30
+<% end -%>
+<% end -%>
+<% if using_redis? -%>
+
+  redis-db:
+    image: redis
+<% end -%>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dockerfile-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Sam Ruby
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-14 00:00:00.000000000 Z
+date: 2023-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -37,6 +37,7 @@ files:
 - lib/dockerfile-rails/scanner.rb
 - lib/generators/dockerfile_generator.rb
 - lib/generators/templates/Dockerfile.erb
+- lib/generators/templates/docker-compose.yml.erb
 - lib/generators/templates/docker-entrypoint.erb
 - lib/generators/templates/dockerignore.erb
 - lib/generators/templates/node-version.erb