b4um_generators 0.2.11 → 0.2.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe62953ac32b6c0aa41af6886b6d6c97d1446ef4ae92177a4c200faee03dc9ff
-  data.tar.gz: 4b08b040919c741f57374a9f572268265b2405180af4a5958659da3232ada073
+  metadata.gz: 3872ce0dc22b0119d636611c3948c941da818ed3c8ee65301da95c0570ba677d
+  data.tar.gz: 77a2d8228dddbb5852325b81c1e1cc65482dc429912629884cf7c580438dac4e
 SHA512:
-  metadata.gz: 54fb5d2d124addb3063a2e0ab1540ff6327b9fa624d41f6a9e0197e6012fa5a1fd5edaf26356f3b59d7ec4d36a2d3a3ab993a4b0f59d65cf50ade4adb65b9a20
-  data.tar.gz: adea210e1f9eec24d763c9084be55aec061bb9d568caf7be9c68c2a539e8b65ac45e8066fa75c9baae2721f8f1d6d20b8d7396612ec9fa955e9b7370f5d3b0a2
+  metadata.gz: 1e44802b32dc4e9ee22c7bd2b4507a34a692777ca0a940b904f0403223b0d36b7bbd9c403579a13cd2fe9409d76f86fd21cc487022d13b4abd7de0ef600f4e6a
+  data.tar.gz: 1a20c4ba742c086c788c5426085724d3bea2a3a01e30229ea1dc0f190b6ad4d2819a5c5609e326dd95fdfc4b70beb728260ded64a26416d0725322144e7f6b1b

data/.rubocop.yml

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

data/README.de.md

@@ -82,6 +82,7 @@ b4um:pagination
 b4um:infinite_scroll
 b4um:search
 b4um:comments
+b4um:in_place
 b4um:authentication
 b4um:trix
 b4um:readable
@@ -114,6 +115,8 @@ Der Scaffold-Generator bietet:
 - Index-, Show-, New- und Edit-Views
 - Standardmäßig ein Bento-Index-Layout
 - Optionales Tabellen-Index-Layout
+- Select-Felder mit eigenen Anzeigebezeichnungen
+- Radio-Felder mit eigenen Anzeigebezeichnungen
 - Automatischen Navigationseintrag
 - Aktiven Navigationszustand
 - Anzeige von Formular-Validierungsfehlern
@@ -121,6 +124,45 @@ Der Scaffold-Generator bietet:
 - Unterstützung für Passwortfelder
 - Optionale lesbare URL-Parameter
 
+### Select- und Radio-Felder
+
+Der Scaffold-Generator kann String-Attribute als Select- oder Radio-Felder mit eigenen Anzeigebezeichnungen erzeugen.
+
+Für ein Select-Feld verwende:
+
+```text
+--select='FIELD:VALUE=LABEL,VALUE=LABEL'
+```
+
+Beispiel:
+
+```bash
+bin/rails generate b4um:scaffold Product name:string status:string --select='status:Active=Aktiv,Inactive=Inaktiv'
+```
+
+Für Radio-Buttons verwende:
+
+```text
+--radio='FIELD:VALUE=LABEL,VALUE=LABEL'
+```
+
+Beispiel:
+
+```bash
+bin/rails generate b4um:scaffold Product name:string condition:string --radio='condition:new=Neu,used=Gebraucht,refurbished=Generalüberholt'
+```
+
+Beide Optionen können für unterschiedliche Felder miteinander kombiniert werden:
+
+```bash
+bin/rails generate b4um:scaffold Product name:string status:string condition:string --select='status:Active=Aktiv,Inactive=Inaktiv' --radio='condition:new=Neu,used=Gebraucht'
+```
+
+Die konfigurierten Werte werden in der Datenbank gespeichert. In Formularen, Ressourcen-Views und Tabellen-Layouts
+werden dagegen die zugehörigen Anzeigebezeichnungen dargestellt.
+
+Dasselbe Feld kann nicht gleichzeitig `--select` und `--radio` verwenden.
+
 ### Bento-Index
 
 Der standardmäßige Scaffold-Index verwendet das responsive b4um-Bento-Kartenlayout.
@@ -260,16 +302,34 @@ Das Partial verwendet eine lokale Collection und kann daher auch mit einer ander
 Erzeuge eine wiederverwendbare b4um-Tabelle für ein bestehendes Modell:
 
 ```bash
-bin/rails generate b4um:table MODEL FIELDS
+bin/rails generate b4um:table MODEL [FIELDS]
 ```
 
-Beispiel:
+Das Modell muss bereits vorhanden sein.
+
+Die Felder sind optional. Werden keine Felder angegeben, erkennt der Generator automatisch die Datenbankfelder des
+Modells, Action-Text-Felder und Active-Storage-Anhänge. `id`, `created_at` und `updated_at` werden automatisch
+ausgeschlossen.
+
+Empfohlen:
 
 ```bash
-bin/rails generate b4um:table Product name:string description:text price:decimal status:string
+bin/rails generate b4um:table Product
 ```
 
-Das Modell muss bereits vorhanden sein.
+Felder können weiterhin ausdrücklich angegeben werden:
+
+```bash
+bin/rails generate b4um:table Product name price status
+```
+
+Konfigurierte Select- und Radio-Werte können mit ihren Beschriftungen dargestellt werden:
+
+```bash
+bin/rails generate b4um:table Product \
+  --select="status:active=Aktiv,inactive=Inaktiv" \
+  --radio="condition:new=Neu,used=Gebraucht"
+```
 
 Für ein `Product`-Modell wird das generierte Partial hier gespeichert:
 
@@ -279,20 +339,33 @@ app/views/products/_table.html.erb
 
 Die generierte Tabelle bietet:
 
+- Automatische Felderkennung aus dem bestehenden Modell
 - Responsives Tabellenlayout
-- Typisierte Felddefinitionen
+- Erkennung der tatsächlichen Feldtypen des Modells
 - Kürzung von Textfeldern auf 100 Zeichen
+- Formatierung von Dezimalwerten mit zwei Nachkommastellen
 - Darstellung von Statusfeldern als b4um-Badges
+- Beschriftungen für konfigurierte `--select`- und `--radio`-Werte
+- Action-Text-/Trix-Inhalte
+- Lightbox für Bilder innerhalb von Rich Text
+- Übernahme von Trix-Bildbeschriftungen in die Lightbox
+- Active-Storage-`has_one_attached`-Bilder
+- Active-Storage-`has_many_attached`-Galerien
+- Vorschaubilder, Lightbox-Navigation und Ziehen/Wischen
 - Aktionsspalte mit Show-Button
 - Empty-State-Darstellung
 
-Einbindung:
+Beim Aufruf des Tabellen-Generators wird eine vorhandene b4um-Index-Ansicht automatisch auf das Tabellen-Partial
+umgestellt:
 
 ```erb
 <%= render "table", products: @products %>
 ```
 
-Das Partial kann auch mit einer anderen Collection verwendet werden:
+Wird später `b4um:bento Product` ausgeführt, stellt der Generator den Index wieder auf das Bento-Partial zurück. Das
+gilt auch für die Bento-Layouts `grid`, `list` und `alternating`.
+
+Das Tabellen-Partial kann auch mit einer anderen Collection verwendet werden:
 
 ```erb
 <%= render "products/table", products: @featured_products %>
@@ -690,6 +763,90 @@ Bestehende b4um-Comments-Controller werden automatisch erweitert.
 Unbekannte benutzerdefinierte Comments-Controller bleiben unverändert und führen dazu, dass der Generator abbricht,
 anstatt eigenen Code zu überschreiben.
 
+## In-place Editing
+
+Füge Feldern einer bestehenden b4um-Ressource eine direkte Bearbeitung hinzu:
+
+```bash
+bin/rails generate b4um:in_place MODEL FIELD [FIELD ...]
+```
+
+Beispiel für ein einzelnes Feld:
+
+```bash
+bin/rails generate b4um:in_place Product name
+```
+
+Mehrere Felder können in einem Durchlauf hinzugefügt werden:
+
+```bash
+bin/rails generate b4um:in_place Product name price status
+```
+
+Modell, Controller und Resource-Routen müssen bereits vorhanden sein.
+
+Der Generator erkennt die vorhandenen Feldtypen automatisch und erstellt die passenden Editoren.
+
+Unterstützte Felder sind:
+
+- String- und Text-Felder
+- Numerische und Decimal-Felder
+- Boolean-Felder
+- Action-Text-Rich-Text-Felder
+- Einzelne Active-Storage-Bild-Attachments
+- Mehrere Active-Storage-Bild-Attachments
+
+### Select-Felder
+
+Ein Feld kann mit `--select` als Auswahlliste dargestellt werden:
+
+```bash
+bin/rails generate b4um:in_place Product status --select='status:Active=Aktiv,Inactive=Inaktiv'
+```
+
+Der Wert vor `=` wird in der Datenbank gespeichert. Der optionale Wert nach `=` wird als sichtbare Beschriftung
+verwendet.
+
+Zum Beispiel speichert `Active=Aktiv` den Wert `Active`, während `Aktiv` angezeigt wird.
+
+### Radio-Felder
+
+Ein Feld kann mit `--radio` als Gruppe von Radio-Buttons dargestellt werden:
+
+```bash
+bin/rails generate b4um:in_place Product condition --radio='condition:new=Neu,used=Gebraucht,refurbished=Generalüberholt'
+```
+
+Für Radio-Felder gilt dieselbe Wert- und Beschriftungssyntax wie für `--select`.
+
+### Verhalten der In-place-Bearbeitung
+
+Die generierte In-place-Bearbeitung bietet:
+
+- Bearbeitung mit Turbo Frames ohne zusätzliches In-place-Editing-Gem
+- Direkte Bearbeitung innerhalb des bestehenden Ressourcen-Layouts
+- Speichern von Text- und Rich-Text-Feldern beim Klick außerhalb des Editors
+- Sofortiges Speichern von Select-, Radio- und Boolean-Feldern
+- Bearbeitung einzelner und mehrerer Bild-Attachments
+- Entfernen vorhandener Bild-Attachments
+- Validierungsfehler direkt im Editor
+- Sofortige Aktualisierung der Flash-Meldung nach erfolgreicher Änderung
+- Mehrere Felder in einem Generator-Durchlauf
+- Nachträgliches Hinzufügen weiterer Felder
+- Sichere wiederholte Ausführung des Generators
+
+### Authentifizierung
+
+Die In-place-Bearbeitung integriert sich automatisch in die b4um-Authentifizierung.
+
+Ohne Authentifizierung können die generierten In-place-Felder bearbeitet werden.
+
+Wenn die b4um-Authentifizierung installiert ist, wird die In-place-Bearbeitung auf angemeldete Benutzer beschränkt und
+die zugehörigen Controller-Actions werden mit `require_login` geschützt.
+
+Die Authentifizierung kann vor oder nach der In-place-Bearbeitung installiert werden. Die Generatoren aktualisieren die
+Integration in beiden Installationsreihenfolgen automatisch.
+
 ## Trix und Rich Text
 
 Füge einer bestehenden b4um-Ressource Rails Action Text mit Trix hinzu:
@@ -978,7 +1135,7 @@ wird.
 
 ## Version
 
-Aktuelle Version: `0.2.6`
+Aktuelle Version: `0.2.16`
 
 ## Autor
 

data/README.md

@@ -80,6 +80,7 @@ b4um:pagination
 b4um:infinite_scroll
 b4um:search
 b4um:comments
+b4um:in_place
 b4um:authentication
 b4um:trix
 b4um:readable
@@ -112,6 +113,8 @@ The scaffold generator provides:
 - Index, show, new and edit views
 - Bento index layout by default
 - Optional table index layout
+- Select fields with custom labels
+- Radio fields with custom labels
 - Automatic navigation entry
 - Active navigation state
 - Form validation errors
@@ -119,6 +122,45 @@ The scaffold generator provides:
 - Password field support
 - Optional readable URL parameters
 
+### Select and Radio Fields
+
+The scaffold generator can render string attributes as select or radio fields with custom display labels.
+
+For a select field, use:
+
+```text
+--select='FIELD:VALUE=LABEL,VALUE=LABEL'
+```
+
+Example:
+
+```bash
+bin/rails generate b4um:scaffold Product name:string status:string --select='status:Active=Aktiv,Inactive=Inaktiv'
+```
+
+For radio buttons, use:
+
+```text
+--radio='FIELD:VALUE=LABEL,VALUE=LABEL'
+```
+
+Example:
+
+```bash
+bin/rails generate b4um:scaffold Product name:string condition:string --radio='condition:new=Neu,used=Gebraucht,refurbished=Generalüberholt'
+```
+
+Both options can be combined for different fields:
+
+```bash
+bin/rails generate b4um:scaffold Product name:string status:string condition:string --select='status:Active=Aktiv,Inactive=Inaktiv' --radio='condition:new=Neu,used=Gebraucht'
+```
+
+The configured values are stored in the database, while the labels are displayed in forms, resource views and table
+layouts.
+
+A field cannot use both `--select` and `--radio`.
+
 ### Bento Index
 
 The default scaffold index uses the responsive b4um Bento card layout.
@@ -257,16 +299,33 @@ The partial uses a local collection and can therefore also be reused with anothe
 Generate a reusable b4um table for an existing model:
 
 ```bash
