administrate 0.18.0 → 0.20.1

data/docs/getting_started.md

@@ -3,7 +3,7 @@ title: Getting Started
 ---
 
 Administrate is released as a Ruby gem, and can be installed on Rails
-applications version 5.0 or greater. We support Ruby 2.7 and up.
+applications version 6.0 or greater. We support Ruby 3.0 and up.
 
 First, add the following to your Gemfile:
 

data/docs/guides/customising_search.md

@@ -135,7 +135,7 @@ records.
 
 ## A working example
 
-The [Administrate demo app](/admin)
+The [Administrate demo app](https://administrate-demo.herokuapp.com/admin)
 includes an example of custom search in the "Log Entries" dashboard.
 In this app, each `LogEntry` instance has a polymorphic `belongs_to`
 association to a `:logeable`. Logeables are other models for which logs can be

data/lib/administrate/base_dashboard.rb

@@ -51,6 +51,12 @@ module Administrate
     end
 
     def form_attributes(action = nil)
+      action =
+        case action
+        when "update" then "edit"
+        when "create" then "new"
+        else action
+        end
       specific_form_attributes_for(action) || self.class::FORM_ATTRIBUTES
     end
 
@@ -62,11 +68,18 @@ module Administrate
       self.class.const_get(cname) if self.class.const_defined?(cname)
     end
 
-    def permitted_attributes
-      form_attributes.map do |attr|
+    def permitted_attributes(action = nil)
+      attributes = form_attributes action
+
+      if attributes.is_a? Hash
+        attributes = attributes.values.flatten
+      end
+
+      attributes.map do |attr|
         attribute_types[attr].permitted_attribute(
           attr,
           resource_class: self.class.model,
+          action: action,
         )
       end.uniq
     end
@@ -76,7 +89,11 @@ module Administrate
     end
 
     def collection_attributes
-      self.class::COLLECTION_ATTRIBUTES
+      if self.class::COLLECTION_ATTRIBUTES.is_a?(Hash)
+        self.class::COLLECTION_ATTRIBUTES.values.flatten
+      else
+        self.class::COLLECTION_ATTRIBUTES
+      end
     end
 
     def search_attributes
@@ -100,7 +117,12 @@ module Administrate
     end
 
     def item_associations
-      attribute_associated(show_page_attributes)
+      attributes = if show_page_attributes.is_a?(Hash)
+                     show_page_attributes.values.flatten
+                   else
+                     show_page_attributes
+                   end
+      attribute_associated attributes
     end
 
     private

data/lib/administrate/field/associative.rb

@@ -7,6 +7,10 @@ module Administrate
         reflection(resource_class, attr).foreign_key
       end
 
+      def self.association_primary_key_for(resource_class, attr)
+        reflection(resource_class, attr).association_primary_key
+      end
+
       def self.associated_class(resource_class, attr)
         reflection(resource_class, attr).klass
       end
@@ -49,10 +53,16 @@ module Administrate
       end
 
       def primary_key
+        # Deprecated, renamed `association_primary_key`
+        Administrate.warn_of_deprecated_method(self.class, :primary_key)
+        association_primary_key
+      end
+
+      def association_primary_key
         if option_given?(:primary_key)
           deprecated_option(:primary_key)
         else
-          :id
+          self.class.association_primary_key_for(resource.class, attribute)
         end
       end
 

data/lib/administrate/field/belongs_to.rb

@@ -23,12 +23,15 @@ module Administrate
 
       def associated_resource_options
         candidate_resources.map do |resource|
-          [display_candidate_resource(resource), resource.send(primary_key)]
+          [
+            display_candidate_resource(resource),
+            resource.send(association_primary_key),
+          ]
         end
       end
 
       def selected_option
-        data && data.send(primary_key)
+        data&.send(association_primary_key)
       end
 
       def include_blank_option

data/lib/administrate/field/deferred.rb

@@ -34,7 +34,7 @@ module Administrate
       end
 
       def searchable_field
-        ActiveSupport::Deprecation.warn(
+        Administrate.deprecator.warn(
           "searchable_field is deprecated, use searchable_fields instead",
         )
         options.fetch(:searchable_field)

data/lib/administrate/field/has_many.rb

@@ -22,7 +22,11 @@ module Administrate
       end
 
       def associated_collection(order = self.order)
-        Administrate::Page::Collection.new(associated_dashboard, order: order)
+        Administrate::Page::Collection.new(
+          associated_dashboard,
+          order: order,
+          collection_attributes: options[:collection_attributes],
+        )
       end
 
       def attribute_key
@@ -30,21 +34,28 @@ module Administrate
       end
 
       def associated_resource_options
-        candidate_resources.map do |resource|
-          [display_candidate_resource(resource), resource.send(primary_key)]
+        candidate_resources.map do |associated_resource|
+          [
+            display_candidate_resource(associated_resource),
+            associated_resource.send(association_primary_key),
+          ]
         end
       end
 
       def selected_options
         return if data.empty?
 
-        data.map { |object| object.send(primary_key) }
+        data.map { |object| object.send(association_primary_key) }
       end
 
       def limit
         options.fetch(:limit, DEFAULT_LIMIT)
       end
 
+      def paginate?
+        limit.respond_to?(:positive?) ? limit.positive? : limit.present?
+      end
+
       def permitted_attribute
         self.class.permitted_attribute(
           attribute,
@@ -53,12 +64,15 @@ module Administrate
       end
 
       def resources(page = 1, order = self.order)
-        resources = order.apply(data).page(page).per(limit)
+        resources = order.apply(data)
+        if paginate?
+          resources = resources.page(page).per(limit)
+        end
         includes.any? ? resources.includes(*includes) : resources
       end
 
       def more_than_limit?
-        data.count(:all) > limit
+        paginate? && data.count(:all) > limit
       end
 
       def data

data/lib/administrate/field/number.rb

@@ -38,14 +38,8 @@ module Administrate
         formatter = options[:format][:formatter]
         formatter_options = options[:format][:formatter_options].to_h
 
-        case formatter
-        when :number_to_delimited
-          ActiveSupport::NumberHelper.number_to_delimited(
-            result, **formatter_options
-          )
-        else
-          result
-        end
+        ActiveSupport::NumberHelper.
+          try(formatter, result, **formatter_options) || result
       end
     end
   end

data/lib/administrate/field/polymorphic.rb

@@ -30,7 +30,8 @@ module Administrate
       end
 
       def classes
-        options.fetch(:classes, [])
+        klasses = options.fetch(:classes, [])
+        klasses.respond_to?(:call) ? klasses.call : klasses
       end
 
       private

data/lib/administrate/field/select.rb

@@ -8,22 +8,32 @@ module Administrate
       end
 
       def selectable_options
-        collection
+        values =
+          if options.key?(:collection)
+            options.fetch(:collection)
+          elsif active_record_enum?
+            active_record_enum_values
+          else
+            []
+          end
+
+        if values.respond_to? :call
+          values = values.arity.positive? ? values.call(self) : values.call
+        end
+
+        values
       end
 
       def include_blank_option
         options.fetch(:include_blank, false)
       end
 
-      private
-
-      def collection
-        values = options.fetch(:collection, [])
-        if values.respond_to? :call
-          return values.arity.positive? ? values.call(self) : values.call
-        end
+      def active_record_enum?
+        resource.class.defined_enums.key?(attribute.to_s)
+      end
 
-        @collection ||= values
+      def active_record_enum_values
+        resource.class.defined_enums[attribute.to_s].map(&:first)
       end
     end
   end

data/lib/administrate/not_authorized_error.rb

@@ -5,8 +5,10 @@ module Administrate
       @resource = resource
 
       case resource
-      when Module, String, Symbol
+      when String, Symbol
         super("Not allowed to perform #{action.inspect} on #{resource.inspect}")
+      when Module
+        super("Not allowed to perform #{action.inspect} on #{resource.name}")
       else
         super(
           "Not allowed to perform #{action.inspect} on the given " +

data/lib/administrate/order.rb

@@ -10,9 +10,9 @@ module Administrate
       return order_by_association(relation) unless
         reflect_association(relation).nil?
 
-      order = "#{relation.table_name}.#{attribute} #{direction}"
+      order = relation.arel_table[attribute].public_send(direction)
 
-      return relation.reorder(Arel.sql(order)) if
+      return relation.reorder(order) if
         column_exist?(relation, attribute)
 
       relation
@@ -52,36 +52,57 @@ module Administrate
     end
 
     def order_by_association(relation)
-      return order_by_count(relation) if has_many_attribute?(relation)
-
-      return order_by_attribute(relation) if belongs_to_attribute?(relation)
-
-      relation
+      case relation_type(relation)
+      when :has_many
+        order_by_count(relation)
+      when :belongs_to
+        order_by_belongs_to(relation)
+      when :has_one
+        order_by_has_one(relation)
+      else
+        relation
+      end
     end
 
     def order_by_count(relation)
       klass = reflect_association(relation).klass
-      query = "COUNT(#{klass.table_name}.#{klass.primary_key}) #{direction}"
+      query = klass.arel_table[klass.primary_key].count.public_send(direction)
       relation.
         left_joins(attribute.to_sym).
         group(:id).
-        reorder(Arel.sql(query))
+        reorder(query)
     end
 
-    def order_by_id(relation)
-      relation.reorder(Arel.sql(order_by_id_query(relation)))
+    def order_by_belongs_to(relation)
+      if ordering_by_association_column?(relation)
+        order_by_attribute(relation)
+      else
+        order_by_id(relation)
+      end
     end
 
-    def order_by_attribute(relation)
+    def order_by_has_one(relation)
       if ordering_by_association_column?(relation)
-        relation.joins(
-          attribute.to_sym,
-        ).reorder(Arel.sql(order_by_attribute_query))
+        order_by_attribute(relation)
       else
-        order_by_id(relation)
+        order_by_association_id(relation)
       end
     end
 
+    def order_by_attribute(relation)
+      relation.joins(
+        attribute.to_sym,
+      ).reorder(order_by_attribute_query)
+    end
+
+    def order_by_id(relation)
+      relation.reorder(order_by_id_query(relation))
+    end
+
+    def order_by_association_id(relation)
+      relation.reorder(order_by_association_id_query)
+    end
+
     def ordering_by_association_column?(relation)
       association_attribute &&
         column_exist?(
@@ -94,19 +115,20 @@ module Administrate
     end
 
     def order_by_id_query(relation)
-      "#{relation.table_name}.#{foreign_key(relation)} #{direction}"
+      relation.arel_table[foreign_key(relation)].public_send(direction)
     end
 
-    def order_by_attribute_query
-      "#{attribute.tableize}.#{association_attribute} #{direction}"
+    def order_by_association_id_query
+      Arel::Table.new(association_table_name)[:id].public_send(direction)
     end
 
-    def has_many_attribute?(relation)
-      reflect_association(relation).macro == :has_many
+    def order_by_attribute_query
+      table = Arel::Table.new(association_table_name)
+      table[association_attribute].public_send(direction)
     end
 
-    def belongs_to_attribute?(relation)
-      reflect_association(relation).macro == :belongs_to
+    def relation_type(relation)
+      reflect_association(relation).macro
     end
 
     def reflect_association(relation)
@@ -116,5 +138,9 @@ module Administrate
     def foreign_key(relation)
       reflect_association(relation).foreign_key
     end
+
+    def association_table_name
+      attribute.tableize
+    end
   end
 end

data/lib/administrate/page/collection.rb

@@ -4,6 +4,7 @@ module Administrate
   module Page
     class Collection < Page::Base
       def attribute_names
+        options.fetch(:collection_attributes, nil) ||
         dashboard.collection_attributes
       end
 

data/lib/administrate/page/form.rb

@@ -11,15 +11,16 @@ module Administrate
       attr_reader :resource
 
       def attributes(action = nil)
-        action =
-          case action
-          when "update" then "edit"
-          when "create" then "new"
-          else action
-          end
+        attributes = dashboard.form_attributes(action)
+
+        if attributes.is_a? Array
+          attributes = { "" => attributes }
+        end
 
-        dashboard.form_attributes(action).map do |attribute|
-          attribute_field(dashboard, resource, attribute, :form)
+        attributes.transform_values do |attrs|
+          attrs.map do |attribute|
+            attribute_field(dashboard, resource, attribute, :form)
+          end
         end
       end
 

data/lib/administrate/page/show.rb

@@ -15,8 +15,16 @@ module Administrate
       end
 
       def attributes
-        dashboard.show_page_attributes.map do |attr_name|
-          attribute_field(dashboard, resource, attr_name, :show)
+        attributes = dashboard.show_page_attributes
+
+        if attributes.is_a? Array
+          attributes = { "" => attributes }
+        end
+
+        attributes.transform_values do |attrs|
+          attrs.map do |attr_name|
+            attribute_field(dashboard, resource, attr_name, :show)
+          end
         end
       end
     end

data/lib/administrate/resource_resolver.rb

@@ -35,7 +35,8 @@ module Administrate
     end
 
     def controller_path_parts
-      controller_path.split("/")[1..-1].map(&:singularize)
+      path_parts = controller_path.split("/")[1..-1]
+      path_parts << path_parts.pop.singularize
     end
 
     attr_reader :controller_path

data/lib/administrate/search.rb

@@ -31,7 +31,7 @@ module Administrate
       private
 
       def filter?(word)
-        valid_filters&.any? { |filter| word.match?(/^#{filter}:\w*$/) }
+        valid_filters&.any? { |filter| word.match?(/^#{filter}:/) }
       end
 
       def parse_query(query)

data/lib/administrate/version.rb

@@ -1,3 +1,3 @@
 module Administrate
-  VERSION = "0.18.0".freeze
+  VERSION = "0.20.1".freeze
 end

data/lib/administrate/view_generator.rb

@@ -5,7 +5,12 @@ require "administrate/namespace"
 module Administrate
   class ViewGenerator < Rails::Generators::Base
     include Administrate::GeneratorHelpers
-    class_option :namespace, type: :string, default: :admin
+    class_option(
+      :namespace,
+      type: :string,
+      desc: "Namespace where the admin dashboards live",
+      default: "admin",
+    )
 
     def self.template_source_path
       File.expand_path(

data/lib/administrate.rb

@@ -1,8 +1,9 @@
 require "administrate/engine"
+require "administrate/version"
 
 module Administrate
   def self.warn_of_missing_resource_class
-    ActiveSupport::Deprecation.warn(
+    deprecator.warn(
       "Calling Field::Base.permitted_attribute without the option " +
       ":resource_class is deprecated. If you are seeing this " +
       "message, you are probably using a custom field type that" +
@@ -12,7 +13,7 @@ module Administrate
   end
 
   def self.warn_of_deprecated_option(name)
-    ActiveSupport::Deprecation.warn(
+    deprecator.warn(
       "The option :#{name} is deprecated. " +
       "Administrate should detect it automatically. " +
       "Please file an issue at " +
@@ -22,7 +23,7 @@ module Administrate
   end
 
   def self.warn_of_deprecated_method(klass, method)
-    ActiveSupport::Deprecation.warn(
+    deprecator.warn(
       "The method #{klass}##{method} is deprecated. " +
       "If you are seeing this message you are probably " +
       "using a dashboard that depends explicitly on it. " +
@@ -32,10 +33,14 @@ module Administrate
   end
 
   def self.warn_of_deprecated_authorization_method(method)
-    ActiveSupport::Deprecation.warn(
+    deprecator.warn(
       "The method `#{method}` is deprecated. " +
       "Please use `accessible_action?` instead, " +
       "or see the documentation for other options.",
     )
   end
+
+  def self.deprecator
+    @deprecator ||= ActiveSupport::Deprecation.new(VERSION, "Administrate")
+  end
 end

data/lib/generators/administrate/dashboard/dashboard_generator.rb

@@ -27,7 +27,12 @@ module Administrate
       COLLECTION_ATTRIBUTE_LIMIT = 4
       READ_ONLY_ATTRIBUTES = %w[id created_at updated_at]
 
-      class_option :namespace, type: :string, default: :admin
+      class_option(
+        :namespace,
+        type: :string,
+        desc: "Namespace where the admin dashboards live",
+        default: "admin",
+      )
 
       source_root File.expand_path("../templates", __FILE__)
 

data/lib/generators/administrate/dashboard/templates/controller.rb.erb

@@ -36,11 +36,11 @@ module <%= namespace.to_s.camelize %>
     #
     # def resource_params
     #   params.require(resource_class.model_name.param_key).
-    #     permit(dashboard.permitted_attributes).
+    #     permit(dashboard.permitted_attributes(action_name)).
     #     transform_values { |value| value == "" ? nil : value }
     # end
 
-    # See https://administrate-prototype.herokuapp.com/customizing_controller_actions
+    # See https://administrate-demo.herokuapp.com/customizing_controller_actions
     # for more information
   end
 end

data/lib/generators/administrate/install/install_generator.rb

@@ -14,7 +14,12 @@ module Administrate
       include Administrate::GeneratorHelpers
       source_root File.expand_path("../templates", __FILE__)
 
-      class_option :namespace, type: :string, default: "admin"
+      class_option(
+        :namespace,
+        type: :string,
+        desc: "Namespace where the admin dashboards will live",
+        default: "admin",
+      )
 
       def run_routes_generator
         if dashboard_resources.none?

data/lib/generators/administrate/routes/routes_generator.rb

@@ -7,13 +7,19 @@ end
 require "rails/generators/base"
 require "administrate/generator_helpers"
 require "administrate/namespace"
+require "generators/administrate/test_record"
 
 module Administrate
   module Generators
     class RoutesGenerator < Rails::Generators::Base
       include Administrate::GeneratorHelpers
       source_root File.expand_path("../templates", __FILE__)
-      class_option :namespace, type: :string, default: "admin"
+      class_option(
+        :namespace,
+        type: :string,
+        desc: "Namespace where the admin dashboards live",
+        default: "admin",
+      )
 
       def insert_dashboard_routes
         if valid_dashboard_models.any?
@@ -55,7 +61,10 @@ module Administrate
       end
 
       def database_models
-        ActiveRecord::Base.descendants.reject(&:abstract_class?)
+        ActiveRecord::Base.descendants.
+          reject(&:abstract_class?).
+          reject { |k| k < Administrate::Generators::TestRecord }.
+          sort_by(&:to_s)
       end
 
       def invalid_dashboard_models

data/lib/generators/administrate/test_record.rb

@@ -0,0 +1,21 @@
+module Administrate
+  module Generators
+    # This class serves only to work around a strange behaviour in Rails 7
+    # with Ruby 3.
+    #
+    # After running the spec for DashboardGenerator, the fake models that
+    # it generates (eg: Foo, Shipment) linger around despite being removed
+    # explicitly. This causes RouteGenerator to take them into
+    # account and generate routes for them, which its spec doesn't expect,
+    # causing a spec failure.
+    #
+    # To avoid this, the spec for DashboardGenerator defines its fake models
+    # as children of TestRecord. Then RoutesGenerator explicitly filters
+    # child classes of TestRecord when figuring out what models exist.
+    #
+    # Discussion at https://github.com/thoughtbot/administrate/pull/2324
+    class TestRecord < ApplicationRecord
+      self.abstract_class = true
+    end
+  end
+end