madmin 3.1.2 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dde4d963db323d7d26197c454095beed2eff86ff40dcd9359e85ee480dd3bc13
-  data.tar.gz: 68566f86e2163ce2b7bf2fd12f6289d786fa118639936eff1aeef5f84feea616
+  metadata.gz: d296cf7cb6a9354c9592abe179e09f696c1d57d29b180832a89b5cbc40bd0af9
+  data.tar.gz: 413c7d5f5f4182c623e1e396a8cec662c3ddc6a6b3fa154bdbed42ea85de655a
 SHA512:
-  metadata.gz: 0c2206a2935ec06380389dbca3109acabf2a3f0af8d84105d964b9551bde50c30c8746403aa718b0acd9e397efecb7fe70e74f9b8704d5a2c3d7d8474898305f
-  data.tar.gz: eb2128311c6fd923d69f3d58955e7c9e0bdf322a8949532fc156ec8fec6bba4ab6afd6771d4b06df584a3939ef67ba5879dad16da75611d37816857b92d9582f
+  metadata.gz: d8ec5350c6adb616086c148e18323a16bb6ea06049e96c2731b4c2ffe1a23208493265415772833c44ea6684e9909e289a27d6447378fad79682a5ae0f64f017
+  data.tar.gz: 07a42b02500a2bb14eae9d2817b75f54c7798917b76fdf39aefa6c66d8dcf813cc3553842643db20abf12e5998a7de9c695226eb843966a5430cd40ca5033222

data/app/assets/stylesheets/madmin/pagination.css

@@ -1,4 +1,7 @@
 .pagination {
+  display: flex;
+  flex-wrap: wrap;
+  align-items: center;
   padding: 0.5rem;
 }
 
@@ -44,3 +47,16 @@
 .pagination-info {
   margin-left: 0.5rem;
 }
+
+.per-page {
+  display: inline-flex;
+  gap: 0.5rem;
+  align-items: center;
+  margin-left: auto;
+  font-size: 0.875rem;
+
+  a[aria-current="true"] {
+    color: var(--text-color);
+    font-weight: 600;
+  }
+}

data/app/controllers/madmin/resource_controller.rb

@@ -91,7 +91,7 @@ module Madmin
     # Returns [page, records]. Override for non-ActiveRecord collections and
     # return an object responding to the Madmin::Page interface.
     def paginate_collection(collection)
-      paginate(collection, page: params[:page])
+      paginate(collection, page: params[:page], per_page: Madmin::Page.per_page_for(params[:per_page]))
     end
 
     def valid_scope

data/app/helpers/madmin/application_helper.rb

@@ -19,5 +19,23 @@ module Madmin
     def index_path_with(**changes)
       resource.index_path(request.query_parameters.symbolize_keys.except(:page).merge(changes))
     end
+
+    # The current URL with some params changed, or removed when nil. Works on
+    # any page, unlike index_path_with
+    def current_path_with(changes)
+      "#{request.path}?#{request.query_parameters.merge(changes).compact.to_query}"
+    end
+
+    # Hidden fields carrying the current index params through a GET form, so
+    # submitting it keeps what index_path_with keeps. Pass the params the form
+    # sets itself in except
+    def index_params_fields(except: [])
+      query = request.query_parameters.except("page", *except.map(&:to_s)).to_query
+      fields = query.split("&").map do |pair|
+        name, value = pair.split("=", 2).map { |part| CGI.unescape(part) }
+        hidden_field_tag name, value, id: nil
+      end
+      safe_join(fields, "\n")
+    end
   end
 end

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

@@ -6,9 +6,7 @@
 
   <div id="filters" class="filters" popover data-controller="filters">
     <%= form_with url: resource.index_path, method: :get, skip_enforcing_utf8: true do %>
-      <% request.query_parameters.slice("q", "scope", "sort", "direction").each do |name, value| %>
-        <%= hidden_field_tag name, value, id: nil %>
-      <% end %>
+      <%= index_params_fields except: [:filters] %>
 
       <p class="filters-heading"><%= t("madmin.filters.heading") %></p>
 

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

@@ -1,8 +1,7 @@
 <div class="pagination">
   <% if page.last > 1 %>
-    <% page_url = ->(number) { "#{request.path}?#{request.query_parameters.merge(page.param => number).to_query}" } %>
     <nav class="pages" aria-label="<%= t("madmin.pagination.label") %>">
-      <%= link_to_if page.prev, "<", page.prev && page_url.call(page.prev), aria: { label: t("madmin.pagination.previous") } do %>
+      <%= link_to_if page.prev, "<", page.prev && current_path_with(page.param => page.prev), aria: { label: t("madmin.pagination.previous") } do %>
         <a role="link" aria-disabled="true" aria-label="<%= t("madmin.pagination.previous") %>">&lt;</a>
       <% end %>
 
@@ -12,11 +11,11 @@
         <% elsif number == page.page %>
           <a role="link" aria-disabled="true" aria-current="page"><%= number %></a>
         <% else %>
-          <%= link_to number, page_url.call(number) %>
+          <%= link_to number, current_path_with(page.param => number) %>
         <% end %>
       <% end %>
 
-      <%= link_to_if page.next, ">", page.next && page_url.call(page.next), aria: { label: t("madmin.pagination.next") } do %>
+      <%= link_to_if page.next, ">", page.next && current_path_with(page.param => page.next), aria: { label: t("madmin.pagination.next") } do %>
         <a role="link" aria-disabled="true" aria-label="<%= t("madmin.pagination.next") %>">&gt;</a>
       <% end %>
     </nav>
