administrate 1.0.0.beta3 → 1.0.0

data/docs/customizing_dashboards.md

@@ -106,11 +106,14 @@ For example:
 with this, you will be able to search through the column `name` from the
 association `belongs_to :country`, from your model.
 
-`:class_name` - Specifies the name of the associated class.
+`:sortable` - Specifies if sorting should be enabled in the table views.  
+Default is `true`.  
 
-`:primary_key` (deprecated) - Specifies the association's primary_key.
+`:sorting_column` - Specifies the column of the associated model to be used for sorting in the table views and dropdown menu.  
+If `sorting_column` is omitted and `order` is specified, the value of `order` will be used.  
+If neither is specified, sorting will be done using the foreign key.  
 
-`:foreign_key` (deprecated) - Specifies the name of the foreign key directly.
+`:class_name` - Specifies the name of the associated class.
 
 **Field::HasMany**
 
@@ -124,11 +127,15 @@ set this to `0` or `false`. Default is `5`.
 
 `:direction` - What direction the sort should be in, `:asc` (default) or `:desc`.
 
-`:class_name` - Specifies the name of the associated class.
+`:sortable` - Specifies if sorting should be enabled in the table views.  
+Default is `true`.  
 
-`:primary_key` (deprecated) - Specifies object's primary_key.
+`:sorting_column` - Specifies the column of the associated model to be used for sorting in the dropdown menu.  
+If `sorting_column` is omitted and `sort_by` is specified, the value of `sort_by` will be used.  
+If neither is specified, sorting will be done using the foreign key.  
+For `HasMany` associations, sorting is based on the count, so this option is not referenced in the table views.  
 
-`:foreign_key` (deprecated) - Specifies the name of the foreign key directly.
+`:class_name` - Specifies the name of the associated class.
 
 **Field::HasOne**
 
@@ -154,6 +161,13 @@ For example:
 with this, you will be able to search through the column `name` from the
 association `has_one :city`, from your model.
 
+`:sortable` - Specifies if sorting should be enabled in the table views.  
+Default is `true`.  
+
+`:sorting_column` - Specifies the column of the associated model to be used for sorting in the table views and dropdown menu.  
+If `sorting_column` is omitted and `order` is specified, the value of `order` will be used.  
+If neither is specified, sorting will be done using the foreign key.  
+
 `:class_name` - Specifies the name of the associated class.
 
 **Field::Number**
@@ -162,6 +176,13 @@ association `has_one :city`, from your model.
 Note that currently number fields are searched like text, which may yield
 more results than expected. Default is `false`.
 
+`:sortable` - Specifies if sorting should be enabled in the table views.  
+Default is `true`.  
+
+`:sorting_column` - Specifies the column to be used for sorting in the table view.  
+By default, the column itself is used, but when used as a virtual column,  
+a custom sorting column can be specified.  
+
 `:decimals` - Set the number of decimals to display. Defaults to `0`.
 
 `:prefix` - Prefixes the number with a string. Defaults to `""`.
@@ -210,8 +231,18 @@ Default is `[]`.
 `:order` - What to sort the association by in the form select.
 Default is `nil`.
 
+`:sortable` - Specifies if sorting should be enabled in the table views.  
+Default is `true`.  
+
 **Field::DateTime**
 
+`:sortable` - Specifies if sorting should be enabled in the table views.  
+Default is `true`.  
+
+`:sorting_column` - Specifies the column to be used for sorting in the table view.  
+By default, the column itself is used, but when used as a virtual column,  
+a custom sorting column can be specified.  
+
 `:format` - Specify what format, using `strftime` you would like `DateTime`
 objects to display as.
 
@@ -220,6 +251,13 @@ in.
 
 **Field::Date**
 
+`:sortable` - Specifies if sorting should be enabled in the table views.  
+Default is `true`.  
+
+`:sorting_column` - Specifies the column to be used for sorting in the table view.  
+By default, the column itself is used, but when used as a virtual column,  
+a custom sorting column can be specified.  
+
 `:format` - Specify what format, using `strftime` you would like `Date`
 objects to display as.
 
@@ -249,6 +287,13 @@ If no collection is provided and no enum can be detected, the list of options wi
 `:searchable` - Specify if the attribute should be considered when searching.
 Default is `true`.
 
