Add AjaxDatatablesRails::ActiveRecord class

Author: n-rodriguez

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## 0.5.0 (to come)
 
 * Breaking change: Remove dependency on view_context [Issue #288](https://github.com/jbox-web/ajax-datatables-rails/issues/288)
+* Breaking change: Replace `config.orm = :active_record` by a class : `AjaxDatatablesRails::ActiveRecord`
 
 ## 0.4.3 (2018-06-05)
 

README.md

@@ -96,16 +96,11 @@ AjaxDatatablesRails.configure do |config|
 
   # 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
 ```
 
 Uncomment the `config.db_adapter` line and set the corresponding value to your database and gem. This is all you need.
 
-Uncomment the `config.orm` line to set `active_record or mongoid` if included in your project. It defaults to `active_record`.
-
 #### Note
 
 Currently `AjaxDatatablesRails` only supports `ActiveRecord` as ORM for performing database queries.
@@ -386,7 +381,7 @@ Sometimes you'll need to use view helper methods like `link_to`, `mail_to`,
 To have these methods available to be used, this is the way to go:
 
 ```ruby
-class UserDatatable < AjaxDatatablesRails::Base
+class UserDatatable < AjaxDatatablesRails::ActiveRecord
   extend Forwardable
 
   # either define them one-by-one
@@ -483,7 +478,7 @@ This way you don't need to inject the `view_context` in the Datatable object to
 
 ### Pass options to the datatable class
 
-An `AjaxDatatablesRails::Base` inherited class can accept an options hash at initialization. This provides room for flexibility when required.
+An `AjaxDatatablesRails::ActiveRecord` inherited class can accept an options hash at initialization. This provides room for flexibility when required.
 
 Example:
 
@@ -497,7 +492,7 @@ def index
 end
 
 # The datatable class
-class UnrespondedMessagesDatatable < AjaxDatatablesRails::Base
+class UnrespondedMessagesDatatable < AjaxDatatablesRails::ActiveRecord
 
   # ... other methods (view_columns, data...)
 
@@ -648,7 +643,7 @@ To enable the date range search, for example `created_at` :
 
 ### Generator Syntax
 
-Also, a class that inherits from `AjaxDatatablesRails::Base` is not tied to an
+Also, a class that inherits from `AjaxDatatablesRails::ActiveRecord` is not tied to an
 existing model, module, constant or any type of class in your Rails app.
 You can pass a name to your datatable class like this:
 

lib/ajax-datatables-rails/active_record.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module AjaxDatatablesRails
+  class ActiveRecord < AjaxDatatablesRails::Base
+    include AjaxDatatablesRails::ORM::ActiveRecord
+  end
+end

lib/ajax-datatables-rails/base.rb

@@ -8,9 +8,8 @@ class Base
     GLOBAL_SEARCH_DELIMITER = ' '
 
     def initialize(params, options = {})
-      @params  = params
-      @options = options
-      load_orm_extension
+      @params    = params
+      @options   = options
       @datatable = Datatable::Datatable.new(self)
     end
 
@@ -108,16 +107,6 @@ def records_filtered_count
       filter_records(fetch_records).count(:all)
     end
 
-    # Private helper methods
-    def load_orm_extension
-      case AjaxDatatablesRails.config.orm
-      when :active_record
-        extend ORM::ActiveRecord
-      when :mongoid
-        nil
-      end
-    end
-
     def global_search_delimiter
       GLOBAL_SEARCH_DELIMITER
     end

lib/ajax-datatables-rails/config.rb

@@ -22,7 +22,6 @@ def self.config
   class Configuration
     include ActiveSupport::Configurable
 
-    config_accessor(:orm) { :active_record }
     config_accessor(:db_adapter) { :postgresql }
     config_accessor(:nulls_last) { false }
   end

lib/ajax_datatables_rails.rb

@@ -12,4 +12,5 @@ module AjaxDatatablesRails
   require 'ajax-datatables-rails/datatable/column/date_filter'
   require 'ajax-datatables-rails/datatable/column'
   require 'ajax-datatables-rails/orm/active_record'
+  require 'ajax-datatables-rails/active_record'
 end

lib/generators/datatable/templates/ajax_datatables_rails_config.rb

@@ -6,7 +6,4 @@
 
   # 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

lib/generators/rails/templates/datatable.rb

@@ -1,4 +1,4 @@
-class <%= datatable_name %> < AjaxDatatablesRails::Base
+class <%= datatable_name %> < AjaxDatatablesRails::ActiveRecord
 
   def view_columns
     # Declare strings in this format: ModelName.column_name

spec/ajax-datatables-rails/base_spec.rb

@@ -107,16 +107,63 @@
         end
       end
     end
+
+    describe '#filter_records' do
+      let(:records) { User.all }
+
+      let(:datatable) do
+        datatable = Class.new(ComplexDatatable) do
+          def filter_records(records)
+            raise NotImplementedError
+          end
+        end
+        datatable.new(sample_params)
+      end
+
+      it 'should allow method override' do
+        expect { datatable.filter_records(records) }.to raise_error(NotImplementedError)
+      end
+    end
+
+    describe '#sort_records' do
+      let(:records) { User.all }
+
+      let(:datatable) do
+        datatable = Class.new(ComplexDatatable) do
+          def sort_records(records)
+            raise NotImplementedError
+          end
+        end
+        datatable.new(sample_params)
+      end
+
+      it 'should allow method override' do
+        expect { datatable.sort_records(records) }.to raise_error(NotImplementedError)
+      end
+    end
+
+    describe '#paginate_records' do
+      let(:records) { User.all }
+
+      let(:datatable) do
+        datatable = Class.new(ComplexDatatable) do
+          def paginate_records(records)
+            raise NotImplementedError
+          end
+        end
+        datatable.new(sample_params)
+      end
+
+      it 'should allow method override' do
+        expect { datatable.paginate_records(records) }.to raise_error(NotImplementedError)
+      end
+    end
   end
 
 
   context 'Private API' do
     context 'when orm is not implemented' do
-      before do
-        allow_any_instance_of(AjaxDatatablesRails::Configuration).to receive(:orm) { nil }
-      end
-
-      let(:datatable) { ComplexDatatable.new(sample_params) }
+      let(:datatable) { AjaxDatatablesRails::Base.new(sample_params) }
 
       describe '#fetch_records' do
         it 'raises an error if it does not include an ORM module' do

spec/ajax-datatables-rails/configuration_spec.rb

@@ -20,10 +20,6 @@
   let(:config) { AjaxDatatablesRails::Configuration.new }
 
   describe 'default config' do
-    it 'default orm should :active_record' do
-      expect(config.orm).to eq(:active_record)
-    end
-
     it 'default db_adapter should :postgresql' do
       expect(config.db_adapter).to eq(:postgresql)
     end
@@ -34,10 +30,5 @@
       config.db_adapter = :mysql
       expect(config.db_adapter).to eq(:mysql)
     end
-
-    it 'accepts a custom orm value' do
-      config.orm = :mongoid
-      expect(config.orm).to eq(:mongoid)
-    end
   end
 end