boxing 0.3.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc45fc502d0e92045969b463a8371bfd70c0375903be656554d0b0523a4e54db
-  data.tar.gz: 2f65fa15db1b98e7f2c8b58c592fdef26feb484408d1bdc75329f882b0561f6c
+  metadata.gz: cd1ab96ae737b37be480b3d7d862a5925b951062f7ccae22eb200d26e55f3a14
+  data.tar.gz: 8cd2271e0cb3fc6736c2440f978bdee63b0ba43c90a57596f9064f5b576788ae
 SHA512:
-  metadata.gz: b3d12460d64bd448880826172ea91393f58ea1b2e44178ae343da1ca2023909a45b2ff1d3c7afc5efcb7b8f0657c8f99d2490d633638cfef45ae2f28ecb176c5
-  data.tar.gz: 0c8ba08ef084fe5881e8cb90b54ff1d9486abe2de905d21103346b4e445962dbe488c714aac8fe8d599319036d795fd0ac4cef9e9db83680b331e8106fe4e721
+  metadata.gz: 0c4c43055ed9973e21b4e1660fff4bc5f6cd870f08f82339a0ea88be4edde2914c2e37086a5bf92a48e493c12fb2ba20c68bb28c936fcd2e3f77a6fe5e5edf29
+  data.tar.gz: 25dd924fc89a7aa20361acbcdc2c52b0e320c007308ac1a79a227df9938c2b575f7ee468a0dac1dd5cda8d17a820ea0c6e2fcb18de3ad7e7c15c5fa8746205cd

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    boxing (0.3.1)
+    boxing (0.6.0)
       bundler (~> 2.0)
       thor (~> 1.0)
 

data/README.md

@@ -78,21 +78,90 @@ bundle exec boxing update
 
 > If the generated `Dockerfile` is not satisfy, please try to update it.
 
+## Configuration
+
+If `config/boxing.rb` is found, it will be loaded and change the generated `Dockerfile` and `.dockerignore`
+
+### Source Code Root
+
+```ruby
+Boxing.config do |c|
+  c.root = '/var/www'
+end
+```
+
+### Ignore Files
+
+```ruby
+Boxing.config do |c|
+  c.ignores = %w[
+    vendor/gems
+  ]
+end
+```
+
+### Extra Packages
+
+```ruby
+Boxing.config do |c|
+  c.build_packages = %w[nodejs]
+  c.runtime_packages = %w[git]
+end
+```
+
+### Assets Precompile
+
+This feature is disabled by default and suggest to use CI to build it.
+
+```ruby
+Boxing.config do |c|
+  c.assets_precompile = true
+  # If not given the `node -v` will be execute
+  c.node_version = '14.18'
+end
+```
+
+### Health Check
+
+```ruby
+Boxing.config do |c|
+  c.health_check = true
+  c.health_check_path = '/api/status.json'
+end
+```
+
+> If `liveness` gem is installed, the health check will enabled by default with `/status` path.
+
 ## Roadmap
 
 * [x] `Dockerfile` generator
-* [x] `.gitignore` generator
+* [x] `.dockerignore` generator
   * [x] Common ignore files
-  * [ ] Customizable ignore files
-* [ ] Customize config file `config/boxing.rb`
-* [ ] Entrypoint Detection
-  * [x] Openbox (Suggested)
+  * [x] Customizable ignore files
+* [ ] Docker Compose generator
+  * [ ] Production Version
+  * [x] Development Version
+* [x] Allow run Assets Precompile in Container
+  * [ ] Disable `RAILS_SERVE_STATIC_FILES` by default
+* [x] Customize config file `config/boxing.rb`
+  * [x] Customize `APP_ROOT`
+  * [ ] Extra packages
+  * [ ] DSL to customize `Dockerfile`
+    * [ ] Build Stage
+    * [ ] Entrypoint
+    * [ ] Command
+    * [x] Expose Port
+* [x] Health Check
+  * [x] [Liveness](https://github.com/elct9620/openbox) gem detection
+  * [x] Add `curl` for web application
+* [x] Entrypoint Detection
+  * [x] [Openbox](https://github.com/elct9620/openbox) (Suggested)
   * [x] Ruby on Rails
-  * [ ] Rack
-  * [ ] Ruby
+  * [x] Rack (Default)
 * [ ] Package Database
   * [x] Built-in (Move to standalone repoistory in future)
   * [x] Standalone Repoistory
+  * [x] Support gems from `git` repoistory
   * [x] Customize Source
   * [ ] Base Image
     * [x] Alpine

data/lib/boxing/command.rb

@@ -12,7 +12,9 @@ module Boxing
       true
     end
 
+    require_relative 'commands/base'
     require_relative 'commands/generate'
+    require_relative 'commands/compose'
     require_relative 'commands/update'
   end
 end

data/lib/boxing/commands/base.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Boxing
+  # :nodoc:
+  module Commands
+    # The Base Command
+    #
+    # @since 0.5.0
+    class Base < Thor::Group
+      include Thor::Actions
+
+      # :nodoc:
+      def self.source_root
+        Pathname.new(File.dirname(__FILE__)).join('../../..')
+      end
+
+      # Prepare command environment
+      #
+      # @since 0.5.0
+      def prepare
+        config = Bundler.root.join('config/boxing.rb')
+        return unless config.exist?
+
+        load config
+      end
+
+      private
+
+      # :nodoc:
+      def context
+        @context = Context.new(
+          Boxing.config,
+          Database.new,
+          Boxing.dependencies
+        )
+      end
+    end
+  end
+end

data/lib/boxing/commands/compose.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Boxing
+  # :nodoc:
+  module Commands
+    # The Docker Compose Generator
+    #
+    # @since 0.1.0
+    class Compose < Base
+      # Create Dockerfile
+      #
+      # @since 0.1.0
+      def execute
+        Database.download! unless Database.exist?
+
+        # TODO: Allow set image registry
+        # TODO: Allow set application name
+        template('templates/docker-compose.yml.tt', 'docker-compose.yml', context: context.to_binding)
+      end
+    end
+
+    Boxing::Command.register(Compose, 'compose', 'compose', 'Generate docker-compose.yml')
+  end
+end

data/lib/boxing/commands/generate.rb

@@ -9,14 +9,7 @@ module Boxing
     # The Dockerfle Generator
     #
     # @since 0.1.0
-    class Generate < Thor::Group
-      include Thor::Actions
-
-      # :nodoc:
-      def self.source_root
-        Pathname.new(File.dirname(__FILE__)).join('../../..')
-      end
-
+    class Generate < Base
       # Create Dockerfile
       #
       # @since 0.1.0
@@ -26,15 +19,6 @@ module Boxing
         template('templates/Dockerfile.tt', 'Dockerfile', context: context.to_binding)
         template('templates/dockerignore.tt', '.dockerignore', context: context.to_binding)
       end
-
-      private
-
-      def context
-        @context = Context.new(
-          Database.new,
-          Boxing.dependencies
-        )
-      end
     end
 
     Boxing::Command.register(Generate, 'generate', 'generate', 'Generate Dockerfile')

data/lib/boxing/commands/update.rb

@@ -6,7 +6,7 @@ module Boxing
     # The Database Updater
     #
     # @since 0.3.0
-    class Update < Thor::Group
+    class Update < Base
       # Update Database
       #
       # @since 0.3.0

data/lib/boxing/config.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Boxing
+  # The config of boxing
+  #
+  # @since 0.5.0
+  class Config
+    # @!attribute root
+    #   @return [String] the application root
+    #
+    # @since 0.5.0
+    attr_accessor :root, :name, :registry, :ignores, :port,
+                  :health_check, :health_check_path,
+                  :assets_precompile, :node_version,
+                  :build_packages, :runtime_packages
+
+    # @since 0.5.0
+    def initialize(&block)
+      @name = 'myapp'
+      @root = '/srv/app'
+      @port = 9292
+      @health_path = '/status'
+      @assets_precompile = false
+
+      instance_exec(self, &block) if defined?(yield)
+    end
+  end
+end

data/lib/boxing/context.rb

@@ -5,13 +5,20 @@ module Boxing
   #
   # @since 0.1.0
   class Context
+    # @since 0.5.0
+    attr_reader :config
+
+    # @param config [Boxing::Config]
     # @param database [Boxing::Database]
     # @param dependencies [Array<Bundler::Dependency>]
     #
     # @since 0.1.0
-    def initialize(database, dependencies = [])
+    def initialize(config, database, dependencies = [])
+      @config = config
       @database = database
       @dependencies = dependencies
+
+      @config.port = 3000 if has?('rails')
     end
 
     # Return required packages
@@ -20,11 +27,14 @@ module Boxing
     #
     # @since 0.1.0
     def packages
-      @packages ||= Set.new(
-        @dependencies
-        .map(&:name)
-        .flat_map { |name| @database.package_for(name).to_a }
-      )
+      @packages ||=
+        Set
+        .new(default_packages + extra_packages)
+        .merge(
+          @dependencies
+          .map(&:name)
+          .flat_map { |name| @database.package_for(name).to_a }
+        )
     end
 
     # Check rubygems exists
@@ -38,6 +48,54 @@ module Boxing
       @dependencies.any? { |dep| names.include?(dep.name) }
     end
 
+    # Does any gem from git
+    #
+    # @return [TrueClass|FalseClass]
+    #
+    # @since 0.4.0
+    def git?
+      @dependencies.any?(&:git)
+    end
+
+    # Default packages
+    #
+    # @return [Array<Boxing::Package>]
+    #
+    # @since 0.4.0
+    def default_packages
+      [
+        Package.new('build-base', mode: Package::BUILD)
+      ]
+        .push(git? ? Package.new('git', mode: Package::BUILD) : nil)
+        .push(has?('liveness') ? Package.new('curl', mode: Package::RUNTIME) : nil)
+        .compact
+    end
+
+    # Extra Packages
+    #
+    # @return [Array<Boxing::Package>]
+    #
+    # @since 0.6.0
+    def extra_packages
+      Array[config.build_packages, config.runtime_packages].compact.flat_map do |name|
+        mode = 0
+        mode |= Package::BUILD if config.build_packages&.include?(name)
+        mode |= Package::RUNTIME if config.runtime_packages&.include?(name)
+        Package.new(name, mode: mode)
+      end
+    end
+
+    # Return node.js version
+    #
+    # @return [String]
+    #
+    # @since 0.6.0
+    def node_version
+      return config.node_version if config.node_version
+
+      `node -v`.gsub(/^v/, '')
+    end
+
     # Convert to binding
     #
     # @return [Binding]

data/lib/boxing/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Boxing
-  VERSION = '0.3.1'
+  VERSION = '0.6.0'
 end

data/lib/boxing.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'boxing/version'
+require_relative 'boxing/config'
 require_relative 'boxing/package'
 require_relative 'boxing/database'
 require_relative 'boxing/context'
@@ -10,6 +11,8 @@ require_relative 'boxing/command'
 #
 # @since 0.1.0
 module Boxing
+  LOCK = Mutex.new
+
   module_function
 
   # @return [Bundler::Dependency]
@@ -21,4 +24,19 @@ module Boxing
       .current_dependencies
       .select { |dep| (dep.groups & groups).any? }
   end
+
+  # @return [Boxing::Config]
+  #
+  # @since 0.5.0
+  def config(&block)
+    return @config if @config
+
+    LOCK.synchronize do
+      return @config if @config
+
+      @config = Config.new(&block)
+    end
+
+    @config
+  end
 end

data/templates/Dockerfile.tt

@@ -1,10 +1,11 @@
-ARG APP_ROOT=/src/app
+ARG APP_ROOT=<%= config.root %>
 ARG RUBY_VERSION=<%= RUBY_VERSION %>
+<%- if config.assets_precompile -%>ARG NODE_VERSION=<%= node_version %><%- end -%>
 
 FROM ruby:${RUBY_VERSION}-alpine AS gem
 ARG APP_ROOT
 
-RUN apk add --no-cache build-base <%= packages.select(&:build?).join(' ') %>
+RUN apk add --no-cache <%= packages.select(&:build?).join(' ') %>
 
 RUN mkdir -p ${APP_ROOT}
 COPY Gemfile Gemfile.lock ${APP_ROOT}/
@@ -23,15 +24,35 @@ RUN gem install bundler:<%= Bundler::VERSION %> \
     && find /usr/local/bundle -type f -name '*.o' -delete \
     && rm -rf /usr/local/bundle/cache/*.gem
 
+<%- if config.assets_precompile -%>
+FROM node:${NODE_VERSION}-alpine as node
+FROM ruby:${RUBY_VERSION}-alpine as assets
+ARG APP_ROOT
+
+<%- if packages.select(&:runtime?).any? -%>
+RUN apk add --no-cache <%= packages.select(&:runtime?).join(' ') %> yarn
+
+<%- end -%>
+COPY --from=node /usr/local/bin/node /usr/local/bin/node
+
+COPY --from=gem /usr/local/bundle/config /usr/local/bundle/config
+COPY --from=gem /usr/local/bundle /usr/local/bundle
+COPY --from=gem /${APP_ROOT}/vendor/bundle /${APP_ROOT}/vendor/bundle
+
+RUN mkdir -p ${APP_ROOT}
+COPY . ${APP_ROOT}
+
+ENV RAILS_ENV production
+WORKDIR ${APP_ROOT}
+RUN bundle exec rake assets:precompile
+
+<%- end -%>
 FROM ruby:${RUBY_VERSION}-alpine
 ARG APP_ROOT
 
 <%- if packages.select(&:runtime?).any? -%>
 RUN apk add --no-cache <%= packages.select(&:runtime?).join(' ') %>
 
-ARG REVISION
-ENV REVISION $REVISION
-
 <%- end -%>
 COPY --from=gem /usr/local/bundle/config /usr/local/bundle/config
 COPY --from=gem /usr/local/bundle /usr/local/bundle
@@ -42,10 +63,15 @@ RUN mkdir -p ${APP_ROOT}
 <%- if has?('rails') -%>
 ENV RAILS_ENV=production
 ENV RAILS_LOG_TO_STDOUT=true
+ENV RAILS_SERVE_STATIC_FILES=yes
 <%- end -%>
 ENV APP_ROOT=$APP_ROOT
 
 COPY . ${APP_ROOT}
+COPY --from=assets /${APP_ROOT}/public /${APP_ROOT}/public
+
+ARG REVISION
+ENV REVISION $REVISION
 RUN echo $REVISION > ${SERVER_ROOT}/REVISION
 
 # Apply Execute Permission
@@ -60,7 +86,10 @@ RUN adduser -h ${APP_ROOT} -D -s /bin/nologin ruby ruby && \
 USER ruby
 WORKDIR ${APP_ROOT}
 
-EXPOSE <%= has?('rails') ? '3000' : '9292' %>
+EXPOSE <%= config.port %>
+<%- if has?('liveness') || config.health_check -%>
+HEALTHCHECK CMD curl -f http://localhost:<%= config.port %><%= config.health_check_path %> || exit 1
+<%- end -%>
 <%- if has?('openbox') -%>
 ENTRYPOINT ["bin/openbox"]
 CMD ["server"]

data/templates/docker-compose.yml.tt

@@ -0,0 +1,47 @@
+version: '3.4'
+
+volumes:
+  database:
+    driver: local
+
+services:
+<%- if has?('pg') -%>
+  postgres:
+    image: postgres:13.1
+    volumes:
+      - database:/var/lib/postgresql/data
+    environment:
+      - POSTGRES_DB=<%= config.name %>
+      - POSTGRES_USER=<%= config.name %>
+      - POSTGRES_PASSWORD=<%= config.name %>
+<%- end -%>
+<%- if has?('mysql2') -%>
+  mysql:
+    image: mysql:8.0
+    volumes:
+      - database:/var/lib/mysql
+    environment:
+      - MYSQL_USER=<%= config.name %>
+      - MYSQL_PASSWORD=<%= config.name %>
+      - MYSQL_DATABASE=<%= config.name %>
+      - MYSQL_ROOT_PASSWORD=<%= config.name %>
+<%- end -%>
+  application:
+<%- if config.registry.nil? -%>
+    build:
+      context: .
+<%- else -%>
+    image: <%= config.registry %>
+<%- end -%>
+    environment:
+      - RAILS_MASTER_KEY
+      - AUTO_MIGRATION=yes
+      <%- if has?('pg') -%>
+      - DATABASE_URL=postgres://<%= config.name %>:<%= config.name %>@postgres/<%= config.name %>
+      <%- elsif has?('mysql2') %>
+      - DATABASE_URL=mysql2://<%= config.name %>:<%= config.name %>@mysql/<%= config.name %>
+      <%- end -%>
+    ports:
+      - "3000:3000"
+    depends_on:
+      - postgres

data/templates/dockerignore.tt

@@ -8,8 +8,10 @@ docker-compose*.yml
 # CI/CD
 .github/
 .cache/
+.circleci/
 coverage/
 spec/
+test/
 features/
 .gitlab-ci.yml
 .travis.yml
@@ -28,6 +30,17 @@ rspec.xml
 log/*
 tmp/*
 
+# Frontend
+node_modules/
+
 # Licensed
 .licensed.yml
 .licenses
+
+# Boxing
+config/boxing.rb
+<% if config.ignores -%>
+
+# Customize Ignores
+<%= Array[config.ignores].join("\n") %>
+<%- end -%>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: boxing
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.6.0
 platform: ruby
 authors:
 - 蒼時弦也
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-29 00:00:00.000000000 Z
+date: 2022-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -60,13 +60,17 @@ files:
 - exe/boxing
 - lib/boxing.rb
 - lib/boxing/command.rb
+- lib/boxing/commands/base.rb
+- lib/boxing/commands/compose.rb
 - lib/boxing/commands/generate.rb
 - lib/boxing/commands/update.rb
+- lib/boxing/config.rb
 - lib/boxing/context.rb
 - lib/boxing/database.rb
 - lib/boxing/package.rb
 - lib/boxing/version.rb
 - templates/Dockerfile.tt
+- templates/docker-compose.yml.tt
 - templates/dockerignore.tt
 homepage: https://github.com/elct9620/boxing
 licenses: []