administrate 0.17.0 → 0.20.0

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.associated_class) && show_action?(:show, field.associated_class) %>
+  <% if accessible_action?(field.data, :show) %>
     <%= link_to(
       field.display_associated_resource,
       [namespace, field.data],

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

@@ -2,7 +2,6 @@
 # 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:
 
@@ -13,12 +12,11 @@ By default, the input is a text field that is augmented with [DateTimePicker].
   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' }  %>
+  <%= f.date_field field.attribute %>
 </div>

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

@@ -2,7 +2,6 @@
 # DateTime Form Partial
 
 This partial renders an input element for a datetime attribute.
-By default, the input is a text field that is augmented with [DateTimePicker].
 
 ## Local variables:
 
@@ -13,12 +12,11 @@ By default, the input is a text field that is augmented with [DateTimePicker].
   A wrapper around the DateTime value pulled from the database.
 
 [1]: http://www.rubydoc.info/gems/administrate/Administrate/Field/DateTime
-[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: 'datetime' }  %>
+  <%= f.datetime_local_field field.attribute, step: 1 %>
 </div>

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.singularize) %>
+<%= pluralize(field.data.size, t("activerecord.models.#{field.attribute.to_s.singularize}", default: field.attribute.to_s.humanize.downcase.singularize, count: field.data.size)) %>

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

@@ -28,9 +28,10 @@ from the associated resource class's dashboard.
     page: page,
     resources: field.resources(page_number, order),
     table_title: field.name,
+    resource_class: field.associated_class,
   ) %>
   <% if field.more_than_limit? %>
-    <%= paginate field.resources(page_number), param_name: "#{field.name}[page]" %>
+    <%= render("pagination", resources: field.resources(page_number), param_name: "#{field.name}[page]") %>
   <% end %>
 
 <% else %>

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

@@ -18,11 +18,21 @@ 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><%= 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 %>
-      </div>
+    <legend><%= t "helpers.label.#{f.object_name}.#{field.name}", default: field.name.titleize %></legend>
+    <% field.nested_form.attributes.each do |title, attributes| -%>
+
+      <fieldset class="<%= "field-unit--nested" if title.present? %>">
+        <% if title.present? %>
+          <legend><%= t "helpers.label.#{f.object_name}.#{title}", default: title %></legend>
+        <% end %>
+
+        <% attributes.each do |attribute| %>
+          <div class="field-unit field-unit--<%= attribute.html_class %>">
+            <%= render_field attribute, f: has_one_f %>
+          </div>
+        <% end %>
+      </fieldset>
+
     <% end -%>
   </fieldset>
 <% end %>

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

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

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

@@ -18,23 +18,30 @@ All show page attributes of has_one relationship would be rendered
 <% if field.linkable? %>
   <fieldset class="attribute--nested">
     <legend>
