tb_core 1.4.1 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a9b6cb6c8e20c8f5e050ff4194eecd52873a8ee8
-  data.tar.gz: 6f0923c173310c948501ab42f63fd9cdc4117577
+  metadata.gz: 5d4b115f542bdd9445a2a32b9d1d0ea8a664c6ae
+  data.tar.gz: c77ab9bab3976d0c567ea557111991b1b45a8388
 SHA512:
-  metadata.gz: 75f1dcb89bd05dad030e06f21955d670c3cd8cb7af2541807de9588840aa1202205699cbd53bb95ecce5d6337ae456fe53b529f01b35e57fcca6c8f83c0ffac0
-  data.tar.gz: e8fbe677701e25eafca66574b35ed73bd0689bddf9af713c896da23d21b28d013a4166f7b7645f450c7bf35917b258e9fb9da0fa149fa0b0649e64c6b0af99ab
+  metadata.gz: e6b8e1f29af8d51135fb1a724eecceacb31f3bf9d43ec9ca3e2496bdb93c4aecb21027d81ecbd9b4a3e5be3c140b137f2257a799b4cd142cdca5e090c098a3bb
+  data.tar.gz: 13e3206f5b3327ad0473cce81d1869552227c227772fe41cefddd72afe685867ca2e120111e8bf17b89a4864130f55a4a1ef1ae72721657f04fb30c46f4631de

data/README.md

@@ -32,7 +32,7 @@ Setup Tasks
 
 The `spud:setup` generator takes care of a few tasks for you. If you missed that step or would like to complete them manually, they are listed below:
 
-1. Your base `ApplicationController` should extend from `Spud::ApplicationController`.
+1. Your base `ApplicationController` should extend from `TbCore::ApplicationController`.
 2. Your base `application.html.erb` should include a few special head tags (see generator template for example).
 3. You should copy in the base migrations with `rake railties:install:migrations`.
 
@@ -121,7 +121,7 @@ Create a file in your app at `app/views/admin/users/_show_additions.html.erb`.
 Error Handling
 ------------
 
-The base `Spud::ApplicationController` will automatically rescue from any `Spud::NotFoundError` and `Spud::AccessDeniedError` errors by rendering out the `layouts/error_page.html` template. If you ran the `spud:setup` generator, a template of that name will have been created for you automatically.
+The base `TbCore::ApplicationController` will automatically rescue from any `Spud::NotFoundError` and `Spud::AccessDeniedError` errors by rendering out the `layouts/error_page.html` template. If you ran the `spud:setup` generator, a template of that name will have been created for you automatically.
 
 When building your own apps you may raise a `Spud::NotFoundError` or `Spud::AccessDeniedError` error at any time to halt further execution and cause the error page to render. For example:
 
@@ -175,6 +175,38 @@ A common case is to have a model in your app that `belongs_to :spud_user`. The `
       <%= f.tb_save_buttons('Widget', widgets_path) %>
     <% end %>
 
+Table Sorting
+-------------
+
+We provide a few tools to assist with sorting tables of data backed by ActiveRecord queries. In your view, the `tb_table_header` helper method will generate a `<thead>` element with header tags.
+
+### Example
+
+```erb
+<%= tb_table_header :users_path do |t| %>
+  <%= t.sortable :full_name %>
+  <%= t.sortable :email %>
+  <%= t.sortable :birth_date %>
+  <%= t.header :favorite_color %> # Header without sorting
+  <th>Plain HTML is fine too</th>
+<% end %>
+```
+
+On the controller side, you can choose to deal with the `:dir` and `:sort` params using your own custom logic, or you can use the `SortableParams` module.
+
+```ruby
+include TbCore::SortableParams
+
+sortable_by :email,                               # A basic sort
+            full_name: [:last_name, :first_name], # This will sort on two columns
+            birth_date: 'birth_dates.date :dir',  # This will sort on a joined table
+            default: :email                       # The sort to use when none is passed
+
+def index
+  MyModel.where(...).order(sortable_query)
+end
+```
+
 Remote Forms
 --------------
 

data/app/assets/javascripts/admin/core/dashboard.js

@@ -1,3 +1,5 @@
+//= require sortable/sortable
+
 (function(){
 
 var badgeInterval;
@@ -46,27 +48,28 @@ var updateBadge = function(badge_id, count) {
 };
 
 var sortableIcons = function(){
-  $(".sortable").sortable({
-    update : function(e, ui) {
+  var element = document.querySelector('.sortable');
+  var sortable = Sortable.create(element, {
+    onUpdate: function() {
       var sortArr = [];
       var index = 0;
-      $(".sortable > div > a").each(function() {
-        sortArr.push($(this).attr('href'));
-      });
-      //save the order to userSettings
-      $.ajax('/admin/change_sort', { 
-        method: 'PUT', 
-        data: {order:sortArr}, 
-        dataType: "json",
-        success: function(data, status, jqXHR) {
-
-        },
-        error: function(XMLHttpRequest, textStatus, errorThrown) { 
-            alert("Status: " + textStatus); alert("Error: " + errorThrown); 
-        }       
+      document.querySelectorAll('.sortable > div > a').forEach(function(element){
+        sortArr.push(element.getAttribute('href'));
       });
+      saveOrder(sortArr);
     }
   });
 };
 
+function saveOrder(sortArray) {
+  $.ajax('/admin/change_sort', {
+    method: 'PUT',
+    data: { order: sortArray },
+    dataType: "json",
+    error: function(XMLHttpRequest, textStatus, errorThrown) {
+      console.error('Saving sort order failed:', arguments);
+    }
+  });
+}
+
 })();