ajax-datatables-rails 0.3.1 → 0.4.0

data/spec/ajax-datatables-rails/orm/active_record_paginate_records_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe AjaxDatatablesRails::ORM::ActiveRecord do
+
+  let(:view) { double('view', params: sample_params) }
+  let(:datatable) { SampleDatatable.new(view) }
+  let(:records) { User.all }
+
+  before(:each) do
+    create(:user, username: 'johndoe', email: 'johndoe@example.com')
+    create(:user, username: 'msmith', email: 'mary.smith@example.com')
+  end
+
+  describe '#paginate_records' do
+    it 'requires a records collection argument' do
+      expect { datatable.paginate_records }.to raise_error(ArgumentError)
+    end
+
+    it 'paginates records properly' do
+      if AjaxDatatablesRails.config.db_adapter.in? %i[oracle oracleenhanced]
+        if Rails.version.in? %w[4.0.13 4.1.15 4.2.8]
+          expect(datatable.paginate_records(records).to_sql).to include(
+            'rownum <= 10'
+          )
+        else
+          expect(datatable.paginate_records(records).to_sql).to include(
+            'rownum <= (0 + 10)'
+          )
+        end
+      else
+        expect(datatable.paginate_records(records).to_sql).to include(
+          'LIMIT 10 OFFSET 0'
+        )
+      end
+
+      datatable.params[:start] = '26'
+      datatable.params[:length] = '25'
+      if AjaxDatatablesRails.config.db_adapter.in? %i[oracle oracleenhanced]
+        if Rails.version.in? %w[4.0.13 4.1.15 4.2.8]
+          expect(datatable.paginate_records(records).to_sql).to include(
+            'rownum <= 50'
+          )
+        else
+          expect(datatable.paginate_records(records).to_sql).to include(
+            'rownum <= (25 + 25)'
+          )
+        end
+      else
+        expect(datatable.paginate_records(records).to_sql).to include(
+          'LIMIT 25 OFFSET 25'
+        )
+      end
+    end
+
+    it 'depends on the value of #offset' do
+      expect(datatable.datatable).to receive(:offset)
+      datatable.paginate_records(records)
+    end
+
+    it 'depends on the value of #per_page' do
+      expect(datatable.datatable).to receive(:per_page).at_least(:once) { 10 }
+      datatable.paginate_records(records)
+    end
+  end
+
+end

data/spec/ajax-datatables-rails/orm/active_record_sort_records_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe AjaxDatatablesRails::ORM::ActiveRecord do
+
+  let(:view) { double('view', params: sample_params) }
+  let(:datatable) { ComplexDatatable.new(view) }
+  let(:records) { User.all }
+
+  before(:each) do
+    create(:user, username: 'johndoe', email: 'johndoe@example.com')
+    create(:user, username: 'msmith', email: 'mary.smith@example.com')
+  end
+
+  describe '#sort_records' do
+    it 'returns a records collection sorted by :order params' do
+      # set to order Users by email in descending order
+      datatable.params[:order]['0'] = { column: '1', dir: 'desc' }
+      expect(datatable.sort_records(records).map(&:email)).to match(
+        ['mary.smith@example.com', 'johndoe@example.com']
+      )
+    end
+
+    it 'can handle multiple sorting columns' do
+      # set to order by Users username in ascending order, and
+      # by Users email in descending order
+      datatable.params[:order]['0'] = { column: '0', dir: 'asc' }
+      datatable.params[:order]['1'] = { column: '1', dir: 'desc' }
+      expect(datatable.sort_records(records).to_sql).to include(
+        'ORDER BY users.username ASC, users.email DESC'
+      )
+    end
+  end
+
+end

data/spec/ajax-datatables-rails/orm/active_record_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe AjaxDatatablesRails::ORM::ActiveRecord do
+  context 'Private API' do
+    let(:view) { double('view', params: sample_params) }
+    let(:datatable) { SampleDatatable.new(view) }
+
+    before(:each) do
+      create(:user, username: 'johndoe', email: 'johndoe@example.com')
+      create(:user, username: 'msmith', email: 'mary.smith@example.com')
+    end
+
+    describe '#fetch_records' do
+      it 'calls #get_raw_records' do
+        expect(datatable).to receive(:get_raw_records) { User.all }
+        datatable.send(:fetch_records)
+      end
+
+      it 'returns a collection of records' do
+        expect(datatable).to receive(:get_raw_records) { User.all }
+        expect(datatable.send(:fetch_records)).to be_a(ActiveRecord::Relation)
+      end
+    end
+  end
+end

data/spec/factories/user.rb

