administrate 0.15.0 → 0.18.0

data/docs/guides/scoping_has_many_relations.md

@@ -0,0 +1,27 @@
+---
+title: Scoping HasMany Relations
+---
+
+To show a subset of a has_many relationship, create a new [has_many](https://apidock.com/rails/ActiveRecord/Associations/ClassMethods/has_many) relationship in your model (using the `scope` argument) and add it to the model's dashboard.
+
+## Creating a scoped has_many relationship
+
+Models can define subsets of a `has_many` relationship by passing a callable (i.e. proc or lambda) as its second argument.
+
+```ruby
+class Customer < ApplicationRecord
+   has_many :orders
+   has_many :processed_orders, ->{ where(processed: true) }, class_name: "Order"
+```
+
+Since ActiveRecord infers the class name from the first argument, the new `has_many` relation needs to specify the model using the `class_name` option.
+
+## Add new relationship to dashboard
+
+Your new scoped relation can be used in the dashboard just like the original `HasMany`. Notice the new field needs to specifiy the class name as an option like you did in the model.
+
+```ruby
+ATTRIBUTE_TYPES = {
+  orders: Field::HasMany,
+  processed_orders: Field::HasMany.with_options(class_name: 'Order')
+```

data/docs/guides.md

@@ -2,4 +2,6 @@
 title: Guides
 ---
 
-* [Hiding Dashboards from the Sidebar](./guides/hiding_dashboards_from_sidebar)
+- [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)

data/lib/administrate/base_dashboard.rb

@@ -50,8 +50,16 @@ module Administrate
       attribute_types.keys
     end
 
-    def form_attributes
-      self.class::FORM_ATTRIBUTES
+    def form_attributes(action = nil)
+      specific_form_attributes_for(action) || self.class::FORM_ATTRIBUTES
+    end
+
+    def specific_form_attributes_for(action)
+      return unless action
+
+      cname = "FORM_ATTRIBUTES_#{action.upcase}"
+
+      self.class.const_get(cname) if self.class.const_defined?(cname)
     end
 
     def permitted_attributes
@@ -71,6 +79,12 @@ module Administrate
       self.class::COLLECTION_ATTRIBUTES
     end
 
+    def search_attributes
+      attribute_types.keys.select do |attribute|
+        attribute_types[attribute].searchable?
+      end
+    end
+
     def display_resource(resource)
       "#{resource.class} ##{resource.id}"
     end
@@ -80,9 +94,15 @@ module Administrate
     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
+      attribute_associated(show_page_attributes)
+    end
+
     private
 
     def attribute_not_found_message(attr)
@@ -90,6 +110,14 @@ module Administrate
     end
 
     def attribute_includes(attributes)
+      attributes.map do |key|
+        field = attribute_type_for(key)
+
+        key if field.eager_load?
+      end.compact
+    end
+
+    def attribute_associated(attributes)
       attributes.map do |key|
         field = attribute_type_for(key)
 

data/lib/administrate/engine.rb

@@ -1,11 +1,11 @@
-require "datetime_picker_rails"
 require "jquery-rails"
 require "kaminari"
-require "momentjs-rails"
 require "sassc-rails"
 require "selectize-rails"
 require "sprockets/railtie"
 
+require "administrate/namespace/resource"
+require "administrate/not_authorized_error"
 require "administrate/page/form"
 require "administrate/page/show"
 require "administrate/page/collection"

data/lib/administrate/field/associative.rb

@@ -12,7 +12,7 @@ module Administrate
       end
 
       def self.associated_class_name(resource_class, attr)
-        reflection(resource_class, attr).class_name
+        associated_class(resource_class, attr).name
       end
 
       def self.reflection(resource_class, attr)
@@ -31,12 +31,6 @@ module Administrate
         end
       end
 
-      private
-
-      def associated_dashboard
-        "#{associated_class_name}Dashboard".constantize.new
-      end
-
       def associated_class_name
         if option_given?(:class_name)
           deprecated_option(:class_name)
@@ -48,6 +42,12 @@ module Administrate
         end
       end
 
+      private
+
+      def associated_dashboard
+        "#{associated_class_name}Dashboard".constantize.new
+      end
+
       def primary_key
         if option_given?(:primary_key)
           deprecated_option(:primary_key)

data/lib/administrate/field/base.rb

@@ -16,6 +16,10 @@ module Administrate
         self < Associative
       end
 
+      def self.eager_load?
+        false
+      end
+
       def self.searchable?
         false
       end

data/lib/administrate/field/belongs_to.rb

@@ -13,6 +13,10 @@ module Administrate
         end
       end
 
+      def self.eager_load?
+        true
+      end
+
       def permitted_attribute
         foreign_key
       end

data/lib/administrate/field/deferred.rb

@@ -25,6 +25,10 @@ module Administrate
         deferred_class.associative?
       end
 
+      def eager_load?
+        deferred_class.eager_load?
+      end
+
       def searchable?
         options.fetch(:searchable, deferred_class.searchable?)
       end

data/lib/administrate/field/has_one.rb

@@ -26,6 +26,10 @@ module Administrate
         { "#{attr}_attributes": related_dashboard_attributes }
       end
 
+      def self.eager_load?
+        true
+      end
+
       def nested_form
         @nested_form ||= Administrate::Page::Form.new(
           resolver.dashboard_class.new,

data/lib/administrate/field/select.rb

@@ -11,6 +11,10 @@ module Administrate
         collection
       end
 
+      def include_blank_option
+        options.fetch(:include_blank, false)
+      end
+
       private
 
       def collection

data/lib/administrate/field/time.rb

@@ -3,6 +3,17 @@ require_relative "base"
 module Administrate
   module Field
     class Time < Base
+      def time
+        return I18n.localize(data, format: format) if options[:format]
+
+        data.strftime("%I:%M%p")
+      end
+
+      private
+
+      def format
+        options[:format]
+      end
     end
   end
 end

data/lib/administrate/field/url.rb

@@ -11,6 +11,10 @@ module Administrate
         data.to_s[0...truncation_length]
       end
 
+      def html_options
+        @options[:html_options] || {}
+      end
+
       private
 
       def truncation_length

data/lib/administrate/namespace.rb

@@ -1,7 +1,7 @@
 module Administrate
   class Namespace
     def initialize(namespace)
-      @namespace = namespace
+      @namespace = namespace.to_sym
     end
 
     def resources

data/lib/administrate/not_authorized_error.rb

@@ -0,0 +1,18 @@
+module Administrate
+  class NotAuthorizedError < StandardError
+    def initialize(action:, resource:)
+      @action = action
+      @resource = resource
+
+      case resource
+      when Module, String, Symbol
+        super("Not allowed to perform #{action.inspect} on #{resource.inspect}")
+      else
+        super(
+          "Not allowed to perform #{action.inspect} on the given " +
+            resource.class.name
+        )
+      end
+    end
+  end
+end

data/lib/administrate/order.rb

@@ -1,8 +1,9 @@
 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)
@@ -12,7 +13,7 @@ module Administrate
       order = "#{relation.table_name}.#{attribute} #{direction}"
 
       return relation.reorder(Arel.sql(order)) if
-        relation.columns_hash.keys.include?(attribute.to_s)
+        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
@@ -53,7 +54,7 @@ module Administrate
     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)
+      return order_by_attribute(relation) if belongs_to_attribute?(relation)
 
       relation
     end
@@ -68,7 +69,36 @@ module Administrate
     end
 
     def order_by_id(relation)
-      relation.reorder("#{foreign_key(relation)} #{direction}")
+      relation.reorder(Arel.sql(order_by_id_query(relation)))
+    end
+
+    def order_by_attribute(relation)
+      if ordering_by_association_column?(relation)
+        relation.joins(
+          attribute.to_sym,
+        ).reorder(Arel.sql(order_by_attribute_query))
+      else
+        order_by_id(relation)
+      end
+    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 order_by_id_query(relation)
+      "#{relation.table_name}.#{foreign_key(relation)} #{direction}"
+    end
+
+    def order_by_attribute_query
+      "#{attribute.tableize}.#{association_attribute} #{direction}"
     end
 
     def has_many_attribute?(relation)

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/form.rb

@@ -10,8 +10,15 @@ module Administrate
 
       attr_reader :resource
 
-      def attributes
-        dashboard.form_attributes.map do |attribute|
+      def attributes(action = nil)
+        action =
+          case action
+          when "update" then "edit"
+          when "create" then "new"
+          else action
+          end
+
+        dashboard.form_attributes(action).map do |attribute|
           attribute_field(dashboard, resource, attribute, :form)
         end
       end

data/lib/administrate/resource_resolver.rb

@@ -9,7 +9,7 @@ module Administrate
     end
 
     def namespace
-      controller_path.split("/").first
+      controller_path.split("/").first.to_sym
     end
 
     def resource_class

data/lib/administrate/search.rb

@@ -4,14 +4,15 @@ require "active_support/core_ext/object/blank"
 module Administrate
   class Search
     class Query
-      attr_reader :filters
+      attr_reader :filters, :valid_filters
 
       def blank?
         terms.blank? && filters.empty?
       end
 
-      def initialize(original_query)
+      def initialize(original_query, valid_filters = nil)
         @original_query = original_query
+        @valid_filters = valid_filters
         @filters, @terms = parse_query(original_query)
       end
 
@@ -30,7 +31,7 @@ module Administrate
       private
 
       def filter?(word)
-        word.match?(/^\w+:$/)
+        valid_filters&.any? { |filter| word.match?(/^#{filter}:\w*$/) }
       end
 
       def parse_query(query)
@@ -38,7 +39,7 @@ module Administrate
         terms = []
         query.to_s.split.each do |word|
           if filter?(word)
-            filters << word.split(":").first
+            filters << word
           else
             terms << word
           end
@@ -47,10 +48,10 @@ module Administrate
       end
     end
 
-    def initialize(scoped_resource, dashboard_class, term)
-      @dashboard_class = dashboard_class
+    def initialize(scoped_resource, dashboard, term)
+      @dashboard = dashboard
       @scoped_resource = scoped_resource
-      @query = Query.new(term)
+      @query = Query.new(term, valid_filters.keys)
     end
 
     def run
@@ -65,15 +66,20 @@ module Administrate
 
     private
 
-    def apply_filter(filter, resources)
+    def apply_filter(filter, filter_param, resources)
       return resources unless filter
-      filter.call(resources)
+      if filter.parameters.size == 1
+        filter.call(resources)
+      else
+        filter.call(resources, filter_param)
+      end
     end
 
     def filter_results(resources)
-      query.filters.each do |filter_name|
+      query.filters.each do |filter_query|
+        filter_name, filter_param = filter_query.split(":")
         filter = valid_filters[filter_name]
-        resources = apply_filter(filter, resources)
+        resources = apply_filter(filter, filter_param, resources)
       end
       resources
     end
@@ -102,9 +108,7 @@ module Administrate
     end
 
     def search_attributes
-      attribute_types.keys.select do |attribute|
-        attribute_types[attribute].searchable?
-      end
+      @dashboard.search_attributes
     end
 
     def search_results(resources)
@@ -114,15 +118,15 @@ module Administrate
     end
 
     def valid_filters
-      if @dashboard_class.const_defined?(:COLLECTION_FILTERS)
-        @dashboard_class.const_get(:COLLECTION_FILTERS).stringify_keys
+      if @dashboard.class.const_defined?(:COLLECTION_FILTERS)
+        @dashboard.class.const_get(:COLLECTION_FILTERS).stringify_keys
       else
         {}
       end
     end
 
     def attribute_types
-      @dashboard_class::ATTRIBUTE_TYPES
+      @dashboard.class.const_get(:ATTRIBUTE_TYPES)
     end
 
     def query_table_name(attr)

data/lib/administrate/version.rb

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

data/lib/administrate/view_generator.rb

@@ -5,7 +5,7 @@ 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, default: :admin
 
     def self.template_source_path
       File.expand_path(

data/lib/administrate.rb

@@ -20,4 +20,22 @@ module Administrate
       "if you think otherwise.",
     )
   end
+
+  def self.warn_of_deprecated_method(klass, method)
+    ActiveSupport::Deprecation.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)
+    ActiveSupport::Deprecation.warn(
+      "The method `#{method}` is deprecated. " +
+      "Please use `accessible_action?` instead, " +
+      "or see the documentation for other options.",
+    )
+  end
 end

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

@@ -27,7 +27,7 @@ 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, default: :admin
 
       source_root File.expand_path("../templates", __FILE__)
 
@@ -53,9 +53,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

@@ -1,5 +1,5 @@
-module <%= namespace.classify %>
-  class <%= class_name.pluralize %>Controller < <%= namespace.classify %>::ApplicationController
+module <%= namespace.to_s.camelize %>
+  class <%= class_name.pluralize %>Controller < <%= namespace.to_s.camelize %>::ApplicationController
     # Overwrite any of the RESTful controller actions to implement custom behavior
     # For example, you may want to send an email after a foo is updated.
     #

data/lib/generators/administrate/install/templates/application_controller.rb.erb

@@ -4,7 +4,7 @@
 #
 # If you want to add pagination or other controller-level concerns,
 # you're free to overwrite the RESTful controller actions.
-module <%= namespace.classify %>
+module <%= namespace.camelize %>
   class ApplicationController < Administrate::ApplicationController
     before_action :authenticate_admin