ajax-datatables-rails 0.3.1 → 0.4.0

data/Rakefile

@@ -3,7 +3,7 @@ require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
-task :default => :spec
+task default: :spec
 
 task :console do
   require 'pry'

data/ajax-datatables-rails.gemspec

@@ -1,30 +1,37 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+# coding: utf-8
+$:.push File.expand_path('../lib', __FILE__)
 require 'ajax-datatables-rails/version'
 
-Gem::Specification.new do |gem|
-  gem.name          = "ajax-datatables-rails"
-  gem.version       = AjaxDatatablesRails::VERSION
-  gem.authors       = ["Joel Quenneville"]
-  gem.email         = ["joel.quenneville@collegeplus.org"]
-  gem.description   = %q{A gem that simplifies using datatables and hundreds of records via ajax}
-  gem.summary       = %q{A wrapper around datatable's ajax methods that allow synchronization with server-side pagination in a rails app}
-  gem.homepage      = ""
-  gem.required_ruby_version = Gem::Requirement.new(">= 1.9.3")
+Gem::Specification.new do |s|
+  s.name        = 'ajax-datatables-rails'
+  s.version     = AjaxDatatablesRails::VERSION
+  s.platform    = Gem::Platform::RUBY
+  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.license     = 'MIT'
 
-  gem.files = Dir["{lib,spec}/**/*", "[A-Z]*"] - ["Gemfile.lock"]
-  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_path = "lib"
+  s.add_dependency 'railties', '>= 4.0'
 
-  gem.add_dependency 'railties',   '>= 3.1'
+  s.add_development_dependency 'rails', '>= 4.0'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'pg'
+  s.add_development_dependency 'mysql2'
+  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'activerecord-oracle_enhanced-adapter'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'generator_spec'
+  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 'faker'
+  s.add_development_dependency 'appraisal'
 
-  gem.add_development_dependency "rspec"
-  gem.add_development_dependency "generator_spec"
-  gem.add_development_dependency "pry"
-  gem.add_development_dependency "rake"
-  gem.add_development_dependency "sqlite3"
-  gem.add_development_dependency "rails", ">= 3.1.0"
-  gem.add_development_dependency "activerecord", ">= 4.1.6"
+  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.require_paths = ['lib']
 end

data/gemfiles/rails_4.0.13.gemfile

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

data/gemfiles/rails_4.1.15.gemfile

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

data/gemfiles/rails_4.2.8.gemfile

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

data/gemfiles/rails_5.0.3.gemfile

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

data/gemfiles/rails_5.1.1.gemfile

@@ -0,0 +1,13 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "5.1.1"
+gem "activerecord-oracle_enhanced-adapter", "~> 1.8.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,10 +1,11 @@
-require 'ajax-datatables-rails/version'
-require 'ajax-datatables-rails/config'
-require 'ajax-datatables-rails/models'
-require 'ajax-datatables-rails/base'
-require 'ajax-datatables-rails/extensions/simple_paginator'
-require 'ajax-datatables-rails/extensions/kaminari'
-require 'ajax-datatables-rails/extensions/will_paginate'
-
 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

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

@@ -1,214 +1,138 @@
 module AjaxDatatablesRails
+  class NotImplemented < StandardError; end
+
   class Base
     extend Forwardable
-    class MethodNotImplementedError < StandardError; end
 
-    attr_reader :view, :options, :sortable_columns, :searchable_columns
-    def_delegator :@view, :params, :params
+    attr_reader :view, :options
+    def_delegator :@view, :params
 
     def initialize(view, options = {})
-      @view = view
+      @view    = view
       @options = options
-      load_paginator
+      load_orm_extension
     end
 
     def config
       @config ||= AjaxDatatablesRails.config
     end
 
-    def sortable_columns
-      @sortable_columns ||= []
-    end
-
-    def searchable_columns
-      @searchable_columns ||= []
+    def datatable
+      @datatable ||= Datatable::Datatable.new(self)
     end
 
-    def data
-      fail(
-        MethodNotImplementedError,
-        'Please implement this method in your class.'
-      )
+    def view_columns
+      fail(NotImplemented, view_columns_error_text)
     end
 
     def get_raw_records
-      fail(
-        MethodNotImplementedError,
-        'Please implement this method in your class.'
-      )
+      fail(NotImplemented, raw_records_error_text)
     end
 
-    def as_json(options = {})
-      {
-        :draw => params[:draw].to_i,
-        :recordsTotal =>  get_raw_records.count(:all),
-        :recordsFiltered => filter_records(get_raw_records).count(:all),
-        :data => data
-      }
+    def data
+      fail(NotImplemented, data_error_text)
     end
 
-    def self.deprecated(message, caller = Kernel.caller[1])
-      warning = caller + ": " + message
-
-      if(respond_to?(:logger) && logger.present?)
-        logger.warn(warning)
-      else
-        warn(warning)
-      end
+    def additional_datas
+      {}
     end
 
-    private
-
-    def records
-      @records ||= fetch_records
+    def as_json(*)
+      {
+        recordsTotal: records_total_count,
+        recordsFiltered: records_filtered_count,
+        data: sanitize(data)
+      }.merge(additional_datas)
     end
 
-    def fetch_records
-      records = get_raw_records
-      records = sort_records(records) if params[:order].present?
-      records = filter_records(records) if params[:search].present?
-      records = paginate_records(records) unless params[:length].present? && params[:length] == '-1'
-      records
+    def records
+      @records ||= retrieve_records
     end
 
-    def sort_records(records)
-      sort_by = []
-      params[:order].each_value do |item|
-        sort_by << "#{sort_column(item)} #{sort_direction(item)}"
+    # helper methods
+    def connected_columns
+      @connected_columns ||= begin
+        view_columns.keys.map do |field_name|
+          datatable.column_by(:data, field_name.to_s)
+        end.compact
       end
-      records.order(sort_by.join(", "))
-    end
-
-    def paginate_records(records)
-      fail(
-        MethodNotImplementedError,
-        'Please mixin a pagination extension.'
-      )
-    end
-
-    def filter_records(records)
-      records = simple_search(records)
-      records = composite_search(records)
-      records
-    end
-
-    def simple_search(records)
-      return records unless (params[:search].present? && params[:search][:value].present?)
-      conditions = build_conditions_for(params[:search][:value])
-      records = records.where(conditions) if conditions
-      records
     end
 
-    def composite_search(records)
-      conditions = aggregate_query
-      records = records.where(conditions) if conditions
-      records
-    end
-
-    def build_conditions_for(query)
-      search_for = query.split(' ')
-      criteria = search_for.inject([]) do |criteria, atom|
-        criteria << searchable_columns.map { |col| search_condition(col, atom) }.reduce(:or)
-      end.reduce(:and)
-      criteria
-    end
-
-    def search_condition(column, value)
-      if column[0] == column.downcase[0]
-        ::AjaxDatatablesRails::Base.deprecated '[DEPRECATED] Using table_name.column_name notation is deprecated. Please refer to: https://github.com/antillas21/ajax-datatables-rails#searchable-and-sortable-columns-syntax'
-        return deprecated_search_condition(column, value)
-      else
-        return new_search_condition(column, value)
+    def searchable_columns
+      @searchable_columns ||= begin
+        connected_columns.select(&:searchable?)
       end
     end
 
-    def new_search_condition(column, value)
-      model, column = column.split('.')
-      model = model.constantize
-      casted_column = ::Arel::Nodes::NamedFunction.new('CAST', [model.arel_table[column.to_sym].as(typecast)])
-      casted_column.matches("%#{value}%")
-    end
-
-    def deprecated_search_condition(column, value)
-      model, column = column.split('.')
-      model = model.singularize.titleize.gsub( / /, '' ).constantize
-
-      casted_column = ::Arel::Nodes::NamedFunction.new('CAST', [model.arel_table[column.to_sym].as(typecast)])
-      casted_column.matches("%#{value}%")
-    end
-
-    def aggregate_query
-      conditions = searchable_columns.each_with_index.map do |column, index|
-        value = params[:columns]["#{index}"][:search][:value] if params[:columns]
-        search_condition(column, value) unless value.blank?
+    def search_columns
+      @search_columns ||= begin
+        searchable_columns.select(&:searched?)
       end
-      conditions.compact.reduce(:and)
     end
 
-    def typecast
-      case config.db_adapter
-      when :oracle then 'VARCHAR2(4000)'  
-      when :pg then 'VARCHAR'
-      when :mysql2 then 'CHAR'
-      when :sqlite3 then 'TEXT'
+    private
+
+    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) }
+        end
       end
     end
 
