administrate 0.8.1 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bbf40650e2f1b5fef6121aed98256dfc8225bb12
-  data.tar.gz: ec4394132d9e3b0f5117b95e26dcbc8d3fca3bea
+SHA256:
+  metadata.gz: 6a099c28c8a74491759229e6fe82de763f25b9ff59473d5c70b00d38675e3498
+  data.tar.gz: c24140b9e1bc63eb9ecd5f38cd0cfd3d3c0f125a81370df1dd6663af66121baa
 SHA512:
-  metadata.gz: 9e9014f2e04d659e1ca3d8e7fdb3b54f55097bfb8911279baf03f5114db200d4de3cc4a1b0fe745d70e033aa790e43e50a1f5b7f708897623cfeff75b156204b
-  data.tar.gz: 23896d95877e97096300d8412b9a5ff9332aceb3f9aabee06cd297f6641a01bfe6a0e86b2b6c48cd55f047decb0d77935e21874bba5459a118cde5051a28adee
+  metadata.gz: 8ada94532afa210a359eece24f042fdb7de549cdb6bb94507c044f85df7b26cfbd5855202de2016255d635d2448dcba303d91eac4dc41c896f30e52f95073345
+  data.tar.gz: 98e115c8c3acfe7dc5cab3a3055b5f06dfa5661f9d2eb135c528b474cbe36e6fb51b36a8c88489860a9fda200758ce37f4d60375705f0e0234af4dc2805e75ff

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

@@ -0,0 +1,5 @@
+$(function() {
+  $('.field-unit--belongs-to select').selectize({});
+  $(".field-unit--has-many select").selectize({});
+  $('.field-unit--polymorphic select').selectize({});
+});

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

@@ -1,6 +1,14 @@
 $(function () {
-  $(".datetimepicker").datetimepicker({
+  $('[data-type="time"]').datetimepicker({
     debug: false,
-    format: "YYYY-MM-DD HH:mm:ss",
+    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/app/assets/javascripts/administrate/components/table.js

@@ -13,7 +13,7 @@ $(function() {
       var dataUrl = $(event.target).closest("tr").data("url");
       var selection = window.getSelection().toString();
       if (selection.length === 0 && dataUrl) {
-        window.location = dataUrl;
+        window.location = window.location.protocol + '//' + window.location.host + dataUrl;
       }
     }
   };

data/app/assets/stylesheets/administrate/base/_tables.scss

@@ -21,6 +21,9 @@ tr {
 tbody tr {
   &:hover {
     background-color: $base-background-color;
+  }
+
+  [role=link] {
     cursor: pointer;
   }
 

data/app/assets/stylesheets/administrate/base/_typography.scss

@@ -23,7 +23,7 @@ p {
 
 a {
   color: $action-color;
-  text-decoration-skip: ink;
+  text-decoration-skip-ink: auto;
   transition: color $base-duration $base-timing;
 
   &:hover {

data/app/assets/stylesheets/administrate/components/_attributes.scss

@@ -3,9 +3,9 @@
   clear: left;
   float: left;
   margin-bottom: $base-spacing;
-  margin-top: 0;
+  margin-top: 0.25em;
   text-align: right;
-  width: calc(15% - 1rem);
+  width: calc(20% - 1rem);
 }
 
 .preserve-whitespace {
@@ -17,7 +17,8 @@
   float: left;
   margin-bottom: $base-spacing;
   margin-left: 2rem;
-  width: calc(85% - 1rem);
+  width: calc(80% - 1rem);
+  word-break: break-word;
 }
 
 .attribute--nested {

data/app/assets/stylesheets/administrate/components/_buttons.scss

@@ -41,3 +41,14 @@ input[type="submit"],
     }
   }
 }
+
+.button--alt {
+  background-color: transparent;
+  border: $base-border;
+  border-color: $blue;
+  color: $blue;
+}
+
+.button--nav {
+  margin-bottom: $base-spacing;
+}

data/app/assets/stylesheets/administrate/components/_cells.scss

@@ -1,5 +1,5 @@
 .cell-label {
-  position: relative;
+  padding-top: 0.15em;
 
   &:hover {
     a {
@@ -26,10 +26,8 @@
 }
 
 .cell-label__sort-indicator {
-  display: inline-block;
-  overflow: hidden;
-  position: absolute;
-  right: 0;
+  float: right;
+  margin-left: 5px;
 
   svg {
     fill: $hint-grey;

data/app/assets/stylesheets/administrate/components/_field-unit.scss

@@ -17,20 +17,33 @@
 .field-unit__field {
   float: left;
   margin-left: 2rem;
-  width: 45%;
+  max-width: 50rem;
+  width: 100%;
+
+  .optgroup-header {
+    font-weight: $bold-font-weight;
+  }
 }
 
 .field-unit--nested {
   border: $base-border;
   margin-left: 7.5%;
+  max-width: 60rem;
   padding: $small-spacing;
-  width: 50%;
+  width: 100%;
 
   .field-unit__field {
-    width: calc(75% - 1rem);
+    width: 100%;
   }
 
   .field-unit__label {
-    width: calc(25% - 1rem);
+    width: 10rem;
+  }
+}
+
+.field-unit--required {
+  label::after {
+    color: $red;
+    content: " *";
   }
 }

data/app/assets/stylesheets/administrate/components/_flashes.scss

@@ -1,11 +1,3 @@
-$base-spacing: 1.5em !default;
-$flashes: (
-  "alert": #fff6bf,
-  "error": #fbe3e4,
-  "notice": #e5edf8,
-  "success": #e6efc2,
-) !default;
-
 @each $flash-type, $color in $flashes {
   .flash-#{$flash-type} {
     background-color: $color;

data/app/assets/stylesheets/administrate/components/_main-content.scss

@@ -5,6 +5,7 @@
               0 2px 2px rgba($black, 0.2);
   flex: 1 1 100%;
   padding-bottom: 10vh;
+  min-width: 800px;
 }
 
 .main-content__header,

data/app/assets/stylesheets/administrate/components/_navigation.scss

@@ -2,9 +2,8 @@ $_navigation-link-padding: 0.6em;
 
 .navigation {
   flex: 1 0 10rem;
-  padding-bottom: $base-spacing;
-  padding-right: calc(#{$base-spacing} - #{$_navigation-link-padding});
-  padding-top: $base-spacing;
+  padding: $base-spacing;
+  padding-left: 0;
 }
 
 .navigation__link {

data/app/assets/stylesheets/administrate/library/_variables.scss

@@ -22,8 +22,10 @@ $black: #000 !default;
 
 $blue: #1976d2 !default;
 $red: #d32f2f !default;
-$light-yellow: #f0cd66 !default;
-$light-green: #4ab471 !default;
+$light-yellow: #fff6bf !default;
+$light-red: #fbe3e4 !default;
+$light-green: #e6efc2 !default;
+$light-blue: #e5edf8 !default;
 
 $grey-0: #f6f7f7 !default;
 $grey-1: #dfe0e1 !default;
@@ -47,12 +49,12 @@ $focus-outline: $focus-outline-width solid $focus-outline-color;
 $focus-outline-offset: 1px;
 
 // Flash Colors
-$flash-colors: (
-  alert: $light-yellow,
-  error: $red,
-  notice: mix($white, $blue, 50%),
-  success: $light-green
-);
+$flashes: (
+  "alert": $light-yellow,
+  "error": $light-red,
+  "notice": $light-blue,
+  "success": $light-green
+) !default;
 
 // Border
 $base-border-color: $grey-1 !default;

data/app/assets/stylesheets/docs.scss

@@ -80,6 +80,7 @@ code {
     padding-left: 1rem;
 
     .hljs-string { color: $code-green; }
+    .hljs-subst { color: $code-white; }
     .hljs-constant { color: $code-blue; }
     .hljs-symbol { color: $code-red; }
     .hljs-keyword { color: $code-yellow; }

data/app/controllers/administrate/application_controller.rb

@@ -3,20 +3,21 @@ module Administrate
     protect_from_forgery with: :exception
 
     def index
+      authorize_resource(resource_class)
       search_term = params[:search].to_s.strip
       resources = Administrate::Search.new(scoped_resource,
-                                           dashboard_class,
+                                           dashboard,
                                            search_term).run
-      resources = resources.includes(*resource_includes) if resource_includes.any?
+      resources = apply_collection_includes(resources)
       resources = order.apply(resources)
-      resources = resources.page(params[:page]).per(records_per_page)
+      resources = resources.page(params[:_page]).per(records_per_page)
       page = Administrate::Page::Collection.new(dashboard, order: order)
 
       render locals: {
         resources: resources,
         search_term: search_term,
         page: page,
-        show_search_bar: show_search_bar?
+        show_search_bar: show_search_bar?,
       }
     end
 
@@ -27,8 +28,10 @@ module Administrate
     end
 
     def new
+      resource = new_resource
+      authorize_resource(resource)
       render locals: {
-        page: Administrate::Page::Form.new(dashboard, resource_class.new),
+        page: Administrate::Page::Form.new(dashboard, resource),
       }
     end
 
@@ -40,43 +43,60 @@ module Administrate
 
     def create
       resource = resource_class.new(resource_params)
+      authorize_resource(resource)
 
       if resource.save
         redirect_to(
-          [namespace, resource],
+          after_resource_created_path(resource),
           notice: translate_with_resource("create.success"),
         )
       else
         render :new, locals: {
           page: Administrate::Page::Form.new(dashboard, resource),
-        }
+        }, status: :unprocessable_entity
       end
     end
 
     def update
       if requested_resource.update(resource_params)
         redirect_to(
-          [namespace, requested_resource],
+          after_resource_updated_path(requested_resource),
           notice: translate_with_resource("update.success"),
         )
       else
         render :edit, locals: {
           page: Administrate::Page::Form.new(dashboard, requested_resource),
-        }
+        }, status: :unprocessable_entity
       end
     end
 
     def destroy
-      requested_resource.destroy
-      flash[:notice] = translate_with_resource("destroy.success")
-      redirect_to action: :index
+      if requested_resource.destroy
+        flash[:notice] = translate_with_resource("destroy.success")
+      else
+        flash[:error] = requested_resource.errors.full_messages.join("<br/>")
+      end
+      redirect_to after_resource_destroyed_path(requested_resource)
     end
 
     private
 
+    def after_resource_destroyed_path(_requested_resource)
+      { action: :index }
+    end
+
+    def after_resource_created_path(requested_resource)
+      [namespace, requested_resource]
+    end
+
+    def after_resource_updated_path(requested_resource)
+      [namespace, requested_resource]
+    end
+
     helper_method :nav_link_state
     def nav_link_state(resource)
-      resource_name.to_s.pluralize == resource.to_s ? :active : :inactive
+      underscore_resource = resource.to_s.split("/").join("__")
+      resource_name.to_s.pluralize == underscore_resource ? :active : :inactive
     end
 
     helper_method :valid_action?
@@ -95,15 +115,37 @@ module Administrate
     end
 
     def order
-      @_order ||= Administrate::Order.new(params[:order], params[:direction])
+      @order ||= Administrate::Order.new(sorting_attribute, sorting_direction)
+    end
+
+    def sorting_attribute
+      sorting_params.fetch(:order) { default_sorting_attribute }
+    end
+
+    def default_sorting_attribute
+      nil
+    end
+
+    def sorting_direction
+      sorting_params.fetch(:direction) { default_sorting_direction }
+    end
+
+    def default_sorting_direction
+      nil
+    end
+
+    def sorting_params
+      Hash.try_convert(request.query_parameters[resource_name]) || {}
     end
 
     def dashboard
-      @_dashboard ||= dashboard_class.new
+      @dashboard ||= dashboard_class.new
     end
 
     def requested_resource
-      @_requested_resource ||= find_resource(params[:id])
+      @requested_resource ||= find_resource(params[:id]).tap do |resource|
+        authorize_resource(resource)
+      end
     end
 
     def find_resource(param)
@@ -114,22 +156,40 @@ module Administrate
       resource_class.default_scoped
     end
 
-    def resource_includes
-      dashboard.association_includes
+    def apply_collection_includes(relation)
+      resource_includes = dashboard.collection_includes
+      return relation if resource_includes.empty?
+      relation.includes(*resource_includes)
     end
 
     def resource_params
       params.require(resource_class.model_name.param_key).
-        permit(dashboard.permitted_attributes)
+        permit(dashboard.permitted_attributes).
+        transform_values { |v| read_param_value(v) }
+    end
+
+    def read_param_value(data)
+      if data.is_a?(ActionController::Parameters) && data[:type]
+        if data[:type] == Administrate::Field::Polymorphic.to_s
+          GlobalID::Locator.locate(data[:value])
+        else
+          raise "Unrecognised param data: #{data.inspect}"
+        end
+      elsif data.is_a?(ActionController::Parameters)
+        data.transform_values { |v| read_param_value(v) }
+      else
+        data
+      end
     end
 
     delegate :dashboard_class, :resource_class, :resource_name, :namespace,
       to: :resource_resolver
     helper_method :namespace
     helper_method :resource_name
+    helper_method :resource_class
 
     def resource_resolver
-      @_resource_resolver ||=
+      @resource_resolver ||=
         Administrate::ResourceResolver.new(controller_path)
     end
 
@@ -142,8 +202,22 @@ module Administrate
 
     def show_search_bar?
       dashboard.attribute_types_for(
-        dashboard.collection_attributes
+        dashboard.all_attributes,
       ).any? { |_name, attribute| attribute.searchable? }
     end
+
+    def show_action?(_action, _resource)
+      true
+    end
+    helper_method :show_action?
+
+    def new_resource
+      resource_class.new
+    end
+    helper_method :new_resource
+
+    def authorize_resource(resource)
+      resource
+    end
   end
 end

data/app/controllers/concerns/administrate/punditize.rb

@@ -0,0 +1,36 @@
+module Administrate
+  module Punditize
+    if Object.const_defined?("Pundit")
+      extend ActiveSupport::Concern
+      include Pundit
+
+      included do
+        def scoped_resource
+          policy_scope_admin super
+        end
+
+        def authorize_resource(resource)
+          authorize resource
+        end
+
+        def show_action?(action, resource)
+          Pundit.policy!(pundit_user, resource).send("#{action}?".to_sym)
+        end
+      end
+
+      private
+
+      # Like the policy_scope method in stock Pundit, but allows the 'resolve'
+      # to be overridden by 'resolve_admin' for a different index scope in Admin
+      # controllers.
+      def policy_scope_admin(scope)
+        ps = Pundit::PolicyFinder.new(scope).scope!.new(pundit_user, scope)
+        if ps.respond_to? :resolve_admin
+          ps.resolve_admin
+        else
+          ps.resolve
+        end
+      end
+    end
+  end
+end

data/app/helpers/administrate/application_helper.rb

@@ -1,22 +1,39 @@
 module Administrate
   module ApplicationHelper
     PLURAL_MANY_COUNT = 2.1
+    SINGULAR_COUNT = 1
+
+    def application_title
+      if Rails::VERSION::MAJOR <= 5
+        Rails.application.class.parent_name.titlecase
+      else
+        Rails.application.class.module_parent_name.titlecase
+      end
+    end
 
     def render_field(field, locals = {})
-      locals.merge!(field: field)
+      locals[:field] = field
       render locals: locals, partial: field.to_partial_path
     end
 
-    def display_resource_name(resource_name)
-      resource_name.
-        to_s.
-        classify.
-        constantize.
-        model_name.
-        human(
-          count: PLURAL_MANY_COUNT,
-          default: resource_name.to_s.pluralize.titleize,
-        )
+    def requireness(field)
+      field.required? ? "required" : "optional"
+    end
+
+    def dashboard_from_resource(resource_name)
+      "#{resource_name.to_s.singularize}_dashboard".classify.constantize
+    end
+
+    def model_from_resource(resource_name)
+      dashboard = dashboard_from_resource(resource_name)
+      dashboard.try(:model) || resource_name.to_sym
+    end
+
+    def display_resource_name(resource_name, opts = {})
+      dashboard_from_resource(resource_name).resource_name(
+        count: opts[:singular] ? SINGULAR_COUNT : PLURAL_MANY_COUNT,
+        default: default_resource_name(resource_name, opts),
+      )
     end
 
     def sort_order(order)
@@ -27,12 +44,32 @@ module Administrate
       end
     end
 
-    def sanitized_order_params
-      params.permit(:search, :id, :order, :page, :per_page, :direction, :orders)
+    def resource_index_route(resource_name)
+      url_for(
+        action: "index",
+        controller: "/#{namespace}/#{resource_name}",
+      )
+    end
+
+    def sanitized_order_params(page, current_field_name)
+      collection_names = page.item_includes + [current_field_name]
+      association_params = collection_names.map do |assoc_name|
+        { assoc_name => %i[order direction page per_page] }
+      end
+      params.permit(:search, :id, :_page, :per_page, association_params)
     end
 
     def clear_search_params
-      params.except(:search, :page).permit(:order, :direction, :per_page)
+      params.except(:search, :_page).permit(
+        :per_page, resource_name => %i[order direction]
+      )
+    end
+
+    private
+
+    def default_resource_name(name, opts = {})
+      resource_name = (opts[:singular] ? name.to_s : name.to_s.pluralize)
+      resource_name.gsub("/", "_").titleize
     end
   end
 end