b4um_generators 0.3.0 → 0.4.2

data/lib/generators/b4um/guest/templates/edit.html.erb.tt

@@ -0,0 +1,156 @@
+<div class="page-header">
+  <h1>Create your account</h1>
+</div>
+
+<div class="b4um-grid">
+  <section class="b4um-card b4um-card--full">
+    <%%= form_with model: @<%= authentication_model_name %>,
+          url: convert_guest_path,
+          method: :patch,
+          class: "form" do |form| %>
+      <%% if @<%= authentication_model_name %>.errors.any? %>
+        <div class="error-messages">
+          <h2>
+            <%%= pluralize(@<%= authentication_model_name %>.errors.count, "error") %>
+            prohibited this account from being saved:
+          </h2>
+
+          <ul>
+            <%% @<%= authentication_model_name %>.errors.each do |error| %>
+              <li><%%= error.full_message %></li>
+            <%% end %>
+          </ul>
+        </div>
+      <%% end %>
+
+<% guest_available_fields.each do |field| -%>
+<% field_type = guest_field_type(field) -%>
+<% required = account_required_fields.include?(field) -%>
+<% label = field.humanize + (required ? " *" : "") -%>
+<% if field.match?(/(?:^|_)email(?:_|$)/) -%>
+      <div class="form-field">
+        <%%= form.email_field :<%= field %>,
+              class: "form-input",
+              placeholder: " ",
+              required: <%= required %> %>
+        <%%= form.label :<%= field %>, "<%= label %>", class: "form-label" %>
+      </div>
+
+<% elsif field.match?(/(?:^|_)(?:phone|telephone|mobile)(?:_|$)/) -%>
+      <div class="form-field">
+        <%%= form.telephone_field :<%= field %>,
+              class: "form-input",
+              placeholder: " ",
+              required: <%= required %> %>
+        <%%= form.label :<%= field %>, "<%= label %>", class: "form-label" %>
+      </div>
+
+<% elsif field.match?(/(?:^|_)(?:url|website|homepage)(?:_|$)/) -%>
+      <div class="form-field">
+        <%%= form.url_field :<%= field %>,
+              class: "form-input",
+              placeholder: " ",
+              required: <%= required %> %>
+        <%%= form.label :<%= field %>, "<%= label %>", class: "form-label" %>
+      </div>
+
+<% elsif field_type == :boolean -%>
+      <div class="form-field form-field--checkbox">
+        <%%= form.check_box :<%= field %>,
+              class: "form-checkbox",
+              required: <%= required %> %>
+        <%%= form.label :<%= field %>, "<%= label %>",
+              class: "form-label form-label--checkbox" %>
+      </div>
+
+<% elsif field_type == :text -%>
+      <div class="form-field form-field--textarea">
+        <%%= form.text_area :<%= field %>,
+              class: "form-textarea",
+              placeholder: " ",
+              required: <%= required %> %>
+        <%%= form.label :<%= field %>, "<%= label %>", class: "form-label" %>
+      </div>
+
+<% elsif field_type == :integer -%>
+      <div class="form-field">
+        <%%= form.number_field :<%= field %>,
+              class: "form-input",
+              placeholder: " ",
+              step: 1,
+              required: <%= required %> %>
+        <%%= form.label :<%= field %>, "<%= label %>", class: "form-label" %>
+      </div>
+
+<% elsif [:float, :decimal].include?(field_type) -%>
+      <div class="form-field">
+        <%%= form.number_field :<%= field %>,
+              class: "form-input",
+              placeholder: " ",
+              step: "any",
+              required: <%= required %> %>
+        <%%= form.label :<%= field %>, "<%= label %>", class: "form-label" %>
+      </div>
+
+<% elsif field_type == :date -%>
+      <div class="form-field">
+        <%%= form.date_field :<%= field %>,
+              class: "form-input",
+              required: <%= required %> %>
+        <%%= form.label :<%= field %>, "<%= label %>", class: "form-label" %>
+      </div>
+
+<% elsif [:datetime, :timestamp].include?(field_type) -%>
+      <div class="form-field">
+        <%%= form.datetime_local_field :<%= field %>,
+              class: "form-input",
+              required: <%= required %> %>
+        <%%= form.label :<%= field %>, "<%= label %>", class: "form-label" %>
+      </div>
+
+<% elsif field_type == :time -%>
+      <div class="form-field">
+        <%%= form.time_field :<%= field %>,
+              class: "form-input",
+              required: <%= required %> %>
+        <%%= form.label :<%= field %>, "<%= label %>", class: "form-label" %>
+      </div>
+
+<% else -%>
+      <div class="form-field">
+        <%%= form.text_field :<%= field %>,
+              class: "form-input",
+              placeholder: " ",
+              required: <%= required %> %>
+        <%%= form.label :<%= field %>, "<%= label %>", class: "form-label" %>
+      </div>
+
+<% end -%>
+<% end -%>
+
+      <div class="form-field">
+        <%%= form.password_field :password,
+              class: "form-input",
+              placeholder: " ",
+              required: true,
+              autocomplete: "new-password" %>
+        <%%= form.label :password, "Password *", class: "form-label" %>
+      </div>
+
+      <div class="form-field">
+        <%%= form.password_field :password_confirmation,
+              class: "form-input",
+              placeholder: " ",
+              required: true,
+              autocomplete: "new-password" %>
+        <%%= form.label :password_confirmation,
+              "Password confirmation *",
+              class: "form-label" %>
+      </div>
+
+      <div class="form-actions">
+        <%%= form.submit "Create account", class: "form-submit" %>
+      </div>
+    <%% end %>
+  </section>
+</div>

