administrate 0.8.1 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bbf40650e2f1b5fef6121aed98256dfc8225bb12
-  data.tar.gz: ec4394132d9e3b0f5117b95e26dcbc8d3fca3bea
+SHA256:
+  metadata.gz: 901108f5715bed268b4395d6edadf3738b127425910dc365390847710f19c98f
+  data.tar.gz: 6b61113c5c116250f2e46eaa5dbf77972473b16a6aae8042a6bcaef74f45308e
 SHA512:
-  metadata.gz: 9e9014f2e04d659e1ca3d8e7fdb3b54f55097bfb8911279baf03f5114db200d4de3cc4a1b0fe745d70e033aa790e43e50a1f5b7f708897623cfeff75b156204b
-  data.tar.gz: 23896d95877e97096300d8412b9a5ff9332aceb3f9aabee06cd297f6641a01bfe6a0e86b2b6c48cd55f047decb0d77935e21874bba5459a118cde5051a28adee
+  metadata.gz: ac4790d3bca102b4a27cc73f154e7167620f4589088b1207008f0915521735cfed483fbf085d24e7844e7b092f9f1a7d198ec6113cbc4be877758886c192f097
+  data.tar.gz: da2c64204adee3b43a566c67cf2aa42f37a0a38ea5f35b9988f704491f2b15dcd76210fb2f56f57de1576e77da71f429fe6572493e65933877b29f9eb9e5920f

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

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

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/_cells.scss

