boxing 0.1.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7aa77750bf2c795fb7a6ec267784bbd62c352a9803729c7ba53e2f00e8536867
-  data.tar.gz: ec949c8362198e86a3c93b9c7b90da42697e666a2f98e517614e15dafe2234b4
+  metadata.gz: 747c1ce612416684731778d49c0b85eaf1630d01a305c9a96494e5828d7c0cbc
+  data.tar.gz: fe4025de518fce98279332c9dd5565294966d6b55e6a5bd60bcb09da5672bd8d
 SHA512:
-  metadata.gz: 883826c272959026f32ea98284def5e4908b96cf0866f3469bd934e464ffbe813a252b1fb29dc28c55c418e025c5ebf42c6b22cd21fa84da3d7687c2d72c0b11
-  data.tar.gz: 439823cf586f66dd4180570edbeda8089640c1ff80f7003524b8b34161c40d12ebaf7053dc432617fb3bf0db10844158c01484d17ccca127018b90bc27174603
+  metadata.gz: 075d91ba4af2033ca7f2f55d7d3414dbc9b718f882e6531ed854609469a268ca85c13898c3c5c3e571c4039f0a00b3828a54c6493d5717a59cb30312111317b5
+  data.tar.gz: 15a7c46db72f0c0e481bfbd6af6abecd69e8ac077b3f66bf971a7c98cbb7e33d33b5f87378b3afeb8126f8d00ab0d80a961b49098c6a161884126f5573e8e28e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    boxing (0.1.1)
+    boxing (0.4.0)
       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:
@@ -66,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)
@@ -77,12 +92,14 @@ bundle exec boxing generate
   * [ ] Ruby
 * [ ] Package Database
   * [x] Built-in (Move to standalone repoistory in future)
-  * [ ] Standalone Repoistory
-  * [ ] Customize Source
+  * [x] Standalone Repoistory
+  * [x] Support gems from `git` 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/context.rb

@@ -20,11 +20,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)
+        .merge(
+          @dependencies
+          .map(&:name)
+          .flat_map { |name| @database.package_for(name).to_a }
+        )
     end
 
     # Check rubygems exists
@@ -38,6 +41,29 @@ module Boxing
       @dependencies.any? { |dep| names.include?(dep.name) }
     end
 
+    # Does any gem from git
+    #
+    # @return [TrueClass|FalseClass]
+    #
+    # @since 0.4.0
+    def git?
+      pp @dependencies
+      @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)
+        .compact
+    end
+
     # Convert to binding
     #
     # @return [Binding]

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.1'
+  VERSION = '0.4.0'
 end

data/templates/Dockerfile.tt

@@ -4,7 +4,7 @@ ARG RUBY_VERSION=<%= RUBY_VERSION %>
 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}/
@@ -29,9 +29,6 @@ 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
@@ -46,6 +43,9 @@ ENV RAILS_LOG_TO_STDOUT=true
 ENV APP_ROOT=$APP_ROOT
 
 COPY . ${APP_ROOT}
+
+ARG REVISION
+ENV REVISION $REVISION
 RUN echo $REVISION > ${SERVER_ROOT}/REVISION
 
 # Apply Execute Permission

data/templates/dockerignore.tt

@@ -0,0 +1,35 @@
+# Repo
+.git/
+
+# Docker
+Dockerfile
+docker-compose*.yml
+
+# CI/CD
+.github/
+.cache/
+.circleci/
+coverage/
+spec/
+test/
+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.1
+  version: 0.4.0
 platform: ruby
 authors:
 - 蒼時弦也
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-21 00:00:00.000000000 Z
+date: 2021-12-30 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