ajax-datatables-rails 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb40ce5ae30557f81c8a63451ab50f2e4c23c5f3
-  data.tar.gz: bad6eea562962c847c1b3cec96e83b65e950735a
+  metadata.gz: 80d42b1310c4f10689a82c08e83dfe459dd4dff0
+  data.tar.gz: 6d330fd4357b99d90b5f62d6073882d6337c9334
 SHA512:
-  metadata.gz: 9af79c2aa217a781f1f9fcad0eec6071ecd81ad4c350cd4ef60c3e74642f7e955988d54cd90e2085aeb8ca76d0536317e53bd422da4971216a8b801630c6e9b0
-  data.tar.gz: e840e32893f670972bc292788295fe18a713fa016b25327ef94eaeabaa0914b34f12d7c0df32f2f59d1a4affbc32cd01c16d0dd52f45818cc4e2b40e8e50c064
+  metadata.gz: 16e1b35b7c5f129c5ff53659ad205e56afd07b51d675a0e74e9c5aba03b0a206a1be155b43a0ba3a30868ca6f7adab881d94422cc78da6962b1af89dc2ff6cb7
+  data.tar.gz: 621736c6a250745e8f68a363f5686fb4840b1804a05637cdd00da15c4a61db647c47118dd8b0d6fa6c713b27002f27e0526c48176e5dca395a1081ac8452e371

data/CHANGELOG.md

@@ -1,6 +1,9 @@
 # CHANGELOG
 
-## 0.3.0 (unreleased yet)
+## 0.3.1
+* Adds `:oracle` as supported `db_adapter`. Thanks to [lutechspa](https://github.com/lutechspa) for this contribution.
+
+## 0.3.0
 * Changes to the `sortable_columns` and `searchable_columns` syntax as it
   required us to do unnecessary guessing. New syntax is `ModelName.column_name`
   or `Namespace::ModelName.column_name`. Old syntax of `table_name.column_name`

data/README.md

@@ -44,7 +44,7 @@ Currently `AjaxDatatablesRails` only supports `ActiveRecord` as ORM for
 performing database queries.
 
 Adding support for `Sequel`, `Mongoid` and `MongoMapper` is a planned feature
-for this gem. If you'd be interested in contributing to speed development, 
+for this gem. If you'd be interested in contributing to speed development,
 please [open an issue](https://github.com/antillas21/ajax-datatables-rails/issues/new)
 and get in touch.
 
@@ -65,7 +65,7 @@ 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
+## Usage (0.3.x)
 *The following examples assume that we are setting up ajax-datatables-rails for
 an index of users from a `User` model, and that we are using postgresql as
 our db, because you __should be using it__, if not, please refer to the
@@ -99,7 +99,9 @@ end
 * For `sortable_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.
+various columns. The sequence of these 3 columns must mirror the order of
+declarations in the `data` method below. You cannot leave this array empty as of
+0.3.0.
 
 * For `searchable_columns`, assign an array of the database columns that you
 want searchable by datatables. Suppose we need to sort and search users
@@ -140,7 +142,7 @@ def data
 end
 ```
 
-This method builds a 2d array that is used by datatables to construct the html
+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
@@ -155,8 +157,48 @@ def data
 end
 ```
 
+In the example above, we use the same sequence of column declarations as in
+`sortable_columns`. This ordering is important! And as of 0.3.0, the first
+column must be a sortable column. For more, see
+[this issue](https://github.com/antillas21/ajax-datatables-rails/issues/83).
+
 [See here](#using-view-helpers) if you need to use view helpers in the
-returned 2d array, like `link_to`, `mail_to`, `resource_path`, etc.
+returned 2D array, like `link_to`, `mail_to`, `resource_path`, etc.
+
+#### Automatic addition of ID
+If you want the gem inserts automatically the ID of the record in the `<tr>` element
+as shown in this [DataTable axample](http://www.datatables.net/examples/server_side/ids.html),
+you have to perform some modifications in both `some_datatable.rb` file and in your javascript.
+
+Here is an example:
+```ruby
+def data
+  records.map do |record|
+    {
+      '0' => record.first_name,
+      '1' => record.last_name,
+      '2' => record.email,
+      'DT_RowId' => record.id
+    }
+  end
+end
+```
+
+and in your javascript file:
+```javascript
+$(function() {
+  return $('#table_id').dataTable({
+    processing: true,
+    serverSide: true,
+    ajax: 'ajax_url',
+    columns: [
+      {data: '0' },
+      {data: '1' },
+      {data: '2' }
+    ]
+  });
+});
+```
 
 #### Get Raw Records
 ```ruby
@@ -286,6 +328,9 @@ So the query using the `.includes()` method is:
   end
 ```
 
+For more examples of 0.3.0 syntax for complex associations (and an example of
+the `data` method), read
+[this](https://github.com/antillas21/ajax-datatables-rails/issues/77).
 
 ### Controller
 Set up the controller to respond to JSON
@@ -423,6 +468,10 @@ end
 
 Pretty much like you would do it, if you were inside a namespaced controller.
 
+#### What if I'm using Oracle?
+
+We have recently merged and released a contribution from [lutechspa](https://github.com/lutechspa) that makes this gem work with Oracle (tested in version 11g). You can [take a look at this sample repo](https://github.com/paoloripamonti/oracle-ajax-datatable) to get an idea on how to set things up.
+
 #### Searching on non text-based columns
 
 It always comes the time when you need to add a non-string/non-text based
@@ -431,8 +480,8 @@ these column types (example: numeric, date, time).
 
 We recently added the ability to (automatically) typecast these column types
 and have this scenario covered. Please note however, if you are using
-something different from `postgresql` (with the `:pg` gem), like `mysql` or
-`sqlite`, then you need to add an initializer in your application's
+something different from `postgresql` (with the `:pg` gem), like `oracle`,
+`mysql` or `sqlite`, then you need to add an initializer in your application's
 `config/initializers` directory.
 
 If you don't perform this step (again, if using something different from
@@ -458,7 +507,7 @@ with the following content:
 
 ```ruby
 AjaxDatatablesRails.configure do |config|
-  # available options for db_adapter are: :pg, :mysql2, :sqlite3
+  # available options for db_adapter are: :oracle, :pg, :mysql2, :sqlite3
   # config.db_adapter = :pg
 
   # available options for paginator are: :simple_paginator, :kaminari, :will_paginate

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

@@ -147,6 +147,7 @@ module AjaxDatatablesRails
 
     def typecast
       case config.db_adapter
+      when :oracle then 'VARCHAR2(4000)'  
       when :pg then 'VARCHAR'
       when :mysql2 then 'CHAR'
       when :sqlite3 then 'TEXT'

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

@@ -1,3 +1,3 @@
 module AjaxDatatablesRails
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

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

@@ -1,5 +1,5 @@
 AjaxDatatablesRails.configure do |config|
-  # available options for db_adapter are: :pg, :mysql2, :sqlite3
+  # available options for db_adapter are: :oracle, :pg, :mysql2, :sqlite3
   # config.db_adapter = :pg
 
   # available options for paginator are: :simple_paginator, :kaminari, :will_paginate

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ajax-datatables-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Joel Quenneville
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-30 00:00:00.000000000 Z
+date: 2015-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties