b4um_generators 0.2.11 → 0.2.16

data/lib/generators/b4um/authentication/authentication_generator.rb

@@ -149,6 +149,69 @@ module B4um
         end
       end
 
+      def update_in_place_helper
+        helper_path = "app/helpers/b4um_in_place_helper.rb"
+
+        full_helper_path = File.join(
+          destination_root,
+          helper_path
+        )
+
+        return unless File.exist?(full_helper_path)
+
+        helper = File.read(full_helper_path)
+
+        return if helper.include?(
+          "def b4um_in_place_editing_allowed?\n    logged_in?"
+        )
+
+        gsub_file(
+          helper_path,
+          "def b4um_in_place_editing_allowed?\n    true",
+          "def b4um_in_place_editing_allowed?\n    logged_in?"
+        )
+      end
+
+      def protect_in_place_controllers
+        controllers_path = File.join(
+          destination_root,
+          "app/controllers"
+        )
+
+        return unless Dir.exist?(controllers_path)
+
+        Dir.glob(
+          File.join(controllers_path, "*_controller.rb")
+        ).each do |full_controller_path|
+          controller = File.read(full_controller_path)
+
+          next unless controller.include?("IN_PLACE_FIELDS")
+
+          controller_name =
+            File
+            .basename(full_controller_path, "_controller.rb")
+
+          protect_index_actions_for(controller_name)
+          protect_show_actions_for(controller_name)
+
+          callback =
+            "before_action :require_login, except: [:index, :show]"
+
+          next if controller.include?(callback)
+
+          controller_path = full_controller_path.delete_prefix(
+            "#{destination_root}/"
+          )
+
+          inject_into_file(
+            controller_path,
+            after: /^class .*Controller < ApplicationController\s*$/
+          ) do
+            "\n  #{callback}"
+          end
+        end
+      end
+
       def add_session_routes
         routes_path = "config/routes.rb"
         full_routes_path = File.join(destination_root, routes_path)

data/lib/generators/b4um/bento/bento_generator.rb

@@ -45,6 +45,21 @@ module B4um
         )
       end
 
+      def update_index_layout
+        return unless File.exist?(index_path)
+
+        index = File.read(index_path)
+
+        updated_index = index.sub(
+          /render\s+["'](?:bento|table|list|alternating)["']/,
+          'render "bento"'
+        )
+
+        return if updated_index == index
+
+        File.write(index_path, updated_index)
+      end
+
       private
 
       def model_path
@@ -55,6 +70,15 @@ module B4um
         )
       end
 