+`:sortable` - Specifies if sorting should be enabled in the table views.  
+Default is `true`.  
+
+`:sorting_column` - Specifies the column to be used for sorting in the table view.  
+By default, the column itself is used, but when used as a virtual column,  
+a custom sorting column can be specified.  
+
 `:include_blank` - Similar to [the option of the same name accepted by Rails helpers](https://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html). If provided, a "blank" option will be added first to the list of options, with the value of `include_blank` as label.
 
 **Field::String**
@@ -256,6 +301,13 @@ Default is `true`.
 `:searchable` - Specify if the attribute should be considered when searching.
 Default is `true`.
 
+`:sortable` - Specifies if sorting should be enabled in the table views.  
+Default is `true`.  
+
+`:sorting_column` - Specifies the column to be used for sorting in the table view.  
+By default, the column itself is used, but when used as a virtual column,  
+a custom sorting column can be specified.  
+
 `:truncate` - Set the number of characters to display in the index view.
 Defaults to `50`.
 
@@ -264,6 +316,13 @@ Defaults to `50`.
 `:searchable` - Specify if the attribute should be considered when searching.
 Default is `false`.
 
+`:sortable` - Specifies if sorting should be enabled in the table views.  
+Default is `true`.  
+
+`:sorting_column` - Specifies the column to be used for sorting in the table view.  
+By default, the column itself is used, but when used as a virtual column,  
+a custom sorting column can be specified.  
+
 `:truncate` - Set the number of characters to display in the index view.
 Defaults to `50`.
 
@@ -275,6 +334,13 @@ Example: `.with_options(input_options: { rows: 20 })`
 `:searchable` - Specify if the attribute should be considered when searching.
 Default is `true`.
 
+`:sortable` - Specifies if sorting should be enabled in the table views.  
+Default is `true`.  
+
+`:sorting_column` - Specifies the column to be used for sorting in the table view.  
+By default, the column itself is used, but when used as a virtual column,  
+a custom sorting column can be specified.  
+
 `:truncate` - Set the number of characters to display in the index view.
 Defaults to `50`.
 
@@ -286,6 +352,9 @@ Defaults is `{}`.
 `:searchable` - Specify if the attribute should be considered when searching.
 Default is `false`.
 
+`:sortable` - Specifies if sorting should be enabled in the table views.  
+Default is `false`.  
+
 `:truncate` - Set the number of characters to display in the views.
 Defaults to `50`.
 

data/docs/guides/switching_templates_with_view_variants.md

@@ -0,0 +1,45 @@
+---
+title: Switching templates with view variants
+---
+
+You can switch to different templates using Rails' support for [view
+variants][], which can be used to override the template used inside the
+controller.
+
+By setting the `request.variant` option to any value (in this case, `:admin`)
+at any point in any controller, you can add a new variant to Rails' template
+lookup tree (in this case, `.html+admin.erb`).
+
+For example, to add a button to become the admin to view certain functionality:
+
+```ruby
+class CustomersController < Admin::ApplicationController
+  before_action :with_variant, only: %i[index]
+
+  private
+
+  def with_variant
+    if @current_user.admin?
+      request.variant = :admin
+    end
+  end
+end
+```
+
+```erb
+<!-- app/views/admin/customers/_index_header.html.erb -->
+<p class="identity__banner">
+  You are logged in as <em><%= pundit_user.name %></em>.
+  <%= link_to("Become the Admin", become_admin_customer_path("admin"),
+        class: "identity__become-action")%>
+</p>
+```
+
+```erb
+<!-- app/views/admin/customers/_index_header.html+admin.erb -->
+<p class="identity__banner identity__banner--admin">
+  You are logged in as <em><%= pundit_user.name %></em>.
+</p>
+```
+
+[view variants]: https://guides.rubyonrails.org/layouts_and_rendering.html#the-variants-option

data/docs/guides.md

@@ -5,3 +5,4 @@ title: Guides
 - [Hiding Dashboards from the Sidebar](./guides/hiding_dashboards_from_sidebar)
 - [Customising the search](./guides/customising_search)
 - [Scoping HasMany Relations](./guides/scoping_has_many_relations.md)
+- [Switching templates with view variants](./guides/switching_templates_with_view_variants.md)

data/docs/migrating-to-v1.md

