ajax-datatables-rails 0.3.1 → 1.4.0

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

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe AjaxDatatablesRails::ORM::ActiveRecord do
+
+  let(:datatable) { ComplexDatatable.new(sample_params) }
+  let(:nulls_last_datatable) { DatatableOrderNullsLast.new(sample_params) }
+  let(:records) { User.all }
+
+  before do
+    create(:user, username: 'johndoe', email: 'johndoe@example.com')
+    create(:user, username: 'msmith', email: 'mary.smith@example.com')
+  end
+
+  describe '#sort_records' do
+    it 'returns a records collection sorted by :order params' do
+      # set to order Users by email in descending order
+      datatable.params[:order]['0'] = { column: '1', dir: 'desc' }
+      expect(datatable.sort_records(records).map(&:email)).to match(
+        ['mary.smith@example.com', 'johndoe@example.com']
+      )
+    end
+
+    it 'can handle multiple sorting columns' do
+      # 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 users.username ASC, users.email DESC'
+      )
+    end
+
+    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' }
+
+      expect(datatable.sort_records(records).to_sql).to include(
+        'ORDER BY users.username ASC'
+      )
+
+      expect(datatable.sort_records(records).to_sql).to_not include(
+        'users.post_id DESC'
+      )
+    end
+  end
+
+  describe '#sort_records with nulls last using global config' do
+    before { datatable.nulls_last = true }
+    after  { datatable.nulls_last = false }
+
+    it 'can handle multiple sorting columns' do
+      skip('unsupported database adapter') if RunningSpec.oracle?
+
+      # 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 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 RunningSpec.oracle?
+
+      # 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, users.email DESC #{nulls_last_sql(datatable)}"
+      )
+    end
+  end
+
+end

data/spec/dummy/config/database.yml

@@ -0,0 +1,25 @@
+<% adapter = ENV.fetch('DB_ADAPTER', 'postgresql') %>
+test:
+  adapter:  <%= adapter %>
+  database: ajax_datatables_rails
+  encoding: utf8
+
+<% if adapter == 'postgresql' %>
+  host: '127.0.0.1'
+  port: 5432
+  username: 'postgres'
+  password: 'postgres'
+<% elsif adapter == 'mysql2' %>
+  host: '127.0.0.1'
+  port: 3306
+  username: 'root'
+  password: 'root'
+<% elsif adapter == 'oracle_enhanced' %>
+  host: '127.0.0.1/xe'
+  username: <%= ENV.fetch('USER') %>
+  password: <%= ENV.fetch('USER') %>
+  database: 'xe'
+<% elsif adapter == 'sqlite3' %>
+  # database: ':memory:'
+  database: db/ajax_datatables_rails.sqlite3
+<% end %>

data/spec/dummy/config/routes.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Rails.application.routes.draw do
+  # Add your own routes here, or remove this file if you don't have need for it.
+end

data/spec/dummy/config/storage.yml

@@ -0,0 +1,3 @@
+test:
+  service: Disk
+  root: /tmp/ajax-datatables-rails/tmp/storage

data/spec/dummy/db/schema.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+ActiveRecord::Schema.define do
+  create_table :users, force: true do |t|
+    t.string  :username
+    t.string  :email
+    t.string  :first_name
+    t.string  :last_name
+    t.integer :post_id
+
+    t.timestamps null: false
+  end
+end

data/spec/dummy/log/.gitignore

@@ -0,0 +1 @@
+*.log

data/spec/factories/user.rb

@@ -0,0 +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 }
+  end
+end

data/spec/install_oracle.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+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
+
+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
+
+# 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,9 +1,88 @@
+# frozen_string_literal: true
+
+require 'combustion'
+
+Combustion.path = 'spec/dummy'
+Combustion.initialize! :active_record, :action_controller
+
+require 'simplecov'
+require 'rspec'
+require 'rspec/retry'
+require 'database_cleaner'
+require 'factory_bot'
+require 'faker'
 require 'pry'
-require 'rails'
-require 'active_record'
-require 'ajax-datatables-rails'
 
-ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+# Start Simplecov
+SimpleCov.start do
+  add_filter 'spec/'
+end
+
+# Configure RSpec
+RSpec.configure do |config|
+  config.include FactoryBot::Syntax::Methods
+
+  config.before(:suite) do
+    FactoryBot.find_definitions
+  end
+
+  config.color = true
+  config.fail_fast = false
+
+  config.order = :random
+  Kernel.srand config.seed
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.before(:suite) do
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.before do
+    DatabaseCleaner.strategy = :transaction
+  end
+
+  config.before do
+    DatabaseCleaner.start
+  end
+
+  config.after do
+    DatabaseCleaner.clean
+  end
+
+  # 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
+
+class RunningSpec
+  def self.sqlite?
+    ENV['DB_ADAPTER'] == 'sqlite3'
+  end
+
+  def self.oracle?
+    ENV['DB_ADAPTER'] == 'oracle_enhanced'
+  end
+
+  def self.mysql?
+    ENV['DB_ADAPTER'] == 'mysql2'
+  end
+
+  def self.postgresql?
+    ENV['DB_ADAPTER'] == 'postgresql'
+  end
+end
+
+# Require our gem
+require 'ajax-datatables-rails'
 
