ajax-datatables-rails 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e815b1d2b3438d1347104637543f89a783530edf13e685eb2e8df4be93c69a51
-  data.tar.gz: 4ad611361b37e80e83c64aacc07beec161c59fd3bc31f48e6c76b3d598c0b91d
+  metadata.gz: c0b5b7242e164445bb1f0faaadadce3cdac7abc9a95ae813f29ff8754eb92060
+  data.tar.gz: b7551245872059aa1dba5dca216ed54fd5a3852a104e7fa6b5cd88c2e6a301a9
 SHA512:
-  metadata.gz: '0825362656ce0f7a7abd134de0ab8094dc423a0431d0408cfb8a76c35c5aee1c94b5e020b1ef353531ff74c25cc8c1547d6f0ce6f8ff938e02ca31c307c5ef9d'
-  data.tar.gz: 4cade9736d3bf4e4f902ab944cd5f6e6b213f220e30d11c977bc850b635665d3e9e67f417e90c0ead8d649d7c4b285502e847ded99e3aa4c878187fb7e5650f8
+  metadata.gz: 8715a74263a88667f384069d0975c67ec34b558c61291731f4e440d5e46cd803b3b978667b7dcd9945406abc5651f70254904a9f5c5f64172703f040da7a5dce
+  data.tar.gz: 93a2dda89e7293509eaf58525e445616b4f62a126d258b567445c4c143a518f7984cdccefc4186912aa64d6d0c49739cb054e26bd34ab9a9119da43f737c61ce

data/.github/workflows/ci.yml

@@ -0,0 +1,120 @@
+---
+name: CI
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  rspec:
+    runs-on: ubuntu-20.04
+
+    env:
+      ORACLE_COOKIE: sqldev
+      ORACLE_FILE: oracle11g/xe/oracle-xe-11.2.0-1.0.x86_64.rpm.zip
+      ORACLE_HOME: /u01/app/oracle/product/11.2.0/xe
+      ORACLE_SID: XE
+
+    services:
+      postgres:
+        image: 'postgres:13'
+        ports: ['5432:5432']
+        env:
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: ajax_datatables_rails
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+      # Using docker image fails with
+      # invalid reference format
+      # mariadb:
+      #   image: 'mariadb:10.3'
+      #   ports: ['3306:3306']
+      #   env:
+      #     MYSQL_ROOT_PASSWORD: root
+      #     MYSQL_DATABASE: ajax_datatables_rails
+      #   options: >-
+      #     --health-cmd 'mysqladmin ping'
+      #     --health-interval 10s
+      #     --health-timeout 5s
+      #     --health-retries 3
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - '3.0'
+          - '2.7'
+          - '2.6'
+          - '2.5'
+        rails:
+          - rails_5.2.4
+          - rails_6.0.3
+          - rails_6.1.0
+        adapter:
+          - sqlite3
+          - postgresql
+          - mysql2
+          - oracle_enhanced
+        exclude:
+          - ruby: '3.0'
+            rails: rails_5.2.4
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Set DB Adapter
+        env:
+          RAILS_VERSION: ${{ matrix.rails }}
+          DB_ADAPTER: ${{ matrix.adapter }}
+          CUSTOM_ORACLE_FILE: ${{ secrets.CUSTOM_ORACLE_FILE }}
+
+        # See: https://github.com/actions/virtual-environments/blob/main/images/linux/Ubuntu2004-README.md#mysql
+        run: |
+          if [ "${DB_ADAPTER}" = "mysql2" ]; then
+            sudo systemctl start mysql.service
+            mysql -u root -proot -e 'create database ajax_datatables_rails;'
+          fi
+
+          if [ "${DB_ADAPTER}" = "oracle_enhanced" ]; then
+            ./spec/install_oracle.sh
+            # Fix error : libnnz11.so: cannot open shared object file: No such file or directory
+            sudo ln -s ${ORACLE_HOME}/lib/libnnz11.so /usr/lib/libnnz11.so
+          fi
+
+      - name: Setup Ruby cache
+        uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gems-${{ matrix.ruby }}-${{ matrix.rails }}-${{ matrix.adapter }}-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-gems-${{ matrix.ruby }}-${{ matrix.rails }}-${{ matrix.adapter }}-
+
+      - name: Bundle
+        env:
+          RAILS_VERSION: ${{ matrix.rails }}
+          DB_ADAPTER: ${{ matrix.adapter }}
+          BUNDLE_GEMFILE: gemfiles/${{ matrix.rails }}.gemfile
+        run: |
+          gem install bundler
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3
+
+      - name: RSpec & publish code coverage
+        uses: paambaati/codeclimate-action@v2.7.5
+        env:
+          RAILS_VERSION: ${{ matrix.rails }}
+          DB_ADAPTER: ${{ matrix.adapter }}
+          BUNDLE_GEMFILE: gemfiles/${{ matrix.rails }}.gemfile
+          CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+        with:
+          coverageCommand: bin/rake

