administrate 0.0.12 → 0.1.0

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

@@ -1,13 +1,29 @@
-<%= form_for([Administrate::NAMESPACE, @page.resource], class: "form") do |f| %>
-  <% if @page.resource.errors.any? %>
+<%#
+# Form Partial
+
+This partial is rendered on a resource's `new` and `edit` pages,
+and renders all form fields for a resource's editable attributes.
+
+## Local variables:
+
+- `page`:
+  An instance of [Administrate::Page::Form][1].
+  Contains helper methods to display a form,
+  and knows which attributes should be displayed in the resource's form.
+
+[1]: http://www.rubydoc.info/gems/administrate/Administrate/Page/Form
+%>
+
+<%= form_for([Administrate::NAMESPACE, page.resource], class: "form") do |f| %>
+  <% if page.resource.errors.any? %>
     <div id="error_explanation">
       <h2>
-        <%= pluralize(@page.resource.errors.count, "error") %>
-        prohibited this <%= @page.resource_name %> from being saved:
+        <%= pluralize(page.resource.errors.count, "error") %>
+        prohibited this <%= page.resource_name %> from being saved:
       </h2>
 
       <ul>
-        <% @page.resource.errors.full_messages.each do |message| %>
+        <% page.resource.errors.full_messages.each do |message| %>
           <li><%= message %></li>
         <% end %>
       </ul>
@@ -15,8 +31,8 @@
   <% end %>
 
   <div class="form-inputs">
-    <% @page.attributes.each do |attribute| -%>
-      <div class="form-field form-field-<%= attribute.html_class %>">
+    <% page.attributes.each do |attribute| -%>
+      <div class="form-field form-field--<%= attribute.html_class %>">
         <%= render_field attribute, f: f %>
       </div>
     <% end -%>

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

@@ -1,3 +1,12 @@
+<%#
+# Javascript Partial
+
+This partial imports the necessary javascript on each page.
+By default, it includes the application JS,
+but each page can define additional JS sources
+by providing a `content_for(:javascript)` block.
+%>
+
 <%= javascript_include_tag "administrate/application" %>
 
 <%= yield :javascript %>

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

@@ -1,3 +1,12 @@
+<%#
+# Sidebar
+
+This partial is used to display the sidebar in Administrate.
+By default, the sidebar contains navigation links
+for all resources in the admin dashboard,
+as defined by the DashboardManifest.
+%>
+
 <ul class="sidebar__list">
   <% DashboardManifest::DASHBOARDS.each do |resource| %>
     <li>

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

@@ -1,6 +1,25 @@
+<%#
+# Edit
+
+This view is the template for the edit page.
+
+It displays a header, and renders the `_form` partial to do the heavy lifting.
+
+## Local variables:
+
+- `page`:
+  An instance of [Administrate::Page::Form][1].
+  Contains helper methods to help display a form,
+  and knows which attributes should be displayed in the resource's form.
+
+[1]: http://www.rubydoc.info/gems/administrate/Administrate/Page/Form
+%>
+
+<% content_for(:title) { "Edit #{page.page_title}" } %>
+
 <header class="header">
-  <h1 class="header-heading">Edit <%= @page.page_title %></h1>
-  <%= link_to "Show #{@page.resource}", [Administrate::NAMESPACE, @page.resource], class: "button" %>
+  <h1 class="header-heading"><%= content_for(:title) %></h1>
+  <%= link_to "Show #{page.resource}", [Administrate::NAMESPACE, page.resource], class: "button" %>
 </header>
 
-<%= render "form" %>
+<%= render "form", page: page %>

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

@@ -1,3 +1,28 @@
+<%#
+# Index
+
+This view is the template for the index page.
+It is responsible for rendering the search bar, header and pagination.
+It renders the `_table` partial to display details about the resources.
+
+## Local variables:
+
+- `page`:
+  An instance of [Administrate::Page::Table][1].
+  Contains helper methods to help display a table,
+  and knows which attributes should be displayed in the resource's table.
+- `resources`:
+  An instance of `ActiveRecord::Relation` containing the resources
+  that match the user's search criteria.
+  By default, these resources are passed to the table partial to be displayed.
+- `search_term`:
+  A string containing the term the user has searched for, if any.
+
+[1]: http://www.rubydoc.info/gems/administrate/Administrate/Page/Table
+%>
+
+<% content_for(:title) { page.resource_name.pluralize.titleize } %>
+
 <% content_for(:search) do %>
   <form class="search">
     <span class="search__icon">
@@ -8,7 +33,7 @@
       name="search"
       class="search__input"
       placeholder="Search"
-      value="<%= @search_term %>"
+      value="<%= search_term %>"
     />
     <span class="search__hint">
       Press enter to search
@@ -17,14 +42,14 @@
 <% end %>
 
 <header class="header">
-  <h1 class="header-heading"><%= @page.resource_name.pluralize.titleize %></h1>
+  <h1 class="header-heading"><%= content_for(:title) %></h1>
   <%= link_to(
-    "New #{@page.resource_name.titleize.downcase}",
-    [:new, Administrate::NAMESPACE, @page.resource_name],
+    "New #{page.resource_name.titleize.downcase}",
+    [:new, Administrate::NAMESPACE, page.resource_name],
     class: "button",
   ) %>
 </header>
 
-<%= render "table", table_presenter: @page, resources: @resources %>
+<%= render "collection", collection_presenter: page, resources: resources %>
 
-<%= paginate @resources %>
+<%= paginate resources %>

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

@@ -1,6 +1,25 @@
+<%#
+# New
+
+This view is the template for the "new resource" page.
+It displays a header, and then renders the `_form` partial
+to do the heavy lifting.
+
+## Local variables:
+
+- `page`:
+  An instance of [Administrate::Page::Form][1].
+  Contains helper methods to help display a form,
+  and knows which attributes should be displayed in the resource's form.
+
+[1]: http://www.rubydoc.info/gems/administrate/Administrate/Page/Form
+%>
+
+<% content_for(:title) { "New #{page.resource_name.titleize}" } %>
+
 <header class="header">
-  <h1 class="header-heading">New <%= @page.resource_name.titleize %></h1>
-  <%= link_to 'Back', @page.resource_name.pluralize, class: "button" %>
+  <h1 class="header-heading"><%= content_for(:title) %></h1>
+  <%= link_to 'Back', :back, class: "button" %>
 </header>
 
-<%= render 'form' %>
+<%= render 'form', page: page %>

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

@@ -1,17 +1,37 @@
+<%#
+# Show
+
+This view is the template for the show page.
+It renders the attributes of a resource,
+as well as a link to its edit page.
+
+## Local variables:
+
+- `page`:
+  An instance of [Administrate::Page::Show][1].
+  Contains methods for accessing the resource to be displayed on the page,
+  as well as helpers for describing how each attribute of the resource
+  should be displayed.
+
+[1]: http://www.rubydoc.info/gems/administrate/Administrate/Page/Show
+%>
+
+<% content_for(:title) { page.page_title } %>
+
 <header class="header">
-  <h1 class="header-heading"><%= @page.page_title %></h1>
+  <h1 class="header-heading"><%= content_for(:title) %></h1>
   <%= link_to(
     "Edit",
-    [:edit, Administrate::NAMESPACE, @page.resource],
+    [:edit, Administrate::NAMESPACE, page.resource],
     class: "button",
   ) %>
 </header>
 
 <dl>
-  <% @page.attributes.each do |attribute| %>
+  <% page.attributes.each do |attribute| %>
     <dt class="attribute-label"><%= attribute.name.titleize %></dt>
 
-    <dd class="attribute-data--<%=attribute.html_class%>"
+    <dd class="attribute-data attribute-data--<%=attribute.html_class%>"
         ><%= render_field attribute %></dd>
   <% end %>
 </dl>

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

