madmin 2.6.0 → 3.1.0

data/lib/madmin/search.rb

@@ -2,20 +2,18 @@
 
 module Madmin
   class Search
-    attr_reader :query
+    attr_reader :query, :filters
 
-    def initialize(scoped_resource, resource, term)
+    def initialize(scoped_resource, resource, term, filters = [])
       @resource = resource
       @scoped_resource = scoped_resource
       @query = term
+      @filters = filters
     end
 
     def run
-      if query.blank?
-        @scoped_resource.all
-      else
-        search_results(@scoped_resource)
-      end
+      results = query.blank? ? @scoped_resource.all : search_results(@scoped_resource)
+      filters.reduce(results) { |scope, filter| filter.apply(scope) }
     end
 
     private

data/lib/madmin/version.rb

@@ -1,3 +1,3 @@
 module Madmin
-  VERSION = "2.6.0"
+  VERSION = "3.1.0"
 end

data/lib/madmin.rb

@@ -2,18 +2,21 @@ require "madmin/engine"
 require "importmap-rails"
 require "stimulus-rails"
 require "turbo-rails"
-require "pagy"
 
 module Madmin
   autoload :Field, "madmin/field"
+  autoload :Filter, "madmin/filter"
   autoload :GeneratorHelpers, "madmin/generator_helpers"
   autoload :MemberAction, "madmin/member_action"
   autoload :Menu, "madmin/menu"
+  autoload :Page, "madmin/page"
+  autoload :Pagination, "madmin/pagination"
   autoload :Resource, "madmin/resource"
   autoload :ResourceBuilder, "madmin/resource_builder"
   autoload :Search, "madmin/search"
 
   module Fields
+    autoload :Array, "madmin/fields/array"
     autoload :Attachment, "madmin/fields/attachment"
     autoload :Attachments, "madmin/fields/attachments"
     autoload :BelongsTo, "madmin/fields/belongs_to"
@@ -30,6 +33,7 @@ module Madmin
     autoload :Integer, "madmin/fields/integer"
     autoload :Json, "madmin/fields/json"
     autoload :NestedHasMany, "madmin/fields/nested_has_many"
+    autoload :NestedHasOne, "madmin/fields/nested_has_one"
     autoload :Password, "madmin/fields/password"
     autoload :Polymorphic, "madmin/fields/polymorphic"
     autoload :RichText, "madmin/fields/rich_text"
@@ -41,6 +45,7 @@ module Madmin
 
   mattr_accessor :importmap, default: Importmap::Map.new
   mattr_accessor :menu, default: Menu.new
+  mattr_accessor :per_page, default: 20
   mattr_accessor :site_name
   mattr_accessor :stylesheets, default: []
   mattr_accessor :resource_locations, default: []
@@ -48,6 +53,9 @@ module Madmin
   class MissingResource < StandardError
   end
 
+  class MissingRoute < StandardError
+  end
+
   class << self
     # Returns a Madmin::Resource class for the given object
     def resource_for(object)
@@ -58,6 +66,12 @@ module Madmin
       elsif (resource_name = sti_resource_name_for(object)) && Object.const_defined?(resource_name)
         resource_name.constantize
 
+      # A resource named differently from its model (`ArticleResource` for
+      # `Blog::Post`) still says which model it is for with `model`. Honor that
+      # declaration before giving up, so association cells can link to it.
+      elsif (resource = resource_declaring(object.class))
+        resource
+
       else
         raise MissingResource, <<~MESSAGE
           `#{object.class.name}Resource` is missing.
@@ -69,6 +83,28 @@ module Madmin
       end
     end
 
+    # The one resource whose `model` is +klass+ or, failing that, its nearest
+    # superclass, or nil. Two resources declaring the same model with neither
+    # matching its name is ambiguous, and guessing would silently link to the
+    # wrong admin page, so that raises.
+    def resource_declaring(klass)
+      declared = klass.ancestors.grep(Class).find { |ancestor| resources_by_model.key?(ancestor) }
+      return unless declared
+
+      candidates = resources_by_model[declared]
+      return candidates.first if candidates.one?
+
+      raise MissingResource, <<~MESSAGE
+        `#{declared.name}Resource` is missing, and #{candidates.map(&:name).join(", ")} all declare `model #{declared.name}`.
+
+        Madmin can't tell which one to use. Name one of them `#{declared.name}Resource`.
+      MESSAGE
+    end
+
+    def resources_by_model
+      @resources_by_model ||= resources.group_by(&:model)
+    end
+
     def resource_name_for(object)
       if object.is_a? ::ActiveStorage::Attached
         "ActiveStorage::AttachmentResource"
@@ -85,13 +121,19 @@ module Madmin
       end
     end
 
