command_deck 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d7607e2931f95aa4dfd89508fce37ab2d9b769c4e5463692d9a6d1a8e420861
-  data.tar.gz: 8efb1447f274e41cb071524d92e2e718349fe0b90dd32124db4e6daa60fcfb8f
+  metadata.gz: 403635cfced62de1e01f415368f926475937db69e83dda253283113d4f76f9cb
+  data.tar.gz: edf5c2cc7371c6dd4da4a4a577292db53a821f2345c54631c16340323c20a7e6
 SHA512:
-  metadata.gz: ded56cf9f23174bdc5406d70ec1bf66788706708aae8edc84c8af9f87882f6ec6bd728b62c5f511eb9139776822a6a8645d9548b71145920bd6f073c9d3079e6
-  data.tar.gz: 20bcfcca9de31c7da07fb6b36630bd6dd7b1151cc1eda6c89d45332b55c5ff2a1169a8a774fa57e7128fe034719983d6c1c0f6c86e831fb504682012b5aa9ef9
+  metadata.gz: d27d8c3b933ea5069861055644f5db6122fde71de4207ad2fd7c32ff6fbb56110de8c3632983cc0cd387680c6c88d8d65d6ef10ca634ea6904e4d797d533d9bd
+  data.tar.gz: 31a9bab9bd5bf4025b292c565c0f04118fc09eb51d3473dabe671b523885966f91374a5c840d4fce710a10132ff3c276cba670ccb8cf4169efcae1107cea30ae

data/CHANGELOG.md

@@ -1,5 +1,49 @@
 # CHANGELOG
 
+## [0.3.0] - 2025-10-10
+
+### Added
+
+- **Auto-discovery**: Panels can now be defined in any `command_deck` directory (e.g., `app/command_deck`, `packs/**/command_deck`)
+- **Automatic middleware insertion**: Middleware is now auto-injected when `COMMAND_DECK_ENABLED=true` in development
+- **Flexible namespacing**: Use any namespace that matches your project structure (e.g., `CommandDeck::Panels`, `DevTools::Panels`)
+
+### Changed
+
+- **Zero configuration required in application.rb**: No need to manually add autoload paths or middleware
+- Improved documentation with examples for modularized monoliths (packwerk/pack-rails)
+- Recommended gem group changed to `:development, :test` for better Sorbet/Tapioca compatibility
+
+### Migration from 0.2.0
+
+**Before (0.2.0):**
+
+```ruby
+# config/application.rb
+config.middleware.insert_after ActionDispatch::DebugExceptions, CommandDeck::Middleware if Rails.env.development?
+
+# app/command_deck/panels/global.rb
+module Panels
+  class Global < CommandDeck::BasePanel
+    # ...
+  end
+end
+```
+
+**After (0.3.0):**
+
+```ruby
+# config/application.rb - NO CONFIG NEEDED!
+# Just set COMMAND_DECK_ENABLED=true in your .env
+
+# app/command_deck/panels/global.rb
+module CommandDeck::Panels  # More descriptive namespace
+  class Global < CommandDeck::BasePanel
+    # ...
+  end
+end
+```
+
 ## [0.2.0] - 2025-10-09
 
 ### Breaking Changes

data/CONTRIBUTING.md

@@ -58,6 +58,33 @@ bundle exec rubocop -A
 - Provide steps to reproduce
 - Include relevant code samples
 
+## Releasing a New Version
+
+**Prerequisites:**
+
+- Update `lib/command_deck/version.rb` with the new version
+- Update `CHANGELOG.md` with changes
+- Commit all changes
+- Be on the `master` branch with a clean working directory
+
+**Release:**
+
+```bash
+bin/release
+```
+
+This script will:
+
+1. Run tests and RuboCop
+2. Build the gem
+3. Create a git tag
+4. Push to GitHub
+5. Publish to RubyGems
+
+**Manual steps after release:**
+
+- Create a GitHub release with the CHANGELOG content.
+
 ## Questions?
 
 Feel free to open an issue for questions or discussions.

data/README.md

@@ -11,8 +11,8 @@ Define panels/tabs/actions with a minimal class-based DSL. Each action can decla
 Add the gem to your application:
 
 ```ruby
-# Gemfile (development only recommended)
-group :development do
+# Gemfile (development and test recommended for Sorbet/Tapioca)
+group :development, :test do
   gem 'command_deck'
 end
 ```
@@ -21,30 +21,30 @@ Mount the engine:
 
 ```ruby
 # config/routes.rb
-mount CommandDeck::Engine => '/command_deck' if Rails.env.development?
+mount CommandDeck::Engine => '/command_deck' if defined?(CommandDeck::Engine)
 ```
 
-Add middleware to inject the floating panel:
+Enable it in your development environment:
 
