madmin 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 223251f99312a051f3fd6a6d926c6583347e2c78b255343bc66b3fb063ea8a54
-  data.tar.gz: cfab141916431f52d137bd7704c33cc4cd3b1781735062e2a9d173f9d9d7bee4
+  metadata.gz: e868d17abd508729232e7ebeebd4b79a8e69545b853276a700c60e61e5d6348c
+  data.tar.gz: b19043a0a2e7dd0ad6392f995b76812b434e54f73682eb163ca28e1aaeb4ad34
 SHA512:
-  metadata.gz: 7b1480b7df30ec0bba0f1937a7336bb8532f51cd8dc9c8de78fd73b686c132dd14083eec88a303938bfb4fdfa50827db570a3d899e40952799869dfe4795e756
-  data.tar.gz: e362a3d85149b1f1074ea21eaf6a6659e6c8f002a929f668a21583a286fc1824a2f3ede02997eafe75feaa20e0172345c54210180b7c537b44d0de4bca1eb0b0
+  metadata.gz: '09b7ec920a1c8ae8a1429db77cff71ca45574e379563db5a06648d5cd5434950597b99eed5b836f7834cdc5c71e9d68411f064cc78d363da848efde9a0ef1b1a'
+  data.tar.gz: 51b2b25ddabe18e8777c9eab9e34dd1b8afd74a05aae5671f2f94c85cb404043bcde8423d996033a9dd4fa07ee672ad36240e65e195166586afabc02d756237a

data/app/controllers/madmin/resource_controller.rb

@@ -1,5 +1,7 @@
 module Madmin
   class ResourceController < ApplicationController
+    include SortHelper
+
     before_action :set_record, except: [:index, :new, :create]
 
     def index
@@ -54,7 +56,7 @@ module Madmin
     end
 
     def scoped_resources
-      resource.model.send(valid_scope)
+      resource.model.send(valid_scope).order(sort_column => sort_direction)
     end
 
     def valid_scope

data/app/helpers/madmin/sort_helper.rb

@@ -0,0 +1,31 @@
+module Madmin
+  module SortHelper
+    def sortable(column, title, options = {})
+      matching_column = (column.to_s == sort_column)
+
+      link_to request.params.merge(sort: column, direction: sort_direction), options do
+        concat title
+        if matching_column
+          concat " "
+          concat tag.i(sort_direction == "asc" ? "▲" : "▼")
+        end
+      end
+    end
+
+    def sort_column
+      resource.sortable_columns.include?(params[:sort]) ? params[:sort] : default_sort_column
+    end
+
+    def sort_direction
+      ["asc", "desc"].include?(params[:direction]) ? params[:direction] : default_sort_direction
+    end
+
+    def default_sort_column
+      resource.try(:default_sort_column) || "created_at"
+    end
+
+    def default_sort_direction
+      resource.try(:default_sort_direction) || "desc"
+    end
+  end
+end

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

@@ -20,7 +20,7 @@
         <% next if attribute[:field].nil? %>
         <% next unless attribute[:field].visible?(action_name) %>
 
-        <th><%= attribute[:name].to_s.titleize %></th>
+        <th><%= sortable attribute[:name], attribute[:name].to_s.titleize %></th>
       <% end %>
       <th>Actions</th>
     </tr>

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

@@ -13,4 +13,13 @@ class <%= class_name %>Resource < Madmin::Resource
   # def self.display_name(record)
   #   record.name
   # end
+
+  # Uncomment this to customize the default sort column and direction.
+  # def self.default_sort_column
+  #   "created_at"
+  # end
+  #
+  # def self.default_sort_direction
+  #   "desc"
+  # end
 end

data/lib/madmin/resource.rb

@@ -70,7 +70,7 @@ module Madmin
       end
 
       def permitted_params
-        attributes.map { |a| a[:field].to_param }
+        attributes.filter_map { |a| a[:field].to_param if a[:field].visible?(:form) }
       end
 
       def display_name(record)
@@ -81,6 +81,10 @@ module Madmin
         model.respond_to? :friendly
       end
 
+      def sortable_columns
+        model.column_names
+      end
+
       private
 
       def field_for_type(name, type)

data/lib/madmin/version.rb

@@ -1,3 +1,3 @@
 module Madmin
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: madmin
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Chris Oliver
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-22 00:00:00.000000000 Z
+date: 2021-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -63,6 +63,7 @@ files:
 - app/controllers/madmin/dashboard_controller.rb
 - app/controllers/madmin/resource_controller.rb
 - app/helpers/madmin/application_helper.rb
+- app/helpers/madmin/sort_helper.rb
 - app/views/layouts/madmin/application.html.erb
 - app/views/madmin/application/_form.html.erb
 - app/views/madmin/application/_javascript.html.erb