ajax-datatables-rails 0.4.2 → 1.3.0

data/Rakefile

@@ -10,6 +10,7 @@ task :console do
   require 'pry'
   require 'rails'
   require 'ajax-datatables-rails'
+  puts 'Loaded AjaxDatatablesRails'
   ARGV.clear
   Pry.start
 end

data/ajax-datatables-rails.gemspec

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
-# coding: utf-8
 
-$LOAD_PATH.push File.expand_path('../lib', __FILE__)
-require 'ajax-datatables-rails/version'
+require_relative 'lib/ajax-datatables-rails/version'
 
 Gem::Specification.new do |s|
   s.name        = 'ajax-datatables-rails'
-  s.version     = AjaxDatatablesRails::VERSION
+  s.version     = AjaxDatatablesRails::VERSION::STRING
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['Joel Quenneville', 'Antonio Antillon']
   s.email       = ['joel.quenneville@collegeplus.org', 'antillas21@gmail.com']
@@ -14,26 +12,32 @@ Gem::Specification.new do |s|
   s.summary     = 'A gem that simplifies using datatables and hundreds of records via ajax'
   s.description = "A wrapper around datatable's ajax methods that allow synchronization with server-side pagination in a rails app"
   s.license     = 'MIT'
+  s.metadata    = {
+    'homepage_uri'    => 'https://github.com/jbox-web/ajax-datatables-rails',
+    'changelog_uri'   => 'https://github.com/jbox-web/ajax-datatables-rails/blob/master/CHANGELOG.md',
+    'source_code_uri' => 'https://github.com/jbox-web/ajax-datatables-rails',
+    'bug_tracker_uri' => 'https://github.com/jbox-web/ajax-datatables-rails/issues',
+  }
 
-  s.add_dependency 'railties', '>= 4.0'
+  s.required_ruby_version = '>= 2.5.0'
+
+  s.files = `git ls-files`.split("\n")
+
+  s.add_runtime_dependency 'zeitwerk'
 
-  s.add_development_dependency 'rails', '>= 4.0'
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'pg', '< 1.0'
-  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 'appraisal'
   s.add_development_dependency 'database_cleaner'
   s.add_development_dependency 'factory_bot'
   s.add_development_dependency 'faker'
-  s.add_development_dependency 'appraisal'
-
-  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']
+  s.add_development_dependency 'generator_spec'
+  s.add_development_dependency 'guard-rspec'
+  s.add_development_dependency 'pg'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'rails', '>= 5.2'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rspec-retry'
+  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'simplecov'
 end

data/bin/_guard-core

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application '_guard-core' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("guard", "_guard-core")

data/bin/appraisal

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'appraisal' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("appraisal", "appraisal")

data/bin/guard

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'guard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("guard", "guard")

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/rubocop

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

data/doc/migrate.md

@@ -0,0 +1,97 @@
+## To migrate from `v1.0.x` to `v1.3.0`
+
+The *v1.3.0* version has some breaking changes :
+
+* `AjaxDatatablesRails.config.db_adapter=` is removed and is configured per datatable class now. It defaults to Rails DB adapter. (fixes [#364](https://github.com/jbox-web/ajax-datatables-rails/issues/364))
+
+This change is transparent for everyone. Just remove `AjaxDatatablesRails.config.db_adapter=` from your configuration (if exists) and it should work fine.
+
+Now you can use AjaxDatatablesRails in multi-db environments.
+
+* `AjaxDatatablesRails.config.nulls_last=` is removed and is configured per datatable class now (or by column). It defaults to false.
+
+This change is easy to mitigate : add `self.nulls_last = true` in [`ApplicationDatatable`](https://github.com/jbox-web/ajax-datatables-rails#create-a-master-parent-class-easy) and remove `AjaxDatatablesRails.config.nulls_last=`
+
+```ruby
+class ApplicationDatatable < AjaxDatatablesRails::ActiveRecord
+  self.nulls_last = true
+  # puts commonly used methods here
+end
+```
+
+* `AjaxDatatablesRails.config` is removed with no replacement
+
+Fix the two changes above and remove any configuration file about AjaxDatatablesRails. The gem is now configless :)
+
+## To migrate from `v0.4.x` to `v1.0.0`
+
+The *v1.0.0* version is a **major break** from *v0.4*.
+
+* Datatables no longer inherits from `AjaxDatatablesRails::Base` but from `AjaxDatatablesRails::ActiveRecord` (this solves [#228](https://github.com/jbox-web/ajax-datatables-rails/issues/228))
+* The `view_context` is no longer injected in Datatables but only the `params` hash (see the [example](#4-setup-the-controller-action)). This will break calls to helpers methods.
+
+1) To mitigate the first change (Datatables no longer inherits from `AjaxDatatablesRails::Base` but from `AjaxDatatablesRails::ActiveRecord`)
+
+Create a new `ApplicationDatatable` class and make all your classes inherits from it :
+
+```ruby
+class ApplicationDatatable < AjaxDatatablesRails::ActiveRecord
+end
+
+class PostDatatable < ApplicationDatatable
+end
+```
+
+**Note :** This is now in the [ProTips™](https://github.com/jbox-web/ajax-datatables-rails#protips) section of the documentation.
+
+2) To mitigate the second change (The `view_context` is no longer injected in Datatables)
+
+Update the `ApplicationDatatable` class :
+
+```ruby
+class ApplicationDatatable < AjaxDatatablesRails::ActiveRecord
+  extend Forwardable
+  attr_reader :view
+  def initialize(params, opts = {})
+    @view = opts[:view_context]
+    super
+  end
+end
+```
+
+and update your controllers :
+
+```ruby
+# before
+respond_to do |format|
+  format.json { render json: UserDatatable.new(view_context) }
+end
+
+# after
+respond_to do |format|
+  format.json { render json: UserDatatable.new(params, view_context: view_context) }
+end
+
+# if you need to inject some options
+respond_to do |format|
+  format.json { render json: UserDatatable.new(params, view_context: view_context, my: 'options') }
+end
+```
+
+This way, you can still use `def_delegators` in your datatables [as in the documentation](https://github.com/jbox-web/ajax-datatables-rails#using-view-helpers).
+
+Note that the recommanded way is to use [Draper gem](https://github.com/drapergem/draper) to separate filtering logic from view/presentation logic [as in the documentation](https://github.com/jbox-web/ajax-datatables-rails#using-view-decorators).
+
+## To migrate from `v0.3.x` to `v0.4.x`
+
+The *v0.4* version is a **major break** from *v0.3*.
+
+The core has been rewriten to remove dependency on [Kaminari](https://github.com/kaminari/kaminari) or [WillPaginate](https://github.com/mislav/will_paginate).
+
+It also brings a new (more natural) way of defining columns, based on hash definitions (and not arrays) and add some filtering options for column search.
+
+To migrate on the v0.4 you'll need to :
+
+* update your DataTables classes to remove all the `extend` directives
+* switch to hash definitions of `view_columns`
+* update your views to declare your columns bindings ([See here](https://github.com/jbox-web/ajax-datatables-rails#5-wire-up-the-javascript))

data/doc/webpack.md

@@ -5,7 +5,9 @@ We assume here that Bootstrap and FontAwesome are already installed with Webpack
 Inspired by https://datatables.net/download and completed :
 
 Add npm packages :
-
+```sh
+$ yarn add imports-loader
+```
 ```sh
 $ yarn add datatables.net
 $ yarn add datatables.net-bs
@@ -22,7 +24,10 @@ In `config/webpack/loaders/datatables.js` :
 ```js
 module.exports = {
   test: /datatables\.net.*/,
-  loader: 'imports-loader?define=>false'
+  loader: 'imports-loader',
+  options: {
+    additionalCode: 'var define = false;'
+  }
 }
 ```
 

data/gemfiles/{rails_5.2.0.gemfile → rails_5.2.4.gemfile}

@@ -2,12 +2,10 @@
 
 source "https://rubygems.org"
 
-gem "rails", "5.2.0"
+gem "rails", "5.2.4"
 gem "activerecord-oracle_enhanced-adapter", "~> 5.2.0"
+gem "sqlite3", "~> 1.3.0"
+gem "mysql2"
 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.7.gemfile → rails_6.0.3.gemfile}

@@ -2,12 +2,10 @@
 
 source "https://rubygems.org"
 
-gem "rails", "5.0.7"
-gem "activerecord-oracle_enhanced-adapter", "~> 1.7.0"
+gem "rails", "6.0.3"
+gem "activerecord-oracle_enhanced-adapter", "~> 6.0.0"
+gem "sqlite3", "~> 1.4.0"
+gem "mysql2"
 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.6.gemfile → rails_6.1.0.gemfile}

@@ -2,12 +2,10 @@
 
 source "https://rubygems.org"
 
-gem "rails", "5.1.6"
-gem "activerecord-oracle_enhanced-adapter", "~> 1.8.0"
+gem "rails", "6.1.0"
+gem "activerecord-oracle_enhanced-adapter", "~> 6.1.0"
+gem "sqlite3", "~> 1.4.0"
+gem "mysql2"
 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,3 +1,14 @@
 # frozen_string_literal: true
 
-require 'ajax_datatables_rails'
+require 'zeitwerk'
+loader = Zeitwerk::Loader.for_gem
+generators = "#{__dir__}/generators"
+loader.ignore(generators)
+loader.inflector.inflect(
+  'orm'                   => 'ORM',
+  'ajax-datatables-rails' => 'AjaxDatatablesRails'
+)
+loader.setup
+
+module AjaxDatatablesRails
+end

data/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