boxing 0.1.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 716a6100d6aa32b77aa0ec152655d305a218e69810171bc3e8b6884c90ddbba0
-  data.tar.gz: 0a96c48d4cbbf0ecf5ce34e19955150576e2dca7b7a9841be40eb17f79c274bb
+  metadata.gz: bc45fc502d0e92045969b463a8371bfd70c0375903be656554d0b0523a4e54db
+  data.tar.gz: 2f65fa15db1b98e7f2c8b58c592fdef26feb484408d1bdc75329f882b0561f6c
 SHA512:
-  metadata.gz: 62c1a29292e5b511b57e58f4cf3d1659e16ffdb4da102f02dceb395a5d0bb77c73f2eeeafba8294a0ec57cc742bb18e6cc304b72b2032c97c0507cf19604597e
-  data.tar.gz: a177892ab763e676074a8e38fdbcfedb961b0076f61d891d0089324062ab128335e336a8f63c0367d3a269a4be02c53749a1f4a74403db1362217bc622e1f9c2
+  metadata.gz: b3d12460d64bd448880826172ea91393f58ea1b2e44178ae343da1ca2023909a45b2ff1d3c7afc5efcb7b8f0657c8f99d2490d633638cfef45ae2f28ecb176c5
+  data.tar.gz: 0c8ba08ef084fe5881e8cb90b54ff1d9486abe2de905d21103346b4e445962dbe488c714aac8fe8d599319036d795fd0ac4cef9e9db83680b331e8106fe4e721

data/Gemfile.lock

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

data/README.md

@@ -2,6 +2,8 @@
 
 The zero-configuration Dockerfile generator for Ruby.
 
+> The [Database Repository](https://github.com/elct9620/ruby-boxing-db) will be used for package information.
+
 ## Installation
 
 Add this line to your application's Gemfile development group:
@@ -16,6 +18,46 @@ And then execute:
 
     $ bundle install
 
+## Features
+
+### Automatic Package Finder
+
+This gem will read `Gemfile` and find any "knows" gem in the dependency database and put the necessary package as a dependency for build and runtime.
+
+That means you never need to know the actual package and don't need to write your Dockerfile by hand.
+
+### Optimized Size
+
+By the default, the base image is depend on `ruby:[VERSION]-alpine` which is minimal size for Ruby in most cases.
+
+To let your image as small as possible, this gem uses multi-stage and strip useless artifacts while the c-extension compiling.
+
+The final Rails image will be around 100MB and can be flexible to delivery to any environment.
+
+> We suggest using `puma` as the webserver to avoid the extra dependency to keep the image small.
+
+### Revision
+
+To identity your image version, the default build argument `REVISION` will be configured by default.
+
+You can add extra options when you are building images in your CI.
+
+```yaml
+# GitLab CI example
+docker:rails:
+  extends: .docker
+  stage: package
+  script:
+    - docker build
+      --cache-from $RAILS_IMAGE:latest
+      --build-arg REVISION=${CI_COMMIT_SHORT_SHA}
+      --build-arg BUILDKIT_INLINE_CACHE=1
+      --tag $RAILS_IMAGE:$CI_COMMIT_REF_SLUG
+      --tag $RAILS_IMAGE:latest .
+```
+
+It will helpful for Sentry to detect the released version or use `<%= ENV['REVISION'] %>` to help you identify the current version.
+
 ## Usage
 
 ### Generate
@@ -26,9 +68,22 @@ To generate `Dockerfile` for current project
 bundle exec boxing generate
 ```
 
+### Update
+
+To update the database for package information
+
+```ruby
+bundle exec boxing update
+```
+
+> If the generated `Dockerfile` is not satisfy, please try to update it.
+
 ## Roadmap
 
 * [x] `Dockerfile` generator
+* [x] `.gitignore` generator
+  * [x] Common ignore files
+  * [ ] Customizable ignore files
 * [ ] Customize config file `config/boxing.rb`
 * [ ] Entrypoint Detection
   * [x] Openbox (Suggested)
@@ -37,12 +92,13 @@ bundle exec boxing generate
   * [ ] Ruby
 * [ ] Package Database
   * [x] Built-in (Move to standalone repoistory in future)
-  * [ ] Standalone Repoistory
-  * [ ] Customize Source
+  * [x] Standalone Repoistory
+  * [x] Customize Source
   * [ ] Base Image
     * [x] Alpine
     * [ ] Ubuntu
-  * [ ] Ruby Version
+  * [ ] Filter by Ruby Version
+  * [ ] Filter by Gem Version
 
 ## Development
 

data/lib/boxing/command.rb

@@ -13,5 +13,6 @@ module Boxing
     end
 
     require_relative 'commands/generate'
+    require_relative 'commands/update'
   end
 end

data/lib/boxing/commands/generate.rb

@@ -21,7 +21,10 @@ module Boxing
       #
       # @since 0.1.0
       def execute
+        Database.download! unless Database.exist?
+
         template('templates/Dockerfile.tt', 'Dockerfile', context: context.to_binding)
+        template('templates/dockerignore.tt', '.dockerignore', context: context.to_binding)
       end
 
       private

data/lib/boxing/commands/update.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Boxing
+  # :nodoc:
+  module Commands
+    # The Database Updater
+    #
+    # @since 0.3.0
+    class Update < Thor::Group
+      # Update Database
+      #
+      # @since 0.3.0
+      def execute
+        if Database.exist?
+          Database.new.update!
+        else
+          Database.download!
+        end
+      end
+    end
+
+    Boxing::Command.register(Update, 'update', 'update', 'Update Database')
+  end
+end

data/lib/boxing/database.rb

@@ -9,12 +9,80 @@ module Boxing
   # @since 0.1.0
   class Database
     class << self
-      # The database root
+      # Check for the database exists
       #
-      # @since 0.1.0
-      def root
-        @root ||= Pathname.new(File.dirname(__FILE__)).join('../../database')
+      # @param [String] path
+      #
+      # @return [TrueClass\FalseClass]
+      #
+      # @since 0.3.0
+      def exist?(path = DEFAULT_PATH)
+        File.directory?(path) && !(Dir.entries(path) - %w[. ..]).empty?
+      end
+
+      # Download Database
+      #
+      # @since 0.3.0
+      def download!(path = DEFAULT_PATH)
+        command = %w[git clone --quiet]
+        command << URL << path.to_s
+
+        raise DownloadFailed, "failed to download #{URL} to #{path}" unless system(*command)
+
+        new(path)
+      end
+    end
+
+    # @since 0.3.0
+    class DownloadFailed < RuntimeError; end
+
+    # @since 0.3.0
+    class UpdateFailed < RuntimeError; end
+
+    # Git URL of the ruby-boxing-db
+    #
+    # @since 0.3.0
+    URL = 'https://github.com/elct9620/ruby-boxing-db.git'
+
+    # Path to the user's copy of ruby-boxing-db
+    #
+    # @since 0.3.0
+    USER_PATH = Pathname.new(Gem.user_home).join('.local/share/ruby-boxing-db')
+
+    # @since 0.3.0
+    DEFAULT_PATH = ENV['BOXING_DB'] || USER_PATH
+
+    # @since 0.3.0
+    attr_reader :path
+
+    # Initialize Database
+    #
+    # @since 0.3.0
+    def initialize(path = DEFAULT_PATH)
+      @path = path
+    end
+
+    # The Database is Git Repoistory
+    #
+    # @return [TrueClass|FalseClass]
+    #
+    # @since 0.3.0
+    def git?
+      File.directory?(File.join(@path, '.git'))
+    end
+
+    # Update the database
+    #
+    # @since 0.3.0
+    def update!
+      return unless git?
+
+      Dir.chdir(@path) do
+        command = %w[git pull --quiet origin main]
+        raise UpdateFailed, "failed to update #{@path}" unless system(*command)
       end
+
+      true
     end
 
     # Find packages for rubygems
@@ -41,7 +109,7 @@ module Boxing
     #
     # @since 0.1.0
     def each_package_path_for(name, &block)
-      Dir.glob(Database.root.join('gems', name, '*.yml'), &block)
+      Dir.glob(File.join(@path, 'gems', name, '*.yml'), &block)
     end
   end
 end

data/lib/boxing/version.rb

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

data/templates/Dockerfile.tt

@@ -29,6 +29,9 @@ 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
@@ -43,6 +46,7 @@ ENV RAILS_LOG_TO_STDOUT=true
 ENV APP_ROOT=$APP_ROOT
 
 COPY . ${APP_ROOT}
+RUN echo $REVISION > ${SERVER_ROOT}/REVISION
 
 # Apply Execute Permission
 RUN adduser -h ${APP_ROOT} -D -s /bin/nologin ruby ruby && \

data/templates/dockerignore.tt

@@ -0,0 +1,33 @@
+# Repo
+.git/
+
+# Docker
+Dockerfile
+docker-compose*.yml
+
+# CI/CD
+.github/
+.cache/
+coverage/
+spec/
+features/
+.gitlab-ci.yml
+.travis.yml
+
+# Lint/Test
+rspec.xml
+.overcommit.yml
+.rubocop*.yml
+
+# Ruby
+.bundle/
+.env
+.env*
+
+# Rails
+log/*
+tmp/*
+
+# Licensed
+.licensed.yml
+.licenses

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: boxing
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.1
 platform: ruby
 authors:
 - 蒼時弦也
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-18 00:00:00.000000000 Z
+date: 2021-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -57,21 +57,17 @@ files:
 - bin/console
 - bin/setup
 - boxing.gemspec
-- database/gems/pg/postgresql-dev.yml
-- database/gems/pg/postgresql-libs.yml
-- database/gems/rails/shared-mime-info.yml
-- database/gems/rails/tzdata.yml
-- database/gems/sqlite3/sqlite-dev.yml
-- database/gems/sqlite3/sqlite-libs.yml
 - exe/boxing
 - lib/boxing.rb
 - lib/boxing/command.rb
 - lib/boxing/commands/generate.rb
+- lib/boxing/commands/update.rb
 - lib/boxing/context.rb
 - lib/boxing/database.rb
 - lib/boxing/package.rb
 - lib/boxing/version.rb
 - templates/Dockerfile.tt
+- templates/dockerignore.tt
 homepage: https://github.com/elct9620/boxing
 licenses: []
 metadata:

data/database/gems/pg/postgresql-dev.yml

@@ -1,2 +0,0 @@
-name: postgresql-dev
-build: yes

data/database/gems/pg/postgresql-libs.yml

@@ -1,2 +0,0 @@
-name: postgresql-libs
-runtime: yes

data/database/gems/rails/shared-mime-info.yml

@@ -1,2 +0,0 @@
-name: shared-mime-info
-runtime: yes

data/database/gems/rails/tzdata.yml

@@ -1,2 +0,0 @@
-name: tzdata
-runtime: yes

data/database/gems/sqlite3/sqlite-dev.yml

@@ -1,2 +0,0 @@
-name: sqlite-dev
-build: yes

data/database/gems/sqlite3/sqlite-libs.yml

@@ -1,2 +0,0 @@
-name: sqlite-libs
-runtime: true