falqon 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ac7a29b42908bf546c1ef179712b24d4c29cdc41f268172ae94efc01f2e28a5
-  data.tar.gz: 89c27514ea3ecd84fd191e20696a251c8a304d5149f4276007dc815181cb7bd8
+  metadata.gz: 6df392504c2ce1ad80e43fa176f12ce54c1f270ec3e2be706b763d6c76a27a72
+  data.tar.gz: 48b241333d45181d7575b0f776604f2d70820c7b473274aaf34a90fcc361afa7
 SHA512:
-  metadata.gz: 94b591a05d679e6df6b1308adcebb2619a30923ce4a5c2168f5dd07d381737b59ee6ed8ff4883d8913ab8d07c1a516ec32021cedf068c023f127d81394685c9e
-  data.tar.gz: a83d8fc3f97b8bbbc7c399fd3e7674986470d3fe07fe6384d2605a5510378a1bdddf93f0ac2ad7622ecb1db4018916bd05a91e3e96e362ebc1a93fa1395c67e1
+  metadata.gz: 02ba22201c385d00fe57f848c748900f0feb0aa1b04b50386cbef4e9fefe825e69035d618a8a94630cde7f203daea3b1ddc5173b65d9d53a3b708270e3adb3b2
+  data.tar.gz: 0b8e7cf96eac72efdc96b4a0911ea7da0a2cfc1669bec8169c9925b4a41ed1000cbf68c910c57d01bbfecf2fb326c27717bb0d0f4941eedf7923402e07499767

data/CHANGELOG.md

@@ -13,6 +13,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed
 
+## Falqon v1.2.0 (2025-05-18)
+
+### Changed
+
+- Falqon CLI: automatically detect and require Falqon Pro
+
 ## Falqon v1.1.0 (2025-05-18)
 
 ### Changed
@@ -35,7 +41,8 @@ Initial release
 
 ## Falqon v0.0.1 (2023-06-22)
 
-[unreleased]: https://github.com/floriandejonckheere/falqon/compare/v1.1.0...HEAD
-[1.1.0]: https://github.com/floriandejonckheere/falqon-pro/releases/tag/v1.1.0
-[1.0.0]: https://github.com/floriandejonckheere/falqon-pro/releases/tag/v1.0.0
-[0.1.0]: https://github.com/floriandejonckheere/falqon-pro/releases/tag/v0.1.0
+[unreleased]: https://github.com/floriandejonckheere/falqon/compare/v1.2.0...HEAD
+[1.2.0]: https://github.com/floriandejonckheere/falqon/releases/tag/v1.2.0
+[1.1.0]: https://github.com/floriandejonckheere/falqon/releases/tag/v1.1.0
+[1.0.0]: https://github.com/floriandejonckheere/falqon/releases/tag/v1.0.0
+[0.1.0]: https://github.com/floriandejonckheere/falqon/releases/tag/v0.1.0

data/lib/falqon/cli.rb

@@ -29,140 +29,15 @@ module Falqon
       true
     end
 
-    desc "version", "Display version"
-    # @!visibility private
-    def version
-      Version
-        .new(options)
-        .call
-    end
-
-    desc "list", "Display all active (registered) queues"
-    # @!visibility private
-    def list
-      List
-        .new(options)
-        .call
-    end
-
-    desc "status", "Display queue status"
-    option :queue, aliases: "-q", type: :string, desc: "Queue name"
-    # @!visibility private
-    def status
-      Status
-        .new(options)
-        .call
-    end
-
-    desc "stats", "Display queue statistics"
-    option :queue, aliases: "-q", type: :string, desc: "Queue name"
-    # @!visibility private
-    def stats
-      Stats
-        .new(options)
-        .call
-    end
-
-    desc "show", "Display messages in a queue"
-    option :queue, aliases: "-q", type: :string, desc: "Queue name", required: true
-
-    option :pending, type: :boolean, desc: "Display pending messages (default)"
-    option :processing, type: :boolean, desc: "Display processing messages"
-    option :dead, type: :boolean, desc: "Display dead messages"
-
-    option :data, aliases: "-d", type: :boolean, desc: "Display raw data"
-    option :meta, aliases: "-m", type: :boolean, desc: "Display additional metadata"
-
-    option :head, type: :numeric, desc: "Display N messages from head of queue"
-    option :tail, type: :numeric, desc: "Display N messages from tail of queue"
-    option :index, type: :numeric, desc: "Display message at index N", repeatable: true
-    option :range, type: :array, desc: "Display messages at index N to M", banner: "N M"
-
-    option :id, type: :numeric, desc: "Display message with ID N", repeatable: true
-    # @!visibility private
-    def show
-      Show
-        .new(options)
-        .call
-    end
-
-    desc "delete", "Delete messages from a queue"
-    option :queue, aliases: "-q", type: :string, desc: "Queue name", required: true
-
-    option :pending, type: :boolean, desc: "Delete only pending messages (default)"
-    option :processing, type: :boolean, desc: "Delete only processing messages"
-    option :dead, type: :boolean, desc: "Delete only dead messages"
+    include Falqon::Commands
 