@@ -0,0 +1,9 @@
+FactoryGirl.define do
+  factory :user do |f|
+    f.username   { Faker::Internet.user_name }
+    f.email      { Faker::Internet.email }
+    f.first_name { Faker::Name.first_name }
+    f.last_name  { Faker::Name.last_name }
+    f.post_id    { ((1..100).to_a).sample }
+  end
+end

data/spec/install_oracle.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+wget 'https://github.com/cbandy/travis-oracle/archive/v2.0.2.tar.gz'
+mkdir -p ~/.travis/oracle
+tar xz --strip-components 1 -C ~/.travis/oracle -f v2.0.2.tar.gz
+
+~/.travis/oracle/download.sh
+~/.travis/oracle/install.sh
+
+"$ORACLE_HOME/bin/sqlplus" -L -S / AS SYSDBA <<SQL
+ALTER USER $USER IDENTIFIED BY $USER;
+SQL

data/spec/spec_helper.rb

@@ -1,9 +1,81 @@
+require 'simplecov'
+require 'rspec'
+require 'database_cleaner'
+require 'factory_girl'
+require 'faker'
 require 'pry'
 require 'rails'
 require 'active_record'
+require 'action_controller'
+
+# Start Simplecov
+SimpleCov.start do
+  add_filter 'spec/'
+end
+
+# Configure RSpec
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+
+  config.before(:suite) do
+    FactoryGirl.find_definitions
+  end
+
+  config.after(:each) do
+    AjaxDatatablesRails.configure do |c|
+      c.db_adapter = ActiveRecord::Base.connection.adapter_name.downcase.to_sym
+      c.orm = :active_record
+    end
+  end
+
+  config.color = true
+  config.fail_fast = false
+
+  config.order = :random
+  Kernel.srand config.seed
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.before(:suite) do
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.strategy = :transaction
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end
+
 require 'ajax-datatables-rails'
 
-ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+adapter = ENV.fetch('DB_ADAPTER', 'postgresql')
+
+options = {
+  adapter:  adapter,
+  database: 'ajax_datatables_rails',
+  encoding: 'utf8'
+}
+
+options = options.merge(username: 'root') if adapter == 'mysql2'
+options = options.merge(username: ENV['USER'], password: ENV['USER'], database: 'xe', host: '127.0.0.1/xe') if adapter == 'oracle_enhanced'
+options = options.merge(database: ':memory:') if adapter == 'sqlite3'
+
+ActiveRecord::Base.establish_connection(options)
+
+AjaxDatatablesRails.configure do |c|
+  c.db_adapter = ActiveRecord::Base.connection.adapter_name.downcase.to_sym
+  c.orm = :active_record
+end
 
-load File.dirname(__FILE__) + '/schema.rb'
-require File.dirname(__FILE__) + '/test_models.rb'
+load File.dirname(__FILE__) + '/support/schema.rb'
+load File.dirname(__FILE__) + '/support/test_helpers.rb'
+require File.dirname(__FILE__) + '/support/test_models.rb'

data/spec/support/schema.rb

@@ -0,0 +1,14 @@
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :users, :force => true do |t|
+    t.string  :username
+    t.string  :email
+    t.string  :first_name
+    t.string  :last_name
+    t.integer :post_id
+
+    t.timestamps null: false
+  end
+
+end

data/spec/support/test_helpers.rb

