madmin 2.5.1 → 3.0.0

data/lib/madmin/resource.rb

@@ -37,6 +37,13 @@ module Madmin
         scopes << name
       end
 
+      # Label for a scope button on the index. Looks up
+      # madmin.scopes.<param_key>.<name>, then madmin.scopes.<name> in I18n,
+      # falling back to the humanized scope name. Override for custom labels.
+      def scope_label(name)
+        I18n.t("madmin.scopes.#{param_key}.#{name}", default: [:"madmin.scopes.#{name}", name.to_s.humanize])
+      end
+
       def get_attribute(name)
         attributes[name]
       end
@@ -76,8 +83,21 @@ module Madmin
 
       # Returns singular name
       # For example: "Forum::Post" -> "Forum / Post"
+      #
+      # Uses the model's translation (`activerecord.models.forum/post`) when there is one
       def friendly_name
-        model_name.split("::").map { |part| part.underscore.humanize }.join(" / ").titlecase
+        translated_name || model_name.split("::").map { |part| part.underscore.humanize }.join(" / ").titlecase
+      end
+
+      # Returns plural name
+      # For example: "Forum::Post" -> "Forum / Posts"
+      def friendly_plural_name
+        singular = translated_name
+        return friendly_name.pluralize unless singular
+
+        # A translation without `one` / `other` forms is the same for every count
+        return translated_name(count: 2) if plural_translation? || !locale_inflections?
+        singular.pluralize(I18n.locale)
       end
 
       # Support for isolated namespaces
@@ -91,19 +111,28 @@ module Madmin
       end
 
       def index_path(options = {})
-        url_helpers.polymorphic_path([:madmin, route_namespace, model], options)
+        route_path([:madmin, route_namespace, model], options)
       end
 
       def new_path
-        url_helpers.polymorphic_path([:madmin, route_namespace, model], action: :new)
+        route_path([:madmin, route_namespace, model], action: :new)
       end
 
       def show_path(record)
-        url_helpers.polymorphic_path([:madmin, route_namespace, becomes(record)])
+        route_path([:madmin, route_namespace, becomes(record)])
       end
 
       def edit_path(record)
-        url_helpers.polymorphic_path([:madmin, route_namespace, becomes(record)], action: :edit)
+        route_path([:madmin, route_namespace, becomes(record)], action: :edit)
+      end
+
+      # Whether a route is drawn for the given action on this resource's controller
+      # For example: PostResource.route?(:destroy)
+      def route?(action)
+        controller = "madmin/#{model.model_name.collection}"
+        Rails.application.routes.routes.any? do |route|
+          route.defaults[:controller] == controller && route.defaults[:action] == action.to_s
+        end
       end
 
       def becomes(record)
@@ -126,7 +155,15 @@ module Madmin
         model.respond_to? :friendly
       end
 
+      def readonly?
+        false
+      end
+
       def sortable_columns
+        model_column_names
+      end
+
+      def model_column_names
         model.column_names
       end
 
@@ -134,6 +171,10 @@ module Madmin
         attributes.values.select { |a| a.field.searchable? }
       end
 
+      def filterable_attributes
+        attributes.values.select { |a| a.field&.filter_type }
+      end
+
       def member_action(collection: false, &block)
         member_actions << MemberAction.new(collection: collection, &block)
       end
@@ -149,6 +190,7 @@ module Madmin
 
       def field_for_type(type)
         {
+          array: Fields::Array,
           binary: Fields::String,
           blob: Fields::Text,
           boolean: Fields::Boolean,
@@ -208,7 +250,8 @@ module Madmin
           has_many: Fields::HasMany,
           has_one: Fields::HasOne,
           rich_text: Fields::RichText,
-          nested_has_many: Fields::NestedHasMany
+          nested_has_many: Fields::NestedHasMany,
+          nested_has_one: Fields::NestedHasOne
         }[type]
       end
 
@@ -219,6 +262,8 @@ module Madmin
           column_type = model.attribute_types[name_string]
           if column_type.is_a? ::ActiveRecord::Enum::EnumType
             :enum
+          elsif model.columns_hash[name_string].try(:array?)
+            :array
           else
             column_type.type || :string
           end
@@ -257,7 +302,29 @@ module Madmin
         @url_helpers ||= Rails.application.routes.url_helpers
       end
 
