postburner 1.0.0.pre.1 → 1.0.0.pre.3

data/lib/postburner/queue_config.rb

@@ -10,9 +10,9 @@ module Postburner
   # @example Basic usage
   #   class ProcessPayment < Postburner::Job
   #     queue 'critical'
-  #     queue_priority 0
-  #     queue_ttr 300
-  #     queue_max_job_retries 3
+  #     priority 0
+  #     ttr 300
+  #     max_retries 3
   #
   #     def perform(args)
   #       # ...
@@ -32,6 +32,9 @@ module Postburner
 
     class_methods do
       # Sets or returns the queue name.
+      # 
+      # The queue name expands 'postburner.<environment>.<queue_name>' for the
+      # tube name in Beanstalkd.
       #
       # @param name [String, Symbol, nil] Queue name to set, or nil to get current value
       #
@@ -52,21 +55,21 @@ module Postburner
         end
       end
 
-      # Sets or returns the queue priority.
+      # Sets or returns the priority.
       #
-      # Lower numbers = higher priority in Beanstalkd.
+      # Lower numbers = higher priority in Beanstalkd (0 is highest).
       #
       # @param pri [Integer, nil] Priority to set (0-4294967295), or nil to get current value
       #
       # @return [Integer, nil] Current priority when getting, nil when setting
       #
       # @example Set priority
-      #   queue_priority 0  # Highest priority
+      #   priority 0  # Highest priority
       #
       # @example Get priority
-      #   ProcessPayment.queue_priority  # => 0
+      #   ProcessPayment.priority  # => 0
       #
-      def queue_priority(pri = nil)
+      def priority(pri = nil)
         if pri
           self.postburner_priority = pri
           nil
@@ -75,24 +78,24 @@ module Postburner
         end
       end
 
-      # Sets or returns the queue TTR (time-to-run).
+      # Sets or returns the TTR (time-to-run).
       #
       # Number of seconds Beanstalkd will wait for job completion before
       # making it available again.
       #
-      # @param ttr [Integer, nil] Timeout in seconds, or nil to get current value
+      # @param seconds [Integer, nil] Timeout in seconds, or nil to get current value
       #
       # @return [Integer, nil] Current TTR when getting, nil when setting
       #
       # @example Set TTR
-      #   queue_ttr 300  # 5 minutes
+      #   ttr 300  # 5 minutes
       #
       # @example Get TTR
-      #   ProcessPayment.queue_ttr  # => 300
+      #   ProcessPayment.ttr  # => 300
       #
-      def queue_ttr(ttr = nil)
-        if ttr
-          self.postburner_ttr = ttr
+      def ttr(seconds = nil)
+        if seconds
+          self.postburner_ttr = seconds
           nil
         else
           postburner_ttr
@@ -106,12 +109,12 @@ module Postburner
       # @return [Integer, nil] Current max retries when getting, nil when setting
       #
       # @example Set max retries
-      #   queue_max_job_retries 3
+      #   max_retries 3
       #
       # @example Get max retries
-      #   ProcessPayment.queue_max_job_retries  # => 3
+      #   ProcessPayment.max_retries  # => 3
       #
-      def queue_max_job_retries(retries = nil)
+      def max_retries(retries = nil)
         if retries
           self.postburner_max_retries = retries
           nil
@@ -130,15 +133,15 @@ module Postburner
       # @return [Integer, Proc, nil] Current delay when getting, nil when setting
       #
       # @example Set fixed retry delay
-      #   queue_retry_delay 10
+      #   retry_delay 10
       #
       # @example Set exponential backoff with proc
-      #   queue_retry_delay ->(retries) { 2 ** retries }
+      #   retry_delay ->(retries) { 2 ** retries }
       #
       # @example Get retry delay
-      #   ProcessPayment.queue_retry_delay  # => 10 or #<Proc>
+      #   ProcessPayment.retry_delay  # => 10 or #<Proc>
       #
-      def queue_retry_delay(delay = nil)
+      def retry_delay(delay = nil)
         if delay
           self.postburner_retry_delay = delay
           nil

data/lib/postburner/strategies/queue.rb

