administrate 0.19.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a94bb51af4fa730f84d042f402122cc3073894e67494309dab4621b5f39b36fa
-  data.tar.gz: 57e7d78f316c635be65735e5c4220bd4e8d777c29c1d92741ab2520998080cde
+  metadata.gz: eebcadb06ece9944279b1119e950922a388078a5c9ab5b95d6d8863c1e03994d
+  data.tar.gz: 96a697e2e10228a5f2772b1602985107f7ed428ca63d77c7d6e964a614659b9d
 SHA512:
-  metadata.gz: 4d7b0a4b21404d16b48a5545e57202b73b3d782e23a5b26b5ed9e52ab3a66069717e23b1e099727eba9ff99315ba757d8ad0b739895a56775fbb5f3f8279df29
-  data.tar.gz: 07cc800c0c7cca79231ac047d10120ef63ec1c7d95aa5dccac9c7b1b5a99cafaccc2c31165c7350920721e622063190b0f804fb05d1e436c518511639802d4bd
+  metadata.gz: da130cb7cdcfd15321a653a59cfb499411f85324c19216097a6f4a76407268cc6691647e2ccdf86c367bd6c2e1491342324de89e22c9152eddbea8e6ba32b819
+  data.tar.gz: 8813f237457fa4e37abf8d5c350e4fb4f8f536583a6919764bc5c2abb0bc3b3fc436431b41e731722045179c45dcfef0d4c45d8c5534e7d26ee52d151252665f

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

@@ -2,6 +2,7 @@
   @include administrate-clearfix;
   align-items: center;
   display: flex;
+  flex-wrap: wrap;
   margin-bottom: $base-spacing;
   position: relative;
   width: 100%;
@@ -25,6 +26,12 @@
   }
 }
 
