railspress-engine 0.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23a09596799a0a89eefd920154a5aefdcae1a4247ebbfb8f161781a87adaa462
-  data.tar.gz: 3b8b24840927df71dedc373457eeb082cf429932e6542eceeec06cf59195cfea
+  metadata.gz: f1ca2f73a89851d3359c2d32b51c5b5a3770e9e5d3c4f81655e5436fcf249fd4
+  data.tar.gz: 5c8c712b7139a6ab50be2b30831de8320b254a99a96e8f23fa69c0ad4d2ab8ae
 SHA512:
-  metadata.gz: 4ad75a1e6057939610e32fef6b4add2a5d4eb4b5ff47621801f45a74414205c0d30ac5e308e21b612e26d774d19f6cd488e7655dd4626772a8c7e837997680d2
-  data.tar.gz: 4f011c5faf57b329fb81ae904ff2da1ef0df5a373b7e3c41c31c16af5bc661eeddb67430daf8e8def0b9cc4f899802217287ebbfeb235e51cf1567d0067aa0d1
+  metadata.gz: fc61ccdaa5f8af6baa55c5186c07525a5272bb87bf4bec19f09c1ec6bdd710d8107d804a384f4d339a5243a8d44d0ca4dc82655a6328775587a831077567b470
+  data.tar.gz: d8d931f5f83c225d75b7d939a5251e4d8343c6b223fc7e56d8855024da7c58fae3c3236348e51aafc2e80f144cfc6e2dc40899db430e6da5df87f8b01530dd45

data/LICENSE

@@ -0,0 +1,20 @@
+O'Saasy License Agreement - https://osaasy.dev/
+
+Copyright © 2026, Avi Flombaum (https://avi.nyc).
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+No licensee or downstream recipient may use the Software (including any modified or derivative versions) to directly compete with the original Licensor by offering it to third parties as a hosted, managed, or Software-as-a-Service (SaaS) product or cloud service where the primary value of the service is the functionality of the Software itself.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+--
+
+Trademarks
+
+The Rails trademarks are the intellectual property of David Heinemeier Hansson,
+and exclusively licensed to the Rails Foundation. Uses of "Rails" and "Ruby on
+Rails" in this project are for identification purposes only and do not imply an
+endorsement by or affiliation with Rails, the trademark owner, or the Rails
+Foundation.

data/README.md

@@ -1,60 +1,226 @@
-# RailsPress
+<p align="center">
+  <strong>RailsPress</strong><br>
+  A mountable blog + CMS engine for Rails 8
+</p>
 
-A simple blog engine for Rails 8 applications.
+<p align="center">
+  <a href="https://rubygems.org/gems/railspress-engine"><img src="https://img.shields.io/gem/v/railspress-engine.svg?style=flat&bump=true" alt="Gem Version"></a>
+  <img src="https://img.shields.io/badge/Rails-8.1%2B-red.svg?style=flat" alt="Rails 8.1+">
+  <img src="https://img.shields.io/badge/Ruby-3.3%2B-red.svg?style=flat" alt="Ruby 3.3+">
+  <a href="https://osaasy.dev/"><img src="https://img.shields.io/badge/License-O'Saasy-blue.svg?style=flat" alt="License"></a>
+</p>
 
-## Features
+---
+
+RailsPress is a mountable Rails engine that gives your app a complete content management system — namespaced and isolated so it stays out of your way.
+
+You can read more at [Railspress.org](https://railspress.org).
+
+It manages three kinds of content:
+
+## Posts, Entities, and Blocks
 
-- Blog posts with rich text editing (ActionText)
-- Categories and tags
+### Posts
+
+Your blog. Chronological content published over time — articles, news, announcements. Categories, tags, draft/published workflow.
+
+- Rich text editing with [Lexxy](https://github.com/aviflombaum/lexxy) + markdown mode toggle
+- Categories, tags, draft/published workflow
 - SEO metadata (meta title, meta description)
-- Draft/published workflow with automatic publish timestamps
-- Admin interface for content management
+- Reading time auto-calculation
+- Header images with focal point cropping
+- Import/export (markdown + YAML frontmatter)
+
+### Entities
+
+Your pages of structured content. A portfolio with projects, a collection of case studies, a resources page with links — anything with its own schema that isn't a blog post.
+
+You define a regular ActiveRecord model, include `Railspress::Entity`, and RailsPress gives it a full admin interface with CRUD, search, pagination, image uploads, and tagging — no scaffolding or custom views required.
+
+- Define fields with `railspress_fields` DSL or let RailsPress auto-detect from your schema
+- Supports string, text, rich text, boolean, datetime, attachments, array fields, and more
+- Focal point image cropping for any attachment
+- Polymorphic tagging
+- Custom index columns, searchable fields, scopes
+- Generator: `rails generate railspress:entity Project title:string description:text`
+
+### Blocks
+
+The copy and images on your site itself. Your homepage hero headline, an "About Us" blurb, a call-to-action, a footer tagline — the content that normally lives hardcoded in templates and requires a developer to change.
+
+Blocks are organized into **groups** (e.g., "Homepage Hero", "Contact Info") and each block is either text or an image. You reference them in your views and they become editable in the admin — or inline, right on the page.
+
+- Chainable Ruby API: `Railspress::CMS.find("Hero").load("headline").value`
+- View helpers: `cms_value("Hero", "headline")` and `cms_element("Hero", "headline")`
+- Inline editing — right-click any `cms_element` in the frontend to edit in place
+- Auto-versioning with full audit trail
+- Required blocks that can't be accidentally deleted
+- Image blocks with upload, hints, and focal points
+- Export/import block groups as ZIP
+
+### Why all three?
+
+Most content doesn't fit neatly into "blog posts." A portfolio piece isn't a post. A homepage headline isn't a post. RailsPress gives you the right tool for each kind of content instead of forcing everything through one model.
+
+## Features
+
+**Admin Interface**
+- Dashboard with content stats and recent activity
+- Full CRUD for posts, categories, tags, block groups, blocks, and entities
+- Drag-and-drop image uploads with progress
+- Collapsible sidebar, responsive design
+- Vanilla CSS with BEM naming (`rp-` prefix) — no framework dependencies
+
+**Developer Experience**
+- Focal point image concern for any model: `focal_point_image :cover_photo`
+- CSS variable theming
+- Generators for installation and custom entities
 
 ## Requirements
 
-- Rails 8.0+
+- Rails 8.1+
 - Ruby 3.3+
-- ActionText (for rich text)
-- Active Storage (for image uploads)
+- ActionText
+- Active Storage
 
 ## Installation
 
+Ensure ActionText and Active Storage are installed:
+
+```bash
+rails action_text:install
+rails active_storage:install
+```
+
 Add to your Gemfile:
 
 ```ruby
-gem "railspress"
+gem "railspress-engine"
 ```
 
-Install the gem and copy migrations:
+Run the install generator:
 
 ```bash
 bundle install
-rails railspress:install:migrations
+rails generate railspress:install
 rails db:migrate
 ```
 
-Mount the engine in your routes:
+Mount the engine (the install generator does this automatically):
 
 ```ruby
 # config/routes.rb
 Rails.application.routes.draw do
-  mount Railspress::Engine => "/blog", as: :railspress
+  mount Railspress::Engine => "/railspress"
 end
 ```
 
-## Usage
+## Authentication
 
-Access the admin interface at `/blog/admin`.
+The admin interface is publicly accessible by default. Add authentication before deploying:
 
-From there you can:
-- Create and manage blog posts with rich text content
-- Organize posts with categories
-- Tag posts (enter tags as comma-separated values)
-- Save posts as drafts or publish them
+```ruby
+# app/controllers/application_controller.rb
+class ApplicationController < ActionController::Base
+  before_action :authenticate_user!, if: :railspress_admin?
 
-## Development
+  private
+
+  def railspress_admin?
+    request.path.start_with?("/railspress/admin")
+  end
+end
+```
+
+See [CONFIGURING.md](docs/CONFIGURING.md) for more authentication patterns including Devise integration.
+
+## Quick Start
+
+Access the admin at `/railspress/admin`. From there you can manage posts, entities, and blocks.
+
+### Posts
+
+Create posts with rich text, categories, tags, and header images. Build your own frontend controllers and views — see the [Blogging guide](docs/BLOGGING.md).
 
-After checking out the repo:
+### Entities
+
+Generate a model and register it:
+
+```bash
+rails generate railspress:entity Project title:string client:string description:text
+```
+
+```ruby
+class Project < ApplicationRecord
+  include Railspress::Entity
+
+  railspress_config do |c|
+    c.admin_title = "Projects"
+    c.searchable_columns = [:title, :client]
+  end
+end
+```
+
+It now has a full admin interface at `/railspress/admin/entities/projects`. See the [Entity System guide](docs/ENTITIES.md).
+
+### Blocks
+
+Set up inline editing for admins:
+
+```ruby
+# config/initializers/railspress.rb
+Railspress.configure do |config|
+  config.inline_editing_check = ->(ctx) { ctx.current_user&.admin? }
+end
+```
+
+Reference blocks in your views:
+
+```erb
+<%# Raw value (no editing wrapper) %>
+<h1><%= cms_value("Homepage", "headline") %></h1>
+
+<%# With inline editing (admins can right-click to edit in place) %>
+<h1><%= cms_element("Homepage", "headline") %></h1>
+
+<p><%= cms_element("Homepage", "subheadline") %></p>
+<%= image_tag cms_value("Homepage", "hero_image"), alt: "Hero" %>
+```
+
+Create the "Homepage" group and its blocks in the admin at `/railspress/admin/content_groups`. See the [Inline Editing guide](docs/INLINE_EDITING.md).
+
+## Generators
+
+```bash
+rails generate railspress:install                    # Full setup
+rails generate railspress:entity Project title:string # Add a managed entity
+```
+
+## Documentation
+
+**Posts, Entities, and Blocks:**
+
+| Guide | Description |
+|-------|-------------|
+| [Building a Blog](docs/BLOGGING.md) | Frontend views, RSS, SEO for posts |
+| [Entity System](docs/ENTITIES.md) | Structured content pages (portfolios, case studies, etc.) |
+| [Blocks & Inline Editing](docs/INLINE_EDITING.md) | Editable site copy and images |
+
+**Everything else:**
+
+| Guide | Description |
+|-------|-------------|
+| [Reference](docs/README.md) | Models, routes, and API reference |
+| [Configuring](docs/CONFIGURING.md) | Authors, images, inline editing, and all options |
+| [Image Focal Points](docs/image-focal-point-system.md) | Smart cropping with focal points |
+| [Import/Export](docs/IMPORT_EXPORT.md) | Bulk operations for posts and CMS content |
+| [Theming](docs/THEMING.md) | CSS variable customization |
+| [Admin Helpers](docs/ADMIN_HELPERS.md) | View helper reference |
+| [Troubleshooting](docs/TROUBLESHOOTING.md) | Common issues |
+| [Upgrading](docs/UPGRADING.md) | Version upgrades and migrations |
+| [Changelog](CHANGELOG.md) | Version history |
+
+## Development
 
 ```bash
 bundle install
@@ -64,4 +230,8 @@ bundle exec rspec
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+Available as open source under the terms of the [O'Saasy License](https://osaasy.dev/).
+
+## Trademarks
+
+The Rails trademarks are the intellectual property of David Heinemeier Hansson, and exclusively licensed to the Rails Foundation. Uses of "Rails" and "Ruby on Rails" in this project are for identification purposes only and do not imply an endorsement by or affiliation with Rails, the trademark owner, or the Rails Foundation.

data/app/assets/javascripts/railspress/admin.js

@@ -6,6 +6,44 @@
 (function() {
   'use strict';
 
+  // ============================================
+  // Sidebar Collapse Toggle
+  // ============================================
+
+  function initSidebarCollapse() {
+    var sidebar = document.querySelector('.rp-sidebar');
+    var layout = document.querySelector('.rp-admin-layout');
+    var toggle = document.querySelector('.rp-sidebar-toggle');
+
+    if (!sidebar || !toggle || !layout) return;
+
+    var STORAGE_KEY = 'rp-sidebar-collapsed';
+
+    function isCollapsed() {
+      return localStorage.getItem(STORAGE_KEY) === 'true';
+    }
+
+    function setCollapsed(collapsed) {
+      if (collapsed) {
+        sidebar.classList.add('rp-sidebar--collapsed');
+        layout.classList.add('rp-admin-layout--sidebar-collapsed');
+      } else {
+        sidebar.classList.remove('rp-sidebar--collapsed');
+        layout.classList.remove('rp-admin-layout--sidebar-collapsed');
+      }
+      localStorage.setItem(STORAGE_KEY, collapsed ? 'true' : 'false');
+    }
+
+    // Restore state on load
+    if (isCollapsed()) {
+      setCollapsed(true);
+    }
+
+    toggle.addEventListener('click', function() {
+      setCollapsed(!sidebar.classList.contains('rp-sidebar--collapsed'));
+    });
+  }
+
   // ============================================
   // Mobile Menu Toggle
   // ============================================
@@ -194,6 +232,7 @@
   // ============================================
 
   function init() {
+    initSidebarCollapse();
     initMobileMenu();
     initSlugGenerator();
     initDeleteConfirmation();