rails-datatables 0.0.1

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Joel Quenneville
+
+MIT License
+
+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.md

@@ -0,0 +1,142 @@
+# rails-datatables
+
+Datatables is a nifty jquery plugin that adds the ability to paginate, sort, and search your html tables. When dealing with large tables (more than a couple hundred rows) however, we run into performance issues. These can be fixed by using server-side pagination, but this breaks some datatables functionality.
+
+`rails-datatables` is a wrapper around datatable's ajax methods that allow synchronization with server-side pagination in a rails app. It was inspired by this [railscast](http://railscasts.com/episodes/340-datatables). I needed to implement a similar solution in a couple projects I was working on so I extracted it out into a gem.
+
+## Installation
+
+Add these lines to your application's Gemfile:
+
+    gem 'jquery-datatables-rails'
+    gem 'rails-datatables'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+*The following examples assume that we are setting up rails-datatables for an index of users from a `User` model*
+### Model
+Run the following command:
+
+    $ rails generate ajaxdatatable User
+
+This will generate a file named `users_datatable.rb` in `app/datatables`. Open the file and customize in the functions as directed by the comments
+
+#### Initializer
+```ruby
+def initialize(view)
+  @model_name = User
+  @columns = # insert array of column names here
+  @searchable_columns = #insert array of columns that will be searched
+  super(view)
+end
+```
+
+* For `@columns`, assign an array of the database columns that correspond to the columns in our view table. For example `[users.f_name, users.l_name, users.bio]`. This array is used for sorting by various columns
+
+* For `@searchable_columns`, assign an array of the database columns that you want searchable by datatables. For example `[users.f_name, users.l_name]`
+
+This gives us:
+```ruby
+def initialize(view)
+  @model_name = User
+  @columns = [users.f_name, users.l_name, users.bio]
+  @searchable_columns = [users.f_name, users.l_name]
+  super(view)
+end
+```
+
+#### Data
+```ruby
+def data
+  users.map do |user|
+    [
+      # comma separated list of the values for each cell of a table row
+    ]
+  end
+end
+```
+
+This method builds a 2d array that is used by datatables to construct the html table. Insert the values you want on each column.
+
+```ruby
+def data
+  users.map do |user|
+    [
+      user.f_name,
+      user.l_name,
+      user.bio
+    ]
+  end
+end
+```
+
+#### Get Raw Records
+```ruby
+def get_raw_records
+  # insert query here
+end
+```
+
+This is where your query goes.
+
+```ruby
+def get_raw_records
+  User.all
+end
+```
+
+### Controller
+Set up the controller to respond to JSON
+
+```ruby
+def index
+  respond_to do |format|
+    format.html
+    format.json { render json: UsersDatatable.new(view_context) }
+  end
+end
+```
+
+### View
+* Set up an html `<table>` with a `<thead>` and `<tbody>`
+* Add in your table headers if desired
+* Don't add any rows to the body of the table, datatables does this automatically
+* Add a data attribute to the `<table>` tag with the url of the JSON feed
+
+The resulting view may look like this:
+
+```erb
+<table id="user-table", data-source="<%= users_path(format: :json) %>">
+  <thead>
+    <tr>
+      <th>First Name</th>
+      <th>Last Name</th>
+      <th>Brief Bio</th>
+    </tr>
+  </thead>
+  <tbody>
+  </tbody>
+</table>
+```
+
+### Javascript
+Finally, the javascript to tie this all together. In the appropriate `js.coffee` file:
+
+```coffeescript
+$ ->
+  $('#users-table').dataTable
+    bProcessing: true
+    bServerSide: true
+    sAjaxSource: $('#users-table').data('source')
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/lib/generators/ajaxdatatable/ajaxdatatable_generator.rb

@@ -0,0 +1,8 @@
+class AjaxdatatableGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+  argument :model, type: :string
+
+  def generate_ajaxdatatable
+    template 'datatable.rb', File.join('app/datatables', "#{model.tableize}_datatable.rb")
+  end
+end

data/lib/generators/ajaxdatatable/templates/datatable.rb

@@ -0,0 +1,33 @@
+class <%= model.classify.pluralize %>Datatable < RailsDatatables
+  
+  def initialize(view)
+    @model_name = <%= model.classify %>
+    @columns = # insert array of column names here
+    @searchable_columns = #insert array of columns that will be searched
+    super(view)
+  end
+  
+private
+
+    def data
+      <%= model.tableize %>.map do |<%= model.tableize.singularize %>|
+        [
+          # comma separated list of the values for each cell of a table row
+        ]
+      end
+    end
+
+    def <%= model.tableize %>
+      @<%= model.tableize %> ||= fetch_records
+    end
+
+    def get_raw_records
+      # insert query here
+    end
+    
+    def get_raw_record_count
+      search_records(get_raw_records).count
+    end
+    
+    # ==== Insert 'presenter'-like methods below if necessary
+end

data/lib/generators/filterdatatable/templates/filter.rb

@@ -0,0 +1,8 @@
+class <%= model.classify.pluralize %>FilterDatatable < <%= model.classify.pluralize %>Datatable
+  
+private
+
+  def get_raw_records
+    # insert query here
+  end
+end

data/lib/rails-datatables.rb

@@ -0,0 +1,96 @@
+# require 'rails'
+
+class RailsDatatables
+  
+  class MethodError < StandardError; end
+
+  VERSION = '0.0.1'
+    
+  attr_reader :columns, :model_name, :searchable_columns
+
+  def initialize(view)
+    @view = view
+  end
+
+  def method_missing(meth, *args, &block)
+    @view.send(meth, *args, &block)
+  end
+
+  def as_json(options = {})
+    {
+      sEcho: params[:sEcho].to_i,
+      iTotalRecords: @model_name.count,
+      iTotalDisplayRecords: filtered_record_count,
+      aaData: data
+    }
+  end
+
+private
+
+  def data
+    raise MethodError, "The method `data' is not defined."
+  end
+
+  def get_raw_records
+    raise MethodError, "The method `get_raw_records' is not defined."
+  end
+
+  def filtered_record_count
+    search_records(get_raw_records).count
+  end
+  
+  def fetch_records
+    search_records(sort_records(paginate_records(get_raw_records)))
+  end
+
+  def paginate_records(records)
+    records.offset((page - 1) * per_page).limit(per_page)
+  end
+
+  def sort_records(records)
+    records.order("#{sort_column} #{sort_direction}")
+  end
+
+  def search_records(records)
+    if params[:sSearch].present?
+      value = params[:sSearch]
+      conditions = @searchable_columns.map do |column|
+        search_condition(column, value)
+      end
+      conditions = conditions.reduce(:or)
+      records = records.where(conditions)
+    end
+    conditions = @columns.each_with_index.map do |column, index|
+      value = params[:"sSearch_#{index}"]
+      search_condition(column, value) if value.present?
+    end
+    conditions = conditions.compact.reduce(:and)
+    records = records.where(conditions) if conditions.present?
+    records
+  end
+
+  def search_condition(column, value)
+    column = column.split('.').last
+    column_hash = @model_name.columns_hash[column]
+    if column_hash && [:string, :text].include?(column_hash.type)
+      return @model_name.arel_table[column].matches("%#{value}%")
+    end
+    @model_name.arel_table[column].eq(value)
+  end
+
+  def page
+    params[:iDisplayStart].to_i/per_page + 1
+  end
+
+  def per_page
+    params[:iDisplayLength].to_i > 0 ? params[:iDisplayLength].to_i : 10
+  end
+
+  def sort_column
+    @columns[params[:iSortCol_0].to_i]
+  end
+
+  def sort_direction
+    params[:sSortDir_0] == "desc" ? "DESC" : "ASC"
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: rails-datatables
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Joel Quenneville
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A gem that simplifies using datatables and hundreds of records via ajax
+email:
+- joel.quenneville@collegeplus.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/generators/ajaxdatatable/ajaxdatatable_generator.rb
+- lib/generators/ajaxdatatable/templates/datatable.rb
+- lib/generators/filterdatatable/templates/filter.rb
+- lib/rails-datatables.rb
+- LICENSE
+- Rakefile
+- README.md
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A wrapper around datatable's ajax methods that allow synchronization with
+  server-side pagination in a rails app
+test_files: []