@@ -0,0 +1,34 @@
+---
+title: Migrating to v1
+---
+
+In the release of v1.0.0, we [began bundling assets in the gem itself][2397].
+In the future, this should mean that any changes made to assets (coming
+from you or from Administrate updates) should not have an effect on you.
+However, this is quite a big change and so you might find some problems.
+
+As with most upgrades, if you're upgrading between versions with changes to the
+templates, and if you've customised them, you may need to apply recent changes.
+You can see those which changed in the [CHANGELOG][].
+
+This applies to both modified files in `app/views/admin` and `app/views/fields`
+if you have your own Field classes defined. A good way is to use the same 
+command to generate the view as for the earlier version:
+`rails generate administrate:views:ACTION MyModel`
+noting the changes and re-applying the modifications
+
+[2397]: https://github.com/thoughtbot/administrate/pull/2397
+[CHANGELOG]: https://github.com/thoughtbot/administrate/blob/main/CHANGELOG.md
+
+## Reported issues
+
+### Removal of the `sprockets-rails` transitive dependency
+
+[Issue][2514]
+
+Previously, Administrate depended on [`sprockets-rails`][], if you have a
+dependency which requires this, you may now need to add a direct dependency on
+your application.
+
+[2514]: https://github.com/thoughtbot/administrate/issues/2514
+[`sprockets-rails`]: https://rubygems.org/gems/sprockets-rails

data/lib/administrate/base_dashboard.rb

@@ -111,12 +111,6 @@ module Administrate
       attribute_includes(collection_attributes)
     end
 
-    def item_includes
-      # Deprecated, internal usage has moved to #item_associations
-      Administrate.warn_of_deprecated_method(self.class, :item_includes)
-      attribute_includes(show_page_attributes)
-    end
-
     def item_associations
       attributes = if show_page_attributes.is_a?(Hash)
         show_page_attributes.values.flatten

data/lib/administrate/field/associative.rb

@@ -56,36 +56,17 @@ module Administrate
         "#{associated_class_name}Dashboard".constantize.new
       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
-          self.class.association_primary_key_for(resource.class, attribute)
-        end
+        self.class.association_primary_key_for(resource.class, attribute)
       end
 
       def foreign_key
-        if option_given?(:foreign_key)
-          deprecated_option(:foreign_key)
-        else
-          self.class.foreign_key_for(resource.class, attribute)
-        end
+        self.class.foreign_key_for(resource.class, attribute)
       end
 
       def option_given?(name)
         options.key?(name)
       end
-
-      def deprecated_option(name)
-        Administrate.warn_of_deprecated_option(name)
-        options.fetch(name)
-      end
     end
   end
 end

data/lib/administrate/field/base.rb

@@ -24,6 +24,10 @@ module Administrate
         false
       end
 
+      def self.sortable?
+        true
+      end
+
       def self.field_type
         to_s.split("::").last.underscore
       end
@@ -32,6 +36,19 @@ module Administrate
         attr
       end
 
+      def self.partial_prefixes
+        @partial_prefixes ||=
+          if superclass.respond_to?(:partial_prefixes)
+            local_partial_prefixes + superclass.partial_prefixes
+          else
+            local_partial_prefixes
+          end
+      end
+
+      def self.local_partial_prefixes
+        ["fields/#{field_type}"]
+      end
+
       def initialize(attribute, data, page, options = {})
         @attribute = attribute
         @page = page
@@ -66,8 +83,8 @@ module Administrate
         end
       end
 
-      def to_partial_path
-        "/fields/#{self.class.field_type}/#{page}"
+      def partial_prefixes
+        self.class.partial_prefixes
       end
 
       def required?

data/lib/administrate/field/belongs_to.rb

@@ -5,12 +5,7 @@ module Administrate
     class BelongsTo < Associative
       def self.permitted_attribute(attr, options = {})
         resource_class = options[:resource_class]
-        if resource_class
-          foreign_key_for(resource_class, attr)
-        else
-          Administrate.warn_of_missing_resource_class
-          :"#{attr}_id"
-        end
+        foreign_key_for(resource_class, attr)
       end
 
       def self.eager_load?

data/lib/administrate/field/date.rb

@@ -5,7 +5,7 @@ module Administrate
     class Date < Base
       def date
         I18n.localize(
-          data.to_date,
+          data.in_time_zone(timezone).to_date,
           format: format
         )
       end
@@ -15,6 +15,10 @@ module Administrate
       def format
         options.fetch(:format, :default)
       end
+
+      def timezone
+        options.fetch(:timezone, ::Time.zone)
+      end
     end
   end
 end

