twenty-cli 0.5.3 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55e0c27d4ec4e32738e794d6cd61a7c79f0e26b39792adc16f38c341e8094be6
-  data.tar.gz: eb7577a4aa235ec089fcabc38c61b705579ecf64a85ce6134c3f79f3e23615fd
+  metadata.gz: 2788338657a1baa50cd9df1dbf6f0ee6cec4670c70e888d0ecf483c2dee42aec
+  data.tar.gz: b1cc4f163fc1a2be7aeb924ab9bbfba5f4769d4d848fe78265b288fb77e14dc3
 SHA512:
-  metadata.gz: ea2ccc70e801478bc6e0bda852ee0f983e3f2206ef46350a2503901d579b40258ef641d8644b5e73330146ddd03b8a60318d6abbbcc2afea00571df38d73e552
-  data.tar.gz: 5d2396f29cbe709b994991bb5217e88b788530cc22d9fea9a1560b771d6536dfff35d02d486815c1f1cfca262df38cdd8f3bb03e46c8ed3f10886fd26b922587
+  metadata.gz: d3db4deea8e6f421c1189d328298f1acf38f2058f33fff6d11b3413c898a674159130252e5131992268871e4a217de19b051e516c76ddc128d27688865a92403
+  data.tar.gz: 2cdd2d036d9d1abb8680abe9b97a904a6608f650093579897f7b00dc3b3dd874971eae85ede66d308371a0d46c1f5362a0f7cb543dc5d997ff092f48c25ba0ca

data/lib/twenty/cli/command/connect.rb

@@ -5,9 +5,13 @@ class Twenty::Command::Connect < Twenty::Command
              description: "Connect a project to twenty"
   set_option "-p PATH", "--path PATH", "The path to a project", default: nil
 
-  prepend Twenty::Command::MigrationMixin
-  prepend Twenty::Command::SQLiteMixin
-  prepend Twenty::Command::RescueMixin
+  ##
+  # Hooks
+  # Run order:
+  # Rescue -> SQLiteConn -> RequireMigration -> command
+  prepend Hook::RequireMigration
+  prepend Hook::SQLiteConn
+  prepend Hook::Rescue
 
   def run
     options = parse_options(argv)
@@ -17,6 +21,7 @@ class Twenty::Command::Connect < Twenty::Command
   private
 
   def run_command(options)
+    require "twenty/server/model"
     path = File.realpath(options.path ? options.path : Dir.getwd)
     if File.exist?(path)
       project = Twenty::Project.create(

data/lib/twenty/cli/command/console.rb

@@ -3,10 +3,18 @@
 class Twenty::Command::Console < Twenty::Command
   set_banner usage: "twenty console [OPTIONS]",
              description: "Start the twenty developer console"
-  include CommonOptionMixin
-  prepend Twenty::Command::MigrationMixin
-  prepend Twenty::Command::SQLiteMixin
-  prepend Twenty::Command::RescueMixin
+
+  ##
+  # Option(s)
+  include Option::Database
+
+  ##
+  # Hooks
+  # Run order:
+  # Rescue -> SQLiteConn -> RequireMigration -> command
+  prepend Hook::RequireMigration
+  prepend Hook::SQLiteConn
+  prepend Hook::Rescue
 
   def run
     options = parse_options(argv)
@@ -16,6 +24,7 @@ class Twenty::Command::Console < Twenty::Command
   private
 
   def run_command(options)
+    require "twenty/server/model"
     require "irb"
     TOPLEVEL_BINDING.irb
   end

data/lib/twenty/cli/command/disconnect.rb

@@ -4,9 +4,12 @@ class Twenty::Command::Disconnect < Twenty::Command
   set_banner usage: "twenty disconnect [OPTIONS]",
              description: "Disconnect a project from twenty"
   set_option "-p PATH", "--path PATH", "The path to a project", default: nil
-  prepend Twenty::Command::MigrationMixin
-  prepend Twenty::Command::SQLiteMixin
-  prepend Twenty::Command::RescueMixin
+
+  ##
+  # Hooks
+  prepend Hook::RequireMigration
+  prepend Hook::SQLiteConn
+  prepend Hook::Rescue
 
   def run
     options = parse_options(argv)
@@ -16,6 +19,7 @@ class Twenty::Command::Disconnect < Twenty::Command
   private
 
   def run_command(options)
+    require "twenty/server/model"
     path = File.realpath(options.path ? options.path : Dir.getwd)
     Twenty::Project
       .where(path:)

data/lib/twenty/cli/command/down.rb

@@ -3,9 +3,13 @@
 class Twenty::Command::Down < Twenty::Command
   set_banner usage: "twenty down [OPTIONS]",
              description: "Stop the twenty web server"
-  include Twenty::Path
-  prepend Twenty::Command::SQLiteMixin
-  prepend Twenty::Command::RescueMixin
+
+  ##
+  # Hooks
+  # Run order:
+  # Rescue -> SQLiteConn -> command
+  prepend Hook::SQLiteConn
+  prepend Hook::Rescue
 
   def run
     options = parse_options(argv)
@@ -15,19 +19,18 @@ class Twenty::Command::Down < Twenty::Command
   private
 
   def run_command(options)
-    if File.readable?(pidfile)
-      Process.kill("SIGINT", Integer(pid))
+    if File.readable?(pid)
+      pid = Integer(File.binread(pid).gsub(/[^\d]/, ""))
+      Process.kill("SIGINT", pid)
     else
-      warn "PID file is not readable."
+      warn "[x] #{pid} is not readable"
     end
   rescue Errno::ESRCH
-    warn "No such process."
-    FileUtils.rm(pidfile)
+    warn "[x] Process not found"
+    rm(pid)
   end
 
   def pid
-    @pid ||= File
-               .binread(pidfile)
-               .gsub(/[^\d]/, "")
+    Twenty.pid
   end
 end

data/lib/twenty/cli/command/hook/require_migration.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Twenty::Command::Hook
+  module RequireMigration
+    def run_command(...)
+      if pending_migrations?
+        warn "There are pending migrations.\n" \
+             "Run \"twenty migrate\" first.\n"
+        exit(1)
+      else
+        super(...)
+      end
+    end
+
+    private
+
+    def pending_migrations?
+      Twenty::Migration.pending_migrations?
+    end
+  end
+end

data/lib/twenty/cli/command/{mixin/rescue_mixin.rb → hook/rescue.rb}

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
-class Twenty::Command
-  module RescueMixin
+module Twenty::Command::Hook
+  module Rescue
+    FRAME_MAX = 15
+
     def run(...)
       super(...)
     rescue => ex
@@ -18,7 +20,7 @@ class Twenty::Command
     private
 
     def format_backtrace(backtrace)
-      backtrace.last(5).map do
+      backtrace.last(FRAME_MAX).map do
         "  #{_1.gsub(Dir.getwd, "")}"
       end.join("\n")
     end

data/lib/twenty/cli/command/hook/sqlite_conn.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Twenty::Command::Hook
+  module SQLiteConn
+    def run_command(options)
+      path = options.database || Twenty.default_database
+      Twenty.establish_connection(path:)
+      super(options)
+    end
+  end
+end

data/lib/twenty/cli/command/hook.rb

@@ -0,0 +1,5 @@
+module Twenty::Command::Hook
+  require_relative "hook/require_migration"
+  require_relative "hook/sqlite_conn"
+  require_relative "hook/rescue"
+end

data/lib/twenty/cli/command/migrate.rb

@@ -3,9 +3,18 @@
 class Twenty::Command::Migrate < Twenty::Command
   set_banner usage: "twenty migrate [OPTIONS]",
              description: "Migrate the database"
-  include CommonOptionMixin
-  prepend Twenty::Command::SQLiteMixin
-  prepend Twenty::Command::RescueMixin
+  set_option "-t TARGET", "--target TARGET", "The target version", default: nil
+
+  ##
+  # Options
+  include Option::Database
+
+  ##
+  # Hooks
+  # Run order:
+  # Rescue -> SQLiteConn -> command.
+  prepend Hook::SQLiteConn
+  prepend Hook::Rescue
 
   def run
     options = parse_options(argv)
@@ -15,6 +24,6 @@ class Twenty::Command::Migrate < Twenty::Command
   private
 
   def run_command(options)
-    Twenty::Migration.run!
+    Twenty::Migration.run!(target: options.target)
   end
 end

data/lib/twenty/cli/command/mixin/common_option_mixin.rb

@@ -6,7 +6,7 @@ class Twenty::Command
       mod.module_eval do
         set_option "-d PATH",
                    "--database PATH",
-                   "The path to an alternate SQLite3 database",
+                   "The path to an alternate SQLite database",
                    as: String,
                    default: nil
       end

data/lib/twenty/cli/command/option/database.rb

@@ -0,0 +1,13 @@
+module Twenty::Command::Option
+  module Database
+    def self.included(mod)
+      mod.module_eval do
+        set_option "-d PATH",
+                   "--database PATH",
+                   "The path to an alternate SQLite database",
+                   as: String,
+                   default: nil
+      end
+    end
+  end
+end

data/lib/twenty/cli/command/option.rb

@@ -0,0 +1,3 @@
+module Twenty::Command::Option
+  require_relative "option/database"
+end

data/lib/twenty/cli/command/up.rb

@@ -16,11 +16,17 @@ class Twenty::Command::Up < Twenty::Command
              "--unix PATH",
              "Listen on a UNIX socket"
 
-  include CommonOptionMixin
-  include Twenty::Path
-  prepend Twenty::Command::MigrationMixin
-  prepend Twenty::Command::SQLiteMixin
-  prepend Twenty::Command::RescueMixin
+  ##
+  # Option(s)
+  include Option::Database
+
+  ##
+  # Hooks
+  # Run order:
+  # Rescue -> SQLiteConn -> RequireMigration -> command
+  prepend Hook::RequireMigration
+  prepend Hook::SQLiteConn
+  prepend Hook::Rescue
 
   def run
     options = parse_options(argv)
@@ -30,12 +36,17 @@ class Twenty::Command::Up < Twenty::Command
   private
 
   def run_command(options)
-    File.binwrite(pidfile, Process.pid.to_s)
+    require "twenty/server/model"
+    File.binwrite(pid, Process.pid.to_s)
     thr = Twenty::Rack.server(options).start
     thr.join
   rescue Interrupt
     thr.kill
   ensure
-    FileUtils.rm(pidfile)
+    FileUtils.rm(pid)
+  end
+
+  def pid
+    Twenty.pid
   end
 end

data/lib/twenty/cli/command.rb

@@ -4,14 +4,12 @@ require "cmd"
 
 class Twenty::Command < Cmd
   ##
-  # mixins
-  require_relative "command/mixin/common_option_mixin"
-  require_relative "command/mixin/migration_mixin"
-  require_relative "command/mixin/sqlite_mixin"
-  require_relative "command/mixin/rescue_mixin"
+  # Hooks
+  require_relative "command/option"
+  require_relative "command/hook"
 
   ##
-  # commands
+  # Commands
   require_relative "command/up"
   require_relative "command/down"
   require_relative "command/connect"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twenty-cli
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.5
 platform: ruby
 authors:
 - '0x1eef'
@@ -94,7 +94,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.35'
-description: Command-line interface
+description: Provides the CLI component of twenty. See https://rubygems.org/gems/twenty
+  for context.
 email:
 - 0x1eef@protonmail.com
 executables:
@@ -109,11 +110,14 @@ files:
 - "./lib/twenty/cli/command/console.rb"
 - "./lib/twenty/cli/command/disconnect.rb"
 - "./lib/twenty/cli/command/down.rb"
+- "./lib/twenty/cli/command/hook.rb"
+- "./lib/twenty/cli/command/hook/require_migration.rb"
+- "./lib/twenty/cli/command/hook/rescue.rb"
+- "./lib/twenty/cli/command/hook/sqlite_conn.rb"
 - "./lib/twenty/cli/command/migrate.rb"
 - "./lib/twenty/cli/command/mixin/common_option_mixin.rb"
-- "./lib/twenty/cli/command/mixin/migration_mixin.rb"
-- "./lib/twenty/cli/command/mixin/rescue_mixin.rb"
-- "./lib/twenty/cli/command/mixin/sqlite_mixin.rb"
+- "./lib/twenty/cli/command/option.rb"
+- "./lib/twenty/cli/command/option/database.rb"
 - "./lib/twenty/cli/command/up.rb"
 - "./lib/twenty/cli/libexec.rb"
 - "./libexec/twenty/connect"
@@ -145,5 +149,5 @@ requirements: []
 rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
-summary: Command-line interface
+summary: Provides the CLI component of twenty
 test_files: []

data/lib/twenty/cli/command/mixin/migration_mixin.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Twenty::Command::MigrationMixin
-  def run_command(...)
-    if pending_migrations?
-      warn "There are pending migrations.\n" \
-           "Run \"twenty migrate\" first.\n"
-      exit(1)
-    else
-      super(...)
-    end
-  end
-
-  private
-
-  def pending_migrations?
-    Twenty::Migration.pending_migrations?
-  end
-end

data/lib/twenty/cli/command/mixin/sqlite_mixin.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module Twenty::Command::SQLiteMixin
-  def run_command(options)
-    path = options.database || Twenty.default_database
-    Twenty.establish_connection(path:)
-    require "twenty/server/migration"
-    require "twenty/server/model"
-    super(options)
-  end
-end