-load File.dirname(__FILE__) + '/schema.rb'
-require File.dirname(__FILE__) + '/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,33 @@
+# 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'  },
+      full_name:  { source: 'full_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,
+        full_name:  record.full_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/datatables/datatable_cond_date.rb

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

data/spec/support/datatables/datatable_cond_numeric.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+class DatatableCondEq < ComplexDatatable
+  def view_columns
+    super.deep_merge(post_id: { cond: :eq })
+  end
+end
+
+class DatatableCondNotEq < ComplexDatatable
+  def view_columns
+    super.deep_merge(post_id: { cond: :not_eq })
+  end
+end
+
+class DatatableCondLt < ComplexDatatable
+  def view_columns
+    super.deep_merge(post_id: { cond: :lt })
+  end
+end
+
+class DatatableCondGt < ComplexDatatable
+  def view_columns
+    super.deep_merge(post_id: { cond: :gt })
+  end
+end
+
+class DatatableCondLteq < ComplexDatatable
+  def view_columns
+    super.deep_merge(post_id: { cond: :lteq })
+  end
+end
+
+class DatatableCondGteq < ComplexDatatable
+  def view_columns
+    super.deep_merge(post_id: { cond: :gteq })
+  end
+end
+
+class DatatableCondIn < ComplexDatatable
+  def view_columns
+    super.deep_merge(post_id: { cond: :in })
+  end
+end
+
+class DatatableCondInWithRegex < DatatableCondIn
+  def view_columns
+    super.deep_merge(post_id: { cond: :in, use_regex: false, orderable: true, formatter: ->(str) { cast_regex_value(str) } })
+  end
+
+  def cast_regex_value(value)
+    value.split('|').map(&:to_i)
+  end
+end

data/spec/support/datatables/datatable_cond_proc.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class DatatableCondProc < ComplexDatatable
+  def view_columns
+    super.deep_merge(username: { cond: custom_filter })
+  end
+
+  private
+
+  def custom_filter
+    ->(column, value) { ::Arel::Nodes::SqlLiteral.new(column.field.to_s).matches("#{value}%") }
+  end
+end

data/spec/support/datatables/datatable_cond_string.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+class DatatableCondStartWith < ComplexDatatable
+  def view_columns
+    super.deep_merge(first_name: { cond: :start_with })
+  end
+end
+
+class DatatableCondEndWith < ComplexDatatable
+  def view_columns
+    super.deep_merge(last_name: { cond: :end_with })
+  end
+end
+
+class DatatableCondLike < ComplexDatatable
+  def view_columns
+    super.deep_merge(email: { cond: :like })
+  end
+end
+
+class DatatableCondStringEq < ComplexDatatable
+  def view_columns
+    super.deep_merge(email: { cond: :string_eq })
+  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 })
+  end
+end
+
+class DatatableWithFormater < ComplexDatatable
+  def view_columns
+    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/datatables/datatable_custom_column.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class DatatableCustomColumn < ComplexDatatable
+  def view_columns
+    super.deep_merge(full_name: { cond: filter_full_name })
+  end
+
+  def get_raw_records
+    User.select("*, CONCAT(first_name, ' ', last_name) as full_name")
+  end
+
+  private
+
+  def filter_full_name
+    ->(_column, value) { ::Arel::Nodes::SqlLiteral.new("CONCAT(first_name, ' ', last_name)").matches("#{value}%") }
+  end
+end

data/spec/support/datatables/datatable_order_nulls_last.rb

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

data/spec/support/helpers/params.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+# rubocop:disable Metrics/MethodLength
+def sample_params
+  ActionController::Parameters.new(
+    {
+      'draw' => '1',
+      'columns' => {
+        '0' => {
+          'data' => 'username', 'name' => '', 'searchable' => 'true', 'orderable' => 'true',
+          'search' => {
+            'value' => '', 'regex' => 'false'
+          }
+        },
+        '1' => {
+          'data' => 'email', 'name' => '', 'searchable' => 'true', 'orderable' => 'true',
+          'search' => {
+            'value' => '', 'regex' => 'false'
+          }
+        },
+        '2' => {
+          'data' => 'first_name', 'name' => '', 'searchable' => 'true', 'orderable' => 'false',
+          'search' => {
+            'value' => '', 'regex' => 'false'
+          }
+        },
+        '3' => {
+          'data' => 'last_name', 'name' => '', 'searchable' => 'true', 'orderable' => 'true',
+          'search' => {
+            'value' => '', 'regex' => 'false'
+          }
+        },
+        '4' => {
+          'data' => 'full_name', 'name' => '', 'searchable' => 'true', 'orderable' => 'true',
+          'search' => {
+            'value' => '', 'regex' => 'false'
+          }
+        },
+        '5' => {
+          'data' => 'post_id', 'name' => '', 'searchable' => 'true', 'orderable' => 'true',
+          'search' => {
+            'value' => '', 'regex' => 'false'
+          }
+        },
+        '6' => {
+          'data' => 'created_at', 'name' => '', 'searchable' => 'true', 'orderable' => 'true',
+          'search' => {
+            'value' => '', 'regex' => 'false'
+          }
+        },
+      },
+      'order' => {
+        '0' => { 'column' => '0', 'dir' => 'asc' },
+      },
+      'start' => '0', 'length' => '10', 'search' => {
+        'value' => '', 'regex' => 'false'
+      },
+      '_' => '1423364387185'
+    }
+  )
+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
+
+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/models/user.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class User < ActiveRecord::Base
+  def full_name
+    "#{first_name} #{last_name}"
+  end
+end