@@ -29,4 +28,6 @@
       <%= t("madmin.pagination.info", from: page.from, to: page.to, count: page.count) %>
     <% end %>
   </span>
+
+  <%= render "per_page", page: page if page.resizable? %>
 </div>

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

@@ -0,0 +1,10 @@
+<nav class="per-page" aria-label="<%= t("madmin.pagination.per_page") %>">
+  <span><%= t("madmin.pagination.per_page") %></span>
+  <% page.per_page_options.each do |size| %>
+    <% if size == page.per_page %>
+      <a role="link" aria-disabled="true" aria-current="true"><%= size %></a>
+    <% else %>
+      <%= link_to size, current_path_with(page.param => nil, page.per_page_param => size) %>
+    <% end %>
+  <% end %>
+</nav>

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

@@ -6,12 +6,8 @@
   <div class="actions">
     <form class="search">
       <%= hidden_field_tag :page, params[:page], value: 1 %>
+      <%= index_params_fields except: [:q] %>
       <%= search_field_tag :q, params[:q], placeholder: t("madmin.search.placeholder") %>
-      <% filters.map(&:to_h).each do |filter| %>
-        <% filter.each do |name, value| %>
-          <%= hidden_field_tag "filters[][#{name}]", value, id: nil %>
-        <% end %>
-      <% end %>
     </form>
 
     <%= link_to clear_search_params, class: "btn btn-secondary" do %>

data/config/locales/el.yml

@@ -48,6 +48,7 @@ el:
       next: Επόμενη
       info: "Εμφάνιση %{from}-%{to} από %{count}"
       empty: Δεν βρέθηκαν εγγραφές
+      per_page: Ανά σελίδα
     filters:
       button: "Φίλτρα"
       heading: "Εμφάνιση εγγραφών όπου"

data/config/locales/en.yml

@@ -48,6 +48,7 @@ en:
       next: Next
       info: "Displaying %{from}-%{to} of %{count}"
       empty: No records found
+      per_page: Per page
     filters:
       button: "Filters"
       heading: "Show records where"

data/config/locales/fr.yml

@@ -48,6 +48,7 @@ fr:
       next: Suivant
       info: "Affichage de %{from} à %{to} sur %{count}"
       empty: Aucun enregistrement trouvé
+      per_page: Par page
     filters:
       button: "Filtres"
       heading: "Afficher les enregistrements où"

data/config/locales/ko.yml

@@ -47,6 +47,7 @@ ko:
       next: 다음
       info: "%{count}개 중 %{from}-%{to} 표시"
       empty: 레코드가 없습니다
+      per_page: 페이지당
     filters:
       button: "필터"
       heading: "다음 조건의 레코드 표시"

data/lib/madmin/fields/has_many.rb

@@ -38,7 +38,9 @@ module Madmin
 
       def paginated_value(record, params)
         page_key = "#{attribute_name}_page"
-        paginate value(record), page: params[page_key], param: page_key
+        per_page = Madmin::Page.per_page_for(params["#{attribute_name}_per_page"])
+
+        paginate value(record), page: params[page_key], per_page: per_page, param: page_key
       end
     end
   end

data/lib/madmin/page.rb

@@ -5,9 +5,22 @@ module Madmin
   # these (or any object responding to the same methods) alongside their records.
   class Page
     SERIES_SLOTS = 7
+    PER_PAGE_OPTIONS = [20, 50, 100, 200].freeze
 
     attr_reader :count, :page, :per_page, :param
 
+    # The page size for a request param. Invalid sizes fall back to the default
+    # and large ones are capped. Sizes passed to Page.new directly aren't capped
+    def self.per_page_for(param)
+      size = param.to_s.to_i
+      size.positive? ? [size, max_per_page].min : Madmin.per_page
+    end
+
+    def self.max_per_page
+      [PER_PAGE_OPTIONS.max, Madmin.per_page].max
+    end
+    private_class_method :max_per_page
+
     def initialize(count:, page: 1, per_page: Madmin.per_page, param: :page)
       @count = count.to_i
       @per_page = [per_page.to_i, 1].max
@@ -15,6 +28,21 @@ module Madmin
       @param = param.to_s
     end
 
+    # The param carrying the page size: "per_page", or "posts_per_page" for a "posts_page" param
+    def per_page_param
+      "#{param.delete_suffix("page")}per_page"
+    end
+
+    # Page sizes to offer, always including the default and the current one
+    def per_page_options
+      (PER_PAGE_OPTIONS | [Madmin.per_page, per_page]).sort
+    end
+
+    # Whether a different page size would change what's shown
+    def resizable?
+      count > per_page_options.min
+    end
+
     def last
       [(count.to_f / per_page).ceil, 1].max
     end

data/lib/madmin/version.rb

@@ -1,3 +1,3 @@
 module Madmin
-  VERSION = "3.1.2"
+  VERSION = "3.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: madmin
 version: !ruby/object:Gem::Version
-  version: 3.1.2
+  version: 3.2.0
 platform: ruby
 authors:
 - Chris Oliver
@@ -113,6 +113,7 @@ files:
 - app/views/madmin/application/_missing_resource.html.erb
 - app/views/madmin/application/_navigation.html.erb
 - app/views/madmin/application/_pagination.html.erb
+- app/views/madmin/application/_per_page.html.erb
 - app/views/madmin/application/edit.html.erb
 - app/views/madmin/application/index.html.erb
 - app/views/madmin/application/new.html.erb