b4um_generators 0.1.1 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b55f9667cdd536bfa19d947e9139130300d4dfd5a95d3e4a8c52b37042022fa9
-  data.tar.gz: 0ba19080c73de429e1b4f0b2e025d03aad4f0eec88963c26e5817e718677d1d6
+  metadata.gz: ab89fe09deda48a796523b69839e38cacce98d2d91e417b0de179c3263b45be2
+  data.tar.gz: b7c7173b4d447cd2a068fd84c06f268b4cdfd0eabfdd76115a6fdb4342b03a48
 SHA512:
-  metadata.gz: 1ba384cba95037febae27de129297021507ec8eecc7806ae767b3761e395641c918576d42c58190a73cf3838f3a7c6569ed27f5d20074d4ded083f7270d07192
-  data.tar.gz: 94e5ce838a05e85e4c18cd7f582b9981d1c80dc8aa30bad5e68f55298588a4544a3dcf9a45adbcfe8ff622d86e57e1a240ebc30dd6d8b1817b3512bd05f6b7b3
+  metadata.gz: 38240797ad404a9ed5092ce1222b4e02a07bed73a217d16d72d2b3dbf22beafc29e3667031bd06a732b3ab5fa22d81ee1cf5ee670ce1d380868ec5364d93aea1
+  data.tar.gz: 982dc00957e65b8f38233184369a8cfbce9ad00236fef09f750f029f22e4b64926e1ad194e4d785ab5a492c8ff197930eb62cccce766c882714d9275640b3971

data/.rubocop.yml

@@ -15,14 +15,14 @@ Style/StringLiteralsInInterpolation:
   EnforcedStyle: double_quotes
 
 Metrics/MethodLength:
-  Max: 550
+  Max: 650
 
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'
 
 Metrics/ClassLength:
-  Max: 550
+  Max: 650
 
 Metrics/AbcSize:
   Max: 100

data/README.de.md

@@ -6,7 +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 und Rich-Text-Bearbeitung.
+Bento-Layouts, Tabellen, Pagination, Infinite Scroll, Suche, Kommentare, Authentifizierung, Attachments und
+Rich-Text-Bearbeitung.
 
 Die generierten Komponenten verwenden ein gemeinsames b4um-Styling und sind darauf ausgelegt, miteinander zu
 funktionieren.
@@ -23,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.1.0", path: "/pfad/zu/b4um_generators"
+gem "b4um_generators", "~> 0.2.0", path: "/pfad/zu/b4um_generators"
 ```
 
 Führe anschließend aus:
@@ -73,6 +74,7 @@ Das Gem stellt derzeit folgende Generatoren bereit:
 ```text
 b4um:install
 b4um:scaffold
+b4um:attachment
 b4um:bento
 b4um:table
 b4um:controller
@@ -80,7 +82,9 @@ b4um:pagination
 b4um:infinite_scroll
 b4um:search
 b4um:comments
+b4um:authentication
 b4um:trix
