madmin 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0bfdf6827cb1ef98872c55b9c786c08d9e9f8def47a2a9fa8bc5a3552c3bbee8
-  data.tar.gz: b4c73bdb4cfebfc209e7edce32d926c0e32ef9a291c8404c755665e2bbdc62f3
+  metadata.gz: fd0df17707eadc918a0379fa955748a67f70255e1875befe53aa4837c3ae0bb1
+  data.tar.gz: ee70de4f5cbf5789e2325545352e45afb53006f7cde1c63601a132d8283f8179
 SHA512:
-  metadata.gz: 4d973242c54c9f3da6f0fbf8110b8c14b221d1d63841c1056d2e0310a4464869f638c7e20dad217a9d5f014853258fb482b40e84642462afeeda7a39af0477f0
-  data.tar.gz: 349dc39b717ce028990db3935de771396b0d6a62f877997b37231447d9fed6163bf57651245a9b5bb085c3edb37f8cf3c28e748ea546c3c45ab59da6e68241d2
+  metadata.gz: 898e0a9b8da25e3af1b08bf90525d488e441a3d7b09141f8528e3e2af9473098500492871ce3d330ac31702ee2b7b25f1b1e22aa9210efe6d2842f652040229a
+  data.tar.gz: 6347a3efb59bdd6a87c529580a4936833b9296d326a000c214813ee7aed24a158e13ac12f226da4d44e0fe1c6edcc6535fa34d2c493d546717c37dbcbdf9b551

data/README.md

@@ -172,6 +172,16 @@ class PostResource < Madmin::Resource
 end
 ```
 
+Pass `collection: true` to also render the action on the **index** page, in each row next to the built-in "View" and "Edit" links:
+
+```ruby
+class PostResource < Madmin::Resource
+  member_action collection: true 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.
@@ -192,6 +202,35 @@ class PostResource < Madmin::Resource
 end
 ```
 
+## Extending Madmin
+
+Madmin runs `ActiveSupport` load hooks on its core classes so you can extend them from an initializer without reopening or monkey patching them. This is the recommended way for engines and gems to add behavior to Madmin.
+
+| Hook | Base | Use it for |
+| --- | --- | --- |
+| `:madmin_resource` | `Madmin::Resource` | Adding to the resource DSL |
+| `:madmin_field` | `Madmin::Field` | Shared behavior across every field type |
+| `:madmin_search` | `Madmin::Search` | Customizing how the search query is built |
+| `:madmin_base_controller` | `Madmin::BaseController` | Layouts, helpers, `rescue_from`, authentication |
+| `:madmin_resource_controller` | `Madmin::ResourceController` | CRUD callbacks, scoping records, audit logging |
+
+Blocks are `class_eval`-ed on the base class, so `self` is the class itself:
+
+```ruby
+# config/initializers/madmin.rb
+ActiveSupport.on_load(:madmin_resource) do
+  # self == Madmin::Resource, so `extend` adds class-level DSL to every resource
+  extend MyAdmin::ResourceExtensions
+end
+
+ActiveSupport.on_load(:madmin_base_controller) do
+  # self == Madmin::BaseController
+  rescue_from Pundit::NotAuthorizedError, with: :admin_not_authorized
+end
+```
+
+Hooks registered after a class has already loaded run immediately, so ordering in your initializers doesn't matter. The controllers live in the engine's `app/` directory and are reloadable, which means their hooks re-run on every reload in development — keep the blocks idempotent.
+
 ## Authentication
 
 You can use a couple of strategies to authenticate users who are trying to

data/app/controllers/madmin/base_controller.rb

@@ -9,5 +9,7 @@ module Madmin
     end
 
     protect_from_forgery with: :exception
+
+    ActiveSupport.run_load_hooks(:madmin_base_controller, self)
   end
 end

data/app/controllers/madmin/resource_controller.rb

@@ -101,5 +101,7 @@ module Madmin
     def search_term
       @search_term ||= params[:q].to_s.strip
     end
+
+    ActiveSupport.run_load_hooks(:madmin_resource_controller, self)
   end
 end

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

@@ -61,6 +61,10 @@
           <td>
             <%= link_to t("madmin.actions.view"), resource.show_path(record) %>
             <%= link_to t("madmin.actions.edit"), resource.edit_path(record) %>
+
+            <% resource.collection_member_actions.each do |action| %>
+              <%= instance_exec(record, &action) %>
+            <% end %>
           </td>
         </tr>
       <% end %>

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

@@ -13,6 +13,7 @@ class <%= class_name %>Resource < Madmin::Resource
   # scope :published
 
   # Add actions to the resource's show page
+  # Pass collection: true to also render it in each row on the index page
   # member_action do |record|
   #   link_to "Do Something", some_path
   # end

data/lib/madmin/field.rb

@@ -61,5 +61,7 @@ module Madmin
     def paginateable?
       false
     end
+
+    ActiveSupport.run_load_hooks(:madmin_field, self)
   end
 end

data/lib/madmin/member_action.rb

@@ -0,0 +1,19 @@
+module Madmin
+  # Wraps a member action block along with its options so views can decide
+  # where to render it. Responds to `to_proc` and `call` so it can be used
+  # anywhere the raw block was.
+  class MemberAction
+    attr_reader :block
+
+    def initialize(collection: false, &block)
+      @collection = collection
+      @block = block
+    end
+
+    def collection? = @collection
+
+    def call(*args, &blk) = block.call(*args, &blk)
+
+    def to_proc = block
+  end
+end

data/lib/madmin/resource.rb

@@ -11,7 +11,7 @@ module Madmin
     class << self
       def inherited(base)
         base.attributes = attributes.dup
-        base.member_actions = scopes.dup
+        base.member_actions = member_actions.dup
         base.collection_actions = collection_actions.dup
         base.scopes = scopes.dup
         super
@@ -134,8 +134,13 @@ module Madmin
         attributes.values.select { |a| a.field.searchable? }
       end
 
-      def member_action(&block)
-        member_actions << block
+      def member_action(collection: false, &block)
+        member_actions << MemberAction.new(collection: collection, &block)
+      end
+
+      # Member actions that should also render in each row on the index page
+      def collection_member_actions
+        member_actions.select { |action| action.respond_to?(:collection?) && action.collection? }
       end
 
       def collection_action(&block)
@@ -267,5 +272,7 @@ module Madmin
         @menu_options.with_defaults(label: friendly_name.pluralize, url: index_path)
       end
     end
+
+    ActiveSupport.run_load_hooks(:madmin_resource, self)
   end
 end

data/lib/madmin/search.rb

@@ -56,5 +56,7 @@ module Madmin
     def column_to_query(attr)
       ::ActiveRecord::Base.connection.quote_column_name(attr)
     end
+
+    ActiveSupport.run_load_hooks(:madmin_search, self)
   end
 end

data/lib/madmin/version.rb

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

data/lib/madmin.rb

@@ -7,6 +7,7 @@ require "pagy"
 module Madmin
   autoload :Field, "madmin/field"
   autoload :GeneratorHelpers, "madmin/generator_helpers"
+  autoload :MemberAction, "madmin/member_action"
   autoload :Menu, "madmin/menu"
   autoload :Resource, "madmin/resource"
   autoload :ResourceBuilder, "madmin/resource_builder"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: madmin
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Chris Oliver
@@ -247,6 +247,7 @@ files:
 - lib/madmin/fields/text.rb
 - lib/madmin/fields/time.rb
 - lib/madmin/generator_helpers.rb
+- lib/madmin/member_action.rb
 - lib/madmin/menu.rb
 - lib/madmin/namespace.rb
 - lib/madmin/resource.rb