+    # Returns the Madmin::Resource class for a model or model name, falling
+    # back to the resource that declares the model when none is named after it
     def resource_by_name(name)
       "#{name}Resource".constantize
     rescue NameError
+      model = name.is_a?(Class) ? name : name.to_s.safe_constantize
+      resource = resource_declaring(model) if model
+      return resource if resource
+
       raise MissingResource, <<~MESSAGE
         #{name}Resource is missing. Create it by running:
 
-            bin/rails generate madmin:resource #{resource_name.split("Resource").first}
+            bin/rails generate madmin:resource #{name}
       MESSAGE
     end
 
@@ -101,6 +143,7 @@ module Madmin
 
     def reset_resources!
       @resources = nil
+      @resources_by_model = nil
       menu.reset
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: madmin
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Chris Oliver
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 7.0.0
-- !ruby/object:Gem::Dependency
-  name: pagy
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.5'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: importmap-rails
   requirement: !ruby/object:Gem::Requirement
@@ -107,25 +93,34 @@ files:
 - app/controllers/madmin/dashboard_controller.rb
 - app/controllers/madmin/resource_controller.rb
 - app/helpers/madmin/application_helper.rb
+- app/helpers/madmin/filters_helper.rb
 - app/helpers/madmin/nav_helper.rb
 - app/helpers/madmin/sort_helper.rb
 - app/javascript/madmin/application.js
 - app/javascript/madmin/controllers/application.js
+- app/javascript/madmin/controllers/filters_controller.js
 - app/javascript/madmin/controllers/index.js
 - app/javascript/madmin/controllers/mobile_nav_controller.js
 - app/javascript/madmin/controllers/nested_form_controller.js
 - app/javascript/madmin/controllers/select_controller.js
 - app/views/layouts/madmin/application.html.erb
+- app/views/madmin/application/_active_filters.html.erb
+- app/views/madmin/application/_filter.html.erb
+- app/views/madmin/application/_filters.html.erb
 - app/views/madmin/application/_flash.html.erb
 - app/views/madmin/application/_form.html.erb
 - app/views/madmin/application/_javascript.html.erb
 - 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/edit.html.erb
 - app/views/madmin/application/index.html.erb
 - app/views/madmin/application/new.html.erb
 - app/views/madmin/application/show.html.erb
 - app/views/madmin/dashboard/show.html.erb
+- app/views/madmin/fields/array/_form.html.erb
+- app/views/madmin/fields/array/_index.html.erb
+- app/views/madmin/fields/array/_show.html.erb
 - app/views/madmin/fields/attachment/_form.html.erb
 - app/views/madmin/fields/attachment/_index.html.erb
 - app/views/madmin/fields/attachment/_show.html.erb
@@ -175,6 +170,7 @@ files:
 - app/views/madmin/fields/nested_has_many/_form.html.erb
 - app/views/madmin/fields/nested_has_many/_index.html.erb
 - app/views/madmin/fields/nested_has_many/_show.html.erb
+- app/views/madmin/fields/nested_has_one/_form.html.erb
 - app/views/madmin/fields/password/_form.html.erb
 - app/views/madmin/fields/password/_index.html.erb
 - app/views/madmin/fields/password/_show.html.erb
@@ -225,6 +221,7 @@ files:
 - lib/madmin.rb
 - lib/madmin/engine.rb
 - lib/madmin/field.rb
+- lib/madmin/fields/array.rb
 - lib/madmin/fields/attachment.rb
 - lib/madmin/fields/attachments.rb
 - lib/madmin/fields/belongs_to.rb
@@ -241,6 +238,7 @@ files:
 - lib/madmin/fields/integer.rb
 - lib/madmin/fields/json.rb
 - lib/madmin/fields/nested_has_many.rb
+- lib/madmin/fields/nested_has_one.rb
 - lib/madmin/fields/password.rb
 - lib/madmin/fields/polymorphic.rb
 - lib/madmin/fields/rich_text.rb
@@ -248,10 +246,13 @@ files:
 - lib/madmin/fields/string.rb
 - lib/madmin/fields/text.rb
 - lib/madmin/fields/time.rb
+- lib/madmin/filter.rb
 - lib/madmin/generator_helpers.rb
 - lib/madmin/member_action.rb
 - lib/madmin/menu.rb
 - lib/madmin/namespace.rb
+- lib/madmin/page.rb
+- lib/madmin/pagination.rb
 - lib/madmin/resource.rb
 - lib/madmin/resource_builder.rb
 - lib/madmin/search.rb
@@ -276,7 +277,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.16
+rubygems_version: 4.0.20
 specification_version: 4
 summary: A modern admin for Ruby on Rails apps
 test_files: []