+b4um:readable
 b4um:help
 ```
 
@@ -164,6 +168,12 @@ Die ID bleibt Bestandteil der URL, sodass die normale Rails-Ressourcensuche weit
 Der lesbare Teil wird aus dem ausgewählten Attribut erzeugt und ändert sich automatisch, wenn sich dieses Attribut
 ändert.
 
+Lesbare URLs können auch später zu einem bestehenden Modell hinzugefügt werden:
+
+```bash
+bin/rails generate b4um:readable Product name
+```
+
 ## Bento und Karten
 
 b4um enthält ein responsives Kartensystem, das auch unabhängig von den Generatoren verwendet werden kann.
@@ -356,6 +366,112 @@ bin/rails generate b4um:install
 
 Falls erforderlich, fügt b4um bcrypt zur `Gemfile` der Anwendung hinzu und installiert es.
 
+## Authentifizierung
+
+Füge einem bestehenden Modell eine sitzungsbasierte Authentifizierung hinzu:
+
+```bash
+bin/rails generate b4um:authentication MODEL
+```
+
+Beispiel:
+
+```bash
+bin/rails generate b4um:authentication User
+```
+
+Das Authentifizierungsmodell kann einen beliebigen Namen haben, zum Beispiel:
+
+```text
+User
+Admin
+Member
+```
+
+Das ausgewählte Modell muss:
+
+- Bereits vorhanden sein
+- `has_secure_password` verwenden
+- Eine `password_digest`-Spalte besitzen
+- bcrypt verwenden
+
+Für die Anmeldung verwendet die Authentifizierung ein `email`-Attribut.
+
+Ein vollständiges Beispiel:
+
+```bash
+bin/rails generate b4um:scaffold User name:string email:string password_digest:string
+bin/rails generate b4um:authentication User
+```
+
+Der Authentifizierungs-Generator fügt Folgendes hinzu:
+
+- Sessions-Controller
+- Anmeldeformular
+- Login- und Logout-Routen
+- Sitzungsbasierten Helper für das aktuell angemeldete Konto
+- `logged_in?`-Helper
+- `require_login`-Helper
+- Login- und Logout-Elemente in der Navigation
+
+Der Name des generierten Helpers richtet sich nach dem ausgewählten Modell.
+
+Für `User`:
+
+```ruby
+current_user
+```
+
+Für `Admin`:
+
+```ruby
+current_admin
+```
+
+### Controller schützen
+
+Bestehende Controller können bei der Einrichtung der Authentifizierung optional geschützt werden.
+
+Verwende `--protect` mit dem Namen des Controllers:
+
+```bash
+bin/rails generate b4um:authentication User --protect=Products
+```
+
+Der Generator fügt dem ausgewählten Controller folgende Authentifizierungsanforderung hinzu:
+
+```ruby
+before_action :require_login, except: [:index, :show]
+```
+
+Dadurch bleiben `index` und `show` öffentlich erreichbar. Für Aktionen wie `new`, `create`, `edit`, `update` und
+`destroy` ist dagegen eine Anmeldung erforderlich.
+
+Mehrere Controller können gleichzeitig geschützt werden, indem ihre Namen durch Kommas getrennt werden:
+
+```bash
+bin/rails generate b4um:authentication User --protect=Products,Articles
+```
+
+Weitere Controller können auch später geschützt werden, indem der Authentifizierungs-Generator erneut ausgeführt wird:
+
+```bash
+bin/rails generate b4um:authentication User --protect=Comments
+```
+
+Die bereits vorhandene Authentifizierung wird dabei weiterverwendet. Authentifizierungs-Helper, Routen,
+Navigationselemente und Controller-Schutz werden nicht dupliziert.
+
+Der Generator prüft die angegebenen Controller, bevor Änderungen an der Anwendung vorgenommen werden. Existiert ein
+angeforderter Controller nicht, bricht der Generator mit einer Fehlermeldung ab, bevor Dateien verändert werden.
+
+Der Generator prüft außerdem seine Authentifizierungsvoraussetzungen, bevor Änderungen an der Anwendung vorgenommen
+werden. Fehlt eine erforderliche Voraussetzung, bricht der Generator mit einer hilfreichen Fehlermeldung und einem
+passenden Vorschlag für einen b4um-Scaffold-Befehl ab.
+
+Bei wiederholter Ausführung werden Authentifizierungs-Helper, Routen, Navigationselemente und Controller-Schutz nicht
+dupliziert.
+
 ## Active Storage und Bilder
 
 Bildanhänge verwenden Rails Active Storage.
@@ -368,7 +484,7 @@ bin/rails generate b4um:install
 
 Wenn Active Storage noch nicht installiert ist, installiert b4um es und führt die erforderliche Migration aus.
 
-### Einzelnes Bild
+### Einzelnes Bild in einem neuen Scaffold
 
 Verwende:
 
@@ -382,7 +498,7 @@ Beispiel:
 bin/rails generate b4um:scaffold Article title:string image:attachment
 ```
 
-### Mehrere Bilder
+### Mehrere Bilder in einem neuen Scaffold
 
 Verwende:
 
@@ -396,6 +512,62 @@ Beispiel:
 bin/rails generate b4um:scaffold Gallery title:string images:attachments
 ```
 
+### Attachment-Generator
+
+Attachments können auch später zu einer bestehenden b4um-Ressource hinzugefügt werden.
+
+Für ein einzelnes Attachment:
+
+```bash
+bin/rails generate b4um:attachment MODEL ATTACHMENT
+```
+
+Beispiel:
+
+```bash
+bin/rails generate b4um:attachment Admin avatar
+```
+
+Dadurch wird hinzugefügt:
+
+```ruby
+has_one_attached :avatar
+```
+
+Für mehrere Attachments verwende `--multiple`:
+
+```bash
+bin/rails generate b4um:attachment MODEL ATTACHMENT --multiple
+```
+
+Beispiel:
+
+```bash
+bin/rails generate b4um:attachment Product images --multiple
+```
+
+Dadurch wird hinzugefügt:
+
+```ruby
+has_many_attached :images
+```
+
+Wenn die entsprechenden b4um-Dateien vorhanden sind, aktualisiert der Attachment-Generator außerdem:
+
+- Das bestehende Modell
+- Das bestehende b4um-Formular
+- Die Controller-Parameter
+- Das bestehende b4um-Ressourcen-Partial
+
+Mehrere Attachments unterstützen zusätzlich:
+
+- Hinzufügen neuer Bilder, ohne bestehende Bilder zu ersetzen
+- Entfernen einzelner bestehender Bilder
+- Vorschau mehrerer Bilder
+- Bildergalerie mit Lightbox-Navigation
+
+Bei wiederholter Ausführung wird eine bestehende Attachment-Konfiguration nicht dupliziert.
+
 Die Bildunterstützung umfasst:
 
 - Active-Storage-Integration
@@ -806,7 +978,7 @@ wird.
 
 ## Version
 
-Aktuelle Version: `0.1.0`
+Aktuelle Version: `0.2.6`
 
 ## Autor
 

data/README.md

@@ -6,7 +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, comments and rich-text editing.
+Bento layouts, tables, pagination, infinite scrolling, search, comments, authentication, attachments and rich-text
+editing.
 
 Generated components share the same b4um styling and are designed to work together.
 
@@ -22,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.1.0", path: "/path/to/b4um_generators"
+gem "b4um_generators", "~> 0.2.0", path: "/path/to/b4um_generators"
 ```
 
 Then run:
@@ -71,6 +72,7 @@ The gem currently provides the following generators:
 ```text
 b4um:install
 b4um:scaffold
+b4um:attachment
 b4um:bento
 b4um:table
 b4um:controller
@@ -78,7 +80,9 @@ b4um:pagination
 b4um:infinite_scroll
 b4um:search
 b4um:comments
+b4um:authentication
 b4um:trix
+b4um:readable
 b4um:help
 ```
 
@@ -161,6 +165,12 @@ The ID remains part of the URL, so the standard Rails resource lookup continues
 
 The readable part is generated from the selected attribute and changes automatically when that attribute changes.
 
+Readable URLs can also be added later to an existing model:
+
+```bash
+bin/rails generate b4um:readable Product name
+```
+
 ## Bento and Cards
 
 b4um includes a responsive card system that can be used independently of the generators.
@@ -353,6 +363,110 @@ bin/rails generate b4um:install
 
 If necessary, b4um adds bcrypt to the application's `Gemfile` and installs it.
 