@@ -1,6 +1,4 @@
 .cell-label {
-  position: relative;
-
   &:hover {
     a {
       color: $action-color;
@@ -26,10 +24,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/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

@@ -7,7 +7,7 @@ module Administrate
       resources = Administrate::Search.new(scoped_resource,
                                            dashboard_class,
                                            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)
       page = Administrate::Page::Collection.new(dashboard, order: order)
@@ -16,7 +16,7 @@ module Administrate
         resources: resources,
         search_term: search_term,
         page: page,
-        show_search_bar: show_search_bar?
+        show_search_bar: show_search_bar?,
       }
     end
 
@@ -27,8 +27,10 @@ module Administrate
     end
 
     def new
+      resource = resource_class.new
+      authorize_resource(resource)
       render locals: {
-        page: Administrate::Page::Form.new(dashboard, resource_class.new),
+        page: Administrate::Page::Form.new(dashboard, resource),
       }
     end
 
@@ -40,6 +42,7 @@ module Administrate
 
     def create
       resource = resource_class.new(resource_params)
+      authorize_resource(resource)
 
       if resource.save
         redirect_to(
@@ -67,8 +70,11 @@ module Administrate
     end
 
     def destroy
-      requested_resource.destroy
-      flash[:notice] = translate_with_resource("destroy.success")
+      if requested_resource.destroy
+        flash[:notice] = translate_with_resource("destroy.success")
+      else
+        flash[:error] = requested_resource.errors.full_messages.join("<br/>")
+      end
       redirect_to action: :index
     end
 
@@ -95,15 +101,20 @@ module Administrate
     end
 
     def order
-      @_order ||= Administrate::Order.new(params[:order], params[:direction])
+      @order ||= Administrate::Order.new(
+        params.fetch(resource_name, {}).fetch(:order, nil),
+        params.fetch(resource_name, {}).fetch(:direction, nil),
+      )
     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,13 +125,28 @@ 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
+      else
+        data
+      end
     end
 
     delegate :dashboard_class, :resource_class, :resource_name, :namespace,
@@ -129,7 +155,7 @@ module Administrate
     helper_method :resource_name
 
     def resource_resolver
-      @_resource_resolver ||=
+      @resource_resolver ||=
         Administrate::ResourceResolver.new(controller_path)
     end
 
@@ -142,8 +168,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

@@ -2,16 +2,25 @@ module Administrate
   module ApplicationHelper
     PLURAL_MANY_COUNT = 2.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)
       render locals: locals, partial: field.to_partial_path
     end
 
+    def class_from_resource(resource_name)
+      resource_name.to_s.classify.constantize
+    end
+
     def display_resource_name(resource_name)
-      resource_name.
-        to_s.
-        classify.
-        constantize.
+      class_from_resource(resource_name).
         model_name.
         human(
           count: PLURAL_MANY_COUNT,
@@ -27,12 +36,22 @@ module Administrate
       end
     end
 
-    def sanitized_order_params
-      params.permit(:search, :id, :order, :page, :per_page, :direction, :orders)
+    def resource_index_route_key(resource_name)
+      ActiveModel::Naming.route_key(class_from_resource(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
   end
 end

data/app/views/administrate/application/_collection.html.erb

@@ -28,14 +28,13 @@ to display a collection of resources in an HTML table.
         scope="col"
         role="columnheader"
         aria-sort="<%= sort_order(collection_presenter.ordered_html_class(attr_name)) %>">
-        <%= link_to(sanitized_order_params.merge(
-          collection_presenter.order_params_for(attr_name)
+        <%= link_to(sanitized_order_params(page, collection_field_name).merge(
+          collection_presenter.order_params_for(attr_name, key: collection_field_name)
         )) do %>
         <%= t(
           "helpers.label.#{collection_presenter.resource_name}.#{attr_name}",
           default: attr_name.to_s,
         ).titleize %>
-
             <% if collection_presenter.ordered_by?(attr_name) %>
               <span class="cell-label__sort-indicator cell-label__sort-indicator--<%= collection_presenter.ordered_html_class(attr_name) %>">
                 <svg aria-hidden="true">
@@ -63,11 +62,13 @@ to display a collection of resources in an HTML table.
           >
         <% collection_presenter.attributes_for(resource).each do |attribute| %>
           <td class="cell-data cell-data--<%= attribute.html_class %>">
-            <a href="<%= polymorphic_path([namespace, resource]) -%>"
-               class="action-show"
-               >
-              <%= render_field attribute %>
-            </a>
+            <% if show_action? :show, resource -%>
+              <a href="<%= polymorphic_path([namespace, resource]) -%>"
+                 class="action-show"
+                 >
+                <%= render_field attribute %>
+              </a>
+            <% end -%>
           </td>
         <% end %>
 
@@ -76,7 +77,7 @@ to display a collection of resources in an HTML table.
             t("administrate.actions.edit"),
             [:edit, namespace, resource],
             class: "action-edit",
-          ) %></td>
+          ) if show_action? :edit, resource%></td>
         <% end %>
 
         <% if valid_action? :destroy, collection_presenter.resource_name %>
@@ -86,7 +87,7 @@ to display a collection of resources in an HTML table.
             class: "text-color-red",
             method: :delete,
             data: { confirm: t("administrate.actions.confirm") }
-          ) %></td>
+          ) if show_action? :destroy, resource %></td>
         <% end %>
       </tr>
     <% end %>

data/app/views/administrate/application/_flashes.html.erb

@@ -14,7 +14,7 @@ This partial renders flash messages on every page.
 <% if flash.any? %>
   <div class="flashes">
     <% flash.each do |key, value| -%>
-      <div class="flash flash-<%= key %>"><%= value %></div>
+      <div class="flash flash-<%= key %>"><%= value.html_safe %></div>
     <% end -%>
   </div>
 <% end %>

data/app/views/administrate/application/_form.html.erb

@@ -18,8 +18,11 @@ and renders all form fields for a resource's editable attributes.
   <% if page.resource.errors.any? %>
     <div id="error_explanation">
       <h2>
-        <%= pluralize(page.resource.errors.count, "error") %>
-        prohibited this <%= page.resource_name %> from being saved:
+        <%= t(
+          "administrate.form.errors",
+          pluralized_errors: pluralize(page.resource.errors.count, t("administrate.form.error")),
+          resource_name: display_resource_name(page.resource_name)
+        ) %>
       </h2>
 
       <ul>

data/app/views/administrate/application/_navigation.html.erb

@@ -11,7 +11,7 @@ as defined by the routes in the `admin/` namespace
   <% Administrate::Namespace.new(namespace).resources.each do |resource| %>
     <%= link_to(
       display_resource_name(resource),
-      [namespace, resource.path],
+      [namespace, resource_index_route_key(resource)],
       class: "navigation__link navigation__link--#{nav_link_state(resource)}"
     ) %>
   <% end %>

data/app/views/administrate/application/edit.html.erb

@@ -15,7 +15,7 @@ It displays a header, and renders the `_form` partial to do the heavy lifting.
 [1]: http://www.rubydoc.info/gems/administrate/Administrate/Page/Form
 %>
 
-<% content_for(:title) { "#{t("administrate.actions.edit")} #{page.page_title}" } %>
+<% content_for(:title) { t("administrate.actions.edit_resource", name: page.page_title) } %>
 
 <header class="main-content__header" role="banner">
   <h1 class="main-content__page-title">
@@ -24,10 +24,10 @@ It displays a header, and renders the `_form` partial to do the heavy lifting.
 
   <div>
     <%= link_to(
-      "#{t("administrate.actions.show")} #{page.page_title}",
+      t("administrate.actions.show_resource", name: page.page_title),
       [namespace, page.resource],
       class: "button",
-    ) if valid_action? :show %>
+    ) if valid_action?(:show) && show_action?(:show, page.resource) %>
   </div>
 </header>
 

data/app/views/administrate/application/index.html.erb

@@ -42,10 +42,13 @@ It renders the `_table` partial to display details about the resources.
 
   <div>
     <%= link_to(
-      "#{t("administrate.actions.new")} #{page.resource_name.titleize.downcase}",
+      t(
+        "administrate.actions.new_resource",
+        name: page.resource_name.titleize.downcase
+      ),
       [:new, namespace, page.resource_path],
       class: "button",
-    ) if valid_action? :new %>
+    ) if valid_action?(:new) && show_action?(:new, new_resource) %>
   </div>
 </header>
 
@@ -53,6 +56,8 @@ It renders the `_table` partial to display details about the resources.
   <%= render(
     "collection",
     collection_presenter: page,
+    collection_field_name: resource_name,
+    page: page,
     resources: resources,
     table_title: "page-title"
   ) %>

data/app/views/administrate/application/new.html.erb

@@ -15,7 +15,12 @@ to do the heavy lifting.
 [1]: http://www.rubydoc.info/gems/administrate/Administrate/Page/Form
 %>
 
-<% content_for(:title) { "#{t("administrate.actions.new")} #{page.resource_name.titleize}" } %>
+<% content_for(:title) do %>
+  <%= t(
+    "administrate.actions.new_resource",
+    name: display_resource_name(page.resource_name).titleize
+  ) %>
+<% end %>
 
 <header class="main-content__header" role="banner">
   <h1 class="main-content__page-title">

data/app/views/administrate/application/show.html.erb

@@ -16,7 +16,7 @@ as well as a link to its edit page.
 [1]: http://www.rubydoc.info/gems/administrate/Administrate/Page/Show
 %>
 
-<% content_for(:title) { "#{t("administrate.actions.show")} #{page.page_title}" } %>
+<% content_for(:title) { t("administrate.actions.show_resource", name: page.page_title) } %>
 
 <header class="main-content__header" role="banner">
   <h1 class="main-content__page-title">
@@ -25,10 +25,10 @@ as well as a link to its edit page.
 
   <div>
     <%= link_to(
-      "#{t("administrate.actions.edit")} #{page.page_title}",
+      t("administrate.actions.edit_resource", name: page.page_title),
       [:edit, namespace, page.resource],
       class: "button",
-    ) if valid_action? :edit %>
+    ) if valid_action?(:edit) && show_action?(:edit, page.resource) %>
   </div>
 </header>
 
