administrate 0.17.0 → 0.20.0

data/lib/administrate/order.rb

@@ -1,18 +1,19 @@
 module Administrate
   class Order
-    def initialize(attribute = nil, direction = nil)
+    def initialize(attribute = nil, direction = nil, association_attribute: nil)
       @attribute = attribute
       @direction = sanitize_direction(direction)
+      @association_attribute = association_attribute
     end
 
     def apply(relation)
       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
-        relation.columns_hash.keys.include?(attribute.to_s)
+      return relation.reorder(order) if
+        column_exist?(relation, attribute)
 
       relation
     end
@@ -32,7 +33,7 @@ module Administrate
 
     private
 
-    attr_reader :attribute
+    attr_reader :attribute, :association_attribute
 
     def sanitize_direction(direction)
       %w[asc desc].include?(direction.to_s) ? direction.to_sym : :asc
@@ -51,32 +52,83 @@ module Administrate
     end
 
     def order_by_association(relation)
-      return order_by_count(relation) if has_many_attribute?(relation)
-
-      return order_by_id(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_belongs_to(relation)
+      if ordering_by_association_column?(relation)
+        order_by_attribute(relation)
+      else
+        order_by_id(relation)
+      end
+    end
+
+    def order_by_has_one(relation)
+      if ordering_by_association_column?(relation)
+        order_by_attribute(relation)
+      else
+        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("#{foreign_key(relation)} #{direction}")
+      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?(
+          reflect_association(relation).klass, association_attribute.to_sym
+        )
+    end
+
+    def column_exist?(table, column_name)
+      table.columns_hash.key?(column_name.to_s)
     end
 
-    def has_many_attribute?(relation)
-      reflect_association(relation).macro == :has_many
+    def order_by_id_query(relation)
+      relation.arel_table[foreign_key(relation)].public_send(direction)
     end
 
-    def belongs_to_attribute?(relation)
-      reflect_association(relation).macro == :belongs_to
+    def order_by_association_id_query
+      Arel::Table.new(association_table_name)[:id].public_send(direction)
+    end
+
+    def order_by_attribute_query
+      table = Arel::Table.new(association_table_name)
+      table[association_attribute].public_send(direction)
+    end
+
+    def relation_type(relation)
+      reflect_association(relation).macro
     end
 
     def reflect_association(relation)
@@ -86,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/base.rb

@@ -23,6 +23,10 @@ module Administrate
         dashboard.try(:item_includes) || []
       end
 
+      def item_associations
+        dashboard.try(:item_associations) || []
+      end
+
       private
 
       def attribute_field(dashboard, resource, attribute_name, page)

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.17.0".freeze
+  VERSION = "0.20.0".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

@@ -2,7 +2,7 @@ require "administrate/engine"
 
 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 +12,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 " +
@@ -20,4 +20,26 @@ module Administrate
       "if you think otherwise.",
     )
   end
+
+  def self.warn_of_deprecated_method(klass, method)
+    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. " +
+      "Please make sure you update it to a version that " +
+      "does not use a deprecated API",
+    )
+  end
+
+  def self.warn_of_deprecated_authorization_method(method)
+    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__)
 
@@ -53,9 +58,22 @@ module Administrate
       end
 
       def attributes
-        klass.reflections.keys +
+        attrs = (
+          klass.reflections.keys +
           klass.columns.map(&:name) -
           redundant_attributes
+        )
+
+        primary_key = attrs.delete(klass.primary_key)
+        created_at = attrs.delete("created_at")
+        updated_at = attrs.delete("updated_at")
+
+        [
+          primary_key,
+          *attrs.sort,
+          created_at,
+          updated_at,
+        ].compact
       end
 
       def form_attributes

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: administrate
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.20.0
 platform: ruby
 authors:
 - Nick Charlton
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-02 00:00:00.000000000 Z
+date: 2024-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -17,98 +17,88 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: actionview
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: datetime_picker_rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.7
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+        version: '6.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.0.7
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: jquery-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 4.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 4.6.0
 - !ruby/object:Gem::Dependency
   name: kaminari
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: momentjs-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: 1.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: 1.2.2
 - !ruby/object:Gem::Dependency
   name: sassc-rails
   requirement: !ruby/object:Gem::Requirement