-    option :head, type: :numeric, desc: "Delete N messages from head of queue"
-    option :tail, type: :numeric, desc: "Delete N messages from tail of queue"
-    option :index, type: :numeric, desc: "Delete message at index N", repeatable: true
-    option :range, type: :array, desc: "Delete messages at index N to M", banner: "N M"
+    begin
+      require "falqon/pro"
+      require "falqon/pro/commands"
 
-    option :id, type: :numeric, desc: "Delete message with ID N", repeatable: true
-    # @!visibility private
-    def delete
-      Delete
-        .new(options)
-        .call
-    end
-
-    desc "kill", "Kill messages in a queue"
-    option :queue, aliases: "-q", type: :string, desc: "Queue name", required: true
-
-    option :pending, type: :boolean, desc: "Kill only pending messages (default)"
-    option :processing, type: :boolean, desc: "Kill only processing messages"
-
-    option :head, type: :numeric, desc: "Kill N messages from head of queue"
-    option :tail, type: :numeric, desc: "Kill N messages from tail of queue"
-    option :index, type: :numeric, desc: "Kill message at index N", repeatable: true
-    option :range, type: :array, desc: "Kill messages at index N to M", banner: "N M"
-
-    option :id, type: :numeric, desc: "Kill message with ID N", repeatable: true
-    # @!visibility private
-    def kill
-      Kill
-        .new(options)
-        .call
-    end
-
-    desc "clear", "Clear messages from a queue"
-    option :queue, aliases: "-q", type: :string, desc: "Queue name", required: true
-
-    option :pending, type: :boolean, desc: "Clear only pending messages"
-    option :processing, type: :boolean, desc: "Clear only processing messages"
-    option :dead, type: :boolean, desc: "Clear only dead messages"
-    # @!visibility private
-    def clear
-      Clear
-        .new(options)
-        .call
-    end
-
-    desc "refill", "Refill queue (move processing messages to pending)"
-    option :queue, aliases: "-q", type: :string, desc: "Queue name", required: true
-    # @!visibility private
-    def refill
-      Refill
-        .new(options)
-        .call
-    end
-
-    desc "revive", "Revive queue (move dead messages to pending)"
-    option :queue, aliases: "-q", type: :string, desc: "Queue name", required: true
-    # @!visibility private
-    def revive
-      Revive
-        .new(options)
-        .call
-    end
-
-    desc "schedule", "Schedule failed messages for a retry"
-    option :queue, aliases: "-q", type: :string, desc: "Queue name", required: true
-    # @!visibility private
-    def schedule
-      Schedule
-        .new(options)
-        .call
+      include Falqon::Pro::Commands
+    rescue LoadError
+      nil
     end
   end
 end

data/lib/falqon/{cli → commands}/base.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Falqon
-  class CLI
+  module Commands
     # @!visibility private
     class Base
       attr_reader :options

data/lib/falqon/{cli → commands}/clear.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Falqon
-  class CLI
+  module Commands
     # Clear messages from a queue
     #
     # Clearing a subqueue removes all messages and their data from the subqueue.

data/lib/falqon/{cli → commands}/delete.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Falqon
-  class CLI
+  module Commands
     # Delete messages from a queue
     #
     # Deleting a message removes it including its data from the queue.

data/lib/falqon/{cli → commands}/kill.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Falqon
-  class CLI
+  module Commands
     # Kill messages in a queue
     #
     # Killing a message removes it from the pending or scheduled queue, and moves it to the dead queue.

data/lib/falqon/{cli → commands}/list.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Falqon
-  class CLI
+  module Commands
     # Display all active (registered) queues
     #
     # Usage:

data/lib/falqon/{cli → commands}/refill.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Falqon
-  class CLI
+  module Commands
     # Refill queue (move processing messages to pending)
     #
     # This command moves all messages from the processing queue back to the pending queue (in order).

