ajax-datatables-rails 0.4.3 → 1.3.1

data/spec/ajax-datatables-rails/orm/active_record_paginate_records_spec.rb

@@ -1,12 +1,13 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
-describe AjaxDatatablesRails::ORM::ActiveRecord do
+RSpec.describe AjaxDatatablesRails::ORM::ActiveRecord do
 
-  let(:view) { double('view', params: sample_params) }
-  let(:datatable) { ComplexDatatable.new(view) }
+  let(:datatable) { ComplexDatatable.new(sample_params) }
   let(:records) { User.all }
 
-  before(:each) do
+  before do
     create(:user, username: 'johndoe', email: 'johndoe@example.com')
     create(:user, username: 'msmith', email: 'mary.smith@example.com')
   end
@@ -17,8 +18,8 @@ describe AjaxDatatablesRails::ORM::ActiveRecord do
     end
 
     it 'paginates records properly' do
-      if AjaxDatatablesRails.config.db_adapter.in? %i[oracle oracleenhanced]
-        if Rails.version.in? %w[4.0.13 4.1.16 4.2.10]
+      if ENV['DB_ADAPTER'] == 'oracle_enhanced'
+        if Rails.version.in? %w[4.2.11]
           expect(datatable.paginate_records(records).to_sql).to include(
             'rownum <= 10'
           )
@@ -35,8 +36,8 @@ describe AjaxDatatablesRails::ORM::ActiveRecord do
 
       datatable.params[:start] = '26'
       datatable.params[:length] = '25'
-      if AjaxDatatablesRails.config.db_adapter.in? %i[oracle oracleenhanced]
-        if Rails.version.in? %w[4.0.13 4.1.16 4.2.10]
+      if ENV['DB_ADAPTER'] == 'oracle_enhanced'
+        if Rails.version.in? %w[4.2.11]
           expect(datatable.paginate_records(records).to_sql).to include(
             'rownum <= 51'
           )

data/spec/ajax-datatables-rails/orm/active_record_sort_records_spec.rb

@@ -1,13 +1,14 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
-describe AjaxDatatablesRails::ORM::ActiveRecord do
+RSpec.describe AjaxDatatablesRails::ORM::ActiveRecord do
 
-  let(:view) { double('view', params: sample_params) }
-  let(:datatable) { ComplexDatatable.new(view) }
-  let(:nulls_last_datatable) { DatatableOrderNullsLast.new(view) }
+  let(:datatable) { ComplexDatatable.new(sample_params) }
+  let(:nulls_last_datatable) { DatatableOrderNullsLast.new(sample_params) }
   let(:records) { User.all }
 
-  before(:each) do
+  before do
     create(:user, username: 'johndoe', email: 'johndoe@example.com')
     create(:user, username: 'msmith', email: 'mary.smith@example.com')
   end
@@ -31,7 +32,7 @@ describe AjaxDatatablesRails::ORM::ActiveRecord do
       )
     end
 
-    it 'should not sort a column which is not orderable' do
+    it 'does not sort a column which is not orderable' do
       datatable.params[:order]['0'] = { column: '0', dir: 'asc' }
       datatable.params[:order]['1'] = { column: '4', dir: 'desc' }
 
@@ -46,30 +47,32 @@ describe AjaxDatatablesRails::ORM::ActiveRecord do
   end
 
   describe '#sort_records with nulls last using global config' do
-    before { AjaxDatatablesRails.config.nulls_last = true }
-    after  { AjaxDatatablesRails.config.nulls_last = false }
-  
+    before { datatable.nulls_last = true }
+    after  { datatable.nulls_last = false }
+
     it 'can handle multiple sorting columns' do
+      skip('unsupported database adapter') if ENV['DB_ADAPTER'] == 'oracle_enhanced'
+
       # set to order by Users username in ascending order, and
       # by Users email in descending order
       datatable.params[:order]['0'] = { column: '0', dir: 'asc' }
       datatable.params[:order]['1'] = { column: '1', dir: 'desc' }
       expect(datatable.sort_records(records).to_sql).to include(
-        'ORDER BY CASE WHEN users.username IS NULL THEN 1 ELSE 0 END, users.username ASC, ' +
-        'CASE WHEN users.email IS NULL THEN 1 ELSE 0 END, users.email DESC'
+        "ORDER BY users.username ASC #{nulls_last_sql(datatable)}, users.email DESC #{nulls_last_sql(datatable)}"
       )
     end
   end