data/lib/administrate/field/date_time.rb

@@ -13,8 +13,7 @@ module Administrate
       def datetime
         I18n.localize(
           data.in_time_zone(timezone),
-          format: format,
-          default: data
+          format: format
         )
       end
 
@@ -25,7 +24,7 @@ module Administrate
       end
 
       def timezone
-        options.fetch(:timezone, ::Time.zone.name || "UTC")
+        options.fetch(:timezone, ::Time.zone)
       end
     end
   end

data/lib/administrate/field/deferred.rb

@@ -41,28 +41,16 @@ module Administrate
         end
       end
 
-      def searchable_field
-        Administrate.deprecator.warn(
-          "searchable_field is deprecated, use searchable_fields instead"
-        )
-        options.fetch(:searchable_field)
+      def searchable_fields
+        options.fetch(:searchable_fields)
       end
 
-      def searchable_fields
-        if options.key?(:searchable_field)
-          [searchable_field]
-        else
-          options.fetch(:searchable_fields)
-        end
+      def sortable?
+        options.fetch(:sortable, deferred_class.sortable?)
       end
 
       def permitted_attribute(attr, opts = {})
-        if options.key?(:foreign_key)
-          Administrate.warn_of_deprecated_option(:foreign_key)
-          options.fetch(:foreign_key)
-        else
-          deferred_class.permitted_attribute(attr, options.merge(opts))
-        end
+        deferred_class.permitted_attribute(attr, options.merge(opts))
       end
 
       delegate :html_class, to: :deferred_class

data/lib/administrate/field/has_many.rb

@@ -72,7 +72,7 @@ module Administrate
       end
 
       def more_than_limit?
-        paginate? && data.count(:all) > limit
+        paginate? && data.size > limit
       end
 
       def data
@@ -82,12 +82,21 @@ module Administrate
       def order_from_params(params)
         Administrate::Order.new(
           params.fetch(:order, sort_by),
-          params.fetch(:direction, direction)
+          params.fetch(:direction, direction),
+          sorting_column: sorting_column(
+            associated_dashboard_attribute(params.fetch(:order, sort_by))
+          )
         )
       end
 
       def order
-        @order ||= Administrate::Order.new(sort_by, direction)
+        @order ||= Administrate::Order.new(
+          sort_by,
+          direction,
+          sorting_column: sorting_column(
+            associated_dashboard_attribute(sort_by)
+          )
+        )
       end
 
       private
@@ -109,6 +118,16 @@ module Administrate
         associated_dashboard.display_resource(resource)
       end
 
+      def sorting_column(dashboard_attribute)
+        return unless dashboard_attribute.try(:options)
+
+        dashboard_attribute.options.fetch(:sorting_column, nil)
+      end
+
+      def associated_dashboard_attribute(attribute)
+        associated_dashboard.attribute_types[attribute.to_sym] if attribute
+      end
+
       def sort_by
         options[:sort_by]
       end

data/lib/administrate/field/has_one.rb

@@ -7,17 +7,9 @@ module Administrate
         resource_class = options[:resource_class]
         final_associated_class_name =
           if options.key?(:class_name)
-            Administrate.warn_of_deprecated_option(:class_name)
             options.fetch(:class_name)
-          elsif resource_class
-            associated_class_name(resource_class, attr)
           else
-            Administrate.warn_of_missing_resource_class
-            if options
-              attr.to_s.singularize.camelcase
-            else
-              attr
-            end
+            associated_class_name(resource_class, attr)
           end
         related_dashboard_attributes =
           Administrate::ResourceResolver

data/lib/administrate/field/password.rb

@@ -7,6 +7,10 @@ module Administrate
         false
       end
 
+      def self.sortable?
+        false
+      end
+
       def truncate
         data.to_s.gsub(/./, character)[0...truncation_length]
       end

data/lib/administrate/field/polymorphic.rb

@@ -9,7 +9,7 @@ module Administrate
 
       def associated_resource_grouped_options
         classes.map do |klass|