data/lib/falqon/{cli → commands}/revive.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Falqon
-  class CLI
+  module Commands
     # Revive queue (move dead messages to pending)
     #
     # This command moves all messages from the dead queue back to the pending queue (in order).

data/lib/falqon/{cli → commands}/schedule.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Falqon
-  class CLI
+  module Commands
     # Schedule failed messages for a retry
     #
     # This command moves all eligible messages from the scheduled queue back to the head of the pending queue (in order).
@@ -16,7 +16,7 @@ module Falqon
     # @example Schedule eligible failed messages for retry
     #   $ falqon schedule --queue jobs
     #   Scheduled 3 messages for a retry in queue jobs
-    class Schedule < Falqon::CLI::Base
+    class Schedule < Falqon::Commands::Base
       # @!visibility private
       def validate
         raise "No queue registered with this name: #{options[:queue]}" if options[:queue] && !Falqon::Queue.all.map(&:name).include?(options[:queue])

data/lib/falqon/{cli → commands}/show.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Falqon
-  class CLI
+  module Commands
     # Display messages in a queue
     #
     # Usage:

data/lib/falqon/{cli → commands}/stats.rb

@@ -3,7 +3,7 @@
 require "date"
 
 module Falqon
-  class CLI
+  module Commands
     # Display queue statistics
     #
     # Usage:

data/lib/falqon/{cli → commands}/status.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Falqon
-  class CLI
+  module Commands
     # Display queue status
     #
     # Usage:

data/lib/falqon/{cli → commands}/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Falqon
-  class CLI
+  module Commands
     # @!visibility private
     class Version < Base
       def validate; end

data/lib/falqon/commands.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+# typed: true
+
+module Falqon
+  ##
+  # Falqon commands
+  #
+  module Commands
+    extend T::Sig
+
+    sig { returns(T.untyped) }
+    def options # rubocop:disable Lint/UselessMethodDefinition
+      super
+    end
+
+    # @!visibility private
+    sig { params(base: T.class_of(Thor)).void }
+    def self.included(base)
+      base.class_eval do
+        desc "version", "Display version"
+        # @!visibility private
+        def version
+          Version
+            .new(options)
+            .call
+        end
+
+        desc "list", "Display all active (registered) queues"
+        # @!visibility private
+        def list
+          List
+            .new(options)
+            .call
+        end
+
+        desc "status", "Display queue status"
+        option :queue, aliases: "-q", type: :string, desc: "Queue name"
+        # @!visibility private
+        def status
+          Status
+            .new(options)
+            .call
+        end
+
+        desc "stats", "Display queue statistics"
+        option :queue, aliases: "-q", type: :string, desc: "Queue name"
+        # @!visibility private
+        def stats
+          Stats
+            .new(options)
+            .call
+        end
+
+        desc "show", "Display messages in a queue"
+        option :queue, aliases: "-q", type: :string, desc: "Queue name", required: true
+
+        option :pending, type: :boolean, desc: "Display pending messages (default)"
+        option :processing, type: :boolean, desc: "Display processing messages"
+        option :dead, type: :boolean, desc: "Display dead messages"
+
+        option :data, aliases: "-d", type: :boolean, desc: "Display raw data"
+        option :meta, aliases: "-m", type: :boolean, desc: "Display additional metadata"
+
+        option :head, type: :numeric, desc: "Display N messages from head of queue"
+        option :tail, type: :numeric, desc: "Display N messages from tail of queue"
+        option :index, type: :numeric, desc: "Display message at index N", repeatable: true
+        option :range, type: :array, desc: "Display messages at index N to M", banner: "N M"
+
+        option :id, type: :numeric, desc: "Display message with ID N", repeatable: true
+        # @!visibility private
+        def show
+          Show
+            .new(options)
+            .call
+        end
+
+        desc "delete", "Delete messages from a queue"
+        option :queue, aliases: "-q", type: :string, desc: "Queue name", required: true
+
+        option :pending, type: :boolean, desc: "Delete only pending messages (default)"
+        option :processing, type: :boolean, desc: "Delete only processing messages"
+        option :dead, type: :boolean, desc: "Delete only dead messages"
+
+        option :head, type: :numeric, desc: "Delete N messages from head of queue"
+        option :tail, type: :numeric, desc: "Delete N messages from tail of queue"
+        option :index, type: :numeric, desc: "Delete message at index N", repeatable: true
+        option :range, type: :array, desc: "Delete messages at index N to M", banner: "N M"
+
+        option :id, type: :numeric, desc: "Delete message with ID N", repeatable: true
+        # @!visibility private
+        def delete
+          Delete
+            .new(options)
+            .call
+        end
+
+        desc "kill", "Kill messages in a queue"
+        option :queue, aliases: "-q", type: :string, desc: "Queue name", required: true
+
+        option :pending, type: :boolean, desc: "Kill only pending messages (default)"
+        option :processing, type: :boolean, desc: "Kill only processing messages"
+
+        option :head, type: :numeric, desc: "Kill N messages from head of queue"
+        option :tail, type: :numeric, desc: "Kill N messages from tail of queue"
+        option :index, type: :numeric, desc: "Kill message at index N", repeatable: true
+        option :range, type: :array, desc: "Kill messages at index N to M", banner: "N M"
+
+        option :id, type: :numeric, desc: "Kill message with ID N", repeatable: true
+        # @!visibility private
+        def kill
+          Kill
+            .new(options)
+            .call
+        end
+
+        desc "clear", "Clear messages from a queue"
+        option :queue, aliases: "-q", type: :string, desc: "Queue name", required: true
+
+        option :pending, type: :boolean, desc: "Clear only pending messages"
+        option :processing, type: :boolean, desc: "Clear only processing messages"
+        option :dead, type: :boolean, desc: "Clear only dead messages"
+        # @!visibility private
+        def clear
+          Clear
+            .new(options)
+            .call
+        end
+
+        desc "refill", "Refill queue (move processing messages to pending)"
+        option :queue, aliases: "-q", type: :string, desc: "Queue name", required: true
+        # @!visibility private
+        def refill
+          Refill
+            .new(options)
+            .call
+        end
+
+        desc "revive", "Revive queue (move dead messages to pending)"
+        option :queue, aliases: "-q", type: :string, desc: "Queue name", required: true
+        # @!visibility private
+        def revive
+          Revive
+            .new(options)
+            .call
+        end
+
+        desc "schedule", "Schedule failed messages for a retry"
+        option :queue, aliases: "-q", type: :string, desc: "Queue name", required: true
+        # @!visibility private
+        def schedule
+          Schedule
+            .new(options)
+            .call
+        end
+      end
+    end
+  end
+end

