ajax-datatables-rails 0.4.0 → 0.4.1

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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module AjaxDatatablesRails
+  module Datatable
+    class Column
+      module DateFilter
+
+        class DateRange
+          attr_reader :begin, :end
+
+          def initialize(date_start, date_end)
+            @begin = date_start
+            @end   = date_end
+          end
+
+          def exclude_end?
+            false
+          end
+        end
+
+        # Add delimiter option to handle range search
+        def delimiter
+          @view_column[:delimiter] || '-'
+        end
+
+        def empty_range_search?
+          (formated_value == delimiter) || (range_start.blank? && range_end.blank?)
+        end
+
+        # A range value is in form '<range_start><delimiter><range_end>'
+        # This returns <range_start>
+        def range_start
+          @range_start ||= formated_value.split(delimiter)[0]
+        end
+
+        # A range value is in form '<range_start><delimiter><range_end>'
+        # This returns <range_end>
+        def range_end
+          @range_end ||= formated_value.split(delimiter)[1]
+        end
+
+        # Do a range search
+        def date_range_search
+          return nil if empty_range_search?
+          table[field].between(DateRange.new(range_start_casted, range_end_casted))
+        end
+
+        private
+
+        def non_regex_search
+          if cond == :date_range
+            date_range_search
+          else
+            super
+          end
+        end
+
+        def range_start_casted
+          range_start.blank? ? parse_date('01/01/1970') : parse_date(range_start)
+        end
+
+        def range_end_casted
+          range_end.blank? ? Time.current : parse_date("#{range_end} 23:59:59")
+        end
+
+        def parse_date(date)
+          if Time.zone
+            Time.zone.parse(date)
+          else
+            Time.parse(date)
+          end
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module AjaxDatatablesRails
+  module Datatable
+    class Column
+      module Order
+
+        def orderable?
+          @view_column.fetch(:orderable, true)
+        end
+
+        # Add sort_field option to allow overriding of sort field
+        def sort_field
+          @view_column[:sort_field] || field
+        end
+
+        def sort_query
+          custom_field? ? source : "#{table.name}.#{sort_field}"
+        end
+
+        # Add option to sort null values last
+        def nulls_last?
+          @view_column.fetch(:nulls_last, false)
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module AjaxDatatablesRails
+  module Datatable
+    class Column
+      module Search
+
+        def searchable?
+          @view_column.fetch(:searchable, true)
+        end
+
+        def cond
+          @view_column[:cond] || :like
+        end
+
+        def filter
+          @view_column[:cond].call(self, formated_value)
+        end
+
+        def search
+          @search ||= SimpleSearch.new(options[:search])
+        end
+
+        def searched?
+          search.value.present?
+        end
+
+        def search_query
+          search.regexp? ? regex_search : non_regex_search
+        end
+
+        # Add use_regex option to allow bypassing of regex search
+        def use_regex?
+          @view_column.fetch(:use_regex, true)
+        end
+
+        private
+
+        # 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
+          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}%")
+          end
+        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
+        end
+
+      end
+    end
+  end
+end

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

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module AjaxDatatablesRails
   module Datatable
 
-    TRUE_VALUE = 'true'.freeze
+    TRUE_VALUE = 'true'
 
     class Datatable
       attr_reader :datatable, :options
@@ -55,16 +57,16 @@ module AjaxDatatablesRails
         per_page != -1
       end
 
-      def offset
-        (page - 1) * per_page
+      def per_page
+        options.fetch(:length, 10).to_i
       end
 
-      def page
-        (options[:start].to_i / per_page) + 1
+      def offset
+        options.fetch(:start, 0).to_i
       end
 
-      def per_page
-        options.fetch(:length, 10).to_i
+      def page
+        (offset / per_page) + 1
       end
 
       def get_param(param)
@@ -74,6 +76,7 @@ module AjaxDatatablesRails
           options[param].to_unsafe_h.with_indifferent_access
         end
       end
+
     end
   end
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module AjaxDatatablesRails
   module Datatable
     class SimpleOrder
@@ -10,7 +12,11 @@ module AjaxDatatablesRails
       end
 
       def query(sort_column)
-        "#{sort_column} #{direction}"
+        if sort_nulls_last?
+          "CASE WHEN #{sort_column} IS NULL THEN 1 ELSE 0 END, #{sort_column} #{direction}"
+        else
+          "#{sort_column} #{direction}"
+        end
       end
 
       def column
@@ -18,7 +24,7 @@ module AjaxDatatablesRails
       end
 
       def direction