+      # Raises MissingRoute with instructions instead of a NoMethodError for
+      # the undefined route helper when the resource's routes aren't drawn
+      def route_path(components, options = {})
+        url_helpers.polymorphic_path(components, options)
+      rescue NoMethodError => error
+        raise unless error.name.to_s.end_with?("_path")
+
+        *namespaces, resources = model.model_name.collection.split("/")
+        routes = namespaces.reverse.inject("resources :#{resources}") do |body, namespace|
+          "namespace :#{namespace} do\n#{body.indent(2)}\nend"
+        end
+
+        raise MissingRoute, [
+          "`#{error.name}` is not defined, so #{name} has no route for this page.",
+          "Add the route inside `namespace :madmin` in your routes:",
+          routes.indent(4),
+          "To hide the resource from the menu instead, add `menu false` to #{name}."
+        ].join("\n\n")
+      end
+
       def model_store_accessors
+        return [] unless model.respond_to?(:stored_attributes)
+
         store_accessors = model.stored_attributes.values
         store_accessors.flatten
       end
@@ -269,7 +336,28 @@ module Madmin
       def menu_options
         return false if @menu_options == false
         @menu_options ||= {}
-        @menu_options.with_defaults(label: friendly_name.pluralize, url: index_path)
+        # The default label follows the locale, so the menu tracks the item by resource instead
+        @menu_options.with_defaults(key: @menu_options[:label] || name, label: friendly_plural_name, url: index_path)
+      end
+
+      private
+
+      def translated_name(count: 1)
+        model.model_name.human(count: count, default: "").presence
+      end
+
+      # Whether the model's translation spells out its own `one` / `other` forms
+      def plural_translation?
+        model.lookup_ancestors.each do |klass|
+          translation = I18n.t(klass.model_name.i18n_key, scope: [klass.i18n_scope, :models], default: "")
+          return translation.is_a?(Hash) if translation.present?
+        end
+        false
+      end
+
+      # Locales without inflection rules of their own (most non-English ones) are left unpluralized
+      def locale_inflections?
+        ActiveSupport::Inflector::Inflections.instance(I18n.locale).plurals.any?
       end
     end
 

data/lib/madmin/resource_builder.rb

@@ -7,6 +7,8 @@ module Madmin
     end
 
     def associations
+      return [] unless model.respond_to?(:reflections)
+
       model.reflections.reject { |name, association|
         # Hide these special associations
         name.starts_with?("rich_text") ||
@@ -22,10 +24,14 @@ module Madmin
     end
 
     def store_accessors
+      return [] unless model.respond_to?(:stored_attributes)
+
       model.stored_attributes.values.flatten
     end
 
     def virtual_attributes
+      return [] unless model.respond_to?(:attribute_types)
+
       virtual = []
 
       # has_secure_password columns
@@ -50,6 +56,8 @@ module Madmin
     end
 
     def redundant_attributes
+      return [] unless model.respond_to?(:attribute_types)
+
       redundant = []
 
       # has_secure_password columns

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.5.1"
+  VERSION = "3.0.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"
@@ -78,18 +114,26 @@ module Madmin
     end
 
     def sti_resource_name_for(object)
+      return unless object.class.respond_to?(:inheritance_column) && object.class.respond_to?(:column_names)
+
       if (column = object.class.inheritance_column) && object.class.column_names.include?(column)
         "#{object.class.superclass.base_class.name}Resource"
       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
 
@@ -99,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.5.1
+  version: 3.0.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
@@ -198,8 +194,10 @@ files:
 - app/views/madmin/fields/time/_show.html.erb
 - app/views/madmin/shared/_label.html.erb
 - config/importmap.rb
+- config/locales/el.yml
 - config/locales/en.yml
 - config/locales/fr.yml
+- config/locales/ko.yml
 - lib/generators/madmin/field/field_generator.rb
 - lib/generators/madmin/field/templates/_form.html.erb
 - lib/generators/madmin/field/templates/_index.html.erb
@@ -223,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
@@ -239,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
@@ -246,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
@@ -274,7 +277,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.18
+rubygems_version: 4.0.20
 specification_version: 4
 summary: A modern admin for Ruby on Rails apps
 test_files: []