@@ -160,7 +150,7 @@ files:
 - Rakefile
 - app/assets/javascripts/administrate/application.js
 - app/assets/javascripts/administrate/components/associative.js
-- app/assets/javascripts/administrate/components/date_time_picker.js
+- app/assets/javascripts/administrate/components/select.js
 - app/assets/javascripts/administrate/components/table.js
 - app/assets/stylesheets/administrate/application.scss
 - app/assets/stylesheets/administrate/base/_forms.scss
@@ -197,6 +187,7 @@ files:
 - app/views/administrate/application/_index_header.html.erb
 - app/views/administrate/application/_javascript.html.erb
 - app/views/administrate/application/_navigation.html.erb
+- app/views/administrate/application/_pagination.html.erb
 - app/views/administrate/application/_search.html.erb
 - app/views/administrate/application/_stylesheet.html.erb
 - app/views/administrate/application/edit.html.erb
@@ -249,7 +240,6 @@ files:
 - app/views/fields/url/_index.html.erb
 - app/views/fields/url/_show.html.erb
 - app/views/layouts/administrate/application.html.erb
-- config/i18n-tasks.yml
 - config/locales/administrate.ar.yml
 - config/locales/administrate.bs.yml
 - config/locales/administrate.ca.yml
@@ -268,6 +258,7 @@ files:
 - config/locales/administrate.pt-BR.yml
 - config/locales/administrate.pt.yml
 - config/locales/administrate.ru.yml
+- config/locales/administrate.sl.yml
 - config/locales/administrate.sq.yml
 - config/locales/administrate.sv.yml
 - config/locales/administrate.tr.yml
@@ -275,8 +266,6 @@ files:
 - config/locales/administrate.vi.yml
 - config/locales/administrate.zh-CN.yml
 - config/locales/administrate.zh-TW.yml
-- config/routes.rb
-- config/unicorn.rb
 - docs/adding_controllers_without_related_model.md
 - docs/adding_custom_field_types.md
 - docs/authentication.md
@@ -288,7 +277,9 @@ files:
 - docs/extending_administrate.md
 - docs/getting_started.md
 - docs/guides.md
+- docs/guides/customising_search.md
 - docs/guides/hiding_dashboards_from_sidebar.md
+- docs/guides/scoping_has_many_relations.md
 - docs/rails_api.md
 - lib/administrate.rb
 - lib/administrate/base_dashboard.rb
@@ -315,6 +306,7 @@ files:
 - lib/administrate/generator_helpers.rb
 - lib/administrate/namespace.rb
 - lib/administrate/namespace/resource.rb
+- lib/administrate/not_authorized_error.rb
 - lib/administrate/order.rb
 - lib/administrate/page.rb
 - lib/administrate/page/base.rb
@@ -341,6 +333,7 @@ files:
 - lib/generators/administrate/install/templates/application_controller.rb.erb
 - lib/generators/administrate/routes/routes_generator.rb
 - lib/generators/administrate/routes/templates/routes.rb.erb
+- lib/generators/administrate/test_record.rb
 - lib/generators/administrate/views/edit_generator.rb
 - lib/generators/administrate/views/field_generator.rb
 - lib/generators/administrate/views/form_generator.rb
@@ -370,7 +363,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: A Rails engine for creating super-flexible admin dashboards

data/app/assets/javascripts/administrate/components/date_time_picker.js

@@ -1,14 +0,0 @@
-$(function () {
-  $('[data-type="time"]').datetimepicker({
-    debug: false,
-    format: 'HH:mm:ss',
-  });
-  $('[data-type="datetime"]').datetimepicker({
-    debug: false,
-    format: 'YYYY-MM-DD HH:mm:ss',
-  });
-  $('[data-type="date"]').datetimepicker({
-    debug: false,
-    format: 'YYYY-MM-DD',
-  });
-});

data/config/i18n-tasks.yml

@@ -1,18 +0,0 @@
-search:
-  paths:
-    - "app/controllers"
-    - "app/helpers"
-    - "app/pages"
-    - "app/views"
-
-data:
-  read:
-    - config/locales/administrate.%{locale}.yml
-
-ignore_unused:
-  - activerecord.*
-  - administrate.*
-  - date.*
-  - simple_form.*
-  - time.*
-  - titles.*

data/config/routes.rb

@@ -1,2 +0,0 @@
-Administrate::Engine.routes.draw do
-end