@@ -0,0 +1,174 @@
+# rubocop:disable Metrics/MethodLength
+def sample_params
+  ActionController::Parameters.new(
+    {
+      'draw' => '1',
+      'columns' => {
+        '0' => {
+          'data' => 'username', 'name' => '', 'searchable' => 'true', 'orderable' => 'true',
+          'search' => {
+            'value' => '', 'regex' => 'false'
+          }
+        },
+        '1' => {
+          'data' => 'email', 'name' => '', 'searchable' => 'true', 'orderable' => 'true',
+          'search' => {
+            'value' => '', 'regex' => 'false'
+          }
+        },
+        '2' => {
+          'data' => 'first_name', 'name' => '', 'searchable' => 'true', 'orderable' => 'false',
+          'search' => {
+            'value' => '', 'regex' => 'false'
+          }
+        },
+        '3' => {
+          'data' => 'last_name', 'name' => '', 'searchable' => 'true', 'orderable' => 'true',
+          'search' => {
+            'value' => '', 'regex' => 'false'
+          }
+        },
+        '4' => {
+          'data' => 'post_id', 'name' => '', 'searchable' => 'true', 'orderable' => 'true',
+          'search' => {
+            'value' => '', 'regex' => 'false'
+          }
+        },
+        '5' => {
+          'data' => 'created_at', 'name' => '', 'searchable' => 'true', 'orderable' => 'true',
+          'search' => {
+            'value' => '', 'regex' => 'false'
+          }
+        },
+      },
+      'order' => {
+        '0' => {'column' => '0', 'dir' => 'asc'}
+      },
+      'start' => '0', 'length' => '10', 'search' => {
+        'value' => '', 'regex' => 'false'
+      },
+      '_' => '1423364387185'
+    }
+  )
+end
+# rubocop:enable Metrics/MethodLength
+
+class SampleDatatable < AjaxDatatablesRails::Base
+  def view_columns
+    @view_columns ||= ['User.username', 'User.email', 'User.first_name', 'User.last_name']
+  end
+
+  def data
+    [{}, {}]
+  end
+
+  def get_raw_records
+    User.all
+  end
+end
+
+class ComplexDatatable < SampleDatatable
+  def view_columns
+    @view_columns ||= {
+      username:   { source: 'User.username' },
+      email:      { source: 'User.email' },
+      first_name: { source: 'User.first_name' },
+      last_name:  { source: 'User.last_name', formater: -> (o) { o.upcase } },
+    }
+  end
+
+  def data
+    records.map do |record|
+      {
+        username:   record.username,
+        email:      record.email,
+        first_name: record.first_name,
+        last_name:  record.last_name,
+      }
+    end
+  end
+end
+
+class ComplexDatatableHash < ComplexDatatable
+end
+
+class ComplexDatatableArray < ComplexDatatable
+  def data
+    records.map do |record|
+      [
+        record.username,
+        record.email,
+        record.first_name,
+        record.last_name,
+      ]
+    end
+  end
+end
+
+class ReallyComplexDatatable < SampleDatatable
+  def view_columns
+    @view_columns ||= {
+      username:   { source: 'User.username' },
+      email:      { source: 'User.email',      cond: :null_value },
+      first_name: { source: 'User.first_name', cond: :start_with },
+      last_name:  { source: 'User.last_name',  cond: :end_with, formater: -> (o) { o.upcase } },
+      post_id:    { source: 'User.post_id' },
+      created_at: { source: 'User.created_at', cond: :date_range },
+    }
+  end
+
+  def data
+    records.map do |record|
+      {
+        username:   record.username,
+        email:      record.email,
+        first_name: record.first_name,
+        last_name:  record.last_name,
+        post_id:    record.post_id,
+        created_at: record.created_at,
+      }
+    end
+  end
+end
+
+class ReallyComplexDatatableEq < ReallyComplexDatatable
+  def view_columns
+    super.deep_merge(post_id: { cond: :eq })
+  end
+end
+
+class ReallyComplexDatatableNotEq < ReallyComplexDatatable
+  def view_columns
+    super.deep_merge(post_id: { cond: :not_eq })
+  end
+end
+
+class ReallyComplexDatatableLt < ReallyComplexDatatable
+  def view_columns
+    super.deep_merge(post_id: { cond: :lt })
+  end
+end
+
+class ReallyComplexDatatableGt < ReallyComplexDatatable
+  def view_columns
+    super.deep_merge(post_id: { cond: :gt })
+  end
+end
+
+class ReallyComplexDatatableLteq < ReallyComplexDatatable
+  def view_columns
+    super.deep_merge(post_id: { cond: :lteq })
+  end
+end
+
+class ReallyComplexDatatableGteq < ReallyComplexDatatable
+  def view_columns
+    super.deep_merge(post_id: { cond: :gteq })
+  end
+end
+
+class ReallyComplexDatatableIn < ReallyComplexDatatable
+  def view_columns
+    super.deep_merge(post_id: { cond: :in })
+  end
+end

data/spec/support/test_models.rb

@@ -0,0 +1,2 @@
+class User < ActiveRecord::Base
+end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: ajax-datatables-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Joel Quenneville
+- Antonio Antillon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-13 00:00:00.000000000 Z
+date: 2017-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -16,14 +17,98 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord-oracle_enhanced-adapter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -67,7 +152,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +166,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,68 +180,107 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: factory_girl
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: faker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.6
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.6
-description: A gem that simplifies using datatables and hundreds of records via ajax
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A wrapper around datatable's ajax methods that allow synchronization
+  with server-side pagination in a rails app
 email:
 - joel.quenneville@collegeplus.org
+- antillas21@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Appraisals
 - CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - ajax-datatables-rails.gemspec
