cafe_car 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8d0f3cafde61c20c26c71051639e723c59aa9a9c1e6d3e8ad33b3a7d97aec8d
-  data.tar.gz: 315d84333c1c9a7bfe90b4ea7e58911cc5c3da3012f54ce942075f12863098ef
+  metadata.gz: fdfdd44f9f4f564e6fe25b17a694b0dd6dce990efdc30990d0cef474a98cc718
+  data.tar.gz: e483b2317f3a39b3b7c57b9c44bd20e3e766376f4889551bdc8ed199b8e6db52
 SHA512:
-  metadata.gz: 390d873729793c6dd8ec53988a0d6fe68eefa31bebd5df7999a7faf1ab16d46d50cd14f35afe6d671e56c774d0a2366526fbe9f4f631139a85e076e1da789e46
-  data.tar.gz: 4dc107cbc55e13033fbb5b7b9e55c50672ffa4ebe6eb8de23c6a523af0026ff4465207519e1bd250eb1958d50b379a70c4e308cd2ae8cbf6cb86b4a071aa6c3e
+  metadata.gz: daba4f7613586a3ff4f74e952800d3738965afafb81fbf1bfe82eec4b3ae5363c99d7aa879c1d3be438ff1ecdbf18d37d071307072487a1d2fb434dbfa3a6b62
+  data.tar.gz: '051968fadd32602c6b8884443200f030aeae9bcecb731c602161b854f0222e8197b65d568eadce9e1c45175cc66b64fab899d74f5df367df856f7c39e29bc8eb'

data/README.md

@@ -1,24 +1,36 @@
 # CafeCar
 