data/lib/falqon/version.rb

@@ -4,7 +4,7 @@ module Falqon
   # @!visibility private
   module Version
     MAJOR = 1
-    MINOR = 1
+    MINOR = 2
     PATCH = 0
     PRE   = nil
 

data/lib/falqon.rb

@@ -3,6 +3,7 @@
 # typed: true
 
 require "forwardable"
+require "pathname"
 
 require "sorbet-runtime"
 require "zeitwerk"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: falqon
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Florian Dejonckheere
@@ -96,18 +96,19 @@ files:
 - config/inflections.rb
 - lib/falqon.rb
 - lib/falqon/cli.rb
-- lib/falqon/cli/base.rb
-- lib/falqon/cli/clear.rb
-- lib/falqon/cli/delete.rb
-- lib/falqon/cli/kill.rb
-- lib/falqon/cli/list.rb
-- lib/falqon/cli/refill.rb
-- lib/falqon/cli/revive.rb
-- lib/falqon/cli/schedule.rb
-- lib/falqon/cli/show.rb
-- lib/falqon/cli/stats.rb
-- lib/falqon/cli/status.rb
-- lib/falqon/cli/version.rb
+- lib/falqon/commands.rb
+- lib/falqon/commands/base.rb
+- lib/falqon/commands/clear.rb
+- lib/falqon/commands/delete.rb
+- lib/falqon/commands/kill.rb
+- lib/falqon/commands/list.rb
+- lib/falqon/commands/refill.rb
+- lib/falqon/commands/revive.rb
+- lib/falqon/commands/schedule.rb
+- lib/falqon/commands/show.rb
+- lib/falqon/commands/stats.rb
+- lib/falqon/commands/status.rb
+- lib/falqon/commands/version.rb
 - lib/falqon/concerns/hooks.rb
 - lib/falqon/configuration.rb
 - lib/falqon/connection_pool_snooper.rb
@@ -126,7 +127,7 @@ files:
 - lib/generators/falqon/install.rb
 homepage: https://github.com/floriandejonckheere/falqon
 licenses:
-- LGPL-3.0
+- LGPL-3.0-or-later
 metadata:
   source_code_uri: https://github.com/floriandejonckheere/falqon.git
   rubygems_mfa_required: 'true'