-  
+
   describe '#sort_records with nulls last using column config' do
     it 'can handle multiple sorting columns' do
+      skip('unsupported database adapter') if ENV['DB_ADAPTER'] == 'oracle_enhanced'
+
       # set to order by Users username in ascending order, and
       # by Users email in descending order
       nulls_last_datatable.params[:order]['0'] = { column: '0', dir: 'asc' }
       nulls_last_datatable.params[:order]['1'] = { column: '1', dir: 'desc' }
       expect(nulls_last_datatable.sort_records(records).to_sql).to include(
-        'ORDER BY users.username ASC, ' +
-        'CASE WHEN users.email IS NULL THEN 1 ELSE 0 END, users.email DESC'
+        "ORDER BY users.username ASC, users.email DESC #{nulls_last_sql(datatable)}"
       )
     end
   end

data/spec/factories/user.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 FactoryBot.define do
   factory :user do |f|
     f.username   { Faker::Internet.user_name }
     f.email      { Faker::Internet.email }
     f.first_name { Faker::Name.first_name }
     f.last_name  { Faker::Name.last_name }
-    f.post_id    { ((1..100).to_a).sample }
+    f.post_id    { (1..100).to_a.sample }
   end
 end

data/spec/install_oracle.sh

@@ -4,9 +4,15 @@ wget 'https://github.com/cbandy/travis-oracle/archive/v2.0.3.tar.gz'
 mkdir -p ~/.travis/oracle
 tar xz --strip-components 1 -C ~/.travis/oracle -f v2.0.3.tar.gz
 
-~/.travis/oracle/download.sh
+if [ -n ${CUSTOM_ORACLE_FILE} ]; then
+  wget -q ${CUSTOM_ORACLE_FILE} -O ~/.travis/oracle/oracle-xe-11.2.0-1.0.x86_64.rpm.zip
+else
+  ~/.travis/oracle/download.sh
+fi
+
 ~/.travis/oracle/install.sh
 
-"$ORACLE_HOME/bin/sqlplus" -L -S / AS SYSDBA <<SQL
-ALTER USER $USER IDENTIFIED BY $USER;
+# in dev env: sqlplus system/password@localhost/XE
+"${ORACLE_HOME}/bin/sqlplus" -L -S / AS SYSDBA <<SQL
+ALTER USER ${USER} IDENTIFIED BY ${USER};
 SQL

data/spec/spec_helper.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 require 'simplecov'
 require 'rspec'
+require 'rspec/retry'
 require 'database_cleaner'
 require 'factory_bot'
 require 'faker'
@@ -21,13 +24,6 @@ RSpec.configure do |config|
     FactoryBot.find_definitions
   end
 
-  config.after(:each) do
-    AjaxDatatablesRails.configure do |c|
-      c.db_adapter = ActiveRecord::Base.connection.adapter_name.downcase.to_sym
-      c.orm = :active_record
-    end
-  end
-
   config.color = true
   config.fail_fast = false
 
@@ -42,45 +38,54 @@ RSpec.configure do |config|
     DatabaseCleaner.clean_with(:truncation)
   end
 
-  config.before(:each) do
+  config.before do
     DatabaseCleaner.strategy = :transaction
   end
 
-  config.before(:each) do
+  config.before do
     DatabaseCleaner.start
   end
 
-  config.after(:each) do
+  config.after do
     DatabaseCleaner.clean
   end
-end
 
-require 'ajax-datatables-rails'
+  # disable monkey patching
+  # see: https://relishapp.com/rspec/rspec-core/v/3-8/docs/configuration/zero-monkey-patching-mode
+  config.disable_monkey_patching!
 
