administrate 0.20.1 → 1.0.0.beta2

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

@@ -1,6 +1,6 @@
 module Administrate
   module Punditize
-    if Object.const_defined?("Pundit")
+    if Object.const_defined?(:Pundit)
       extend ActiveSupport::Concern
 
       if Pundit.const_defined?(:Authorization)
@@ -28,7 +28,7 @@ module Administrate
       def authorized_action?(resource, action)
         namespaced_resource = policy_namespace + [resource]
         policy = Pundit.policy!(pundit_user, namespaced_resource)
-        policy.send("#{action}?".to_sym)
+        policy.send(:"#{action}?")
       end
 
       def policy_scope!(user, scope)
@@ -38,13 +38,13 @@ module Administrate
           policy_scope = policy_scope_class.new(user, pundit_model(scope))
         rescue ArgumentError
           raise(Pundit::InvalidConstructorError,
-                "Invalid #<#{policy_scope_class}> constructor is called")
+            "Invalid #<#{policy_scope_class}> constructor is called")
         end
 
         if policy_scope.respond_to? :resolve_admin
           Administrate.deprecator.warn(
-            "Pundit policy scope `resolve_admin` method is deprecated. " +
-            "Please use a namespaced pundit policy instead.",
+            "Pundit policy scope `resolve_admin` method is deprecated. " \
+            "Please use a namespaced pundit policy instead."
           )
           policy_scope.resolve_admin
         else

data/app/helpers/administrate/application_helper.rb

@@ -50,7 +50,7 @@ module Administrate
     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),
+        default: default_resource_name(resource_name, opts)
       )
     end
 
@@ -65,14 +65,14 @@ module Administrate
     def resource_index_route(resource_name)
       url_for(
         action: "index",
-        controller: "/#{namespace}/#{resource_name}",
+        controller: "/#{namespace}/#{resource_name}"
       )
     end
 
     def sanitized_order_params(page, current_field_name)
       collection_names = page.item_associations + [current_field_name]
       association_params = collection_names.map do |assoc_name|
-        { assoc_name => %i[order direction page per_page] }
+        {assoc_name => %i[order direction page per_page]}
       end
       params.permit(:search, :id, :_page, :per_page, association_params)
     end
@@ -87,7 +87,7 @@ module Administrate
 
     def default_resource_name(name, opts = {})
       resource_name = (opts[:singular] ? name.to_s : name.to_s.pluralize)
-      resource_name.gsub("/", "_").titleize
+      resource_name.tr("/", "_").titleize
     end
   end
 end

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

@@ -18,7 +18,7 @@ to display a collection of resources in an HTML table.
 [1]: http://www.rubydoc.info/gems/administrate/Administrate/Page/Collection
 %>
 
-<table aria-labelledby="<%= table_title %>">
+<table aria-labelledby="<%= table_title %>" data-controller="table" data-action="click->table#visitDataUrl keydown->table#visitDataUrl">
   <thead>
     <tr>
       <% collection_presenter.attribute_types.each do |attr_name, attr_type| %>

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

@@ -7,11 +7,11 @@
 <% end %>
 
 <% if existing_action?(collection_presenter.resource_name, :destroy) %>
-  <td><%= link_to(
+  <td><%= button_to(
     t("administrate.actions.destroy"),
     [namespace, resource],
-    class: "text-color-red",
+    class: "link link--danger",
     method: :delete,
-    data: { confirm: t("administrate.actions.confirm") }
+    data: { turbo_confirm: t("administrate.actions.confirm") }
   ) if accessible_action?(resource, :destroy) %></td>
 <% end %>

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

@@ -7,6 +7,8 @@
     <%= content_for(:title) %>
   </h1>
 
+  <%= content_for(:header_middle) %>
+
   <% if show_search_bar %>
     <%= render(
       "search",
@@ -25,4 +27,6 @@
       class: "button",
     ) if accessible_action?(new_resource, :new) %>
   </div>
+
+  <%= content_for(:header_last) %>
 </header>

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

@@ -8,7 +8,7 @@ by providing a `content_for(:javascript)` block.
 %>
 
 <% Administrate::Engine.javascripts.each do |js_path| %>
-  <%= javascript_include_tag js_path %>
+  <%= javascript_include_tag js_path, "data-turbo-track": "reload", defer: true %>
 <% end %>
 
 <%= yield :javascript %>

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

@@ -22,6 +22,8 @@ It displays a header, and renders the `_form` partial to do the heavy lifting.
     <%= content_for(:title) %>
   </h1>
 
+  <%= content_for(:header_middle) %>
+
   <div>
     <%= link_to(
       t("administrate.actions.show_resource", name: page.page_title),
@@ -29,8 +31,18 @@ It displays a header, and renders the `_form` partial to do the heavy lifting.
       class: "button",
     ) if accessible_action?(page.resource, :show) %>
   </div>
+
+  <%= content_for(:header_last) %>
 </header>
 
-<section class="main-content__body">
-  <%= render "form", page: page %>
-</section>
+<%= content_for(:before_main) %>
+
+<% if content_for?(:main) %>
+  <%= content_for(:main) %>
+<% else %>
+  <section class="main-content__body">
+    <%= render "form", page: page %>
+  </section>
+<% end %>
+
+<%= content_for(:after_main) %>

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

@@ -32,15 +32,23 @@ It renders the `_table` partial to display details about the resources.
   )
 %>
 