+- gemfiles/rails_4.0.13.gemfile
+- gemfiles/rails_4.1.15.gemfile
+- gemfiles/rails_4.2.8.gemfile
+- gemfiles/rails_5.0.3.gemfile
+- gemfiles/rails_5.1.1.gemfile
 - lib/ajax-datatables-rails.rb
 - lib/ajax-datatables-rails/base.rb
 - lib/ajax-datatables-rails/config.rb
-- lib/ajax-datatables-rails/extensions/kaminari.rb
-- lib/ajax-datatables-rails/extensions/simple_paginator.rb
-- lib/ajax-datatables-rails/extensions/will_paginate.rb
-- lib/ajax-datatables-rails/models.rb
+- lib/ajax-datatables-rails/datatable/column.rb
+- lib/ajax-datatables-rails/datatable/column_date_filter.rb
+- lib/ajax-datatables-rails/datatable/datatable.rb
+- lib/ajax-datatables-rails/datatable/simple_order.rb
+- lib/ajax-datatables-rails/datatable/simple_search.rb
+- lib/ajax-datatables-rails/orm/active_record.rb
 - lib/ajax-datatables-rails/version.rb
 - lib/generators/datatable/config_generator.rb
 - lib/generators/datatable/templates/ajax_datatables_rails_config.rb
 - lib/generators/rails/datatable_generator.rb
 - lib/generators/rails/templates/datatable.rb
-- spec/ajax-datatables-rails/ajax_datatables_rails_spec.rb
-- spec/ajax-datatables-rails/kaminari_spec.rb
-- spec/ajax-datatables-rails/models_spec.rb
-- spec/ajax-datatables-rails/simple_paginator_spec.rb
-- spec/ajax-datatables-rails/will_paginate_spec.rb
-- spec/schema.rb
+- spec/ajax-datatables-rails/base_spec.rb
+- spec/ajax-datatables-rails/configuration_spec.rb
+- spec/ajax-datatables-rails/datatable/column_spec.rb
+- spec/ajax-datatables-rails/datatable/datatable_spec.rb
+- spec/ajax-datatables-rails/datatable/simple_order_spec.rb
+- spec/ajax-datatables-rails/datatable/simple_search_spec.rb
+- spec/ajax-datatables-rails/extended_spec.rb
+- spec/ajax-datatables-rails/orm/active_record_filter_records_spec.rb
+- spec/ajax-datatables-rails/orm/active_record_paginate_records_spec.rb
+- spec/ajax-datatables-rails/orm/active_record_sort_records_spec.rb
+- spec/ajax-datatables-rails/orm/active_record_spec.rb
+- spec/factories/user.rb
+- spec/install_oracle.sh
 - spec/spec_helper.rb
-- spec/test_models.rb
-homepage: ''
-licenses: []
+- spec/support/schema.rb
+- spec/support/test_helpers.rb
+- spec/support/test_models.rb
+homepage: https://github.com/jbox-web/ajax-datatables-rails
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -166,7 +290,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -174,17 +298,25 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
-summary: A wrapper around datatable's ajax methods that allow synchronization with
-  server-side pagination in a rails app
+summary: A gem that simplifies using datatables and hundreds of records via ajax
 test_files:
-- spec/ajax-datatables-rails/ajax_datatables_rails_spec.rb
-- spec/ajax-datatables-rails/kaminari_spec.rb
-- spec/ajax-datatables-rails/models_spec.rb
-- spec/ajax-datatables-rails/simple_paginator_spec.rb
-- spec/ajax-datatables-rails/will_paginate_spec.rb
-- spec/schema.rb
+- spec/ajax-datatables-rails/base_spec.rb
+- spec/ajax-datatables-rails/configuration_spec.rb
+- spec/ajax-datatables-rails/datatable/column_spec.rb
+- spec/ajax-datatables-rails/datatable/datatable_spec.rb
+- spec/ajax-datatables-rails/datatable/simple_order_spec.rb
+- spec/ajax-datatables-rails/datatable/simple_search_spec.rb
+- spec/ajax-datatables-rails/extended_spec.rb
+- spec/ajax-datatables-rails/orm/active_record_filter_records_spec.rb
+- spec/ajax-datatables-rails/orm/active_record_paginate_records_spec.rb
+- spec/ajax-datatables-rails/orm/active_record_sort_records_spec.rb
+- spec/ajax-datatables-rails/orm/active_record_spec.rb
+- spec/factories/user.rb
+- spec/install_oracle.sh
 - spec/spec_helper.rb
-- spec/test_models.rb
+- spec/support/schema.rb
+- spec/support/test_helpers.rb
+- spec/support/test_models.rb