b4um_generators 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c28062a0ee906885d252d4f10519103efd322fb0b4543f4e2c50583e806cb8eb
-  data.tar.gz: 914c0f060ab2e9f27ab11441f66c822696c7d2c928038880fb2c31f2c6113546
+  metadata.gz: 32be49cb4a38e8c75eba464939aa99d73d45784f0434d3aa75f0b4d7fd57862f
+  data.tar.gz: a3af1d5dcb53dd3aa945f92f05ec84bdb271c0a6ffc14fb1c99c96232d7a6407
 SHA512:
-  metadata.gz: 8f0e80c477c65da9362ea6bff1c23760d620a639e40cda8ab3070ff2e6389dd70cb305bce39ea837259a1ed5d5ca33273217f87f8037d607d3774b9d60ffa155
-  data.tar.gz: b94e7e85275276d551a090797bf08bccaabfe90e89ab9ed10d9b2208a1e092605eb563411fd79700b8a0e5bbf1e4042d093c3688cd9d160733daa5cf54a0b5e2
+  metadata.gz: c00cf8cab52aa8f5edf31b01ac68e948c2f8019ba2978542546be8daa79a138c40673b421c82ba5933e51553b781fbd700fcac3857d973b3da13816904e20b90
+  data.tar.gz: d9b452a787712782c27a4a02799cac27b0ee2566bb97bb8e14875fe521e89a17eb2632873a5c772385e78264abf0204a3dba696b37c830e20d911c01ae17b220

data/CHANGELOG.md

@@ -4,6 +4,33 @@ All notable changes to b4um Generators will be documented in this file.
 
 ## [Unreleased]
 
+## [0.5.0] - 2026-10-14
+
+### Added
+
+- Added complete Todo application generator with `b4um:todo`
+- Added task creation, completion, reopening and deletion
+- Added separate lists for open and completed tasks
+- Added automatic task counters and progress tracking
+- Added progress bar with completion percentage
+- Added Turbo Stream updates without full page reloads
+- Added Stimulus controller for task input handling
+- Added automatic input reset after successful task creation
+- Added responsive Todo layout with b4um cards and floating labels
+- Added light and dark mode support for Todo components
+- Added optional `--owner=MODEL` support for personal Todo lists
+- Added integration with b4um authentication and current account helpers
+- Added owner-specific task access protection
+- Added HTTP 401 responses for unauthenticated owner-specific Todo requests
+- Added 35 RSpec examples for the Todo generator
+
+### Changed
+
+- Extended `b4um:help` with Todo generator documentation
+- Extended Help generator RSpec coverage for Todo
+- Updated English and German README documentation
+- Updated the generator overview to include `b4um:todo`
+
 ## [0.4.2] - 2026-10-13
 
 ### Fixed

data/README.de.md

@@ -6,8 +6,8 @@ b4um Generators ist eine Sammlung wiederverwendbarer Rails-Generatoren, Template
 für b4um-Rails-Projekte.
 
 Das Gem bietet eine einheitliche Grundlage für Rails-Anwendungen und enthält Generatoren für Scaffolds, Controller,
-Bento-Layouts, Tabellen, Pagination, Infinite Scroll, Suche, Kommentare, Authentifizierung, Administration, Gastzugänge,
-Attachments und Rich-Text-Bearbeitung.
+Bento-Layouts, Tabellen, Pagination, Infinite Scroll, Suche, Sortierung, Todo-Listen, Kommentare, Authentifizierung,
+Administration, Gastzugänge, Attachments und Rich-Text-Bearbeitung.
 
 Die generierten Komponenten verwenden ein gemeinsames b4um-Styling und sind darauf ausgelegt, miteinander zu
 funktionieren.