+  if ENV.key?('GITHUB_ACTIONS')
+    config.around do |ex|
+      ex.run_with_retry retry: 3
+    end
+  end
+end
+
+# Configure ActiveRecord
 adapter = ENV.fetch('DB_ADAPTER', 'postgresql')
 
 options = {
   adapter:  adapter,
   database: 'ajax_datatables_rails',
-  encoding: 'utf8'
+  encoding: 'utf8',
 }
 
-options = options.merge(username: 'root') if adapter == 'mysql2'
-options = options.merge(username: ENV['USER'], password: ENV['USER'], database: 'xe', host: '127.0.0.1/xe') if adapter == 'oracle_enhanced'
-options = options.merge(database: ':memory:') if adapter == 'sqlite3'
+options =
+  case adapter
+  when 'postgresql'
+    options.merge(host: '127.0.0.1', port: 5432, username: 'postgres', password: 'postgres')
+  when 'mysql2'
+    options.merge(host: '127.0.0.1', port: 3306, username: 'root', password: 'root')
+  when 'oracle_enhanced'
+    options.merge(host: '127.0.0.1/xe', username: ENV['USER'], password: ENV['USER'], database: 'xe')
+  when 'sqlite3'
+    options.merge(database: ':memory:')
+  end
 
 ActiveRecord::Base.establish_connection(options)
 
-AjaxDatatablesRails.configure do |c|
-  c.db_adapter = ActiveRecord::Base.connection.adapter_name.downcase.to_sym
-  c.orm = :active_record
-end
+# Require our gem
+require 'ajax-datatables-rails'
 
-load File.dirname(__FILE__) + '/support/schema.rb'
-load File.dirname(__FILE__) + '/support/test_helpers.rb'
-load File.dirname(__FILE__) + '/support/datatable_cond_date.rb'
-load File.dirname(__FILE__) + '/support/datatable_cond_numeric.rb'
-load File.dirname(__FILE__) + '/support/datatable_cond_proc.rb'
-load File.dirname(__FILE__) + '/support/datatable_cond_string.rb'
-load File.dirname(__FILE__) + '/support/datatable_order_nulls_last.rb'
-require File.dirname(__FILE__) + '/support/test_models.rb'
+# Load test helpers
+Dir[File.dirname(__FILE__) + '/support/**/*.rb'].sort.each { |f| require f }

data/spec/support/datatables/complex_datatable.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+class ComplexDatatable < AjaxDatatablesRails::ActiveRecord
+  def view_columns
+    @view_columns ||= {
+      username:   { source: 'User.username'   },
+      email:      { source: 'User.email'      },
+      first_name: { source: 'User.first_name' },
+      last_name:  { source: 'User.last_name'  },
+      post_id:    { source: 'User.post_id', orderable: false },
+      created_at: { source: 'User.created_at' },
+    }
+  end
+
+  def data
+    records.map do |record|
+      {
+        username:   record.username,
+        email:      record.email,
+        first_name: record.first_name,
+        last_name:  record.last_name,
+        post_id:    record.post_id,
+        created_at: record.created_at,
+      }
+    end
+  end
+
+  def get_raw_records
+    User.all
+  end
+end

data/spec/support/datatables/complex_datatable_array.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class ComplexDatatableArray < ComplexDatatable
+  def data
+    records.map do |record|
+      [
+        record.username,
+        record.email,
+        record.first_name,
+        record.last_name,
+        record.post_id,
+        record.created_at,
+      ]
+    end
+  end
+end

data/spec/support/{datatable_cond_date.rb → datatables/datatable_cond_date.rb}

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class DatatableCondDate < ComplexDatatable
   def view_columns
     super.deep_merge(created_at: { cond: :date_range })

data/spec/support/{datatable_cond_numeric.rb → datatables/datatable_cond_numeric.rb}

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class DatatableCondEq < ComplexDatatable
   def view_columns
     super.deep_merge(post_id: { cond: :eq })
@@ -42,7 +44,7 @@ end
 
 class DatatableCondInWithRegex < DatatableCondIn
   def view_columns
-    super.deep_merge(post_id: { cond: :in, use_regex: false, orderable: true, formater: ->(str) { cast_regex_value(str) } })
+    super.deep_merge(post_id: { cond: :in, use_regex: false, orderable: true, formatter: ->(str) { cast_regex_value(str) } })
   end
 
   def cast_regex_value(value)