-    def offset
-      (page - 1) * per_page
+    def retrieve_records
+      records = fetch_records
+      records = filter_records(records)
+      records = sort_records(records)     if datatable.orderable?
+      records = paginate_records(records) if datatable.paginate?
+      records
     end
 
-    def page
-      (params[:start].to_i / per_page) + 1
+    def records_total_count
+      get_raw_records.count(:all)
     end
 
-    def per_page
-      params.fetch(:length, 10).to_i
+    def records_filtered_count
+      filter_records(get_raw_records).count(:all)
     end
 
-    def sort_column(item)
-      new_sort_column(item)
-    rescue
-      ::AjaxDatatablesRails::Base.deprecated '[DEPRECATED] Using table_name.column_name notation is deprecated. Please refer to: https://github.com/antillas21/ajax-datatables-rails#searchable-and-sortable-columns-syntax'
-      deprecated_sort_column(item)
+    # Private helper methods
+    def load_orm_extension
+      case config.orm
+      when :mongoid then nil
+      when :active_record then extend ORM::ActiveRecord
+      else
+        nil
+      end
     end
 
-    def deprecated_sort_column(item)
-      sortable_columns[sortable_displayed_columns.index(item[:column])]
-    end
+    def raw_records_error_text
+      return <<-eos
 
-    def new_sort_column(item)
-      model, column = sortable_columns[sortable_displayed_columns.index(item[:column])].split('.')
-      col = [model.constantize.table_name, column].join('.')
+        You should implement this method in your class and specify
+        how records are going to be retrieved from the database.
+      eos
     end
 
-    def sort_direction(item)
-      options = %w(desc asc)
-      options.include?(item[:dir]) ? item[:dir].upcase : 'ASC'
-    end
+    def data_error_text
+      return <<-eos
 
-    def sortable_displayed_columns
-      @sortable_displayed_columns ||= generate_sortable_displayed_columns
+        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
     end
 
-    def generate_sortable_displayed_columns
-      @sortable_displayed_columns = []
-      params[:columns].each_value do |column|
-        @sortable_displayed_columns << column[:data] if column[:orderable] == 'true'
-      end
-      @sortable_displayed_columns
-    end
+    def view_columns_error_text
+      return <<-eos
 
-    def load_paginator
-      case config.paginator
-      when :kaminari
-        extend Extensions::Kaminari
-      when :will_paginate
-        extend Extensions::WillPaginate
-      else
-        extend Extensions::SimplePaginator
-      end
-      self
+        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
     end
   end
 end