data/.rubocop.yml

@@ -1,5 +1,7 @@
 AllCops:
-  TargetRubyVersion: 2.4
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 2.5
   Exclude:
     - bin/*
     - lib/generators/**/*.rb

data/Appraisals

@@ -1,26 +1,20 @@
 # frozen_string_literal: true
 
 RAILS_VERSIONS = {
-  '5.0.7' => {
-    'activerecord-oracle_enhanced-adapter' => '~> 1.7.0',
-    'sqlite3' => '~> 1.3.0',
-    'mysql2' => '',
-    'ruby-oci8' => '',
-  },
-  '5.1.7' => {
-    'activerecord-oracle_enhanced-adapter' => '~> 1.8.0',
+  '5.2.4' => {
+    'activerecord-oracle_enhanced-adapter' => '~> 5.2.0',
     'sqlite3' => '~> 1.3.0',
     'mysql2' => '',
     'ruby-oci8' => '',
   },
-  '5.2.3' => {
-    'activerecord-oracle_enhanced-adapter' => '~> 5.2.0',
-    'sqlite3' => '~> 1.3.0',
+  '6.0.3' => {
+    'activerecord-oracle_enhanced-adapter' => '~> 6.0.0',
+    'sqlite3' => '~> 1.4.0',
     'mysql2' => '',
     'ruby-oci8' => '',
   },
-  '6.0.1' => {
-    'activerecord-oracle_enhanced-adapter' => '~> 6.0.0',
+  '6.1.0' => {
+    'activerecord-oracle_enhanced-adapter' => '~> 6.1.0',
     'sqlite3' => '~> 1.4.0',
     'mysql2' => '',
     'ruby-oci8' => '',

data/CHANGELOG.md

@@ -1,13 +1,34 @@
 # CHANGELOG
 
-## 1.2.0 (to come)
+## 1.3.0 (2021-01-04)
+
+* Drop support of Rails 5.0.x and 5.1.x
+* Drop support of Ruby 2.4
+* Add support of Rails 6.1
+* Add support of Ruby 3.0
+* Switch from Travis to Github Actions
+* Improve specs
+* Fix lib loading with JRuby (fixes [#371](https://github.com/jbox-web/ajax-datatables-rails/issues/371))
+* Raise an error when column's `cond:` setting is unknown
+* Make global search and column search work together (merge: [#350](https://github.com/jbox-web/ajax-datatables-rails/pull/350), fixes: [#258](https://github.com/jbox-web/ajax-datatables-rails/issues/258))
+* Fix: date_range doesn't support searching by a date greater than today (merge: [#351](https://github.com/jbox-web/ajax-datatables-rails/pull/351))
+* Fix: undefined method `fetch' for nil:NilClass (fix: [#307](https://github.com/jbox-web/ajax-datatables-rails/issues/307))
+* Add support for json params (merge: [#355](https://github.com/jbox-web/ajax-datatables-rails/pull/355))
+
+* `AjaxDatatablesRails.config` is removed with no replacement. The gem is now configless :)
+* `AjaxDatatablesRails.config.db_adapter=` is removed and is configured per datatable class now. It defaults to Rails DB adapter. (fixes [#364](https://github.com/jbox-web/ajax-datatables-rails/issues/364))
+* `AjaxDatatablesRails.config.nulls_last=` is removed and is configured per datatable class now (or by column). It defaults to false.
+
+To mitigate this 3 changes see the [migration doc](/doc/migrate.md).
+
+## 1.2.0 (2020-04-19)
 
 * Drop support of Rails 4.x
 * Drop support of Ruby 2.3
 * Use [zeitwerk](https://github.com/fxn/zeitwerk) to load gem files
 * Add binstubs to ease development
 
-This is the last version to support Rails 5.0.x and Ruby 2.4.x.
+This is the last version to support Rails 5.0.x, Rails 5.1.x and Ruby 2.4.x.
 
 ## 1.1.0 (2019-12-12)
 

data/README.md

@@ -3,7 +3,7 @@
 [![GitHub license](https://img.shields.io/github/license/jbox-web/ajax-datatables-rails.svg)](https://github.com/jbox-web/ajax-datatables-rails/blob/master/LICENSE)
 [![Gem](https://img.shields.io/gem/v/ajax-datatables-rails.svg)](https://rubygems.org/gems/ajax-datatables-rails)
 [![Gem](https://img.shields.io/gem/dtv/ajax-datatables-rails.svg)](https://rubygems.org/gems/ajax-datatables-rails)
-[![Build Status](https://travis-ci.com/jbox-web/ajax-datatables-rails.svg?branch=master)](https://travis-ci.com/jbox-web/ajax-datatables-rails)
+[![CI](https://github.com/jbox-web/ajax-datatables-rails/workflows/CI/badge.svg)](https://github.com/jbox-web/ajax-datatables-rails/actions)
 [![Code Climate](https://codeclimate.com/github/jbox-web/ajax-datatables-rails/badges/gpa.svg)](https://codeclimate.com/github/jbox-web/ajax-datatables-rails)
 [![Test Coverage](https://codeclimate.com/github/jbox-web/ajax-datatables-rails/badges/coverage.svg)](https://codeclimate.com/github/jbox-web/ajax-datatables-rails/coverage)
 
@@ -11,12 +11,12 @@
 
 It's tested against :
 
-* Rails 5.0.7 / 5.1.7 / 5.2.3 / 6.0.1
-* Ruby 2.4.10 / 2.5.8 / 2.6.6 / 2.7.1
-* Postgresql 9.6
-* MySQL 5.6
-* Oracle XE 11.2 (thanks to [travis-oracle](https://github.com/cbandy/travis-oracle))
+* Rails 5.2.4 / 6.0.3 / 6.1.0
+* Ruby 2.5.x / 2.6.x / 2.7.x
 * SQLite3
+* Postgresql 13
+* MySQL 8
+* Oracle XE 11.2 (thanks to [travis-oracle](https://github.com/cbandy/travis-oracle))
 
 ## Description
 
@@ -38,38 +38,9 @@ The final goal of this gem is to **generate a JSON** content that will be given
 All the datatable customizations (header, tr, td, css classes, width, height, buttons, etc...) **must** take place in the [javascript definition](#5-wire-up-the-javascript) of the datatable.
 jQuery DataTables is a very powerful tool with a lot of customizations available. Take the time to [read the doc](https://datatables.net/reference/option/).
 
+You'll find a sample project here : https://ajax-datatables-rails.herokuapp.com
 
-## Warnings
-
-**Breaking changes :**
-
-1) the *v1.0.0* version is a **major break** from *v0.4*.
-
-* Datatables no longer inherits from `AjaxDatatablesRails::Base` but from `AjaxDatatablesRails::ActiveRecord` (this solves [#228](https://github.com/jbox-web/ajax-datatables-rails/issues/228))
-* The `view_context` is no longer injected in Datatables but only the `params` hash (see the [example](#4-setup-the-controller-action)). This will break calls to helpers methods.
-
-To mitigate this 2 changes see the [migration doc](/doc/migrate.md).
-
-2) the *v0.4* version is a **major break** from *v0.3*.
-
-The core has been rewriten to remove dependency on [Kaminari](https://github.com/kaminari/kaminari) or [WillPaginate](https://github.com/mislav/will_paginate).
-
-It also brings a new (more natural) way of defining columns, based on hash definitions (and not arrays) and add some filtering options for column search.
-
-[See below](#3-customize-the-generated-datatables-class) for more infos.
-
-To migrate on the v0.4 you'll need to :
-
-* update your DataTables classes to remove all the `extend` directives
-* switch to hash definitions of `view_columns`
-* update your views to declare your columns bindings ([See here](#5-wire-up-the-javascript))
-
-
-## Documentation version
-
-This documentation is about the `v1.x.x` release (master branch) of this gem.
-
-You can still have access to the `v0.4.x` documentation on the [v0.4.x branch](https://github.com/jbox-web/ajax-datatables-rails/tree/v0.4.x).
+Its real world examples. The code is here : https://github.com/jbox-web/ajax-datatables-rails-sample-project
 
 
 ## Installation
@@ -95,29 +66,7 @@ You can install jQuery DataTables :
 * with [Rails webpacker gem](https://github.com/rails/webpacker) (see [here](/doc/webpack.md) for more infos)
 
 
-## Configuration
-
-Generate the `ajax-datatables-rails` config file with this command :
-
-```sh
-$ bundle exec rails generate datatable:config
-```
-
-Doing so, will create the `config/initializers/ajax_datatables_rails.rb` file with the following content :
-
-```ruby
-AjaxDatatablesRails.configure do |config|
-  # available options for db_adapter are: :pg, :mysql, :mysql2, :sqlite, :sqlite3
-  # config.db_adapter = :pg
-
-  # Or you can use your rails environment adapter if you want a generic dev and production
-  # config.db_adapter = Rails.configuration.database_configuration[Rails.env]['adapter'].to_sym
-end
-```
-
-Uncomment the `config.db_adapter` line and set the corresponding value to your database and gem. This is all you need.
-
-#### Note
+## Note
 
 Currently `AjaxDatatablesRails` only supports `ActiveRecord` as ORM for performing database queries.
 
@@ -129,7 +78,7 @@ If you'd be interested in contributing to speed development, please [open an iss
 ## Quick start (in 5 steps)
 
 The following examples assume that we are setting up `ajax-datatables-rails` for an index page of users from a `User` model,
-and that we are using Postgresql as our db, because you **should be using it**. (It also works with other DB, see above, just be sure to have [configured the right adapter](#configuration))
+and that we are using Postgresql as our db, because you **should be using it**. (It also works with other DB, [see above](#change-the-db-adapter-for-a-datatable-class))
 
 The goal is to render a users table and display : `id`, `first name`, `last name`, `email`, and `bio` for each user.
 
@@ -204,7 +153,7 @@ def view_columns
   @view_columns ||= {
     id:         { source: "User.id" },
     first_name: { source: "User.first_name", cond: :like, searchable: true, orderable: true },
-    last_name:  { source: "User.last_name",  cond: :like },
+    last_name:  { source: "User.last_name",  cond: :like, nulls_last: true },
     email:      { source: "User.email" },
     bio:        { source: "User.bio" },
   }
@@ -217,9 +166,19 @@ end
 
 * `:like`, `:start_with`, `:end_with`, `:string_eq`, `:string_in` for string or full text search
 * `:eq`, `:not_eq`, `:lt`, `:gt`, `:lteq`, `:gteq`, `:in` for numeric
-* `:date_range` for date range (only for Rails > 4.2.x, see [here](#daterange-search))
+* `:date_range` for date range
 * `:null_value` for nil field
-* `Proc` for whatever (see [here](https://github.com/ajahongir/ajax-datatables-rails-v-0-4-0-how-to/blob/master/app/datatables/city_datatable.rb) for real example)
+* `Proc` for whatever (see [here](https://github.com/jbox-web/ajax-datatables-rails-sample-project/blob/master/app/datatables/city_datatable.rb) for real example)
+
+The `nulls_last` param allows for nulls to be ordered last. You can configure it by column, like above, or by datatable class :
+
+```ruby
+class MyDatatable < AjaxDatatablesRails::ActiveRecord
+  self.nulls_last = true
+
+  # ... other methods (view_columns, data...)
+end
+```
 
 See [here](#columns-syntax) to get more details about columns definitions and how to play with associated models.
 
@@ -257,7 +216,8 @@ def data
   end
 end
 ```
-You can either use the v0.3 Array style for your columns :
+
+**Deprecated:** You can either use the v0.3 Array style for your columns :
 
 This method builds a 2d array that is used by datatables to construct the html
 table. Insert the values you want on each column.
@@ -317,7 +277,7 @@ def additional_data
 end
 ```
 
-Very useful with https://github.com/vedmack/yadcf to provide values for dropdown filters.
+Very useful with [datatables-factory](https://github.com/jbox-web/datatables-factory) (or [yadcf](https://github.com/vedmack/yadcf)) to provide values for dropdown filters.
 
 
 ### 4) Setup the Controller action
@@ -541,6 +501,24 @@ class UnrespondedMessagesDatatable < AjaxDatatablesRails::ActiveRecord
 end
 ```
 
+### Change the DB adapter for a datatable class
+
+If you have models from different databases you can set the `db_adapter` on the datatable class :
+
+```ruby
+class MySharedModelDatatable < AjaxDatatablesRails::ActiveRecord
+  self.db_adapter = :oracle_enhanced
+
+  # ... other methods (view_columns, data...)
+
+  def get_raw_records
+    AnimalsRecord.connected_to(role: :reading) do
+      Dog.all
+    end
+  end
+end
+```
+
 ### Columns syntax
 
 You can mix several model in the same datatable.
@@ -656,7 +634,7 @@ See [DefaultScope is evil](https://rails-bestpractices.com/posts/2013/06/15/defa
 
 ### DateRange search
 
-This feature works with [yadcf](https://github.com/vedmack/yadcf).
+This feature works with [datatables-factory](https://github.com/jbox-web/datatables-factory) (or [yadcf](https://github.com/vedmack/yadcf)).
 
 To enable the date range search, for example `created_at` :
 
@@ -783,6 +761,7 @@ then in your views :
 then in your Coffee/JS :
 
 ```coffee
+# send params in form data
 $ ->
   $('#posts-datatable').dataTable
     ajax:
@@ -790,11 +769,15 @@ $ ->
       type: 'POST'
     # ...others options, see [here](#5-wire-up-the-javascript)
 
+# send params as json data
 $ ->
   $('#users-datatable').dataTable
     ajax:
       url: $('#users-datatable').data('source')
+      contentType: 'application/json'
       type: 'POST'
+      data: (d) ->
+        JSON.stringify d
     # ...others options, see [here](#5-wire-up-the-javascript)
 ```
 
@@ -827,9 +810,7 @@ end
 
 ## Tutorial
 
-You'll find a sample project [here](https://github.com/ajahongir/ajax-datatables-rails-v-0-4-0-how-to). Its real world example.
-
-Filtering by JSONB column values : [#277](https://github.com/jbox-web/ajax-datatables-rails/issues/277)
+Filtering by JSONB column values : [#277](https://github.com/jbox-web/ajax-datatables-rails/issues/277#issuecomment-366526373)
 
 Use [has_scope](https://github.com/plataformatec/has_scope) gem with `ajax-datatables-rails` : [#280](https://github.com/jbox-web/ajax-datatables-rails/issues/280)
 

data/ajax-datatables-rails.gemspec

@@ -12,12 +12,17 @@ Gem::Specification.new do |s|
   s.summary     = 'A gem that simplifies using datatables and hundreds of records via ajax'
   s.description = "A wrapper around datatable's ajax methods that allow synchronization with server-side pagination in a rails app"
   s.license     = 'MIT'
+  s.metadata    = {
+    'homepage_uri'    => 'https://github.com/jbox-web/ajax-datatables-rails',
+    'changelog_uri'   => 'https://github.com/jbox-web/ajax-datatables-rails/blob/master/CHANGELOG.md',
+    'source_code_uri' => 'https://github.com/jbox-web/ajax-datatables-rails',
+    'bug_tracker_uri' => 'https://github.com/jbox-web/ajax-datatables-rails/issues',
+  }
 
-  s.required_ruby_version = '>= 2.4.4'
+  s.required_ruby_version = '>= 2.5.0'
 
   s.files = `git ls-files`.split("\n")
 
-  s.add_runtime_dependency 'railties', '>= 5.0'
   s.add_runtime_dependency 'zeitwerk'
 
   s.add_development_dependency 'activerecord-oracle_enhanced-adapter'
@@ -27,11 +32,12 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'faker'
   s.add_development_dependency 'generator_spec'
   s.add_development_dependency 'guard-rspec'
-  s.add_development_dependency 'pg', '< 1.0'
+  s.add_development_dependency 'pg'
   s.add_development_dependency 'pry'
-  s.add_development_dependency 'rails', '>= 5.0'
+  s.add_development_dependency 'rails', '>= 5.2'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rspec-retry'
   s.add_development_dependency 'rubocop'
-  s.add_development_dependency 'simplecov', '~> 0.17.1'
+  s.add_development_dependency 'simplecov'
 end