openbox 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21387e3425ced629a43bb32997f2c5f8f9cd10647ce9fc75c6353afa53d2c465
-  data.tar.gz: 565964314f2846373e9e94dcf4bacf096cb0918f42dcf195993fb2b4b5492932
+  metadata.gz: c3b2286d2b3b83ce60a50ead93f7f3b293612cd7a9386f21309b2078467acf3e
+  data.tar.gz: e1b3b12fe3c36503c9cfe1c72ac38163b1c7850eeda7e4395adf79c665abc19e
 SHA512:
-  metadata.gz: c4214b43a54cab99c7331f92082c9716cd2f706081de4513ae57887b3e2fc05478ffa0eb80c92c3365b8710a2ac91a8daa9ae294ca423a6385ae1b9330a7b8c5
-  data.tar.gz: 306cf0aa7af340df144ed52e9bd85cfe55276397307d54ce77190e7c33aafd2bdcadc3dd03f94813cb5cfd51c908d93dfc0d46dcb90e15cbb91ea78c2a481fa8
+  metadata.gz: 741418382ee5a71631d3ff8303ea421091527338f72b6a42cfc441c94acdad51b7ede680b44515724bacd3c715e8878e339ed84b80b16186f14750c2c4f3edb9
+  data.tar.gz: ba0bfebc3ed03a62a4321e389202992f7bf988cf00a3a99d6651569fedd46d1496839a35d037f7815e5b336c5ca2af54ae5e60cdd46544b2fdb87d28a128d381

data/.rubocop.yml

@@ -12,3 +12,7 @@
 AllCops:
   TargetRubyVersion: 2.5
   NewCops: enable
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*_spec.rb

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openbox (0.1.0)
+    openbox (0.4.0)
       thor (~> 1.0)
 
 GEM

data/README.md

@@ -1,5 +1,7 @@
 # Openbox
 