-CafeCar is a Rails engine that extends the MVC "view" layer to provide automatic CRUD UI generation with sensible defaults. Its philosophy is rooted in the idea that Rails should render _something_ that represents the CRUD operations of your models by default. These defaults can then be expanded or overridden on either an application-wide or model-specific basis.
+[![CI](https://img.shields.io/github/actions/workflow/status/craft-concept/cafe_car/ci.yml?branch=main&label=CI)](https://github.com/craft-concept/cafe_car/actions/workflows/ci.yml)
+[![Gem Version](https://img.shields.io/gem/v/cafe_car)](https://rubygems.org/gems/cafe_car)
+[![License: MIT](https://img.shields.io/badge/license-MIT-green)](https://opensource.org/licenses/MIT)
+
+CafeCar is a Rails engine that extends the MVC "view" layer to provide automatic
+CRUD UI generation with sensible defaults. Its philosophy is rooted in the idea
+that Rails should render _something_ that represents the CRUD operations of your
+models by default. These defaults can then be expanded or overridden on either
+an application-wide or model-specific basis.
 
 **Perfect for**: Admin panels, internal tools, and rapid prototyping.
 
 ## Features
 
-- 🚀 **Auto-generated CRUD interfaces** - One line of code generates complete index, show, new, edit views
-- 🎨 **Component-based UI system** - Flexible, composable components for building interfaces
-- 🔐 **Built-in authorization** - Pundit integration for attribute-level permissions
+- 🚀 **Auto-generated CRUD interfaces** - One line of code generates complete
+  index, show, new, edit views
+- 🎨 **Component-based UI system** - Flexible, composable components for
+  building interfaces
+- 🔐 **Built-in authorization** - Pundit integration for attribute-level
+  permissions
 - 📊 **Smart presenters** - Automatic type-aware display of your data
-- 🔍 **Advanced filtering** - Range queries, comparison operators, and association filters
+- 🔍 **Advanced filtering** - Range queries, comparison operators, and
+  association filters
 - 📄 **Pagination & sorting** - Kaminari integration with sortable columns
 - ⚡ **Hotwire ready** - Turbo Streams support out of the box
 - 📝 **Intelligent forms** - Auto-generated forms with smart field detection
 
 ## Prerequisites
 
-- Rails 7.0+
-- Ruby 3.0+
+- Ruby 3.3+ (developed and tested against 3.3.5)
+- Rails 8.0+ (developed and tested against Rails 8.1)
 
 ## Installation
 
@@ -41,23 +53,28 @@ $ rails generate cafe_car:install
 ```
 
 This will:
-- Add required dependencies (bcrypt, paper_trail, factory_bot_rails, faker, rouge)
+
+- Add required gems (cnc, bcrypt, paper_trail, factory_bot_rails, faker, rouge)
+  plus development tools (hotwire-livereload, better_errors, binding_of_caller,
+  chrome_devtools_rails, i18n-debug)
 - Mount the CafeCar engine at `/` under the `:admin` namespace
 - Create `app/policies/application_policy.rb`
 - Add `CafeCar::Controller` to your `ApplicationController`
-- Set up JavaScript imports for Trix and ActionText
+- Set up JavaScript imports for CafeCar, Trix, and ActionText
 
 ## Getting Started
 
 ### Quick Start: Generate a Complete Resource
 
-The fastest way to get started is to generate a complete resource (model + controller + policy):
+The fastest way to get started is to generate a complete resource (model +
+controller + policy):
 
 ```bash
 $ rails generate cafe_car:resource Product name:string price:decimal description:text
 ```
 
 This creates:
+
 - Migration and model (`app/models/product.rb`)
 - Controller with CRUD actions (`app/controllers/products_controller.rb`)
 - Policy with permission methods (`app/policies/product_policy.rb`)
@@ -79,11 +96,12 @@ You can also add CafeCar to existing resources:
 
 ```ruby
 class ProductsController < ApplicationController
-  recline_in_the_cafe_car
+  cafe_car
 end
 ```
 
 That single line provides:
+
 - All 7 RESTful actions (index, show, new, create, edit, update, destroy)
 - Automatic authorization via Pundit
 - Filtering and sorting
@@ -113,17 +131,19 @@ The policy controls both authorization and which attributes can be edited.
 
 ### Controllers
 
-The `CafeCar::Controller` module provides automatic CRUD functionality with the `recline_in_the_cafe_car` class method.
+The `CafeCar::Controller` module provides automatic CRUD functionality with the
+`cafe_car` class method.
 
 ```ruby
 class Admin::ClientsController < ApplicationController
-  recline_in_the_cafe_car
+  cafe_car
 end
 ```
 
 **What you get:**
 
-- **RESTful actions**: `index`, `show`, `new`, `edit`, `create`, `update`, `destroy`
+- **RESTful actions**: `index`, `show`, `new`, `edit`, `create`, `update`,
+  `destroy`
 - **Authorization**: Automatic `authorize!` before each action
 - **Smart defaults**: Model detection from controller name
 - **Callbacks**: Lifecycle hooks for `render`, `update`, `create`, `destroy`
@@ -132,9 +152,9 @@ end
 **Limiting actions:**
 
 ```ruby
-recline_in_the_cafe_car only: [:index, :show]
+cafe_car only: [:index, :show]
 # or
-recline_in_the_cafe_car except: [:destroy]
+cafe_car except: [:destroy]
 ```
 
 **Custom model:**
@@ -142,7 +162,7 @@ recline_in_the_cafe_car except: [:destroy]
 ```ruby
 class Admin::ClientsController < ApplicationController
   model Company  # Use Company model instead of Client
-  recline_in_the_cafe_car
+  cafe_car
 end
 ```
 
@@ -150,8 +170,8 @@ end
 
 ```ruby
 class ProductsController < ApplicationController
-  recline_in_the_cafe_car
-  
+  cafe_car
+
   set_callback :create, :after do |controller|
     NotificationMailer.product_created(controller.object).deliver_later
   end
@@ -160,7 +180,8 @@ end
 
 ### Policies
 
-CafeCar extends Pundit with attribute-level permissions and auto-detection of displayable fields.
+CafeCar extends Pundit with attribute-level permissions and auto-detection of
+displayable fields.
 
 ```ruby
 class ClientPolicy < ApplicationPolicy
@@ -185,9 +206,11 @@ end
 **Key methods:**
 
 - `permitted_attributes` - Attributes that can be edited via forms
-- `displayable_attributes` - Attributes shown in views (auto-detected from columns + associations)
+- `displayable_attributes` - Attributes shown in views (auto-detected from
+  columns + associations)
 - `displayable_associations` - Associations that can be displayed
-- `filtered_attribute?(attr)` - Check if attribute should be hidden (uses Rails parameter filters)
+- `filtered_attribute?(attr)` - Check if attribute should be hidden (uses Rails
+  parameter filters)
 
 **Scope pattern:**
 
@@ -203,7 +226,8 @@ end
 
 ### Presenters
 
-Presenters convert model objects into view-ready representations with automatic type detection.
+Presenters convert model objects into view-ready representations with automatic
+type detection.
 
 **Automatic usage** (in views):
 
@@ -212,6 +236,7 @@ Presenters convert model objects into view-ready representations with automatic
 ```
 
 This automatically:
+
 1. Finds the appropriate presenter for the object type
 2. Checks policy permissions
 3. Renders displayable attributes
@@ -227,14 +252,14 @@ class ProductPresenter < CafeCar::Presenter
   show :description
   show :category
   show :created_at
-  
+
   # Custom display method
   def preview
     "#{name} - #{format_currency(price)}"
   end
-  
+
   private
-  
+
   def format_currency(amount)
     "$#{amount}"
   end
@@ -349,7 +374,7 @@ The form builder automatically detects field types:
   <%= f.field(:price).label %>
   <%= f.field(:price).input class: "currency" %>
   <%= f.field(:price).hint "In USD" %>
-  <%= f.field(:price).errors %>
+  <%= f.field(:price).error %>
 <% end %>
 ```
 
@@ -397,17 +422,19 @@ end
 ```
 
 The model gets:
+
 - `sorted(*keys)` - Parse and apply sort parameters
-- `normalized_sort_key()` - Convert sort keys to Arel format
+- `normalize_sort_key(key)` - Internal helper that converts a sort key to Arel
+  order format
 
 **Custom filters in controllers:**
 
 ```ruby
 class ProductsController < ApplicationController
-  recline_in_the_cafe_car
-  
+  cafe_car
+
   private
-  
+
   def find_objects
     @objects = model.where(active: true)
                     .query(filter_params)
@@ -431,16 +458,17 @@ app/views/
     _form.html.haml    # Override form partial
 ```
 
-CafeCar's default views are in `app/views/cafe_car/application/` and serve as templates.
+CafeCar's default views are in `app/views/cafe_car/application/` and serve as
+templates.
 
 ### Custom Responders
 
 ```ruby
 class ProductsController < ApplicationController
-  recline_in_the_cafe_car
-  
+  cafe_car
+
   private
-  
+
   def create
     super
     respond_with object, location: custom_path
@@ -477,7 +505,78 @@ CafeCar::Current.user_agent     # User agent string
 CafeCar::Current.ip_address     # IP address
 ```
 
-Set in controllers via `set_current_attributes` (automatically called by `recline_in_the_cafe_car`).
+Set in controllers via `set_current_attributes` (automatically called by
+`cafe_car`).
+
+## Sessions & Authentication
+
+Sessions are **opt-in**. CafeCar works for plain CRUD with no login at all: when
+a policy denies access and no sessions infrastructure is present, the request
+gets a plain **403 Forbidden** instead of redirecting to a login page that
+doesn't exist. Authorization (Pundit policies) is always on; *authentication*
+(knowing who the user is) is the part you turn on when you want it.
+
+### Enabling sessions
+
+1. **Run the generator** to add the `sessions` table:
+
+   ```bash
+   $ rails generate cafe_car:sessions
+   $ rails db:migrate
+   ```
+
+   The `CafeCar::Session` model and `SessionPolicy` ship with the engine, so the
+   generator only creates the migration (columns: `user`, `ip_address`,
+   `user_agent`).
+
+2. **Expose the routes.** Mounting the engine already provides them. To expose
+   login at the top level without mounting, add to `config/routes.rb`:
+
+   ```ruby
+   resource :session, only: %i[new create destroy], controller: "cafe_car/sessions"
+   ```
+
+   This gives you `new_session_path` (login form) and `session_path` (create via
+   `POST`, log out via `DELETE`).
+
+3. **Prepare your user model.** It needs `has_secure_password` and an `email`:
+
+   ```ruby
+   class User < ApplicationRecord
+     has_secure_password
+     has_many :sessions, dependent: :destroy, class_name: "CafeCar::Session"
+   end
+   ```
+
+4. **Different user model name?** Set it in an initializer (resolved lazily):
+
+   ```ruby
+   # config/initializers/cafe_car.rb
+   CafeCar.user_class_name = "Account"
+   ```
+
+Once sessions are available, an authorization failure for a signed-out visitor
+redirects to the login form (remembering where they were headed) instead of
+returning 403.
+
+### Helpers
+
+These are available in controllers and views:
+
+- `authenticated?` - truthy when someone is logged in
+- `current_user` - the logged-in user (or `nil`)
+- `current_session` - the current `CafeCar::Session`
+
+```erb
+<% if authenticated? %>
+  Signed in as <%= current_user.email %>
+<% else %>
+  <%= link_to "Log in", new_session_path %>
+<% end %>
+```
+
+Logging in (`POST /session` with `session[:email]`/`session[:password]`) sets a
+signed, http-only cookie; logging out (`DELETE /session`) clears it.
 
 ## Generators
 
@@ -514,10 +613,22 @@ $ rails generate cafe_car:notes
 ```
 
 Creates:
+
 - Migration for notes table
 - `Note` model
 - `Notable` concern for trackable models
 
+### Sessions Generator
+
+Enable opt-in login/logout (see [Sessions & Authentication](#sessions--authentication)):
+
+```bash
+$ rails generate cafe_car:sessions
+```
+
+Creates the `sessions` table migration. The `CafeCar::Session` model and
+`SessionPolicy` already ship with the engine.
+
 ## Configuration
 
 ### Custom Form Builder
@@ -539,7 +650,7 @@ class ApplicationPresenter < CafeCar::Presenter
   # Application-wide presenter customizations
 end
 
-# app/presenters/product_presenter.rb  
+# app/presenters/product_presenter.rb
 class ProductPresenter < ApplicationPresenter
   show :name
   show :price
@@ -568,7 +679,7 @@ class ProductsControllerTest < ActionDispatch::IntegrationTest
     get products_url
     assert_response :success
   end
-  
+
   test "create with valid attributes" do
     assert_difference "Product.count", 1 do
       post products_url, params: { product: { name: "Widget" } }
@@ -580,8 +691,12 @@ end
 
 ## Contributing
 
-Contributions are welcome! Please feel free to submit a Pull Request.
+Contributions are welcome! Please read [CONTRIBUTING.md](CONTRIBUTING.md) for
+development setup, how to run the tests (`bundle exec rake`), and PR expectations.
+By participating you agree to the [Code of Conduct](CODE_OF_CONDUCT.md). To report a
+security issue, see [SECURITY.md](SECURITY.md).
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -10,7 +10,15 @@ RuboCop::RakeTask.new
 
 task :brakeman do
   require "brakeman"
-  Brakeman.run app_path: ".", print_report: true
+  Brakeman.run app_path: ".", print_report: true, pager: false
+end
+
+task :test do
+  Rails::TestUnit::Runner.run_from_rake("test")
 end
 
 task default: %i[rubocop test brakeman]
+
+# Holdco backlog machinery (tasks:new, tasks:index, tasks:claim, tasks:done, rake task).
+# Loads every .rake under lib/tasks/ so the gem's own tasks and holdco_tasks both run.
+Dir.glob(File.expand_path("lib/tasks/*.rake", __dir__)).sort.each { |f| load f }

data/app/assets/fonts/Lexend.css

@@ -0,0 +1,7 @@
+@font-face {
+	font-family: 'Lexend';
+	font-style: normal;
+	font-weight: 100 900;
+	src: url('./Lexend.ttf') format('truetype');
+	/* size-adjust: 122%; */
+}

data/app/assets/stylesheets/cafe_car/themes/defaults.css

@@ -1,61 +1,60 @@
 :root {
-    color-scheme: light dark;
-    accent-color: var(--accent);
-    scroll-behavior: smooth;
-
-    --blue: blue;
-    --green: green;
-    --orange: orange;
-    --red: red;
-
-    --white: white;
-    --gray: #eee;
-    --black: black;
-
-    --accent: var(--blue);
-    --primary: var(--accent);
-    --secondary: var(--accent);
-    --tertiary: var(--accent);
-
-    --success: var(--green);
-    --warning: var(--orange);
-    --danger: var(--red);
-    --error: var(--red);
-    --info: var(--blue);
-
-    --link: var(--accent);
-    --card: var(--white);
-    --button: var(--gray);
-    --menu: var(--card);
-
-    --shadow: rgb(50 50 93 / .25);
-    --backdrop: rgb(0 0 0 / .5);
-
-    --hover: rgb(50 50 93 / .03);
-    --outline: var(--accent);
-    --invalid: color-mix(in lab, var(--error) 3%, var(--input));
-    --selection: color-mix(in lab, var(--accent) 25%, transparent);
-
-    --font-family: ui-sans-serif, -apple-system, menu, sans-serif;
-    --font: 16px var(--font-family);
-
-    --box-shadow: var(--shadow) 0 2px 5px -1px,
-                  var(--shadow) 0 1px 3px -1px;
-    --inset-shadow: inset var(--shadow) 0 1px 3px -1px;
-
-    --gap: 1rem;
-    --indent: 0;
-    --half-gap: calc(var(--gap) / 2);
-    --third-gap: calc(var(--gap) / 3);
-    --gap2: calc(var(--gap) * 2);
-    --radius: 12px;
-    --menu-radius: calc(var(--radius) / 2);
-    --control-radius: calc(var(--radius) / 3);
-
-    --max-width: 720px;
-    --page-width: 1024px;
-    --aside-width: 20vw;
-    --modal-width: 720px;
-
-    --duration: 300ms;
+  color-scheme: light dark;
+  accent-color: var(--accent);
+  scroll-behavior: smooth;
+
+  --blue: blue;
+  --green: green;
+  --orange: orange;
+  --red: red;
+
+  --white: white;
+  --gray: #eee;
+  --black: black;
+
+  --accent: var(--blue);
+  --primary: var(--accent);
+  --secondary: var(--accent);
+  --tertiary: var(--accent);
+
+  --success: var(--green);
+  --warning: var(--orange);
+  --danger: var(--red);
+  --error: var(--red);
+  --info: var(--blue);
+
+  --link: var(--accent);
+  --card: var(--white);
+  --button: var(--gray);
+  --menu: var(--card);
+
+  --shadow: rgb(50 50 93 / 0.25);
+  --backdrop: rgb(0 0 0 / 0.5);
+
+  --hover: rgb(50 50 93 / 0.03);
+  --outline: var(--accent);
+  --invalid: color-mix(in lab, var(--error) 3%, var(--input));
+  --selection: color-mix(in lab, var(--accent) 25%, transparent);
+
+  --font-family: ui-sans-serif, -apple-system, menu, sans-serif;
+  --font: 16px var(--font-family);
+
+  --box-shadow: var(--shadow) 0 2px 5px -1px, var(--shadow) 0 1px 3px -1px;
+  --inset-shadow: inset var(--shadow) 0 1px 3px -1px;
+
+  --gap: 1rem;
+  --indent: 0;
+  --half-gap: calc(var(--gap) / 2);
+  --third-gap: calc(var(--gap) / 3);
+  --gap2: calc(var(--gap) * 2);
+  --radius: 12px;
+  --menu-radius: calc(var(--radius) / 2);
+  --control-radius: calc(var(--radius) / 3);
+
+  --max-width: 720px;
+  --page-width: 1024px;
+  --aside-width: 20vw;
+  --modal-width: 720px;
+
+  --duration: 100ms;
 }

data/app/assets/stylesheets/cafe_car/tooltips.css

@@ -0,0 +1,20 @@
+[data-tip]:not(:has([data-tip]:hover)):hover {
+  &::before {
+    content: attr(data-tip, attr(title));
+    position: fixed;
+    display: block;
+
+    position-anchor: auto;
+    position-area: top;
+    position-try-fallbacks: flip-block;
+
+    z-index: 99;
+    background: var(--tooltip, rgb(0 0 0 / 0.8));
+    font-size: 0.8rem;
+    color: var(--white, white);
+    padding: 0.25rem 0.5rem;
+    max-width: 80%;
+    white-space: wrap;
+    border-radius: var(--control-radius);
+  }
+}

data/app/assets/stylesheets/cafe_car/utility.css

@@ -7,9 +7,8 @@
 }
 
 .remove {
-    /*animation: fade-out 100ms;*/
     opacity: 0;
-    transition: opacity 0.1s;
+    transition: all var(--duration);
     pointer-events: none;
 }
 

data/app/assets/stylesheets/cafe_car.css

@@ -7,8 +7,10 @@
 @import url(cafe_car/trix.css);
 
 @import url(cafe_car/pagination.css);
+@import url(cafe_car/tooltips.css);
 @import url(cafe_car/utility.css);
 @import url(ui/components.css);
+@import url(Lexend.css);
 @import url(cafe_car/themes/warm.css);
 @import url(cafe_car/themes/warm-dark.css) (prefers-color-scheme: dark);
 
@@ -16,7 +18,7 @@
 @import url(cafe_car/code/base16-dark.css) (prefers-color-scheme: dark);
 
 :root {
-  --half-gap: calc(var(--gap) / 2);
+  --font-family: Lexend, ui-sans-serif, -apple-system, menu, sans-serif;
 }
 
 :focus {
@@ -33,7 +35,7 @@ a {
   }
 
   &:active {
-    filter: brightness(.95);
+    filter: brightness(0.95);
   }
 }
 
@@ -53,20 +55,29 @@ body {
   background-blend-mode: soft-light; */
   font: var(--font);
   margin: 0;
-  min-height: 100vh;
+  min-height: 100dvh;
+  display: flex;
+  flex-flow: column;
+
+  > * {
+    flex: 1;
+  }
 }
 
-h1, h2, h4, h5, h6, p {
+h1,
+h2,
+h4,
+h5,
+h6,
+p {
   margin-left: var(--indent);
 }
 
 time {
   text-decoration: dotted underline;
   text-decoration-color: var(--dim);
-  cursor: default;
 }
 
-
 html[data-turbo-visit-direction="forward"]::view-transition-group(root),
 html[data-turbo-visit-direction="back"]::view-transition-group(root) {
   animation: none;

data/app/assets/stylesheets/ui/Alert.css

@@ -15,7 +15,8 @@
   --color: var(--error);
 }
 
-.Alert-info {
+.Alert-info,
+.Alert-notice {
   --color: var(--info);
 }