@@ -43,7 +43,7 @@ as well as a link to its edit page.
       </dt>
 
       <dd class="attribute-data attribute-data--<%=attribute.html_class%>"
-          ><%= render_field attribute %></dd>
+          ><%= render_field attribute, page: page %></dd>
     <% end %>
   </dl>
 </section>

data/app/views/fields/belongs_to/_index.html.erb

@@ -16,7 +16,7 @@ By default, the relationship is rendered as a link to the associated object.
 %>
 
 <% if field.data %>
-  <% if valid_action?(:show, field.attribute) %>
+  <% if valid_action?(:show, field.associated_class) %>
     <%= link_to(
       field.display_associated_resource,
       [namespace, field.data],

data/app/views/fields/belongs_to/_show.html.erb

@@ -16,7 +16,7 @@ By default, the relationship is rendered as a link to the associated object.
 %>
 
 <% if field.data %>
-  <% if valid_action?(:show, field.attribute) %>
+  <% if valid_action?(:show, field.associated_class) %>
     <%= link_to(
       field.display_associated_resource,
       [namespace, field.data],

data/app/views/fields/date_time/_form.html.erb

@@ -20,5 +20,5 @@ By default, the input is a text field that is augmented with [DateTimePicker].
   <%= f.label field.attribute %>
 </div>
 <div class="field-unit__field">
-  <%= f.text_field field.attribute, class: "datetimepicker" %>
+  <%= f.text_field field.attribute, data: { type: 'datetime' }  %>
 </div>

data/app/views/fields/date_time/_index.html.erb

@@ -17,5 +17,5 @@ as a localized date & time string.
 %>
 
 <% if field.data %>
-  <%= field.date %>
+  <%= field.datetime %>
 <% end %>

data/app/views/fields/has_many/_form.html.erb

@@ -1,7 +1,7 @@
 <%#
 # HasMany Form Partial
 
-This partial renders an input element for belongs_to relationships.
+This partial renders an input element for has_many relationships.
 By default, the input is a collection select box
 that displays all possible records to associate with.
 The collection select box supports multiple inputs,
@@ -20,7 +20,7 @@ and is augmented with [Selectize].
 %>
 
 <div class="field-unit__label">
-  <%= f.label field.attribute_key, field.attribute %>
+  <%= f.label field.attribute, for: "#{f.object_name}_#{field.attribute_key}" %>
 </div>
 <div class="field-unit__field">
   <%= f.select(field.attribute_key, nil, {}, multiple: true) do %>

data/app/views/fields/has_many/_index.html.erb

@@ -16,4 +16,4 @@ as a count of how many objects are associated through the relationship.
 [1]: http://www.rubydoc.info/gems/administrate/Administrate/Field/HasMany
 %>
 
-<%= pluralize(field.data.size, field.attribute.to_s.humanize.downcase) %>
+<%= pluralize(field.data.size, field.attribute.to_s.humanize.downcase.singularize) %>

data/app/views/fields/has_many/_show.html.erb

@@ -19,15 +19,18 @@ from the associated resource class's dashboard.
 %>
 
 <% if field.resources.any? %>
+  <% order = field.order_from_params(params.fetch(field.name, {})) %>
+  <% page_number = params.fetch(field.name, {}).fetch(:page, nil) %>
   <%= render(
     "collection",
-    collection_presenter: field.associated_collection,
-    resources: field.resources(params[field.name]),
-    table_title: field.name
+    collection_presenter: field.associated_collection(order),
+    collection_field_name: field.name,
+    page: page,
+    resources: field.resources(page_number, order),
+    table_title: field.name,
   ) %>
-
   <% if field.more_than_limit? %>
-    <%= paginate field.resources(params[field.name]), param_name: "#{field.name}" %>
+    <%= paginate field.resources(page_number), param_name: "#{field.name}[page]" %>
   <% end %>
 
 <% else %>

data/app/views/fields/has_one/_form.html.erb

@@ -18,7 +18,7 @@ The form will be rendered as nested_from to parent relationship.
 
 <%= f.fields_for field.attribute, field.data || field.nested_form.resource.class.new do |has_one_f| %>
   <fieldset class="field-unit--nested">
-    <legend><%= field.nested_form.resource_name.titleize %></legend>
+    <legend><%= t "helpers.label.#{f.object_name}.#{field.nested_form.resource_name}", default: field.nested_form.resource_name.titleize %></legend>
     <% field.nested_form.attributes.each do |attribute| -%>
       <div class="field-unit field-unit--<%= attribute.html_class %>">
         <%= render_field attribute, f: has_one_f %>

data/app/views/fields/password/_form.html.erb

@@ -0,0 +1,23 @@
+<%#
+# Password Form Partial
+
+This partial renders an input element for a password attribute.
+By default, the input is a password field.
+
+## Local variables:
+
+- `f`:
+  A Rails form generator, used to help create the appropriate input fields.
+- `field`:
+  An instance of [Administrate::Field::Password][1].
+  A wrapper around the Password.
+
+[1]: http://www.rubydoc.info/gems/administrate/Administrate/Field/Password
+%>
+
+<div class="field-unit__label">
+  <%= f.label field.attribute %>
+</div>
+<div class="field-unit__field">
+  <%= f.password_field field.attribute, value: field.data %>
+</div>

data/app/views/fields/password/_index.html.erb

@@ -0,0 +1,18 @@
+<%#
+# Password Index Partial
+
+This partial renders a password attribute
+to be displayed on a resource's index page.
+
+By default, the attribute is rendered as a truncated string.
+
+## Local variables:
+
+- `field`:
+  An instance of [Administrate::Field::Password][1].
+  A wrapper around the Password.
+
+[1]: http://www.rubydoc.info/gems/administrate/Administrate/Field/Password
+%>
+
+<%= field.truncate %>

data/app/views/fields/password/_show.html.erb

@@ -0,0 +1,18 @@
+<%#
+# Password Show Partial
+
+This partial renders a password attribute,
+to be displayed on a resource's show page.
+
+By default, the attribute is rendered as an truncate string.
+
+## Local variables:
+
+- `field`:
+  An instance of [Administrate::Field::Password][1].
+  A wrapper around the Password.
+
+[1]: http://www.rubydoc.info/gems/administrate/Administrate/Field/Password
+%>
+
+<%= field.truncate %>