passive_queue 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8b4f0e4d9843f7d1bd519582dfeeba0ba98282380a557f9aaf9508ee3fc6418
-  data.tar.gz: b52061271a1d520d154e4eb952e20ec430d6a571ade3fcf6830cff270e4b5c84
+  metadata.gz: 14f8ed63b9c73cb9e5d8aaabb2ca9062bd28335c92b46cae2e676102fe23d2e9
+  data.tar.gz: 576d48dfdb6eef8d0725d5d1a48af30d971415386443c717e42feac607dd32f9
 SHA512:
-  metadata.gz: d51d7f54fcfdea3f7def1cab47104215f8188e5f226d820a72bc76e42827b2c4e63b815352acc627a6d87cbcd53123c9b2e886750b9a94fbd312c2cf43542cd2
-  data.tar.gz: 679e47135dde14ca024f90a8a820028cf1f4fca4e2b47b7f0a20bac9ab5755e6daf7b8a5dbecb0207907d139cef2536b6d5e09cf359d277a430acfe7435ad5df
+  metadata.gz: c54ef9ca173d1e7ce2d5834669d07b3deed860d476f216066c1aaf0c49308ccbab6ee3d8fe593aa79e51adde5f1bf7541fe75cc1bfa51072570202542eb43b6c
+  data.tar.gz: 3be8fe8ce3cb36f1402456ac643139e9cb59dffe403b44c38b439b85d603f322bc267dc3d4377e20e4def4644947c2c2c63b57bf35211de36a1d3c0476656432

data/.ruby-version

@@ -0,0 +1 @@
+3.4.5

data/.yard-lint.yml

@@ -0,0 +1,94 @@
+# YARD-Lint Configuration
+# Strict settings: all validators set to error severity and 100% coverage requirement
+
+AllValidators:
+  # Fail on any error severity violation
+  FailOnSeverity: error
+
+  # Require 100% documentation coverage
+  MinCoverage: 100.0
+
+  # Include private and protected methods in validation
+  YardOptions:
+    - --private
+    - --protected
+
+# Documentation Validators - All set to ERROR
+Documentation/UndocumentedObjects:
+  Enabled: true
+  Severity: error
+  Description: All classes, modules, and methods must be documented
+
+Documentation/UndocumentedMethodArguments:
+  Enabled: true
+  Severity: error
+  Description: All method parameters must have @param documentation
+
+Documentation/UndocumentedReturnValue:
+  Enabled: true
+  Severity: error
+  Description: All methods with return values must have @return documentation
+
+Documentation/MinimumDescriptionLength:
+  Enabled: true
+  Severity: error
+  MinLength: 10
+  Description: Documentation must be meaningful (minimum 10 characters)
+
+Documentation/MarkdownSyntax:
+  Enabled: true
+  Severity: error
+  Description: All markdown in documentation must be valid
+
+# Tag Validators - All set to ERROR
+Tags/InvalidTypes:
+  Enabled: true
+  Severity: error
+  Description: Type specifications must use valid YARD syntax
+
+Tags/Order:
+  Enabled: true
+  Severity: error
+  Description: Tags must follow consistent ordering
+
+Tags/CollectionType:
+  Enabled: true
+  Severity: error
+  Description: Collections must use YARD standard syntax (e.g., Hash{K => V}, Array<Type>)
+
+Tags/ExampleSyntax:
+  Enabled: true
+  Severity: error
+  Description: Code in @example tags must be valid Ruby syntax
+
+Tags/MissingTypeInformation:
+  Enabled: true
+  Severity: error
+  Description: Tags requiring types must have type information
+
+Tags/DuplicateTags:
+  Enabled: true
+  Severity: error
+  Description: No duplicate tags allowed (except @param, @option, @raise)
+
+# Code Quality Validators - All set to ERROR
+Quality/EmptyDescription:
+  Enabled: true
+  Severity: error
+  Description: Descriptions cannot be empty or whitespace-only
+
+Quality/InconsistentIndentation:
+  Enabled: true
+  Severity: error
+  Description: Documentation must have consistent indentation
+
+Quality/TrailingWhitespace:
+  Enabled: true
+  Severity: error
+  Description: No trailing whitespace in documentation
+
+# Naming Validators - All set to ERROR
+Naming/InconsistentParameterNames:
+  Enabled: true
+  Severity: error
+  Description: Parameter names in @param tags must match method signature

