tb_core 1.0.2 → 1.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NmE1NDdlYjE0ZWE1MTk0MmE4YTUxMTExMTQwODRkNDc3YmFmNGI4NQ==
+    ZjlmZmMzMTQ5NGI5MWM2MDRjMDdkMzkxNzJiYWFiODE4MjRiYjA0YQ==
   data.tar.gz: !binary |-
-    MDZmZjRjYmIzNDEzNjI1YzZmOGM1ZjFhMTNjMTBmYTAzN2M1M2E2ZQ==
+    ODI3MTc1Y2FjZmNkMTFjOTkxZmEzN2ZiZGRmNWJmYzAwOWNiOWJlYw==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    NmQ2MzE0NjUxODNkYWRkNzdlMGQwMWEzMGEyNTU3NjM3Yzk0MDE1OTQxNGE0
-    NzRmNzMyNTE2MzVhOGU3Njc2OTllMTM4YjVkOTJhNjM2ZTBmMDQ1YTMzMTVh
-    NTM5M2E5NTY4OTY2MTRjODg5N2FjNzgxMjY1YTkyNDM5Y2Y5MmU=
+    MzlmNjE1YjA3N2ZmOGIzYjgwOTIzYjIwNmM2YjY3NDcyNmQ2ZGMxN2M4NjM2
+    MDk0N2Y5YjMyMjdkMjY0MWE0Y2MwZDJhNmM0NTU3OWNlYWUwYjY2YjY5ZDgw
+    NDZjMjgxNjBhYWViZjVhMzk1NzBkOGZjN2E5NTYxODZkMTBiY2E=
   data.tar.gz: !binary |-
-    ZTc3OTZhZWU5OTBmZTRiZjAxNWZmMGYwZjc3MTExZDkxNGFmMjVmYmMwZjMx
-    MGNiY2ZmYjE3ZGM2MTA3YjVmZjg3N2YyOTA4MThjOTI0OGE1NDFkYWRiZThj
-    NzZmNDUwYTI3YWM2ZjczYmIzNzZiNjdjM2MzZDhjODFiMmQ3ZmI=
+    NWQwMWEyZTcxODBiOTQyZjI2NjhjNjA0Mzg0YmJiMWY5ODBjNTllNzExOGRl
+    ZjZlNTU1NjY1MjhlNGE5ZTVjMWY5MTcyZmJkYjA0OGJmYzIyM2UxNTBlYjdh
+    MTIyYzkyOWM4ZGNkZWI0Y2FiODliOGI5YzVlZDJjZWQ5OTMxYTE=

data/README.md

@@ -0,0 +1,89 @@
+Twice Baked Core
+================
+
+TB Core is the base Twice Baked engine that provides user authentication, roles, and an admin dashboard upon which CRUD apps can be built. Use TB Core to power content-managed websites or as a quick-and-simple way to add a backend to your existing data models. 
+
+Installation/Usage
+------------------
+
+1. In your Gemfile add the following
+
+        gem 'tb_core'
+
+2. Run bundle install
+3. Copy in database migrations to your new rails project
+
+    bundle exec rake tb_core:install:migrations
+    rake db:migrate
+
+4. run a rails server instance and point your browser to /admin
+
+
+Adding Apps to the Dashboard
+----------------------------
+
+Admin apps can be added via the `Spud::Core.config.admin_applications` array. We recommend you perform this action in either an initializer or within your `application.rb` file. 
+
+    Spud::Core.config.admin_applications += [{
+      :name => "Clients",
+      :thumbnail => "spud/admin/clients.png",
+      :url => "/admin/clients"
+    }]
+
+Build out your RESTful controller and views like you normally would in any Rails app. Extend your controller from `Admin::ApplicationController` in order to inherit the default admin behaviors, and look at the core admin controllers for example implementations. 
+
+Roles & Permissions
+-------------------
+
+A user can be assigned to a role, which itself has one or more permissions. These permissions serve two distinct purposes: Determining what dashboard apps a user has access to (if any), and being used within your application logic to establish fine-grained user abilities.
+
+Checking permissions is easy. Each permission has a `tag` which is a unique, namespaced identifier. Use the `has_permission?` and `has_any_permission?` methods on the user object to check for their existence. Keep in mind that these calls will always return true for users who have the `super_admin` flag set.
+
+    if !@spud_user.has_permission?('my_website.clients.my_clients')
+      redirect_to root_path, :notice => 'Permission Denied!'
+    end
+
+Permissions are created one of two ways:
+
+1. Every dashboard app automatically generates a "Full Access" permission, with a tag of `admin.(app name).full_access`. 
+2. You as the developer may append custom permissions to the `Spud::Core.permissions` array. 
+
+Create custom permissions whenever you need to permit an action that falls outside of the standard "full access to an app" use case; For example, turning on/off the ability for a user to upload an avatar.
+
+    // application.rb
+    Spud::Core.permissions += [
+      {:tag => 'my_website.profile.avatar', :name => 'Upload an avatar to my profile'}
+    ]
+    // some_view.html.erb
+    <% if current_user.has_permission?('my_website.profile.avatar') %>
+      <%= link_to 'Upload Avatar', upload_avatar_path %>
+    <% end %>
+
+Finally, custom permissions may optionally be tied to one or more dashboard apps. A user who has the permission shown below would have access to the the Clients and Projects dashboard apps. After that is is up to you to code your view and controller logic in accorance to what permissions the user has. 
+
+    // application.rb
+    Spud::Core.permissions += [{
+      :tag => 'my_website.projects.project_management',
+      :name => 'Manage clients and projects, but cannot delete them or view private info',
+      :apps => [:clients, :projects]
+    }]  
+
+Testing
+-----------------
+
+Twice Baked uses RSpec for testing. Get the tests running with a few short commands:
+
+1. Create and migrate the databases:
+   
+        rake db:create
+        rake db:migrate
+
+2. Load the schema in to the test database:
+
+        rake app:db:test:prepare
+
+3. Run the tests with RSpec
+
+        rspec spec
+
+After the tests have completed the current code coverage stats is available by opening `/coverage/index.html` in a browser.

data/app/assets/javascripts/{spud/admin → admin}/application.js

@@ -1,9 +1,8 @@
 //= require jquery
 //= require jquery_ujs
-//= require spud/admin/preinit
+//= require admin/preinit
 //= require tiny_mce/jquery.tinymce.js
 //= require tiny_mce/tiny_mce_src.js
-//= require spud/admin/jquery.dataTables.min
 //= require bootstrap/js/bootstrap
 //= require datepicker/js/bootstrap-datepicker
 //= require jquery-ui/js/jquery-ui-1.9.1.custom