-        DIRECTIONS.find { |dir| dir == @options[:dir].upcase } || 'ASC'
+        DIRECTIONS.find { |dir| dir == column_direction } || 'ASC'
       end
 
       private
@@ -26,6 +32,15 @@ module AjaxDatatablesRails
       def column_index
         @options[:column]
       end
+
+      def column_direction
+        @options[:dir].upcase
+      end
+
+      def sort_nulls_last?
+        column.nulls_last? || AjaxDatatablesRails.config.nulls_last == true
+      end
+
     end
   end
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module AjaxDatatablesRails
   module Datatable
     class SimpleSearch
@@ -13,6 +15,7 @@ module AjaxDatatablesRails
       def regexp?
         @options[:regex] == TRUE_VALUE
       end
+
     end
   end
 end

data/lib/ajax-datatables-rails/orm/active_record.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module AjaxDatatablesRails
   module ORM
     module ActiveRecord
@@ -10,13 +12,16 @@ module AjaxDatatablesRails
         records.where(build_conditions)
       end
 
+      # rubocop:disable Style/EachWithObject
       def sort_records(records)
         sort_by = datatable.orders.inject([]) do |queries, order|
           column = order.column
-          queries << order.query(column.sort_query) if column
+          queries << order.query(column.sort_query) if column && column.orderable?
+          queries
         end
-        records.order(sort_by.join(", "))
+        records.order(Arel.sql(sort_by.join(', ')))
       end
+      # rubocop:enable Style/EachWithObject
 
       def paginate_records(records)
         records.offset(datatable.offset).limit(datatable.per_page)
@@ -33,20 +38,24 @@ module AjaxDatatablesRails
       end
 
       def build_conditions_for_datatable
-        search_for = datatable.search.value.split(' ')
         criteria = search_for.inject([]) do |crit, atom|
-          search = Datatable::SimpleSearch.new({ value: atom, regex: datatable.search.regexp? })
+          search = Datatable::SimpleSearch.new(value: atom, regex: datatable.search.regexp?)
           crit << searchable_columns.map do |simple_column|
             simple_column.search = search
             simple_column.search_query
           end.reduce(:or)
-        end.reduce(:and)
+        end.compact.reduce(:and)
         criteria
       end
 
       def build_conditions_for_selected_columns
         search_columns.map(&:search_query).compact.reduce(:and)
       end
+
+      def search_for
+        datatable.search.value.split(global_search_delimiter)
+      end
+
     end
   end
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module AjaxDatatablesRails
-  VERSION = '0.4.0'.freeze
+  VERSION = '0.4.1'
 end

data/lib/ajax_datatables_rails.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+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/search'
+  require 'ajax-datatables-rails/datatable/column/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

data/lib/generators/datatable/config_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails/generators'
 
 module Datatable

data/lib/generators/datatable/templates/ajax_datatables_rails_config.rb

@@ -1,7 +1,12 @@
+# frozen_string_literal: true
+
 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
+
   # available options for orm are: :active_record, :mongoid
   # config.orm = :active_record
 end

data/lib/generators/rails/datatable_generator.rb

@@ -1,16 +1,16 @@
+# frozen_string_literal: true
+
 require 'rails/generators'
 
 module Rails
   module Generators
     class DatatableGenerator < ::Rails::Generators::Base
       desc 'Creates a *_datatable model in the app/datatables directory.'
-      source_root File.expand_path('../templates', __FILE__)
+      source_root File.expand_path('templates', __dir__)
       argument :name, type: :string
 
       def generate_datatable
-        template 'datatable.rb', File.join(
-          'app/datatables', "#{datatable_path}.rb"
-        )
+        template 'datatable.rb', File.join('app', 'datatables', "#{datatable_path}.rb")
       end
 
       def datatable_name
@@ -18,10 +18,11 @@ module Rails
       end
 
       private
+
       def datatable_path
         "#{name.underscore}_datatable"
       end
 
     end
   end
-end
+end

data/lib/generators/rails/templates/datatable.rb

@@ -19,23 +19,9 @@ class <%= datatable_name %> < AjaxDatatablesRails::Base
     end
   end
 
-  private
-
   def get_raw_records
     # insert query here
+    # User.all
   end
 
-  # ==== These methods represent the basic operations to perform on records
-  # and feel free to override them
-
-  # def filter_records(records)
-  # end
-
-  # def sort_records(records)
-  # end
-
-  # def paginate_records(records)
-  # end
-
-  # ==== Insert 'presenter'-like methods below if necessary
 end