data/spec/support/{datatable_cond_proc.rb → datatables/datatable_cond_proc.rb}

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class DatatableCondProc < ComplexDatatable
   def view_columns
     super.deep_merge(username: { cond: custom_filter })

data/spec/support/{datatable_cond_string.rb → datatables/datatable_cond_string.rb}

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class DatatableCondStartWith < ComplexDatatable
   def view_columns
     super.deep_merge(first_name: { cond: :start_with })
@@ -22,6 +24,12 @@ class DatatableCondStringEq < ComplexDatatable
   end
 end
 
+class DatatableCondStringIn < ComplexDatatable
+  def view_columns
+    super.deep_merge(email: { cond: :string_in, formatter: ->(o) { o.split('|') } })
+  end
+end
+
 class DatatableCondNullValue < ComplexDatatable
   def view_columns
     super.deep_merge(email: { cond: :null_value })
@@ -30,6 +38,6 @@ end
 
 class DatatableWithFormater < ComplexDatatable
   def view_columns
-    super.deep_merge(last_name: { formater: -> (o) { o.upcase } })
+    super.deep_merge(last_name: { formatter: ->(o) { o.upcase } })
   end
 end

data/spec/support/datatables/datatable_cond_unknown.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class DatatableCondUnknown < ComplexDatatable
+  def view_columns
+    super.deep_merge(username: { cond: :foo })
+  end
+end

data/spec/support/{datatable_order_nulls_last.rb → datatables/datatable_order_nulls_last.rb}

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class DatatableOrderNullsLast < ComplexDatatable
   def view_columns
     super.deep_merge(email: { nulls_last: true })

data/spec/support/{test_helpers.rb → helpers/params.rb}

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # rubocop:disable Metrics/MethodLength
 def sample_params
   ActionController::Parameters.new(
@@ -42,7 +44,7 @@ def sample_params
         },
       },
       'order' => {
-        '0' => {'column' => '0', 'dir' => 'asc'}
+        '0' => { 'column' => '0', 'dir' => 'asc' },
       },
       'start' => '0', 'length' => '10', 'search' => {
         'value' => '', 'regex' => 'false'
@@ -51,49 +53,22 @@ def sample_params
     }
   )
 end
-# rubocop:enable Metrics/MethodLength
-
-class ComplexDatatable < AjaxDatatablesRails::Base
-  def view_columns
-    @view_columns ||= {
-      username:   { source: 'User.username'   },
-      email:      { source: 'User.email'      },
-      first_name: { source: 'User.first_name' },
-      last_name:  { source: 'User.last_name'  },
-      post_id:    { source: 'User.post_id', orderable: false },
-      created_at: { source: 'User.created_at' },
-    }
-  end
 
-  def data
-    records.map do |record|
-      {
-        username:   record.username,
-        email:      record.email,
-        first_name: record.first_name,
-        last_name:  record.last_name,
-        post_id:    record.post_id,
-        created_at: record.created_at,
-      }
-    end
-  end
-
-  def get_raw_records
-    User.all
-  end
+def sample_params_json
+  hash_params = sample_params.to_unsafe_h
+  hash_params['columns'] = hash_params['columns'].values
+  hash_params['order'] = hash_params['order'].values
+  ActionController::Parameters.new(hash_params)
 end
+# rubocop:enable Metrics/MethodLength
 
-class ComplexDatatableArray < ComplexDatatable
-  def data
-    records.map do |record|
-      [
-        record.username,
-        record.email,
-        record.first_name,
-        record.last_name,
-        record.post_id,
-        record.created_at,
-      ]
-    end
+def nulls_last_sql(datatable)
+  case datatable.db_adapter
+  when :pg, :postgresql, :postgres, :oracle
+    'NULLS LAST'
+  when :mysql, :mysql2, :sqlite, :sqlite3
+    'IS NULL'
+  else
+    raise 'unsupported database adapter'
   end
 end

data/spec/support/{test_models.rb → models/user.rb}

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 class User < ActiveRecord::Base
 end