-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adds basic administration area with tests
** Why are these changes being introduced: * We want to add the Administrate gem to the application, and use its dashboards to manage information within TACOS. ** Relevant ticket(s): * https://mitlibraries.atlassian.net/browse/TCO-51 ** How does this address that need: This does several things: * Adds the Administrate gem * Builds the default dashboards for several resources already in the application: Suggested Resources, Search Events, Terms, and Users * Adds a nav link to the admin area, visible only to users with the rights to see the Terms dashboard (the default display) * Starts to define the authorization checks in the admin application controller, which should in turn look to CanCan's ability model. The ability model itself is so far unchanged. ** Document any side effects to this change: * The only change to the generated dashboards was to remove the fingerprint field from the Suggested Resource form, because that value is calculated during save. * The fact that the Terms dashboard is the default display is a bit arbitrary, and a future ticket will expand our approach here to potentially include a "lobby" display for users with various rights.
- Loading branch information
1 parent
9f52ce0
commit 1bab3fa
Showing
14 changed files
with
578 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -111,3 +111,5 @@ group :test do | |
gem 'vcr' | ||
gem 'webmock' | ||
end | ||
|
||
gem "administrate", "~> 0.20.1" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# All Administrate controllers inherit from this | ||
# `Administrate::ApplicationController`, making it the ideal place to put | ||
# authentication logic or other before_actions. | ||
# | ||
# If you want to add pagination or other controller-level concerns, | ||
# you're free to overwrite the RESTful controller actions. | ||
module Admin | ||
class ApplicationController < Administrate::ApplicationController | ||
before_action :require_user | ||
before_action :authorize_user | ||
|
||
private | ||
|
||
def authorize_user | ||
return if authorize_action?(resource_name, action_name) | ||
|
||
redirect_to root_path, alert: 'Not authorized' | ||
end | ||
|
||
def authorize_action?(resource, action) | ||
can? action, resource | ||
end | ||
|
||
def require_user | ||
return if current_user | ||
|
||
redirect_to root_path, alert: 'Please sign in to continue' | ||
end | ||
|
||
# Override this value to specify the number of elements to display at a time | ||
# on index pages. Defaults to 20. | ||
# def records_per_page | ||
# params[:per_page] || 20 | ||
# end | ||
end | ||
end |
48 changes: 48 additions & 0 deletions
48
app/controllers/admin/detector/suggested_resources_controller.rb
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
module Admin | ||
module Detector | ||
class SuggestedResourcesController < Admin::ApplicationController | ||
# Overwrite any of the RESTful controller actions to implement custom behavior | ||
# For example, you may want to send an email after a foo is updated. | ||
# | ||
# def update | ||
# super | ||
# send_foo_updated_email(requested_resource) | ||
# end | ||
|
||
# Override this method to specify custom lookup behavior. | ||
# This will be used to set the resource for the `show`, `edit`, and `update` | ||
# actions. | ||
# | ||
# def find_resource(param) | ||
# Foo.find_by!(slug: param) | ||
# end | ||
|
||
# The result of this lookup will be available as `requested_resource` | ||
|
||
# Override this if you have certain roles that require a subset | ||
# this will be used to set the records shown on the `index` action. | ||
# | ||
# def scoped_resource | ||
# if current_user.super_admin? | ||
# resource_class | ||
# else | ||
# resource_class.with_less_stuff | ||
# end | ||
# end | ||
|
||
# Override `resource_params` if you want to transform the submitted | ||
# data before it's persisted. For example, the following would turn all | ||
# empty values into nil values. It uses other APIs such as `resource_class` | ||
# and `dashboard`: | ||
# | ||
# def resource_params | ||
# params.require(resource_class.model_name.param_key). | ||
# permit(dashboard.permitted_attributes(action_name)). | ||
# transform_values { |value| value == "" ? nil : value } | ||
# end | ||
|
||
# See https://administrate-demo.herokuapp.com/customizing_controller_actions | ||
# for more information | ||
end | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
module Admin | ||
class SearchEventsController < Admin::ApplicationController | ||
# Overwrite any of the RESTful controller actions to implement custom behavior | ||
# For example, you may want to send an email after a foo is updated. | ||
# | ||
# def update | ||
# super | ||
# send_foo_updated_email(requested_resource) | ||
# end | ||
|
||
# Override this method to specify custom lookup behavior. | ||
# This will be used to set the resource for the `show`, `edit`, and `update` | ||
# actions. | ||
# | ||
# def find_resource(param) | ||
# Foo.find_by!(slug: param) | ||
# end | ||
|
||
# The result of this lookup will be available as `requested_resource` | ||
|
||
# Override this if you have certain roles that require a subset | ||
# this will be used to set the records shown on the `index` action. | ||
# | ||
# def scoped_resource | ||
# if current_user.super_admin? | ||
# resource_class | ||
# else | ||
# resource_class.with_less_stuff | ||
# end | ||
# end | ||
|
||
# Override `resource_params` if you want to transform the submitted | ||
# data before it's persisted. For example, the following would turn all | ||
# empty values into nil values. It uses other APIs such as `resource_class` | ||
# and `dashboard`: | ||
# | ||
# def resource_params | ||
# params.require(resource_class.model_name.param_key). | ||
# permit(dashboard.permitted_attributes(action_name)). | ||
# transform_values { |value| value == "" ? nil : value } | ||
# end | ||
|
||
# See https://administrate-demo.herokuapp.com/customizing_controller_actions | ||
# for more information | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
module Admin | ||
class TermsController < Admin::ApplicationController | ||
# Overwrite any of the RESTful controller actions to implement custom behavior | ||
# For example, you may want to send an email after a foo is updated. | ||
# | ||
# def update | ||
# super | ||
# send_foo_updated_email(requested_resource) | ||
# end | ||
|
||
# Override this method to specify custom lookup behavior. | ||
# This will be used to set the resource for the `show`, `edit`, and `update` | ||
# actions. | ||
# | ||
# def find_resource(param) | ||
# Foo.find_by!(slug: param) | ||
# end | ||
|
||
# The result of this lookup will be available as `requested_resource` | ||
|
||
# Override this if you have certain roles that require a subset | ||
# this will be used to set the records shown on the `index` action. | ||
# | ||
# def scoped_resource | ||
# if current_user.super_admin? | ||
# resource_class | ||
# else | ||
# resource_class.with_less_stuff | ||
# end | ||
# end | ||
|
||
# Override `resource_params` if you want to transform the submitted | ||
# data before it's persisted. For example, the following would turn all | ||
# empty values into nil values. It uses other APIs such as `resource_class` | ||
# and `dashboard`: | ||
# | ||
# def resource_params | ||
# params.require(resource_class.model_name.param_key). | ||
# permit(dashboard.permitted_attributes(action_name)). | ||
# transform_values { |value| value == "" ? nil : value } | ||
# end | ||
|
||
# See https://administrate-demo.herokuapp.com/customizing_controller_actions | ||
# for more information | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
module Admin | ||
class UsersController < Admin::ApplicationController | ||
# Overwrite any of the RESTful controller actions to implement custom behavior | ||
# For example, you may want to send an email after a foo is updated. | ||
# | ||
# def update | ||
# super | ||
# send_foo_updated_email(requested_resource) | ||
# end | ||
|
||
# Override this method to specify custom lookup behavior. | ||
# This will be used to set the resource for the `show`, `edit`, and `update` | ||
# actions. | ||
# | ||
# def find_resource(param) | ||
# Foo.find_by!(slug: param) | ||
# end | ||
|
||
# The result of this lookup will be available as `requested_resource` | ||
|
||
# Override this if you have certain roles that require a subset | ||
# this will be used to set the records shown on the `index` action. | ||
# | ||
# def scoped_resource | ||
# if current_user.super_admin? | ||
# resource_class | ||
# else | ||
# resource_class.with_less_stuff | ||
# end | ||
# end | ||
|
||
# Override `resource_params` if you want to transform the submitted | ||
# data before it's persisted. For example, the following would turn all | ||
# empty values into nil values. It uses other APIs such as `resource_class` | ||
# and `dashboard`: | ||
# | ||
# def resource_params | ||
# params.require(resource_class.model_name.param_key). | ||
# permit(dashboard.permitted_attributes(action_name)). | ||
# transform_values { |value| value == "" ? nil : value } | ||
# end | ||
|
||
# See https://administrate-demo.herokuapp.com/customizing_controller_actions | ||
# for more information | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
require "administrate/base_dashboard" | ||
|
||
module Detector | ||
class Detector::SuggestedResourceDashboard < 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 = { | ||
id: Field::Number, | ||
fingerprint: Field::String, | ||
phrase: Field::String, | ||
title: Field::String, | ||
url: Field::String, | ||
created_at: Field::DateTime, | ||
updated_at: Field::DateTime, | ||
}.freeze | ||
|
||
# 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 = %i[ | ||
id | ||
fingerprint | ||
phrase | ||
title | ||
].freeze | ||
|
||
# SHOW_PAGE_ATTRIBUTES | ||
# an array of attributes that will be displayed on the model's show page. | ||
SHOW_PAGE_ATTRIBUTES = %i[ | ||
id | ||
fingerprint | ||
phrase | ||
title | ||
url | ||
created_at | ||
updated_at | ||
].freeze | ||
|
||
# FORM_ATTRIBUTES | ||
# an array of attributes that will be displayed | ||
# on the model's form (`new` and `edit`) pages. | ||
FORM_ATTRIBUTES = %i[ | ||
phrase | ||
title | ||
url | ||
].freeze | ||
|
||
# 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 = {}.freeze | ||
|
||
# Overwrite this method to customize how suggested resources are displayed | ||
# across all pages of the admin dashboard. | ||
# | ||
# def display_resource(suggested_resource) | ||
# "Detector::SuggestedResource ##{suggested_resource.id}" | ||
# end | ||
end | ||
end |
Oops, something went wrong.