@@ -24,7 +24,7 @@ b4um Generators wird während der Entwicklung derzeit als lokales Gem verwendet.
 Füge das Gem zur `Gemfile` der Rails-Anwendung hinzu:
 
 ```ruby
-gem "b4um_generators", "~> 0.4.2", path: "/pfad/zu/b4um_generators"
+gem "b4um_generators", "~> 0.5.0", path: "/pfad/zu/b4um_generators"
 ```
 
 Führe anschließend aus:
@@ -82,6 +82,7 @@ b4um:pagination
 b4um:infinite_scroll
 b4um:search
 b4um:sortable
+b4um:todo
 b4um:comments
 b4um:in_place
 b4um:authentication
@@ -1146,6 +1147,119 @@ Dadurch entstehen entsprechend `/produktuebersicht`, `/verwaltung` und `/admin`.
 Eine separate Sortierseite ermöglicht außerdem, nur die `sort`-Action durch die Authentifizierung zu schützen, während
 der normale Ressourcen-Index öffentlich bleiben kann.
 
+## Todo
+
+Erzeuge eine vollständige Todo-Anwendung mit Turbo Streams, Stimulus und dem einheitlichen b4um-Styling:
+
+```bash
+bin/rails generate b4um:todo Task
+bin/rails db:migrate
+```
+
+Der Generator erstellt eine sofort verwendbare Aufgabenliste, ohne dass ein zusätzliches Todo-Gem erforderlich ist.
+
+Standardmäßig werden Aufgaben gemeinsam innerhalb der Anwendung verwaltet und sind keinem einzelnen Benutzer zugeordnet.
+
+Die generierte Todo-Anwendung ist erreichbar unter:
+
+```text
+/tasks
+```
+
+### Funktionen
+
+Der Todo-Generator bietet:
+
+- Neue Aufgaben erstellen
+- Aufgaben als erledigt markieren
+- Erledigte Aufgaben wieder öffnen
+- Aufgaben löschen
+- Getrennte Listen für offene und erledigte Aufgaben
+- Automatische Aufgabenzähler
+- Fortschrittsbalken mit prozentualer Anzeige
+- Aktualisierungen mit Turbo Streams ohne vollständiges Neuladen der Seite
+- Stimulus-Controller für die Aufgabeneingabe
+- Automatisches Zurücksetzen des Eingabefeldes nach erfolgreicher Erstellung
+- b4um Floating Labels
+- Responsives b4um-Kartenlayout
+- Unterstützung für Light Mode und Dark Mode
+- Optionale Zuordnung zu einem Benutzerkonto
+- Zugriffsschutz für benutzerspezifische Aufgaben
+
+### Persönliche Todo-Listen
+
+Todo-Listen können optional einem Authentifizierungsmodell zugeordnet werden.
+
+Mit `--owner` werden Aufgaben einzelnen Benutzern zugewiesen:
+
+```bash
+bin/rails generate b4um:todo Task --owner=User
+bin/rails db:migrate
+```
+
+Das angegebene Benutzer- beziehungsweise Eigentümermodell muss bereits existieren.
+
+Wird ein Eigentümermodell angegeben, erhält jedes angemeldete Benutzerkonto seine eigene Todo-Liste.
+
+Die Aufgaben werden über die Verknüpfung des aktuell angemeldeten Kontos geladen. Dadurch können Benutzer nicht auf
+Aufgaben anderer Konten zugreifen.
+
+Nicht authentifizierte Anfragen an benutzerspezifische Todo-Aktionen erhalten den HTTP-Status `401 Unauthorized`.
+
+### Integration mit der Authentifizierung
+
+Der Todo-Generator arbeitet mit dem bestehenden b4um-Authentifizierungssystem zusammen.
+
+Ein vollständiges Beispiel:
+
+```bash
+bin/rails generate b4um:scaffold User name:string email:string password_digest:string
+bin/rails db:migrate
+
+bin/rails generate b4um:authentication User
+
+bin/rails generate b4um:todo Task --owner=User
+bin/rails db:migrate
+```
+
+Die Passwort-Authentifizierung benötigt bcrypt. Dieses kann über `b4um:install` installiert werden.
+
+Die Option `--owner` unterstützt auch andere Authentifizierungsmodelle:
+
+```bash
+bin/rails generate b4um:todo Task --owner=Member
+bin/rails generate b4um:todo Task --owner=Customer
+```
+
+Der generierte Controller verwendet automatisch den zum Modell passenden Helper für das aktuell angemeldete Konto:
+
+```ruby
+current_user
+current_member
+current_customer
+```
+
+### Generierte Dateien
+
+Für das standardmäßige `Task`-Modell erstellt der Generator folgende Komponenten:
+
+- Task-Modell und Datenbankmigration
+- Tasks-Controller
+- Ressourcen-Routen
+- Todo-Index-View
+- Task-Partial
+- Fortschritts-Partial
+- Todo-Stylesheet
+- Stimulus-Controller
+
+Nach dem Generieren muss die Datenbankmigration ausgeführt werden:
+
+```bash
+bin/rails db:migrate
+```
+
+Anschließend kann die Todo-Anwendung verwendet werden.
+
 ## Kommentare
 
 Füge einem bestehenden Modell polymorphe Kommentare hinzu:
@@ -1549,7 +1663,7 @@ wird.
 
 ## Version
 
-Aktuelle Version: `0.4.2`
+Aktuelle Version: `0.5.0`
 
 ## Autor
 

data/README.md

@@ -6,8 +6,8 @@ b4um Generators is a collection of reusable Rails generators, templates, compone
 Rails projects.
 
 The gem provides a consistent starting point for Rails applications and includes generators for scaffolds, controllers,
-Bento layouts, tables, pagination, infinite scrolling, search, sorting, comments, authentication, administrator
-management, guest access, attachments and rich-text editing.
+Bento layouts, tables, pagination, infinite scrolling, search, sorting, Todo lists, comments, authentication,
+administrator management, guest access, attachments and rich-text editing.
 
 Generated components share the same b4um styling and are designed to work together.
 
@@ -23,7 +23,7 @@ b4um Generators is currently used as a local gem during development.
 Add the gem to the Rails application's `Gemfile`:
 
 ```ruby
-gem "b4um_generators", "~> 0.4.2", path: "/path/to/b4um_generators"
+gem "b4um_generators", "~> 0.5.0", path: "/path/to/b4um_generators"
 ```
 
 Then run:
@@ -80,6 +80,7 @@ b4um:pagination
 b4um:infinite_scroll
 b4um:search
 b4um:sortable
+b4um:todo
 b4um:comments
 b4um:in_place
 b4um:authentication
@@ -1125,6 +1126,119 @@ These create `/produktuebersicht`, `/verwaltung`, and `/admin` respectively.
 Using a separate sortable page also makes it possible to protect only the `sort` action with authentication while
 keeping the regular resource index public.
 
