datatables 1.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in datatables.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2004-2011 Caseproof, LLC
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README.rdoc

@@ -0,0 +1,134 @@
+= Datatables
+
+Datatables is a Rails 3 plugin that enables the easy creation of dynamic datatable views on top of any ActiveRecord model. Datatables provides a simple helper that can be utilized in the view to automatically display a dynamic view on top of a model. Datatables handles the entire front end and backend support to do this.
+
+= Installation
+
+To install datatables to your rails project, follow these simple steps:
+
+==== 1. Make sure your project is using the 'jquery-rails' plugin.
+==== 2. Add the following line to your Gemfile:
+  gem 'datatables', :git => 'git://github.com/Caseproof/datatables.git'
+==== 3. Run <b>bundle install</b>
+==== 4. Run <b>rails generate datatables:install</b>
+==== 5. Add the following lines to your layout file after <b>javascript_include_tag :defaults</b>
+  <%= stylesheet_link_tag "datatable_page" %>
+  <%= stylesheet_link_tag "datatable_table" %>
+  <%= javascript_include_tag 'jquery.dataTables.min' %>
+==== 6. Add the Datatable helper mixin to your ApplicationHelper (<b>app/helpers/application_helper.rb</b>) like so:
+  module ApplicationHelper
+    include Datatables::Helpers
+  end
+
+= Example
+
+With datatables it's easy to add rich datatables to your views that correspond with your active record models.
+
+There is a lovely helper that you can use to render your datatable that takes in a whole host of options. Unfortunately, there's still quite a bit of work to do with these options to handle every scenario but here's what it support so far:
+
+== Database table:
+
+The following examples will use the following database table:
+
+  mysql> desc companies;
+  +-------------+--------------+------+-----+---------+----------------+
+  | Field       | Type         | Null | Key | Default | Extra          |
+  +-------------+--------------+------+-----+---------+----------------+
+  | id          | int(11)      | NO   | PRI | NULL    | auto_increment |
+  | name        | varchar(255) | YES  | MUL | NULL    |                |
+  | slug        | varchar(255) | YES  | MUL | NULL    |                |
+  | domain      | varchar(255) | YES  | MUL | NULL    |                |
+  | category_id | int(11)      | NO   | MUL | NULL    |                |
+  | created_at  | datetime     | YES  |     | NULL    |                |
+  | updated_at  | datetime     | YES  |     | NULL    |                |
+  +-------------+--------------+------+-----+---------+----------------+
+
+
+== Standard datatable
+
+The first argument to the datatable helper is the name of the model or an array of model & scope. The second argument is a hash of column names & options.
+
+  <%= datatable('company', { :name => { :type => 'string', 
+                                        :label => 'Name',
+                                        :width => '20%' },
+                             :slug => { :type => 'string',
+                                        :label => 'Slug',
+                                        :width => '15%' },
+                             :domain => { :type => 'string',
+                                          :label => 'Domain',
+                                          :width => '15%' }
+                           }) %>
+
+== Datatable with a link to edit
+
+Note that the edit link path utilizes the :id field in the database table to automatically insert the correct id on a row by row basis:
+
+  <%= datatable('company', { :id => { :type => 'hidden' },
+                             :name => { :type => 'link', 
+                                            :label => 'Name', 
+                                            :link => edit_admin_company_path(:id),
+                                            :replace => 'id',
+                                            :width => '50%' },
+                             :slug => { :type => 'string',
+                                        :label => 'Slug',
+                                        :width => '25%' },
+                             :domain => { :type => 'string',
+                                          :label => 'Domain',
+                                          :width => '25%' }
+                           }) %>
+
+== Scoped datatable (now we're using the 'dot_org_domains' that can be found in the Company model):
+
+  <%= datatable(['company','dot_org_domains'], { :id => { :type => 'hidden' },
+                                                 :name => { :type => 'link', 
+                                                                :label => 'Name', 
+                                                                :link => edit_admin_company_path(:id),
+                                                                :replace => 'id',
+                                                                :width => '50%' },
+                                                 :slug => { :type => 'string',
+                                                            :label => 'Slug',
+                                                            :width => '25%' },
+                                                 :domain => { :type => 'string',
+                                                              :label => 'Domain',
+                                                              :width => '25%' }
+                                               }) %>
+
+== Association columns
+  <%= datatable(['company','dot_org_domains'], { :id => { :type => 'hidden' },
+                                                 :name => { :type => 'link', 
+                                                                :label => 'Name', 
+                                                                :link => edit_admin_company_path(:id),
+                                                                :replace => 'id',
+                                                                :width => '40%' },
+                                                 :slug => { :type => 'string',
+                                                            :label => 'Slug',
+                                                            :width => '20%' },
+                                                 :domain => { :type => 'string',
+                                                              :label => 'Domain',
+                                                              :width => '20%' },
+                                                 :category_name => { :type => 'string',
+                                                                     :label => 'Category',
+                                                                     :column => 'categories.name',
+                                                                     :width => '20%',
+                                                                     :class => 'center' }
+  
+                                               }) %>
+
+= Why use this plugin?
+
+It is the easiest way to integrate dynamic datatables using the jQuery datatables plugin into your rails app.
+
+= Version history
+
+- Version 1.0.0
+  - First Release
+
+= Contribute
+
+If you've got some ideas for datatables let me know and, even better, if you've made some enhancements to the code send me a pull request!
+
+= Support
+
+Bug report? Faulty/incomplete documentation? Feature request? Please post an issue on 'http://github.com/Caseproof/metafy/issues'. If its urgent, please contact me from my website at 'http://blairwilliams.com/contact'
+
+Copyright (c) 2004-2011 Caseproof, LLC, released under the MIT license

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/app/controllers/datatables_controller.rb

@@ -0,0 +1,19 @@
+class DatatablesController < ApplicationController
+  #before_filter :authenticate_user!
+  #load_and_authorize_resource
+  respond_to :json
+
+  def dataset
+    begin
+      model_class = params[:model].classify.constantize
+    rescue NameError
+      render :text => 'Model Not Found', :layout => false
+      return
+    end
+    
+    output = model_class.datatable(params)
+    
+    # Render Encoded JSON
+    render :text => output.to_json, :layout => false
+  end
+end

data/app/views/datatable/_datatable.html.erb

@@ -0,0 +1,163 @@
+<% unless @pptions[:selectable].nil? or !@pptions[:selectable] -%>
+<div id="rd_buttons">
+  <a id="rd_clear_selections" class="rd_disabled">Clear Selections</a>
+  <% unless @pptions[:selectable_actions].nil? -%>
+    <% @pptions[:selectable_actions].each do |sa| %>
+&nbsp;&nbsp;<%= sa %>
+    <% end -%>
+  <% end -%>
+</div>
+<% end -%>
+<table cellpadding="0" cellspacing="0" border="0" class="display" id="rdatatable">
+  <thead>
+    <tr>
+      <% @columns.each_pair do |key,col| -%>
+        <th width="<%= col[:width] %>"><%= col[:label] || key.to_s.humanize %></th>
+      <% end -%>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td colspan="<%= @columns.length.to_s %>" class="dataTables_empty">Loading...</td>
+    </tr>
+  </tbody>
+  <tfoot>
+    <tr>
+      <% @columns.each_pair do |key,col| -%>
+        <th><input type="text" name="search_<%= key.to_s %>" value="Search <%= col[:label] || key.to_s.humanize %>" class="search_init" rel="<%= @columns.keys.index(key) %>" /></th>
+      <% end -%>
+    </tr>
+  </tfoot>
+</table>
+
+<%= javascript_tag :defer => 'defer' do -%>
+  var asInitVals = new Array();
+  
+<% unless @pptions[:selectable].nil? or !@pptions[:selectable] -%>
+  var gaiSelected = [];
+  
+  function rd_toggle_buttons() {
+    if( gaiSelected.length > 0 )
+    {
+      jQuery("#rd_buttons a").removeClass('rd_disabled');
+      jQuery("#rd_buttons a").addClass('rd_enabled');
+    }
+    else
+    {
+      jQuery("#rd_buttons a").removeClass('rd_enabled');
+      jQuery("#rd_buttons a").addClass('rd_disabled');
+    }
+  }
+<% end -%>
+
+  function rd_bulk_edit_users() {
+    if( jQuery('#rd_bulk_edit_users').hasClass('rd_enabled') )
+    {
+      jQuery.prettyPhoto.open('/admin/projects/<%= @id %>/edit_users/' + gaiSelected + '?iframe=true&width=90%&height=90%');
+    }
+  }
+
+  jQuery(document).ready(function() {
+    var oTable = jQuery('#rdatatable').dataTable( {
+
+      /* Custom Options */
+      <% @jsoptions.each_pair do |k,v| -%>
+        "<%= k %>": <%= v %>,
+      <% end -%>
+
+      /* Visible / Hidden columns & Formatting */
+      "aoColumnDefs": [
+        <% @columns.each_pair do |name,attrs| -%>
+          <% if attrs[:type] == 'link' -%>
+            /* <%= name.to_s %> */ {
+              "fnRender": function ( oObj ) {
+                return '<a href="' + "<%= attrs[:link] %>".replace( /<%= attrs[:replace] %>/i, oObj.aData[<%= @columns.keys.index( attrs[:replace].to_sym ) %>] ) + '">' + oObj.aData[<%= @columns.keys.index( name.to_sym ) %>] + '</a>';
+              },
+              "aTargets": [ <%= @columns.keys.index( name ) %> ]
+            }<%= "," unless @columns.keys.last == name %>
+          <% elsif attrs[:type] == 'hidden' -%>
+            /* <%= name.to_s %> */ { "bVisible": false, "aTargets": [ <%= @columns.keys.index( name ) %> ] }<%= "," unless @columns.keys.last == name %>
+          <% else -%>
+            /* <%= name.to_s %> */ { "aTargets": [ <%= @columns.keys.index( name ) %> ] }<%= "," unless @columns.keys.last == name %>
+          <% end -%>
+        <% end -%>
+      ],
+      
+    <% unless @pptions[:selectable].nil? or !@pptions[:selectable] -%>
+      "fnRowCallback": function( nRow, aData, iDisplayIndex ) {
+  			if ( jQuery.inArray(aData[0], gaiSelected) != -1 ) {
+  				jQuery(nRow).addClass('row_selected');
+  			}
+  			return nRow;
+  		},
+    <% end -%>
+
+      /* Boilerplate Options */
+      "sPaginationType": "full_numbers",
+      "aLengthMenu": [[10, 25, 50, 100, 500], [10, 25, 50, 100, 500]],
+      "bProcessing": true,
+      "bServerSide": true,
+      "sAjaxSource": '/rdtable/<%= @modelname %><%= "/#{@col_str}" %><%= @scope.nil? ? '' : "/#{@scope}" %><%= @id.nil? ? '' : "/#{@id}" %>'
+    } );
+    
+  <% unless @pptions[:selectable].nil? or !@pptions[:selectable] -%>
+    jQuery('#rd_clear_selections').click( function () {
+      gaiSelected = [];
+      jQuery("#rdatatable tbody tr").removeClass('row_selected');
+      rd_toggle_buttons();
+    });
+
+  	/* Click event handler */
+  	jQuery('#rdatatable tbody tr').live('click', function () {
+  		var aData = oTable.fnGetData( this );
+  		var iId = aData[0];
+
+  		if ( jQuery.inArray(iId, gaiSelected) == -1 )
+  		{
+  			gaiSelected[gaiSelected.length++] = iId;
+  		}
+  		else
+  		{
+  			gaiSelected = jQuery.grep(gaiSelected, function(value) {
+  				return value != iId;
+  			} );
+  		}
+
+  		jQuery(this).toggleClass('row_selected');
+      rd_toggle_buttons();
+  	} );  
+  <% end -%>
+
+    jQuery("tfoot input").keyup( function () {
+      /* Filter on the column (the index) of this element */
+      oTable.fnFilter( this.value, jQuery(this).attr('rel') );
+      gaiSelected = []; // clear the selection on filter
+      rd_toggle_buttons();
+    } );
+
+    /*
+     * Support functions to provide a little bit of 'user friendlyness' to the textboxes in 
+     * the footer
+     */
+    jQuery("tfoot input").each( function (i) {
+      asInitVals[i] = this.value;
+    } );
+
+    jQuery("tfoot input").focus( function () {
+      if ( this.className == "search_init" )
+      {
+        this.className = "";
+        this.value = "";
+      }
+    } );
+
+    jQuery("tfoot input").blur( function (i) {
+      if ( this.value == "" )
+      {
+        this.className = "search_init";
+        this.value = asInitVals[jQuery("tfoot input").index(this)];
+      }
+    } );
+    
+  } );
+<% end -%>

data/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+  match 'rdtable/:model/:columns' => 'datatables#dataset', :as => 'datatable'
+  match 'rdtable/:model/:columns/:scope' => 'datatables#dataset', :as => 'datatable'
+  match 'rdtable/:model/:columns/:scope/:id' => 'datatables#dataset', :as => 'datatable'
+end

data/datatables.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "datatables"
+  s.version     = "1.0.0"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Blair Williams","Brandon Toone"]
+  s.email       = ["blair@caseproof.com","btoone@gmail.com"]
+  s.homepage    = "http://blairwilliams.com/ruby-on-rails/datatables"
+  s.summary     = %q{Datatables is a Rails 3 plugin that enables the easy creation of dynamic datatable views on top of any ActiveRecord model}
+  s.description = %q{Datatables is a Rails 3 plugin that enables the easy creation of dynamic datatable views on top of any ActiveRecord model. Datatables provides a simple helper that can be utilized in the view to automatically display a dynamic view on top of a model. Datatables handles the entire front end and backend support to do this. }
+
+  s.add_dependency('rails','>= 3.0.3')
+  s.add_dependency('jquery-rails')
+  
+  s.license = 'MIT'
+
+  s.rubyforge_project = "datatables"
+
+  s.files         = `git ls-files`.split("\n")
+  #s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  #s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  #s.require_paths = ["app","config","lib"]
+end

data/lib/datatables.rb

@@ -0,0 +1,5 @@
+module Datatables
+  require 'datatables/engine' if defined?(Rails) && Rails::VERSION::MAJOR == 3
+  require 'datatables/activerecord_methods' if defined?(Rails) && Rails::VERSION::MAJOR == 3
+  require 'datatables/datatable_helpers' if defined?(Rails) && Rails::VERSION::MAJOR == 3
+end

data/lib/datatables/activerecord_methods.rb

@@ -0,0 +1,130 @@
+# Adds the datatable method in ActiveRecord::Base, which sets up the backend for the datatable javascript
+#
+class << ActiveRecord::Base
+  def datatable( params )
+    curr_model = self
+    table_name = curr_model.table_name
+
+    if curr_model.metafied?
+      metas = curr_model.metafied_attrs || []
+    else
+      metas = []
+    end
+
+    sql_opts = { :select => [], :limit => "", :order => "", :joins => [], :conditions => "" }
+    columns = []
+    full_columns = []
+
+    dscope = params[:scope] || nil
+    dcols =  params[:columns].split(',')
+    did =    params[:id]
+
+    dcols.each do |col|
+      col = col.split(':')
+      if col.length > 1 # association (already assumed we're joined within a scope)
+        col_fmt = "`#{col[1].to_s}`.`#{col[2].to_s}`"
+      elsif metas.include? col.first.to_sym
+        col_fmt = "`m_#{col.first.to_s}`.`meta_value`"
+      else
+        col_fmt = "`#{table_name.to_s}`.`#{col.first.to_s}`"
+      end
+
+      columns.push col.first.to_s
+      full_columns.push col_fmt
+      sql_opts[:select].push "#{col_fmt} as #{col.first.to_s}"
+    end
+
+    # Paging
+	  if params['iDisplayStart'] and params['iDisplayLength'] != '-1'
+  	  sql_opts[:limit]  = "#{params['iDisplayStart']},#{params['iDisplayLength']}"
+  	end
+
+    # Ordering
+    if params['iSortCol_0']
+  	  orders = []
+  	  i = 0
+  	  while i < params['iSortingCols'].to_i do
+  	    if params['bSortable_' + params['iSortCol_' + i.to_s]] == "true"
+  	      # Make sure the order works for metafied columns and normal columns
+  	      col = full_columns[ params['iSortCol_' + i.to_s].to_i ]
+  	      orders.push( "#{col} #{params['sSortDir_' + i.to_s]}" )
+  	    end
+  	    i += 1
+  	  end
+  	  sql_opts[:order] = orders.join(", ") unless orders.empty?
+  	end
+
+  	# Searching
+  	search_str = ""
+  	searches = []
+  	if params['sSearch'] and !params['sSearch'].empty?
+  	  full_columns.each_with_index do |col,i|
+  	    searches.push( "#{col} LIKE '%#{params['sSearch']}%'" )
+  	  end
+  	  search_str = searches.join(' OR ') unless searches.empty?
+  	end
+  
+  	# Filtering
+  	filter_str = ""
+  	filters = []
+  	full_columns.each_with_index do |col,i|
+  	  if params['bSearchable_' + i.to_s] == "true" and !params['sSearch_' + i.to_s].empty?
+  	    filters.push( "#{col} LIKE '%#{params['sSearch_' + i.to_s]}%'" )
+  	  end
+  	end
+  	filter_str = filters.join(' AND ') unless filters.empty?
+  
+  	# Pull Searching & Filtering into where
+  	if !searches.empty? and !filters.empty?
+  	  sql_opts[:conditions] = "(#{search_str}) AND #{filter_str}"
+  	elsif !searches.empty?  
+  	  sql_opts[:conditions] = search_str
+  	elsif !filters.empty?   
+  	  sql_opts[:conditions] = filter_str
+  	end
+    
+    # Query
+    if dscope.nil?
+      # Scope model
+      records = curr_model.select( sql_opts[:select] ).limit( sql_opts[:limit] ).order( sql_opts[:order] ).where( sql_opts[:conditions] ).joins(sql_opts[:joins])
+      # Records Found
+      filtered_total = curr_model.count( :select => "*", :conditions => sql_opts[:conditions], :joins => sql_opts[:joins] )
+      # Total Found
+      total = curr_model.count( :select => "*" )
+    elsif params[:id].nil?  
+      # Scope model
+      records = curr_model.send( dscope.to_s ).select( sql_opts[:select] ).limit( sql_opts[:limit] ).order( sql_opts[:order] ).where( sql_opts[:conditions] ).joins(sql_opts[:joins])
+      # Records Found
+      filtered_total = curr_model.send( dscope.to_s ).count( :select => "*", :conditions => sql_opts[:conditions], :joins => sql_opts[:joins] )
+      # Total Found
+      total = curr_model.send( dscope.to_s ).count( :select => "*" )
+    else
+      # Scope model
+      records = curr_model.send( dscope.to_s, params[:id] ).select( sql_opts[:select] ).limit( sql_opts[:limit] ).order( sql_opts[:order] ).where( sql_opts[:conditions] ).joins(sql_opts[:joins])
+      # Records Found
+      filtered_total = curr_model.send( dscope.to_s, params[:id] ).count( :select => "*", :conditions => sql_opts[:conditions], :joins => sql_opts[:joins] )
+      # Total Found
+      total = curr_model.send( dscope.to_s, params[:id] ).count( :select => "*" )
+    end
+  
+    # Build Output Data Structure
+  	output = { "sEcho" => params['sEcho'], 
+  	           "iTotalRecords" => total,
+  	           "iTotalDisplayRecords" => filtered_total,
+  	           "aaData" => [] }
+  
+  	records.each do |a_row|
+  	  row = []
+  	  columns.each_with_index do |col,i|
+  	    if col == "version" # Special output formatting for version column
+  	      row.push( a_row[ col ]=="0" ? '-' : a_row[ col ] )
+  	    elsif col != ' ' # General Output
+  	      row.push( a_row[ col ])
+  	    end
+  	  end
+  	  output['aaData'].push(row)
+  	end
+  	
+  	output
+  end
+end