-<section class="main-content__body main-content__body--flush">
-  <%= render(
-    "collection",
-    collection_presenter: page,
-    collection_field_name: resource_name,
-    page: page,
-    resources: resources,
-    table_title: "page-title"
-  ) %>
+<%= content_for(:before_main) %>
+
+<% if content_for?(:main) %>
+  <%= content_for(:main) %>
+<% else %>
+  <section class="main-content__body main-content__body--flush">
+    <%= render(
+      "collection",
+      collection_presenter: page,
+      collection_field_name: resource_name,
+      page: page,
+      resources: resources,
+      table_title: "page-title"
+    ) %>
+
+    <%= render("pagination", resources: resources) %>
+  </section>
+<% end %>
 
-  <%= render("pagination", resources: resources) %>
-</section>
+<%= content_for(:after_main) %>

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

@@ -27,11 +27,23 @@ to do the heavy lifting.
     <%= content_for(:title) %>
   </h1>
 
+  <%= content_for(:header_middle) %>
+
   <div>
     <%= link_to t("administrate.actions.back"), :back, class: "button" %>
   </div>
+
+  <%= content_for(:header_last) %>
 </header>
 
-<section class="main-content__body">
-  <%= render "form", page: page %>
-</section>
+<%= content_for(:before_main) %>
+
+<% if content_for?(:main) %>
+  <%= content_for(:main) %>
+<% else %>
+  <section class="main-content__body">
+    <%= render "form", page: page %>
+  </section>
+<% end %>
+
+<%= content_for(:after_main) %>

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

@@ -23,6 +23,8 @@ as well as a link to its edit page.
     <%= content_for(:title) %>
   </h1>
 
+  <%= content_for(:header_middle) %>
+
   <div>
     <%= link_to(
       t("administrate.actions.edit_resource", name: page.page_title),
@@ -30,36 +32,46 @@ as well as a link to its edit page.
       class: "button",
     ) if accessible_action?(page.resource, :edit) %>
 
-    <%= link_to(
+    <%= button_to(
       t("administrate.actions.destroy"),
       [namespace, page.resource],
       class: "button button--danger",
       method: :delete,
-      data: { confirm: t("administrate.actions.confirm") }
+      data: { turbo_confirm: t("administrate.actions.confirm") }
     ) if accessible_action?(page.resource, :destroy) %>
   </div>
+
+  <%= content_for(:header_last) %>
 </header>
 
-<section class="main-content__body">
-  <dl>
-    <% page.attributes.each do |title, attributes| %>
-      <fieldset class="<%= "field-unit--nested" if title.present? %>">
-        <% if title.present? %>
-          <legend><%= t "helpers.label.#{page.resource_name}.#{title}", default: title %></legend>
-        <% end %>
+<%= content_for(:before_main) %>
+
+<% if content_for?(:main) %>
+  <%= content_for(:main) %>
+<% else %>
+  <section class="main-content__body">
+    <dl>
+      <% page.attributes.each do |title, attributes| %>
+        <fieldset class="<%= "field-unit--nested" if title.present? %>">
+          <% if title.present? %>
+            <legend><%= t "helpers.label.#{page.resource_name}.#{title}", default: title %></legend>
+          <% end %>
+
+          <% attributes.each do |attribute| %>
+            <dt class="attribute-label" id="<%= attribute.name %>">
+            <%= t(
+              "helpers.label.#{resource_name}.#{attribute.name}",
+              default: page.resource.class.human_attribute_name(attribute.name),
+            ) %>
+            </dt>
 
-        <% attributes.each do |attribute| %>
-          <dt class="attribute-label" id="<%= attribute.name %>">
-          <%= t(
-            "helpers.label.#{resource_name}.#{attribute.name}",
-            default: page.resource.class.human_attribute_name(attribute.name),
-          ) %>
-          </dt>
+            <dd class="attribute-data attribute-data--<%=attribute.html_class%>"
+                ><%= render_field attribute, page: page %></dd>
+          <% end %>
+        </fieldset>
+      <% end %>
+    </dl>
+  </section>
+<% end %>
 
-          <dd class="attribute-data attribute-data--<%=attribute.html_class%>"
-              ><%= render_field attribute, page: page %></dd>
-        <% end %>
-      </fieldset>
-    <% end %>
-  </dl>
-</section>
+<%= content_for(:after_main) %>

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

@@ -17,10 +17,11 @@ that displays all possible records to associate with.
 %>
 
 <div class="field-unit__label">
-  <%= f.label field.permitted_attribute %>
+  <%= f.label field.attribute, for: "#{f.object_name}_#{field.permitted_attribute}" %>
 </div>
 <div class="field-unit__field">
   <%= f.select(field.permitted_attribute,
                options_for_select(field.associated_resource_options, field.selected_option),
-               include_blank: field.include_blank_option) %>
+               {include_blank: field.include_blank_option},
+               data: {controller: field.html_controller}) %>
 </div>

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