+## Todo
+
+Generate a complete Todo application with Turbo Streams, Stimulus and b4um styling:
+
+```bash
+bin/rails generate b4um:todo Task
+bin/rails db:migrate
+```
+
+The generator creates a ready-to-use Todo list without requiring an additional Todo gem.
+
+By default, tasks are shared across the application and are not assigned to individual users.
+
+The generated Todo application is available at:
+
+```text
+/tasks
+```
+
+### Features
+
+The Todo generator provides:
+
+- Create new tasks
+- Mark tasks as completed
+- Reopen completed tasks
+- Delete tasks
+- Separate lists for open and completed tasks
+- Automatic task counters
+- Progress bar with completion percentage
+- Turbo Stream updates without full page reloads
+- Stimulus controller for task input handling
+- Automatic input reset after successful creation
+- b4um floating labels
+- Responsive b4um card layout
+- Light and dark mode support
+- Optional owner association
+- Owner-specific task access protection
+
+### Personal Todo Lists
+
+Todo lists can optionally be associated with an authentication model.
+
+Use `--owner` to assign tasks to individual users:
+
+```bash
+bin/rails generate b4um:todo Task --owner=User
+bin/rails db:migrate
+```
+
+The owner model must already exist.
+
+When an owner is configured, each authenticated account has its own Todo list.
+
+Tasks are loaded through the current owner's association, preventing users from accessing tasks belonging to another
+account.
+
+Unauthenticated requests to owner-specific Todo actions receive HTTP `401 Unauthorized`.
+
+### Authentication Integration
+
+The Todo generator integrates with the existing b4um authentication system.
+
+A complete example:
+
+```bash
+bin/rails generate b4um:scaffold User name:string email:string password_digest:string
+bin/rails db:migrate
+
+bin/rails generate b4um:authentication User
+
+bin/rails generate b4um:todo Task --owner=User
+bin/rails db:migrate
+```
+
+Password authentication requires bcrypt, which can be installed through `b4um:install`.
+
+The owner option also supports other authentication models:
+
+```bash
+bin/rails generate b4um:todo Task --owner=Member
+bin/rails generate b4um:todo Task --owner=Customer
+```
+
+The generated controller uses the corresponding current account helper:
+
+```ruby
+current_user
+current_member
+current_customer
+```
+
+### Generated Files
+
+For the default `Task` model, the generator creates the following components:
+
+- Task model and database migration
+- Tasks controller
+- Resource routes
+- Todo index view
+- Task partial
+- Progress partial
+- Todo stylesheet
+- Stimulus controller
+
+After generation, run:
+
+```bash
+bin/rails db:migrate
+```
+
+The Todo application is then ready to use.
+
 ## Comments
 
 Add polymorphic comments to an existing model:
@@ -1524,7 +1638,7 @@ The gem can be tested locally by referencing the repository with `path:` from a
 
 ## Version
 
-Current version: `0.4.2`
+Current version: `0.5.0`
 
 ## Author
 

data/lib/b4um_generators/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module B4umGenerators
-  VERSION = "0.4.2"
+  VERSION = "0.5.0"
 end

data/lib/generators/b4um/help/help_generator.rb

@@ -1172,6 +1172,95 @@ module B4um
             - Safe repeated generator runs
 
 
+          TODO
+
+            bin/rails generate b4um:todo MODEL
+
+          Generates a complete Todo application for Rails.
+
+          Example:
+
+            bin/rails generate b4um:todo Task
+            bin/rails db:migrate
+
+          By default, the Todo list is shared across the application.
+          Tasks are not assigned to individual users.
+
+          To create personal Todo lists, use --owner:
+
+            bin/rails generate b4um:todo Task --owner=User
+            bin/rails db:migrate
+
+          The owner model must already exist.
+
+          For user-specific Todo lists, b4um authentication can be
+          installed first:
+
+            bin/rails generate b4um:scaffold User name:string email:string password_digest:string
+            bin/rails db:migrate
+            bin/rails generate b4um:authentication User
+            bin/rails generate b4um:todo Task --owner=User
+            bin/rails db:migrate
+
+          The owner option supports other authentication models:
+
+            --owner=User
+            --owner=Member
+            --owner=Customer
+
+          The generated controller uses the corresponding
+          current owner helper, for example:
+
+            current_user
+            current_member
+            current_customer
+
+          With an owner, each account has its own Todo list.
+
+          Tasks are loaded through the current owner's association.
+          Users cannot access tasks belonging to another account.
+
+          Unauthenticated requests to owner-specific Todo actions
+          receive HTTP 401 Unauthorized.
+
+          Todo features:
+
+            - Create new tasks
+            - Mark tasks as completed
+            - Reopen completed tasks
+            - Delete tasks
+            - Separate lists for open and completed tasks
+            - Automatic task counters
+            - Progress bar with completion percentage
+            - Turbo Stream updates without full page reloads
+            - Stimulus controller for the task input
+            - Automatic input reset after successful creation
+            - b4um floating labels
+            - Responsive b4um card layout
+            - Light and dark mode support
+            - Optional owner association with --owner
+            - Owner-specific task access protection
+
+          The generator creates:
+
+            - Task model and database migration
+            - Tasks controller
+            - Resource routes
+            - Index view
+            - Task partial
+            - Progress partial
+            - Todo stylesheet
+            - Stimulus controller
+
+          After generating the Todo application, run:
+
+            bin/rails db:migrate
+
+          With the default Task model, the Todo list is available at:
+
+            /tasks
+
+
           COMMENTS
 
             bin/rails generate b4um:comments MODEL

data/lib/generators/b4um/install/templates/b4um/theme.css

@@ -66,6 +66,21 @@
   --b4um-hero-teaser-background: rgba(255, 255, 255, 0.55);
   --b4um-hero-teaser-text: rgba(20, 20, 20, 0.9);
   --b4um-hero-teaser-border: rgba(255, 255, 255, 0.3);
+
+  /* todo */
+  --todo-primary: var(--b4um-primary);
+
+  --todo-primary-hover: var(--b4um-primary-hover);
+
+  --todo-background: #ffffff;
+  --todo-surface: #f7f9fb;
+  --todo-border: #e5e9ee;
+
+  --todo-text: #20252b;
+  --todo-muted: #737d89;
+
+  --todo-success: #22a06b;
+  --todo-danger: #d94b4b;
 }
 
 /* -------------------------------------------------------
@@ -136,5 +151,13 @@
   --b4um-hero-teaser-text: rgba(255, 255, 255, 0.85);
   --b4um-hero-teaser-border: rgba(255, 255, 255, 0.18);
 
+  /* todo */
+  --todo-background: #28292a;
+  --todo-surface: #222426;
+  --todo-border: #414448;
+
+  --todo-text: #e3e3e3;
+  --todo-muted: #a2a8ae;
+
   color-scheme: dark;
 }

data/lib/generators/b4um/todo/templates/_progress.html.erb.tt

@@ -0,0 +1,22 @@
+<section id="todo_progress" class="b4um-todo__progress">
+  <div class="b4um-todo__progress-info">
+    <h2>Fortschritt</h2>
+
+    <span>
+      <%%= @completed_tasks %> von <%%= @total_tasks %> erledigt
+    </span>
+  </div>
+
+  <%% progress = @total_tasks.positive? ? (@completed_tasks * 100.0 / @total_tasks).round : 0 %>
+
+  <div class="b4um-todo__progress-bar">
+    <div
+      class="b4um-todo__progress-fill"
+      style="width: <%%= progress %>%"
+    ></div>
+  </div>
+
+  <p class="b4um-todo__progress-percentage">
+    <%%= progress %>% abgeschlossen
+  </p>
+</section>

data/lib/generators/b4um/todo/templates/_task.html.erb.tt

@@ -0,0 +1,42 @@
+<div id="<%%= dom_id(task) %>"
+     class="b4um-todo__item <%%= 'b4um-todo__item--complete' if task.complete? %>">
+
+  <div class="b4um-todo__item-content">
+
+    <%%= button_to <%= singular_table_name %>_path(task),
+          method: :patch,
+          class: "b4um-todo__checkbox",
+          form: { data: { turbo: true } },
+          aria: {
+            label: task.complete? ? "Als offen markieren" : "Als erledigt markieren",
+            pressed: task.complete?
+          } do %>
+
+      <span class="b4um-todo__checkbox-icon">
+        <%%= "✓" if task.complete? %>
+      </span>
+
+    <%% end %>
+
+    <span class="b4um-todo__item-name">
+      <%%= task.name %>
+    </span>
+
+  </div>
+
+  <%%= button_to <%= singular_table_name %>_path(task),
+        method: :delete,
+        class: "b4um-todo__delete",
+        form: {
+          data: {
+            turbo: true,
+            turbo_confirm: "Möchtest du diese Aufgabe wirklich löschen?"
+          }
+        },
+        aria: { label: "Aufgabe löschen" } do %>
+
+    <span aria-hidden="true">×</span>
+
+  <%% end %>
+
+</div>

