madmin 2.3.3 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2862cda2a9f7f8cc5313b205404c21bc4bd2e3a9aa780dfe6ba708ef0db51c34
-  data.tar.gz: a6dd1ac4898938c31ab694c61ca9c7ac379510b3ab00cc9830d8df43d651aff5
+  metadata.gz: 0bfdf6827cb1ef98872c55b9c786c08d9e9f8def47a2a9fa8bc5a3552c3bbee8
+  data.tar.gz: b4c73bdb4cfebfc209e7edce32d926c0e32ef9a291c8404c755665e2bbdc62f3
 SHA512:
-  metadata.gz: 8958ec3db4a60cd9df3484a9eb864f6b273ef646ae5a631f13cc16f0d7870147998193552de77c4cef6aad57bf3d97db8bd3f18fa213304f35b430f5d60ac8c7
-  data.tar.gz: d0eb3ec050476cdd04beec7d6ec2cb3a5a1a10d47dbab182b19236b2d8d3a0b90bebdbda04a0e8f5f875a2b695379095a3681470178669a9bc23ccdcb1e55a22
+  metadata.gz: 4d973242c54c9f3da6f0fbf8110b8c14b221d1d63841c1056d2e0310a4464869f638c7e20dad217a9d5f014853258fb482b40e84642462afeeda7a39af0477f0
+  data.tar.gz: 349dc39b717ce028990db3935de771396b0d6a62f877997b37231447d9fed6163bf57651245a9b5bb085c3edb37f8cf3c28e748ea546c3c45ab59da6e68241d2

data/README.md

