plutonium 0.33.1 → 0.34.0

data/docs/guide/getting-started/01-installation.md

@@ -1,165 +0,0 @@
-# Installation and Setup
-
-::: tip VERSION REQUIREMENTS
-- Ruby 3.2.2 or higher
-- Rails 7.1 or higher
-- Node.js and Yarn
-:::
-
-## Quick Start
-
-Get up and running with Plutonium in seconds:
-
-::: code-group
-```bash [New App]
-rails new plutonium_app -a propshaft -j esbuild -c tailwind \
-  -m https://radioactive-labs.github.io/plutonium-core/templates/plutonium.rb
-```
-
-```bash [Existing App]
-bin/rails app:template \
-  LOCATION=https://radioactive-labs.github.io/plutonium-core/templates/base.rb
-```
-:::
-
-## Detailed Installation Guide
-
-1. Add Plutonium to your Gemfile:
-
-::: code-group
-```ruby [Gemfile]
-gem "plutonium"
-```
-
-```bash [Terminal]
-bundle install
-```
-:::
-
-2. Run the installation generator:
-
-```bash
-rails generate pu:core:install
-```
-
-This will:
-- Set up the basic Plutonium structure
-- Create necessary configuration files
-- Configure your application for Plutonium
-
-### Project Structure
-
-After installation, your project will have the following new directories and files:
-
-```
-my_rails_app/
-├── app/
-│   ├── controllers/
-│   │   ├── plutonium_controller.rb     # Base controller for Plutonium
-│   │   └── resource_controller.rb      # Base controller for resources
-│   ├── definitions/
-│   │   └── resource_definition.rb      # Base class for resource definitions
-│   ├── interactions/
-│   │   └── resource_interaction.rb     # Base class for resource interactions
-│   ├── models/
-│   │   └── resource_record.rb         # Base module for resource models
-│   ├── policies/
-│   │   └── resource_policy.rb         # Base class for resource policies
-│   └── views/
-│       └── layouts/
-│           └── resource.html.erb       # Base layout for resources
-├── config/
-│   ├── initializers/
-│   │   └── plutonium.rb               # Main configuration
-│   └── packages.rb                    # Package registration
-└── packages/                          # Directory for modular features
-    └── .keep
-```
-
-## Configuration
-
-### Basic Configuration
-
-Configure Plutonium in `config/initializers/plutonium.rb`:
-
-```ruby
-Plutonium.configure do |config|
-  # Load default configuration for version 1.0
-  config.load_defaults 1.0
-
-  # Asset configuration
-  config.assets.stylesheet = "plutonium.css" # Default stylesheet
-  config.assets.script = "plutonium.js"     # Default JavaScript
-  config.assets.logo = "plutonium.png"   # Default logo
-end
-```
-
-### Authentication Setup
-
-Plutonium supports multiple authentication strategies. Here's how to set up the recommended Rodauth integration:
-
-1. Install Rodauth:
-
-```bash
-rails generate pu:rodauth:install
-```
-
-2. Create an authentication account:
-
-::: code-group
-```bash [Basic Setup]
-rails generate pu:rodauth:account user
-```
-
-```bash [Custom Setup]
-# Include selected authentication features
-rails generate pu:rodauth:account admin --no-defaults \
-  --login --logout --remember --lockout \
-  --create-account --verify-account --close-account \
-   --change-password --reset-password --reset-password-notify \
-  --active-sessions --password-grace-period --otp \
-  --recovery-codes --audit-logging --internal-request
-```
-:::
-
-3. Configure the authentication controller:
-
-```ruby
-# app/controllers/resource_controller.rb
-class ResourceController < PlutoniumController
-  include Plutonium::Resource::Controller
-  include Plutonium::Auth::Rodauth(:user)
-end
-```
-
-::: tip
-You can use your existing authentication system by implementing the `current_user` method in `ResourceController`.
-:::
-
-## Optional Enhancements
-
-### Database Performance
-
-For PostgreSQL/MySQL users, add these recommended gems:
-
-```ruby
-group :development, :test do
-  # N+1 query detection
-  gem "prosopite"
-end
-
-# Automatic eager loading
-gem "goldiloader"
-```
-
-### Development Tools
-
-Add helpful development gems:
-
-```ruby
-# Generate model annotations
-rails generate pu:gem:annotated
-
-# Set up environment variables
-rails generate pu:gem:dotenv
-```

data/docs/guide/index.md

@@ -1,28 +0,0 @@
----
-layout: home
-title: Plutonium Documentation
-hero:
-  name: Plutonium Documentation
-  text: A RAD toolkit for Rails
-  tagline: Build better applications, faster.
-  actions:
-    - theme: brand
-      text: Get Started
-      link: /guide/introduction/01-what-is-plutonium
-    - theme: alt
-      text: View on GitHub
-      link: https://github.com/radioactive-labs/plutonium
-features:
-  - title: Introduction
-    details: Learn about the core concepts and architecture of Plutonium.
-    link: /guide/introduction/01-what-is-plutonium
-  - title: Tutorial
-    details: A step-by-step guide to building your first application.
-    link: /guide/tutorial/01-project-setup
-  - title: Deep Dive Guides
-    details: In-depth explanations of specific Plutonium features.
-    link: /guide/deep-dive/resources
-  - title: Module Documentation
-    details: Detailed documentation for each Plutonium module.
-    link: /modules/
----

data/docs/guide/introduction/01-what-is-plutonium.md

