thecore_ui_rails_admin 3.6.1 → 3.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: babf45ecdbfd260e90d7a50dedb8c40e5a3c881a0da48ea510f490f2aac0c2d7
-  data.tar.gz: 0b06f34722a73e632fddbb2dd12bcb760c7ec60aa5537056a7d3e2cf090af3ea
+  metadata.gz: 68bdc2c266f2da01e7c620cad865a2a41960dd7be738643d8a97bb52e09bc164
+  data.tar.gz: 60447392948bb9d54f028b2a8eb19d7fd5e8664e1202959de8ad0390cafcf55f
 SHA512:
-  metadata.gz: 5cd0d92cd912e7354d80b2a1323a9db11bb7233617f7f6d7c42d06669b9ece0f1b2226d40143baa64b93e21b19aa8f83104c1c25d0ea607d63c6577fe3b5e9cb
-  data.tar.gz: f7246b699c1ef4ca2a0647cb13d9a05a6995baaef3ca0236463cda571bf4a662009b2f52d896bcb8ecf55e17ea5e27b808464b62b366df5367e2b0da5373d8ec
+  metadata.gz: 4230e1a6cb30a8af5bca7ef1424c862ff8d235be31d17f6fa86163c12e3940d089e2b11cfe169021c3bed18ea576e3b932b85f05719319868267707b4e7733d1
+  data.tar.gz: ade89d04b3ab490a86c8753cb92c8a560ea2fe9da16248ffbcb8c30c9ac1251f13f7955bd386db9cc627b0d9c31fdc91832fb2ddcd0968cf3a5efaa12f16d452

data/README.md

@@ -2,6 +2,41 @@ This is part of [Thecore framework](https://github.com/gabrieletassoni/thecore/t
 
 ---
 
+## Default `navigation_label`/icon for models without a `RailsAdmin::ModelName` concern
+
+Per [ADR 0001](https://github.com/gabrieletassoni/thecore/blob/release/3/docs/adr/0001-application-record-defaults-over-generated-concerns.md)
+(host app), any `ApplicationRecord` subclass that does **not** define its own
+`RailsAdmin::ModelName` concern still gets a sensible `navigation_label` and
+a real default icon (`fa fa-table`) in the RailsAdmin sidebar, instead of
+falling back to RailsAdmin's own unconfigured default (no group / no icon).
+
+This is provided by `ThecoreUiRailsAdminDefaultNavigationConcern`
+(`config/initializers/concern_default_navigation.rb`), registered into
+[`ThecoreBackendCommons::DefaultModuleRegistry`](../thecore_backend_commons/README.md)
+so it is included automatically into every model at class-definition time —
+no generated concern file required.
+
+The default `navigation_label` reuses the exact same i18n key
+(`I18n.t('admin.registries.label')`) that the Thecore VS Code extension's
+`addModel` command already hardcodes into every freshly generated
+`RailsAdmin::ModelName` concern, so a model relying on this default reads
+identically, to an end user, to one whose generated-and-never-customized
+concern was kept around.
+
+**Field-level configuration is never defaulted** — `hide`, `sticky`,
+`configure :field`, custom `list`/`edit` blocks, etc. stay exclusively in
+hand-written `RailsAdmin::ModelName` concerns. A model that already has its
+own concern is unaffected: its own `navigation_label`/`navigation_icon` (if
+set) and all field-level config still win over/apply alongside the default.
+
+> **Temporary dependency note**: this feature requires
+> `ThecoreBackendCommons::DefaultModuleRegistry`, merged into
+> `thecore_backend_commons`'s `release/3` branch but not yet published to
+> RubyGems. The `Gemfile` pins a git source for this
+> (`github: "gabrieletassoni/thecore_backend_commons", branch: "release/3"`)
+> until a real release ships — remove it once `thecore_backend_commons`
+> cuts a version satisfying the gemspec's `>= 3.4` constraint.
+
 ## Push Notification Test (RailsAdmin root action)
 
 A built-in admin UI for sending Web Push test notifications. It lets you pick one or more active subscribers and fire a real notification immediately — useful for verifying the end-to-end VAPID setup without writing any code.

data/app/views/rails_admin/main/push_notification_test.html.erb

@@ -1,7 +1,7 @@
 <span class="hide-toolbar"></span>
 
 <div class="container mt-4">
-  <h2>Push Notification Test</h2>
+  <h2><%= t("admin.actions.push_notification_test.title") %></h2>
 
   <% if flash[:success].present? %>
     <div class="alert alert-success"><%= flash[:success] %></div>
@@ -10,10 +10,41 @@
     <div class="alert alert-danger"><%= flash[:error] %></div>
   <% end %>
 
-  <%= form_with url: push_notification_test_path, method: :post, local: true do |form| %>
+  <datalist id="subscriber-email-list">
+    <% @subscriber_emails.each do |email| %>
+      <option value="<%= email %>">
+    <% end %>
+  </datalist>
+
+  <%= form_with url: push_notification_test_path, method: :get, local: true do |f| %>
+    <div class="card mb-4">
+      <div class="card-header d-flex align-items-center justify-content-between">
+        <h5 class="mb-0"><%= t("admin.actions.push_notification_test.filter_title") %></h5>
+        <span class="badge bg-secondary">
+          <%= t("admin.actions.push_notification_test.total_count", count: @total_count) %>
+        </span>
+      </div>
+      <div class="card-body">
+        <div class="input-group">
+          <%= f.text_field :q,
+                value: params[:q],
+                class: "form-control",
+                placeholder: t("admin.actions.push_notification_test.filter_placeholder"),
+                list: "subscriber-email-list",
+                autocomplete: "off" %>
+          <%= f.submit t("admin.actions.push_notification_test.filter_button"),
+                class: "btn btn-secondary" %>
+        </div>
+      </div>
+    </div>
+  <% end %>
+
+  <%= form_with url: push_notification_test_path, method: :post, local: true, id: "send-push-form" do |form| %>
+    <%= hidden_field_tag :q, params[:q] %>
+
     <div class="card mb-4">
       <div class="card-header">
-        <h5 class="mb-0">Select Subscribers</h5>
+        <h5 class="mb-0"><%= t("admin.actions.push_notification_test.select_subscribers") %></h5>
       </div>
       <div class="card-body">
         <% if @subscribers.any? %>
@@ -22,7 +53,7 @@
               <%= check_box_tag "subscriber_ids[]",
                     subscriber.id,
                     false,
-                    class: "form-check-input",
+                    class: "form-check-input subscriber-checkbox",
                     id: "subscriber_#{subscriber.id}" %>
               <label class="form-check-label" for="subscriber_<%= subscriber.id %>">
                 <strong><%= subscriber.user&.email || "user ##{subscriber.user_id}" %></strong>
@@ -33,44 +64,73 @@
               </label>
             </div>
           <% end %>
+        <% elsif params[:q].present? %>
+          <p class="text-muted"><%= t("admin.actions.push_notification_test.no_results") %></p>
         <% else %>
-          <p class="text-muted">No active subscribers found.</p>
+          <p class="text-muted">
+            <%= t("admin.actions.push_notification_test.disclaimer_no_filter", count: @total_count) %>
+          </p>
         <% end %>
       </div>
     </div>
 
-    <div class="card mb-4">
-      <div class="card-header">
-        <h5 class="mb-0">Message</h5>
-      </div>
-      <div class="card-body">
-        <div class="mb-3">
-          <%= form.label :title, "Title", class: "form-label" %>
-          <%= form.text_field :title, class: "form-control", required: true,
-                placeholder: "Notification title" %>
+    <% if @subscribers.any? %>
+      <div class="card mb-4">
+        <div class="card-header">
+          <h5 class="mb-0"><%= t("admin.actions.push_notification_test.message_title") %></h5>
         </div>
+        <div class="card-body">
+          <div class="mb-3">
+            <%= form.label :title, t("admin.actions.push_notification_test.title_label"), class: "form-label" %>
+            <%= form.text_field :title, class: "form-control", required: true,
+                  placeholder: t("admin.actions.push_notification_test.title_placeholder") %>
+          </div>
 
-        <div class="mb-3">
-          <%= form.label :body, "Body", class: "form-label" %>
-          <%= form.text_area :body, class: "form-control", rows: 3, required: true,
-                placeholder: "Notification body text" %>
-        </div>
+          <div class="mb-3">
+            <%= form.label :body, t("admin.actions.push_notification_test.body_label"), class: "form-label" %>
+            <%= form.text_area :body, class: "form-control", rows: 3,
+                  placeholder: t("admin.actions.push_notification_test.body_placeholder") %>
+          </div>
 
-        <div class="mb-3">
-          <%= form.label :url, "URL (optional)", class: "form-label" %>
-          <%= form.url_field :url, class: "form-control",
-                placeholder: "https://example.com/target-page" %>
-        </div>
+          <div class="mb-3">
+            <%= form.label :url, t("admin.actions.push_notification_test.url_label"), class: "form-label" %>
+            <%= form.url_field :url, class: "form-control",
+                  placeholder: "https://example.com/target-page" %>
+          </div>
 
-        <div class="mb-3">
-          <%= form.label :icon, "Icon URL (optional)", class: "form-label" %>
-          <%= form.url_field :icon, class: "form-control",
-                placeholder: "https://example.com/icon.png" %>
-        </div>
+          <div class="mb-3">
+            <%= form.label :icon, t("admin.actions.push_notification_test.icon_label"), class: "form-label" %>
+            <%= form.url_field :icon, class: "form-control",
+                  placeholder: "https://example.com/icon.png" %>
+          </div>
 
-        <%= form.submit "Send Test", class: "btn btn-primary",
-              disabled: @subscribers.empty? %>
+          <%= form.submit t("admin.actions.push_notification_test.send_button"),
+                class: "btn btn-primary",
+                id: "send-push-btn" %>
+        </div>
       </div>
-    </div>
+    <% end %>
   <% end %>
 </div>
+
+<script>
+  (function () {
+    var form = document.getElementById("send-push-form");
+    if (!form) return;
+
+    var threshold = <%= @large_subscriber_threshold %>;
+    var warningTemplate = "<%= j t('admin.actions.push_notification_test.large_selection_warning',
+                                    count: '__N__',
+                                    threshold: @large_subscriber_threshold) %>";
+
+    form.addEventListener("submit", function (e) {
+      var checked = form.querySelectorAll(".subscriber-checkbox:checked").length;
+      if (checked > threshold) {
+        var msg = warningTemplate.replace("__N__", checked);
+        if (!confirm(msg)) {
+          e.preventDefault();
+        }
+      }
+    });
+  })();
+</script>

data/config/initializers/concern_default_navigation.rb

@@ -0,0 +1,64 @@
+require 'active_support/concern'
+
+# Default RailsAdmin `navigation_label`/`navigation_icon` for any
+# `ApplicationRecord` subclass that has no explicit `RailsAdmin::ModelName`
+# concern of its own -- see ADR 0001
+# (vendor/external/thecore/docs/adr/0001-application-record-defaults-over-generated-concerns.md
+# in the host app) and GitHub issue
+# gabrieletassoni/thecore_ui_rails_admin#7.
+#
+# Registered into `ThecoreBackendCommons::DefaultModuleRegistry` below, so
+# it is `include`d automatically into every model at class-definition time
+# (via `ApplicationRecord.inherited`) instead of requiring a per-model
+# `RailsAdmin::ModelName` concern file to be generated just to get these two
+# mechanically-derivable values.
+#
+# Deliberately does NOT default any field-level configuration (`hide`,
+# `sticky`, `configure :field`, custom `list`/`edit` blocks, ...) -- per
+# ADR 0001's research, every existing hand-written `RailsAdmin::ModelName`
+# concern in the `mytask` engine carries real field-level content, so only
+# the navigation bits below are safe to default. Field-level config stays
+# exclusively in hand-written concerns.
+#
+# `navigation_label` intentionally reuses the exact SAME fixed i18n key
+# (`I18n.t('admin.registries.label')`) that the Thecore VS Code extension's
+# `addModel` template
+# (vendor/external/thecore_code_extension/templates/addModel/rails_admin_concern.rb
+# in the host app) already hardcodes into every freshly generated
+# `RailsAdmin::ModelName` concern -- so a model relying on this default
+# looks, to an end user, exactly like one whose generated-and-never-customized
+# concern was kept around. `DEFAULT_ICON` is a real, ready-to-use FontAwesome
+# icon (no "TODO: customize" placeholder needed).
+#
+# == Why an explicit concern's own `navigation_label`/`navigation_icon` wins
+#
+# This module is `include`d into a model class from
+# `ApplicationRecord.inherited`, which fires -- and so evaluates this
+# `included do rails_admin do ... end end` block, registering RailsAdmin's
+# *first* deferred config block for that model -- before the model class
+# body itself runs its own `include RailsAdmin::ModelName` statement, whose
+# block is registered *second*. RailsAdmin evaluates same-origin deferred
+# blocks in registration order (see
+# `RailsAdmin::Config::LazyModel#target` in the `rails_admin` gem), and
+# `navigation_label`/`navigation_icon` are plain last-write-wins setters
+# (see `RailsAdmin::Config::Configurable::ClassMethods#register_instance_option`),
+# so whichever call runs last -- the hand-written concern's, when present --
+# overrides the default set here.
+module ThecoreUiRailsAdminDefaultNavigationConcern
+  extend ActiveSupport::Concern
+
+  DEFAULT_ICON = 'fa fa-table'.freeze
+
+  included do
+    rails_admin do
+      navigation_label I18n.t('admin.registries.label')
+      navigation_icon ThecoreUiRailsAdminDefaultNavigationConcern::DEFAULT_ICON
+    end
+  end
+end
+
+Rails.application.config.to_prepare do
+  ThecoreBackendCommons::DefaultModuleRegistry.register(
+    ThecoreUiRailsAdminDefaultNavigationConcern
+  )
+end

data/config/locales/en.thecore_ui_ra.yml

@@ -60,6 +60,22 @@ en:
         breadcrumb: Test Push Notification
         success: "Sent test notification to %{count} subscriber(s)"
         error_blank_title: "Title can't be blank"
+        filter_title: "Filter Subscribers"
+        filter_placeholder: "Search by email..."
+        filter_button: "Search"
+        total_count: "%{count} active subscriber(s)"
+        disclaimer_no_filter: "There are %{count} active subscriber(s) in the system. Start typing an email address in the search field above to filter and select recipients."
+        no_results: "No active subscribers found for this email."
+        select_subscribers: "Select Subscribers"
+        message_title: "Message"
+        title_label: "Title"
+        title_placeholder: "Notification title"
+        body_label: "Body"
+        body_placeholder: "Notification body text"
+        url_label: "URL (optional)"
+        icon_label: "Icon URL (optional)"
+        send_button: "Send Test"
+        large_selection_warning: "You are about to send to %{count} subscriber(s). This may take a while. Do you want to continue?"
     scopes:
       _all: All
     flash:

data/config/locales/it.thecore_ui_ra.yml

@@ -60,6 +60,22 @@ it:
         breadcrumb: Test Notifica Push
         success: "Notifica di test inviata a %{count} sottoscrittore/i"
         error_blank_title: "Il titolo non può essere vuoto"
+        filter_title: "Filtra Subscriber"
+        filter_placeholder: "Cerca per email..."
+        filter_button: "Cerca"
+        total_count: "%{count} subscriber/i attivi"
+        disclaimer_no_filter: "Ci sono %{count} subscriber/i attivi nel sistema. Inizia a digitare un indirizzo email nel campo di ricerca per filtrare e selezionare i destinatari."
+        no_results: "Nessun subscriber attivo trovato per questa email."
+        select_subscribers: "Seleziona Subscriber"
+        message_title: "Messaggio"
+        title_label: "Titolo"
+        title_placeholder: "Titolo della notifica"
+        body_label: "Testo"
+        body_placeholder: "Testo del messaggio"
+        url_label: "URL (opzionale)"
+        icon_label: "URL icona (opzionale)"
+        send_button: "Invia Test"
+        large_selection_warning: "Stai per inviare a %{count} subscriber/i. L'operazione potrebbe richiedere del tempo. Vuoi continuare?"
     scopes:
       _all: Tutti
     flash:

data/lib/root_actions/push_notification_test.rb

@@ -1,3 +1,5 @@
+LARGE_SUBSCRIBER_THRESHOLD = 10
+
 RailsAdmin::Config::Actions.add_action "push_notification_test", :base, :root do
   show_in_sidebar true
   show_in_navigation false
@@ -12,7 +14,16 @@ RailsAdmin::Config::Actions.add_action "push_notification_test", :base, :root do
 
   controller do
     proc do
-      @subscribers = PushSubscriber.active.includes(:user)
+      @large_subscriber_threshold = LARGE_SUBSCRIBER_THRESHOLD
+      @total_count = PushSubscriber.active.count
+      @subscriber_emails = User.joins(:push_subscribers).merge(PushSubscriber.active).distinct.pluck(:email)
+
+      filter_query = params[:q].presence
+      @subscribers = if filter_query
+        PushSubscriber.active.includes(:user).joins(:user).where("users.email ILIKE ?", "%#{filter_query}%")
+      else
+        []
+      end
 
       if request.post?
         params.permit!

data/lib/thecore_ui_rails_admin/version.rb

@@ -1,3 +1,3 @@
 module ThecoreUiRailsAdmin
-  VERSION = "3.6.1".freeze
+  VERSION = "3.8.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: thecore_ui_rails_admin
 version: !ruby/object:Gem::Version
-  version: 3.6.1
+  version: 3.8.0
 platform: ruby
 authors:
 - Gabriele Tassoni
@@ -51,6 +51,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.18'
+- !ruby/object:Gem::Dependency
+  name: thecore_backend_commons
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.4'
 description: Holds all base dependencies and configurations to have a thecore integrated
   with Rails Admin.
 email:
@@ -103,6 +117,7 @@ files:
 - config/initializers/assets.rb
 - config/initializers/concern_action.rb
 - config/initializers/concern_bulk_delete.rb
+- config/initializers/concern_default_navigation.rb
 - config/initializers/concern_export.rb
 - config/initializers/concern_permission.rb
 - config/initializers/concern_permission_role.rb