data/lib/generators/b4um/guest/templates/guest_expiration_warning.html.erb.tt

@@ -0,0 +1,12 @@
+<%% if guest_expiring_soon? %>
+  <div class="flash flash--alert">
+    <span>Your guest access expires soon.</span>
+
+    <%%= link_to "Create account", convert_guest_path %>
+
+    <%%= button_to "Delete guest account",
+          guest_path,
+          method: :delete,
+          data: { turbo_confirm: "Delete your guest account?" } %>
+  </div>
+<%% end %>

data/lib/generators/b4um/guest/templates/guests_controller.rb.tt

@@ -0,0 +1,88 @@
+require "securerandom"
+
+class GuestsController < ApplicationController
+  before_action :require_guest, only: %i[edit update destroy]
+  before_action :require_logged_out, only: %i[new create]
+
+  def new
+    @<%= authentication_model_name %> = <%= authentication_class_name %>.new
+  end
+
+  def create
+    @<%= authentication_model_name %> = <%= authentication_class_name %>.new(guest_params)
+    @<%= authentication_model_name %>.guest = true
+    @<%= authentication_model_name %>.guest_expires_at = <%= options[:expires_in].to_i %>.days.from_now
+
+    guest_password = SecureRandom.base64(32)
+    @<%= authentication_model_name %>.password = guest_password
+    @<%= authentication_model_name %>.password_confirmation = guest_password
+
+    if @<%= authentication_model_name %>.save
+      session[:<%= authentication_model_name %>_id] = @<%= authentication_model_name %>.id
+      redirect_to root_path
+    else
+      render :new, status: :unprocessable_content
+    end
+  end
+
+  def edit
+    @<%= authentication_model_name %> = <%= current_authentication_method %>
+  end
+
+  def update
+    @<%= authentication_model_name %> = <%= current_authentication_method %>
+
+    if conversion_params[:password].blank?
+      @<%= authentication_model_name %>.errors.add(:password, "can't be blank")
+      render :edit, status: :unprocessable_content
+      return
+    end
+
+    guest_expires_at = @<%= authentication_model_name %>.guest_expires_at
+
+    @<%= authentication_model_name %>.assign_attributes(conversion_params)
+    @<%= authentication_model_name %>.guest = false
+    @<%= authentication_model_name %>.guest_expires_at = nil
+
+    if @<%= authentication_model_name %>.save
+      redirect_to root_path
+    else
+      @<%= authentication_model_name %>.guest = true
+      @<%= authentication_model_name %>.guest_expires_at = guest_expires_at
+      render :edit, status: :unprocessable_content
+    end
+  end
+
+  def destroy
+    @<%= authentication_model_name %> = <%= current_authentication_method %>
+
+    session.delete(:<%= authentication_model_name %>_id)
+    @<%= authentication_model_name %>.destroy!
+
+    redirect_to root_path
+  end
+
+  private
+
+  def guest_params
+    params.require(:guest).permit(<%= guest_available_fields.map { |field| ":#{field}" }.join(", ") %>)
+  end
+
+  def conversion_params
+    params.require(:<%= authentication_model_name %>).permit(
+      <%= (guest_available_fields + %w[password password_confirmation]).map { |field| ":#{field}" }.join(", ") %>
+    )
+  end
+
+  def require_guest
+    return if <%= current_authentication_method %>&.guest?
+
+    redirect_to root_path, alert: "Guest access required."
+  end
+
+  def require_logged_out
+    return unless <%= current_authentication_method %>
+
+    redirect_to root_path, alert: "You are already logged in."
+  end
+end

data/lib/generators/b4um/guest/templates/new.html.erb.tt