-bin/rails generate b4um:table MODEL FIELDS
+bin/rails generate b4um:table MODEL [FIELDS]
 ```
 
-Example:
+The model must already exist.
+
+Fields are optional. If no fields are supplied, the generator automatically detects the model's database fields, Action
+Text fields and Active Storage attachments. `id`, `created_at` and `updated_at` are excluded automatically.
+
+Recommended:
 
 ```bash
-bin/rails generate b4um:table Product name:string description:text price:decimal status:string
+bin/rails generate b4um:table Product
 ```
 
-The model must already exist.
+Fields can also be specified explicitly:
+
+```bash
+bin/rails generate b4um:table Product name price status
+```
+
+Configured select and radio values can be displayed using their labels:
+
+```bash
+bin/rails generate b4um:table Product \
+  --select="status:active=Active,inactive=Inactive" \
+  --radio="condition:new=New,used=Used"
+```
 
 For a `Product` model, the generated partial is stored at:
 
@@ -276,20 +335,32 @@ app/views/products/_table.html.erb
 
 The generated table provides:
 
+- Automatic field detection from the existing model
 - Responsive table layout
-- Typed field definitions
+- Model-aware field types
 - Text fields shortened to 100 characters
+- Decimal values formatted with two decimal places
 - Status fields displayed as b4um badges
+- Labels for configured `--select` and `--radio` values
+- Action Text / Trix content
+- Lightbox support for images embedded in rich text
+- Trix image captions in the Lightbox
+- Active Storage `has_one_attached` images
+- Active Storage `has_many_attached` galleries
+- Thumbnails, Lightbox navigation and drag/swipe support
 - Actions column with a Show button
 - Empty-state handling
 
-Render it with:
+Running the Table generator automatically switches an existing b4um index view to the table partial:
 
 ```erb
 <%= render "table", products: @products %>
 ```
 
-The partial can also be reused with another collection:
+Running `b4um:bento Product` later switches the index back to the Bento partial. This also applies to the `grid`, `list`
+and `alternating` Bento layouts.
+
+The table partial can also be reused with another collection:
 
 ```erb
 <%= render "products/table", products: @featured_products %>
