openaustralia/planningalerts

View on GitHub
app/dashboards/comment_dashboard.rb

Summary

Maintainability
A
0 mins
Test Coverage
C
77%
# typed: strict
# frozen_string_literal: true

require "administrate/base_dashboard"

class CommentDashboard < Administrate::BaseDashboard
  # ATTRIBUTE_TYPES
  # a hash that describes the type of each of the model's fields.
  #
  # Each different type represents an Administrate::Field object,
  # which determines how the attribute is displayed
  # on pages throughout the dashboard.
  ATTRIBUTE_TYPES = T.let({
    id: Field::Number,
    address: Field::String,
    application: Field::BelongsTo,
    published: YesNoBooleanField,
    published_at: Field::DateTime,
    hidden: YesNoBooleanField,
    last_delivered_at: Field::DateTime,
    last_delivered_successfully: YesNoBooleanField,
    name: Field::String,
    reports: Field::HasMany,
    text: Field::Text,
    user: Field::BelongsTo,
    created_at: Field::DateTime,
    updated_at: Field::DateTime
  }.freeze, T::Hash[Symbol, T.untyped])

  # COLLECTION_ATTRIBUTES
  # an array of attributes that will be displayed on the model's index page.
  #
  # By default, it's limited to four items to reduce clutter on index pages.
  # Feel free to add, remove, or rearrange items.
  COLLECTION_ATTRIBUTES = T.let(%i[
    created_at
    application
    text
    name
  ].freeze, T::Array[Symbol])

  # SHOW_PAGE_ATTRIBUTES
  # an array of attributes that will be displayed on the model's show page.
  SHOW_PAGE_ATTRIBUTES = T.let(%i[
    application
    text
    user
    name
    published
    published_at
    created_at
    updated_at
    address
    hidden
    last_delivered_at
    last_delivered_successfully
    reports
  ].freeze, T::Array[Symbol])

  # FORM_ATTRIBUTES
  # an array of attributes that will be displayed
  # on the model's form (`new` and `edit`) pages.
  FORM_ATTRIBUTES = T.let(
    {
      "Moderate comment" => %i[text hidden],
      "Person details" => %i[name address]
    }.freeze, T::Hash[String, T::Array[Symbol]]
  )

  # COLLECTION_FILTERS
  # a hash that defines filters that can be used while searching via the search
  # field of the dashboard.
  #
  # For example to add an option to search for open resources by typing "open:"
  # in the search field:
  #
  #   COLLECTION_FILTERS = {
  #     open: ->(resources) { resources.where(open: true) }
  #   }.freeze
  COLLECTION_FILTERS = T.let({
    visible: ->(resources) { resources.visible },
    hidden: ->(resources) { resources.where(hidden: true) }
  }.freeze, T::Hash[Symbol, T.untyped])

  # Overwrite this method to customize how comments are displayed
  # across all pages of the admin dashboard.
  #
  # def display_resource(comment)
  #   "Comment ##{comment.id}"
  # end
end