@@ -0,0 +1,136 @@
+<div class="page-header">
+  <h1>Guest access</h1>
+</div>
+
+<div class="b4um-grid">
+  <section class="b4um-card b4um-card--full">
+    <%%= form_with model: @<%= authentication_model_name %>,
+          url: guest_path,
+          scope: :guest,
+          class: "form" do |form| %>
+      <%% if @<%= authentication_model_name %>.errors.any? %>
+        <div class="error-messages">
+          <h2>
+            <%%= pluralize(@<%= authentication_model_name %>.errors.count, "error") %>
+            prohibited this guest from being saved:
+          </h2>
+
+          <ul>
+            <%% @<%= authentication_model_name %>.errors.each do |error| %>
+              <li><%%= error.full_message %></li>
+            <%% end %>
+          </ul>
+        </div>
+      <%% end %>
+
+<% guest_available_fields.each do |field| -%>
+<% field_type = guest_field_type(field) -%>
+<% required = guest_required_fields.include?(field) -%>
+<% label = field.humanize + (required ? " *" : "") -%>
+<% if field.match?(/(?:^|_)email(?:_|$)/) -%>
+      <div class="form-field">
+        <%%= form.email_field :<%= field %>,
+              class: "form-input",
+              placeholder: " ",
+              required: <%= required %> %>
+        <%%= form.label :<%= field %>, "<%= label %>", class: "form-label" %>
+      </div>
+
+<% elsif field.match?(/(?:^|_)(?:phone|telephone|mobile)(?:_|$)/) -%>
+      <div class="form-field">
+        <%%= form.telephone_field :<%= field %>,
+              class: "form-input",
+              placeholder: " ",
+              required: <%= required %> %>
+        <%%= form.label :<%= field %>, "<%= label %>", class: "form-label" %>
+      </div>
+
+<% elsif field.match?(/(?:^|_)(?:url|website|homepage)(?:_|$)/) -%>
+      <div class="form-field">
+        <%%= form.url_field :<%= field %>,
+              class: "form-input",
+              placeholder: " ",
+              required: <%= required %> %>
+        <%%= form.label :<%= field %>, "<%= label %>", class: "form-label" %>
+      </div>
+
+<% elsif field_type == :boolean -%>
+      <div class="form-field form-field--checkbox">
+        <%%= form.check_box :<%= field %>,
+              class: "form-checkbox",
+              required: <%= required %> %>
+        <%%= form.label :<%= field %>, "<%= label %>",
+              class: "form-label form-label--checkbox" %>
+      </div>
+
+<% elsif field_type == :text -%>
+      <div class="form-field form-field--textarea">
+        <%%= form.text_area :<%= field %>,
+              class: "form-textarea",
+              placeholder: " ",
+              required: <%= required %> %>
+        <%%= form.label :<%= field %>, "<%= label %>", class: "form-label" %>
+      </div>
+
+<% elsif field_type == :integer -%>
+      <div class="form-field">
+        <%%= form.number_field :<%= field %>,
+              class: "form-input",
+              placeholder: " ",
+              step: 1,
+              required: <%= required %> %>
+        <%%= form.label :<%= field %>, "<%= label %>", class: "form-label" %>
+      </div>
+
+<% elsif [:float, :decimal].include?(field_type) -%>
+      <div class="form-field">
+        <%%= form.number_field :<%= field %>,
+              class: "form-input",
+              placeholder: " ",
+              step: "any",
+              required: <%= required %> %>
+        <%%= form.label :<%= field %>, "<%= label %>", class: "form-label" %>
+      </div>
+
+<% elsif field_type == :date -%>
+      <div class="form-field">
+        <%%= form.date_field :<%= field %>,
+              class: "form-input",
+              required: <%= required %> %>
+        <%%= form.label :<%= field %>, "<%= label %>", class: "form-label" %>
+      </div>
+
+<% elsif [:datetime, :timestamp].include?(field_type) -%>
+      <div class="form-field">
+        <%%= form.datetime_local_field :<%= field %>,
+              class: "form-input",
+              required: <%= required %> %>
+        <%%= form.label :<%= field %>, "<%= label %>", class: "form-label" %>
+      </div>
+
+<% elsif field_type == :time -%>
+      <div class="form-field">
+        <%%= form.time_field :<%= field %>,
+              class: "form-input",
+              required: <%= required %> %>
+        <%%= form.label :<%= field %>, "<%= label %>", class: "form-label" %>
+      </div>
+
+<% else -%>
+      <div class="form-field">
+        <%%= form.text_field :<%= field %>,
+              class: "form-input",
+              placeholder: " ",
+              required: <%= required %> %>
+        <%%= form.label :<%= field %>, "<%= label %>", class: "form-label" %>
+      </div>
+
+<% end -%>
+<% end -%>
+
+      <div class="form-actions">
+        <%%= form.submit "Continue as guest", class: "form-submit" %>
+      </div>
+    <%% end %>
+  </section>
+</div>

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

@@ -362,6 +362,7 @@ module B4um
             - b4um index, show, new and edit views
             - Bento index layout by default
             - Optional table index layout
+            - Required fields with presence validation
             - Select fields with custom labels
             - Radio fields with custom labels
             - Automatic navigation entry
@@ -371,6 +372,19 @@ module B4um
             - Password field support
             - Optional readable URL parameters
 
+          Required fields can be generated with:
+
+            --required=FIELD,FIELD
+
+          Example:
+
+            bin/rails generate b4um:scaffold Customer first_name:string last_name:string company:string email:string --required=first_name,last_name,email
+
+          This adds a presence validation for the selected fields
+          to the generated model.
+
+          Fields not listed in --required remain optional.
+
           Select fields can be generated with:
 
             --select='FIELD:VALUE=LABEL,VALUE=LABEL'
@@ -597,6 +611,154 @@ module B4um
           helpers, routes or navigation controls.
 
 
+          ADMIN
+
+            bin/rails generate b4um:admin MODEL
+
+          Adds administrator user management to an existing
+          b4um authentication model.
+
+          Example:
+
+            bin/rails generate b4um:admin User
+            bin/rails db:migrate
+
+          The admin generator requires b4um authentication to be
+          installed for the selected model first.
+
+          Example setup:
+
+            bin/rails generate b4um:scaffold User name:string email:string password_digest:string
+            bin/rails generate b4um:authentication User
+            bin/rails generate b4um:admin User
+            bin/rails db:migrate
+
+          The generator adds two fields to the authentication model:
+
+            admin
+            blocked
+
+          Both fields are boolean values and default to false.
+
+          The generator also adds:
+
+            - Admin dashboard
+            - User management
+            - Admin-only controller protection
+            - Administrator routes
+            - Blocking and unblocking users
+            - Granting and revoking administrator rights
+            - Deleting users
+            - Protection against blocking your own account
+            - Protection against deleting your own account
+            - Protection against removing the last administrator
+            - Blocked session invalidation
+            - Blocked login prevention
+
+          The admin area is available at:
+
+            /admin
+
+          Only logged-in users with administrator rights can access
+          the admin area.
+
+          The first administrator is created from the command line.
+          This prevents public registration from granting administrator
+          rights.
+
+          Run:
+
+            bin/rails b4um:admin:create
+
+          Run bin/rails db:migrate before creating the first administrator.
+
+          The task asks for the authentication model fields automatically.
+
+          Additional authentication model fields are requested automatically.
+          Fields with an unconditional presence validation are marked with * and are required.
+          Optional fields can be left empty.
+
+          Email, password and password confirmation are always required.
+
+          The password is not displayed while it is entered.
+
+          Existing users cannot be converted to administrators with
+          this task. Administrator rights for existing users are
+          managed from the admin user management interface.
+
+          From the admin user management interface, administrators can:
+
+            - Block a user
+            - Unblock a user
+            - Grant administrator rights
+            - Revoke administrator rights
+            - Delete a user
+
+          A blocked user cannot log in. If a logged-in user becomes
+          blocked, the existing session is invalidated.
+
+          Administrators cannot block or delete their own account
+          through the generated user management interface.
+
+          The last administrator cannot lose administrator rights.
+
+
+          GUEST
+
+            bin/rails generate b4um:guest MODEL --required=FIELDS
+
+          Adds temporary guest access to an existing
+          b4um authentication model.
+
+          Example:
+
+            bin/rails generate b4um:guest User --required=first_name,email
+            bin/rails db:migrate
+
+          The guest generator requires b4um authentication to be
+          installed for the selected model first.
+
+          At least one field must be supplied with --required.
+          These fields are required when creating a guest account.
+
+          Additional suitable model fields are offered automatically
+          and remain optional unless included in --required.
+
+          The generator adds two fields to the authentication model:
+
+            guest
+            guest_expires_at
+
+          Guest accounts use the same authentication model as regular
+          accounts. No separate guest model is created.
+
+          Guest accounts receive an internal password automatically.
+          The guest does not need to choose or enter this password.
+
+          By default, guest access expires after 7 days.
+
+          A different lifetime can be configured with --expires-in:
+
+            bin/rails generate b4um:guest User --required=first_name,email --expires-in=14
+
+          Guest accounts can be converted into regular accounts.
+          The existing record is retained so existing account data
+          remains associated with the user.
+
+          During conversion, missing required account fields and a
+          password are requested.
+
+          Guest accounts approaching expiration receive a warning.
+          Expired guest accounts can be removed with:
+
+            bin/rails b4um:guests:cleanup
+
+          Run the cleanup task regularly in production to remove
+          expired guest accounts.
+
+          Run bin/rails db:migrate after installing guest access.
+
+
           ACTIVE STORAGE / IMAGES
 
           Image attachments require Active Storage.