+.field-unit__hint {
+  font-size: 90%;
+  margin-left: calc(15% + 2rem);
+  width: 100%;
+}
+
 .field-unit--nested {
   border: $base-border;
   margin-left: 7.5%;

data/app/controllers/administrate/application_controller.rb

@@ -44,6 +44,7 @@ module Administrate
       authorize_resource(resource)
 
       if resource.save
+        yield(resource) if block_given?
         redirect_to(
           after_resource_created_path(resource),
           notice: translate_with_resource("create.success"),

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

@@ -9,31 +9,27 @@ module Administrate
         include Pundit
       end
 
-      included do
-        private
-
-        def policy_namespace
-          []
-        end
+      private
 
-        def scoped_resource
-          namespaced_scope = policy_namespace + [super]
-          policy_scope!(pundit_user, namespaced_scope)
-        end
+      def policy_namespace
+        []
+      end
 
-        def authorize_resource(resource)
-          namespaced_resource = policy_namespace + [resource]
-          authorize namespaced_resource
-        end
+      def scoped_resource
+        namespaced_scope = policy_namespace + [super]
+        policy_scope!(pundit_user, namespaced_scope)
+      end
 
-        def authorized_action?(resource, action)
-          namespaced_resource = policy_namespace + [resource]
-          policy = Pundit.policy!(pundit_user, namespaced_resource)
-          policy.send("#{action}?".to_sym)
-        end
+      def authorize_resource(resource)
+        namespaced_resource = policy_namespace + [resource]
+        authorize namespaced_resource
       end
 
-      private
+      def authorized_action?(resource, action)
+        namespaced_resource = policy_namespace + [resource]
+        policy = Pundit.policy!(pundit_user, namespaced_resource)
+        policy.send("#{action}?".to_sym)
+      end
 
       def policy_scope!(user, scope)
         policy_scope_class = Pundit::PolicyFinder.new(scope).scope!
@@ -46,7 +42,7 @@ module Administrate
         end
 
         if policy_scope.respond_to? :resolve_admin
-          ActiveSupport::Deprecation.warn(
+          Administrate.deprecator.warn(
             "Pundit policy scope `resolve_admin` method is deprecated. " +
             "Please use a namespaced pundit policy instead.",
           )

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

@@ -33,10 +33,25 @@ and renders all form fields for a resource's editable attributes.
     </div>
   <% end %>
 
-  <% page.attributes(controller.action_name).each do |attribute| -%>
-    <div class="field-unit field-unit--<%= attribute.html_class %> field-unit--<%= requireness(attribute) %>">
-      <%= render_field attribute, f: f %>
-    </div>
+  <% page.attributes(controller.action_name).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 %> field-unit--<%= requireness(attribute) %>">
+          <%= render_field attribute, f: f %>
+
+          <% hint_key = "administrate.field_hints.#{page.resource_name}.#{attribute.name}" %>
+          <% if I18n.exists?(hint_key) -%>
+            <div class="field-unit__hint">
+              <%= I18n.t(hint_key) %>
+            </div>
+          <% end -%>
+        </div>
+      <% end %>
+    </fieldset>
   <% end -%>
 
   <div class="form-actions">

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

@@ -42,16 +42,24 @@ as well as a link to its edit page.
 
 <section class="main-content__body">
   <dl>
-    <% page.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>
+    <% 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>
+
+          <dd class="attribute-data attribute-data--<%=attribute.html_class%>"
+              ><%= render_field attribute, page: page %></dd>
+        <% end %>
+      </fieldset>
     <% end %>
   </dl>
 </section>

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

@@ -19,10 +19,20 @@ 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.name}", default: field.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>
+    <% 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/_show.html.erb

@@ -24,18 +24,24 @@ All show page attributes of has_one relationship would be rendered
         [namespace, field.data],
       ) %>
     </legend>
-    <% field.nested_show.attributes.each do |attribute| -%>
-      <div>
-      <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>
-      </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/docs/customizing_controller_actions.md

@@ -93,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

@@ -113,6 +113,9 @@ association `belongs_to :country`, from your model.
 
 **Field::HasMany**
 
+`: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`.
 
@@ -168,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:
 
@@ -383,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 6.0 or greater. We support Ruby 2.7 and up.
+applications version 6.0 or greater. We support Ruby 3.0 and up.
 
 First, add the following to your Gemfile:
 

data/lib/administrate/base_dashboard.rb

@@ -69,7 +69,13 @@ module Administrate
     end
 
     def permitted_attributes(action = nil)
-      form_attributes(action).map do |attr|
+      attributes = form_attributes action
+
+      if attributes.is_a? Hash
+        attributes = attributes.values.flatten
+      end
+
+      attributes.map do |attr|
         attribute_types[attr].permitted_attribute(
           attr,
           resource_class: self.class.model,
@@ -83,7 +89,11 @@ module Administrate
     end
 
     def collection_attributes
-      self.class::COLLECTION_ATTRIBUTES
+      if self.class::COLLECTION_ATTRIBUTES.is_a?(Hash)
+        self.class::COLLECTION_ATTRIBUTES.values.flatten
+      else
+        self.class::COLLECTION_ATTRIBUTES
+      end
     end
 
     def search_attributes
@@ -107,7 +117,12 @@ module Administrate
     end
 
     def item_associations
-      attribute_associated(show_page_attributes)
+      attributes = if show_page_attributes.is_a?(Hash)
+                     show_page_attributes.values.flatten
+                   else
+                     show_page_attributes
+                   end
+      attribute_associated attributes
     end
 
     private

data/lib/administrate/field/deferred.rb

@@ -34,7 +34,7 @@ module Administrate
       end
 
       def searchable_field
-        ActiveSupport::Deprecation.warn(
+        Administrate.deprecator.warn(
           "searchable_field is deprecated, use searchable_fields instead",
         )
         options.fetch(:searchable_field)

data/lib/administrate/field/has_many.rb

@@ -22,7 +22,11 @@ module Administrate
       end
 
       def associated_collection(order = self.order)
-        Administrate::Page::Collection.new(associated_dashboard, order: order)
+        Administrate::Page::Collection.new(
+          associated_dashboard,
+          order: order,
+          collection_attributes: options[:collection_attributes],
+        )
       end
 
       def attribute_key

data/lib/administrate/field/number.rb

@@ -38,14 +38,8 @@ module Administrate
         formatter = options[:format][:formatter]
         formatter_options = options[:format][:formatter_options].to_h
 
-        case formatter
-        when :number_to_delimited
-          ActiveSupport::NumberHelper.number_to_delimited(
-            result, **formatter_options
-          )
-        else
-          result
-        end
+        ActiveSupport::NumberHelper.
+          try(formatter, result, **formatter_options) || result
       end
     end
   end

data/lib/administrate/order.rb

@@ -10,9 +10,9 @@ module Administrate
       return order_by_association(relation) unless
         reflect_association(relation).nil?
 
-      order = "#{relation.table_name}.#{attribute} #{direction}"
+      order = relation.arel_table[attribute].public_send(direction)
 
-      return relation.reorder(Arel.sql(order)) if
+      return relation.reorder(order) if
         column_exist?(relation, attribute)
 
       relation
@@ -66,11 +66,11 @@ module Administrate
 
     def order_by_count(relation)
       klass = reflect_association(relation).klass
-      query = "COUNT(#{klass.table_name}.#{klass.primary_key}) #{direction}"
+      query = klass.arel_table[klass.primary_key].count.public_send(direction)
       relation.
         left_joins(attribute.to_sym).
         group(:id).
-        reorder(Arel.sql(query))
+        reorder(query)
     end
 
     def order_by_belongs_to(relation)
@@ -92,15 +92,15 @@ module Administrate
     def order_by_attribute(relation)
       relation.joins(
         attribute.to_sym,
-      ).reorder(Arel.sql(order_by_attribute_query))
+      ).reorder(order_by_attribute_query)
     end
 
     def order_by_id(relation)
-      relation.reorder(Arel.sql(order_by_id_query(relation)))
+      relation.reorder(order_by_id_query(relation))
     end
 
     def order_by_association_id(relation)
-      relation.reorder(Arel.sql(order_by_association_id_query))
+      relation.reorder(order_by_association_id_query)
     end
 
     def ordering_by_association_column?(relation)
@@ -115,15 +115,16 @@ module Administrate
     end
 
     def order_by_id_query(relation)
-      "#{relation.table_name}.#{foreign_key(relation)} #{direction}"
+      relation.arel_table[foreign_key(relation)].public_send(direction)
     end
 
     def order_by_association_id_query
-      "#{association_table_name}.id #{direction}"
+      Arel::Table.new(association_table_name)[:id].public_send(direction)
     end
 
     def order_by_attribute_query
-      "#{association_table_name}.#{association_attribute} #{direction}"
+      table = Arel::Table.new(association_table_name)
+      table[association_attribute].public_send(direction)
     end
 
     def relation_type(relation)

data/lib/administrate/page/collection.rb

@@ -4,6 +4,7 @@ module Administrate
   module Page
     class Collection < Page::Base
       def attribute_names
+        options.fetch(:collection_attributes, nil) ||
         dashboard.collection_attributes
       end
 

data/lib/administrate/page/form.rb

@@ -11,8 +11,16 @@ module Administrate
       attr_reader :resource
 
       def attributes(action = nil)
-        dashboard.form_attributes(action).map do |attribute|
-          attribute_field(dashboard, resource, attribute, :form)
+        attributes = dashboard.form_attributes(action)
+
+        if attributes.is_a? Array
+          attributes = { "" => attributes }
+        end
+
+        attributes.transform_values do |attrs|
+          attrs.map do |attribute|
+            attribute_field(dashboard, resource, attribute, :form)
+          end
         end
       end
 

data/lib/administrate/page/show.rb

@@ -15,8 +15,16 @@ module Administrate
       end
 
       def attributes
-        dashboard.show_page_attributes.map do |attr_name|
-          attribute_field(dashboard, resource, attr_name, :show)
+        attributes = dashboard.show_page_attributes
+
+        if attributes.is_a? Array
+          attributes = { "" => attributes }
+        end
+
+        attributes.transform_values do |attrs|
+          attrs.map do |attr_name|
+            attribute_field(dashboard, resource, attr_name, :show)
+          end
         end
       end
     end

data/lib/administrate/version.rb

@@ -1,3 +1,3 @@
 module Administrate
-  VERSION = "0.19.0".freeze
+  VERSION = "0.20.0".freeze
 end

data/lib/administrate.rb

@@ -2,7 +2,7 @@ require "administrate/engine"
 
 module Administrate
   def self.warn_of_missing_resource_class
-    ActiveSupport::Deprecation.warn(
+    deprecator.warn(
       "Calling Field::Base.permitted_attribute without the option " +
       ":resource_class is deprecated. If you are seeing this " +
       "message, you are probably using a custom field type that" +
@@ -12,7 +12,7 @@ module Administrate
   end
 
   def self.warn_of_deprecated_option(name)
-    ActiveSupport::Deprecation.warn(
+    deprecator.warn(
       "The option :#{name} is deprecated. " +
       "Administrate should detect it automatically. " +
       "Please file an issue at " +
@@ -22,7 +22,7 @@ module Administrate
   end
 
   def self.warn_of_deprecated_method(klass, method)
-    ActiveSupport::Deprecation.warn(
+    deprecator.warn(
       "The method #{klass}##{method} is deprecated. " +
       "If you are seeing this message you are probably " +
       "using a dashboard that depends explicitly on it. " +
@@ -32,10 +32,14 @@ module Administrate
   end
 
   def self.warn_of_deprecated_authorization_method(method)
-    ActiveSupport::Deprecation.warn(
+    deprecator.warn(
       "The method `#{method}` is deprecated. " +
       "Please use `accessible_action?` instead, " +
       "or see the documentation for other options.",
     )
   end
+
+  def self.deprecator
+    @deprecator ||= ActiveSupport::Deprecation.new(VERSION, "Administrate")
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: administrate
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.20.0
 platform: ruby
 authors:
 - Nick Charlton
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-18 00:00:00.000000000 Z
+date: 2024-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -17,70 +17,88 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: actionview
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: jquery-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 4.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 4.6.0
 - !ruby/object:Gem::Dependency
   name: kaminari
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.2.2
 - !ruby/object:Gem::Dependency
   name: sassc-rails
   requirement: !ruby/object:Gem::Requirement
@@ -345,7 +363,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.14
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: A Rails engine for creating super-flexible admin dashboards