ajax-datatables-rails 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e4fd5aaceea2d7736b1557eb21380da1bd58391
-  data.tar.gz: 10e47fdae2640f298aa19785e90c3a738e5f7237
+  metadata.gz: 41e30fdcf9f0f29415c014aee01b74328f2faf2c
+  data.tar.gz: 3d58fa14346fbc70152eaa3851755e53cc6dc751
 SHA512:
-  metadata.gz: d353c16571573cf843d9a5fd5c29752bbab75d0e37f98ec60c4767f34f7d07934f5138f08df356408e3ed0c6dc1de75a7eeae2c6e6ad914b02e48dceeba98d58
-  data.tar.gz: 8c34fe263c1c38b37447e9328a10a65da66f36ada2e847a38cf1665ec0c9f5fc4f74054ed02fa2121a988cbabfca6228e91d5b5191b2f52383643e3791c6870c
+  metadata.gz: a8673b396a04b6cc7fdf3412f5602d3753d072a53bf6c293b96a0a9e82f61981a443f9a820627f8d126d2c2f989037f463931185e09318e9ef22193c084a55c0
+  data.tar.gz: 217019709cb55ca0a495c81632b507a81f868cf7bbd115a73b6c635ab0b69b8f5838cc2b0343524f8c18ac963e671e5ef861512c68cd2dace7f5ee42038f2dd3

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## 0.2.0
+* This version works with jQuery dataTables ver. 1.10 and it's new API syntax.
+* Added `legacy` branch to repo. If your project is working with jQuery
+  dataTables ver. 1.9, this is the branch you need to pull, or use the last
+  `0.1.x` version of this gem.
+
 ## 0.1.2
 * Fixes `where` clause being built even when search term is an empty string.
   Thanks to [e-fisher](https://github.com/e-fisher) for spotting and fixing this.

data/README.md

@@ -3,17 +3,25 @@
 [![Build Status](https://travis-ci.org/antillas21/ajax-datatables-rails.svg?branch=master)](https://travis-ci.org/antillas21/ajax-datatables-rails)
 [![Gem Version](https://badge.fury.io/rb/ajax-datatables-rails.svg)](http://badge.fury.io/rb/ajax-datatables-rails)
 
-### Under new management
+### Versions
 
-> Hi,
->
-> New maintainer here. Just to let you know that we have
-> released version 0.1.0 which includes breaking changes.
->
-> Please check the [CHANGELOG](https://github.com/antillas21/ajax-datatables-rails/blob/master/CHANGELOG.md) to learn about these changes.
->
-> All changes have been documented below.
+[Datatables](http://datatables.net) recently released version 1.10 and deprecated version 1.9 which includes a new API and features.
 
+If you have dataTables 1.9 in your project and want to keep using it, please use this gem's version `0.1.x` in your `Gemfile`:
+
+```ruby
+# specific version number
+gem 'ajax-datatables-rails', '0.1.2'
+
+# or, support on datatables 1.9
+gem 'ajax-datatables-rails', git: 'git://github.com/antillas21/ajax-datatables-rails.git', branch: 'legacy'
+```
+
+If you have dataTables 1.10 in your project, then use the gem's latest version, or point to the `master` branch.
+
+
+
+## Description
 
 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.
 
@@ -29,13 +37,17 @@ Adding support for `Sequel`, `Mongoid` and `MongoMapper` is a planned feature fo
 
 Add these lines to your application's Gemfile:
 
-    gem 'jquery-datatables-rails'
+    gem 'jquery-datatables-rails', git: 'git://github.com/rweng/jquery-datatables-rails.git', branch: 'master'
     gem 'ajax-datatables-rails'
 
 And then execute:
 
     $ bundle
 
+The `jquery-datatables-rails` gem is listed as a convenience, to ease adding
+jQuery dataTables to your Rails project. You can always add the plugin assets
+manually via the assets pipeline. If you decide to use the `jquery-datatables-rails` gem, please refer to its installation instructions [here](https://github.com/rweng/jquery-datatables-rails).
+
 ## Usage
 *The following examples assume that we are setting up rails-datatables for an index of users from a `User` model*
 
@@ -179,10 +191,10 @@ Finally, the javascript to tie this all together. In the appropriate `js.coffee`
 ```coffeescript
 $ ->
   $('#users-table').dataTable
-    bProcessing: true
-    bServerSide: true
-    sAjaxSource: $('#users-table').data('source')
-    sPaginationType: 'full_numbers'
+    processing: true
+    serverSide: true
+    ajax: $('#users-table').data('source')
+    pagingType: 'full_numbers'
     # optional, if you want full pagination controls.
     # Check dataTables documentation to learn more about
     # available options.
@@ -194,10 +206,10 @@ or, if you're using plain javascript:
 
 jQuery(document).ready(function() {
   $('#users-table').dataTable({
-    'bProcessing': true,
-    'bServerSide': true,
-    'sAjaxSource': $('#users-table').data('source'),
-    'sPaginationType': 'full_numbers',
+    "processing": true,
+    "serverSide": true,
+    "ajax": $('#users-table').data('source')
+    "pagingType": "full_numbers",
     // optional, if you want full pagination controls.
     // Check dataTables documentation to learn more about
     // available options.

data/lib/ajax-datatables-rails/base.rb

@@ -35,10 +35,10 @@ module AjaxDatatablesRails
 
     def as_json(options = {})
       {
-        :sEcho => params[:sEcho].to_i,
-        :iTotalRecords => get_raw_records.count,
-        :iTotalDisplayRecords => filter_records(get_raw_records).count,
-        :aaData => data
+        :draw => params[:draw].to_i,
+        :recordsTotal =>  get_raw_records.count,
+        :recordsFiltered => filter_records(get_raw_records).count,
+        :data => data
       }
     end
 
@@ -74,8 +74,8 @@ module AjaxDatatablesRails
     end
 
     def simple_search(records)
-      return records unless params[:sSearch]
-      conditions = build_conditions_for(params[:sSearch])
+      return records unless (params[:search] && params[:search][:value])
+      conditions = build_conditions_for(params[:search][:value])
       records = records.where(conditions) if conditions
       records
     end
@@ -98,7 +98,7 @@ module AjaxDatatablesRails
 
     def aggregate_query
       conditions = searchable_columns.each_with_index.map do |column, index|
-        value = params["sSearch_#{index}".to_sym]
+        value = params[:columns]["#{index}"][:search][:value]
         search_condition(column, value) unless value.blank?
       end
       conditions.compact.reduce(:and)
@@ -109,20 +109,20 @@ module AjaxDatatablesRails
     end
 
     def page
-      (params[:iDisplayStart].to_i / per_page) + 1
+      (params[:start].to_i / per_page) + 1
     end
 
     def per_page
-      params.fetch(:iDisplayLength, 10).to_i
+      params.fetch(:length, 10).to_i
     end
 
     def sort_column
-      sortable_columns[params[:iSortCol_0].to_i]
+      sortable_columns[params[:order]['0'][:column].to_i]
     end
 
     def sort_direction
       options = %w(desc asc)
-      options.include?(params[:sSortDir_0]) ? params[:sSortDir_0].upcase : 'ASC'
+      options.include?(params[:order]['0'][:dir]) ? params[:order]['0'][:dir].upcase : 'ASC'
     end
   end
 end

data/lib/ajax-datatables-rails/version.rb

@@ -1,3 +1,3 @@
 module AjaxDatatablesRails
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

data/spec/ajax-datatables-rails/ajax_datatables_rails_spec.rb

@@ -20,8 +20,28 @@ describe AjaxDatatablesRails::Base do
   end
 
   params = {
-    :sEcho => '0', :sSortDir_0 => 'asc',
-    :iSortCol_0 => '1', :iDisplayStart => '11'
+    :draw => '5',
+    :columns => {
+      "0" => {
+        :data => '0',
+        :name => '',
+        :searchable => true,
+        :orderable => true,
+        :search => { :value => '', :regex => false }
+      },
+      "1" => {
+        :data => '1',
+        :name => '',
+        :searchable => true,
+        :orderable => true,
+        :search => { :value => '', :regex => false }
+      }
+    },
+    :order => { "0" => { :column => '1', :dir => 'desc' } },
+    :start => '0',
+    :length => '10',
+    :search => { :value => '', :regex => false },
+    '_' => '1403141483098'
   }
   let(:view) { double('view', :params => params) }
 
@@ -44,16 +64,16 @@ describe AjaxDatatablesRails::Base do
         expect(datatable.send(:offset)).to eq(0)
       end
 
-      it 'matches the value on view params[:iDisplayStart] minus 1' do
-        paginated_view = double('view', :params => { :iDisplayStart => '11' })
+      it 'matches the value on view params[:start] minus 1' do
+        paginated_view = double('view', :params => { :start => '11' })
         datatable = AjaxDatatablesRails::Base.new(paginated_view)
         expect(datatable.send(:offset)).to eq(10)
       end
     end
 
     describe '#page' do
-      it 'calculates page number from params[:iDisplayStart] and #per_page' do
-        paginated_view = double('view', :params => { :iDisplayStart => '11' })
+      it 'calculates page number from params[:start] and #per_page' do
+        paginated_view = double('view', :params => { :start => '11' })
         datatable = AjaxDatatablesRails::Base.new(paginated_view)
         expect(datatable.send(:page)).to eq(2)
       end
@@ -65,8 +85,8 @@ describe AjaxDatatablesRails::Base do
         expect(datatable.send(:per_page)).to eq(10)
       end
 
-      it 'matches the value on view params[:iDisplayLength]' do
-        other_view = double('view', :params => { :iDisplayLength => 20 })
+      it 'matches the value on view params[:length]' do
+        other_view = double('view', :params => { :length => 20 })
         datatable = AjaxDatatablesRails::Base.new(other_view)
         expect(datatable.send(:per_page)).to eq(20)
       end
@@ -74,8 +94,15 @@ describe AjaxDatatablesRails::Base do
 
     describe '#sort_column' do
       it 'returns a column name from the #sorting_columns array' do
-        sort_view = double('view', :params => { :iSortCol_0 => '1' })
-        datatable = AjaxDatatablesRails::Base.new(view)
+        sort_view = double(
+          'view',
+          :params => {
+            :order => {
+              '0' => { :column => '1' }
+            }
+          }
+        )
+        datatable = AjaxDatatablesRails::Base.new(sort_view)
         datatable.stub(:sortable_columns) { ['foo', 'bar', 'baz'] }
 
         expect(datatable.send(:sort_column)).to eq('bar')
@@ -84,13 +111,27 @@ describe AjaxDatatablesRails::Base do
 
     describe '#sort_direction' do
       it 'matches value of params[:sSortDir_0]' do
-        sorting_view = double('view', :params => { :sSortDir_0 => 'desc' })
+        sorting_view = double(
+          'view',
+          :params => {
+            :order => {
+              '0' => { :column => '1', :dir => 'desc' }
+            }
+          }
+        )
         datatable = AjaxDatatablesRails::Base.new(sorting_view)
         expect(datatable.send(:sort_direction)).to eq('DESC')
       end
 
       it 'can only be one option from ASC or DESC' do
-        sorting_view = double('view', :params => { :sSortDir_0 => 'foo' })
+        sorting_view = double(
+          'view',
+          :params => {
+            :order => {
+              '0' => { :column => '1', :dir => 'foo' }
+            }
+          }
+        )
         datatable = AjaxDatatablesRails::Base.new(sorting_view)
         expect(datatable.send(:sort_direction)).to eq('ASC')
       end
@@ -113,7 +154,7 @@ describe AjaxDatatablesRails::Base do
 
   describe 'perform' do
     let(:results) { double('Collection', :offset => [], :limit => []) }
-    let(:view) { double('view', :params => {}) }
+    let(:view) { double('view', :params => params) }
     let(:datatable) { AjaxDatatablesRails::Base.new(view) }
 
     describe '#paginate_records' do
@@ -133,7 +174,7 @@ describe AjaxDatatablesRails::Base do
 
     describe '#filter_records' do
       let(:records) { double('User', :where => []) }
-      let(:search_view) { double('view', :params => { :sSearch => 'foo' }) }
+      let(:search_view) { double('view', :params => params) }
 
       it 'applies search like functionality on a collection' do
         datatable = AjaxDatatablesRails::Base.new(search_view)
@@ -146,7 +187,7 @@ describe AjaxDatatablesRails::Base do
 
     describe '#filter_records with multi word model' do
       let(:records) { double('UserData', :where => []) }
-      let(:search_view) { double('view', :params => { :sSearch => 'bar' }) }
+      let(:search_view) { double('view', :params => params) }
 
       it 'applies search like functionality on a collection' do
         datatable = AjaxDatatablesRails::Base.new(search_view)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ajax-datatables-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Joel Quenneville
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-18 00:00:00.000000000 Z
+date: 2014-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties