View

In Wallaby, the core of view layer is to iterate decorator’s *_field_names and render the type partial using corresponding type from decorator’s *_fields.

For example, for index view, the core looks like the following pseudocode:

<% index_field_names.each do |field_name| %>
  <%= render decorated.index_type_of(field_name),
    object: decorated, field_name: field_name,
    value: decorated.try(field_name), metadata: decorated.index_metadata_of(field_name) %>
<% end %>

It extends Rails’ partial lookup order (see Rails Template Inheritance) and supports Type Partial.

NOTE: Cell (since 5.2.0) is removed from 6.1.0

Starting with these concepts:

• What’s Type Partial
• Partial Lookup Order

For Type Partial:

• object, field_name, value, metadata and form - local variables for type partial

Also check out:

• Built-in Type Partials

Type Partial

A type partial is no different from Rails partial template. Just its name associates with the type defined in decorator’s metadata.

For example, a custom type markdown is defined for show field description in ProductDecorator:

class ProductDecorator < Admin::ApplicationDecorator
  show_fields[:description][:type] = 'markdown'
end

Then a partial can be created using the type markdown to serve this field description using the following file path:

<%# app/views/admin/products/show/_markdown.html.erb %>
<%# @param object [model] model instance %>
<%# @param field_name [String] name of the field %>
<%# @param value [Object] value of the field %>
<%# @param metadata [Hash] metadata of the field %>
<%= Redcarpet.new(value).to_html %>

Type Partial Locals

The following variables are available for a type partial:

• object: resource object wrapped in a decorator
• field_name: current field name
• value: current value
• metadata: associated metadata for current field and current action (index/show/form).
• form: form object associated with the object

Partial Lookup Order

On top of Rails’ lookup order, Wallaby has extended the order from high to low precedence as:

• app/views/$MOUNTED_PATH/$RESOURCES/$ACTION_PREFIX
• app/views/$MOUNTED_PATH/$RESOURCES
• app/views/$CONTROLLER_PATH/$ACTION_PREFIX
• app/views/$CONTROLLER_PATH
• app/views/$PARENT_CONTROLLER_PATH/$ACTION_PREFIX (it will keep going if there are more ancestor controllers)
• app/views/$PARENT_CONTROLLER_PATH
• app/views/$THEME_NAME/$ACTION_PREFIX
• app/views/$THEME_NAME
• app/views/wallaby/resources/$ACTION_PREFIX - (will not be applicable when $THEME_NAME is set)
• app/views/wallaby/resources - (will not be applicable when $THEME_NAME is set)

For example, for model Product, a Wallaby controller is declared as:

# app/controllers/backend/goods_controller.rb
class Backend::GoodsController < Admin::ApplicationsController
  self.theme_name = 'foundation'
  self.model_class = Product
end

And given that:

• Wallaby is mounted under path /manage (see how Wallaby is mounted in route).
• action is index.

In this case, variables become:

• $MOUNTED_PATH is manage (from mount path /manage)
• $ACTION_PREFIX is index (converted from action_name, see below Action Prefix Mapping)
• $RESOURCES is products (plural model name of Product, see URL naming convention)
• $CONTROLLER_PATH is backend/goods (controller_name of Backend::GoodsController)
• $PARENT_CONTROLLER_PATH is admin/application (controller_name of Admin::ApplicationController)
• $THEME_NAME is foundation

Then the partial lookup order becomes:

• app/views/manage/products/index/_markdown.html.erb (type partial)
• app/views/manage/products/_markdown.html.erb (type partial)
• app/views/backend/goods/index/_markdown.html.erb (type partial)
• app/views/backend/goods/_markdown.html.erb (type partial)
• app/views/admin/application/index/_markdown.html.erb (type partial)
• app/views/admin/application/_markdown.html.erb (type partial)
• app/views/foundation/index/_markdown.html.erb (type partial)
• app/views/foundation/_markdown.html.erb (type partial)

Therefore, the type partial can be created in one of the above paths depending on how it’s shared:

• if the type partial is only needed for model Product when no controller is created, then it can be created as:

  app/views/admin/products/index/_markdown.html.erb
  

