Administrate::Field::ScopedBelongsTo
A belongs_to
field that yields itself to the scope
option.
Installation
Add this line to your application's Gemfile:
gem 'administrate-field-scoped_belongs_to'
And then execute:
$ bundle
Or install it yourself as:
$ gem install administrate-field-scoped_belongs_to
Usage
require "administrate/base_dashboard"
class BookDashboard < 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::String,
name: Field::String,
author: Field::ScopedBelongsTo.with_options(scope: -> (field) { field.resource.publisher.authors } ),
created_at: Field::DateTime,
updated_at: Field::DateTime
}.freeze
# ...
end
This allows you to access the field and therefore the resource and thus any method on this resource such as scopes. You might use this in conjunction with nested resources or settings or authorizations where you can't always rely on globally available data.
Options
option | default | description |
---|---|---|
scope | undefined | scope for the candidate resources for this field; expects a lambda with one argument (the field) |
Related
-
Administrate
: A Rails engine that helps you put together a super-flexible admin dashboard. -
Administrate::BaseController
: 🌠 A set of application controller improvements.
Concerns
-
Administrate::DefaultOrder
: 🔢 Sets the default order for a resource in a administrate controller. -
Administrate::SerializedFields
: 🆎 Automatically deserialize administrate fields on form submit.
Fields
-
Administrate::Field::Code
: 📝 Atext
field that shows code. -
Administrate::Field::Hyperlink
: 📝 Astring
field that is shows a hyperlink. -
Adminisrtate::Field::JsonEditor
: 📝 Atext
field that shows a JSON editor. -
Administrate::Field::ScopedHasMany
: 📝 Ahas_many
field that yields itself to the scopelambda
. -
Administrate::Field::TimeAgo
: 📝 Adate_time
field that shows its data astime_ago
since.
Development
After checking out the repo, run bin/setup
to install dependencies. Then, run rake test
to run the tests. You can
also run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
. To release a new version, update the
version number in version.rb
, and then run bundle exec rake release
, which will create a git tag for the version,
push git commits and tags, and push the .gem
file to rubygems.org.
Contributing
Bug reports and pull requests are welcome on GitHub at XPBytes/administrate-field-scoped_belongs_to.