@@ -1,3 +1,21 @@
+<%#
+# BelongsTo Form Partial
+
+This partial renders an input element for belongs_to relationships.
+By default, the input is a collection select box
+that displays all possible records to associate with.
+
+## Local variables:
+
+- `f`:
+  A Rails form generator, used to help create the appropriate input fields.
+- `field`:
+  An instance of [Administrate::Field::BelongsTo][1].
+  Contains helper methods for displaying a collection select box.
+
+[1]: http://www.rubydoc.info/gems/administrate/Administrate/Field/BelongsTo
+%>
+
 <%= f.label field.permitted_attribute %>
 <%= f.collection_select(
   field.permitted_attribute,

data/app/views/fields/belongs_to/_index.html.erb

@@ -1,3 +1,20 @@
+<%#
+# BelongsTo Index Partial
+
+This partial renders a belongs_to relationship,
+to be displayed on a resource's index page.
+
+By default, the relationship is rendered as a link to the associated object.
+
+## Local variables:
+
+- `field`:
+  An instance of [Administrate::Field::BelongsTo][1].
+  A wrapper around the belongs_to relationship pulled from the database.
+
+[1]: http://www.rubydoc.info/gems/administrate/Administrate/Field/BelongsTo
+%>
+
 <% if field.data %>
   <%= link_to field.data, [Administrate::NAMESPACE, field.data] %>
 <% end %>

data/app/views/fields/belongs_to/_show.html.erb

@@ -1,3 +1,20 @@
+<%#
+# BelongsTo Show Partial
+
+This partial renders a belongs_to relationship,
+to be displayed on a resource's show page.
+
+By default, the relationship is rendered as a link to the associated object.
+
+## Local variables:
+
+- `field`:
+  An instance of [Administrate::Field::BelongsTo][1].
+  A wrapper around the belongs_to relationship pulled from the database.
+
+[1]: http://www.rubydoc.info/gems/administrate/Administrate/Field/BelongsTo
+%>
+
 <% if field.data %>
   <%= link_to field.data, [Administrate::NAMESPACE, field.data] %>
 <% end %>

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

@@ -1,2 +1,19 @@
+<%#
+# Boolean Form Partial
+
+This partial renders an input element for a boolean attribute.
+By default, the input is a checkbox.
+
+## Local variables:
+
+- `f`:
+  A Rails form generator, used to help create the appropriate input fields.
+- `field`:
+  An instance of [Administrate::Field::Boolean][1].
+  A wrapper around the boolean value pulled from the database.
+
+[1]: http://www.rubydoc.info/gems/administrate/Administrate/Field/Boolean
+%>
+
 <%= f.label field.attribute %>
 <%= f.check_box field.attribute %>

data/app/views/fields/boolean/_index.html.erb

@@ -1 +1,19 @@
-<%= field %>
+<%#
+# Boolean Index Partial
+
+This partial renders a boolean attribute,
+to be displayed on a resource's index page.
+
+By default, the attribute is rendered
+as a string representation of the boolean value.
+
+## Local variables:
+
+- `field`:
+  An instance of [Administrate::Field::Boolean][1].
+  A wrapper around the boolean value pulled from the database.
+
+[1]: http://www.rubydoc.info/gems/administrate/Administrate/Field/Boolean
+%>
+
+<%= field.to_s %>

data/app/views/fields/boolean/_show.html.erb

@@ -1 +1,19 @@
-<%= field %>
+<%#
+# Boolean Show Partial
+
+This partial renders a boolean attribute,
+to be displayed on a resource's show page.
+
+By default, the attribute is rendered
+as a string representation of the boolean value.
+
+## Local variables:
+
+- `field`:
+  An instance of [Administrate::Field::Boolean][1].
+  A wrapper around the boolean value pulled from the database.
+
+[1]: http://www.rubydoc.info/gems/administrate/Administrate/Field/Boolean
+%>
+
+<%= field.to_s %>

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

@@ -1,2 +1,20 @@
+<%#
+# DateTime Form Partial
+
+This partial renders an input element for a datetime attribute.
+By default, the input is a text field that is augmented with [DateTimePicker].
+
+## Local variables:
+
+- `f`:
+  A Rails form generator, used to help create the appropriate input fields.
+- `field`:
+  An instance of [Administrate::Field::DateTime][1].
+  A wrapper around the DateTime value pulled from the database.
+
+[1]: http://www.rubydoc.info/gems/administrate/Administrate/Field/DateTime
+[DateTimePicker]: https://github.com/Eonasdan/bootstrap-datetimepicker
+%>
+
 <%= f.label field.attribute %>
 <%= f.text_field field.attribute, class: "datetimepicker" %>

data/app/views/fields/date_time/_index.html.erb

@@ -1,3 +1,21 @@
+<%#
+# DateTime Index Partial
+
+This partial renders a datetime attribute,
+to be displayed on a resource's index page.
+
+By default, the attribute is rendered
+as a localized date & time string.
+
+## Local variables:
+
+- `field`:
+  An instance of [Administrate::Field::DateTime][1].
+  A wrapper around the DateTime value pulled from the database.
+
+[1]: http://www.rubydoc.info/gems/administrate/Administrate/Field/DateTime
+%>
+
 <% if field.data %>
   <%= l field.data.to_date %>
 <% end %>

data/app/views/fields/date_time/_show.html.erb

@@ -1,3 +1,21 @@
+<%#
+# DateTime Show Partial
+
+This partial renders a datetime attribute,
+to be displayed on a resource's show page.
+
+By default, the attribute is rendered
+as a localized date & time string.
+
+## Local variables:
+
+- `field`:
+  An instance of [Administrate::Field::DateTime][1].
+  A wrapper around the DateTime value pulled from the database.
+
+[1]: http://www.rubydoc.info/gems/administrate/Administrate/Field/DateTime
+%>
+
 <% if field.data %>
   <%= l field.data %>
 <% end %>

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

@@ -1,2 +1,19 @@
+<%#
+# Email Form Partial
+
+This partial renders an input element for email addresses.
+By default, the input is a text box.
+
+## Local variables:
+
+- `f`:
+  A Rails form generator, used to help create the appropriate input fields.
+- `field`:
+  An instance of [Administrate::Field::Email][1].
+  A wrapper around the email pulled from the database.
+
+[1]: http://www.rubydoc.info/gems/administrate/Administrate/Field/Email
+%>
+
 <%= f.label field.attribute %>
 <%= f.email_field field.attribute %>