+      def index_path
+        File.join(
+          destination_root,
+          "app/views",
+          plural_table_name,
+          "index.html.erb"
+        )
+      end
+
       def resource_partial_path
         File.join(
           destination_root,

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

@@ -362,6 +362,8 @@ module B4um
             - b4um 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
@@ -369,6 +371,34 @@ module B4um
             - Password field support
             - Optional readable URL parameters
 
+          Select fields can be generated with:
+
+            --select='FIELD:VALUE=LABEL,VALUE=LABEL'
+
+          Example:
+
+            bin/rails generate b4um:scaffold Product name:string status:string --select='status:Active=Aktiv,Inactive=Inaktiv'
+
+          Radio fields use the same value and label syntax:
+
+            --radio='FIELD:VALUE=LABEL,VALUE=LABEL'
+
+          Example:
+
+            bin/rails generate b4um:scaffold Product name:string condition:string --radio='condition:new=Neu,used=Gebraucht,refurbished=Generalüberholt'
+
+          The configured values are stored in the database. The labels
+          are displayed in forms, resource views and table layouts.
+
+          Select and radio options can be used together for different
+          fields.
+
+          Example:
+
+            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 same field cannot use both --select and --radio.
+
           The default index uses the b4um Bento card layout.
 
           To generate a table index instead, use:
@@ -728,15 +758,39 @@ module B4um
 
           TABLE
 
-            bin/rails generate b4um:table MODEL FIELDS
+            bin/rails generate b4um:table MODEL [FIELDS]
 
           Generates a reusable b4um table partial for an existing model.
 
-          Example:
+          The model must already exist.
 
-            bin/rails generate b4um:table Product name:string description:text price:decimal status:string
+          Fields are optional. If no fields are supplied, the generator
+          automatically detects:
 
-          The model must already exist.
+            - Database fields
+            - Action Text rich text fields
+            - Active Storage single attachments
+            - Active Storage multiple attachments
+
+          id, created_at and updated_at are excluded automatically.
+
+          Recommended:
+
+            bin/rails generate b4um:table Product
+
+          Fields can also be specified explicitly:
+
+            bin/rails generate b4um:table Product name price status
+
+          Select fields can be configured with --select:
+
+            bin/rails generate b4um:table Product --select='status:active=Active,inactive=Inactive'
+
+          Radio fields can be configured with --radio:
+
+            bin/rails generate b4um:table Product --radio='condition:new=New,used=Used'
+
+          The configured database values are displayed using their labels.
 
           The generated partial is created at:
 
@@ -744,18 +798,34 @@ module B4um
 
           Table features:
 
+            - Automatic field detection from the existing model
             - Responsive b4um table component
-            - Typed field definitions
+            - Model-aware field types
             - Text fields shortened to 100 characters
-            - Status field displayed as a b4um badge
+            - Decimal values formatted with two decimal places
+            - Status fields displayed as b4um badges
+            - Select and radio labels
+            - Action Text / Trix content
+            - Lightbox for images embedded in rich text
+            - Trix image captions in the lightbox
+            - Active Storage single images
+            - Active Storage multiple image galleries
+            - Image thumbnails and lightbox navigation
+            - Mouse and touch drag / swipe
             - Actions column with a Show button
+            - Empty-state handling
             - No migrations, routes or controllers are generated
 
-          Render the partial from an index view with:
+          Running the Table generator automatically switches an existing
+          b4um index view to the table partial:
 
             <%= render "table", products: @products %>
 
-          The partial uses a local collection, so it can also be
+          Running b4um:bento later switches the index back to the Bento
+          partial. This also applies to the grid, list and alternating
+          Bento layouts.
+
+          The table partial uses a local collection, so it can also be
           reused with another collection:
 
             <%= render "products/table", products: @featured_products %>
@@ -905,6 +975,67 @@ module B4um
           the generator to stop with an error.
 
 
+          IN-PLACE EDITING
+
+            bin/rails generate b4um:in_place MODEL FIELD [FIELD ...]
+
+          Adds in-place editing to fields of an existing b4um resource.
+
+          Examples:
+
+            bin/rails generate b4um:in_place Product name
+            bin/rails generate b4um:in_place Product name price status
+
+          The model, controller and resource routes must already exist.
+
+          The generator detects the field type automatically and creates
+          the appropriate in-place editor.
+
+          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 can be configured with --select:
+
+            bin/rails generate b4um:in_place Product status --select='status:Active=Aktiv,Inactive=Inaktiv'
+
+          Radio buttons can be configured with --radio:
+
+            bin/rails generate b4um:in_place Product condition --radio='condition:new=Neu,used=Gebraucht,refurbished=Generalüberholt'
+
+          The value before "=" is stored in the database.
+          The optional value after "=" is used as the displayed label.
+
+          In-place editing features:
+
+            - Turbo Frame based editing without an additional in-place gem
+            - Click a displayed field to edit it in place
+            - Text and rich text fields save when clicking outside
+            - Select, radio, and boolean fields save immediately
+            - Single and multiple image attachment editing
+            - Existing attachments can be removed
+            - Validation errors remain visible inside the editor
+            - Successful updates can refresh the flash message immediately
+            - Existing resource layout remains in place while editing
+            - Multiple fields can be added in one generator run
+            - Additional fields can be added in later generator runs
+            - Safe repeated generator runs
+
+          In-place editing also integrates with b4um authentication.
+
+          Without authentication, generated in-place fields are editable.
+          When b4um authentication is installed, editing is restricted to
+          logged-in users and the affected controller actions are protected.
+
+          Authentication can be installed before or after in-place editing.
+          The generators update the integration automatically in either order.
+
+
           TRIX / RICH TEXT
 
             bin/rails generate b4um:trix MODEL ATTRIBUTE
@@ -915,21 +1046,27 @@ module B4um
 
             bin/rails generate b4um:trix Article content
 
-          The model and form must already exist.
+          The model and b4um form must already exist. The selected
+          attribute does not need to be present in the form yet.
 
           The generator adds:
 
             has_rich_text :content
 
-          and replaces the selected form field with a rich text editor:
+          and adds or replaces the selected form field with a rich
+          text editor:
 
             form.rich_text_area :content
 
+          The corresponding b4um resource field is also added when
+          it does not already exist.
+
           Trix / Rich Text features:
 
             - Installs Action Text automatically when necessary
             - Adds the rich text association to the model
-            - Replaces only the selected form field
+            - Adds or replaces the selected form field
+            - Adds the rich text field to the b4um resource when necessary
             - Preserves compact Bento text using plain text
             - Image lightbox for images inside rich text
             - Previous / next image navigation