Merge branch 'master' of github.com:jbox-web/ajax-datatables-rails into order_nulls_last_new

natebird · natebird · commit 76e1f6a7ff3e · 2018-05-01T18:23:46.000-04:00
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -26,12 +26,18 @@ Layout/EmptyLinesAroundModuleBody:
 Layout/EmptyLineBetweenDefs:
   Enabled: false
 
+Metrics/CyclomaticComplexity:
+  Max: 7
+
 Metrics/LineLength:
   Enabled: false
 
 Metrics/BlockLength:
   Max: 30
 
+Metrics/MethodLength:
+  Max: 15
+
 Metrics/ClassLength:
   Max: 130
 
diff --git a/.travis.yml b/.travis.yml
@@ -3,42 +3,52 @@ language: ruby
 sudo: required
 cache: bundler
 rvm:
-  - 2.2.9
-  - 2.3.6
+  - 2.2.10
+  - 2.3.7
 gemfile:
   - gemfiles/rails_4.0.13.gemfile
   - gemfiles/rails_4.1.16.gemfile
   - gemfiles/rails_4.2.10.gemfile
-  - gemfiles/rails_5.0.6.gemfile
-  - gemfiles/rails_5.1.5.gemfile
+  - gemfiles/rails_5.0.7.gemfile
+  - gemfiles/rails_5.1.6.gemfile
+  - gemfiles/rails_5.2.0.gemfile
 matrix:
   include:
-    - rvm: 2.4.3
+    - rvm: 2.4.4
       gemfile: gemfiles/rails_4.2.10.gemfile
       env: DB_ADAPTER=postgresql
-    - rvm: 2.4.3
-      gemfile: gemfiles/rails_5.0.6.gemfile
+    - rvm: 2.4.4
+      gemfile: gemfiles/rails_5.0.7.gemfile
       env: DB_ADAPTER=postgresql
-    - rvm: 2.4.3
-      gemfile: gemfiles/rails_5.1.5.gemfile
+    - rvm: 2.4.4
+      gemfile: gemfiles/rails_5.1.6.gemfile
       env: DB_ADAPTER=postgresql
-    - rvm: 2.4.3
+    - rvm: 2.4.4
+      gemfile: gemfiles/rails_5.2.0.gemfile
+      env: DB_ADAPTER=postgresql
+    - rvm: 2.4.4
       gemfile: gemfiles/rails_4.2.10.gemfile
       env: DB_ADAPTER=mysql2
-    - rvm: 2.4.3
-      gemfile: gemfiles/rails_5.0.6.gemfile
+    - rvm: 2.4.4
+      gemfile: gemfiles/rails_5.0.7.gemfile
+      env: DB_ADAPTER=mysql2
+    - rvm: 2.4.4
+      gemfile: gemfiles/rails_5.1.6.gemfile
       env: DB_ADAPTER=mysql2
-    - rvm: 2.4.3
-      gemfile: gemfiles/rails_5.1.5.gemfile
+    - rvm: 2.4.4
+      gemfile: gemfiles/rails_5.2.0.gemfile
       env: DB_ADAPTER=mysql2
-    - rvm: 2.4.3
+    - rvm: 2.4.4
       gemfile: gemfiles/rails_4.2.10.gemfile
       env: DB_ADAPTER=oracle_enhanced
-    - rvm: 2.4.3
-      gemfile: gemfiles/rails_5.0.6.gemfile
+    - rvm: 2.4.4
+      gemfile: gemfiles/rails_5.0.7.gemfile
+      env: DB_ADAPTER=oracle_enhanced
+    - rvm: 2.4.4
+      gemfile: gemfiles/rails_5.1.6.gemfile
       env: DB_ADAPTER=oracle_enhanced
-    - rvm: 2.4.3
-      gemfile: gemfiles/rails_5.1.5.gemfile
+    - rvm: 2.4.4
+      gemfile: gemfiles/rails_5.2.0.gemfile
       env: DB_ADAPTER=oracle_enhanced
 after_success:
   - bundle exec codeclimate-test-reporter
