tb_core 1.1.10 → 1.2.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZjBkMzVhN2EyNDg1MmJkZjk1ZDdhOTBhOWUzZWM2Y2FjZGM0ZTY1MQ==
-  data.tar.gz: !binary |-
-    MmRiZjAxMjg4ZmNiNDZjNjRmZDEwZTM3ZTJjZDg1ZTk0MWY5OTA4Nw==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    YjZjZTJjYzMyYWI0ZDU3NjViYzYwOTU0Mjk3MDQxNmMyMGY5NWJkYTU3YjVi
-    NTNhYzgwNTJiNDhiNmYwNDEzYjYyZTQxNDRmMDlhMTkyNzUzZGM2OTk5YTgx
-    NDExNzg0NDRlMDM2MzI4OGY2MjU0YzBkNzVhMmNmMGEwNDhjNDM=
-  data.tar.gz: !binary |-
-    NDg0MzgyNzllZjEwZTIzMTdmYjk2OTcwOGM2MGM2OWUxZDVhMDU0M2EzYzFh
-    MmJiMTk0NGQ2YmViOWM1Yzk0YTRjY2RkZDIxZGVjYTQ4YWY5MTMwYmQxY2M4
-    MTk0MDg1NzIzMTI0ZjZmM2ZlOGI5NzI1NzZhYzUzN2VkZTUyNTE=
+SHA1:
+  metadata.gz: 82e2cb963cff65ecfe9bce4a017ef9e7db5d8078
+  data.tar.gz: 366d9efb54c2822b29f656ba96b69786695e41a1
+SHA512:
+  metadata.gz: 39d98a5216017a2cd7c338ca3a462032e917b2776212792c1afe6e0fa196df88963c065264b519189156c3002000a3b880afd2532e3095ec0228b3c90017b483
+  data.tar.gz: 7cbf045bb40e1abb89c5d1bd8b0d171d0688282e61173890f3952d43f614a56dec3c2421234d4b28fb8c5df81c98b66bbe5d246baade90ec06338d40d351fb13

data/README.md

@@ -1,13 +1,21 @@
 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. 
+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.
+
+Requirements
+-----------
+
+TB Core 1.2.x and higher requires Rails 4 and is developed using Ruby 2.1. Lower versions of Ruby may continue to work but are not heavily tested.
+
+For Rails 3 compatiblity, stick to TB Core 1.1.x.
 
 Installation/Usage
 ------------------
 
 1. In your Gemfile add the following
 
+        gem 'authlogic', :github => 'binarylogic/authlogic', :ref => 'abc09970ed1fad98c6c12f4ca64d1670d37d11db'
         gem 'tb_core'
 
 2. Run bundle install
@@ -18,6 +26,7 @@ Installation/Usage
 
 4. run a rails server instance and point your browser to /admin
 
+**Note about Authlogic:** The version of Authlogic up on Rubygems.org at the time of this writing is not fully compatible with Rails 4. Until an improved version is released, we are pointing to a more recent commit that contains various Rails 4 fixes.
 
 Setup Tasks
 -----------
@@ -42,7 +51,7 @@ The core engine provides various configuration options.
 - `site_name`: Controls the site name displayed in the dashboard and `tb_page_title` view helper.
 - `from_address`: Sender address used for password resets and other mailers.
 - `not_found_template`: ERB template used for 404 exceptions. Defaults to `layouts/not_found`.
-- `production_alert_domain`: When set, displays a prominent warning bar in the admin dashboard directing users to the production domain. Intended for staging websites. ex: `www.westlakedesign.com`.
+- `production_alert_domain`: When set, displays a prominent warning bar in the admin dashboard directing users to the production domain. You should only set this value in `config/environments/staging.rb`.
 
 Adding Apps to the Dashboard
 ----------------------------
@@ -97,6 +106,45 @@ Finally, custom permissions may optionally be tied to one or more dashboard apps
       :apps => [:clients, :projects]
     }]  
 
+Extending the User Model
+------------------------
+
+A common requirement is to add custom fields and functionality to the base `spud_user` model. We have provided several spots where you can do this.
+
+### Adding custom methods and attributes to the SpudUser class
+
+Create a file in your app at `app/models/spud_user.rb`, and build a class called `SpudUser` that extends from `Spud::SpudUserModel`. You do not need any explicit requires - the autoloader will take care of the rest.
+
+    class SpudUser < Spud::SpudUserModel
+      has_attached_file :avatar
+      attr_accessible :avatar
+      def say_hello
+        return "Hello, World!"
+      end
+    end
+
+### Adding fields to the add/edit user form
+
+Create a file in your app at `app/views/admin/users/_form_additions.html.erb`. 
+
+    <div class="control-group">
+      <%= f.label :avatar, :class=>"control-label"%>
+      <div class="controls">
+        <%= f.file_field :avatar %>
+      </div>  
+    </div>
+
+### Adding fields to the user show action
+
+Create a file in your app at `app/views/admin/users/_show_additions.html.erb`. 
+
+    <% if @user.avatar_file_name %>
+      <dt>Avatar</dt>
+      <dd>
+        <%= image_tag @user.avatar.url(:thumb) %>
+      </dd>
+    <% end %>
+
 404 Handling
 ------------
 

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

@@ -1,8 +1,8 @@
 //= require jquery
 //= require jquery_ujs
 //= require admin/core/preinit
-//= require tiny_mce/jquery.tinymce.js
-//= require tiny_mce/tiny_mce_src.js
+//= require tinymce-jquery
+//= require tinymce/plugins/tableDropdown/editor_plugin
 //= require bootstrap/js/bootstrap
 //= require datepicker/js/bootstrap-datepicker
 //= require jquery-ui/js/jquery-ui-1.9.1.custom

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

@@ -95,6 +95,7 @@ spud.admin.editor = {};
 
     $(element).tinymce({
       theme: theme,
+      language: 'en',
       plugins: registeredPlugins.join(','),
       theme_advanced_toolbar_location: "top",
       theme_advanced_buttons1: buttons[0].join(','),

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

@@ -1 +1 @@
-window.tinyMCEPreInit = {base: "/assets/tiny_mce", suffix:''};
+//window.tinyMCEPreInit = {base: "/assets/tiny_mce", suffix:''};

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

@@ -134,5 +134,9 @@ spud.admin.SplitPane = (function(){
     this.leftPane.html(html);
   };
 
+  SplitPane.prototype.find = function(selector){
+    return this.contentArea.find(selector);
+  };
+
   return SplitPane;
 })();

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

@@ -11,11 +11,15 @@ spud.admin.users = {
     $('.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);
+    if(typeof(FormData) != 'undefined'){
+      _html5Upload = true;
+    }
   }
 };
 
 var _userHtmlCache;
 var _previouslySelected;
+var _html5Upload;
 
 var clickedAddEditUser = function(e){
   e.preventDefault();
@@ -32,6 +36,11 @@ var clickedAddEditUser = function(e){
     success:function(html){
       splitPane.setContentAreaHtml(html);
       splitPane.setToolbarTitle(title);
+      if(!_html5Upload){
+        splitPane.find('input[type=file]').each(function(){
+          $(this).replaceWith('<em>File upload requires an HTML5-capable browser.</em>');
+        });
+      }
     }
   });
 };
@@ -61,18 +70,56 @@ 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 submit = form.find('input[type=submit]');
+  submit.val(submit.attr('data-loading-text')).attr('disabled', true);
+
+  if(_html5Upload){
+    var fd = new FormData();
+    form.find('input, select').each(function(i, input){
+      input = $(input);
+      var name = input.prop('name');
+      var type = input.attr('type');
+      if(type == 'file'){
+        var file = input[0].files[0];
+        if(file !== undefined){
+          fd.append(name, file);
+        }
+      }
+      else if(type == 'checkbox'){
+        if(input.is(':checked')){
+          fd.append(name, input.val());
+        }
+      }
+      else{
+        fd.append(name, input.val());
+      }
+    });
+    var xhr = new XMLHttpRequest();
+    xhr.addEventListener('load', function(e){
+      splitPane.setContentAreaHtml(e.target.response);
+      if(this.status >= 200 && this.status < 400){
+        splitPane.refreshList();
+      }
+    });
+    xhr.open('POST', url);
+    xhr.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
+    xhr.send(fd);
+  }
+  else{
+    $.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){

data/app/assets/libs/bootstrap/css/{bootstrap.css → bootstrap.css.scss}

@@ -1,12 +1,12 @@
-/*!
- * Bootstrap v2.2.1
- *
- * Copyright 2012 Twitter, Inc
- * Licensed under the Apache License v2.0
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Designed and built with all the love in the world @twitter by @mdo and @fat.
- */
+//
+//Bootstrap v2.2.1
+//
+//Copyright 2012 Twitter, Inc
+//Licensed under the Apache License v2.0
+//http://www.apache.org/licenses/LICENSE-2.0
+//
+//Designed and built with all the love in the world @twitter by @mdo and @fat.
+//
 
 article,
 aside,
@@ -2151,7 +2151,7 @@ table th[class*="span"],
   *margin-right: .3em;
   line-height: 14px;
   vertical-align: text-top;
-  background-image: url("/assets/bootstrap/img/glyphicons-halflings.png");
+  background-image: image-url("bootstrap/img/glyphicons-halflings.png");
   background-position: 14px 14px;
   background-repeat: no-repeat;
 }
