administrate 0.12.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 901108f5715bed268b4395d6edadf3738b127425910dc365390847710f19c98f
-  data.tar.gz: 6b61113c5c116250f2e46eaa5dbf77972473b16a6aae8042a6bcaef74f45308e
+  metadata.gz: bb407c439ba3795c3161109f57d64a8e20db553d80f583c6d2a66bfe0f713cd7
+  data.tar.gz: 1691010813773e6ecc19b067adb4a610c6624f2ec2d8a03bb6414a683d5d83b0
 SHA512:
-  metadata.gz: ac4790d3bca102b4a27cc73f154e7167620f4589088b1207008f0915521735cfed483fbf085d24e7844e7b092f9f1a7d198ec6113cbc4be877758886c192f097
-  data.tar.gz: da2c64204adee3b43a566c67cf2aa42f37a0a38ea5f35b9988f704491f2b15dcd76210fb2f56f57de1576e77da71f429fe6572493e65933877b29f9eb9e5920f
+  metadata.gz: 0fc7042ed3389b1cf87a4ba41681e310dc3678e790a5af0d3c3e3d64c213f50b5bf66409069159a18e784c9cdaf5e6d60e2d2614f4647b5ab0d8e0b4e2f6b70e
+  data.tar.gz: 1c8b66a38eca96f2002ccd8b253b4fc7abd082e7376111e2e1be399b870755ce29511982828760fd6a229f5571eb1ace83a9121fae2253db2653218ffbd237ce

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,10 +1,14 @@
 $(function () {
   $('[data-type="time"]').datetimepicker({
     debug: false,
-    format: "HH:mm:ss",
+    format: 'HH:mm:ss',
   });
   $('[data-type="datetime"]').datetimepicker({
     debug: false,
-    format: "YYYY-MM-DD HH:mm:ss",
+    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/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,11 @@ input[type="submit"],
     }
   }
 }
+
+.button--alt {
+  background-color: transparent;
+  border: $base-border;
+  border-color: $blue;
+  color: $blue;
+  margin-bottom: $base-spacing;
+}

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

@@ -1,4 +1,6 @@
 .cell-label {
+  padding-top: 0.15em;
+
   &:hover {
     a {
       color: $action-color;

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/controllers/administrate/application_controller.rb

@@ -3,13 +3,14 @@ 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,
                                            search_term).run
       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: {
@@ -27,7 +28,7 @@ module Administrate
     end
 
     def new
-      resource = resource_class.new
+      resource = new_resource
       authorize_resource(resource)
       render locals: {
         page: Administrate::Page::Form.new(dashboard, resource),
@@ -52,7 +53,7 @@ module Administrate
       else
         render :new, locals: {
           page: Administrate::Page::Form.new(dashboard, resource),
-        }
+        }, status: :unprocessable_entity
       end
     end
 
@@ -65,7 +66,7 @@ module Administrate
       else
         render :edit, locals: {
           page: Administrate::Page::Form.new(dashboard, requested_resource),
-        }
+        }, status: :unprocessable_entity
       end
     end
 
@@ -101,10 +102,27 @@ module Administrate
     end
 
     def order
-      @order ||= Administrate::Order.new(
-        params.fetch(resource_name, {}).fetch(:order, nil),
-        params.fetch(resource_name, {}).fetch(:direction, nil),
-      )
+      @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
@@ -144,6 +162,8 @@ module Administrate
         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
@@ -153,6 +173,7 @@ module Administrate
       to: :resource_resolver
     helper_method :namespace
     helper_method :resource_name
+    helper_method :resource_class
 
     def resource_resolver
       @resource_resolver ||=

data/app/helpers/administrate/application_helper.rb

@@ -1,6 +1,7 @@
 module Administrate
   module ApplicationHelper
     PLURAL_MANY_COUNT = 2.1
+    SINGULAR_COUNT = 1
 
     def application_title
       if Rails::VERSION::MAJOR <= 5
@@ -11,21 +12,28 @@ module Administrate
     end
 
     def render_field(field, locals = {})
-      locals.merge!(field: field)
+      locals[:field] = field
       render locals: locals, partial: field.to_partial_path
     end
 
-    def class_from_resource(resource_name)
-      resource_name.to_s.classify.constantize
+    def requireness(field)
+      field.required? ? "required" : "optional"
     end
 
-    def display_resource_name(resource_name)
-      class_from_resource(resource_name).
-        model_name.
-        human(
-          count: PLURAL_MANY_COUNT,
-          default: resource_name.to_s.pluralize.titleize,
-        )
+    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)
@@ -36,8 +44,11 @@ module Administrate
       end
     end
 
-    def resource_index_route_key(resource_name)
-      ActiveModel::Naming.route_key(class_from_resource(resource_name))
+    def resource_index_route(resource_name)
+      url_for(
+        action: "index",
+        controller: "/#{namespace}/#{resource_name}",
+      )
     end
 
     def sanitized_order_params(page, current_field_name)
@@ -45,13 +56,20 @@ module Administrate
       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)
+      params.permit(:search, :id, :_page, :per_page, association_params)
     end
 
     def clear_search_params
-      params.except(:search, :page).permit(
+      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

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

@@ -33,7 +33,7 @@ to display a collection of resources in an HTML table.
         )) do %>
         <%= t(
           "helpers.label.#{collection_presenter.resource_name}.#{attr_name}",
-          default: attr_name.to_s,
+          default: resource_class.human_attribute_name(attr_name),
         ).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) %>">
@@ -55,19 +55,21 @@ to display a collection of resources in an HTML table.
   <tbody>
     <% resources.each do |resource| %>
       <tr class="js-table-row"
-          tabindex="0"
-          <% if valid_action? :show, collection_presenter.resource_name %>
-            <%= %(role=link data-url=#{polymorphic_path([namespace, resource])}) %>
+          <% if show_action? :show, resource %>
+            <%= %(tabindex=0 role=link data-url=#{polymorphic_path([namespace, resource])}) %>
           <% end %>
           >
         <% collection_presenter.attributes_for(resource).each do |attribute| %>
           <td class="cell-data cell-data--<%= attribute.html_class %>">
             <% if show_action? :show, resource -%>
               <a href="<%= polymorphic_path([namespace, resource]) -%>"
+                 tabindex="-1"
                  class="action-show"
                  >
                 <%= render_field attribute %>
               </a>
+            <% else %>
+              <%= render_field attribute %>
             <% end -%>
           </td>
         <% end %>

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

@@ -21,7 +21,7 @@ and renders all form fields for a resource's editable attributes.
         <%= t(
           "administrate.form.errors",
           pluralized_errors: pluralize(page.resource.errors.count, t("administrate.form.error")),
-          resource_name: display_resource_name(page.resource_name)
+          resource_name: display_resource_name(page.resource_name, singular: true)
         ) %>
       </h2>
 
@@ -34,7 +34,7 @@ and renders all form fields for a resource's editable attributes.
   <% end %>
 
   <% page.attributes.each do |attribute| -%>
-    <div class="field-unit field-unit--<%= attribute.html_class %>">
+    <div class="field-unit field-unit--<%= attribute.html_class %> field-unit--<%= requireness(attribute) %>">
       <%= render_field attribute, f: f %>
     </div>
   <% end -%>

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

@@ -8,11 +8,13 @@ as defined by the routes in the `admin/` namespace
 %>
 
 <nav class="navigation" role="navigation">
-  <% Administrate::Namespace.new(namespace).resources.each do |resource| %>
+  <%= link_to(t("administrate.navigation.back_to_app"), root_url, class: "button button--alt") if defined?(root_url) %>
+
+  <% Administrate::Namespace.new(namespace).resources_with_index_route.each do |resource| %>
     <%= link_to(
       display_resource_name(resource),
-      [namespace, resource_index_route_key(resource)],
+      resource_index_route(resource),
       class: "navigation__link navigation__link--#{nav_link_state(resource)}"
-    ) %>
+    ) if valid_action?(:index, resource) && show_action?(:index, model_from_resource(resource)) %>
   <% end %>
 </nav>

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

@@ -44,7 +44,7 @@ It renders the `_table` partial to display details about the resources.
     <%= link_to(
       t(
         "administrate.actions.new_resource",
-        name: page.resource_name.titleize.downcase
+        name: display_resource_name(page.resource_name, singular: true).downcase
       ),
       [:new, namespace, page.resource_path],
       class: "button",
@@ -62,5 +62,5 @@ It renders the `_table` partial to display details about the resources.
     table_title: "page-title"
   ) %>
 
-  <%= paginate resources %>
+  <%= paginate resources, param_name: '_page' %>
 </section>

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

@@ -38,7 +38,7 @@ as well as a link to its edit page.
       <dt class="attribute-label" id="<%= attribute.name %>">
       <%= t(
         "helpers.label.#{resource_name}.#{attribute.name}",
-        default: attribute.name.titleize,
+        default: page.resource.class.human_attribute_name(attribute.name),
       ) %>
       </dt>
 

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

@@ -20,7 +20,7 @@ that displays all possible records to associate with.
   <%= f.label field.permitted_attribute %>
 </div>
 <div class="field-unit__field">
-  <%= f.select(field.permitted_attribute) do %>
-    <%= options_for_select(field.associated_resource_options, field.selected_option) %>
-  <% end %>
+  <%= f.select(field.permitted_attribute,
+               options_for_select(field.associated_resource_options, field.selected_option),
+               include_blank: field.include_blank_option) %>
 </div>

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

@@ -0,0 +1,24 @@
+<%#
+# Date Form Partial
+
+This partial renders an input element for a date attribute.
+By default, the input is a text field that is augmented with [DateTimePicker].
+
+## Local variables:
+
+- `f`:
+  A Rails form generator, used to help create the appropriate input fields.
+- `field`:
+  An instance of [Administrate::Field::Date][1].
+  A wrapper around the Date value pulled from the database.
+
+[1]: http://www.rubydoc.info/gems/administrate/Administrate/Field/Date
+[DateTimePicker]: https://github.com/Eonasdan/bootstrap-datetimepicker
+%>
+
+<div class="field-unit__label">
+  <%= f.label field.attribute %>
+</div>
+<div class="field-unit__field">
+  <%= f.text_field field.attribute, data: { type: 'date' }  %>
+</div>

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

@@ -0,0 +1,21 @@
+<%#
+# Date Index Partial
+
+This partial renders a date attribute,
+to be displayed on a resource's index page.
+
+By default, the attribute is rendered
+as a localized date string.
+
+## Local variables:
+
+- `field`:
+  An instance of [Administrate::Field::Date][1].
+  A wrapper around the Date value pulled from the database.
+
+[1]: http://www.rubydoc.info/gems/administrate/Administrate/Field/Date
+%>
+
+<% if field.data %>
+  <%= field.date %>
+<% end %>

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

@@ -0,0 +1,21 @@
+<%#
+# Date Show Partial
+
+This partial renders a date attribute,
+to be displayed on a resource's show page.
+
+By default, the attribute is rendered
+as a localized date string.
+
+## Local variables:
+
+- `field`:
+  An instance of [Administrate::Field::Date][1].
+  A wrapper around the Date value pulled from the database.
+
+[1]: http://www.rubydoc.info/gems/administrate/Administrate/Field/Date
+%>
+
+<% if field.data %>
+  <%= field.date %>
+<% end %>

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

@@ -15,7 +15,7 @@ By default, the relationship is rendered as a link to the associated object.
 [1]: http://www.rubydoc.info/gems/administrate/Administrate/Field/HasOne
 %>
 
-<% if field.data %>
+<% if field.linkable? %>
   <%= link_to(
     field.display_associated_resource,
     [namespace, field.data],

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

@@ -4,7 +4,7 @@
 This partial renders a has_one relationship,
 to be displayed on a resource's show page.
 
-All fields of has_one relationship would be rendered
+All show page attributes of has_one relationship would be rendered
 
 ## Local variables:
 
@@ -15,7 +15,7 @@ All fields of has_one relationship would be rendered
 [1]: http://www.rubydoc.info/gems/administrate/Administrate/Field/HasOne
 %>
 
-<% if field.data %>
+<% if field.linkable? %>
   <fieldset class="attribute--nested">
     <legend>
       <%= link_to(
@@ -23,7 +23,7 @@ All fields of has_one relationship would be rendered
         [namespace, field.data],
       ) %>
     </legend>
-    <% field.nested_form.attributes.each do |attribute| -%>
+    <% field.nested_show.attributes.each do |attribute| -%>
       <div>
       <dt class="attribute-label">
         <%= t(
@@ -32,7 +32,7 @@ All fields of has_one relationship would be rendered
         ) %>
       </dt>
       <dd class="attribute-data attribute-data--<%= attribute.html_class %>">
-        <%= attribute.data %>
+        <%= render_field attribute, { page: page } %>
       </dd>
       </div>
     <% end -%>

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

@@ -19,5 +19,5 @@ By default, the input is a text field.
   <%= f.label field.attribute %>
 </div>
 <div class="field-unit__field">
-  <%= f.text_field field.attribute %>
+  <%= f.number_field field.attribute, step: "any" %>
 </div>

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

@@ -17,7 +17,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.data.class) %>
     <%= link_to(
       field.display_associated_resource,
       [namespace, field.data],

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

@@ -19,13 +19,25 @@ to be displayed on a resource's edit form page.
   <%= f.label field.attribute %>
 </div>
 <div class="field-unit__field">
-  <%= f.select(
-    field.attribute,
-    options_from_collection_for_select(
-      field.selectable_options,
-      :to_s,
-      :to_s,
-      field.data.presence,
-    )
-  ) %>
+  <% if field.selectable_options.first&.is_a?(Array) %>
+    <%= f.select(
+      field.attribute,
+      options_from_collection_for_select(
+        field.selectable_options,
+        :last,
+        :first,
+        field.data,
+      )
+    ) %>
+  <% else %>
+    <%= f.select(
+      field.attribute,
+      options_from_collection_for_select(
+        field.selectable_options,
+        :to_s,
+        :to_s,
+        field.data,
+      )
+    ) %>
+  <% end %>
 </div>