+## Authentication
+
+Add session-based authentication for an existing model:
+
+```bash
+bin/rails generate b4um:authentication MODEL
+```
+
+Example:
+
+```bash
+bin/rails generate b4um:authentication User
+```
+
+The authentication model can have any name, for example:
+
+```text
+User
+Admin
+Member
+```
+
+The selected model must:
+
+- Already exist
+- Use `has_secure_password`
+- Have a `password_digest` column
+- Use bcrypt
+
+Authentication uses an `email` attribute for login.
+
+A complete example:
+
+```bash
+bin/rails generate b4um:scaffold User name:string email:string password_digest:string
+bin/rails generate b4um:authentication User
+```
+
+The authentication generator adds:
+
+- Sessions controller
+- Login form
+- Login and logout routes
+- Session-based current account helper
+- `logged_in?` helper
+- `require_login` helper
+- Login and logout navigation controls
+
+The generated helper name follows the selected model.
+
+For `User`:
+
+```ruby
+current_user
+```
+
+For `Admin`:
+
+```ruby
+current_admin
+```
+
+### Protecting Controllers
+
+Existing controllers can optionally be protected when authentication is installed.
+
+Use `--protect` with the controller name:
+
+```bash
+bin/rails generate b4um:authentication User --protect=Products
+```
+
+The generator adds the following authentication requirement to the selected controller:
+
+```ruby
+before_action :require_login, except: [:index, :show]
+```
+
+This keeps `index` and `show` publicly accessible while requiring authentication for actions such as `new`, `create`,
+`edit`, `update` and `destroy`.
+
+Multiple controllers can be protected at the same time by separating their names with commas:
+
+```bash
+bin/rails generate b4um:authentication User --protect=Products,Articles
+```
+
+Additional controllers can also be protected later by running the authentication generator again:
+
+```bash
+bin/rails generate b4um:authentication User --protect=Comments
+```
+
+Existing authentication setup is reused. Authentication helpers, routes, navigation controls and controller protection
+are not duplicated.
+
+The generator validates protected controllers before changing the application. If a requested controller does not exist,
+the generator stops with an error before making changes.
+
+The generator also validates its authentication requirements before changing the application. If required authentication
+setup is missing, the generator stops with a helpful error message and a suggested b4um scaffold command.
+
+Repeated generator runs do not duplicate authentication helpers, routes, navigation controls or controller protection.
+
 ## Active Storage and Images
 
 Image attachments use Rails Active Storage.
@@ -365,7 +479,7 @@ bin/rails generate b4um:install
 
 If Active Storage is not already installed, b4um installs it and runs the required migration.
 
-### Single Image
+### Single Image in a New Scaffold
 
 Use:
 
@@ -379,7 +493,7 @@ Example:
 bin/rails generate b4um:scaffold Article title:string image:attachment
 ```
 
-### Multiple Images
+### Multiple Images in a New Scaffold
 
 Use:
 
@@ -393,6 +507,62 @@ Example:
 bin/rails generate b4um:scaffold Gallery title:string images:attachments
 ```
 
+### Attachment Generator
+
+Attachments can also be added later to an existing b4um resource.
+
+For a single attachment:
+
+```bash
+bin/rails generate b4um:attachment MODEL ATTACHMENT
+```
+
+Example:
+
+```bash
+bin/rails generate b4um:attachment Admin avatar
+```
+
+This adds:
+
+```ruby
+has_one_attached :avatar
+```
+
+For multiple attachments, use `--multiple`:
+
+```bash
+bin/rails generate b4um:attachment MODEL ATTACHMENT --multiple
+```
+
+Example:
+
+```bash
+bin/rails generate b4um:attachment Product images --multiple
+```
+
+This adds:
+
+```ruby
+has_many_attached :images
+```
+
+When the corresponding b4um files exist, the attachment generator also updates:
+
+- The existing model
+- The existing b4um form
+- The controller parameters
+- The existing b4um resource partial
+
+Multiple attachments additionally support:
+
+- Adding new images without replacing existing images
+- Removing individual existing images
+- Multiple image preview
+- Image gallery with lightbox navigation
+
+Repeated generator runs do not duplicate existing attachment setup.
+
 Image support includes:
 
 - Active Storage integration
@@ -800,7 +970,7 @@ The gem can be tested locally by referencing the repository with `path:` from a
 
 ## Version
 
-Current version: `0.1.0`
+Current version: `0.2.7`
 
 ## Author
 

data/lib/b4um_generators/version.rb

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