• if the type partial is only needed for controller Backend::GoodsController, then it can be created as:

  app/views/backend/goods/index/_markdown.html.erb
  

• if the type partial is supposed to be shared among the app, then it can be created as:

  app/views/admin/application/index/_markdown.html.erb
  

NOTE: both locale and format can be included in file name. For example, to include locale en and format json for a type partial, it goes as app/views/admin/products/index/_markdown.en.json.rb.

NOTE: for type partial, the file extension doesn’t have to be erb, it’s totally fine to create it with preferable markup language (e.g. haml/slim/etc.)

NOTE: if CSV export feature is in use, two type partials should be created for index, one for HTML and one for CSV.

Action Prefix Mapping

The following resourcesful actions are mapped to the action prefixes:

Action	Action Prefix
index	index
new	form
create	form
show	show
edit	form
update	form
destroy	<N/A>

Built-in Type Partials

Association Type Partials

Type Partial	Available to Action Prefixes	Metadata Options
belongs_to	index, show, form	options for form: - :polymorphic_list - the list of polymorphic classes for this association.
has_one	index, show, form
has_many	index, show, form
has_and_belongs_to_many	index, show, form

General Type Partials

Type Partial	Available to Action Prefixes	Metadata Options
active_storage	index, show, form
bigint	index, show, form
bigserial	index, show, form
binary	index, show, form
bit_varying	index, show, form
bit	index, show, form
blob	index, show, form
boolean	index, show, form
box	index, show, form	options for index: - :max - truncate text at max length.
cidr	index, show, form
circle	index, show, form	options for index: - :max - truncate text at max length.
citext	index, show, form	options for index: - :max - truncate text at max length.
color	index, show, form
date	index, show, form
daterange	index, show, form
datetime	index, show, form
decimal	index, show, form
dollar	index
dropdown	form	options for form: - :choices - choices for ActionView::Helpers::FormBuilder#select. - :options - options for ActionView::Helpers::FormBuilder#select. - :html_options - html_options for ActionView::Helpers::FormBuilder#select.
email	index, show, form
file	form
float	index, show, form	options for form: - :options - options for ActionView::Helpers::FormHelper#number_field.
hstore	index, show, form	options for index: - :max - truncate text at max length.
image	show	options for show: - :options - options for ActionView::Helpers::AssetTagHelper#image_tag.
inet	index, show, form
int4range	index, show, form
int8range	index, show, form
integer	index, show, form
json	index, show, form	options for index: - :max - truncate text at max length.
jsonb	index, show, form	options for index: - :max - truncate text at max length.
line	index, show, form	options for index: - :max - truncate text at max length.
link	index, show	options for index, show: - :title - title of the link. - :html_options - options for ActionView::Helpers::UrlHelper.html#link_to
longblob	index, show, form
longtext	index, show, form	options for index: - :max - truncate text at max length.
lseg	index, show, form	options for index: - :max - truncate text at max length.
ltree	index, show, form	options for index: - :max - truncate text at max length.
macaddr	index, show, form
markdown	form
mediumblob	index, show, form
mediumtext	index, show, form	options for index: - :max - truncate text at max length.
money	index, show, form
numrange	index, show, form
password	index, show, form
percent	index
path	index, show, form	options for index: - :max - truncate text at max length.
point	index, show, form
polygon	index, show, form	options for index: - :max - truncate text at max length.
raw	index, show
serial	index, show, form
sti	index, show, form	options for index: - :max - truncate text at max length. options for form: - :sti_class_list - list of STI classes for user to choose.
string	index, show, form	options for index: - :max - truncate text at max length.
text	index, show, form	options for index: - :max - truncate text at max length.
time	index, show, form
tinyblob	index, show, form
tinytext	index, show, form	options for index: - :max - truncate text at max length.
tsrange	index, show, form
tstzrange	index, show, form
tsvector	index, show, form	options for index: - :max - truncate text at max length.
unsigned_bigint	index, show, form
unsigned_decimal	index, show, form
unsigned_float	index, show, form
unsigned_integer	index, show, form
uuid	index, show, form	options for index: - :max - truncate text at max length.
xml	index, show, form	options for index: - :max - truncate text at max length.