ajax-datatables-rails 1.2.0 → 1.3.0

data/doc/migrate.md

@@ -1,5 +1,35 @@
+## 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*.
+
+* 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.
+
 1) To mitigate the first change (Datatables no longer inherits from `AjaxDatatablesRails::Base` but from `AjaxDatatablesRails::ActiveRecord`)
 
 Create a new `ApplicationDatatable` class and make all your classes inherits from it :
@@ -51,3 +81,17 @@ end
 This way, you can still use `def_delegators` in your datatables [as in the documentation](https://github.com/jbox-web/ajax-datatables-rails#using-view-helpers).
 
 Note that the recommanded way is to use [Draper gem](https://github.com/drapergem/draper) to separate filtering logic from view/presentation logic [as in the documentation](https://github.com/jbox-web/ajax-datatables-rails#using-view-decorators).
+
+## To migrate from `v0.3.x` to `v0.4.x`
+
+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.
+
+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](https://github.com/jbox-web/ajax-datatables-rails#5-wire-up-the-javascript))

data/doc/webpack.md

@@ -24,7 +24,10 @@ In `config/webpack/loaders/datatables.js` :
 ```js
 module.exports = {
   test: /datatables\.net.*/,
-  loader: 'imports-loader?define=>false'
+  loader: 'imports-loader',
+  options: {
+    additionalCode: 'var define = false;'
+  }
 }
 ```
 

data/gemfiles/{rails_5.2.3.gemfile → rails_5.2.4.gemfile}

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "rails", "5.2.3"
+gem "rails", "5.2.4"
 gem "activerecord-oracle_enhanced-adapter", "~> 5.2.0"
 gem "sqlite3", "~> 1.3.0"
 gem "mysql2"

data/gemfiles/{rails_6.0.1.gemfile → rails_6.0.3.gemfile}

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "rails", "6.0.1"
+gem "rails", "6.0.3"
 gem "activerecord-oracle_enhanced-adapter", "~> 6.0.0"
 gem "sqlite3", "~> 1.4.0"
 gem "mysql2"

data/gemfiles/{rails_5.0.7.gemfile → rails_6.1.0.gemfile}

@@ -2,9 +2,9 @@
 
 source "https://rubygems.org"
 
-gem "rails", "5.0.7"
-gem "activerecord-oracle_enhanced-adapter", "~> 1.7.0"
-gem "sqlite3", "~> 1.3.0"
+gem "rails", "6.1.0"
+gem "activerecord-oracle_enhanced-adapter", "~> 6.1.0"
+gem "sqlite3", "~> 1.4.0"
 gem "mysql2"
 gem "ruby-oci8" if ENV["DB_ADAPTER"] == "oracle_enhanced"
 

data/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.inflector.inflect(
 loader.setup
 
 module AjaxDatatablesRails
-  # Configure AjaxDatatablesRails global settings
-  #
-  #   AjaxDatatablesRails.configure do |config|
-  #     config.db_adapter = :postgresql
-  #   end
-
-  def self.configure
-    yield @config ||= AjaxDatatablesRails::Configuration.new
-  end
-
-  # AjaxDatatablesRails global settings
-  def self.config
-    @config ||= AjaxDatatablesRails::Configuration.new
-  end
 end

data/lib/ajax-datatables-rails/base.rb

@@ -3,6 +3,9 @@
 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
 
     GLOBAL_SEARCH_DELIMITER = ' '
@@ -13,6 +16,7 @@ module AjaxDatatablesRails
       @datatable = Datatable::Datatable.new(self)
     end
 
+    # User defined methods
     def view_columns
       raise(NotImplementedError, view_columns_error_text)
     end
@@ -25,10 +29,29 @@ module AjaxDatatablesRails
       raise(NotImplementedError, data_error_text)
     end
 
+    # ORM defined methods
+    def fetch_records
+      get_raw_records
+    end
+
+    def filter_records(records)
+      raise(NotImplementedError)
+    end
+
+    def sort_records(records)
+      raise(NotImplementedError)
+    end
+
+    def paginate_records(records)
+      raise(NotImplementedError)
+    end
+
+    # User overides
     def additional_data
       {}
     end
 
+    # JSON structure sent to jQuery DataTables
     def as_json(*)
       {
         recordsTotal:    records_total_count,
@@ -37,10 +60,18 @@ module AjaxDatatablesRails
       }.merge(additional_data)
     end
 
-    def records
-      @records ||= retrieve_records
+    # User helper methods
+    def column_id(name)
+      view_columns.keys.index(name.to_sym)
+    end
+
+    def column_data(column)
+      id = column_id(column)
+      params.dig('columns', id.to_s, 'search', 'value')
     end
 
+    private
+
     # helper methods
     def connected_columns
       @connected_columns ||= begin
@@ -62,8 +93,6 @@ module AjaxDatatablesRails
       end
     end
 
-    private
-
     def sanitize_data(data)
       data.map do |record|
         if record.is_a?(Array)
@@ -74,6 +103,11 @@ module AjaxDatatablesRails
       end
     end
 
+    # called from within #data
+    def records
+      @records ||= retrieve_records
+    end
+
     def retrieve_records
       records = fetch_records
       records = filter_records(records)
@@ -94,15 +128,6 @@ module AjaxDatatablesRails
       GLOBAL_SEARCH_DELIMITER
     end
 
-    def column_id(name)
-      view_columns.keys.index(name.to_sym)
-    end
-
-    def column_data(column)
-      id = column_id(column)
-      params.dig('columns', id.to_s, 'search', 'value')
-    end
-
     def raw_records_error_text
       <<-ERROR
 

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

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module AjaxDatatablesRails
+  module Datatable
+  end
+end

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

@@ -4,35 +4,23 @@ module AjaxDatatablesRails
   module Datatable
     class Column
 
-      TYPE_CAST_DEFAULT   = 'VARCHAR'
-      TYPE_CAST_MYSQL     = 'CHAR'
-      TYPE_CAST_SQLITE    = 'TEXT'
-      TYPE_CAST_ORACLE    = 'VARCHAR2(4000)'
-      TYPE_CAST_SQLSERVER = 'VARCHAR(4000)'
-
-      DB_ADAPTER_TYPE_CAST = {
-        mysql:          TYPE_CAST_MYSQL,
-        mysql2:         TYPE_CAST_MYSQL,
-        sqlite:         TYPE_CAST_SQLITE,
-        sqlite3:        TYPE_CAST_SQLITE,
-        oracle:         TYPE_CAST_ORACLE,
-        oracleenhanced: TYPE_CAST_ORACLE,
-        sqlserver:      TYPE_CAST_SQLSERVER,
-      }.freeze
-
-      attr_reader :datatable, :index, :options
-      attr_writer :search
-
       include Search
       include Order
       include DateFilter
 
+      attr_reader :datatable, :index, :options
+      attr_writer :search
 
       def initialize(datatable, index, options)
         @datatable   = datatable
         @index       = index
         @options     = options
-        @view_column = datatable.view_columns[options[:data].to_sym]
+        @view_column = datatable.view_columns[column_name]
+        validate_settings!
+      end
+
+      def column_name
+        @column_name ||= options[:data]&.to_sym
       end
 
       def data
@@ -71,14 +59,64 @@ module AjaxDatatablesRails
 
       private
 
+      TYPE_CAST_DEFAULT   = 'VARCHAR'
+      TYPE_CAST_MYSQL     = 'CHAR'
+      TYPE_CAST_SQLITE    = 'TEXT'
+      TYPE_CAST_ORACLE    = 'VARCHAR2(4000)'
+      TYPE_CAST_SQLSERVER = 'VARCHAR(4000)'
+
+      DB_ADAPTER_TYPE_CAST = {
+        mysql:          TYPE_CAST_MYSQL,
+        mysql2:         TYPE_CAST_MYSQL,
+        sqlite:         TYPE_CAST_SQLITE,
+        sqlite3:        TYPE_CAST_SQLITE,
+        oracle:         TYPE_CAST_ORACLE,
+        oracleenhanced: TYPE_CAST_ORACLE,
+        sqlserver:      TYPE_CAST_SQLSERVER,
+      }.freeze
+
+      private_constant :TYPE_CAST_DEFAULT
+      private_constant :TYPE_CAST_MYSQL
+      private_constant :TYPE_CAST_SQLITE
+      private_constant :TYPE_CAST_ORACLE
+      private_constant :TYPE_CAST_SQLSERVER
+      private_constant :DB_ADAPTER_TYPE_CAST
+
       def type_cast
-        @type_cast ||= DB_ADAPTER_TYPE_CAST.fetch(AjaxDatatablesRails.config.db_adapter, TYPE_CAST_DEFAULT)
+        @type_cast ||= DB_ADAPTER_TYPE_CAST.fetch(datatable.db_adapter, TYPE_CAST_DEFAULT)
       end
 
       def casted_column
         @casted_column ||= ::Arel::Nodes::NamedFunction.new('CAST', [table[field].as(type_cast)])
       end
 
+      def validate_settings!
+        raise AjaxDatatablesRails::Error::InvalidSearchColumn, "Unknown column. Check that `data` field is filled on JS side with the column name" if column_name.empty?
+        raise AjaxDatatablesRails::Error::InvalidSearchColumn, "Check that column '#{column_name}' exists in view_columns" unless valid_search_column?(column_name)
+        raise AjaxDatatablesRails::Error::InvalidSearchCondition, cond unless valid_search_condition?(cond)
+      end
+
+      def valid_search_column?(column_name)
+        !datatable.view_columns[column_name].nil?
+      end
+
+      VALID_SEARCH_CONDITIONS = [
+        # String condition
+        :start_with, :end_with, :like, :string_eq, :string_in, :null_value,
+        # Numeric condition
+        :eq, :not_eq, :lt, :gt, :lteq, :gteq, :in,
+        # Date condition
+        :date_range
+      ].freeze
+
+      private_constant :VALID_SEARCH_CONDITIONS
+
+      def valid_search_condition?(cond)
+        return true if cond.is_a?(Proc)
+
+        VALID_SEARCH_CONDITIONS.include?(cond)
+      end
+
     end
   end
 end

data/lib/ajax-datatables-rails/datatable/column/date_filter.rb

@@ -55,7 +55,7 @@ module AjaxDatatablesRails
         end
 
         def range_end_casted
-          range_end.blank? ? Time.current : parse_date("#{range_end} 23:59:59")
+          range_end.blank? ? parse_date('9999-12-31 23:59:59') : parse_date("#{range_end} 23:59:59")
         end
 
         def parse_date(date)

data/lib/ajax-datatables-rails/datatable/column/search.rb

@@ -61,8 +61,6 @@ module AjaxDatatablesRails
             filter
           when :eq, :not_eq, :lt, :gt, :lteq, :gteq, :in
             searchable_integer? ? raw_search(cond) : empty_search
-          when :null_value
-            null_value_search
           when :start_with
             casted_column.matches("#{formatted_value}%")
           when :end_with
@@ -73,6 +71,8 @@ module AjaxDatatablesRails
             raw_search(:eq)
           when :string_in
             raw_search(:in)
+          when :null_value
+            null_value_search
           when :date_range
             date_range_search
           end

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

@@ -4,7 +4,7 @@ module AjaxDatatablesRails
   module Datatable
 
     class Datatable
-      attr_reader :datatable, :options
+      attr_reader :options
 
       def initialize(datatable)
         @datatable = datatable
@@ -41,7 +41,7 @@ module AjaxDatatablesRails
 
       def columns
         @columns ||= get_param(:columns).map do |index, column_options|
-          Column.new(datatable, index, column_options)
+          Column.new(@datatable, index, column_options)
         end
       end
 
@@ -70,7 +70,21 @@ module AjaxDatatablesRails
       def get_param(param)
         return {} if options[param].nil?
 
-        options[param].to_unsafe_h.with_indifferent_access
+        if options[param].is_a? Array
+          hash = {}
+          options[param].each_with_index { |value, index| hash[index] = value }
+          hash
+        else
+          options[param].to_unsafe_h.with_indifferent_access
+        end
+      end
+
+      def db_adapter
+        @datatable.db_adapter
+      end
+
+      def nulls_last
+        @datatable.nulls_last
       end
 
     end

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

@@ -9,8 +9,10 @@ module AjaxDatatablesRails
       DIRECTIONS     = [DIRECTION_ASC, DIRECTION_DESC].freeze
 
       def initialize(datatable, options = {})
-        @datatable = datatable
-        @options   = options
+        @datatable  = datatable
+        @options    = options
+        @adapter    = datatable.db_adapter
+        @nulls_last = datatable.nulls_last
       end
 
       def query(sort_column)
@@ -36,19 +38,19 @@ module AjaxDatatablesRails
       end
 
       def sort_nulls_last?
-        column.nulls_last? || AjaxDatatablesRails.config.nulls_last == true
+        column.nulls_last? || @nulls_last == true
       end
 
       def nulls_last_sql
         return unless sort_nulls_last?
 
-        case AjaxDatatablesRails.config.db_adapter
+        case @adapter
         when :pg, :postgresql, :postgres, :oracle
           'NULLS LAST'
         when :mysql, :mysql2, :sqlite, :sqlite3
           'IS NULL'
         else
-          raise 'unsupported database adapter'
+          raise "unsupported database adapter: #{@adapter}"
         end
       end