@@ -23,7 +23,7 @@ and is augmented with [Selectize].
   <%= 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 %>
+  <%= f.select(field.attribute_key, nil, {}, multiple: true, data: {controller: field.html_controller}) do %>
     <%= options_for_select(field.associated_resource_options, field.selected_options) %>
   <% end %>
 </div>

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

@@ -22,7 +22,7 @@ This partial renders an input element for polymorphic relationships.
 
   <div class="field-unit__field">
     <%= pf.hidden_field(:type, value: field.class.name) %>
-    <%= pf.select(:value) do %>
+    <%= pf.select(:value, {}, data: {controller: field.html_controller}) do %>
       <%= grouped_options_for_select(field.associated_resource_grouped_options, field.selected_global_id, prompt: true) %>
     <% end %>
   </div>

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

@@ -0,0 +1,6 @@
+<div class="field-unit__label">
+  <%= f.label field.attribute %>
+</div>
+<div class="field-unit__field">
+  <%= f.rich_text_area(field.attribute) %>
+</div>

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

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

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

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

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

@@ -26,7 +26,8 @@ to be displayed on a resource's edit form page.
         field.selectable_options,
         field.data,
       ),
-      include_blank: field.include_blank_option
+      {include_blank: field.include_blank_option},
+      data: {controller: field.html_controller}
     )
   %>
 </div>

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

@@ -18,5 +18,5 @@ This partial renders a textarea element for a text attribute.
   <%= f.label field.attribute %>
 </div>
 <div class="field-unit__field">
-  <%= f.text_area field.attribute %>
+  <%= f.text_area field.attribute, field.options.fetch(:input_options, {}) %>
 </div>

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

@@ -24,6 +24,7 @@ By default, it renders:
   <%= render "stylesheet" %>
   <%= csrf_meta_tags %>
   <%= csp_meta_tag if defined?(csp_meta_tag) %>
+  <%= render "javascript" %>
 </head>
 <body>
   <%= render "icons" %>
@@ -36,7 +37,5 @@ By default, it renders:
       <%= yield %>
     </main>
   </div>
-
-  <%= render "javascript" %>
 </body>
 </html>

data/docs/customizing_dashboards.md

@@ -82,7 +82,8 @@ 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) })`
+Example #1: `.with_options(scope: -> { MyModel.includes(:rel).limit(5) })`
+Example #2: `.with_options(scope: -> (field) { field.resource.my_models.includes(:rel).limit(5) })`
 
 `:include_blank` - Specifies if the select element to be rendered should include
 blank option. Default is `true`.
@@ -113,7 +114,7 @@ association `belongs_to :country`, from your model.
 
 **Field::HasMany**
 
-`:collection_attributes` - Set the columns to display in the show view. 
+`: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,
@@ -144,14 +145,14 @@ Default is `false`.
 For example:
 
 ```ruby
-  cities: Field::HasMany.with_options(
+  city: Field::HasOne.with_options(
     searchable: true,
     searchable_fields: ['name'],
   )
 ```
 
 with this, you will be able to search through the column `name` from the
-association `has_many :cities`, from your model.
+association `has_one :city`, from your model.
 
 `:class_name` (deprecated) - Specifies the name of the associated class.
 
@@ -266,6 +267,9 @@ Default is `false`.
 `:truncate` - Set the number of characters to display in the index view.
 Defaults to `50`.
 
+`:input_options` - Options to customize the text area in form view.
+Example: `.with_options(input_options: { rows: 20 })`
+
 **Field::Url**
 
 `:searchable` - Specify if the attribute should be considered when searching.
@@ -436,3 +440,133 @@ en:
 ```
 
 If not defined (see `SHOW_PAGE_ATTRIBUTES` above), Administrate will default to the given strings.
+
+## Virtual Attributes
+
+For all field types, you can use the `getter` option to change where the data is retrieved from or to set the data directly.
+
+By using this, you can define an attribute in `ATTRIBUTE_TYPES` that doesn’t exist in the model, and use it for various purposes.
+
+### Attribute Aliases
+
+You can create an alias for an attribute. For example:
+
+```ruby
+  ATTRIBUTE_TYPES = {
+    shipped_at: Field::DateTime,
+    shipped_on: Field::Date.with_options(
+      getter: :shipped_at
+    )
+  }
+  COLLECTION_ATTRIBUTES = [
+    :shipped_on
+  }
+  SHOW_PAGE_ATTRIBUTES = [
+    :shipped_at
+  }
+```
+
+In this example, a virtual attribute `shipped_on` based on the value of `shipped_at` is defined as a `Date` type and used for display on the index page (this can help save table cell space).
+
+### Decorated Attributes
+
+You can also use this to decorate data. For example:
+
+```ruby
+  ATTRIBUTE_TYPES = {
+    price: Field::Number,
+    price_including_tax: Field::Number.with_options(
+      getter: -> (field) {
+        field.resource.price * 1.1 if field.resource.price.present?
+      }
+    )
+  }
+```
+
+### Composite Attributes
+
+You can dynamically create a virtual attribute by combining multiple attributes for display. For example:
+
+```ruby
+  ATTRIBUTE_TYPES = {
+    first_name: Field::String,
+    last_name: Field::String,
+    full_name: Field::String.with_options(
+      getter: -> (field) {
+        [
+          field.resource.first_name,
+          field.resource.last_name
+        ].compact_blank.join(' ')
+      }
+    )
+  }
+```
+
+## Virtual Fields
+
+Custom fields can also be defined using virtual fields.
+
+```ruby
+  ATTRIBUTE_TYPES = {
+    id: Field::Number,
+    receipt: Field::ReceiptLink
+  }
+```
+
+```ruby
+module Administrate
+  module Field
+    class ReceiptLink < Base
+      def data
+        resource.id
+      end
+
+      def filename
+        "receipt-#{data}.pdf"
+      end
+
+      def url
+        "/files/receipts/#{filename}"
+      end
+    end
+  end
+end
+```
+
+```erb
+<%= link_to field.filename, field.url %>
+```
+
+### Custom Actions via Virtual Field
+
+By creating custom fields that are not dependent on specific attributes, you can insert custom views into any screen.
+For example, you can add custom buttons like this:
+
+```ruby
+  ATTRIBUTE_TYPES = {
+    id: Field::Number,
+    custom_index_actions: Field::CustomActionButtons,
+    custom_show_actions: Field::CustomActionButtons,
+  }
+```
+
+```ruby
+module Administrate
+  module Field
+    class CustomActionButtons < Base
+      def data
+        resource.id
+      end
+    end
+  end
+end
+```
+
+```erb
+<%# app/views/fields/custom_action_buttons/_index.html.erb %>
+<% if field.data.present? %>
+  <%= button_to "some action 1", [:some_action_1, namespace, field.resource] %>
+  <%= button_to "some action 2", [:some_action_2, namespace, field.resource] %>
+  <%= button_to "some action 3", [:some_action_3, namespace, field.resource] %>
+<% end %>
+```

data/docs/customizing_page_views.md

@@ -94,3 +94,28 @@ rails generate administrate:views:layout
  # It only generates the sidebar partial
  # -> app/views/admin/application/_navigation.html.erb
 ```
+
+## Customizing for a specific layout
+
+You can use several hook points to add elements to specific layouts or specific pages:
+
+* header_middle
+* header_last
+* before_main
+* main
+* after_main
+
+For example, you can add a button in the middle of the header as follows:
+
+```eruby
+<%# app/views/admin/customers/_index_header.html.erb %>
+
+<% content_for(:header_middle) do %>
+  <div>
+    You are logged in as <em><%= pundit_user.name %></em>.
+    <%= link_to("Become the Admin", become_admin_customer_path("admin")) unless pundit_user.admin? %>
+  </div>
+<% end %>
+
+<%= render template: 'administrate/application/_index_header', locals: local_assigns %>
+```

data/lib/administrate/base_dashboard.rb

@@ -7,6 +7,7 @@ require "administrate/field/has_many"
 require "administrate/field/has_one"
 require "administrate/field/number"
 require "administrate/field/polymorphic"
+require "administrate/field/rich_text"
 require "administrate/field/select"
 require "administrate/field/string"
 require "administrate/field/text"
@@ -79,7 +80,7 @@ module Administrate
         attribute_types[attr].permitted_attribute(
           attr,
           resource_class: self.class.model,
-          action: action,
+          action: action
         )
       end.uniq
     end
@@ -118,10 +119,10 @@ module Administrate
 
     def item_associations
       attributes = if show_page_attributes.is_a?(Hash)
-                     show_page_attributes.values.flatten
-                   else
-                     show_page_attributes
-                   end
+        show_page_attributes.values.flatten
+      else
+        show_page_attributes
+      end
       attribute_associated attributes
     end