@@ -158,6 +158,40 @@ class PostResource < Madmin::Resource
 end
 ```
 
+## Actions
+
+### Member Actions
+
+`member_action` lets you add custom buttons to a resource's **show** page. Each block receives the current `record` and is rendered in the header's `.actions` div:
+
+```ruby
+class PostResource < Madmin::Resource
+  member_action do |record|
+    link_to "Publish", publish_admin_post_path(record), class: "btn btn-secondary"
+  end
+end
+```
+
+### Collection Actions
+
+`collection_action` is the index-page counterpart to `member_action`. Blocks are rendered in the index header's `.actions` div, immediately before the built-in "New \<Resource\>" link.
+
+Unlike `member_action`, blocks receive **no** arguments. Each block is `instance_exec`-ed on the index view context, so `link_to`, route helpers, `policy`, `current_user`, `params`, `resource`, and `@records` are all available. Multiple blocks render in registration order.
+
+Each block is responsible for its own authorization gating — if a button should be hidden for some users, guard it inside the block.
+
+```ruby
+class PostResource < Madmin::Resource
+  collection_action do
+    link_to "Bulk Import", bulk_import_admin_posts_path, class: "btn btn-secondary"
+  end
+
+  collection_action do
+    link_to "Export CSV", export_admin_posts_path(format: :csv), class: "btn btn-secondary"
+  end
+end
+```
+
 ## Authentication
 
 You can use a couple of strategies to authenticate users who are trying to

data/app/views/layouts/madmin/application.html.erb

@@ -8,7 +8,7 @@
       <% if content_for? :title %>
         <%= yield(:title) %> -
       <% end %>
-      <%= Madmin.site_name %> Admin
+      <%= Madmin.site_name %> <%= t("madmin.layout.admin_suffix") %>
     </title>
     <%= csrf_meta_tags %>
     <%= render "javascript" %>
@@ -19,7 +19,7 @@
     </header>
     <header id="navbar">
       <div class="nav-group">
-        <button id="hamburger-menu" type="button" data-action="click->mobile-nav#toggle" aria-label="Open menu" aria-expanded="false" aria-controls="sidebar">
+        <button id="hamburger-menu" type="button" data-action="click->mobile-nav#toggle" aria-label="<%= t("madmin.layout.open_menu") %>" aria-expanded="false" aria-controls="sidebar">
           <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 20 20" fill="currentColor" class="size-5"> <path fill-rule="evenodd" d="M2 4.75A.75.75 0 0 1 2.75 4h14.5a.75.75 0 0 1 0 1.5H2.75A.75.75 0 0 1 2 4.75ZM2 10a.75.75 0 0 1 .75-.75h14.5a.75.75 0 0 1 0 1.5H2.75A.75.75 0 0 1 2 10Zm0 5.25a.75.75 0 0 1 .75-.75h14.5a.75.75 0 0 1 0 1.5H2.75a.75.75 0 0 1-.75-.75Z" clip-rule="evenodd" /> </svg>
         </button>
         <%= link_to Madmin.site_name, try(:root_url) || madmin_root_url, data: {turbo: false}  %>

data/app/views/madmin/application/_form.html.erb

@@ -1,7 +1,7 @@
 <%= form_with model: [:madmin, record], url: (record.persisted? ? resource.show_path(record) : resource.index_path), local: true do |form| %>
   <% if form.object.errors.any? %>
     <div class="alert alert-danger">
-      <div class="">There was <%= pluralize form.object.errors.full_messages.count, "error" %> with your submission:</div>
+      <div class=""><%= t("madmin.form.errors", count: form.object.errors.full_messages.count) %>:</div>
 
       <ul>
         <% form.object.errors.full_messages.each do |message| %>
@@ -20,5 +20,5 @@
   <% end %>
 
   <%= form.submit class: "btn btn-primary" %>
-  <%= link_to "Cancel", (record.persisted? ? resource.show_path(record) : resource.index_path), class: "btn" %>
+  <%= link_to t("madmin.actions.cancel"), (record.persisted? ? resource.show_path(record) : resource.index_path), class: "btn" %>
 <% end %>

data/app/views/madmin/application/_missing_resource.html.erb

@@ -1,6 +1,6 @@
-<div class="error"><%= resource_name %> is missing.</div>
+<div class="error"><%= t("madmin.missing_resource.message", resource: resource_name) %></div>
 <% if Rails.env.development? %>
-<div>Create it by running:
+<div><%= t("madmin.missing_resource.create_hint") %>
   <code>
     bin/rails generate madmin:resource <%= resource_name.split("Resource").first %>
   </code>

data/app/views/madmin/application/_navigation.html.erb

@@ -1,5 +1,5 @@
 <nav>
-  <%= nav_link_to "Dashboard", madmin_root_path %>
+  <%= nav_link_to t("madmin.navigation.dashboard"), madmin_root_path %>
 
   <% Madmin.menu.render do |item| %>
     <% if item.url %>
@@ -17,6 +17,6 @@
 <footer>
   <%= link_to "https://github.com/excid3/madmin", target: :_blank do %>
     <svg viewBox="0 0 16 16" height="1rem" width="1rem" fill="currentColor" aria-hidden="true"><path d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0016 8c0-4.42-3.58-8-8-8z"></path></svg>
-    Madmin on GitHub
+    <%= t("madmin.navigation.github") %>
   <% end %>
 </footer>

data/app/views/madmin/application/edit.html.erb

@@ -1,10 +1,10 @@
-<%= content_for :title, "Edit #{resource.display_name(@record)}" %>
+<%= content_for :title, t("madmin.titles.edit", name: resource.display_name(@record)) %>
 
 <header class="header">
   <h1>
     <%= link_to resource.friendly_name.pluralize, resource.index_path %>
     /
-    <strong>Edit <%= link_to resource.display_name(@record), resource.show_path(@record) %></strong>
+    <strong><%= t("madmin.actions.edit") %> <%= link_to resource.display_name(@record), resource.show_path(@record) %></strong>
   </h1>
 </header>
 

data/app/views/madmin/application/index.html.erb

@@ -6,7 +6,7 @@
   <div class="actions">
     <form class="search">
       <%= hidden_field_tag :page, params[:page], value: 1 %>
-      <%= search_field_tag :q, params[:q], placeholder: "Search" %>
+      <%= search_field_tag :q, params[:q], placeholder: t("madmin.search.placeholder") %>
     </form>
 
     <%= link_to clear_search_params, class: "btn btn-secondary" do %>
@@ -15,15 +15,19 @@
       </svg>
       <% end if params[:q].present? %>
 
+    <% resource.collection_actions.each do |action| %>
+      <%= instance_exec(&action) %>
+    <% end %>
+
     <%= link_to resource.new_path, class: "btn btn-secondary" do %>
-      New <%= tag.span resource.friendly_name, class: "hidden md:inline-block" %>
+      <%= t("madmin.actions.new") %> <%= tag.span resource.friendly_name, class: "hidden md:inline-block" %>
     <% end %>
   </div>
 </header>
 
 <nav class="scopes">
   <% if resource.scopes.any? %>
-    <%= link_to "All", resource.index_path, class: class_names("btn btn-secondary", {"active" => params[:scope].blank?}) %>
+    <%= link_to t("madmin.actions.all"), resource.index_path, class: class_names("btn btn-secondary", {"active" => params[:scope].blank?}) %>
   <% end %>
 
   <% resource.scopes.each do |scope| %>
@@ -55,8 +59,8 @@
           <% end %>
 
           <td>
-            <%= link_to "View", resource.show_path(record) %>
-            <%= link_to "Edit", resource.edit_path(record) %>
+            <%= link_to t("madmin.actions.view"), resource.show_path(record) %>
+            <%= link_to t("madmin.actions.edit"), resource.edit_path(record) %>
           </td>
         </tr>
       <% end %>

data/app/views/madmin/application/new.html.erb

@@ -1,10 +1,10 @@
-<%= content_for :title, "New #{resource.friendly_name}" %>
+<%= content_for :title, t("madmin.titles.new", name: resource.friendly_name) %>
 
 <header class="header">
   <h1>
     <%= link_to resource.friendly_name.pluralize, resource.index_path %>
     /
-    <strong>New <%= resource.friendly_name %></strong>
+    <strong><%= t("madmin.titles.new", name: resource.friendly_name) %></strong>
   </h1>
 </header>
 

data/app/views/madmin/application/show.html.erb

@@ -11,8 +11,8 @@
     <% resource.member_actions.each do |action| %>
       <%= instance_exec(@record, &action) %>
     <% end %>
-    <%= link_to "Edit", resource.edit_path(@record), class: "btn btn-secondary" %>
-    <%= button_to "Delete", resource.show_path(@record), method: :delete, data: { turbo_confirm: "Are you sure?" }, class: "btn btn-danger" %>
+    <%= link_to t("madmin.actions.edit"), resource.edit_path(@record), class: "btn btn-secondary" %>
+    <%= button_to t("madmin.actions.delete"), resource.show_path(@record), method: :delete, data: { turbo_confirm: t("madmin.confirmations.delete") }, class: "btn btn-danger" %>
   </div>
 </header>
 

data/app/views/madmin/dashboard/show.html.erb

@@ -1,2 +1,2 @@
-<h1>Madmin Dashboard</h1>
-<p>Create <code>app/views/madmin/dashboard/show.html.erb</code> to customize your dashboard.</p>
+<h1><%= t("madmin.dashboard.title") %></h1>
+<p><%= t("madmin.dashboard.hint_html") %></p>

data/app/views/madmin/fields/attachment/_form.html.erb

@@ -5,7 +5,7 @@
     <%= render partial: field.to_partial_path("show"), locals: {field: field, record: record} %>
 
     <% if (value = field.value(record) && value&.attached?) %>
-      <%= link_to "Remove", Madmin.resource_for(value).show_path(value), data: { turbo_method: :delete, turbo_confirm: "Are you sure? You will lose any other changes."} %>
+      <%= link_to t("madmin.actions.remove"), Madmin.resource_for(value).show_path(value), data: { turbo_method: :delete, turbo_confirm: t("madmin.confirmations.remove_with_changes")} %>
     <% end %>
   </div>
 <% end %>

data/app/views/madmin/fields/attachment/_show.html.erb

@@ -5,5 +5,5 @@
     <%= link_to attachment.filename, main_app.url_for(attachment), target: :_blank, class: "text-blue-500 underline" %>
   <% end %>
 
-  <%= link_to "Remove", Madmin.resource_for(attachment).show_path(attachment), data: { turbo_method: :delete, turbo_confirm: "Are you sure? You will lose any other changes."} %>
+  <%= link_to t("madmin.actions.remove"), Madmin.resource_for(attachment).show_path(attachment), data: { turbo_method: :delete, turbo_confirm: t("madmin.confirmations.remove_with_changes")} %>
 <% end %>

data/app/views/madmin/fields/attachments/_index.html.erb

@@ -1 +1 @@
-<%= pluralize field.value(record).count, "attachment" %>
+<%= t("madmin.fields.attachment", count: field.value(record).count) %>

data/app/views/madmin/fields/nested_has_many/_fields.html.erb

@@ -11,7 +11,7 @@
     </div>
   <% end %>
 
-  <small><%= link_to "Remove", "#", data: { action: "click->nested-form#remove_association" } %></small>
+  <small><%= link_to t("madmin.actions.remove"), "#", data: { action: "click->nested-form#remove_association" } %></small>
 
   <%= f.hidden_field :_destroy %>
 <% end %>

data/app/views/madmin/fields/nested_has_many/_form.html.erb

@@ -23,6 +23,6 @@
   <% end %>
 
   <%= content_tag :div, class: '', data: { target:"nested-form.links" } do %>
-    <%= link_to "+ Add new", "#",  data: { action: "click->nested-form#add_association" } %>
+    <%= link_to t("madmin.nested_form.add_new"), "#",  data: { action: "click->nested-form#add_association" } %>
   <% end %>
 </div>

data/config/locales/en.yml

@@ -0,0 +1,40 @@
+en:
+  madmin:
+    layout:
+      open_menu: Open menu
+      admin_suffix: Admin
+    navigation:
+      dashboard: Dashboard
+      github: Madmin on GitHub
+    dashboard:
+      title: Madmin Dashboard
+      hint_html: Create <code>app/views/madmin/dashboard/show.html.erb</code> to customize your dashboard.
+    actions:
+      all: All
+      view: View
+      edit: Edit
+      delete: Delete
+      new: New
+      remove: Remove
+      cancel: Cancel
+    search:
+      placeholder: Search
+    titles:
+      new: New %{name}
+      edit: Edit %{name}
+    form:
+      errors:
+        one: There was 1 error with your submission
+        other: There were %{count} errors with your submission
+    confirmations:
+      delete: Are you sure?
+      remove_with_changes: Are you sure? You will lose any other changes.
+    nested_form:
+      add_new: "+ Add new"
+    fields:
+      attachment:
+        one: "%{count} attachment"
+        other: "%{count} attachments"
+    missing_resource:
+      message: "%{resource} is missing."
+      create_hint: "Create it by running:"

data/config/locales/fr.yml

@@ -0,0 +1,40 @@
+fr:
+  madmin:
+    layout:
+      open_menu: Ouvrir le menu
+      admin_suffix: Administration
+    navigation:
+      dashboard: Tableau de bord
+      github: Madmin sur GitHub
+    dashboard:
+      title: Tableau de bord Madmin
+      hint_html: Créez <code>app/views/madmin/dashboard/show.html.erb</code> pour personnaliser votre tableau de bord.
+    actions:
+      all: Tous
+      view: Voir
+      edit: Modifier
+      delete: Supprimer
+      new: Nouveau
+      remove: Retirer
+      cancel: Annuler
+    search:
+      placeholder: Rechercher
+    titles:
+      new: Nouveau %{name}
+      edit: Modifier %{name}
+    form:
+      errors:
+        one: Il y a eu 1 erreur dans votre soumission
+        other: Il y a eu %{count} erreurs dans votre soumission
+    confirmations:
+      delete: Êtes-vous sûr ?
+      remove_with_changes: Êtes-vous sûr ? Vous perdrez toutes les autres modifications.
+    nested_form:
+      add_new: "+ Ajouter"
+    fields:
+      attachment:
+        one: "%{count} pièce jointe"
+        other: "%{count} pièces jointes"
+    missing_resource:
+      message: "%{resource} est introuvable."
+      create_hint: "Pour le créer, exécutez :"

data/lib/generators/madmin/resource/templates/resource.rb.tt

@@ -17,6 +17,11 @@ class <%= class_name %>Resource < Madmin::Resource
   #   link_to "Do Something", some_path
   # end
 
+  # Add actions to the resource's index page
+  # collection_action do
+  #   link_to "Bulk Import", bulk_import_path, class: "btn btn-secondary"
+  # end
+
   # Customize the display name of records in the admin area.
   # def self.display_name(record) = record.name
 

data/lib/madmin/engine.rb

@@ -1,5 +1,3 @@
-require "importmap-rails"
-
 module Madmin
   class Engine < ::Rails::Engine
     isolate_namespace Madmin

data/lib/madmin/resource.rb

@@ -4,6 +4,7 @@ module Madmin
 
     class_attribute :attributes, default: ActiveSupport::OrderedHash.new
     class_attribute :member_actions, default: []
+    class_attribute :collection_actions, default: []
     class_attribute :scopes, default: []
     class_attribute :menu_options, instance_reader: false
 
@@ -11,6 +12,7 @@ module Madmin
       def inherited(base)
         base.attributes = attributes.dup
         base.member_actions = scopes.dup
+        base.collection_actions = collection_actions.dup
         base.scopes = scopes.dup
         super
       end
@@ -136,6 +138,10 @@ module Madmin
         member_actions << block
       end
 
+      def collection_action(&block)
+        collection_actions << block
+      end
+
       def field_for_type(type)
         {
           binary: Fields::String,

data/lib/madmin/version.rb

@@ -1,3 +1,3 @@
 module Madmin
-  VERSION = "2.3.3"
+  VERSION = "2.4.0"
 end

data/lib/madmin.rb

@@ -1,5 +1,4 @@
 require "madmin/engine"
-
 require "importmap-rails"
 require "stimulus-rails"
 require "turbo-rails"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: madmin
 version: !ruby/object:Gem::Version
-  version: 2.3.3
+  version: 2.4.0
 platform: ruby
 authors:
 - Chris Oliver
@@ -38,20 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.5'
-- !ruby/object:Gem::Dependency
-  name: propshaft
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: importmap-rails
   requirement: !ruby/object:Gem::Requirement
@@ -212,6 +198,8 @@ files:
 - app/views/madmin/fields/time/_show.html.erb
 - app/views/madmin/shared/_label.html.erb
 - config/importmap.rb
+- config/locales/en.yml
+- config/locales/fr.yml
 - lib/generators/madmin/field/field_generator.rb
 - lib/generators/madmin/field/templates/_form.html.erb
 - lib/generators/madmin/field/templates/_index.html.erb
@@ -285,7 +273,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.12
+rubygems_version: 4.0.18
 specification_version: 4
 summary: A modern admin for Ruby on Rails apps
 test_files: []