-      <%= link_to(
+      <%= link_to_if(
+        accessible_action?(field.data, :show),
         field.display_associated_resource,
         [namespace, field.data],
       ) %>
     </legend>
-    <% field.nested_show.attributes.each do |attribute| -%>
-      <div>
-      <dt class="attribute-label">
-        <%= t(
-          "helpers.label.#{resource_name}.#{attribute.name}",
-          default: attribute.name.titleize,
-        ) %>
-      </dt>
-      <dd class="attribute-data attribute-data--<%= attribute.html_class %>">
-        <%= render_field attribute, { page: page } %>
-      </dd>
-      </div>
+    <% field.nested_show.attributes.each do |title, attributes| -%>
+      <fieldset class="<%= "field-unit--nested" if title.present? %>">
+        <% if title.present? %>
+          <legend><%= t "helpers.label.#{namespace}.#{title}", default: title %></legend>
+        <% end %>
+
+        <% attributes.each do |attribute| %>
+          <dt class="attribute-label">
+            <%= t(
+              "helpers.label.#{field.associated_class_name.underscore}.#{attribute.name}",
+              default: attribute.name.titleize,
+            ) %>
+          </dt>
+          <dd class="attribute-data attribute-data--<%= attribute.html_class %>">
+            <%= render_field attribute, { page: page } %>
+          </dd>
+        <% end %>
+      </fieldset>
     <% end -%>
   </fieldset>
 <% end %>

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

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

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.data.class) %>
+  <% if accessible_action?(field.data, :show) %>
     <%= link_to(
       field.display_associated_resource,
       [namespace, field.data],

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

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

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

@@ -2,7 +2,6 @@
 # Time Form Partial
 
 This partial renders an input element for time attributes.
-By default, the input is a text field that is augmented with [DateTimePicker].
 
 ## Local variables:
 
@@ -12,12 +11,12 @@ By default, the input is a text field that is augmented with [DateTimePicker].
   An instance of [Administrate::Field::Time][1].
   A wrapper around the tmie attributes pulled from the model.
 
-[DateTimePicker]: https://github.com/Eonasdan/bootstrap-datetimepicker
+[1]: http://www.rubydoc.info/gems/administrate/Administrate/Field/Time
 %>
 
 <div class="field-unit__label">
   <%= f.label field.attribute %>
 </div>
 <div class="field-unit__field">
-  <%= f.text_field field.attribute, data: { type: 'time' }, value: field.data&.strftime("%H:%M:%S") %>
+  <%= f.time_field field.attribute, step: 1 %>
 </div>

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

@@ -15,6 +15,6 @@ By default, the value is rendered as an `a` element.
 [1]: http://www.rubydoc.info/gems/administrate/Administrate/Field/Url
 %>
 
-<%= content_tag :a, href: field.data do %>
+<%= content_tag :a, href: field.data, **field.html_options do %>
   <%= field.data %>
 <% end %>

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

@@ -15,6 +15,6 @@ By default, the value is rendered as an `a` element.
 [1]: http://www.rubydoc.info/gems/administrate/Administrate/Field/Url
 %>
 
-<%= content_tag :a, href: field.data do %>
+<%= content_tag :a, href: field.data, **field.html_options do %>
   <%= field.data %>
 <% end %>

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

@@ -31,7 +31,7 @@ By default, it renders:
   <div class="app-container">
     <%= render "navigation" -%>
 
-    <main class="main-content" role="main">
+    <main class="main-content">
       <%= render "flashes" -%>
       <%= yield %>
     </main>

data/config/locales/administrate.de.yml

@@ -21,8 +21,8 @@ de:
         more: "%{count} von %{total_count}"
         none: Keine
     form:
-      error: error
-      errors: "%{pluralized_errors} haben das Speichern dieses %{resource_name} verhindert:"
+      error: Fehler
+      errors: "%{resource_name} konnte nicht gespeichert werden, es gab %{pluralized_errors}."
     navigation:
       back_to_app: Zurück zur App
     search:

data/config/locales/administrate.ja.yml

@@ -5,9 +5,9 @@ ja:
       confirm: 本当によろしいですか？
       destroy: 削除
       edit: 編集
-      edit_resource: 編集 %{name}
-      show_resource: 参照 %{name}
-      new_resource: 新規 %{name}
+      edit_resource: "%{name}を編集"
+      show_resource: "%{name}を参照"
+      new_resource: "%{name}を作成"
       back: 戻る
     controller:
       create:
@@ -22,9 +22,9 @@ ja:
         none: データがありません
     form:
       error: エラー
-      errors: "%{pluralized_errors}のため%{resource_name}を保存できません。"
+      errors: "%{pluralized_errors}のため%{resource_name}を保存できませんでした。"
     navigation:
       back_to_app: アプリに戻る
     search:
       clear: 検索をクリアする
-      label: サーチ %{resource}
+      label: "%{resource}を検索"

data/config/locales/administrate.sl.yml

@@ -0,0 +1,30 @@
+---
+sl:
+  administrate:
+    actions:
+      confirm: Ali ste preričani?
+      destroy: Izbriši
+      edit: Uredi
+      edit_resource: Uredi %{name}
+      show_resource: Prikaži %{name}
+      new_resource: Dodaj %{name}
+      back: Nazaj
+    controller:
+      create:
+        success: "%{resource} je dodan."
+      destroy:
+        success: "%{resource} je izbrisan."
+      update:
+        success: "%{resource} je posodobljen."
+    fields:
+      has_many:
+        more: Prikazanih %{count} od %{total_count}
+        none: Nobene
+    form:
+      error: napaka
+      errors: "%{resource_name} ni mogoče shraniti zaradi:"
+    navigation:
+      back_to_app: Nazaj v aplikacijo
+    search:
+      clear: Počisti iskanje
+      label: Išči %{resource}

data/docs/adding_controllers_without_related_model.md

@@ -14,9 +14,9 @@ routes are displayed in the sidebar and then add a custom dashboard:
 <div style="padding: 20px">
   <h1>Stats</h1>
   <br>
-  <p><b>Total Customers:</b> <%= @stats[:customer_count] %></h1>
+  <p><b>Total Customers:</b> <%= @stats[:customer_count] %></p>
   <br>
-  <p><b>Total Orders:</b> <%= @stats[:order_count] %></h1>
+  <p><b>Total Orders:</b> <%= @stats[:order_count] %></p>
 </div>
 ```
 

data/docs/authorization.md

@@ -28,20 +28,30 @@ technically have access to see in the main app. For example, a user may
 have all public records in their scope, but you want to only show *their*
 records in the admin interface to reduce confusion.
 
-In this case, you can add an additional `resolve_admin` to your policy's
-scope and Administrate will use this instead of the `resolve` method.
+In this case, you can add additional pundit `policy_namespace` in your controller
+and Administrate will use the namespaced pundit policy instead.
 
 For example:
 
 ```ruby
-class PostPolicy < ApplicationPolicy
-  class Scope < Scope
-    def resolve
-      scope.all
+# app/controllers/admin/posts_controller.rb
+module Admin
+  class PostsController < ApplicationController
+    include Administrate::Punditize
+
+    def policy_namespace
+      [:admin]
     end
+  end
+end
 
-    def resolve_admin
-      scope.where(owner: user)
+# app/policies/admin/post_policy.rb
+module Admin
+  class PostPolicy < ApplicationPolicy
+    class Scope < Scope
+      def resolve
+        scope.where(owner: user)
+      end
     end
   end
 end
@@ -49,23 +59,36 @@ end
 
 ## Authorization without Pundit
 
-If you use a different authorization library, or you want to roll your own,
-you just need to override a few methods in your controllers or
-`Admin::ApplicationController`. For example:
+Pundit is not necessary to implement authorization within Administrate. It is
+simply a common solution that many in the community use, and for this reason
+Administrate provides a plugin to work with it. However you can use a different
+solution or roll out your own.
+
+To integrate a different authorization solution, you will need to
+implement some methods in `Admin::ApplicationController`
+or its subclasses.
+
+These are the methods to override, with examples:
 
 ```ruby
-# Limit the scope of the given resource
+# Used in listings, such as the `index` actions. It
+# restricts the scope of records that a user can access.
+# Returns an ActiveRecord scope.
 def scoped_resource
   super.where(user: current_user)
 end
 
-# Raise an exception if the user is not permitted to access this resource
-def authorize_resource(resource)
-  raise "Erg!" unless show_action?(params[:action], resource)
-end
-
-# Hide links to actions if the user is not allowed to do them
-def show_action?(action, resource)
-  current_user.can? action, resource
+# Return true if the current user can access the given
+# resource, false otherwise.
+def authorized_action?(resource, action)
+  current_user.can?(resource, action)
 end
 ```
+
+Additionally, the method `authorize_resource(resource)`
+should throw an exception if the current user is not
+allowed to access the given resource. Normally
+you wouldn't need to override it, as the default
+implementation uses `authorized_action?` to produce the
+correct behaviour. However you may still want to override it
+if you want to raise a custom error type.

data/docs/customizing_controller_actions.md

@@ -46,17 +46,22 @@ end
 
 ## Customizing Actions
 
-To enable or disable certain actions you could override `valid_action?` method in your dashboard controller like this:
+To disable certain actions globally, you can disable their
+routes in `config/routes.rb`, using the usual Rails
+facilities for this. For example:
 
 ```ruby
-# disable 'edit' and 'destroy' links
-def valid_action?(name, resource = resource_class)
-  %w[edit destroy].exclude?(name.to_s) && super
+Rails.application.routes.draw do
+  # ...
+  namespace :admin do
+    # ...
+
+    # Payments can only be listed or displayed
+    resources :payments, only: [:index, :show]
+  end
 end
 ```
 
-Action is one of `new`, `edit`, `show`, `destroy`.
-
 ## Customizing Default Sorting
 
 To set the default sorting on the index action you could override `default_sorting_attribute` or `default_sorting_direction` in your dashboard controller like this:
@@ -88,3 +93,17 @@ To set custom redirects after the actions `create`, `update` and `destroy` you c
       [namespace, requested_resource.some_other_resource]
     end
 ```
+
+## Creating Records
+
+You can perform actions after creation by passing a `block` to `super` in the
+`create` method. The block will only be called if the resource is successfully
+created.
+
+```ruby
+def create
+  super do |resource|
+    # do something with the newly created resource
+  end
+end
+```

data/docs/customizing_dashboards.md

@@ -77,8 +77,9 @@ which are specified through the `.with_options` class method:
 
 **Field::BelongsTo**
 
-`:order` - Specifies the order of the dropdown menu, can be ordered by more
-than one column. e.g.: `"name, email DESC"`.
+`:order` - Specifies the column used to order the records. It will apply both in
+the table views and in the dropdown menu on the record forms.
+You can set multiple columns as well with direction. E.g.: `"name, email DESC"`.
 
 `:scope` - Specifies a custom scope inside a callable. Useful for preloading.
 Example: `.with_options(scope: -> { MyModel.includes(:rel).limit(5) })`
@@ -112,8 +113,11 @@ association `belongs_to :country`, from your model.
 
 **Field::HasMany**
 
-`:limit` - Set the number of resources to display in the show view. Default is
-`5`.
+`:collection_attributes` - Set the columns to display in the show view. 
+Default is COLLECTION_ATTRIBUTES in dashboard.
+
+`:limit` - The number of resources (paginated) to display in the show view. To disable pagination,
+set this to `0` or `false`. Default is `5`.
 
 `:sort_by` - What to sort the association by in the show view.
 
@@ -127,6 +131,10 @@ association `belongs_to :country`, from your model.
 
 **Field::HasOne**
 
+`:order` - Specifies the column used to order the records. It will apply both in
+the table views and in the dropdown menu on the record forms.
+You can set multiple columns as well with direction. E.g.: `"name, email DESC"`.
+
 `:searchable` - Specify if the attribute should be considered when searching.
 Default is `false`.
 
@@ -163,8 +171,7 @@ more results than expected. Default is `false`.
 and works by  by passing a hash that includes the formatter (`formatter`) and
 the options for the formatter (`formatter_options`). Defaults to the locale's
 delimiter when `formatter_options` does not include a `delimiter`. See the
-example below. Note that currently only
-`ActiveSupport::NumberHelper.number_to_delimited` is supported.
+example below. All helpers from `ActiveSupport::NumberHelper` are supported.
 
 For example, you might use the following to display U.S. currency:
 
@@ -217,14 +224,31 @@ objects to display as.
 
 **Field::Select**
 
-`:collection` - Specify the options shown on the select field. It accept either
-an array or an object responding to `:call`. Defaults to `[]`.
+`:collection` - The options available to select. The format is the same as for Rails's own [`options_for_select`](https://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-options_for_select).
+
+If the given value responds to `call`, this will be called and the result used instead. The call will receive an instance of the field as argument. For example:
+
+```ruby
+  confirmation: Field::Select.with_options(
+    collection: ->(field) {
+      person = field.resource
+      {
+        "no, #{person.name}" => "opt0",
+        "yes, #{person.name}" => "opt1",
+        "absolutely, #{person.name}" => "opt2",
+      }
+    },
+  )
+```
+
+Administrate will detect if the attribute is an `ActiveRecord::Enum` and extract the available options. Note that if a `collection` is provided it will take precedence.
+
+If no collection is provided and no enum can be detected, the list of options will be empty.
 
 `:searchable` - Specify if the attribute should be considered when searching.
 Default is `true`.
 
-`:include_blank` - Specifies if the select element to be rendered should include
-blank option. Default is `false`.
+`: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**
 
@@ -250,6 +274,9 @@ Default is `true`.
 `:truncate` - Set the number of characters to display in the index view.
 Defaults to `50`.
 
+`:html_options` - Specify anchor tag attributes (e.g., `target="_blank"`).
+Defaults is `{}`.
+
 **Field::Password**
 
 `:searchable` - Specify if the attribute should be considered when searching.
@@ -358,3 +385,54 @@ FORM_ATTRIBUTES_EDIT = [
 ```
 
 Or for custom action with constant name `"FORM_ATTRIBUTES_#{action.upcase}"`
+
+### Form Fields' Hints
+
+You can show a brief text element below an input field by setting the
+corresponding translation key using the path:
+
+`administrate.field_hints.#{model_name}.#{field_name}`
+
+For example, with a Customer dashboard with an email field you can add a
+string value that will be used as text hint:
+
+```yml
+en:
+  administrate:
+    field_hints:
+      customer:
+        email: field_hint
+```
+
+## Grouped Attributes
+
+You may have models with a large number of fields and therefore you might want to group them in a meaningul way:
+
+```ruby
+class UserDashboard < Administrate::BaseDashboard
+  SHOW_PAGE_ATTRIBUTES = {
+    "" => [:username],
+    "Personal Information" => [:first_name, :last_name, :email],
+    "Address" => [:address_line_one, :address_line_two, :address_city, :address_state, :address_country]
+  }
+
+  FORM_ATTRIBUTES = {
+    "" => [:username, :password, :password_confirmation],
+    "personal_information" => [:first_name, :last_name, :email],
+    "address" => [:address_line_one, :address_line_two, :address_city, :address_state, :address_country]
+  }
+end
+```
+
+You can optionally translate your group labels:
+
+```yaml
+en:
+  helpers:
+    label:
+      user:
+        address: Address
+        personal_information: Personal Information
+```
+
+If not defined (see `SHOW_PAGE_ATTRIBUTES` above), Administrate will default to the given strings.

data/docs/getting_started.md

@@ -3,7 +3,7 @@ title: Getting Started
 ---
 
 Administrate is released as a Ruby gem, and can be installed on Rails
-applications version 5.0 or greater. We support Ruby 2.6 and up.
+applications version 6.0 or greater. We support Ruby 3.0 and up.
 
 First, add the following to your Gemfile: