ajax-datatables-rails 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0b5b7242e164445bb1f0faaadadce3cdac7abc9a95ae813f29ff8754eb92060
-  data.tar.gz: b7551245872059aa1dba5dca216ed54fd5a3852a104e7fa6b5cd88c2e6a301a9
+  metadata.gz: c458882fe0c2ff86e0b262ccdc9e37af67c348941f902e29bee7a9ec7b1ad9f0
+  data.tar.gz: 9fe38de08324f1f281f5a7c24d3e0c782c71bc741a23ae301952c0ef7bfcbb09
 SHA512:
-  metadata.gz: 8715a74263a88667f384069d0975c67ec34b558c61291731f4e440d5e46cd803b3b978667b7dcd9945406abc5651f70254904a9f5c5f64172703f040da7a5dce
-  data.tar.gz: 93a2dda89e7293509eaf58525e445616b4f62a126d258b567445c4c143a518f7984cdccefc4186912aa64d6d0c49739cb054e26bd34ab9a9119da43f737c61ce
+  metadata.gz: 943655268357523c6594845e708f41fbe515284736b1c96d6150514b6c39478d563719c4051c0c3568942e138c1166ab2193cec5585742c1640242a7adbdd381
+  data.tar.gz: 6507a0827be528e61dfb07f905b4016d0d65543b19b3becf8d557884890fa88dbdefd815441f0b6f4cc4c784b24ebb58924f0b69357576295138af67cdf7ca78

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 1.3.1 (2021-02-09)
+
+* Fix rare case error `uninitialized constant AjaxDatatablesRails::ActiveRecord::Base` (merge: [#379](https://github.com/jbox-web/ajax-datatables-rails/pull/379))
+
 ## 1.3.0 (2021-01-04)
 
 * Drop support of Rails 5.0.x and 5.1.x

data/README.md

@@ -532,13 +532,13 @@ available in our datatable to search and sort by.
 
 def view_columns
   @view_columns ||= {
-    first_name:       'User.first_name',
-    last_name:        'User.last_name',
-    order_number:     'PurchaseOrder.number',
-    order_created_at: 'PurchaseOrder.created_at',
-    quantity:         'Purchase::LineItem.quantity',
-    unit_price:       'Purchase::LineItem.unit_price',
-    item_total:       'Purchase::LineItem.item_total'
+    first_name:       { source: 'User.first_name' },
+    last_name:        { source: 'User.last_name' },
+    order_number:     { source: 'PurchaseOrder.number' },
+    order_created_at: { source: 'PurchaseOrder.created_at' },
+    quantity:         { source: 'Purchase::LineItem.quantity' },
+    unit_price:       { source: 'Purchase::LineItem.unit_price' },
+    item_total:       { source: 'Purchase::LineItem.item_total }'
   }
 end
 ```
@@ -570,14 +570,14 @@ The related definition would be :
 ```ruby
 def view_columns
   @view_columns ||= {
-    course_type:     'CourseType.name',
-    course_name:     'Course.name',
-    contact_name:    'Contact.full_name',
-    competency_type: 'CompetencyType.name',
-    event_title:     'Event.title',
-    event_start:     'Event.event_start',
-    event_end:       'Event.event_end',
-    event_status:    'Event.status',
+    course_type:     { source: 'CourseType.name' },
+    course_name:     { source: 'Course.name' },
+    contact_name:    { source: 'Contact.full_name' },
+    competency_type: { source: 'CompetencyType.name' },
+    event_title:     { source: 'Event.title' },
+    event_start:     { source: 'Event.event_start' },
+    event_end:       { source: 'Event.event_end' },
+    event_status:    { source: 'Event.status' },
   }
 end
 

data/bin/bundle

@@ -0,0 +1,114 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bundle' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "rubygems"
+
+m = Module.new do
+  module_function
+
+  def invoked_as_script?
+    File.expand_path($0) == File.expand_path(__FILE__)
+  end
+
+  def env_var_version
+    ENV["BUNDLER_VERSION"]
+  end
+
+  def cli_arg_version
+    return unless invoked_as_script? # don't want to hijack other binstubs
+    return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update`
+    bundler_version = nil
+    update_index = nil
+    ARGV.each_with_index do |a, i|
+      if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
+        bundler_version = a
+      end
+      next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
+      bundler_version = $1
+      update_index = i
+    end
+    bundler_version
+  end
+
+  def gemfile
+    gemfile = ENV["BUNDLE_GEMFILE"]
+    return gemfile if gemfile && !gemfile.empty?
+
+    File.expand_path("../../Gemfile", __FILE__)
+  end
+
+  def lockfile
+    lockfile =
+      case File.basename(gemfile)
+      when "gems.rb" then gemfile.sub(/\.rb$/, gemfile)
+      else "#{gemfile}.lock"
+      end
+    File.expand_path(lockfile)
+  end
+
+  def lockfile_version
+    return unless File.file?(lockfile)
+    lockfile_contents = File.read(lockfile)
+    return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
+    Regexp.last_match(1)
+  end
+
+  def bundler_version
+    @bundler_version ||=
+      env_var_version || cli_arg_version ||
+        lockfile_version
+  end
+
+  def bundler_requirement
+    return "#{Gem::Requirement.default}.a" unless bundler_version
+
+    bundler_gem_version = Gem::Version.new(bundler_version)
+
+    requirement = bundler_gem_version.approximate_recommendation
+
+    return requirement unless Gem::Version.new(Gem::VERSION) < Gem::Version.new("2.7.0")
+
+    requirement += ".a" if bundler_gem_version.prerelease?
+
+    requirement
+  end
+
+  def load_bundler!
+    ENV["BUNDLE_GEMFILE"] ||= gemfile
+
+    activate_bundler
+  end
+
+  def activate_bundler
+    gem_error = activation_error_handling do
+      gem "bundler", bundler_requirement
+    end
+    return if gem_error.nil?
+    require_error = activation_error_handling do
+      require "bundler/version"
+    end
+    return if require_error.nil? && Gem::Requirement.new(bundler_requirement).satisfied_by?(Gem::Version.new(Bundler::VERSION))
+    warn "Activating bundler (#{bundler_requirement}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_requirement}'`"
+    exit 42
+  end
+
+  def activation_error_handling
+    yield
+    nil
+  rescue StandardError, LoadError => e
+    e
+  end
+end
+
+m.load_bundler!
+
+if m.invoked_as_script?
+  load Gem.bin_path("bundler", "bundle")
+end

data/doc/migrate.md

@@ -1,4 +1,4 @@
-## To migrate from `v1.0.x` to `v1.3.0`
+## To migrate from `v1.x` to `v1.3.0`
 
 The *v1.3.0* version has some breaking changes :
 

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

@@ -3,7 +3,7 @@
 module AjaxDatatablesRails
   class Base
 
-    class_attribute :db_adapter, default: ActiveRecord::Base.connection.adapter_name.downcase.to_sym
+    class_attribute :db_adapter, default: ::ActiveRecord::Base.connection.adapter_name.downcase.to_sym
     class_attribute :nulls_last, default: false
 
     attr_reader :params, :options, :datatable

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

@@ -62,11 +62,11 @@ module AjaxDatatablesRails
           when :eq, :not_eq, :lt, :gt, :lteq, :gteq, :in
             searchable_integer? ? raw_search(cond) : empty_search
           when :start_with
-            casted_column.matches("#{formatted_value}%")
+            text_search("#{formatted_value}%")
           when :end_with
-            casted_column.matches("%#{formatted_value}")
+            text_search("%#{formatted_value}")
           when :like
-            casted_column.matches("%#{formatted_value}%")
+            text_search("%#{formatted_value}%")
           when :string_eq
             raw_search(:eq)
           when :string_in
@@ -95,6 +95,10 @@ module AjaxDatatablesRails
           end
         end
 
+        def text_search(value)
+          casted_column.matches(value)
+        end
+
         def empty_search
           casted_column.matches(EMPTY_VALUE)
         end

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

@@ -2,7 +2,6 @@
 
 module AjaxDatatablesRails
   module Datatable
-
     class Datatable
       attr_reader :options
 

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

@@ -9,7 +9,7 @@ module AjaxDatatablesRails
   module VERSION
     MAJOR = 1
     MINOR = 3
-    TINY  = 0
+    TINY  = 1
     PRE   = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')

data/spec/ajax-datatables-rails/base_spec.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
-describe AjaxDatatablesRails::Base do
+RSpec.describe AjaxDatatablesRails::Base do
 
   describe 'an instance' do
     it 'requires a hash of params' do
@@ -15,9 +17,11 @@ describe AjaxDatatablesRails::Base do
 
   describe 'User API' do
     describe '#view_columns' do
-      it 'raises an error if not defined by the user' do
-        datatable = described_class.new(sample_params)
-        expect { datatable.view_columns }.to raise_error NotImplementedError
+      context 'when method is not defined by the user' do
+        it 'raises an error' do
+          datatable = described_class.new(sample_params)
+          expect { datatable.view_columns }.to raise_error NotImplementedError
+        end
       end
 
       context 'child class implements view_columns' do
@@ -29,22 +33,26 @@ describe AjaxDatatablesRails::Base do
     end
 
     describe '#get_raw_records' do
-      it 'raises an error if not defined by the user' do
-        datatable = described_class.new(sample_params)
-        expect { datatable.get_raw_records }.to raise_error NotImplementedError
+      context 'when method is not defined by the user' do
+        it 'raises an error' do
+          datatable = described_class.new(sample_params)
+          expect { datatable.get_raw_records }.to raise_error NotImplementedError
+        end
       end
     end
 
     describe '#data' do
-      it 'raises an error if not defined by the user' do
-        datatable = described_class.new(sample_params)
-        expect { datatable.data }.to raise_error NotImplementedError
+      context 'when method is not defined by the user' do
+        it 'raises an error' do
+          datatable = described_class.new(sample_params)
+          expect { datatable.data }.to raise_error NotImplementedError
+        end
       end
 
       context 'when data is defined as a hash' do
         let(:datatable) { ComplexDatatable.new(sample_params) }
 
-        it 'should return an array of hashes' do
+        it 'returns an array of hashes' do
           create_list(:user, 5)
           expect(datatable.data).to be_a(Array)
           expect(datatable.data.size).to eq 5
@@ -52,7 +60,7 @@ describe AjaxDatatablesRails::Base do
           expect(item).to be_a(Hash)
         end
 
-        it 'should html escape data' do
+        it 'htmls escape data' do
           create(:user, first_name: 'Name "><img src=x onerror=alert("first_name")>', last_name: 'Name "><img src=x onerror=alert("last_name")>')
           data = datatable.send(:sanitize_data, datatable.data)
           item = data.first
@@ -64,7 +72,7 @@ describe AjaxDatatablesRails::Base do
       context 'when data is defined as a array' do
         let(:datatable) { ComplexDatatableArray.new(sample_params) }
 
-        it 'should return an array of arrays' do
+        it 'returns an array of arrays' do
           create_list(:user, 5)
           expect(datatable.data).to be_a(Array)
           expect(datatable.data.size).to eq 5
@@ -72,7 +80,7 @@ describe AjaxDatatablesRails::Base do
           expect(item).to be_a(Array)
         end
 
-        it 'should html escape data' do
+        it 'htmls escape data' do
           create(:user, first_name: 'Name "><img src=x onerror=alert("first_name")>', last_name: 'Name "><img src=x onerror=alert("last_name")>')
           data = datatable.send(:sanitize_data, datatable.data)
           item = data.first
@@ -131,6 +139,18 @@ describe AjaxDatatablesRails::Base do
           datatable.new(sample_params)
         end
 
+        describe '#fetch_records' do
+          it 'calls #get_raw_records' do
+            expect(datatable).to receive(:get_raw_records) { User.all }
+            datatable.fetch_records
+          end
+
+          it 'returns a collection of records' do
+            expect(datatable).to receive(:get_raw_records) { User.all }
+            expect(datatable.fetch_records).to be_a(ActiveRecord::Relation)
+          end
+        end
+
         describe '#filter_records' do
           it {
             expect { datatable.filter_records([]) }.to raise_error(NotImplementedError).with_message('FOO')
@@ -156,7 +176,7 @@ describe AjaxDatatablesRails::Base do
     describe '#as_json' do
       let(:datatable) { ComplexDatatable.new(sample_params) }
 
-      it 'should return a hash' do
+      it 'returns a hash' do
         create_list(:user, 5)
         data = datatable.as_json
         expect(data[:recordsTotal]).to eq 5
@@ -166,9 +186,9 @@ describe AjaxDatatablesRails::Base do
       end
 
       context 'with additional_data' do
-        it 'should return a hash' do
+        it 'returns a hash' do
           create_list(:user, 5)
-          expect(datatable).to receive(:additional_data){ { foo: 'bar' } }
+          expect(datatable).to receive(:additional_data) { { foo: 'bar' } }
           data = datatable.as_json
           expect(data[:recordsTotal]).to eq 5
           expect(data[:recordsFiltered]).to eq 5
@@ -184,7 +204,7 @@ describe AjaxDatatablesRails::Base do
     describe '#column_id' do
       let(:datatable) { ComplexDatatable.new(sample_params) }
 
-      it 'should return column id from view_columns hash' do
+      it 'returns column id from view_columns hash' do
         expect(datatable.column_id(:username)).to eq(0)
         expect(datatable.column_id('username')).to eq(0)
       end
@@ -194,7 +214,7 @@ describe AjaxDatatablesRails::Base do
       let(:datatable) { ComplexDatatable.new(sample_params) }
       before { datatable.params[:columns]['0'][:search][:value] = 'doe' }
 
-      it 'should return column data from params' do
+      it 'returns column data from params' do
         expect(datatable.column_data(:username)).to eq('doe')
         expect(datatable.column_data('username')).to eq('doe')
       end

data/spec/ajax-datatables-rails/datatable/column_spec.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
-describe AjaxDatatablesRails::Datatable::Column do
+RSpec.describe AjaxDatatablesRails::Datatable::Column do
 
   let(:datatable) { ComplexDatatable.new(sample_params) }
 
@@ -8,50 +10,49 @@ describe AjaxDatatablesRails::Datatable::Column do
 
     let(:column) { datatable.datatable.columns.first }
 
-    before do
-      datatable.params[:columns] = {'0'=>{'data'=>'username', 'name'=>'', 'searchable'=>'true', 'orderable'=>'true', 'search'=>{'value'=>'searchvalue', 'regex'=>'false'}}}
-    end
+    before { datatable.params[:columns]['0'][:search][:value] = 'searchvalue' }
 
-    it 'should be orderable' do
+    it 'is orderable' do
       expect(column.orderable?).to eq(true)
     end
 
-    it 'should sort nulls last' do
+    it 'sorts nulls last' do
       expect(column.nulls_last?).to eq(false)
     end
 
-    it 'should be searchable' do
+    it 'is searchable' do
       expect(column.searchable?).to eq(true)
     end
 
-    it 'should be searched' do
+    it 'is searched' do
       expect(column.searched?).to eq(true)
     end
 
-    it 'should have connected to id column' do
+    it 'has connected to id column' do
       expect(column.data).to eq('username')
     end
 
     describe '#data' do
-      it 'should return the data from params' do
+      it 'returns the data from params' do
         expect(column.data).to eq 'username'
       end
     end
 
     describe '#source' do
-      it 'should return the data source from view_column' do
+      it 'returns the data source from view_column' do
         expect(column.source).to eq 'User.username'
       end
     end
 
     describe '#table' do
       context 'with ActiveRecord ORM' do
-        it 'should return the corresponding AR table' do
+        it 'returns the corresponding AR table' do
           expect(column.table).to eq User.arel_table
         end
       end
+
       context 'with other ORM' do
-        it 'should return the corresponding model' do
+        it 'returns the corresponding model' do
           expect(User).to receive(:respond_to?).with(:arel_table).and_return(false)
           expect(column.table).to eq User
         end
@@ -59,19 +60,19 @@ describe AjaxDatatablesRails::Datatable::Column do
     end
 
     describe '#model' do
-      it 'should return the corresponding AR model' do
+      it 'returns the corresponding AR model' do
         expect(column.model).to eq User
       end
     end
 
     describe '#field' do
-      it 'should return the corresponding field in DB' do
+      it 'returns the corresponding field in DB' do
         expect(column.field).to eq :username
       end
     end
 
     describe '#custom_field?' do
-      it 'should return false if field is bound to an AR field' do
+      it 'returns false if field is bound to an AR field' do
         expect(column.custom_field?).to be false
       end
     end
@@ -81,47 +82,47 @@ describe AjaxDatatablesRails::Datatable::Column do
         expect(column.search).to be_a(AjaxDatatablesRails::Datatable::SimpleSearch)
       end
 
-      it 'should have search value' do
+      it 'has search value' do
         expect(column.search.value).to eq('searchvalue')
       end
 
-      it 'should not regex' do
+      it 'does not regex' do
         expect(column.search.regexp?).to eq false
       end
     end
 
     describe '#cond' do
-      it 'should be :like by default' do
+      it 'is :like by default' do
         expect(column.cond).to eq(:like)
       end
     end
 
     describe '#source' do
-      it 'should be :like by default' do
+      it 'is :like by default' do
         expect(column.source).to eq('User.username')
       end
     end
 
     describe '#search_query' do
-      it 'should buld search query' do
+      it 'bulds search query' do
         expect(column.search_query.to_sql).to include('%searchvalue%')
       end
     end
 
     describe '#sort_query' do
-      it 'should build sort query' do
+      it 'builds sort query' do
         expect(column.sort_query).to eq('users.username')
       end
     end
 
     describe '#use_regex?' do
-      it 'should be true by default' do
+      it 'is true by default' do
         expect(column.use_regex?).to be true
       end
     end
 
     describe '#delimiter' do
-      it 'should be - by default' do
+      it 'is - by default' do
         expect(column.delimiter).to eq('-')
       end
     end
@@ -131,7 +132,7 @@ describe AjaxDatatablesRails::Datatable::Column do
     let(:datatable) { DatatableWithFormater.new(sample_params) }
     let(:column) { datatable.datatable.columns.find { |c| c.data == 'last_name' } }
 
-    it 'should be a proc' do
+    it 'is a proc' do
       expect(column.formatter).to be_a(Proc)
     end
   end
@@ -140,7 +141,7 @@ describe AjaxDatatablesRails::Datatable::Column do
     let(:datatable) { DatatableCondProc.new(sample_params) }
     let(:column) { datatable.datatable.columns.find { |c| c.data == 'username' } }
 
-    it 'should be a proc' do
+    it 'is a proc' do
       config = column.instance_variable_get('@view_column')
       filter = config[:cond]
       expect(filter).to be_a(Proc)
@@ -204,19 +205,15 @@ describe AjaxDatatablesRails::Datatable::Column do
   end
 
   describe 'when empty column' do
-    before do
-      datatable.params[:columns] = {'0'=>{'data'=>'', 'name'=>'', 'searchable'=>'true', 'orderable'=>'true', 'search'=>{'value'=>'searchvalue', 'regex'=>'false'}}}
-    end
+    before { datatable.params[:columns]['0'][:data] = '' }
 
     it 'raises error' do
-      expect { datatable.to_json }.to raise_error(AjaxDatatablesRails::Error::InvalidSearchColumn).with_message("Unknown column. Check that `data` field is filled on JS side with the column name")
+      expect { datatable.to_json }.to raise_error(AjaxDatatablesRails::Error::InvalidSearchColumn).with_message('Unknown column. Check that `data` field is filled on JS side with the column name')
     end
   end
 
   describe 'when unknown column' do
-    before do
-      datatable.params[:columns] = {'0'=>{'data'=>'foo', 'name'=>'', 'searchable'=>'true', 'orderable'=>'true', 'search'=>{'value'=>'searchvalue', 'regex'=>'false'}}}
-    end
+    before { datatable.params[:columns]['0'][:data] = 'foo' }
 
     it 'raises error' do
       expect { datatable.to_json }.to raise_error(AjaxDatatablesRails::Error::InvalidSearchColumn).with_message("Check that column 'foo' exists in view_columns")