@@ -53,6 +63,8 @@ addons:
     - mysql-client-core-5.6
     - mysql-client-5.6
 before_install:
+  - gem update --system
+  - gem install bundler
   - sh -c "if [ '$DB_ADAPTER' = 'mysql2' ]; then mysql -e 'create database ajax_datatables_rails;'; fi"
   - sh -c "if [ '$DB_ADAPTER' = 'postgresql' ]; then psql -c 'create database ajax_datatables_rails;' -U postgres; fi"
   - sh -c "if [ '$DB_ADAPTER' = 'oracle_enhanced' ]; then ./spec/install_oracle.sh; fi"
diff --git a/Appraisals b/Appraisals
@@ -12,13 +12,17 @@ RAILS_VERSIONS = {
   '4.2.10' => {
     'activerecord-oracle_enhanced-adapter' => '~> 1.6.0'
   },
-  '5.0.6' => {
+  '5.0.7' => {
     'activerecord-oracle_enhanced-adapter' => '~> 1.7.0',
     'ruby-oci8' => ''
   },
-  '5.1.5' => {
+  '5.1.6' => {
     'activerecord-oracle_enhanced-adapter' => '~> 1.8.0',
     'ruby-oci8' => ''
+  },
+  '5.2.0' => {
+    'activerecord-oracle_enhanced-adapter' => '~> 5.2.0',
+    'ruby-oci8' => ''
   }
 }.freeze
 
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,7 @@
 * Fix: "orderable" option has no effect [Issue #245](https://github.com/jbox-web/ajax-datatables-rails/issues/245)
 * Change: Rename `additional_datas` method as `additional_data` [PR #251](https://github.com/jbox-web/ajax-datatables-rails/pull/251)
 * Change: Added timezone support for daterange [PR #261](https://github.com/jbox-web/ajax-datatables-rails/pull/261)
+* Various improvements in internal API
 
 **Note :** This is the last version to support Rails 4.0.x and Rails 4.1.x
 
diff --git a/README.md b/README.md
@@ -13,10 +13,10 @@
 > This gem is targeted at Datatables version 1.10.x.
 >
 > It's tested against :
-> * Rails 4.0.13 / 4.1.16 / 4.2.10 / 5.0.6 / 5.1.5
-> * Ruby 2.2.8 / 2.3.5 / 2.4.2
-> * Postgresql
-> * MySQL
+> * Rails 4.0.13 / 4.1.16 / 4.2.10 / 5.0.7 / 5.1.6 / 5.2.0
+> * Ruby 2.2.10 / 2.3.7 / 2.4.4 / 2.5.1
+> * Postgresql 9.6
+> * MySQL 5.6
 > * Oracle XE 11.2 (thanks to [travis-oracle](https://github.com/cbandy/travis-oracle))
 
 ## Description
@@ -573,7 +573,7 @@ class MyCustomDatatable < AjaxDatatablesRails::Base
       {
         id:         check_box_tag('users[]', record.id),
         first_name: link_to(record.fname, edit_resource_path(record)),
-        email:      mail_to(record.email)
+        email:      mail_to(record.email),
         # other attributes
       }
     end
@@ -583,20 +583,46 @@ end
 
 If you want to keep things tidy in the data mapping method, you could use
 [Draper](https://github.com/drapergem/draper) to define column mappings like below.
+On the long term it's much more cleaner than using `def_delegator` since decorators are reusable so we strongly recommand you to
+use Draper decorators. It will help you to keep your DataTables class small and clean and keep focused on what they should do (mostly) : filtering records ;)
+The presentation layer should rely on Decorators class.
+
+Example :
 
 ```ruby
 ...
   def data
     records.map do |record|
       {
-        id: record.decorate.id,
-        first_name: record.decorate.first_name,
-        email: record.decorate.email
+        id:         record.decorate.id,
+        first_name: record.decorate.link_to,
+        email:      record.decorate.email,
         # other attributes
+        dt_actions: record.decorate.dt_actions,
+        DT_RowId:   record.id,
       }
     end
   end
 ...
+
+class UserDecorator < ApplicationDecorator
+  delegate :id, :first_name
+
+  def link_to
+    h.link_to first_name, h.user_path(object)
+  end
+
+  def email
+    h.mail_to object.email
+  end
+
+  def dt_actions
+    links = []
+    links << h.link_to 'Edit',   h.edit_user_path(object) if h.policy(object).update?
+    links << h.link_to 'Delete', h.user_path(object), method: :delete, remote: true if h.policy(object).destroy?
+    h.safe_join(links, '')
+  end
+end
 ```
 
 
diff --git a/gemfiles/rails_4.2.10.gemfile b/gemfiles/rails_4.2.10.gemfile
@@ -3,6 +3,7 @@
 source "https://rubygems.org"
 
 gem "rails", "4.2.10"
+gem "mysql2", "0.4.10"
 gem "activerecord-oracle_enhanced-adapter", "~> 1.6.0"
 gem "ruby-oci8" if ENV["DB_ADAPTER"] == "oracle_enhanced"
 
diff --git a/gemfiles/rails_5.0.7.gemfile b/gemfiles/rails_5.0.7.gemfile
@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "rails", "5.0.6"
+gem "rails", "5.0.7"
 gem "activerecord-oracle_enhanced-adapter", "~> 1.7.0"
 gem "ruby-oci8" if ENV["DB_ADAPTER"] == "oracle_enhanced"
 
diff --git a/gemfiles/rails_5.1.6.gemfile b/gemfiles/rails_5.1.6.gemfile
@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "rails", "5.1.5"
+gem "rails", "5.1.6"
 gem "activerecord-oracle_enhanced-adapter", "~> 1.8.0"
 gem "ruby-oci8" if ENV["DB_ADAPTER"] == "oracle_enhanced"
 
diff --git a/gemfiles/rails_5.2.0.gemfile b/gemfiles/rails_5.2.0.gemfile
@@ -0,0 +1,13 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "5.2.0"
+gem "activerecord-oracle_enhanced-adapter", "~> 5.2.0"
+gem "ruby-oci8" if ENV["DB_ADAPTER"] == "oracle_enhanced"
+
+group :test do
+  gem "codeclimate-test-reporter", "~> 1.0.0"
+end
+
+gemspec path: "../"
diff --git a/lib/ajax-datatables-rails/datatable/column.rb b/lib/ajax-datatables-rails/datatable/column.rb
@@ -18,10 +18,8 @@ class Column
 
       include Search
       include Order
+      prepend DateFilter unless AjaxDatatablesRails.old_rails?
 
-      unless AjaxDatatablesRails.old_rails?
-        prepend DateFilter
-      end
 
       def initialize(datatable, index, options)
         @datatable   = datatable
diff --git a/lib/ajax-datatables-rails/orm/active_record.rb b/lib/ajax-datatables-rails/orm/active_record.rb
@@ -12,6 +12,7 @@ def filter_records(records)
         records.where(build_conditions)
       end
 
+      # rubocop:disable Style/EachWithObject
       def sort_records(records)
         sort_by = datatable.orders.inject([]) do |queries, order|
           column = order.column
@@ -20,6 +21,7 @@ def sort_records(records)
         end
         records.order(Arel.sql(sort_by.join(', ')))
       end
+      # rubocop:enable Style/EachWithObject
 
       def paginate_records(records)
         records.offset(datatable.offset).limit(datatable.per_page)
diff --git a/lib/generators/rails/datatable_generator.rb b/lib/generators/rails/datatable_generator.rb
@@ -6,7 +6,7 @@ module Rails
   module Generators
     class DatatableGenerator < ::Rails::Generators::Base
       desc 'Creates a *_datatable model in the app/datatables directory.'
-      source_root File.expand_path('../templates', __FILE__)
+      source_root File.expand_path('templates', __dir__)
       argument :name, type: :string
 
       def generate_datatable
