effective_datatables 3.7.7 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 173590e66ff34a72a7aaed989391a718e25eaca196fae4981f295bf4a73a6bf0
-  data.tar.gz: 8330bb5487288950f107f6dc79dedde2b2298e77c059d98bdf4d7f095ca8c353
+SHA1:
+  metadata.gz: 409a99e8dc9284b103bbbcd90ef5e66e4945c4fe
+  data.tar.gz: 5e320731bec22af5f939b6dd35c9358df9e41b08
 SHA512:
-  metadata.gz: 242e5bf78a1f1aef37f3864e76d8cf90e98141a84ff4408b9fb5fed72a51115c15a5d19ca1fa79a692401ff6abc29d1f40dae4d781f217add15509f09217c810
-  data.tar.gz: 569226fd1c6c32e498efc9ee7728a070f971d54ee10ef353777712a7ccf891337d2061cbceec3366a5d627daa84841eb8a70bea3a81ee32a2e1fdc9c03809576
+  metadata.gz: 3d568242347b2c0656e993305a296284fb0f2731f4d2f4177725f992db7891bdf5e5f873b52cb57b0301c0b0807cb90917147d3a42abb59d8932ff7e1c0a50f5
+  data.tar.gz: a5147ebee2cc69002e0da8e7682e9fe84909da9e7726ea3a61a0887df2e644617324bd36066b1e36a99b1a385b596dc48118fde79bfd3ee85bcacd747eb867dc

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2019 Code and Effect Inc.
+Copyright 2018 Code and Effect Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -12,23 +12,22 @@ Other features include aggregate (total/average) footer rows, bulk actions, show
 
 This gem includes the jQuery DataTables assets.
 
-For use with any Rails 3, 4, 5 application already using Twitter Bootstrap 3.
 
 Works with postgres, mysql, sqlite3 and arrays.
 
-## Bootstrap3
+## effective_datatables 4.0
 
-This is the `bootstrap3` branch of effective_datatables which supports Twitter Bootstrap 3.
+This is the 4.0 series of effective_datatables.
 
-All published effective_datatables 3.x gems will support Twitter Bootstrap 3 and SimpleForm.
+This requires Twitter Bootstrap 4 and Rails 5.1+
 
-For Bootstrap 4 please see the master branch and/or effective_datatables 4.x gems.
+Please check out [Effective Datatables 3.x](https://github.com/code-and-effect/effective_datatables/tree/bootstrap3) for more information using this gem with Bootstrap 3.
 
 # Getting Started
 
 ```ruby
 gem 'haml-rails'            # or try using gem 'hamlit-rails'
-gem 'effective_datatables', '~> 3.0'
+gem 'effective_datatables'
 ```
 
 Run the bundle command to install it:
@@ -45,6 +44,8 @@ rails generate effective_datatables:install
 
 The generator will install an initializer which describes all configuration options.
 
+Make sure you have [Twitter Bootstrap 4](https://github.com/twbs/bootstrap-rubygem) installed.
+
 Require the javascript on the asset pipeline by adding the following to your application.js:
 
 ```ruby
@@ -91,7 +92,7 @@ We're going to display this DataTable on the posts#index action.
 ```ruby
 class PostsController < ApplicationController
   def index
-    @datatable = PostsDatatable.new
+    @datatable = PostsDatatable.new(self)
   end
 end
 ```
@@ -234,13 +235,13 @@ class PostsDatatable < Effective::Datatable
     aggregate :total
 
     # Uses effective_resources gem to discover the resource path and authorization actions
-    # Puts links to show/edit/destroy actions, if authorized to those actions.
+    # Puts in icons to show/edit/destroy actions, if authorized to those actions.
     # Use the actions_col block to add additional actions
-
-    actions_col(edit: false) do |post|
-      glyphicon_to('print', print_post_path(post), title: 'Print')
+    actions_col show: false do |post|
+      if !post.approved? && can?(:approve, Post)
+        link_to 'Approve', approve_post_path(post) data: { method: :post, confirm: 'Really approve?'}
+      end
     end
-
   end
 
 end
@@ -255,7 +256,7 @@ In the above example, when `attributes[:user_id]` is present, the table displays
 ```ruby
 class PostsController < ApplicationController
   def index
-    @datatable = PostsDatatable.new(user_id: current_user.id)
+    @datatable = PostsDatatable.new(self, user_id: current_user.id)
   end
 end
 ```
@@ -311,7 +312,7 @@ Attributes cannot be changed by search, filter, or state in any way. They're gua
 ```ruby
 class PostsController < ApplicationController
   def index
-    @datatable = PostsDatatable.new(user_id: current_user.id, admin: true)
+    @datatable = PostsDatatable.new(self, user_id: current_user.id, admin: true)
   end
 end
 ```
@@ -407,7 +408,7 @@ Sometimes it's handy to call `.reorder(nil)` on a scope.
 
 The `datatable do ... end` block configures a table of data.
 
-Initialize the datatable in your controller or view, `@datatable = PostsDatatable.new`, and render it in your view `<%= render_datatable(@datatable) %>`
+Initialize the datatable in your controller or view, `@datatable = PostsDatatable.new(self)`, and render it in your view `<%= render_datatable(@datatable) %>`
 
 ### col
 
@@ -514,36 +515,35 @@ You can only have one `bulk_actions_col` per datatable.
 
 ### actions_col
 
-When working with an ActiveRecord based collection, this column will consider the `current_user`'s authorization, and generate links to edit, show and destroy actions for any collection class.
+When working with an ActiveRecord based collection, this column will consider the `current_user`'s authorization, and generate
+glyphicon links to edit, show and destroy actions for any collection class.
 
 The authorization method is configured via the `config/initializers/effective_datatables.rb` initializer file.
 
 There are just a few options:
 
 ```ruby
-show: true|false
-edit: true|false
-destroy: true|false
+show: true|false|:authorize
+edit: true|false|:authorize
+destroy: true|false|:authorize
+
 visible: true|false
-actions_partial: :glyphicons
 ```
 
-Each object is checked individually for authorization.
+When the show, edit and destroy actions are `true` (default), the permission check will be made just once, authorizing the class.
+When set to `:authorize`, permission to each individual object will be checked.
 
-The arguments to `actions_col` are passed through to the `effective_resource` gem's [render_resource_actions](https://github.com/code-and-effect/effective_resources/blob/master/app/helpers/effective_resources_helper.rb#L57).
-
-It's all very complicated.
-
-If you just want to override this entire column with your own actions implementation, you can pass `actions_col partial: 'my_partial'` and roll your own.
-
-Otherwise, use the following block syntax to add additional actions. This helper comes from `effective_form_inputs` gem.
+Use the block syntax to add additional actions
 
 ```ruby
-actions_col do |post|
-  glyphicon_to('print', print_post_path(post), title: 'Print')
+actions_col show: false do |post|
+  (post.approved? ? link_to('Approve', approve_post_path(post)) : '') +
+  glyphicon_to('print', print_ticket_path(ticket), title: 'Print')
 end
 ```
 
+The `glyphicon_to` helper is part of the [effective_resources](https://github.com/code-and-effect/effective_resources) gem, which is a dependency of this gem.
+
 ### length
 
 Sets the default number of rows per page. Valid lengths are `5`, `10`, `25`, `50`, `100`, `250`, `500`, `:all`
@@ -609,7 +609,7 @@ Creates a single form with fields for each `filter` and a single radio input fie
 
 The form is submitted by an AJAX POST action, or, in some advanced circumstances (see Dynamic Columns below) as a regular POST or even GET.
 
-Initialize the datatable in your controller or view, `@datatable = PostsDatatable.new`, and render its filters anywhere with `<%= render_datatable_filters(@datatable) %>`.
+Initialize the datatable in your controller or view, `@datatable = PostsDatatable.new(self)`, and render its filters anywhere with `<%= render_datatable_filters(@datatable) %>`.
 
 ### scope
 
@@ -865,7 +865,7 @@ If you just want to render a datatable and nothing else, there is a quick way to
 ```ruby
 class PostsController < ApplicationController
   def index
-    render_datatable_index PostsDatatable.new
+    render_datatable_index PostsDatatable.new(self)
   end
 end
 ```

data/app/assets/images/dataTables/sort-down.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512" width="24" height="24"><path fill="#007bff" d="M41 288h238c21.4 0 32.1 25.9 17 41L177 448c-9.4 9.4-24.6 9.4-33.9 0L24 329c-15.1-15.1-4.4-41 17-41z"/></svg>

data/app/assets/images/dataTables/sort-up.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512" width="24" height="24"><path fill="#007bff" d="M279 224H41c-21.4 0-32.1-25.9-17-41L143 64c9.4-9.4 24.6-9.4 33.9 0l119 119c15.2 15.1 4.5 41-16.9 41z"/></svg>

data/app/assets/images/dataTables/sort.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512" width="24" height="24"><path fill='#ddd' d="M41 288h238c21.4 0 32.1 25.9 17 41L177 448c-9.4 9.4-24.6 9.4-33.9 0L24 329c-15.1-15.1-4.4-41 17-41zm255-105L177 64c-9.4-9.4-24.6-9.4-33.9 0L24 183c-15.1 15.1-4.4 41 17 41h238c21.4 0 32.1-25.9 17-41z"/></svg>

data/app/assets/javascripts/dataTables/buttons/{buttons.bootstrap.js → buttons.bootstrap4.js}

@@ -5,7 +5,7 @@
 (function( factory ){
 	if ( typeof define === 'function' && define.amd ) {
 		// AMD
-		define( ['jquery', 'datatables.net-bs', 'datatables.net-buttons'], function ( $ ) {
+		define( ['jquery', 'datatables.net-bs4', 'datatables.net-buttons'], function ( $ ) {
 			return factory( $, window, document );
 		} );
 	}
@@ -17,7 +17,7 @@
 			}
 
 			if ( ! $ || ! $.fn.dataTable ) {
-				$ = require('datatables.net-bs')(root, $).$;
+				$ = require('datatables.net-bs4')(root, $).$;
 			}
 
 			if ( ! $.fn.dataTable.Buttons ) {
@@ -35,36 +35,28 @@
 'use strict';
 var DataTable = $.fn.dataTable;
 
-
 $.extend( true, DataTable.Buttons.defaults, {
 	dom: {
 		container: {
 			className: 'dt-buttons btn-group'
 		},
 		button: {
-			className: 'btn btn-default'
+			className: 'btn btn-secondary'
 		},
 		collection: {
-			tag: 'ul',
+			tag: 'div',
 			className: 'dt-button-collection dropdown-menu',
 			button: {
-				tag: 'li',
-				className: 'dt-button',
+				tag: 'a',
+				className: 'dt-button dropdown-item',
 				active: 'active',
 				disabled: 'disabled'
-			},
-			buttonLiner: {
-				tag: 'a',
-				className: ''
 			}
 		}
 	}
 } );
 
-DataTable.ext.buttons.collection.text = function ( dt ) {
-	return dt.i18n('buttons.collection', 'Collection <span class="caret"/>');
-};
-
+DataTable.ext.buttons.collection.className += ' dropdown-toggle';
 
 return DataTable.Buttons;
 }));

data/app/assets/javascripts/dataTables/dataTables.bootstrap4.js

@@ -0,0 +1,184 @@
+/*! DataTables Bootstrap 3 integration
+ * ©2011-2015 SpryMedia Ltd - datatables.net/license
+ */
+
+/**
+ * DataTables integration for Bootstrap 3. This requires Bootstrap 3 and
+ * DataTables 1.10 or newer.
+ *
+ * This file sets the defaults and adds options to DataTables to style its
+ * controls using Bootstrap. See http://datatables.net/manual/styling/bootstrap
+ * for further information.
+ */
+(function( factory ){
+  if ( typeof define === 'function' && define.amd ) {
+    // AMD
+    define( ['jquery', 'datatables.net'], function ( $ ) {
+      return factory( $, window, document );
+    } );
+  }
+  else if ( typeof exports === 'object' ) {
+    // CommonJS
+    module.exports = function (root, $) {
+      if ( ! root ) {
+        root = window;
+      }
+
+      if ( ! $ || ! $.fn.dataTable ) {
+        // Require DataTables, which attaches to jQuery, including
+        // jQuery if needed and have a $ property so we can access the
+        // jQuery object that is used
+        $ = require('datatables.net')(root, $).$;
+      }
+
+      return factory( $, root, root.document );
+    };
+  }
+  else {
+    // Browser
+    factory( jQuery, window, document );
+  }
+}(function( $, window, document, undefined ) {
+'use strict';
+var DataTable = $.fn.dataTable;
+
+
+/* Set the defaults for DataTables initialisation */
+$.extend( true, DataTable.defaults, {
+  dom:
+    "<'row'<'col-sm-12 col-md-6'l><'col-sm-12 col-md-6'f>>" +
+    "<'row'<'col-sm-12'tr>>" +
+    "<'row'<'col-sm-12 col-md-5'i><'col-sm-12 col-md-7'p>>",
+  renderer: 'bootstrap'
+} );
+
+
+/* Default class modification */
+$.extend( DataTable.ext.classes, {
+  sWrapper:      "dataTables_wrapper container-fluid dt-bootstrap4",
+  sFilterInput:  "form-control form-control-sm",
+  sLengthSelect: "form-control form-control-sm",
+  sProcessing:   "dataTables_processing card",
+  sPageButton:   "paginate_button page-item"
+} );
+
+
+/* Bootstrap paging button renderer */
+DataTable.ext.renderer.pageButton.bootstrap = function ( settings, host, idx, buttons, page, pages ) {
+  var api     = new DataTable.Api( settings );
+  var classes = settings.oClasses;
+  var lang    = settings.oLanguage.oPaginate;
+  var aria = settings.oLanguage.oAria.paginate || {};
+  var btnDisplay, btnClass, counter=0;
+
+  var attach = function( container, buttons ) {
+    var i, ien, node, button;
+    var clickHandler = function ( e ) {
+      e.preventDefault();
+      if ( !$(e.currentTarget).hasClass('disabled') && api.page() != e.data.action ) {
+        api.page( e.data.action ).draw( 'page' );
+      }
+    };
+
+    for ( i=0, ien=buttons.length ; i<ien ; i++ ) {
+      button = buttons[i];
+
+      if ( $.isArray( button ) ) {
+        attach( container, button );
+      }
+      else {
+        btnDisplay = '';
+        btnClass = '';
+
+        switch ( button ) {
+          case 'ellipsis':
+            btnDisplay = '&#x2026;';
+            btnClass = 'disabled';
+            break;
+
+          case 'first':
+            btnDisplay = lang.sFirst;
+            btnClass = button + (page > 0 ?
+              '' : ' disabled');
+            break;
+
+          case 'previous':
+            btnDisplay = lang.sPrevious;
+            btnClass = button + (page > 0 ?
+              '' : ' disabled');
+            break;
+
+          case 'next':
+            btnDisplay = lang.sNext;
+            btnClass = button + (page < pages-1 ?
+              '' : ' disabled');
+            break;
+
+          case 'last':
+            btnDisplay = lang.sLast;
+            btnClass = button + (page < pages-1 ?
+              '' : ' disabled');
+            break;
+
+          default:
+            btnDisplay = button + 1;
+            btnClass = page === button ?
+              'active' : '';
+            break;
+        }
+
+        if ( btnDisplay ) {
+          node = $('<li>', {
+              'class': classes.sPageButton+' '+btnClass,
+              'id': idx === 0 && typeof button === 'string' ?
+                settings.sTableId +'_'+ button :
+                null
+            } )
+            .append( $('<a>', {
+                'href': '#',
+                'aria-controls': settings.sTableId,
+                'aria-label': aria[ button ],
+                'data-dt-idx': counter,
+                'tabindex': settings.iTabIndex,
+                'class': 'page-link'
+              } )
+              .html( btnDisplay )
+            )
+            .appendTo( container );
+
+          settings.oApi._fnBindAction(
+            node, {action: button}, clickHandler
+          );
+
+          counter++;
+        }
+      }
+    }
+  };
+
+  // IE9 throws an 'unknown error' if document.activeElement is used
+  // inside an iframe or frame.
+  var activeEl;
+
+  try {
+    // Because this approach is destroying and recreating the paging
+    // elements, focus is lost on the select button which is bad for
+    // accessibility. So we want to restore focus once the draw has
+    // completed
+    activeEl = $(host).find(document.activeElement).data('dt-idx');
+  }
+  catch (e) {}
+
+  attach(
+    $(host).empty().html('<ul class="pagination"/>').children('ul'),
+    buttons
+  );
+
+  if ( activeEl !== undefined ) {
+    $(host).find( '[data-dt-idx='+activeEl+']' ).focus();
+  }
+};
+
+
+return DataTable;
+}));

data/app/assets/javascripts/dataTables/responsive/dataTables.responsive.js

@@ -1,11 +1,11 @@
-/*! Responsive 2.2.0
+/*! Responsive 2.2.1
  * 2014-2017 SpryMedia Ltd - datatables.net/license
  */
 
 /**
  * @summary     Responsive
  * @description Responsive tables plug-in for DataTables
- * @version     2.2.0
+ * @version     2.2.1
  * @file        dataTables.responsive.js
  * @author      SpryMedia Ltd (www.sprymedia.co.uk)
  * @contact     www.sprymedia.co.uk/contact
@@ -97,8 +97,8 @@ var DataTable = $.fn.dataTable;
  */
 var Responsive = function ( settings, opts ) {
 	// Sanity check that we are using DataTables 1.10 or newer
-	if ( ! DataTable.versionCheck || ! DataTable.versionCheck( '1.10.3' ) ) {
-		throw 'DataTables Responsive requires DataTables 1.10.3 or newer';
+	if ( ! DataTable.versionCheck || ! DataTable.versionCheck( '1.10.10' ) ) {
+		throw 'DataTables Responsive requires DataTables 1.10.10 or newer';
 	}
 
 	this.s = {
@@ -208,10 +208,12 @@ $.extend( Responsive.prototype, {
 
 			// DataTables will trigger this event on every column it shows and
 			// hides individually
-			dt.on( 'column-visibility.dtr', function (e, ctx, col, vis) {
-				that._classLogic();
-				that._resizeAuto();
-				that._resize();
+			dt.on( 'column-visibility.dtr', function (e, ctx, col, vis, recalc) {
+				if ( recalc ) {
+					that._classLogic();
+					that._resizeAuto();
+					that._resize();
+				}
 			} );
 
 			// Redraw the details box on each draw which will happen if the data
@@ -247,6 +249,9 @@ $.extend( Responsive.prototype, {
 			} );
 
 			dt.one( 'draw.dtr', function () {
+				that._resizeAuto();
+				that._resize();
+
 				dt.rows( rowIds ).every( function () {
 					that._detailsDisplay( this, false );
 				} );
@@ -762,8 +767,13 @@ $.extend( Responsive.prototype, {
 		$( dt.table().node() ).toggleClass( 'collapsed', collapsedClass );
 
 		var changed = false;
+		var visible = 0;
 
 		dt.columns().eq(0).each( function ( colIdx, i ) {
+			if ( columnsVis[i] === true ) {
+				visible++;
+			}
+
 			if ( columnsVis[i] !== oldVis[i] ) {
 				changed = true;
 				that._setColumnVis( colIdx, columnsVis[i] );
@@ -778,7 +788,7 @@ $.extend( Responsive.prototype, {
 
 			// If no records, update the "No records" display element
 			if ( dt.page.info().recordsDisplay === 0 ) {
-				//dt.draw(); # effective_datatables - don't draw
+				$('td', dt.table().body()).eq(0).attr('colspan', visible);
 			}
 		}
 	},
@@ -832,7 +842,8 @@ $.extend( Responsive.prototype, {
 			} )
 			.to$()
 			.clone( false )
-			.css( 'display', 'table-cell' );
+			.css( 'display', 'table-cell' )
+			.css( 'min-width', 0 );
 
 		// Body rows - we don't need to take account of DataTables' column
 		// visibility since we implement our own here (hence the `display` set)
@@ -1312,6 +1323,14 @@ Api.register( 'responsive.hasHidden()', function () {
 		false;
 } );
 
+Api.registerPlural( 'columns().responsiveHidden()', 'column().responsiveHidden()', function () {
+	return this.iterator( 'column', function ( settings, column ) {
+		return settings._responsive ?
+			settings._responsive.s.current[ column ] :
+			false;
+	}, 1 );
+} );
+
 
 /**
  * Version information
@@ -1319,7 +1338,7 @@ Api.register( 'responsive.hasHidden()', function () {
  * @name Responsive.version
  * @static
  */
-Responsive.version = '2.2.0';
+Responsive.version = '2.2.1';
 
 
 $.fn.dataTable.Responsive = Responsive;