@@ -2171,7 +2171,7 @@ table th[class*="span"],
 .dropdown-menu > .active > a > [class*=" icon-"],
 .dropdown-submenu:hover > a > [class^="icon-"],
 .dropdown-submenu:hover > a > [class*=" icon-"] {
-  background-image: url("/assets/bootstrap/img/glyphicons-halflings-white.png");
+  background-image: image-url("bootstrap/img/glyphicons-halflings-white.png");
 }
 
 .icon-glass {

data/app/controllers/admin/application_controller.rb

@@ -39,7 +39,6 @@ private
     if(session[:admin_site] == nil)
       session[:admin_site] = 0
     end
-
   end
 
   def multisite_caching

data/app/controllers/admin/roles_controller.rb

@@ -7,7 +7,7 @@ class Admin::RolesController < Admin::ApplicationController
   add_breadcrumb "Roles", :admin_roles_path
 
   def index
-    @roles = SpudRole.all
+    @roles = SpudRole.includes(:spud_role_permissions)
     respond_with @roles
   end
   
@@ -21,7 +21,9 @@ class Admin::RolesController < Admin::ApplicationController
   end
   
   def create
-    @role = SpudRole.new(params[:spud_role])
+    logger.debug 'role_params:'
+    logger.debug role_params
+    @role = SpudRole.new(role_params)
     flash[:notice] = 'SpudRole created successfully' if @role.save
     respond_with @role, :location => admin_roles_path
   end
@@ -31,8 +33,8 @@ class Admin::RolesController < Admin::ApplicationController
   end
   
   def update
-    params[:spud_role][:permission_tags] ||= []
-    if @role.update_attributes(params[:spud_role])
+    #role_params[:permission_tags] ||= []
+    if @role.update_attributes(role_params)
       flash[:notice] = 'SpudRole updated successfully'
     end
     respond_with @role, :location => admin_roles_path
@@ -55,4 +57,8 @@ class Admin::RolesController < Admin::ApplicationController
     end
   end
 
+  def role_params
+    params.require(:spud_role).permit(:name, :permission_tags => [])
+  end
+
 end

data/app/controllers/admin/settings_controller.rb

@@ -14,10 +14,18 @@ class Admin::SettingsController < Admin::ApplicationController
   end
 
   def update
-    if @current_user.update_attributes(params[:spud_user].slice :login,:first_name,:last_name,:email,:password,:password_confirmation,:time_zone)
+    if @current_user.update_attributes(user_params)
       flash[:notice] = "User settings saved successfully."
+      respond_with @current_user, :location => admin_settings_path
+    else
+      render 'edit'  
     end
-    render 'edit'
+  end
+
+private
+
+  def user_params
+    params.require(:spud_user).permit(:login, :first_name, :last_name, :email, :password, :password_confirmation, :time_zone)
   end
 
 end

data/app/controllers/admin/setup_controller.rb

@@ -12,7 +12,7 @@ class Admin::SetupController < Admin::ApplicationController
   end
 
   def create
-    @spud_user = SpudUser.new(params[:spud_user])
+    @spud_user = SpudUser.new(user_params)
     @spud_user.super_admin = true
     if @spud_user.save
       redirect_to admin_root_path
@@ -21,4 +21,10 @@ class Admin::SetupController < Admin::ApplicationController
     end
   end
 
+private
+
+  def user_params
+    params.require(:spud_user).permit(:login, :email, :password, :password_confirmation)
+  end
+
 end

data/app/controllers/admin/users_controller.rb

@@ -33,7 +33,7 @@ class Admin::UsersController < Admin::ApplicationController
   end
 
   def create
-    @user = SpudUser.new(params[:spud_user], :as => :admin)
+    @user = SpudUser.new(user_params)
     if @user.save
       render 'show', :status => 200
     else
@@ -46,7 +46,7 @@ class Admin::UsersController < Admin::ApplicationController
   end
 
   def update
-    @user.update_attributes(params[:spud_user], :as => :admin)
+    @user.update_attributes(user_params)
     respond_with @user, :location => admin_user_path(@user), :status => 200
   end
 
@@ -66,4 +66,10 @@ private
     return true
   end
 
+  # attr_accessible :login,:email,:first_name,:last_name,:password,:password_confirmation,:password_salt,:last_login_at,:last_request_at,:last_login_ip,:failed_login_count,:current_login_at,:login_count,:persistence_token,:perishable_token,:single_access_token,:crypted_password, :current_login_ip, :created_at, :updated_at,:time_zone, :as => [:default, :admin]
+  # attr_accessible :super_admin, :spud_role_id, :id, :as => :admin
+  def user_params
+    params.require(:spud_user).permit!
+  end
+
 end

data/app/controllers/sitemaps_controller.rb

@@ -1,6 +1,5 @@
 class SitemapsController < Spud::ApplicationController
   respond_to :xml
-  caches_page :show,:expires_in => 1.day
   def show
     @sitemap_urls = Spud::Core.sitemap_urls
     respond_with @sitemap_urls

data/app/controllers/spud/application_controller.rb

@@ -1,8 +1,7 @@
 class Spud::ApplicationController < ActionController::Base
 
-  unloadable
   protect_from_forgery
-  helper_method :current_user_session, :current_user
+  helper_method :current_user_session, :current_user, :current_user_id
   around_filter :set_time_zone
 
   if Spud::Core.multisite_mode_enabled
@@ -33,6 +32,14 @@ private
     @current_user = current_user_session && current_user_session.spud_user
   end
 
+  def current_user_id
+    if @current_user
+      return @current_user.id
+    else
+      0
+    end
+  end
+
   def require_user
     unless current_user
       store_location

data/app/helpers/spud/application_helper.rb

@@ -24,4 +24,25 @@ module Spud::ApplicationHelper
     return config[:site_id] unless config.blank?
   end
 
+  def cache_key_for_spud_collection(collection, key:'view', cache_params:[], for_user:false)
+    cache_keys = [controller_name, action_name, key]
+    cache_keys << collection.collect(&:updated_at).max().try(:utc).try(:to_i)
+    if for_user
+      cache_keys << current_user_id
+    end
+    if cache_params.any?
+      cache_keys += cache_params.collect{ |cache_param| params[cache_param] || 'nil' }
+    end
+    if Spud::Core.multisite_mode_enabled
+      cache_keys.unshift(current_site_id)
+    end
+    cache_keys += collection.collect(&:id)
+    cache_key = cache_keys.join('/')
+    if cache_key.length > 250
+      return Digest::SHA1.hexdigest(cache_key)
+    else
+      return cache_key
+    end
+  end
+
 end

data/app/models/spud/spud_user_model.rb

@@ -0,0 +1,79 @@
+class Spud::SpudUserModel < ActiveRecord::Base
+  self.table_name = 'spud_users'
+  acts_as_authentic
+
+  belongs_to :role, :class_name => 'SpudRole', :foreign_key => 'spud_role_id'
+  has_many :spud_user_settings
+
+  def full_name
+    if first_name.blank? && last_name.blank?
+      return self.login
+    end
+    if self.first_name.blank?
+      return self.last_name
+    elsif self.last_name.blank?
+      return self.first_name
+    end
+    return "#{self.first_name} #{self.last_name}"
+  end
+
+  # Returns true if user can view at least one dashboard app
+  def has_admin_rights?
+    if self.super_admin?
+      return true
+    else
+      return Spud::Core.admin_applications.find{ |app| self.can_view_app?(app) }.present?
+    end
+  end
+
+  # Returns true if the user can view a spud app based on it's key
+  def can_view_app?(admin_application)
+    if self.super_admin?
+      return true
+    else
+      key = admin_application[:key]
+      return self.permissions.find{ |p| p.apps.include?(key) }.present?
+    end
+  end
+
+  # Check if a user has a given list of permissions
+  #
+  # * if one tag is supplied, return true if the tag matches
+  # * if multiple tags are supplied, return true if ALL tags match
+  def has_permission?(*tags)
+    if self.super_admin?
+      return true
+    else
+      my_tags = self.permissions.collect(&:tag)
+      return tags.find{ |tag| !my_tags.include?(tag) }.blank?
+    end
+  end
+
+  # Check if a user has at least one out of a given list of permissions
+  #
+  # * if one tag is supplied, return true if the tag matches
+  # * if multiple tags are supplied, return true if ANY tag matches
+  def has_any_permission?(*tags)
+    if self.super_admin?
+      return true
+    else
+      return self.permissions.find{ |p| tags.include?(p.tag) }.present?
+    end
+  end
+
+  # Return a list of SpudPermission objects for the user's SpudRole
+  def permissions
+    if !self.role
+      return []
+    else
+      return self.role.permissions
+    end
+  end
+
+  # Returns an ActiveRecord::Relation performing a LIKE query against name columns
+  def self.where_name_like(string)
+    like = '%' + string + '%'
+    return self.where('login like ? or concat(`first_name`, " ", `last_name`) like ?', like, like)
+  end
+
+end

data/app/models/spud_role.rb

@@ -1,5 +1,4 @@
 class SpudRole < ActiveRecord::Base
-  attr_accessible :name, :permission_tags
 
   has_many :spud_role_permissions, :dependent => :destroy
   has_many :users, :class_name => 'SpudUser'

data/app/models/spud_role_permission.rb

@@ -1,5 +1,4 @@
 class SpudRolePermission < ActiveRecord::Base
-  attr_accessible :spud_permission_tag, :spud_role_id, :tag
   belongs_to :spud_role
 
   def permission

data/app/models/spud_user.rb

@@ -1,81 +1,3 @@
-class SpudUser < ActiveRecord::Base
-  include Concerns::SpudAuthentication
-
-  belongs_to :role, :class_name => 'SpudRole', :foreign_key => 'spud_role_id'
-  has_many :spud_user_settings
-
-  attr_accessible :login,:email,:first_name,:last_name,:password,:password_confirmation,:password_salt,:last_login_at,:last_request_at,:last_login_ip,:failed_login_count,:current_login_at,:login_count,:persistence_token,:perishable_token,:single_access_token,:crypted_password, :current_login_ip, :created_at, :updated_at,:time_zone, :as => [:default, :admin]
-  attr_accessible :super_admin, :spud_role_id, :id, :as => :admin
-
-  def full_name
-    if first_name.blank? && last_name.blank?
-      return self.login
-    end
-    if self.first_name.blank?
-      return self.last_name
-    elsif self.last_name.blank?
-      return self.first_name
-    end
-    return "#{self.first_name} #{self.last_name}"
-  end
-
-  # Returns true if user can view at least one dashboard app
-  def has_admin_rights?
-    if self.super_admin?
-      return true
-    else
-      return Spud::Core.admin_applications.find{ |app| self.can_view_app?(app) }.present?
-    end
-  end
-
-  # Returns true if the user can view a spud app based on it's key
-  def can_view_app?(admin_application)
-    if self.super_admin?
-      return true
-    else
-      key = admin_application[:key]
-      return self.permissions.find{ |p| p.apps.include?(key) }.present?
-    end
-  end
-
-  # Check if a user has a given list of permissions
-  #
-  # * if one tag is supplied, return true if the tag matches
-  # * if multiple tags are supplied, return true if ALL tags match
-  def has_permission?(*tags)
-    if self.super_admin?
-      return true
-    else
-      my_tags = self.permissions.collect(&:tag)
-      return tags.find{ |tag| !my_tags.include?(tag) }.blank?
-    end
-  end
-
-  # Check if a user has at least one out of a given list of permissions
-  #
-  # * if one tag is supplied, return true if the tag matches
-  # * if multiple tags are supplied, return true if ANY tag matches
-  def has_any_permission?(*tags)
-    if self.super_admin?
-      return true
-    else
-      return self.permissions.find{ |p| tags.include?(p.tag) }.present?
-    end
-  end
-
-  # Return a list of SpudPermission objects for the user's SpudRole
-  def permissions
-    if !self.role
-      return []
-    else
-      return self.role.permissions
-    end
-  end
-
-  # Returns an ActiveRecord::Relation performing a LIKE query against name columns
-  def self.where_name_like(string)
-    like = '%' + string + '%'
-    return self.where('login like ? or concat(`first_name`, " ", `last_name`) like ?', like, like)
-  end
-
+class SpudUser < Spud::SpudUserModel
+  # Copy this file to your app to extend the base SpudUser model
 end

data/app/views/admin/roles/index.html.erb

@@ -5,11 +5,12 @@
 <% end %>
 
 <% content_for :detail do %>
-  <table class="admin-table data-table">
+  <table class="table table-striped">
     <thead>
       <tr>
         <th>Name</th>
         <th># Users</th>
+        <th>Permissions</th>
         <th></th>
       </tr>
     </thead>
@@ -18,9 +19,10 @@
         <tr>
           <td><%= role.name %></td>
           <td><%= role.users.count %></td>
+          <td><%= role.permissions.collect(&:name).join(', ') %></td>
           <td align="right">
             <%= link_to 'Edit', edit_admin_role_path(role), :class => 'btn btn-mini' %>
-            <%= link_to 'Delete', admin_role_path(role), :method => :delete, :confirm => 'Are you sure?', :class => 'btn btn-mini btn-danger' %>
+            <%= link_to 'Delete', admin_role_path(role), :method => :delete, :data => {:confirm => 'Are you sure?'}, :class => 'btn btn-mini btn-danger' %>
           </td>
         </tr>
       <% end %>