data/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 All notable changes to this project will be documented in this file. Since this is Passive Queue, "changes" might be a strong word.
 
+## [1.1.0] - 2025-11-13
+
+### Changed
+- Dropped Ruby 3.1 and 3.2 support - now requires Ruby >= 3.3.0
+- Embracing modern Ruby while maintaining the art of doing nothing
+
+### Added
+- GitHub Actions CI workflow with yard-lint validation
+- Trusted publishing workflow for automated gem releases
+- Continuous integration for documentation quality
+
+## [1.0.1] - Unreleased
+
+### Fixed
+- Potential technical overhead by adding RSpec to the gem?
+
 ## [1.0.0] - 2025-07-12
 
 ### Added

data/Gemfile

@@ -2,5 +2,5 @@ source "https://rubygems.org"
 
 gemspec
 
-gem "rake", "~> 13.0"
-gem "rspec", "~> 3.0"
+gem "rake"
+gem "yard-lint"

data/Gemfile.lock

@@ -1,26 +1,17 @@
 PATH
   remote: .
   specs:
-    passive_queue (1.0.0)
+    passive_queue (1.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.6.2)
-    rake (13.3.0)
-    rspec (3.13.1)
-      rspec-core (~> 3.13.0)
-      rspec-expectations (~> 3.13.0)
-      rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.5)
-      rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.5)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.5)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-support (3.13.4)
+    rake (13.3.1)
+    yard (0.9.37)
+    yard-lint (1.2.2)
+      yard (~> 0.9)
+      zeitwerk (~> 2.6)
+    zeitwerk (2.7.3)
 
 PLATFORMS
   ruby
@@ -28,8 +19,8 @@ PLATFORMS
 
 DEPENDENCIES
   passive_queue!
-  rake (~> 13.0)
-  rspec (~> 3.0)
+  rake
+  yard-lint
 
 BUNDLED WITH
    2.6.9

data/README.md

@@ -428,7 +428,7 @@ Passive Queue is built on the fundamental principle that the most reliable code
 - **Complete Compatibility**: Works with any existing job without modification
 - **Inner Peace**: Developers can rest easy knowing nothing will break
 
-## FAQ ❓
+## FAQ
 
 **Q: Will my jobs actually run?**
 A: No, and that's the point! Your jobs achieve perfect success by never executing.

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'bundler/gem_tasks'

data/lib/passive_queue/adapter.rb

@@ -1,27 +1,50 @@
 module PassiveQueue
+  # ActiveJob queue adapter that accepts jobs but never processes them.
+  # Implements the ActiveJob adapter interface with zen-like non-execution.
   class Adapter
+    # Initializes a new Adapter instance with the zen of doing nothing
     def initialize
       # Initialize with the zen of doing nothing
     end
 
+    # Enqueues a job for immediate non-execution
+    #
+    # @param job [ActiveJob::Base] the job to passively accept
+    # @return [void]
     def enqueue(job)
       log_job_acceptance(job)
     end
 
+    # Enqueues a job for delayed non-execution at a specific time
+    #
+    # @param job [ActiveJob::Base] the job to schedule for non-execution
+    # @param timestamp [Numeric] Unix timestamp when the job should not be executed
+    # @return [void]
     def enqueue_at(job, timestamp)
       log_job_scheduling(job, timestamp)
     end
 
+    # Enqueues multiple jobs for batch non-execution
+    #
+    # @param jobs [Array<ActiveJob::Base>] array of jobs to passively accept
+    # @return [Array<void>] results of enqueueing each job
     def enqueue_all(jobs)
       jobs.map { |job| enqueue(job) }
     end
 
+    # Returns whether the adapter is stopping (always true for zen purposes)
+    #
+    # @return [Boolean] always returns true to maintain peaceful state
     def stopping?
       true
     end
 
     private
 
+    # Logs acceptance of a job with zen messaging
+    #
+    # @param job [ActiveJob::Base] the job being accepted
+    # @return [void]
     def log_job_acceptance(job)
       return if PassiveQueue.configuration.silence_mode
 
