ajax-datatables-rails 0.4.0 → 0.4.1

data/Rakefile

@@ -1,4 +1,5 @@
-#!/usr/bin/env rake
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/ajax-datatables-rails.gemspec

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
 # coding: utf-8
-$:.push File.expand_path('../lib', __FILE__)
+
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
 require 'ajax-datatables-rails/version'
 
 Gem::Specification.new do |s|
@@ -9,15 +11,15 @@ Gem::Specification.new do |s|
   s.authors     = ['Joel Quenneville', 'Antonio Antillon']
   s.email       = ['joel.quenneville@collegeplus.org', 'antillas21@gmail.com']
   s.homepage    = 'https://github.com/jbox-web/ajax-datatables-rails'
-  s.summary     = %q{A gem that simplifies using datatables and hundreds of records via ajax}
-  s.description = %q{A wrapper around datatable's ajax methods that allow synchronization with server-side pagination in a rails app}
+  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.add_dependency 'railties', '>= 4.0'
 
   s.add_development_dependency 'rails', '>= 4.0'
   s.add_development_dependency 'rake'
-  s.add_development_dependency 'pg'
+  s.add_development_dependency 'pg', '< 1.0'
   s.add_development_dependency 'mysql2'
   s.add_development_dependency 'sqlite3'
   s.add_development_dependency 'activerecord-oracle_enhanced-adapter'
@@ -26,12 +28,12 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'pry'
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'database_cleaner'
-  s.add_development_dependency 'factory_girl'
+  s.add_development_dependency 'factory_bot'
   s.add_development_dependency 'faker'
   s.add_development_dependency 'appraisal'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ['lib']
 end

data/doc/webpack.md

@@ -0,0 +1,50 @@
+### Webpack
+
+We assume here that Bootstrap and FontAwesome are already installed with Webpack.
+
+Inspired by https://datatables.net/download and completed :
+
+Add npm packages :
+
+```sh
+$ yarn add datatables.net
+$ yarn add datatables.net-bs
+$ yarn add datatables.net-buttons
+$ yarn add datatables.net-buttons-bs
+$ yarn add datatables.net-responsive
+$ yarn add datatables.net-responsive-bs
+$ yarn add datatables.net-select
+$ yarn add datatables.net-select-bs
+```
+
+In `config/webpack/loaders/datatables.js` :
+
+```js
+module.exports = {
+  test: /datatables\.net.*/,
+  loader: 'imports-loader?define=>false'
+}
+```
+
+In `config/webpack/environment.js` :
+
+```js
+const { environment } = require('@rails/webpacker')
+const datatables = require('./loaders/datatables')
+environment.loaders.append('datatables', datatables)
+module.exports = environment
+```
+
+in `app/javascript/pack/application.js` :
+
+```js
+// Load Datatables
+require('datatables.net-bs')(window, $)
+require('datatables.net-buttons-bs')(window, $)
+require('datatables.net-buttons/js/buttons.colVis.js')(window, $)
+require('datatables.net-buttons/js/buttons.html5.js')(window, $)
+require('datatables.net-buttons/js/buttons.print.js')(window, $)
+require('datatables.net-responsive-bs')(window, $)
+require('datatables.net-select')(window, $)
+// require('yadcf')(window, $) // Uncomment if you use yadcf (need a recent version of yadcf)
+```

data/gemfiles/{rails_4.1.15.gemfile → rails_4.1.16.gemfile}

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "rails", "4.1.15"
+gem "rails", "4.1.16"
 gem "mysql2", "~> 0.3.18"
 gem "activerecord-oracle_enhanced-adapter", "~> 1.5.0"
 gem "ruby-oci8" if ENV["DB_ADAPTER"] == "oracle_enhanced"

data/gemfiles/{rails_4.2.8.gemfile → rails_4.2.10.gemfile}

@@ -2,7 +2,8 @@
 
 source "https://rubygems.org"
 
-gem "rails", "4.2.8"
+gem "rails", "4.2.10"
+gem "mysql2", "0.4.10"
 gem "activerecord-oracle_enhanced-adapter", "~> 1.6.0"
 gem "ruby-oci8" if ENV["DB_ADAPTER"] == "oracle_enhanced"
 

data/gemfiles/{rails_5.0.3.gemfile → rails_5.0.7.gemfile}

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "rails", "5.0.3"
+gem "rails", "5.0.7"
 gem "activerecord-oracle_enhanced-adapter", "~> 1.7.0"
 gem "ruby-oci8" if ENV["DB_ADAPTER"] == "oracle_enhanced"
 

data/gemfiles/{rails_5.1.1.gemfile → rails_5.1.6.gemfile}

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "rails", "5.1.1"
+gem "rails", "5.1.6"
 gem "activerecord-oracle_enhanced-adapter", "~> 1.8.0"
 gem "ruby-oci8" if ENV["DB_ADAPTER"] == "oracle_enhanced"
 

data/gemfiles/rails_5.2.0.gemfile

@@ -0,0 +1,13 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "5.2.0"
+gem "activerecord-oracle_enhanced-adapter", "~> 5.2.0"
+gem "ruby-oci8" if ENV["DB_ADAPTER"] == "oracle_enhanced"
+
+group :test do
+  gem "codeclimate-test-reporter", "~> 1.0.0"
+end
+
+gemspec path: "../"

data/lib/ajax-datatables-rails.rb

@@ -1,11 +1,3 @@
-module AjaxDatatablesRails
-  require 'ajax-datatables-rails/version'
-  require 'ajax-datatables-rails/config'
-  require 'ajax-datatables-rails/base'
-  require 'ajax-datatables-rails/datatable/datatable'
-  require 'ajax-datatables-rails/datatable/simple_search'
-  require 'ajax-datatables-rails/datatable/simple_order'
-  require 'ajax-datatables-rails/datatable/column_date_filter' unless AjaxDatatablesRails.old_rails?
-  require 'ajax-datatables-rails/datatable/column'
-  require 'ajax-datatables-rails/orm/active_record'
-end
+# frozen_string_literal: true
+
+require 'ajax_datatables_rails'

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

@@ -1,39 +1,37 @@
-module AjaxDatatablesRails
-  class NotImplemented < StandardError; end
+# frozen_string_literal: true
 
+module AjaxDatatablesRails
   class Base
     extend Forwardable
 
     attr_reader :view, :options
     def_delegator :@view, :params
 
+    GLOBAL_SEARCH_DELIMITER = ' '
+
     def initialize(view, options = {})
       @view    = view
       @options = options
       load_orm_extension
     end
 
-    def config
-      @config ||= AjaxDatatablesRails.config
-    end
-
     def datatable
       @datatable ||= Datatable::Datatable.new(self)
     end
 
     def view_columns
-      fail(NotImplemented, view_columns_error_text)
+      raise(NotImplementedError, view_columns_error_text)
     end
 
     def get_raw_records
-      fail(NotImplemented, raw_records_error_text)
+      raise(NotImplementedError, raw_records_error_text)
     end
 
     def data
-      fail(NotImplemented, data_error_text)
+      raise(NotImplementedError, data_error_text)
     end
 
-    def additional_datas
+    def additional_data
       {}
     end
 
@@ -42,7 +40,7 @@ module AjaxDatatablesRails
         recordsTotal: records_total_count,
         recordsFiltered: records_filtered_count,
         data: sanitize(data)
-      }.merge(additional_datas)
+      }.merge(get_additional_data)
     end
 
     def records
@@ -72,12 +70,29 @@ module AjaxDatatablesRails
 
     private
 
+    # This method is necessary for smooth transition from
+    # `additinonal_datas` method to `additional_data`
+    # without breaking change.
+    def get_additional_data
+      if respond_to?(:additional_datas)
+        puts <<-WARNING
+          `additional_datas` has been deprecated and
+          will be removed in next major version update!
+          Please use `additional_data` instead.
+        WARNING
+
+        additional_datas
+      else
+        additional_data
+      end
+    end
+
     def sanitize(data)
       data.map do |record|
         if record.is_a?(Array)
           record.map { |td| ERB::Util.html_escape(td) }
         else
-          record.update(record){ |_, v| ERB::Util.html_escape(v) }
+          record.update(record) { |_, v| ERB::Util.html_escape(v) }
         end
       end
     end
@@ -91,48 +106,53 @@ module AjaxDatatablesRails
     end
 
     def records_total_count
-      get_raw_records.count(:all)
+      fetch_records.count(:all)
     end
 
     def records_filtered_count
-      filter_records(get_raw_records).count(:all)
+      filter_records(fetch_records).count(:all)
     end
 
     # Private helper methods
     def load_orm_extension
-      case config.orm
-      when :mongoid then nil
-      when :active_record then extend ORM::ActiveRecord
-      else
+      case AjaxDatatablesRails.config.orm
+      when :active_record
+        extend ORM::ActiveRecord
+      when :mongoid
         nil
       end
     end
 
+    def global_search_delimiter
+      GLOBAL_SEARCH_DELIMITER
+    end
+
     def raw_records_error_text
-      return <<-eos
+      <<-ERROR
 
         You should implement this method in your class and specify
         how records are going to be retrieved from the database.
-      eos
+      ERROR
     end
 
     def data_error_text
-      return <<-eos
+      <<-ERROR
 
         You should implement this method in your class and return an array
         of arrays, or an array of hashes, as defined in the jQuery.dataTables
         plugin documentation.
-      eos
+      ERROR
     end
 
     def view_columns_error_text
-      return <<-eos
+      <<-ERROR
 
         You should implement this method in your class and return an array
         of database columns based on the columns displayed in the HTML view.
         These columns should be represented in the ModelName.column_name,
         or aliased_join_table.column_name notation.
-      eos
+      ERROR
     end
+
   end
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/configurable'
 
 module AjaxDatatablesRails
@@ -24,5 +26,6 @@ module AjaxDatatablesRails
 
     config_accessor(:orm) { :active_record }
     config_accessor(:db_adapter) { :postgresql }
+    config_accessor(:nulls_last) { false }
   end
 end

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

@@ -1,167 +1,75 @@
-require 'ostruct'
+# frozen_string_literal: true
 
 module AjaxDatatablesRails
   module Datatable
     class Column
+
+      DB_ADAPTER_TYPE_CAST = {
+        mysql:          'CHAR',
+        mysql2:         'CHAR',
+        sqlite:         'TEXT',
+        sqlite3:        'TEXT',
+        oracle:         'VARCHAR2(4000)',
+        oracleenhanced: 'VARCHAR2(4000)'
+      }.freeze
+
       attr_reader :datatable, :index, :options
+      attr_writer :search
+
+      include Search
+      include Order
+      prepend DateFilter unless AjaxDatatablesRails.old_rails?
 
-      unless AjaxDatatablesRails.old_rails?
-        prepend ColumnDateFilter
-      end
 
       def initialize(datatable, index, options)
-        @datatable, @index, @options = datatable, index, options
-        @view_column = datatable.view_columns[options["data"].to_sym]
+        @datatable   = datatable
+        @index       = index
+        @options     = options
+        @view_column = datatable.view_columns[options[:data].to_sym]
       end
 
       def data
         options[:data].presence || options[:name]
       end
 
-      def searchable?
-        @view_column.fetch(:searchable, true)
-      end
-
-      def orderable?
-        @view_column.fetch(:orderable, true)
-      end
-
-      def search
-        @search ||= SimpleSearch.new(options[:search])
-      end
-
-      def searched?
-        search.value.present?
-      end
-
-      def search=(value)
-        @search = value
-      end
-
-      def cond
-        @view_column[:cond] || :like
-      end
-
-      def filter(value)
-        @view_column[:cond].call(value)
-      end
-
       def source
         @view_column[:source]
       end
 
-      # Add sort_field option to allow overriding of sort field
-      def sort_field
-        @view_column[:sort_field] || field
-      end
-
-      # Add formater option to allow modification of the value
-      # before passing it to the database
-      def formater
-        @view_column[:formater]
-      end
-
-      # Add use_regex option to allow bypassing of regex search
-      def use_regex?
-        @view_column.fetch(:use_regex, true)
-      end
-
-      # Add delimiter option to handle range search
-      def delimiter
-        @view_column[:delimiter] || '-'
-      end
-
       def table
-        model = source.split('.').first.constantize
-        model.arel_table rescue model
+        model.respond_to?(:arel_table) ? model.arel_table : model
       end
 
-      def field
-        source.split('.').last.to_sym
-      end
-
-      def search_query
-        search.regexp? ? regex_search : non_regex_search
+      def model
+        @model ||= source.split('.').first.constantize
       end
 
-      def sort_query
-        custom_field? ? source : "#{table.name}.#{sort_field}"
+      def field
+        @field ||= source.split('.').last.to_sym
       end
 
-      private
-
       def custom_field?
         !source.include?('.')
       end
 
-      def config
-        @config ||= AjaxDatatablesRails.config
+      # Add formater option to allow modification of the value
+      # before passing it to the database
+      def formater
+        @view_column[:formater]
       end
 
       def formated_value
         formater ? formater.call(search.value) : search.value
       end
 
-      # Using multi-select filters in JQuery Datatable auto-enables regex_search.
-      # Unfortunately regex_search doesn't work when filtering on primary keys with integer.
-      # It generates this kind of query : AND ("regions"."id" ~ '2|3') which throws an error :
-      # operator doesn't exist : integer ~ unknown
-      # The solution is to bypass regex_search and use non_regex_search with :in operator
-      def regex_search
-        if use_regex?
-          ::Arel::Nodes::Regexp.new((custom_field? ? field : table[field]), ::Arel::Nodes.build_quoted(formated_value))
-        else
-          non_regex_search
-        end
-      end
-
-      def non_regex_search
-        case cond
-        when Proc
-          filter(formated_value)
-        when :eq, :not_eq, :lt, :gt, :lteq, :gteq, :in
-          numeric_search
-        when :null_value
-          null_value_search
-        when :start_with
-          casted_column.matches("#{formated_value}%")
-        when :end_with
-          casted_column.matches("%#{formated_value}")
-        when :like
-          casted_column.matches("%#{formated_value}%")
-        else
-          nil
-        end
-      end
+      private
 
-      def typecast
-        case config.db_adapter
-        when :oracle, :oracleenhanced then 'VARCHAR2(4000)'
-        when :mysql, :mysql2   then 'CHAR'
-        when :sqlite, :sqlite3 then 'TEXT'
-        else
-          'VARCHAR'
-        end
+      def type_cast
+        @type_cast ||= (DB_ADAPTER_TYPE_CAST[AjaxDatatablesRails.config.db_adapter] || 'VARCHAR')
       end
 
       def casted_column
-        ::Arel::Nodes::NamedFunction.new('CAST', [table[field].as(typecast)])
-      end
-
-      def null_value_search
-        if formated_value == '!NULL'
-          table[field].not_eq(nil)
-        else
-          table[field].eq(nil)
-        end
-      end
-
-      def numeric_search
-        if custom_field?
-          ::Arel::Nodes::SqlLiteral.new(field).eq(formated_value)
-        else
-          table[field].send(cond, formated_value)
-        end
+        @casted_column ||= ::Arel::Nodes::NamedFunction.new('CAST', [table[field].as(type_cast)])
       end
 
     end