@@ -685,6 +756,89 @@ Existing b4um comments controllers are extended automatically.
 Unknown custom comments controllers are left unchanged and cause the generator to stop instead of overwriting custom
 code.
 
+## In-place Editing
+
+Add in-place editing to fields of an existing b4um resource:
+
+```bash
+bin/rails generate b4um:in_place MODEL FIELD [FIELD ...]
+```
+
+Example for a single field:
+
+```bash
+bin/rails generate b4um:in_place Product name
+```
+
+Multiple fields can be added in one run:
+
+```bash
+bin/rails generate b4um:in_place Product name price status
+```
+
+The model, controller and resource routes must already exist.
+
+The generator detects the existing field types and creates the appropriate editors.
+
+Supported fields include:
+
+- String and text fields
+- Numeric and decimal fields
+- Boolean fields
+- Action Text rich-text fields
+- Active Storage single image attachments
+- Active Storage multiple image attachments
+
+### Select Fields
+
+A field can be rendered as a select list with `--select`:
+
+```bash
+bin/rails generate b4um:in_place Product status --select='status:Active=Aktiv,Inactive=Inaktiv'
+```
+
+The value before `=` is stored in the database. The optional value after `=` is used as the displayed label.
+
+For example, `Active=Aktiv` stores `Active` while displaying `Aktiv`.
+
+### Radio Fields
+
+A field can be rendered as radio buttons with `--radio`:
+
+```bash
+bin/rails generate b4um:in_place Product condition --radio='condition:new=Neu,used=Gebraucht,refurbished=Generalüberholt'
+```
+
+The same value and label syntax used by `--select` applies to radio fields.
+
+### In-place Editing Behavior
+
+Generated in-place editing provides:
+
+- Turbo Frame based editing without an additional in-place editing gem
+- Editing directly inside the existing resource layout
+- Outside-click saving for text and rich-text fields
+- Immediate saving for select, radio and boolean fields
+- Single and multiple image attachment editing
+- Removal of existing image attachments
+- Inline validation errors
+- Immediate flash-message updates after successful changes
+- Multiple fields in one generator run
+- Additional fields in later generator runs
+- Safe repeated generator runs
+
+### Authentication
+
+In-place editing integrates automatically with b4um authentication.
+
+Without authentication, generated in-place fields are editable.
+
+When b4um authentication is installed, in-place editing is restricted to logged-in users and the corresponding
+controller actions are protected with `require_login`.
+
+Authentication can be installed either before or after in-place editing. The generators update the integration
+automatically in both installation orders.
+
 ## Trix and Rich Text
 
 Add Rails Action Text with Trix to an existing b4um resource:
@@ -970,7 +1124,7 @@ The gem can be tested locally by referencing the repository with `path:` from a
 
 ## Version
 
-Current version: `0.2.7`
+Current version: `0.2.16`
 
 ## Author
 

data/lib/b4um_generators/version.rb

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

data/lib/generators/b4um/attachment/attachment_generator.rb

@@ -134,19 +134,24 @@ module B4um
 
           insertion = ":#{attachment}, :remove_#{attachment}"
 
+          normalized_attributes =
+            attributes
+            .strip
+            .gsub(/\s+,/, ",")
+
           updated_attributes =