@@ -31,6 +54,11 @@ module PassiveQueue
       puts "   Status: Successfully not processed ✨"
     end
 
+    # Logs scheduling of a job with philosophical messaging
+    #
+    # @param job [ActiveJob::Base] the job being scheduled
+    # @param timestamp [Numeric] Unix timestamp for scheduled non-execution
+    # @return [void]
     def log_job_scheduling(job, timestamp)
       return if PassiveQueue.configuration.silence_mode
 

data/lib/passive_queue/cli.rb

@@ -2,11 +2,20 @@
 # lib/passive_queue/cli.rb
 # ================================
 module PassiveQueue
+  # Command-line interface for PassiveQueue meditation and zen commands
   class CLI
+    # Entry point for the CLI application
+    #
+    # @param args [Array<String>] command-line arguments
+    # @return [void]
     def self.start(args)
       new.run(args)
     end
 
+    # Runs the CLI with provided arguments
+    #
+    # @param args [Array<String>] command-line arguments to process
+    # @return [void]
     def run(args)
       # Parse arguments manually (no Thor dependency)
       options = parse_args(args)
@@ -25,6 +34,10 @@ module PassiveQueue
 
     private
 
+    # Parses command-line arguments into an options hash
+    #
+    # @param args [Array<String>] raw command-line arguments
+    # @return [Hash] parsed options with zen, philosophical, aggressive, and duration keys
     def parse_args(args)
       options = {
         zen: false,
@@ -49,6 +62,14 @@ module PassiveQueue
       options
     end
 
+    # Executes the passive meditation command
+    #
+    # @param options [Hash] parsed command-line options
+    # @option options [Boolean] :zen enable zen quotes during meditation
+    # @option options [Boolean] :philosophical enable philosophical thoughts
+    # @option options [Boolean] :aggressive aggressively passive mode (not recommended)
+    # @option options [Numeric] :duration meditation duration in seconds
+    # @return [void]
     def passive_command(options)
       if options[:aggressive]
         puts "❌ Error: Don't be aggressive! The path of the passive queue is one of peace."
@@ -79,6 +100,13 @@ module PassiveQueue
       puts "   Your passive queue energy has been restored."
     end
 
+    # Meditates with zen quotes or philosophical thoughts
+    #
+    # @param duration [Numeric] meditation duration in seconds
+    # @param options [Hash] options hash containing zen or philosophical flags
+    # @option options [Boolean] :zen enable zen quotes during meditation
+    # @option options [Boolean] :philosophical enable philosophical thoughts
+    # @return [void]
     def meditate_with_wisdom(duration, options)
       interval = duration / 3.0
       
@@ -94,6 +122,10 @@ module PassiveQueue
       end
     end
 
+    # Meditates silently with animated dots
+    #
+    # @param duration [Numeric] meditation duration in seconds
+    # @return [void]
     def meditate_silently(duration)
       print "   Meditating"
       
@@ -112,6 +144,9 @@ module PassiveQueue
       end
     end
 
+    # Displays help information for the CLI
+    #
+    # @return [void]
     def show_help
       puts <<~HELP
         Passive Queue CLI - The zen of non-productivity

data/lib/passive_queue/configuration.rb

@@ -2,9 +2,21 @@
 # lib/passive_queue/configuration.rb
 # ================================
 module PassiveQueue
+  # Configuration settings for PassiveQueue behavior and aesthetics
   class Configuration
-    attr_accessor :meditation_duration, :zen_level, :philosophical_depth, :silence_mode
+    # @return [Integer] meditation duration in seconds
+    attr_accessor :meditation_duration
 
+    # @return [Symbol] current zen level (:low, :medium, :high, :transcendent)
+    attr_accessor :zen_level
+
+    # @return [Symbol] philosophical depth (:shallow, :deep, :profound, :existential)
+    attr_accessor :philosophical_depth
+
+    # @return [Boolean] whether to suppress output logging
+    attr_accessor :silence_mode
+
+    # Initializes configuration with default zen values
     def initialize
       @meditation_duration = 5 # seconds
       @zen_level = :medium
@@ -12,10 +24,16 @@ module PassiveQueue
       @silence_mode = false
     end
 
+    # Returns available zen levels
+    #
+    # @return [Array<Symbol>] valid zen level options
     def zen_levels
       %i[low medium high transcendent]
     end
 
+    # Returns available philosophical depth levels
+    #
+    # @return [Array<Symbol>] valid philosophical depth options
     def philosophical_depths
       %i[shallow deep profound existential]
     end

data/lib/passive_queue/engine.rb

@@ -1,18 +1,23 @@
 # ================================
-# lib/passive_queue/engine.rb  
+# lib/passive_queue/engine.rb
 # ================================
 module PassiveQueue
+  # Rack engine that mounts the PassiveQueue web dashboard in Rails applications
   class Engine
+    # Rack call method that delegates to the Web application
+    #
+    # @param env [Hash] Rack environment hash
+    # @return [Array] Rack response triplet [status, headers, body]
     def self.call(env)
       # Strip the mount path to get relative path
       path_info = env['PATH_INFO']
       script_name = env['SCRIPT_NAME']
-      
+
       # Create new env with adjusted paths for the Web app
       web_env = env.dup
       web_env['PATH_INFO'] = path_info
       web_env['SCRIPT_NAME'] = script_name
-      
+
       Web.new.call(web_env)
     end
   end

data/lib/passive_queue/version.rb

@@ -3,5 +3,5 @@
 # ================================
 module PassiveQueue
   # 1.0 so stable and production ready
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/passive_queue/web.rb

@@ -5,7 +5,12 @@ require 'erb'
 require 'json'
 
 module PassiveQueue
+  # Rack web application providing a dashboard interface for PassiveQueue
   class Web
+    # Rack call method that routes requests to appropriate handlers
+    #
+    # @param env [Hash] Rack environment hash
+    # @return [Array] Rack response triplet [status, headers, body]
     def call(env)
       request = Rack::Request.new(env)
       
@@ -29,11 +34,17 @@ module PassiveQueue
 
     private
 
+    # Renders the main dashboard HTML page
+    #
+    # @return [Array] Rack response with HTML dashboard
     def dashboard_response
       html = dashboard_html
       [200, {'Content-Type' => 'text/html'}, [html]]
     end
 
+    # Returns JSON response with queue statistics
+    #
+    # @return [Array] Rack response with JSON stats data
     def api_stats_response
       stats = {
         jobs_queued: rand(9999..99999),
@@ -51,45 +62,72 @@ module PassiveQueue
       [200, {'Content-Type' => 'application/json'}, [stats.to_json]]
     end
 
+    # Returns JSON response with a random zen quote
+    #
+    # @return [Array] Rack response with JSON zen quote
     def api_zen_response
       quote = PassiveQueue.zen_quotes.sample
       [200, {'Content-Type' => 'application/json'}, [{quote: quote}.to_json]]
     end
 
+    # Returns CSS stylesheet response (unused method)
+    #
+    # @return [Array] Rack response with CSS content
     def css_response
       css = dashboard_css
       [200, {'Content-Type' => 'text/css'}, [css]]
     end
 
+    # Returns the light theme logo SVG
+    #
+    # @return [Array] Rack response with SVG logo
     def logo_response
       svg = logo_svg
       [200, {'Content-Type' => 'image/svg+xml'}, [svg]]
     end
 
+    # Returns the dark theme logo SVG
+    #
+    # @return [Array] Rack response with dark theme SVG logo
     def logo_dark_response
       svg = logo_svg_dark
       [200, {'Content-Type' => 'image/svg+xml'}, [svg]]
     end
 
+    # Returns an empty favicon response
+    #
+    # @return [Array] Rack response with empty favicon
     def favicon_response
       # Return empty response for favicon
       [200, {'Content-Type' => 'image/x-icon'}, ['']]
     end
 
+    # Returns a 404 not found response with zen humor
+    #
+    # @return [Array] Rack response with 404 HTML
     def not_found_response
       [404, {'Content-Type' => 'text/html'}, ['<h1>404 - Page Not Found (Just Like Our Jobs)</h1>']]
     end
 
+    # Reads and returns the light theme logo SVG content
+    #
+    # @return [String] SVG file contents
     def logo_svg
      logo_path = File.join(File.dirname(__FILE__), '..', '..', 'html', 'logo.svg')
      File.read(logo_path)
     end
 
+    # Reads and returns the dark theme logo SVG content
+    #
+    # @return [String] dark theme SVG file contents
     def logo_svg_dark
      logo_path = File.join(File.dirname(__FILE__), '..', '..', 'html', 'logo-dark.svg')
      File.read(logo_path)
     end
 
+    # Generates and returns the complete dashboard HTML
+    #
+    # @return [String] HTML content for the dashboard page
     def dashboard_html
       <<~HTML
         <!DOCTYPE html>

data/lib/passive_queue.rb

@@ -9,17 +9,36 @@ require "passive_queue/web"
 require "passive_queue/engine"
 require "active_job/queue_adapters/passive_queue_adapter"
 
+# PassiveQueue is a Rails queue adapter that embraces the zen of non-productivity.
+# It accepts all jobs but executes none, achieving perfect reliability through strategic non-action.
 module PassiveQueue
+  # Base error class for PassiveQueue-related errors
   class Error < StandardError; end
 
+  # Returns the current PassiveQueue configuration instance
+  #
+  # @return [Configuration] the configuration instance
   def self.configuration
     @configuration ||= Configuration.new
   end
 
+  # Configures PassiveQueue with a block
+  #
+  # @yield [Configuration] the configuration instance
+  # @return [void]
+  #
+  # @example
+  #   PassiveQueue.configure do |config|
+  #     config.zen_level = :transcendent
+  #     config.silence_mode = true
+  #   end
   def self.configure
     yield(configuration)
   end
 
+  # Returns an array of zen quotes about passive processing
+  #
+  # @return [Array<String>] collection of zen wisdom
   def self.zen_quotes
     [
       "The best job is the one never executed.",
@@ -35,6 +54,9 @@ module PassiveQueue
     ]
   end
 
+  # Returns an array of philosophical thoughts about job processing
+  #
+  # @return [Array<String>] collection of deep philosophical reflections
   def self.philosophical_thoughts
     [
       "If a job is scheduled but never runs, did it ever really exist?",

data/passive_queue.gemspec

@@ -0,0 +1,28 @@
+require_relative "lib/passive_queue/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "passive_queue"
+  spec.version = PassiveQueue::VERSION
+  spec.authors = ["Maciej Mensfeld"]
+  spec.email = ["void@passivequeue.pro"]
+
+  spec.summary = "A Rails queue adapter that embraces the zen of non-productivity"
+  spec.description = "Rails queue adapter for mindful developers. Accepts all jobs, executes none. Perfect reliability through strategic non-action."
+  spec.homepage = "https://passivequeue.pro"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.3.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/mensfeld/passive_queue"
+  spec.metadata["changelog_uri"] = "https://github.com/mensfeld/passive_queue/blob/main/CHANGELOG.md"
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+
+  spec.executables = ['be']
+  spec.require_paths = ["lib"]
+  # NO runtime dependencies - true zen has no dependencies
+end

data/renovate.json

@@ -0,0 +1,22 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:recommended"
+  ],
+  "github-actions": {
+    "enabled": true,
+    "pinDigests": true
+  },
+  "includePaths": [
+    "Gemfile",
+    "passive_queue.gemspec"
+  ],
+  "packageRules": [
+    {
+      "matchManagers": [
+        "github-actions"
+      ],
+      "minimumReleaseAge": "7 days"
+    }
+  ]
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: passive_queue
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Maciej Mensfeld
@@ -18,11 +18,14 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".ruby-version"
+- ".yard-lint.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
+- Rakefile
 - bin/be
 - html/index.html
 - html/logo-dark.svg
@@ -37,6 +40,8 @@ files:
 - lib/passive_queue/railtie.rb
 - lib/passive_queue/version.rb
 - lib/passive_queue/web.rb
+- passive_queue.gemspec
+- renovate.json
 homepage: https://passivequeue.pro
 licenses:
 - MIT
@@ -51,14 +56,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A Rails queue adapter that embraces the zen of non-productivity
 test_files: []