@@ -80,9 +80,9 @@ module Postburner
             data = { class: job.class.name, args: [job.id] }
 
             # Get priority, TTR from job instance (respects instance overrides) or options
-            pri = options[:pri] || job.queue_priority || Postburner.configuration.default_priority
+            pri = options[:pri] || job.priority || Postburner.configuration.default_priority
             delay = options[:delay] || 0
-            ttr = options[:ttr] || job.queue_ttr || Postburner.configuration.default_ttr
+            ttr = options[:ttr] || job.ttr || Postburner.configuration.default_ttr
 
             response = conn.tubes[tube_name].put(
               JSON.generate(data),

data/lib/postburner/version.rb

@@ -1,3 +1,3 @@
 module Postburner
-  VERSION = '1.0.0.pre.1'
+  VERSION = '1.0.0.pre.3'
 end

data/lib/postburner/workers/worker.rb

@@ -43,63 +43,62 @@ module Postburner
     #
     # **Development:**
     # ```yaml
-    # default_forks: 0
-    # default_threads: 1
+    # forks: 0
+    # threads: 1
     # ```
     # Single-threaded, single-process (simplest debugging)
     #
     # **Staging:**
     # ```yaml
-    # default_forks: 0
-    # default_threads: 10
+    # forks: 0
+    # threads: 10
     # ```
     # Multi-threaded, single-process (moderate concurrency)
     #
     # **Production:**
     # ```yaml
-    # default_forks: 4
-    # default_threads: 10
+    # forks: 4
+    # threads: 10
     # ```
     # 4 processes × 10 threads = 40 concurrent jobs per queue
     #
     # ## Configuration
     #
     # @example Development (single-threaded)
-    #   development:
+    #   development:  # <- environment config, i.e. defaults
     #     default_forks: 0
     #     default_threads: 1
-    #     queues:
-    #       default: {}
-    #       mailers: {}
+    #     workers:  # <- worker config, i.e. overrides
+    #       default:
+    #         queues:
+    #           - default
+    #           - mailers
     #
     # @example Staging (multi-threaded, single process)
-    #   staging:
+    #   staging:  # <- environment config, i.e. defaults
     #     default_forks: 0
     #     default_threads: 10
     #     default_gc_limit: 5000
-    #     queues:
-    #       critical:
-    #         threads: 1      # Single-threaded for critical jobs
+    #     workers:  # <- worker config, i.e. overrides
     #       default:
-    #         threads: 10     # 10 concurrent threads
-    #       mailers:
-    #         threads: 5      # 5 concurrent emails
+    #         queues:
+    #           - critical
+    #           - default
+    #           - mailers
     #
-    # @example Production (Puma-style: forks × threads)
-    #   production:
+    # @example Production (Puma-style: forks × threads with worker overrides)
+    #   production:  # <- environment config, i.e. defaults
     #     default_forks: 2
     #     default_threads: 10
     #     default_gc_limit: 5000
-    #     queues:
-    #       critical:
-    #         forks: 1        # Single fork
-    #         threads: 1      # Single thread = 1 concurrent job
+    #     workers:  # <- worker config, i.e. overrides
     #       default:
-    #         forks: 4        # 4 forks (Puma-style)
-    #         threads: 10     # 10 threads per fork = 40 total concurrent jobs
-    #       mailers:
-    #         forks: 2
-    #         threads: 5      # 2×5 = 10 total email senders
+    #         forks: 4        # Overrides default_forks
+    #         threads: 10     # Overrides default_threads
+    #         queues:
+    #           - critical
+    #           - default
+    #           - mailers
     #
     class Worker < Base
       # Starts the worker.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: postburner
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.1
+  version: 1.0.0.pre.3
 platform: ruby
 authors:
 - Matt Smith
@@ -131,6 +131,7 @@ files:
 - config/routes.rb
 - lib/generators/postburner/install/USAGE
 - lib/generators/postburner/install/install_generator.rb
+- lib/generators/postburner/install/templates/config/postburner.yml
 - lib/generators/postburner/install/templates/migrations/create_postburner_jobs.rb.erb
 - lib/postburner.rb
 - lib/postburner/active_job/adapter.rb