-            if attributes.match?(/\w+:\s*\[/)
-              attributes.sub(
+            if normalized_attributes.match?(/\w+:\s*\[/)
+              normalized_attributes.sub(
                 /(?=\w+:\s*\[)/,
                 "#{insertion}, "
               )
             else
-              "#{attributes}, #{insertion}"
+              "#{normalized_attributes}, #{insertion}"
             end
 
           match.sub(
             attributes,
-            updated_attributes
+            " #{updated_attributes} "
           )
         end
       end
@@ -220,23 +225,59 @@ module B4um
       def update_multiple_permitted_params(content)
         return if multiple_attachment_permitted?(content)
 
-        pattern = /
+        params_method_pattern = /
+          def\s+#{Regexp.escape(file_name)}_params
+          (?<body>.*?)
+          ^\s*end
+        /mx
+
+        params_method = content[params_method_pattern, 0]
+
+        unless params_method
+          raise Thor::Error,
+                "Could not find #{file_name}_params in #{controller_path}"
+        end
+
+        expect_pattern = /
           params\.expect\(
           #{Regexp.escape(file_name)}:\s*
           \[
-          (?<attributes>[^\]]*)
+          (?<attributes>.*)
           \]
           \)
         /mx
 
-        return unless content.match?(pattern)
+        match_data = expect_pattern.match(params_method)
 
-        gsub_file(controller_path, pattern) do |match|
-          match.sub(
-            /\]\)$/,
-            ", #{attachment}: [], remove_#{attachment}_ids: []])"
-          )
+        unless match_data
+          raise Thor::Error,
+                "Could not find params.expect for #{file_name} in #{controller_path}"
         end
+
+        normalized_attributes =
+          match_data[:attributes]
+          .strip
+          .gsub(/\s+,/, ",")
+
+        updated_attributes =
+          "#{normalized_attributes}, " \
+          "#{attachment}: [], " \
+          "remove_#{attachment}_ids: []"
+
+        updated_params_method =
+          params_method.sub(
+            match_data[0],
+            match_data[0].sub(
+              match_data[:attributes],
+              " #{updated_attributes} "
+            )
+          )
+
+        gsub_file(
+          controller_path,
+          params_method,
+          updated_params_method
+        )
       end
 
       def multiple_attachment_permitted?(content)
@@ -252,24 +293,43 @@ module B4um
           "new_#{attachment} = update_params.delete(\"#{attachment}\")"
         )
 
+        unless content.include?("    update_params = #{file_name}_params\n")
+          gsub_file(
+            controller_path,
+            "  def update\n    respond_to do |format|\n",
+            [
+              "  def update",
+              "    update_params = #{file_name}_params",
+              "",
+              "    respond_to do |format|",
+              ""
+            ].join("\n")
+          )
+        end
+
         setup = [
-          "  def update",
-          "    update_params = #{file_name}_params",
           "    new_#{attachment} = update_params.delete(\"#{attachment}\")",
           "    remove_#{attachment}_ids = update_params.delete(\"remove_#{attachment}_ids\")",
-          "",
-          "    respond_to do |format|",
           ""
         ].join("\n")
 
-        gsub_file(
+        insert_into_file(
           controller_path,
-          "  def update\n    respond_to do |format|\n",
-          setup
+          setup,
+          after: "    update_params = #{file_name}_params\n"
         )
 
+        content = File.read(controller_path)
+
+        unless content.include?("      if @#{file_name}.update(update_params)\n")
+          gsub_file(
+            controller_path,
+            "      if @#{file_name}.update(#{file_name}_params)\n",
+            "      if @#{file_name}.update(update_params)\n"
+          )
+        end
+
         attachment_handling = [
-          "      if @#{file_name}.update(update_params)",
           "        @#{file_name}.#{attachment}.attach(new_#{attachment}) if new_#{attachment}.present?",
           "",
           "        if remove_#{attachment}_ids.present?",
@@ -280,10 +340,10 @@ module B4um
           ""
         ].join("\n")
 
-        gsub_file(
+        insert_into_file(
           controller_path,
-          "      if @#{file_name}.update(#{file_name}_params)\n",
-          attachment_handling
+          attachment_handling,
+          after: "      if @#{file_name}.update(update_params)\n"
         )
       end