administrate 0.0.12 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd6443bd06d24f63d4f5dcfbb96fd9678a661e54
-  data.tar.gz: da323f68c0e013f7eeed53e9522081ef0e1accf6
+  metadata.gz: a63c6085034ba4b3ee39b90cd213593fbca55347
+  data.tar.gz: 3e4091678fda4953de68374a61c49f45573d843c
 SHA512:
-  metadata.gz: ffe2364fe45f624b3fb422336cd00cb36fde0ef6217e492a77f5117a05dfe0e1dc69395b3bfdc08c4b94b36a81d7231bb3b7193e5ddafb0b62686b422d054d67
-  data.tar.gz: 4e0e7c3d7cdd9dbc45ebe2195c0686f0c9fc852b1e1ffe8c6cd9b3716d61f7a03a801a15a22c25829af360f36eef8ed1af2140bf617a513d12a81182cf0e0461
+  metadata.gz: 232a793a6aad5135c044d957297f5850078fa4bfbf5e3e100a851a0efc4d3ec5ff0392eb9bcc85a99ea6e1b5480ef8c233ab1454913f95ccccf8271b4dc83902
+  data.tar.gz: e66a04e628f6a1afa97be1784a33deedb3baf782075279efbc2dcecf0a2d71eb3b5f7aed2d72845c4b6c54d6ce571e5838011925fb5bac3d4fd2546a4eb1fce9

data/app/assets/images/administrate/dropdown.svg

@@ -0,0 +1,3 @@
+<svg width="242" height="104" viewBox="0 0 242 104" xmlns="http://www.w3.org/2000/svg">
+  <path d="M0 0h242L121 104 0 0z" fill="#2d6586" fill-rule="evenodd"/>
+</svg>

data/app/assets/javascripts/administrate/components/_search.js

@@ -7,7 +7,8 @@ $(function() {
 
   $.fn.textWidth = function(text, font) {
     if (!$.fn.textWidth.fakeEl) {
-      $.fn.textWidth.fakeEl = $("<span>").appendTo(document.body);
+      $.fn.textWidth.fakeEl = $('<span style="display: none;">')
+                              .appendTo(document.body);
     }
 
     var htmlText = text || this.val() || this.text();

data/app/assets/javascripts/administrate/components/has_many_form.js

@@ -1,3 +1,3 @@
 $(function() {
-  $(".form-field-has-many select").selectize({});
+  $(".form-field--has-many select").selectize({});
 });

data/app/assets/stylesheets/administrate/application.scss

@@ -13,6 +13,5 @@
 
 @import "layout";
 @import "sidebar";
-@import "show";
 
 @import "components/components";

data/app/assets/stylesheets/administrate/base/_forms.scss

@@ -36,8 +36,8 @@ select {
   box-sizing: border-box;
   font-family: $form-font-family;
   font-size: $form-font-size;
-  margin-bottom: $base-spacing / 2;
-  padding: ($base-spacing / 3) ($base-spacing / 3);
+  margin-bottom: $small-spacing;
+  padding: $form-input-padding;
   transition: border-color;
   width: 100%;
 
@@ -77,6 +77,6 @@ input[type="file"] {
 
 select {
   appearance: none;
-  background: image-url("dropdown.svg") no-repeat 97% 50% / 10px;
+  background: image-url("administrate/dropdown.svg") no-repeat 97% 50% / 10px;
   margin-bottom: $base-spacing;
 }

data/app/assets/stylesheets/administrate/base/_lists.scss

@@ -19,13 +19,13 @@ ol {
 
 dl {
   margin-bottom: $base-spacing / 2;
+}
 
-  dt {
-    font-weight: bold;
-    margin-top: $base-spacing / 2;
-  }
+dt {
+  font-weight: bold;
+  margin-top: $base-spacing / 2;
+}
 
-  dd {
-    margin: 0;
-  }
+dd {
+  margin: 0;
 }

data/app/assets/stylesheets/administrate/base/_variables.scss

@@ -28,6 +28,7 @@ $base-border-radius: 3px;
 $base-spacing: $base-line-height * 1em;
 $base-z-index: 0;
 $small-spacing: $base-spacing / 2;
+$table-image-height: 2em;
 
 // Transitions
 $base-easing: cubic-bezier(0.215, 0.610, 0.355, 1);
@@ -101,3 +102,5 @@ $form-box-shadow: inset 0 1px 3px rgba(black,0.06);
 $form-box-shadow-focus: $form-box-shadow, 0 0 5px rgba(darken($form-border-color-focus, 5), 0.7);
 $form-font-size: $base-font-size;
 $form-font-family: $base-font-family;
+
+$form-input-padding: $base-spacing / 3;

data/app/assets/stylesheets/administrate/components/_attributes.scss

@@ -1,3 +1,16 @@
+.attribute-label {
+  @include data-label;
+  @include span-columns(2 of 12);
+  margin-top: 0;
+  text-align: right;
+}
+
 .attribute-data--string {
   white-space: pre;
 }
+
+.attribute-data {
+  @include span-columns(10 of 12);
+  @include omega;
+  margin-bottom: $base-spacing;
+}

data/app/assets/stylesheets/administrate/components/_cells.scss

@@ -1,11 +1,5 @@
-.cell-label,
-.attribute-label {
-  color: $hint-grey;
-  font-size: $small-font-size;
-  font-weight: $normal-font-weight;
-  letter-spacing: 0.0357em;
-  position: relative;
-  text-transform: uppercase;
+.cell-label {
+  @include data-label;
 
   a {
     @include fill-parent;

data/app/assets/stylesheets/administrate/components/_form.scss

@@ -1,33 +1,40 @@
-.form {
-  &-actions {
-    margin-left: 12em;
+.form-actions {
+  @include shift(2);
+}
+
+.form-field {
+  @include clearfix;
+  @include fill-parent;
+  align-items: baseline;
+  width: 100%;
+
+  label {
+    @include data-label;
+    @include span-columns(2 of 12);
+    padding: $form-input-padding 0;
+    text-align: right;
   }
 
-  &-heading {
-    font-size: 1.75em;
-    margin: 0;
-    padding-bottom: 0.5em;
+  #{$all-text-inputs},
+  select,
+  textarea,
+  .selectize-control {
+    background-color: $form-field-background-color;
+    margin-bottom: $base-spacing;
   }
 
-  &-field {
-    align-items: baseline;
-    display: flex;
-    justify-content: flex-start;
-    margin: 1.2em 0;
-    width: 100%;
+  input,
+  select,
+  .selectize-control {
+    @include span-columns(4 of 12);
+  }
 
-    label {
-      margin-right: 2em;
-      text-align: right;
-      width: 10em;
-    }
+  textarea {
+    @include span-columns(6 of 12);
+  }
 
-    input,
-    select,
-    .selectize-control {
-      background-color: $form-field-background-color;
-      max-width: 30em;
-      width: 30em;
-    }
+  [type="checkbox"],
+  [type="radio"] {
+    margin: $small-spacing 0 ($base-spacing + $form-input-padding);
   }
 }

data/app/assets/stylesheets/administrate/components/_header.scss

@@ -2,7 +2,7 @@
   align-items: flex-end;
   display: flex;
   justify-content: space-between;
-  margin-bottom: $base-spacing;
+  margin-bottom: $base-spacing * 2;
 
   &-heading {
     margin-top: 0;

data/app/assets/stylesheets/administrate/components/_search.scss

@@ -38,7 +38,7 @@
 }
 
 .search__hint {
-  @include position(absolute, 1em null null null);
+  @include position(absolute, 1em 0 null null);
   @include transition($base-transition);
   color: $hint-grey;
   opacity: 0;

data/app/assets/stylesheets/administrate/components/_table.scss

@@ -8,6 +8,10 @@
     border-left-color: $blue;
     cursor: pointer;
   }
+
+  img {
+    max-height: $table-image-height;
+  }
 }
 
 .table__action--destroy {

data/app/assets/stylesheets/administrate/mixins/_data_label.scss

@@ -0,0 +1,8 @@
+@mixin data-label {
+  color: $hint-grey;
+  font-size: $small-font-size;
+  font-weight: $normal-font-weight;
+  letter-spacing: 0.0357em;
+  position: relative;
+  text-transform: uppercase;
+}

data/app/assets/stylesheets/administrate/mixins/_mixins.scss

@@ -1 +1,2 @@
+@import "data_label";
 @import "shadow";

data/app/controllers/administrate/application_controller.rb

@@ -1,31 +1,39 @@
 module Administrate
   class ApplicationController < ActionController::Base
     def index
-      @search_term = params[:search].to_s.strip
-      @resources = Administrate::Search.new(resource_resolver, @search_term).run
-      @resources = order.apply(@resources)
-      @resources = @resources.page(params[:page]).per(records_per_page)
-      @page = Administrate::Page::Table.new(dashboard, order: order)
+      search_term = params[:search].to_s.strip
+      resources = Administrate::Search.new(resource_resolver, search_term).run
+      resources = order.apply(resources)
+      resources = resources.page(params[:page]).per(records_per_page)
+      page = Administrate::Page::Collection.new(dashboard, order: order)
+
+      render locals: {
+        resources: resources.page(params[:page]).per(records_per_page),
+        search_term: search_term,
+        page: page,
+      }
     end
 
     def show
-      set_resource
-
-      @page = Administrate::Page::Show.new(dashboard, resource)
+      render locals: {
+        page: Administrate::Page::Show.new(dashboard, requested_resource),
+      }
     end
 
     def new
-      @page = Administrate::Page::Form.new(dashboard, resource_class.new)
+      render locals: {
+        page: Administrate::Page::Form.new(dashboard, resource_class.new),
+      }
     end
 
     def edit
-      set_resource
-
-      @page = Administrate::Page::Form.new(dashboard, resource)
+      render locals: {
+        page: Administrate::Page::Form.new(dashboard, requested_resource),
+      }
     end
 
     def create
-      set_resource(resource_class.new(resource_params))
+      resource = resource_class.new(resource_params)
 
       if resource.save
         redirect_to(
@@ -33,29 +41,27 @@ module Administrate
           notice: translate("create.success"),
         )
       else
-        @page = Administrate::Page::Form.new(dashboard, resource)
-        render :new
+        render :new, locals: {
+          page: Administrate::Page::Form.new(dashboard, resource),
+        }
       end
     end
 
     def update
-      set_resource
-
-      if resource.update(resource_params)
+      if requested_resource.update(resource_params)
         redirect_to(
-          [Administrate::NAMESPACE, resource],
+          [Administrate::NAMESPACE, requested_resource],
           notice: translate("update.success"),
         )
       else
-        @page = Administrate::Page::Form.new(dashboard, resource)
-        render :edit
+        render :edit, locals: {
+          page: Administrate::Page::Form.new(dashboard, requested_resource),
+        }
       end
     end
 
     def destroy
-      set_resource
-
-      resource.destroy
+      requested_resource.destroy
       flash[:notice] = translate("destroy.success")
       redirect_to action: :index
     end
@@ -76,26 +82,21 @@ module Administrate
     end
 
     def order
-      @order ||= Administrate::Order.new(params[:order], params[:direction])
+      @_order ||= Administrate::Order.new(params[:order], params[:direction])
     end
 
     def dashboard
-      @dashboard ||= resource_resolver.dashboard_class.new
+      @_dashboard ||= resource_resolver.dashboard_class.new
     end
 
-    def set_resource(resource = nil)
-      resource ||= find_resource(params[:id])
-      instance_variable_set(instance_variable, resource)
+    def requested_resource
+      @_requested_resource ||= find_resource(params[:id])
     end
 
     def find_resource(param)
       resource_class.find(param)
     end
 
-    def resource
-      instance_variable_get(instance_variable)
-    end
-
     def resource_params
       params.require(resource_name).permit(*permitted_attributes)
     end
@@ -104,14 +105,10 @@ module Administrate
       dashboard.permitted_attributes
     end
 
-    def instance_variable
-      "@#{resource_name}"
-    end
-
     delegate :resource_class, :resource_name, to: :resource_resolver
 
     def resource_resolver
-      @resource_resolver ||=
+      @_resource_resolver ||=
         Administrate::ResourceResolver.new(controller_path)
     end
 

data/app/views/administrate/application/{_table.html.erb → _collection.html.erb}

@@ -1,17 +1,37 @@
+<%#
+# Table
+
+This partial is used on the `index` and `show` pages
+to display a collection of resources in an HTML table.
+
+## Local variables:
+
+- `table_presenter`:
+  An instance of [Administrate::Page::Table][1].
+  The table presenter uses `ResourceDashboard::TABLE_ATTRIBUTES` to determine
+  the columns displayed in the table
+- `resources`:
+  An ActiveModel::Relation collection of resources to be displayed in the table.
+  By default, the number of resources is limited by pagination
+  or by a hard limit to prevent excessive page load times
+
+[1]: http://www.rubydoc.info/gems/administrate/Administrate/Page/Table
+%>
+
 <table>
   <thead>
     <tr>
-      <% table_presenter.attribute_types.each do |attr_name, attr_type| %>
+      <% collection_presenter.attribute_types.each do |attr_name, attr_type| %>
         <th class="cell-label cell-label--<%= attr_type.html_class %>
-          cell-label--<%= table_presenter.ordered_html_class(attr_name) %>
+          cell-label--<%= collection_presenter.ordered_html_class(attr_name) %>
         ">
         <%= link_to(params.merge(
-          table_presenter.order_params_for(attr_name)
+          collection_presenter.order_params_for(attr_name)
         )) do %>
             <%= attr_name.to_s.titleize %>
 
-            <% if table_presenter.ordered_by?(attr_name) %>
-              <span class="cell-label__sort-indicator cell-label__sort-indicator--<%= table_presenter.ordered_html_class(attr_name) %>">
+            <% if collection_presenter.ordered_by?(attr_name) %>
+              <span class="cell-label__sort-indicator cell-label__sort-indicator--<%= collection_presenter.ordered_html_class(attr_name) %>">
                 <%= inline_svg("administrate/sort_arrow.svg") %>
               </span>
             <% end %>
@@ -29,7 +49,7 @@
           tabindex="0"
           data-url="<%= polymorphic_path([Administrate::NAMESPACE, resource]) -%>"
           >
-        <% table_presenter.attributes_for(resource).each do |attribute| %>
+        <% collection_presenter.attributes_for(resource).each do |attribute| %>
           <td class="cell-data cell-data--<%= attribute.html_class %>">
             <%= render_field attribute %>
           </td>

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

@@ -1,3 +1,16 @@
+<%#
+# Flash Partial
+
+This partial renders flash messages on every page.
+
+## Relevant Helpers:
+
+- `flash`:
+  Returns a hash,
+  where the keys are the type of flash (alert, error, notice, etc)
+  and the values are the message to be displayed.
+%>
+
 <% if flash.any? %>
   <div id="flashes">
     <% flash.each do |key, value| -%>