semantic-administrate 0.1.0

data/app/views/administrate/application/_icons.erb

@@ -0,0 +1,13 @@
+<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
+  <symbol id="icon-cancel" viewBox="0 0 48 48">
+    <path fill-rule="evenodd" d="M24 19.757l-8.485-8.485c-.784-.783-2.047-.782-2.827 0l-1.417 1.416c-.777.777-.78 2.046.002 2.827L19.757 24l-8.485 8.485c-.783.784-.782 2.047 0 2.827l1.416 1.417c.777.777 2.046.78 2.827-.002L24 28.243l8.485 8.485c.784.783 2.047.782 2.827 0l1.417-1.416c.777-.777.78-2.046-.002-2.827L28.243 24l8.485-8.485c.783-.784.782-2.047 0-2.827l-1.416-1.417c-.777-.777-2.046-.78-2.827.002L24 19.757zM24 47c12.703 0 23-10.297 23-23S36.703 1 24 1 1 11.297 1 24s10.297 23 23 23z" />
+  </symbol>
+
+  <symbol id="icon-eyeglass" viewBox="0 0 48 48">
+    <path d="M27.885 32.515c-2.864 1.966-6.333 3.116-10.07 3.116C7.976 35.63 0 27.656 0 17.817 0 7.976 7.976 0 17.816 0S35.63 7.976 35.63 17.816c0 3.736-1.15 7.205-3.115 10.07l14.53 14.53c1.278 1.277 1.275 3.352 0 4.628-1.28 1.278-3.353 1.278-4.63 0l-14.53-14.53zm-10.07-3.736c6.056 0 10.964-4.91 10.964-10.964 0-6.055-4.91-10.964-10.964-10.964-6.055 0-10.964 4.91-10.964 10.964 0 6.055 4.91 10.963 10.964 10.963z" />
+  </symbol>
+
+  <symbol id="icon-up-caret" viewBox="0 0 48 48">
+    <path d="M2.988 33.02c-1.66 0-1.943-.81-.618-1.824l20-15.28c.878-.672 2.31-.67 3.188 0l20.075 15.288c1.316 1.003 1.048 1.816-.62 1.816H2.987z" />
+  </symbol>
+</svg>

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

@@ -0,0 +1,21 @@
+<%#
+# 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.
+%>
+
+<% Administrate::Engine.javascripts.each do |js_path| %>
+  <%= javascript_include_tag js_path %>
+<% end %>
+
+<%= yield :javascript %>
+
+<% if Rails.env.test? %>
+  <%= javascript_tag do %>
+    $.fx.off = true;
+    $.ajaxSetup({ async: false });
+  <% end %>
+<% end %>

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

@@ -0,0 +1,19 @@
+<div class="nav-drawer">
+  <input type="checkbox" id="nav_drawer_trigger" class="nav-drawer__trigger" style="display: none;" />
+
+  <div class="nav-drawer__header">
+    <label for="nav_drawer_trigger" class="nav-drawer__opener">
+      <i class="icon sidebar"></i>
+    </label>
+    <label for="nav_drawer_trigger" class="nav-drawer__closer">
+      <i class="icon close"></i>
+    </label>
+  </div>
+
+  <div class="nav-drawer__main">
+    <%= render 'navigation_links' %>
+    <%= render 'navigation_extra_links' %>
+  </div>
+
+  <%= render 'navigation_footer' %>
+</div>

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

@@ -0,0 +1,13 @@
+<%#
+  You can add extra navigation itens, in this partial.
+  E.G:
+
+  <div class="nav-drawer__menu-title">
+    Account
+  </div>
+
+  <div class="nav-drawer__menu-item">
+    <i class="icon sign out"></i>
+    Logout
+  </div>
+%>

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

@@ -0,0 +1,44 @@
+<% if defined?(current_user) %>
+  <div class="nav-drawer__footer">
+    <div class="nav-drawer__account">
+      <% avatar_method = [
+        :avatar_url,
+        :avatar_path,
+        :avatar,
+        :image_url,
+        :image_path,
+        :image,
+        :gravatar,
+        :gravatar_url,
+      ].find { |avatar_method| current_user.respond_to?(avatar_method) } %>
+
+      <% if avatar_method.present? %>
+        <div class="nav-drawer__account__avatar">
+          <%= image_tag current_user.send(avatar_method), alt: '' %>
+        </div>
+      <% elsif current_user.respond_to?(:email) %>
+        <div class="nav-drawer__account__avatar">
+          <%= image_tag gravatar_for_email(current_user.email), alt: '' %>
+        </div>
+      <% end %>
+
+      <div class="nav-drawer__account__details">
+        <% name_method = [
+          :name,
+          :first_name,
+          :nickname,
+          :username,
+          :user,
+          :email,
+        ].find { |name_method| current_user.respond_to?(name_method) } %>
+
+        <% if name_method.present? %>
+          <h2>Welcome,</h2>
+          <h3><%= current_user.send(name_method) %></h3>
+        <% else %>
+          <h2>Welcome</h2>
+        <% end %>
+      </div>
+    </div>
+  </div>
+<% end %>

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

@@ -0,0 +1,16 @@
+<%#
+# Navigation
+
+This partial is used to display the navigation in Administrate.
+By default, the navigation contains navigation links
+for all resources in the admin dashboard,
+as defined by the routes in the `admin/` namespace
+%>
+<% Administrate::Namespace.new(namespace).resources.each do |resource| %>
+  <%= link_to(
+    [namespace, resource_index_route_key(resource)],
+    class: "nav-drawer__menu-item nav-drawer__menu-item--#{nav_link_state(resource)}"
+  ) do %>
+    <%= display_resource_name(resource) %>
+  <% end %>
+<% end %>

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

@@ -0,0 +1,25 @@
+<form class="search" role="search">
+  <label class="search__label" for="search">
+    <svg class="search__eyeglass-icon" role="img">
+      <title>
+        <%= t("administrate.search.label", resource: resource_name) %>
+      </title>
+      <use xlink:href="#icon-eyeglass" />
+    </svg>
+  </label>
+
+  <input class="search__input"
+         id="search"
+         type="search"
+         name="search"
+         placeholder="<%= t("administrate.search.label",
+                            resource: resource_name) %>"
+         value="<%= search_term %>">
+
+  <%= link_to clear_search_params, class: "search__clear-link" do %>
+    <svg class="search__clear-icon" role="img">
+      <title><%= t("administrate.search.clear") %></title>
+      <use xlink:href="#icon-cancel" />
+    </svg>
+  <% end %>
+</form>

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

@@ -0,0 +1,14 @@
+<%#
+# Stylesheet Partial
+
+This partial imports the necessary stylesheets on each page.
+By default, it includes the application CSS,
+but each page can define additional CSS sources
+by providing a `content_for(:stylesheet)` block.
+%>
+
+<% Administrate::Engine.stylesheets.each do |css_path| %>
+  <%= stylesheet_link_tag css_path %>
+<% end %>
+
+<%= yield :stylesheet %>

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

@@ -0,0 +1,36 @@
+<%#
+# 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) { "#{t("administrate.actions.edit")} #{page.page_title}" } %>
+
+<header class="main-content__header" role="banner">
+  <h1 class="main-content__page-title">
+    <%= content_for(:title) %>
+  </h1>
+
+  <div>
+    <%= link_to(
+      "#{t("administrate.actions.show")} #{page.page_title}",
+      [namespace, page.resource],
+      class: "button",
+    ) if valid_action? :show %>
+  </div>
+</header>
+
+<section class="main-content__body">
+  <%= render "form", page: page %>
+</section>

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

@@ -0,0 +1,63 @@
+<%#
+# 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::Collection][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.
+- `show_search_bar`:
+  A boolean that determines if the search bar should be shown.
+
+[1]: http://www.rubydoc.info/gems/administrate/Administrate/Page/Collection
+%>
+
+<% content_for(:title) do %>
+  <%= display_resource_name(page.resource_name) %>
+<% end %>
+
+<header class="main-content__header" role="banner">
+  <h1 class="main-content__page-title" id="page-title">
+    <%= content_for(:title) %>
+  </h1>
+
+  <% if show_search_bar %>
+    <div class="main-content__search">
+      <%= render(
+        "search",
+        search_term: search_term,
+        resource_name: display_resource_name(page.resource_name)
+      ) %>
+    </div>
+  <% end %>
+
+  <div class="main-content__navs">
+    <%= link_to(
+      "#{t("administrate.actions.new")} #{page.resource_name.titleize.downcase}",
+      [:new, namespace, page.resource_path],
+      class: "button",
+    ) if valid_action? :new %>
+  </div>
+</header>
+
+<section class="main-content__body">
+  <%= render(
+    "collection",
+    collection_presenter: page,
+    resources: resources,
+    table_title: "page-title"
+  ) %>
+
+  <%= paginate resources %>
+</section>

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

@@ -0,0 +1,32 @@
+<%#
+# 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) { "#{t("administrate.actions.new")} #{page.resource_name.titleize}" } %>
+
+<header class="main-content__header" role="banner">
+  <h1 class="main-content__page-title">
+    <%= content_for(:title) %>
+  </h1>
+
+  <div>
+    <%= link_to t("administrate.actions.back"), :back, class: "button" %>
+  </div>
+</header>
+
+<section class="main-content__body">
+  <%= render "form", page: page %>
+</section>

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

@@ -0,0 +1,49 @@
+<%#
+# 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) { "#{t("administrate.actions.show")} #{page.page_title}" } %>
+
+<header class="main-content__header" role="banner">
+  <h1 class="main-content__page-title">
+    <%= content_for(:title) %>
+  </h1>
+
+  <div>
+    <%= link_to(
+      "#{t("administrate.actions.edit")} #{page.page_title}",
+      [:edit, namespace, page.resource],
+      class: "button",
+    ) if valid_action? :edit %>
+  </div>
+</header>
+
+<section class="main-content__body">
+  <dl>
+    <% page.attributes.each do |attribute| %>
+      <dt class="attribute-label" id="<%= attribute.name %>">
+      <%= t(
+        "helpers.label.#{resource_name}.#{attribute.name}",
+        default: attribute.name.titleize,
+      ) %>
+      </dt>
+
+      <dd class="attribute-data attribute-data--<%=attribute.html_class%>"
+          ><%= render_field attribute %></dd>
+    <% end %>
+  </dl>
+</section>

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

@@ -0,0 +1,26 @@
+<%#
+# 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
+%>
+
+<div class="field-unit__label">
+  <%= f.label field.permitted_attribute %>
+</div>
+<div class="field-unit__field">
+  <%= f.select(field.permitted_attribute) do %>
+    <%= options_for_select(field.associated_resource_options, field.selected_option) %>
+  <% end %>
+</div>

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

@@ -0,0 +1,27 @@
+<%#
+# 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 %>
+  <% if valid_action?(:show, field.attribute) %>
+    <%= link_to(
+      field.display_associated_resource,
+      [namespace, field.data],
+    ) %>
+  <% else %>
+    <%= field.display_associated_resource %>
+  <% end %>
+<% end %>

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

@@ -0,0 +1,27 @@
+<%#
+# 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 %>
+  <% if valid_action?(:show, field.attribute) %>
+    <%= link_to(
+      field.display_associated_resource,
+      [namespace, field.data],
+    ) %>
+  <% else %>
+    <%= field.display_associated_resource %>
+  <% end %>
+<% end %>