@@ -25,11 +24,6 @@ $(document).ready(function() {
 
   spud.admin.editor.init();
 
-    // $('#user_table').dataTable({
-    //   "bJQueryUI": true,
-    //   "sPaginationType": "full_numbers"
-    // });
-
     $("#modal_window .modal-footer .form-submit").bind('click', function() {
       $("#modal_window .modal-body form").submit();
     });

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

@@ -0,0 +1,9 @@
+(function(){
+
+spud.admin.dashboard = {
+	init:function(){
+
+	}
+};
+
+})();

data/app/assets/javascripts/admin/split_pane.js

@@ -0,0 +1,138 @@
+spud.admin.SplitPane = (function(){
+
+  function SplitPane(selector){
+    var container = this.container = $(selector);
+    this.rightPane = container.find('.split-pane-right');
+    this.leftPane = container.find('.split-pane-left');
+    this.contentArea = container.find('.split-pane-right-content');
+    this._listUrl = window.location.pathname;
+    container.on('click', '.split-pane-item', this, clickedItem);
+    container.on('click', '.pagination a', this, clickedPageLink);
+    container.on('submit', '.split-pane-search-form', this, submittedSearchForm);
+    container.on('click', '.split-pane-search-clear-btn', this, clickedClearSearch);
+    container.find('.split-pane-search-clear-btn').hide();
+    this.triggerFirstItem();
+  }
+
+  // Event Handlers
+  /////////////////
+
+  var clickedItem = function(e){
+    var splitPane = e.data;
+    item = $(this);
+    splitPane.setActiveItem(item);
+    url = item.attr('data-url');
+    title = item.attr('data-title') || '';
+    $.ajax(url, {
+      dataType:'html',
+      success:function(html){
+        splitPane.setContentAreaHtml(html);
+        splitPane.setToolbarTitle(title);
+      }
+    });
+  };
+
+  var clickedPageLink = function(e){
+    e.preventDefault();
+    var splitPane = e.data;
+    var url = $(this).attr('href');
+    splitPane.refreshList(url, function(){
+      splitPane.triggerFirstItem();
+    });
+  };
+
+  var clickedClearSearch = function(e){
+    e.preventDefault();
+    var splitPane = e.data;
+    $('.split-pane-search-form input').val('');
+    var btn = $(this);
+    btn.hide();
+    splitPane.refreshList(btn.attr('href'));
+  };
+
+  var submittedSearchForm = function(e){
+    e.preventDefault();
+    var splitPane = e.data;
+    splitPane.container.find('.split-pane-search-clear-btn').show();
+    var form = $(this);
+    var url = form.attr('action') + '?' + form.serialize();
+    splitPane.refreshList(url);
+  };
+
+  // Instance Methods
+  ///////////////////
+
+  SplitPane.prototype.refreshList = function(url, callback){
+    if(typeof(url) != 'undefined'){
+      this._listUrl = url;
+    }
+    var activeId = this.getActiveItem().attr('data-id');
+    var self = this;
+    $.ajax(this._listUrl, {
+      success:function(html){
+        self.setLeftSideHtml(html);
+        var originalItem = self.leftPane.find('[data-id='+activeId+']');
+        if(originalItem.length){
+          self.setActiveItem(originalItem);
+        }
+        if(typeof(callback) == 'function'){
+          callback.call(self);
+        }
+      }
+    });
+  };
+
+  SplitPane.prototype.setActiveItem = function(item){
+    this.deselectActiveItem();
+    item.addClass('split-pane-item-selected');
+  };
+
+  SplitPane.prototype.getActiveItem = function(){
+    return this.container.find('.split-pane-item-selected');
+  };
+
+  SplitPane.prototype.deselectActiveItem = function(){
+    this.getActiveItem().removeClass('split-pane-item-selected');
+  };
+
+  SplitPane.prototype.triggerFirstItem = function(){
+    this.container.find('.split-pane-item').first().click();
+  };
+
+  SplitPane.prototype.setToolbarTitle = function(title){
+    if(typeof(title) == 'undefined'){
+      title = '';
+    }
+    this.container.find('.split-pane-toolbar-title').text(title);
+  };
+
+  SplitPane.prototype.setContentAreaHtml = function(html){
+    this.contentArea.html(html);
+    this.rightPane.scrollTop(0);
+  };
+
+  SplitPane.prototype.getContentAreaHtml = function(){
+    return this.contentArea.html();
+  };
+
+  SplitPane.prototype.removeCurrentlySelectedItem = function(){
+    var activeItem = this.getActiveItem();
+    var sibling = activeItem.next();
+    if(!sibling){
+      sibling = activeItem.prev();
+    }
+    this.getActiveItem().remove();
+    if(sibling){
+      sibling.click();
+    }
+    else{
+      this.setContentAreaHtml('');
+    }
+  };
+
+  SplitPane.prototype.setLeftSideHtml = function(html){
+    this.leftPane.html(html);
+  };
+
+  return SplitPane;
+})();

data/app/assets/javascripts/admin/users.js

@@ -0,0 +1,84 @@
+(function(){
+
+var splitPane;
+
+spud.admin.users = {
+  index: function(){
+    splitPane = new spud.admin.SplitPane('.admin-users-split-pane');
+    $('.admin-user-add-btn').on('click', true, clickedAddEditUser);
+    $('.admin-users-split-pane').on('click', '.admin-user-edit-btn', clickedAddEditUser);
+    $('.admin-users-split-pane').on('click', '.admin-user-edit-cancel-btn', clickedCancelAddEditUser);
+    $('.admin-users-split-pane').on('click', '.admin-user-delete-btn', clickedDeleteUser);
+    $('.admin-users-split-pane').on('submit', '.admin-user-form', submittedUserForm);
+    $('body').on('click', '.split-pane-refresh-btn', clickedRefreshButton);
+  }
+};
+
+var _userHtmlCache;
+var _previouslySelected;
+
+var clickedAddEditUser = function(e){
+  e.preventDefault();
+  _previouslySelected = splitPane.getActiveItem();
+  _userHtmlCache = splitPane.getContentAreaHtml();
+  var isAdd = e.data;
+  if(isAdd){
+    splitPane.deselectActiveItem();
+  }
+  var title = $(this).attr('title');
+  var url = $(this).attr('href');
+  $.ajax(url, {
+    dataType:'html',
+    success:function(html){
+      splitPane.setContentAreaHtml(html);
+      splitPane.setToolbarTitle(title);
+    }
+  });
+};
+
+var clickedCancelAddEditUser = function(e){
+  e.preventDefault();
+  splitPane.setContentAreaHtml(_userHtmlCache);
+  splitPane.setActiveItem(_previouslySelected);
+  splitPane.setToolbarTitle('');
+};
+
+var clickedDeleteUser = function(e){
+  e.preventDefault();
+  var url = $(this).attr('href');
+  $.ajax(url, {
+    dataType:'json',
+    type:'post',
+    data: {_method:'delete'},
+    success:function(html){
+      splitPane.removeCurrentlySelectedItem();
+      splitPane.setToolbarTitle('');
+    }
+  });
+};
+
+var submittedUserForm = function(e){
+  e.preventDefault();
+  var form = $(this);
+  var url = form.attr('action');
+  $.ajax(url, {
+    dataType:'html',
+    type: 'post',
+    data: form.serialize(),
+    success:function(html, textStatus, jqXHR){
+      splitPane.setContentAreaHtml(html);
+      splitPane.refreshList();
+    },
+    error:function(jqXHR, textStatus, errorThrown){
+      splitPane.setContentAreaHtml(jqXHR.responseText);
+    }
+  });
+};
+
+var clickedRefreshButton = function(e){
+  e.preventDefault();
+  splitPane.refreshList();
+};
+
+})();
+

data/app/assets/stylesheets/{spud/admin/application.css → admin/application.css.scss}

@@ -1,10 +1,11 @@
-/* ...
-*= require bootstrap/css/bootstrap
-*= require datepicker/css/datepicker
-*= require jquery-ui/css/flick/jquery-ui-1.9.1.custom
-*= require codemirror
-*= require_self
-*/
+//= require bootstrap/css/bootstrap
+//= require datepicker/css/datepicker
+//= require jquery-ui/css/flick/jquery-ui-1.9.1.custom
+//= require codemirror
+//= require_self
+//= require admin/login
+//= require admin/users
+//= require admin/split_pane
 
 body {
 	background:#eee;
@@ -135,26 +136,26 @@ div.admin_application:hover {
 	height:125px;
 }
 
-#detail_wrapper {
+.detail_wrapper {
 	background:#fff;
 	width:960px;
 	min-height:300px;
 	border-radius:10px;
 	margin:15px auto 0px auto;
 }
-#detail_wrapper h2{
+.detail_wrapper h2{
 	display:block;
 	line-height:50px;
 	color:#333;
 }
-#detail_wrapper .thumb_wrapper {
+.detail_wrapper .thumb_wrapper {
 	display:block;
 	width:50px;
 	height:50px;
 	float:left;
 	margin:0 10px 10px 10px;
 }
-#detail_wrapper h2 img {
+.detail_wrapper h2 img {
 
 	width:100px;
 
@@ -192,35 +193,6 @@ div.admin_application:hover {
 #detail_main {
 	padding-left:5px;
 }
-.dataTables_length {
-	float:left;
-		line-height:22px;
-	font-size:12px;
-	margin-left:5px;
-}
-.dataTables_filter {
-	float:right;
-}
-.dataTables_info {
-	float:left;
-	line-height:22px;
-	font-size:12px;
-	margin-left:5px;
-}
-.dataTables_paginate {
-	float:right;
-}
-.dataTables_paginate .ui-button {
-	padding:2px 5px;
-
-	margin:0 5px;
-}
-.data-table .css_right {
-	position:absolute;
-	right:0;
-	top:1px;
-}
-
 
 
 div.field_with_errors {
@@ -233,7 +205,6 @@ div.field_with_errors {
 }
 div.field_with_errors label {
     color:#F00;
-    /*background: url(/images/icons/error.png) top left no-repeat;*/
 }
 
 
@@ -287,11 +258,11 @@ div.field_with_errors label {
 }
 
 .admin-table th .asc {
-  background-image: url(/assets/spud/admin/up_arrow.gif);
+  background-image: image-url("admin/up_arrow.gif");
 }
 
 .admin-table th .desc {
-  background-image: url(/assets/spud/admin/down_arrow.gif);
+  background-image: image-url("admin/down_arrow.gif");
 }
 
 
@@ -359,27 +330,6 @@ form h2 {
 	height:20px;
 }
 
-/*Flash Styles*/
-div.flash {
-	padding:10px;
-}
-div.flash.notice {
-	background:#99ff99;
-}
-div.flash.warning {
-	background:#FFFACD;
-}
-div.flash.error {
-	background:#ff9999;
-}
-div.flash h2 {
-	color:white !important;
-	font-size:14px !important;
-}
-div.flash ul {
-	color:white !important;
-	font-size:12px !important;
-}
 form input.full-width {
 	display: block;
 	width: 99%;
@@ -394,46 +344,6 @@ form input.full-width {
 	float: right;
 }
 
-#dashboard-editmode {
-	clear:both;
-	background:#ccc;
-	padding:10px;
-	text-align:center;
-	display:none;
-}
-/*Jiggle Animation*/
-.jiggly {
-    -webkit-animation: jiggle 0.2s infinite;
-    -moz-animation-duration: 0.2s;
-    -moz-animation-name: jiggle;
-    -moz-animation-iteration-count: infinite;
-    -webkit-transform: rotate(-1deg);
-    -moz-transform: rotate(-1deg);
-}
-
-.time_select select {
-	width:auto;
-}
-
-@-moz-keyframes jiggle {
-    0% {
-        -moz-transform: rotate(-1deg);
-    }
-    50% {
-        -moz-transform: rotate(1deg);
-    }
-}
-
-@-webkit-keyframes jiggle {
-    0% {
-        -webkit-transform: rotate(-1deg);
-    }
-    50% {
-        -webkit-transform: rotate(1deg);
-    }
-}
-
-
 /*Retina CSS*/
 @media only screen and (-webkit-min-device-pixel-ratio: 1.5),
 	only screen and (-o-min-device-pixel-ratio: 3/2),

data/app/assets/stylesheets/admin/login.css.scss

@@ -0,0 +1,49 @@
+#content_wrapper {
+  position: relative;
+  width: 100%;
+  height: 100%;
+}
+.login-form {
+  width: 460px;
+  margin: 75px auto 0;
+  padding: 0px;
+  color:#000;
+  background: #fff;
+  -webkit-border-radius: 10px;
+  -moz-border-radius: 10px;
+  border-radius:10px;
+  box-shadow: 2px 2px 10px #777;
+  overflow-x: hidden;
+  overflow-y: hidden;
+}
+.login-form h1 {
+  font-size: 28px;
+  margin: 0 0 20px;
+  padding: 10px;
+  background:rgb(199,90,0);
+  background-image: linear-gradient(top, rgb(199,90,0) 5%, rgb(179,72,0) 53%);
+  background-image: -o-linear-gradient(top, rgb(199,90,0) 5%, rgb(179,72,0) 53%);
+  background-image: -moz-linear-gradient(top, rgb(199,90,0) 5%, rgb(179,72,0) 53%);
+  background-image: -webkit-linear-gradient(top, rgb(199,90,0) 5%, rgb(179,72,0) 53%);
+  background-image: -ms-linear-gradient(top, rgb(199,90,0) 5%, rgb(179,72,0) 53%);
+  background-image: -webkit-gradient(
+    linear,
+    left top,
+    left bottom,
+    color-stop(0.05, rgb(199,90,0)),
+    color-stop(0.53, rgb(179,72,0))
+  );
+  color: #fff;
+}
+.login-form .alert{
+  margin: 0 10px;
+}
+.login-form form {
+  margin: 20px;
+}
+.login-form .field-group {
+  margin: 0 0 15px;
+}
+.login-form label {
+  margin: 0 0 5px;
+}