-          [klass.to_s, candidate_resources_for(klass).map do |resource|
+          [klass.model_name.human, candidate_resources_for(klass).map do |resource|
             [display_candidate_resource(resource), resource.to_global_id]
           end]
         end

data/lib/administrate/field/time.rb

@@ -4,15 +4,16 @@ module Administrate
   module Field
     class Time < Base
       def time
-        return I18n.localize(data, format: format) if options[:format]
-
-        data.strftime("%I:%M%p")
+        I18n.localize(
+          data,
+          format: format
+        )
       end
 
       private
 
       def format
-        options[:format]
+        options.fetch(:format, "%I:%M%p")
       end
     end
   end

data/lib/administrate/namespace.rb

@@ -11,10 +11,16 @@ module Administrate
     end
 
     def routes
-      @routes ||= all_routes.select do |controller, _action|
-        controller.starts_with?("#{namespace}/")
-      end.map do |controller, action|
-        [controller.gsub(/^#{namespace}\//, ""), action]
+      @routes ||= begin
+        prefix = "#{namespace}/".freeze
+        Rails.application.routes.routes.filter_map do |route|
+          next unless route.defaults[:controller]&.start_with?(prefix)
+
+          [
+            route.defaults[:controller].delete_prefix(prefix),
+            route.defaults[:action]
+          ]
+        end
       end
     end
 
@@ -25,11 +31,5 @@ module Administrate
     private
 
     attr_reader :namespace
-
-    def all_routes
-      Rails.application.routes.routes.map do |route|
-        route.defaults.values_at(:controller, :action).map(&:to_s)
-      end
-    end
   end
 end

data/lib/administrate/order.rb

@@ -1,19 +1,19 @@
 module Administrate
   class Order
-    def initialize(attribute = nil, direction = nil, association_attribute: nil)
+    def initialize(attribute = nil, direction = nil, sorting_column: nil)
       @attribute = attribute
       @direction = sanitize_direction(direction)
-      @association_attribute = association_attribute
+      @sorting_column = sorting_column || attribute
     end
 
     def apply(relation)
       return order_by_association(relation) unless
         reflect_association(relation).nil?
 
-      order = relation.arel_table[attribute].public_send(direction)
+      order = relation.arel_table[sorting_column].public_send(direction)
 
       return relation.reorder(order) if
-        column_exist?(relation, attribute)
+        column_exist?(relation, sorting_column)
 
       relation
     end
@@ -33,7 +33,7 @@ module Administrate
 
     private
 
-    attr_reader :attribute, :association_attribute
+    attr_reader :attribute, :sorting_column
 
     def sanitize_direction(direction)
       %w[asc desc].include?(direction.to_s) ? direction.to_sym : :asc
@@ -94,9 +94,9 @@ module Administrate
     end
 
     def ordering_by_association_column?(relation)
-      association_attribute &&
+      (attribute != sorting_column) &&
         column_exist?(
-          reflect_association(relation).klass, association_attribute.to_sym
+          reflect_association(relation).klass, sorting_column.to_sym
         )
     end
 
@@ -113,7 +113,7 @@ module Administrate
     end
 
     def order_by_association_attribute(relation)
-      order_by_association_column(relation, association_attribute)
+      order_by_association_column(relation, sorting_column)
     end
 
     def order_by_association_column(relation, column_name)

data/lib/administrate/search.rb

@@ -63,6 +63,14 @@ module Administrate
       end
     end
 
+    def valid_filters
+      if @dashboard.class.const_defined?(:COLLECTION_FILTERS)
+        @dashboard.class.const_get(:COLLECTION_FILTERS).stringify_keys
+      else
+        {}
+      end
+    end
+
     private
 
     def apply_filter(filter, filter_param, resources)
@@ -116,14 +124,6 @@ module Administrate
         .where(query_template, *query_values)
     end
 
-    def valid_filters
-      if @dashboard.class.const_defined?(:COLLECTION_FILTERS)
-        @dashboard.class.const_get(:COLLECTION_FILTERS).stringify_keys
-      else
-        {}
-      end
-    end
-
     def attribute_types
       @dashboard.class.const_get(:ATTRIBUTE_TYPES)
     end
@@ -133,7 +133,6 @@ module Administrate
         provided_class_name = attribute_types[attr].options[:class_name]
         unquoted_table_name =
           if provided_class_name
-            Administrate.warn_of_deprecated_option(:class_name)
             provided_class_name.constantize.table_name
           else
             @scoped_resource.reflect_on_association(attr).klass.table_name

data/lib/administrate/version.rb

@@ -1,3 +1,3 @@
 module Administrate
-  VERSION = "1.0.0.beta3".freeze
+  VERSION = "1.0.0".freeze
 end