@@ -1,211 +0,0 @@
-# What is Plutonium?
-
-Plutonium is a Rapid Application Development (RAD) toolkit that extends Rails with powerful conventions, patterns, and tools to accelerate application development while maintaining flexibility and maintainability.
-
-It acts as a higher-level abstraction on top of Rails, providing ready-to-use solutions for common application needs while preserving Rails' elegance.
-
-## Core Architecture
-
-### Rails-Native Design
-
-Plutonium integrates seamlessly with Rails, extending its conventions rather than replacing them:
-
-```ruby
-# Plutonium controllers inherit from your ApplicationController
-class ResourceController < ApplicationController
-  include Plutonium::Resource::Controller
-end
-
-# Plutonium controllers are Rails controllers
-class ProductsController < ResourceController
-  # Enhanced with resource capabilities
-  def custom_action
-    # Regular Rails code works just fine
-    respond_to do |format|
-      format.html
-      format.json
-    end
-  end
-end
-```
-
-### Resource-Oriented Architecture
-
-Resources are the building blocks of Plutonium applications:
-
-```ruby
-class ProductDefinition < ResourceDefinition
-  # Declarative field definitions
-  field :name, as: :string
-  field :description, as: :markdown
-  field :price_cents, as: :money
-
-  # Resource-level search
-  search do |scope, query|
-    scope.where("name LIKE ?", "%#{query}%")
-  end
-
-  # Business actions
-  action :publish, interaction: PublishProduct
-  action :archive, interaction: ArchiveProduct
-end
-```
-
-### Modular by Design
-
-Plutonium's packaging system helps organize code into focused, reusable modules:
-
-```ruby
-# Generate different types of packages
-rails generate pu:pkg:portal admin
-rails generate pu:pkg:package inventory
-
-# Packages are isolated and focused
-module AdminPortal
-  class Engine < Rails::Engine
-    include Plutonium::Portal::Engine
-  end
-end
-
-AdminPortal::Engine.routes.draw do
-  register_resource ::Product
-end
-```
-
-### Progressive Enhancement
-
-Built on modern web technologies like Hotwire, delivering rich interactivity without sacrificing simplicity:
-
-```ruby
-class PublishProduct < ResourceInteraction
-  attribute :schedule_for, :datetime
-  attribute :notify_users, :boolean
-
-  def execute
-    resource.publish!(schedule_for:)
-    notify_users! if notify_users
-
-    success(resource)
-      .with_message("Product scheduled for publishing")
-      .with_render_response(NotificationComponent.new)
-  end
-end
-```
-
-## Use Cases
-
-### Business Applications
-
-::: details Enterprise Resource Planning (ERP)
-```ruby
-class InvoiceDefinition < ResourceDefinition
-  # Rich field handling
-  field :line_items, as: :nested, limit: 20
-  field :attachments, as: :document, multiple: true
-
-  # Business actions
-  action :submit_for_approval, interaction: SubmitForApproval
-  action :approve, interaction: ApproveInvoice
-  action :reject, interaction: RejectInvoice
-
-  # Workflow states
-  scope :draft
-  scope :pending_approval
-  scope :approved
-end
-```
-:::
-
-::: details Multi-tenant SaaS
-```ruby
-module CustomerPortal
-  class Engine < Rails::Engine
-    include Plutonium::Package::Engine
-    # Automatic tenant isolation
-    scope_to_entity Organization
-  end
-end
-```
-:::
-
-### Administrative Systems
-
-::: details Back-office Applications
-```ruby
-class OrderDefinition < ResourceDefinition
-  # Advanced filtering
-  filter :status, with: SelectFilter, choices: Order.statuses
-  filter :created_at, with: DateRangeFilter
-
-  # Bulk actions
-  action :process_batch, interaction: ProcessPendingOrders
-  action :export_to_csv, interaction: ExportOrders
-
-  # Complex displays
-  display :summary do |field|
-    OrderSummaryComponent.new(field)
-  end
-end
-```
-:::
-
-::: details Content Management
-```ruby
-class ArticleDefinition < ResourceDefinition
-  field :content, as: :markdown
-  field :featured_image, as: :image
-
-  # Publishing workflow
-  action :publish, interaction: PublishArticle
-  action :schedule, interaction: ScheduleArticle
-
-  # Content organization
-  scope :draft
-  scope :published
-  scope :scheduled
-end
-```
-:::
-
-## Key Benefits
-
-### Accelerated Development
-- Pre-built components for common functionality
-- Smart generators for boilerplate code
-- Convention-based resource handling
-- Integrated authentication and authorization
-
-### Maintainable Architecture
-- Clear separation of concerns through packages
-- Consistent patterns across the application
-- Deep Rails integration
-- Progressive enhancement
-
-### Enterprise Ready
-- Flexible and robust access control
-- Multi-tenancy support
-- Extensible component system
-- Mobile-friendly by default
-
-## Best For
-
-::: tip IDEAL USE CASES
-- Complex business applications
-- Multi-tenant SaaS platforms
-- Administrative systems
-- Content management systems
-- Resource management systems
-:::
-
-::: warning MIGHT NOT BE THE BEST FIT
-- Simple blogs or brochure sites
-- Basic CRUD applications
-- Pure API-only services
-:::
-
-## Prerequisites
-
-- Ruby 3.2.2 or higher
-- Rails 7.1 or higher
-- Node.js and Yarn
-- Basic understanding of Ruby on Rails