-```ruby
-# config/application.rb
-
-module YourApp
-  class Application < Rails::Application
-    # ... other config ...
-    
-    config.middleware.insert_after ActionDispatch::DebugExceptions, CommandDeck::Middleware if Rails.env.development?
-  end
-end
+```bash
+# .env.development.local (or your environment config)
+COMMAND_DECK_ENABLED=true
 ```
 
+**That's it!** The gem automatically:
+
+- Discovers panel files in `app/command_deck/**/*.rb` and `packs/**/command_deck/**/*.rb`
+- Adds them to autoload paths
+- Inserts middleware when `COMMAND_DECK_ENABLED=true` in development
+- Stays completely inactive in production
+
 ## Define actions
 
-Create panel classes in `app/command_deck/panels/*.rb`:
+Create panel classes anywhere under a `command_deck` directory. Use descriptive namespaces:
 
 ```ruby
 # app/command_deck/panels/utilities.rb
-module Panels
+module CommandDeck::Panels
   class Utilities < CommandDeck::BasePanel
     panel 'Utilities' do
       tab 'Demo' do
@@ -76,7 +76,29 @@ module Panels
 end
 ```
 
-This creates a panel with a tab and two actions. File path matches constant: `app/command_deck/panels/utilities.rb` → `Panels::Utilities`
+### For modularized monoliths (packwerk/pack-rails)
+
+You can organize panels within your packs:
+
+```ruby
+# packs/dev_tools/command_deck/panels/database.rb
+module DevTools::Panels
+  class Database < CommandDeck::BasePanel
+    panel 'Database Tools' do
+      tab 'Maintenance' do
+        action 'Rebuild Cache', key: 'db.rebuild_cache' do
+          perform do |_p, _ctx|
+            Rails.cache.clear
+            { ok: true, message: 'Cache cleared' }
+          end
+        end
+      end
+    end
+  end
+end
+```
+
+The gem auto-discovers panels in any `command_deck` directory under your app or packs. Use namespaces that match your project structure.
 
 ![Demo](public/img/demo.png)
 

data/lib/command_deck/base_panel.rb

@@ -3,8 +3,15 @@
 module CommandDeck
   # Base class for panel definitions.
   #
-  # Example:
-  #   module Panels
+  # Panels can be defined anywhere under a `command_deck` directory.
+  # The gem will auto-discover panels in:
+  #   - app/command_deck/**/*.rb
+  #   - packs/**/command_deck/**/*.rb
+  #
+  # Use descriptive namespaces that match your project structure.
+  #
+  # Example in app/command_deck/panels/global.rb:
+  #   module CommandDeck::Panels
   #     class Global < CommandDeck::BasePanel
   #       panel "Global Tools" do
   #         tab "Update" do

data/lib/command_deck/engine.rb

@@ -9,8 +9,9 @@ module CommandDeck
     isolate_namespace CommandDeck
 
     initializer "command_deck.add_autoload_paths", before: :set_autoload_paths do |app|
-      panels_path = Rails.root.join("app/command_deck")
-      app.config.autoload_paths << panels_path.to_s if panels_path.exist?
+      discover_panel_paths.each do |path|
+        app.config.autoload_paths << path.to_s unless app.config.autoload_paths.include?(path.to_s)
+      end
     end
 
     initializer "command_deck.mount_point" do
@@ -22,20 +23,43 @@ module CommandDeck
       CommandDeck::Middleware.mount_point = mp
     end
 
+    initializer "command_deck.middleware", after: :load_config_initializers do |app|
+      next unless Rails.env.development?
+      next unless ENV.fetch("COMMAND_DECK_ENABLED", "false") == "true"
+
+      unless app.config.middleware.include?(CommandDeck::Middleware)
+        app.config.middleware.insert_after(
+          ActionDispatch::DebugExceptions,
+          CommandDeck::Middleware
+        )
+      end
+    end
+
     config.to_prepare do
       next unless Rails.env.development?
 
       CommandDeck::Registry.clear!
+      CommandDeck.register_all_panels!
+    end
+
+    class << self
+      private
 
-      if defined?(Panels)
-        Panels.constants.each do |const_name|
-          Panels.const_get(const_name)
-        rescue NameError => e
-          Rails.logger.warn "[CommandDeck] Could not load panel: #{e.message}"
-        end
+      def discover_panel_paths
+        [discover_app_panels, discover_pack_panels].flatten.compact.uniq
       end
 
-      CommandDeck.register_all_panels!
+      def discover_app_panels
+        path = Rails.root.join("app/command_deck")
+        path if path.exist?
+      end
+
+      def discover_pack_panels
+        packs_path = Rails.root.join("packs")
+        return [] unless packs_path.exist?
+
+        Dir.glob(packs_path.join("**/command_deck")).select { |dir| Pathname.new(dir).directory? }
+      end
     end
   end
 end

data/lib/command_deck/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CommandDeck
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: command_deck
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - crowrojas