data/lib/generators/b4um/todo/templates/create_tasks.rb.tt

@@ -0,0 +1,13 @@
+class Create<%= class_name.pluralize %> < ActiveRecord::Migration[<%= migration_version %>]
+  def change
+    create_table :<%= plural_table_name %> do |t|
+      t.string :name, null: false
+      t.boolean :complete, default: false, null: false
+<% if owner? %>
+      t.references :<%= owner_reference_name %>, null: false, foreign_key: true
+<% end %>
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/b4um/todo/templates/index.html.erb.tt

@@ -0,0 +1,101 @@
+<header class="b4um-todo__header">
+  <h1>Meine Aufgaben</h1>
+  <p>Behalte deine Aufgaben im Blick.</p>
+</header>
+<div class="b4um-grid">
+  <div class="b4um-card b4um-card--full">
+    <div class="b4um-todo">
+      <%%= render "progress" %>
+
+      <section class="b4um-todo__form">
+        <h2>Neue Aufgabe</h2>
+
+        <%%= form_with model: @task,
+              data: {
+                controller: "b4um-todo",
+                action: "turbo:submit-end->b4um-todo#resetAfterSuccess"
+              } do |form| %>
+
+
+          <div class="b4um-todo__form-fields">
+
+            <div class="form-field">
+              <%%= form.text_field :name,
+                    class: "form-input",
+                    placeholder: " ",
+                    required: true,
+                    autofocus: true,
+                    data: {
+                      b4um_todo_target: "input",
+                      action: "input->b4um-todo#updateSubmitState"
+                    } %>
+
+              <%%= form.label :name,
+                    "Was möchtest du erledigen?",
+                    class: "form-label" %>
+            </div>
+
+            <%%= form.submit "Hinzufügen",
+                  class: "b4um-todo__button",
+                  data: {
+                    b4um_todo_target: "submit"
+                  } %>
+
+          </div>
+
+          <%% if @task.errors.any? %>
+            <div class="b4um-todo__errors">
+              <%%= @task.errors.full_messages.to_sentence %>
+            </div>
+          <%% end %>
+        <%% end %>
+      </section>
+
+      <section class="b4um-todo__section">
+        <h2>
+          Offene Aufgaben
+          <span id="incomplete_tasks_count">
+            (<%%= @incomplete_tasks.size %>)
+          </span>
+        </h2>
+
+        <div id="incomplete_tasks" class="b4um-todo__list">
+          <%%= render partial: "task",
+                collection: @incomplete_tasks,
+                as: :task %>
+        </div>
+
+        <div id="incomplete_tasks_empty">
+          <%% unless @incomplete_tasks.any? %>
+            <p class="b4um-todo__empty">
+              Keine offenen Aufgaben. Sehr gut!
+            </p>
+          <%% end %>
+        </div>
+      </section>
+
+      <section class="b4um-todo__section">
+        <h2>
+          Erledigte Aufgaben
+          <span id="complete_tasks_count">
+            (<%%= @complete_tasks.size %>)
+          </span>
+        </h2>
+
+        <div id="complete_tasks" class="b4um-todo__list">
+          <%%= render partial: "task",
+                collection: @complete_tasks,
+                as: :task %>
+        </div>
+
+        <div id="complete_tasks_empty">
+          <%% unless @complete_tasks.any? %>
+            <p class="b4um-todo__empty">
+              Noch keine erledigten Aufgaben.
+            </p>
+          <%% end %>
+        </div>
+      </section>
+    </div>
+  </div>
+</div>

data/lib/generators/b4um/todo/templates/task.rb.tt

@@ -0,0 +1,7 @@
+class <%= class_name %> < ApplicationRecord
+<% if owner? %>
+  belongs_to :<%= owner_reference_name %>
+<% end %>
+
+  validates :name, presence: true
+end