+![main branch](https://github.com/elct9620/openbox/actions/workflows/main.yml/badge.svg?branch=main)
+
 The zero-configuration Ruby container entry-point.
 
 ## Installation
@@ -29,12 +31,63 @@ ENTRYPOINT ["bin/openbox"]
 CMD ["server"]
 ```
 
+### Commands
+
+The commands are pre-defined for the Rack and Rails applications.
+
+| Name      | Enabled Condition | Description              |
+|-----------|-------------------|--------------------------|
+| `server`  | `rails` or `rack` | Start application server |
+| `rake`    | `rails` or `rake` | Run rake tasks           |
+| `console` | `rails`           | Start rails console      |
+| `migrate` | `rails`           | Run database migration   |
+| `seed`    | `rails`           | Run database seed        |
+| `sidekiq` | `sidekiq`         | Run sidekiq server       |
+
+### Environments
+
+| Name             | Description                                                                          |
+|------------------|--------------------------------------------------------------------------------------|
+| `AUTO_MIGRATION` | When present, the `migrate` will run before `server` started                         |
+| `DATABASE_URL`   | When `pg` or `mysql2` gem present, Openbox will use it to ensure database connection |
+
+### Customize Commands
+
+When `openbox` execute, the `lib/openbox/commands/*/**.rb` will be scanned and require before started.
+We can register new command by adding files to `lib/openbox/commands` directory.
+
+```ruby
+# lib/openbox/commands/daemon.rb
+
+class Daemon < Openbox::Command
+  def execute
+    exec('bundle exec my-daemon')
+  end
+end
+
+Openbox::Entrypoint.register Daemon, :daemon, :daemon, 'Run a daemon'
+```
+
+> The Rails are not loaded to speed up bootstrap, if you need Rails please load by yourself.
+
 ## Roadmap
 
 * [ ] `config/openbox.rb` config
-* [ ] Customize command
-* [ ] Rake Task support
-  * [ ] Rails capability
+* [x] Customize command
+* [x] Database connection check
+  * [x] PostgreSQL support
+  * [x] MySQL support
+* [x] Run Web Server
+  * [x] `rails server`
+  * [x] `rackup -o 0.0.0.0`
+* [x] Rake Task support
+* [x] Sidekiq support
+* [x] Rails capability
+  * [x] `openbox console` to `rails console`
+  * [x] `openbox migrate` to `rails db:migrate`
+  * [x] `openbox seed` to `rails db:seed`
+  * [x] Use `AUTO_MIGRATION` to run migration before server started
+
 
 ## Development
 

data/exe/openbox

@@ -4,4 +4,14 @@
 
 require 'openbox'
 
-Openbox::Command.start(ARGV)
+CUSTOMIZE_COMMAND_ROOT = if defined?(Bundler)
+                           Bundler.root.join('lib/openbox/commands')
+                         else
+                           Pathname.new(Dir.pwd).join('lib/openbox/commands')
+                         end
+
+CUSTOMIZE_COMMAND_ROOT.glob('**/*.rb') do |command|
+  require command
+end
+
+Openbox::Entrypoint.start(ARGV)

data/lib/openbox/command.rb

@@ -1,24 +1,17 @@
 # frozen_string_literal: true
 
 require 'thor'
-require 'openbox/runtime'
 
 module Openbox
-  # The Container Entrypoint
+  # The base command of openbox
   #
   # @since 0.1.0
-  class Command < Thor
+  class Command < Thor::Group
+    # Execute command
+    #
     # @since 0.1.0
-    desc 'server', 'Start Application Server'
-    def server
-      Openbox.database.ensure_connection!
-      return exec('bundle exec rails server') if Openbox.runtime.rails?
-
-      exec('bundle exec rackup -o 0.0.0.0')
-    end
-
-    def self.exit_on_failure?
-      true
+    def execute
+      raise NotImplementedError
     end
   end
 end

data/lib/openbox/commands/console.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Openbox
+  # :nodoc:
+  module Commands
+    # The Console Command
+    #
+    # @since 0.1.0
+    class Console < Openbox::Command
+      # Run rails console
+      #
+      # @since 0.1.0
+      def execute
+        Openbox.database.ensure_connection!
+        exec('bundle exec rails console')
+      end
+    end
+
+    Openbox::Entrypoint.register(Console, 'console', 'console', 'Run rails console') if Openbox.runtime.has?('rails')
+  end
+end

data/lib/openbox/commands/migrate.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Openbox
+  # :nodoc:
+  module Commands
+    # The Migrate Command
+    #
+    # @since 0.1.0
+    class Migrate < Openbox::Command
+      # Run rails migrate
+      #
+      # @since 0.1.0
+      def execute
+        Openbox.database.ensure_connection!
+        system('bundle exec rails db:migrate')
+      end
+    end
+
+    Openbox::Entrypoint.register(Migrate, 'migrate', 'migrate', 'Run rails migrate') if Openbox.runtime.has?('rails')
+  end
+end

data/lib/openbox/commands/rake.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Openbox
+  # :nodoc:
+  module Commands
+    # The Rake Command
+    #
+    # @since 0.1.0
+    class Rake < Openbox::Command
+      # Run rake task with database connection check
+      #
+      # @since 0.1.0
+      def execute
+        Openbox.database.ensure_connection!
+        exec("bundle exec rake #{args.join(' ')}")
+      end
+    end
+
+    Openbox::Entrypoint.register(Rake, 'rake', 'rake', 'Run rake task') if Openbox.runtime.has?('rails', 'rake')
+  end
+end

data/lib/openbox/commands/seed.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Openbox
+  # :nodoc:
+  module Commands
+    # The Seed Command
+    #
+    # @since 0.1.0
+    class Seed < Openbox::Command
+      # Run rails seed
+      #
+      # @since 0.1.0
+      def execute
+        Openbox.database.ensure_connection!
+        system('bundle exec rails db:seed')
+      end
+    end
+
+    Openbox::Entrypoint.register(Seed, 'seed', 'seed', 'Run rails seed') if Openbox.runtime.has?('rails')
+  end
+end

data/lib/openbox/commands/server.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Openbox
+  # :nodoc:
+  module Commands
+    # The Server Command
+    #
+    # @since 0.1.0
+    class Server < Openbox::Command
+      # Run Application Server
+      #
+      # @since 0.1.0
+      def execute
+        Openbox.database.ensure_connection!
+        invoke Migrate unless ENV['AUTO_MIGRATION'].nil?
+        return exec('bundle exec rails server -b 0.0.0.0') if Openbox.runtime.rails?
+
+        exec('bundle exec rackup -o 0.0.0.0')
+      end
+    end
+
+    if Openbox.runtime.has?('rails', 'rack')
+      Openbox::Entrypoint.register(Server, 'server', 'server', 'Start application server')
+    end
+  end
+end

data/lib/openbox/commands/sidekiq.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Openbox
+  # :nodoc:
+  module Commands
+    # The Sidekiq Command
+    #
+    # @since 0.1.0
+    class Sidekiq < Openbox::Command
+      # Run sidekiq
+      #
+      # @since 0.1.0
+      def execute
+        Openbox.database.ensure_connection!
+        exec('bundle exec sidekiq')
+      end
+    end
+
+    Openbox::Entrypoint.register(Sidekiq, 'sidekiq', 'sidekiq', 'Run rails sidekiq') if Openbox.runtime.has?('sidekiq')
+  end
+end

data/lib/openbox/entrypoint.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'thor'
+require 'openbox/runtime'
+require 'openbox/command'
+
+module Openbox
+  # The Container Entrypoint
+  #
+  # @since 0.1.0
+  class Entrypoint < Thor
+    # :nodoc:
+    def self.exit_on_failure?
+      true
+    end
+
+    require 'openbox/commands/server'
+    require 'openbox/commands/rake'
+    require 'openbox/commands/migrate'
+    require 'openbox/commands/seed'
+    require 'openbox/commands/console'
+    require 'openbox/commands/sidekiq'
+  end
+end

data/lib/openbox/runtime.rb

@@ -7,6 +7,13 @@ module Openbox
   #
   # @since 0.1.0
   class Runtime
+    # @param dependencies [Array<Bundler::Dependency>]
+    #
+    # @since 0.1.0
+    def initialize(dependencies = [])
+      @dependencies = dependencies
+    end
+
     # Check for Rails environment
     #
     # @return [TrueClass|FalseClass]
@@ -22,9 +29,7 @@ module Openbox
     #
     # @since 0.1.0
     def select(*names)
-      Bundler
-        .definition
-        .current_dependencies
+      @dependencies
         .select { |dep| names.include?(dep.name) && (dep.groups & groups).any? }
     end
 

data/lib/openbox/version.rb

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

data/lib/openbox.rb

@@ -3,7 +3,6 @@
 require_relative 'openbox/version'
 require_relative 'openbox/database'
 require_relative 'openbox/runtime'
-require_relative 'openbox/command'
 
 # The tool to build Ruby container easier
 #
@@ -20,7 +19,12 @@ module Openbox
     return @runtime if @runtime
 
     LOCK.synchronize do
-      @runtime ||= Runtime.new
+      dependencies = if defined?(Bundler)
+                       Bundler.definition.current_dependencies
+                     else
+                       []
+                     end
+      @runtime ||= Runtime.new(dependencies)
     end
   end
 
@@ -34,4 +38,6 @@ module Openbox
       @database ||= Database.new
     end
   end
+
+  require_relative 'openbox/entrypoint'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openbox
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.0
 platform: ruby
 authors:
 - 蒼時弦也
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-01 00:00:00.000000000 Z
+date: 2022-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -46,7 +46,14 @@ files:
 - exe/openbox
 - lib/openbox.rb
 - lib/openbox/command.rb
+- lib/openbox/commands/console.rb
+- lib/openbox/commands/migrate.rb
+- lib/openbox/commands/rake.rb
+- lib/openbox/commands/seed.rb
+- lib/openbox/commands/server.rb
+- lib/openbox/commands/sidekiq.rb
 - lib/openbox/database.rb
+- lib/openbox/entrypoint.rb
 - lib/openbox/runtime.rb
 - lib/openbox/version.rb
 - openbox.gemspec