Remove global nulls_last settings. It's defined by class now.

Author: n-rodriguez

CHANGELOG.md

@@ -8,11 +8,16 @@
 * Add support of Ruby 3.0
 * Switch from Travis to Github Actions
 * Improve specs
-* `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))
 * 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))
 
+* `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

README.md

@@ -170,7 +170,15 @@ end
 * `:null_value` for nil field
 * `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.
+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.
 

ajax-datatables-rails.gemspec

@@ -23,7 +23,6 @@ Gem::Specification.new do |s|
 
   s.files = `git ls-files`.split("\n")
 
-  s.add_runtime_dependency 'railties', '>= 5.1'
   s.add_runtime_dependency 'zeitwerk'
 
   s.add_development_dependency 'activerecord-oracle_enhanced-adapter'

doc/migrate.md

@@ -1,3 +1,28 @@
+## To migrate from `v1.0.x` to `v1.3.0`
+
+The *v1.3.0* version has some breaking changes :
+
+* `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))
+
+This change is transparent for everyone. Just remove `AjaxDatatablesRails.config.db_adapter=` from your configuration (if exists) and it should work fine.
+
+Now you can use AjaxDatatablesRails in multi-db environments.
+
+* `AjaxDatatablesRails.config.nulls_last=` is removed and is configured per datatable class now (or by column). It defaults to false.
+
+This change is easy to mitigate : add `self.nulls_last = true` in [`ApplicationDatatable`](https://github.com/jbox-web/ajax-datatables-rails#create-a-master-parent-class-easy) and remove `AjaxDatatablesRails.config.nulls_last=`
+
+```ruby
+class ApplicationDatatable < AjaxDatatablesRails::ActiveRecord
+  self.nulls_last = true
+  # puts commonly used methods here
+end
+```
+
+* `AjaxDatatablesRails.config` is removed with no replacement
+
+Fix the two changes above and remove any configuration file about AjaxDatatablesRails. The gem is now configless :)
+
 ## To migrate from `v0.4.x` to `v1.0.0`
 
 The *v1.0.0* version is a **major break** from *v0.4*.

lib/ajax-datatables-rails.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'active_support/configurable'
-
 require 'zeitwerk'
 loader = Zeitwerk::Loader.for_gem
 generators = "#{__dir__}/generators"
@@ -13,18 +11,4 @@
 loader.setup
 
 module AjaxDatatablesRails
-  # Configure AjaxDatatablesRails global settings
-  #
-  #   AjaxDatatablesRails.configure do |config|
-  #     config.nulls_last = true
-  #   end
-
-  def self.configure
-    yield @config ||= AjaxDatatablesRails::Configuration.new
-  end
-
-  # AjaxDatatablesRails global settings
-  def self.config
-    @config ||= AjaxDatatablesRails::Configuration.new
-  end
 end

lib/ajax-datatables-rails/base.rb

@@ -4,6 +4,7 @@ module AjaxDatatablesRails
   class Base
 
     class_attribute :db_adapter, default: ActiveRecord::Base.connection.adapter_name.downcase.to_sym
+    class_attribute :nulls_last, default: false
 
     attr_reader :params, :options, :datatable
 

lib/ajax-datatables-rails/configuration.rb

@@ -77,6 +77,10 @@ def db_adapter
         @datatable.db_adapter
       end
 
+      def nulls_last
+        @datatable.nulls_last
+      end
+
     end
   end
 end

lib/ajax-datatables-rails/datatable/datatable.rb

@@ -9,9 +9,10 @@ class SimpleOrder
       DIRECTIONS     = [DIRECTION_ASC, DIRECTION_DESC].freeze
 
       def initialize(datatable, options = {})
-        @datatable = datatable
-        @options   = options
-        @adapter   = datatable.db_adapter
+        @datatable  = datatable
+        @options    = options
+        @adapter    = datatable.db_adapter
+        @nulls_last = datatable.nulls_last
       end
 
       def query(sort_column)
@@ -37,7 +38,7 @@ def column_direction
       end
 
       def sort_nulls_last?
-        column.nulls_last? || AjaxDatatablesRails.config.nulls_last == true
+        column.nulls_last? || @nulls_last == true
       end
 
       def nulls_last_sql

lib/ajax-datatables-rails/datatable/simple_order.rb

@@ -14,9 +14,9 @@
   end
 
   describe 'option methods with nulls last' do
-    describe 'using global option' do
-      before { AjaxDatatablesRails.config.nulls_last = true }
-      after  { AjaxDatatablesRails.config.nulls_last = false }
+    describe 'using class option' do
+      before { parent.nulls_last = true }
+      after  { parent.nulls_last = false }
 
       it 'sql query' do
         skip('unsupported database adapter') if ENV['DB_ADAPTER'] == 'oracle_enhanced'