command_deck 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f79a2f12ff19b218e7b02e3269ebaff3a283bc3772cdedeaffe829a7e3c9adc
-  data.tar.gz: 0b76ee1ba7f39d8b3a8a781ec33aefe32efdd9e5b66edcfced9e9fc77ea8dcfb
+  metadata.gz: 2d7607e2931f95aa4dfd89508fce37ab2d9b769c4e5463692d9a6d1a8e420861
+  data.tar.gz: 8efb1447f274e41cb071524d92e2e718349fe0b90dd32124db4e6daa60fcfb8f
 SHA512:
-  metadata.gz: 64a99c105eb4dbce276c748aca3781dbe8f74e5bec7b7ab6073e141a7e7fceac5680bfc4e8f67f1aaac25e2642914ef4d6d7df7e0d0e597614836326f652ec25
-  data.tar.gz: d9ce128531b79674de1d8125995969bf8d4e12df619e7b03aa52a569760f204d7a38fcc28e5cdce5604d9ae8b43fe82e2867a3e972724ddebfe9f5d71b2750b4
+  metadata.gz: ded56cf9f23174bdc5406d70ec1bf66788706708aae8edc84c8af9f87882f6ec6bd728b62c5f511eb9139776822a6a8645d9548b71145920bd6f073c9d3079e6
+  data.tar.gz: 20bcfcca9de31c7da07fb6b36630bd6dd7b1151cc1eda6c89d45332b55c5ff2a1169a8a774fa57e7128fe034719983d6c1c0f6c86e831fb504682012b5aa9ef9

data/.rubocop.yml

@@ -1,3 +1,7 @@
+plugins:
+  - rubocop-minitest
+  - rubocop-rake
+
 AllCops:
   TargetRubyVersion: 3.0
   NewCops: enable

data/CHANGELOG.md

@@ -1,5 +1,35 @@
 # CHANGELOG
 
+## [0.2.0] - 2025-10-09
+
+### Breaking Changes
+
+- Panels must now be defined as classes inheriting from `CommandDeck::BasePanel`
+- Panel files define `Panels::*` constants (not `CommandDeck::Panels::*`)
+- Middleware is no longer automatically injected (must be added manually in `config/application.rb`)
+
+### Added
+
+- Full Rails autoloading and Zeitwerk compatibility
+- Proper class-based panel architecture
+- Automatic panel registration via `BasePanel.inherited` hook
+
+### Changed
+
+- Consolidated Railtie into Engine for simpler initialization
+- Panels namespace changed: `app/command_deck/panels/global.rb` → `Panels::Global`
+- Cleaner, self-documenting code architecture
+
+### Fixed
+
+- Middleware stack freezing conflicts with other gems (Bullet, etc.)
+- CI/test environment compatibility
+- Zeitwerk constant resolution errors
+
+## [0.1.3] - 2025-09-23
+
+- Unchilenizes the README file
+
 ## [0.1.2] - 2025-09-11
 
 ### Added

data/CONTRIBUTING.md

@@ -0,0 +1,63 @@
+# Contributing to Command Deck
+
+Thank you for considering contributing to Command Deck!
+
+## Development Setup
+
+```bash
+git clone https://github.com/crow-rojas/command_deck.git
+cd command_deck
+bundle install
+```
+
+## Running Tests
+
+```bash
+bundle exec rake test
+```
+
+## Code Style
+
+We use RuboCop for code style enforcement:
+
+```bash
+bundle exec rubocop
+```
+
+Fix auto-correctable issues:
+
+```bash
+bundle exec rubocop -A
+```
+
+## Making Changes
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b my-feature`)
+3. Make your changes
+4. Add tests for new functionality
+5. Ensure all tests pass
+6. Run RuboCop and fix any offenses
+7. Commit your changes (`git commit -am 'Add feature'`)
+8. Push to your branch (`git push origin my-feature`)
+9. Create a Pull Request
+
+## Pull Request Guidelines
+
+- Keep changes focused and atomic
+- Update CHANGELOG.md with your changes
+- Update README.md if adding new features
+- Ensure backward compatibility when possible
+- Add tests for bug fixes and new features
+- Follow existing code style
+
+## Reporting Issues
+
+- Use the GitHub issue tracker
+- Include Ruby and Rails versions
+- Provide steps to reproduce
+- Include relevant code samples
+
+## Questions?
+
+Feel free to open an issue for questions or discussions.

data/README.md

@@ -1,8 +1,10 @@
 # Command Deck
 
-Command Deck is a tiny, dev-only Rails engine that gives you a floating panel to run custom actions and quick admin tasks without opening Rails console.
+Convenient, unobtrusive, dev-oriented Rails engine that allows you to run custom actions and quick admin tasks through a floating panel without opening the Rails console.
 
-You define panels/tabs/actions in a minimal DSL. Each action can declare a few params (text, boolean, number, selector), run Ruby code, and return a JSON-ish result shown in the UI.
+Define panels/tabs/actions with a minimal class-based DSL. Each action can declare parameters (text, boolean, number, selector), run Ruby code, and return a JSON result shown in the UI.
+
+![Demo](public/img/demo.gif)
 
 ## Installation
 
@@ -11,79 +13,88 @@ Add the gem to your application:
 ```ruby
 # Gemfile (development only recommended)
 group :development do
-  gem "command_deck"
+  gem 'command_deck'
 end
 ```
 
-Mount the engine (dev only):
+Mount the engine:
 
 ```ruby
 # config/routes.rb
-if Rails.env.development?
-  mount CommandDeck::Engine => "/command_deck"
-end
+mount CommandDeck::Engine => '/command_deck' if Rails.env.development?
 ```
 
-Start your app and the floating panel should appear.
+Add middleware to inject the floating panel:
 
-## Define actions (DSL)
+```ruby
+# config/application.rb
 
-Create Ruby files in `app/command_deck/**/*.rb`. Example:
+module YourApp
+  class Application < Rails::Application
+    # ... other config ...
+    
+    config.middleware.insert_after ActionDispatch::DebugExceptions, CommandDeck::Middleware if Rails.env.development?
+  end
+end
+```
 
-```ruby
-CommandDeck.panel "Utilities" do
-  tab "Demo" do
-    action "Greet", key: "utils.greet" do
-      param :name, :string, label: "Your name", required: true
+## Define actions
 
-      perform do |p, _ctx|
-        { message: "Hello, #{p[:name]}!" }
-      end
-    end
+Create panel classes in `app/command_deck/panels/*.rb`:
 
-    action "Pick a Color", key: "utils.color" do
-      # You can pass simple arrays, pairs, or hashes as choices
-      param :color, :selector,
-        options: [
-          ["Red",   "red"],
-          ["Green", "green"],
-          ["Blue",  "blue"]
-        ],
-        include_blank: true
-
-      perform do |p, _ctx|
-        { chosen: p[:color] }
+```ruby
+# app/command_deck/panels/utilities.rb
+module Panels
+  class Utilities < CommandDeck::BasePanel
+    panel 'Utilities' do
+      tab 'Demo' do
+        action 'Greet', key: 'utils.greet' do
+          param :name, :string, label: 'Your name', required: true
+
+          perform do |p, _ctx|
+            { message: "Hello, #{p[:name]}!" }
+          end
+        end
+
+        action 'Pick a Color', key: 'utils.color' do
+          # You can pass simple arrays, pairs, or hashes as choices
+          param :color, :selector,
+            options: [
+              ['Red',   'red'],
+              ['Green', 'green'],
+              ['Blue',  'blue']
+            ],
+            include_blank: true
+
+          perform do |p, _ctx|
+            { chosen: p[:color] }
+          end
+        end
       end
     end
   end
 end
 ```
 
-This will create a panel called "Utilities" with a tab called "Demo" and two actions: "Greet" and "Pick a Color".
+This creates a panel with a tab and two actions. File path matches constant: `app/command_deck/panels/utilities.rb` → `Panels::Utilities`
 
 ![Demo](public/img/demo.png)
 
 ## DSL API
 
-Define panels under `app/command_deck/**/*.rb`.
-
-```ruby
-CommandDeck.panel(title, owner: nil, group: nil, key: nil) { ... }
-```
-
-Inside a panel, define tabs:
+Panels inherit from `CommandDeck::BasePanel`. Define tabs within a panel:
 
 ```ruby
 tab(title) { ... }
 ```
 
-Inside a tab, define actions:
+Define actions within a tab:
 
 ```ruby
 action(title, key:) { ... }
 ```
 
-Inside an action, declare params and the code to run:
+Declare params and execution logic within an action:
 
 ```ruby
 param(name, type, **opts)
@@ -110,17 +121,14 @@ Selector-specific options:
 - `return:` `:value` (default), `:label`, or `:both` (`{ label:, value: }`).
 - Choice shapes accepted:
   - Values: `%w[a b c]`
-  - Pairs: `[["Label A", "a"], ["Label B", "b"]]`
+  - Pairs: `[['Label A', 'a'], ['Label B', 'b']]`
   - Objects: `{ label:, value:, meta?: { ... } }`
 
-Action execution:
-
-- The block `perform { |params, ctx| ... }` receives your coerced params and a context hash (reserved for future use).
-- Return any object serializable to JSON (Hash recommended) to show it in the UI.
+The `perform` block receives coerced params and a context hash. Return any JSON-serializable object (Hash recommended).
 
 ## Security
 
-Command Deck is intended for development only. The engine mounts only in dev and skips CSRF by default. **DO NOT ENABLE IT IN PRODUCTION**.
+Intended for development only. **DO NOT ENABLE IN PRODUCTION**.
 
 ## Development
 

data/lib/command_deck/base_panel.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module CommandDeck
+  # Base class for panel definitions.
+  #
+  # Example:
+  #   module Panels
+  #     class Global < CommandDeck::BasePanel
+  #       panel "Global Tools" do
+  #         tab "Update" do
+  #           action "Do Something", key: "global.do_something" do
+  #             perform { |params, ctx| { ok: true } }
+  #           end
+  #         end
+  #       end
+  #     end
+  #   end
+  class BasePanel
+    class << self
+      def panel(title, **opts, &block)
+        @panel_definition = { title: title, opts: opts, block: block }
+      end
+
+      def register!
+        return unless @panel_definition
+
+        Registry.panel(
+          @panel_definition[:title],
+          **@panel_definition[:opts],
+          &@panel_definition[:block]
+        )
+      end
+
+      def inherited(subclass)
+        super
+        CommandDeck.register_panel_class(subclass)
+      end
+    end
+  end
+end

data/lib/command_deck/engine.rb

@@ -8,8 +8,12 @@ module CommandDeck
   class Engine < ::Rails::Engine
     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?
+    end
+
     initializer "command_deck.mount_point" do
-      # Default mount point. If the host app has a relative_url_root, respect it.
       mp = "/command_deck"
       if defined?(Rails) && Rails.application.config.respond_to?(:relative_url_root)
         root = Rails.application.config.relative_url_root
@@ -18,11 +22,20 @@ module CommandDeck
       CommandDeck::Middleware.mount_point = mp
     end
 
-    initializer "command_deck.middleware" do |app|
-      # Dev-only injection. Safe no-op in other environments.
-      if defined?(Rails) && Rails.env.development?
-        app.middleware.insert_after ActionDispatch::DebugExceptions, CommandDeck::Middleware
+    config.to_prepare do
+      next unless Rails.env.development?
+
+      CommandDeck::Registry.clear!
+
+      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
       end
+
+      CommandDeck.register_all_panels!
     end
   end
 end

data/lib/command_deck/registry.rb

@@ -96,8 +96,4 @@ module CommandDeck
       end
     end
   end
-
-  def self.panel(title, ...)
-    Registry.panel(title, ...)
-  end
 end

data/lib/command_deck/version.rb

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

data/lib/command_deck.rb

@@ -3,12 +3,25 @@
 require_relative "command_deck/version"
 require "command_deck/registry"
 require "command_deck/executor"
+require "command_deck/base_panel"
 
+# Main module of the Command Deck gem
 module CommandDeck
   class Error < StandardError; end
-end
 
-if defined?(Rails)
-  require "command_deck/railtie"
-  require "command_deck/engine"
+  class << self
+    def panel_classes
+      @panel_classes ||= []
+    end
+
+    def register_panel_class(klass)
+      panel_classes << klass unless panel_classes.include?(klass)
+    end
+
+    def register_all_panels!
+      panel_classes.each(&:register!)
+    end
+  end
 end
+
+require "command_deck/engine" if defined?(Rails)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: command_deck
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - crowrojas
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-09-11 00:00:00.000000000 Z
+date: 2025-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -17,6 +17,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +27,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -31,6 +37,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -38,8 +47,13 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '7.0'
-description: Command Deck is a tiny floating UI that allows you to run commands in
-  your Rails app.
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+description: |
+  Command Deck is a Rails engine that provides a floating panel UI for running custom admin
+  actions and tasks without opening the Rails console. Define panels/tabs/actions with a
+  class-based DSL.
 email:
 - cristobal.rojasbrito@gmail.com
 executables: []
@@ -49,6 +63,7 @@ files:
 - ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -74,13 +89,14 @@ files:
 - lib/command_deck/assets/js/ui/overlay/theme_manager.js
 - lib/command_deck/assets/js/ui/panel_selector.js
 - lib/command_deck/assets/js/ui/settings_dropdown.js
+- lib/command_deck/base_panel.rb
 - lib/command_deck/engine.rb
 - lib/command_deck/executor.rb
 - lib/command_deck/injector.rb
 - lib/command_deck/middleware.rb
-- lib/command_deck/railtie.rb
 - lib/command_deck/registry.rb
 - lib/command_deck/version.rb
+- public/img/demo.gif
 - public/img/demo.png
 - sig/command_deck.rbs
 homepage: https://github.com/crow-rojas/command_deck
@@ -89,7 +105,7 @@ licenses:
 metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/crow-rojas/command_deck
-  source_code_uri: https://github.com/crow-rojas/command_deck
+  source_code_uri: https://github.com/crow-rojas/command_deck/tree/master
   changelog_uri: https://github.com/crow-rojas/command_deck/blob/master/CHANGELOG.md
   rubygems_mfa_required: 'true'
 post_install_message:
@@ -110,6 +126,5 @@ requirements: []
 rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
-summary: Command Deck is a tiny floating UI that allows you to run commands in your
-  Rails app.
+summary: Dev-oriented floating panel for running custom actions in Rails apps
 test_files: []

data/lib/command_deck/railtie.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-require "rails/railtie"
-
-module CommandDeck
-  # Rails engine for Command Deck
-  class Railtie < ::Rails::Railtie
-    initializer "command_deck.load_panels", after: :load_config_initializers do
-      path = Rails.root.join("app/command_deck")
-      Dir[path.join("**/*.rb")].each { |f| load f } if Dir.exist?(path)
-    end
-  end
-end