effective_datatables 4.8.0 → 4.8.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5a9a4233ee452020c92387b3bb140eac9df58bd52548c55a2eb41881c731f67
-  data.tar.gz: f738131e50148095ea9c1cee3b0f68911d4b2a4f1815b7d5aa6445ec4d849a49
+  metadata.gz: cb1dc8f3ac21b885c37e56552192568b059350efcdcd7bd79784d87d91a4bee3
+  data.tar.gz: 46094ee0a00e9246b8dde73c2c9ab4f531c84a287f2cd7db7da467cc0dab6d92
 SHA512:
-  metadata.gz: 2279b8c6b0f72dc5427a2d0cc876ee83021806a3152d325edcccbaf8532dd65de27c1a8275320a306568790a60965d6235ee585e4bba41c1337148568df62d51
-  data.tar.gz: a7e514c7caf226a633fbd5d6098df1241b38336343fc9d6927f3bab07419d56300c06c4cecab752ed4a43819f9f6946c820cff5af7e0b25c317922a06625155e
+  metadata.gz: 51f91cf414121df572748ce03da5732b53011ad113db667b95284276f9ec628ec12ff0f8f614567ab88c770f9fa674059c6b8ca9a1ab1a5701e4dd8dbd509c2f
+  data.tar.gz: 1fbacd63b25ba9ba0556ccfec605a07ff5a3c6e5ddfc8da6dc723e66bfc4a72cb0d9c97d796a4acdb419e7fa5d1a2c8b8ec760bb4df77dbcee9b79708fce235d

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2019 Code and Effect Inc.
+Copyright 2021 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

@@ -8,7 +8,7 @@ Does the right thing with searching sql columns as well as computed values from
 
 Displays links to associated edit/show/destroy actions based on `current_user` authorized actions.
 
-Other features include aggregate (total/average) footer rows, bulk actions, show/hide columns, responsive collapsing columns and Google charts.
+Other features include aggregate (total/average) footer rows, bulk actions, show/hide columns, responsive collapsing columns, google charts, and inline crud.
 
 This gem includes the jQuery DataTables assets.
 
@@ -54,7 +54,8 @@ Please check out [Effective Datatables 3.x](https://github.com/code-and-effect/e
     * [bulk_action](#bulk_action_divider)
     * [bulk_download](#bulk_download)
     * [bulk_action_content](#bulk_action_content)
-  * [charts](#charts)
+  * [Charts](#charts)
+  * [Inline](#inline)
   * [Extras](#extras)
   * [Advanced Search and Sort](#advanced-search-and-sort)
 * [Addtional Functionality](#additional-functionality)
@@ -453,7 +454,7 @@ The `datatable do ... end` block configures a table of data.
 
 Initialize the datatable in your controller or view, `@datatable = PostsDatatable.new(self)`, and render it in your view `<%= render_datatable(@datatable) %>`
 
-### col
+## col
 
 This is the main DSL method that you will interact with.
 
@@ -526,7 +527,7 @@ You can also use the joined syntax, `col 'user.email'` to create a column for ju
 
 This feature is only working with `belongs_to` and you need to add the `.joins(:user)` to the collection do ... end block yourself.
 
-### val
+## val
 
 Shorthand for value, this command also creates a column on the datatable.
 
@@ -548,7 +549,7 @@ This is implemented as a full Array search/sort and is much slower for large dat
 
 The `.format do ... end` block can then be used to apply custom formatting.
 
-### bulk_actions_col
+## bulk_actions_col
 
 Creates a column of checkboxes for use with the `bulk_actions` section.
 
@@ -558,7 +559,7 @@ Use these checkboxes to select all / none / one or more rows for the `bulk_actio
 
 You can only have one `bulk_actions_col` per datatable.
 
-### actions_col
+## 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.
 
@@ -596,7 +597,7 @@ Any `data-remote` actions will be hijacked and performed as inline ajax by datat
 
 If you'd like to opt-out of this behavior, use `actions_col(inline: false)` or add `data-inline: false` to your action link.
 
-### length
+## length
 
 Sets the default number of rows per page. Valid lengths are `5`, `10`, `25`, `50`, `100`, `250`, `500`, `:all`
 
@@ -606,7 +607,7 @@ When not specified, effective_datatables uses the default as per the `config/ini
 length 100
 ```
 
-### order
+## order
 
 Sets the default order of table rows. The first argument is the column, the second the direction.
 
@@ -618,7 +619,7 @@ When not specified, effective_datatables will sort by the first defined column.
 order :created_at, :asc|:desc
 ```
 
-### reorder
+## reorder
 
 Enables drag-and-drop row re-ordering.
 
@@ -636,7 +637,7 @@ reorder :position
 
 Using `reorder` will sort the collection by this field and disable all other column sorting.
 
-### aggregate
+## aggregate
 
 The `aggregate` command inserts a row in the table's `tfoot`.
 
@@ -681,7 +682,7 @@ The form is submitted by an AJAX POST action, or, in some advanced circumstances
 
 Initialize the datatable in your controller or view, `@datatable = PostsDatatable.new(self)`, and render its filters anywhere with `<%= render_datatable_filters(@datatable) %>`.
 
-### scope
+## scope
 
 All defined scopes are rendered as a single radio button form field. Works great with the [effective_form_inputs](https://github.com/code-and-effect/effective_form_inputs) gem.
 
@@ -705,7 +706,7 @@ class Post < ApplicationRecord | ActiveRecord::Base
 end
 ```
 
-### filter
+## filter
 
 Each filter has a name and a default/fallback value. If the form is submitted blank, the default values are used.
 
@@ -758,7 +759,7 @@ Creates a single dropdown menu with a link to each action, download or content.
 
 Along with this section, you must put a `bulk_actions_col` somewhere in your `datatable do ... end` section.
 
-### bulk_action
+## bulk_action
 
 Creates a link that becomes clickable when one or more checkbox/rows are selected as per the `bulk_actions_col` column.
 
@@ -814,11 +815,11 @@ def approve!
 end
 ```
 
-### bulk_action_divider
+## bulk_action_divider
 
 Inserts a menu divider `<li class='divider' role='separator'></li>`
 
-### bulk_download
+## bulk_download
 
 So it turns out there are some http issues with using an AJAX action to download a file.
 
@@ -859,7 +860,7 @@ def bulk_export_report
 end
 ```
 
-### bulk_action_content
+## bulk_action_content
 
 Blindly inserts content into the dropdown.
 
@@ -873,7 +874,7 @@ end
 
 Don't actually use this.
 
-## charts
+# Charts
 
 Create a [Google Chart](https://developers.google.com/chart/interactive/docs/quick_start) based on your searched collection, filters and attributes.
 
@@ -930,11 +931,169 @@ All options passed to `chart` are used to initialize the chart javascript.
 
 By default, the only package that is loaded is `corechart`, see the `config/initializers/effective_datatables.rb` file to add more packages.
 
-## Extras
+# Inline
+
+Any datatable can be used as an inline datatable, to create, update and destroy resources without leaving the current page.
+
+If your datatable is already working with `actions_col` and being rendered from an `Effective::CrudController` controller, all you need to do is change your view from `render_datatable(@datatable)` to `render_datatable(@datatable, inline: true)`.
+
+Click here for a [Inline Live Demo](https://effective-datatables-demo.herokuapp.com/things) and here for an [Inline Code Example](https://github.com/code-and-effect/effective_datatables_demo)
+(only the `thing` data model and `things_datatable` are being used inline)
+
+To use effective_datatables as an inline CRUD builder, you will be relying heavily on [effective_resources](https://github.com/code-and-effect/effective_resources) which is a dependency of this gem. I would also recommend you install [effective_developer](https://github.com/code-and-effect/effective_developer) to get access to some scaffolds and generators. It's not required but I'm gonna use them in this example.
+
+Here is how I build rails models for inline datatable CRUD operations:
+
+1. Create a new model file `app/models/thing.rb`:
+
+```ruby
+class Thing < ApplicationRecord
+  belongs_to :user
+
+  effective_resource do
+    title           :string
+    description     :text
+    timestamps
+  end
+
+  scope :deep, -> { includes(:user) }
+  scope :sorted, -> { order(:title) }
+
+  def to_s
+    title
+  end
+end
+```
+
+The `effective_resource do` block comes from the [effective_resources](https://github.com/code-and-effect/effective_resources) gem and is used to build any permitted_params.
+
+2. Generate a migration. Run `rails generate effective:migration things` to create a migration based off the model file then `rails db:migrate`.
+
+3. Scaffold the rest. Run `rails generate effective:scaffold_controller things` which will create:
+
+- A controller `app/controllers/things_controller.rb`:
+
+```ruby
+class ThingsController < ApplicationController
+  include Effective::CrudController
+end
+```
+
+The Effective::CrudController comes from [effective_resources](https://github.com/code-and-effect/effective_resources) gem and handles the standard 7 CRUD actions and member and collection actions. It is opinionated code that follows rails conventions. It considers the `routes.rb` and `ability.rb` or other authorization, to find all available actions.
+
+- A datatable `app/datatables/things_datatable.rb`:
+
+```ruby
+class ThingsDatatable < Effective::Datatable
+  datatable do
+    col :title
+    col :description
+    actions_col
+  end
+
+  collection do
+    Thing.deep.all
+  end
+end
+```
+
+This is an ordinary datatable. As long as it's an ActiveRecord collection, inline crud will work.
+
+- A view partial `app/views/things/_thing.html.haml`:
+
+```ruby
+%table.table
+  %tbody
+    %tr
+      %th Title
+      %td= thing.title
+    %tr
+      %th Description
+      %td= thing.description
+```
+
+This file is what rails uses when you call `render(thing)` and what datatables uses for the inline `show` action. It's important that its called `_thing.html`.
+
+- A form partial `app/views/things/_form.html.haml`:
+
+```ruby
+= effective_form_with(model: thing) do |f|
+  = f.text_field :title
+  = f.text_area :description
+  = f.submit
+```
+
+The `effective_form_with` comes from [effective_bootstrap](https://github.com/code-and-effect/effective_bootstrap) gem and is a drop-in replacement for the newer `form_with` syntax. It's really good, you should use it, but an ordinary `form_with` will work here just fine.
+
+This `_form.html` is an effective gems convention. This file must exist for your resource.
+
+- A resources entry in `config/routes.rb`:
+
+```ruby
+Rails.application.routes.draw do
+  resources :things do
+    post :approve, on: :member
+    post :reject, on: :member
+  end
+end
+```
+
+Above we have `resources :things` for the 7 crud actions. And we add two more member actions, which datatables will call `approve!` or `reject!` on thing.
+
+
+4. Render in the view. Create an `app/views/things/index.html.haml` and call `render_datatable(@datatable, inline: true)` or `render_inline_datatable(@datatable).
+
+```ruby
+= render_datatable(@datatable, inline: true)
+```
+
+Your datatable should now have New, Show, Edit, Approve and Reject buttons. Click them for inline functionality.
+
+## Troubleshooting Inline
+
+If things aren't working, try the following:
+
+- Double check your javascripts:
+
+```ruby
+//= require jquery3
+//= require popper
+//= require bootstrap
+//= require effective_bootstrap
+//= require effective_datatables
+//= require jquery_ujs
+```
+
+The inline functionality requires one of sprockets jquery_ujs, sprockets rails_ujs or webpack @rails/ujs libraries.
+
+- Double check your stylesheets:
+
+```ruby
+@import 'bootstrap';
+@import 'effective_bootstrap';
+@import 'effective_datatables';
+```
+
+- Make sure your datatable is not being rendered inside a `<form>...</form>` tag. It will display a javascript console error and won't work.
+
+- Double check your `resources :things` are in `routes.rb` in the same namespace as the controller, and that you have authorization for those actions in `ability.rb` or whatever your `config/initializers/effective_datatables.rb` `config.authorization_method` returns.
+
+## A note on how it works
+
+We use good old `rails_ujs` for all inline actions.
+
+When inline, any of the actions_col actions, as well as the New button, will be changed into `data-remote: true` actions.
+
+The [inline_crud javascript](https://github.com/code-and-effect/effective_datatables/blob/master/app/assets/javascripts/effective_datatables/inline_crud.js.coffee) handles fetching the form, or view partial and expanding/collapsing the appropriate row of the datatable.
+
+When an inline action is clicked, effective_datatables will make an AJAX request to the server, which could be received by an `Effective::CrudController` that will handle the `.js` format, and respond_with the appropriate [rails_ujs .js.erb views](https://github.com/code-and-effect/effective_resources/tree/master/app/views/application).
+
+
+# Extras
 
 The following commands don't quite fit into the DSL, but are present nonetheless.
 
-### simple
+## simple
 
 To render a simple table, without pagination, sorting, filtering, export buttons, per page, and default visibility:
 
@@ -942,7 +1101,7 @@ To render a simple table, without pagination, sorting, filtering, export buttons
 <%= render_datatable(@datatable, simple: true) %>
 ```
 
-### index
+## index
 
 If you just want to render a datatable and nothing else, there is a quick way to skip creating a view:
 
@@ -956,13 +1115,13 @@ end
 
 will render `views/effective/datatables/index` with the assigned datatable.
 
-## Advanced Search and Sort
+# Advanced Search and Sort
 
 The built-in search and ordering can be overridden on a per-column basis.
 
 The only gotcha here is that you must be aware of the type of collection.
 
-### With ActiveRecord collection
+## With ActiveRecord collection
 
 In the case of a `col` and an ActiveRecord collection:
 
@@ -994,7 +1153,7 @@ If `column[:sql_column].blank?` then this `col` has fallen back to being a `val`
 
 Try adding `col :post_category, sql_column: 'post_categories.title'`
 
-### With Array collection
+## With Array collection
 
 And in the case of a `col` with an Array collection, or any `val`:
 
@@ -1033,7 +1192,7 @@ end
 
 The search and sort for each column will be merged together to form the final results.
 
-### Default search collection
+## Default search collection
 
 When using a `col :comments` type belongs_to or has_many column, a search collection for that class will be loaded.
 
@@ -1155,6 +1314,22 @@ def finalize(collection)
 end
 ```
 
+## Render outside of view
+
+You can render a datatable outside the view.
+
+Anything you pass to the `rendered` method is treated as view/request params.
+
+You can test filters and scopes by passing them here.
+
+```
+post = Post.create!
+datatable = PostsDatatable.new.rendered(end_date: Time.zone.now+2.days, current_user_id: 1)
+
+assert_equal 1, datatable.collection.count
+assert_equal [post], datatable.collection
+```
+
 ## Authorization
 
 All authorization checks are handled via the config.authorization_method found in the `config/initializers/effective_datatables.rb` file.

data/app/assets/javascripts/effective_datatables/flash.js.coffee

@@ -16,7 +16,7 @@ flash = (message, status = '') ->
   timeout = $processing.data('timeout')
   clearTimeout(timeout) if timeout
 
-  delay = (if status == 'danger' then 4000 else 1500)
+  delay = (if status == 'danger' then 4000 else 1000)
 
   $processing.html(message).data('timeout', setTimeout( =>
       $processing.html('Processing...')

data/app/assets/javascripts/effective_datatables/initialize.js.coffee

@@ -5,6 +5,9 @@ initializeDataTables = (target) ->
     buttons_export_columns = options['buttons_export_columns'] || ':not(.col-actions)'
     reorder = datatable.data('reorder')
 
+    if datatable.data('inline') && datatable.closest('form').length > 0
+      console.error('inline datatable cannot work inside a form')
+
     if options['buttons'] == false
       options['buttons'] = []
 
@@ -49,7 +52,7 @@ initializeDataTables = (target) ->
       displayStart: datatable.data('display-start')
       iDisplayLength: datatable.data('display-length')
       language: datatable.data('language')
-      lengthMenu: [[5, 10, 25, 50, 100, 250, 500, 9999999], ['5', '10', '25', '50', '100', '250', '500', 'All']]
+      lengthMenu: [[5, 10, 25, 50, 100, 250, 500, 9999999], ['5', '10', '25', '50', '100', '250', '500', datatable.data('all-label')]]
       order: datatable.data('display-order')
       processing: true
       responsive: true
@@ -77,7 +80,7 @@ initializeDataTables = (target) ->
               filter_name = name.replace('filters[', '').substring(0, name.length-9)
 
               params['filter'][filter_name] = $form.find("input[name='#{name}']:checked").val()
-              
+
             else if $input.attr('id')
               filter_name = $input.attr('id').replace('filters_', '')
               params['filter'][filter_name] = $input.val()
@@ -162,7 +165,6 @@ initializeDataTables = (target) ->
           $input.on 'change', (event) -> dataTableSearch($(event.currentTarget))
         else if $input.is('input')
           $input.delayedChange ($input) -> dataTableSearch($input)
-          $input.on('paste', -> dataTableSearch($input))
 
     # Do the actual search
     dataTableSearch = ($input) ->   # This is the function called by a select or input to run the search
@@ -172,7 +174,9 @@ initializeDataTables = (target) ->
 
       value = $input.val()
 
-      if value.startsWith('"') && value.endsWith('"')
+      if Array.isArray(value)
+        # Nothing
+      else if value.startsWith('"') && value.endsWith('"')
         value = value.substring(1, value.length-1)
       else
         value = $.trim(value)
@@ -196,6 +200,7 @@ initializeDataTables = (target) ->
 
     table.addClass('initialized')
     table.children('thead').trigger('effective-bootstrap:initialize')
+    table.children('thead').find('input[autofocus]').first().focus()
     true
 
 destroyDataTables = ->

data/app/assets/javascripts/effective_datatables/inline_crud.js.coffee

@@ -1,15 +1,34 @@
 # To achieve inline crud, we use rails' data-remote links, and override their behaviour when inside a datatable
 # This works with EffectiveForm.remote_form which is part of the effective_bootstrap gem.
 
-# We click the New/Edit/Action button from the col-actions
-$(document).on 'ajax:beforeSend', '.dataTables_wrapper .col-actions', (e, xhr, settings) ->
-  $action = $(e.target)
-  $table = $(e.target).closest('table')
+# https://github.com/rails/jquery-ujs/wiki/ajax
+# https://edgeguides.rubyonrails.org/working_with_javascript_in_rails.html#rails-ujs-event-handlers
+
+$(document).on 'ajax:before', '.dataTables_wrapper .col-actions', (event) ->
+  $action = $(event.target)
+  $table = $(event.target).closest('table')
 
   return true if ('' + $action.data('inline')) == 'false'
 
-  $params = $.param({_datatable_id: $table.attr('id'), _datatable_attributes: $table.data('attributes'), _datatable_action: true })
-  settings.url += (if settings.url.indexOf('?') == -1 then '?' else '&') + $params
+  $params = $.param(
+    {
+      _datatable_id: $table.attr('id'),
+      _datatable_attributes: $table.data('attributes'),
+      _datatable_action: true
+    }
+  )
+
+  $action.attr('data-params', $params)
+  true
+
+# We click the New/Edit/Action button from the col-actions
+$(document).on 'ajax:beforeSend', '.dataTables_wrapper .col-actions', (event, xhr, settings) ->
+  [xhr, settings] = event.detail if event.detail # rails/ujs
+
+  $action = $(event.target)
+  $table = $(event.target).closest('table')
+
+  return true if ('' + $action.data('inline')) == 'false'
 
   if $action.closest('.effective-datatables-inline-row,table.dataTable').hasClass('effective-datatables-inline-row')
     # Nothing.
@@ -22,6 +41,8 @@ $(document).on 'ajax:beforeSend', '.dataTables_wrapper .col-actions', (e, xhr, s
 
 # We have either completed the resource action, or fetched the inline form to load.
 $(document).on 'ajax:success', '.dataTables_wrapper .col-actions', (event, data) ->
+  [data, status, xhr] = event.detail if event.detail # rails/ujs
+
   $action = $(event.target)
 
   return true if ('' + $action.data('inline')) == 'false'
@@ -54,12 +75,22 @@ $(document).on 'ajax:error', '.dataTables_wrapper', (event) ->
   EffectiveForm.remote_form_flash = ''
   true
 
-# Submitting an inline datatables form
-$(document).on 'ajax:beforeSend', '.dataTables_wrapper .col-inline-form', (e, xhr, settings) ->
-  $table = $(e.target).closest('table')
+## Now for the fetched form. We add the datatables params attributes
+
+$(document).on 'ajax:before', '.dataTables_wrapper .col-inline-form', (event) ->
+  $action = $(event.target)
+  $form = $action.closest('form')
+  $table = $action.closest('table')
+
+  if $form.find('input[name=_datatable_id]').length == 0
+    $('<input>').attr(
+      {type: 'hidden', name: '_datatable_id', value: $table.attr('id')}
+    ).appendTo($form)
 
-  $params = $.param({_datatable_id: $table.attr('id'), _datatable_attributes: $table.data('attributes') })
-  settings.url += (if settings.url.indexOf('?') == -1 then '?' else '&') + $params
+  if $form.find('input[name=_datatable_attributes]').length == 0
+    $('<input>').attr(
+      {type: 'hidden', name: '_datatable_attributes', value: $table.data('attributes')}
+    ).appendTo($form)
 
   true
 
@@ -92,7 +123,6 @@ beforeNew = ($action) ->
 
   # Append spinner and show Processing
   $th.append($table.data('spinner'))
-  $table.DataTable().flash()
   $table.one 'draw.dt', (event) ->
     $th.find('a').show().siblings('svg').remove() if event.target == event.currentTarget
 
@@ -121,7 +151,6 @@ beforeEdit = ($action) ->
 
   # Append spinner and show Processing
   $td.append($table.data('spinner'))
-  $table.DataTable().flash()
 
 afterEdit = ($action) ->
   $tr = $action.closest('tr')

data/app/assets/javascripts/effective_datatables/reorder.js.coffee

@@ -8,7 +8,14 @@ reorder = (event, diff, edit) ->
   return unless oldNode? && newNode?
 
   url = @context[0].ajax.url.replace('.json', '/reorder.json')
-  data = {'reorder[id]': oldNode.data('reorder-resource'), 'reorder[old]': oldNode.val(), 'reorder[new]': newNode.val(), attributes: $table.data('attributes') }
+
+  data = {
+    'authenticity_token': $('head').find("meta[name='csrf-token']").attr('content'),
+    'reorder[id]': oldNode.data('reorder-resource'),
+    'reorder[old]': oldNode.val(),
+    'reorder[new]': newNode.val(),
+    'attributes': $table.data('attributes')
+  }
 
   @context[0].rowreorder.c.enable = false
 
@@ -40,4 +47,3 @@ $(document).on 'click', '.dataTables_wrapper a.buttons-reorder', (event) ->
     $table.addClass('reordering')
 
   column.visible(!column.visible())
-

data/app/assets/javascripts/vendor/jquery.delayedChange.js

@@ -14,7 +14,7 @@
 
     return this.each(function() {
       var element = $(this);
-      element.keyup(function() {
+      element.on('keyup paste', function() {
         clearTimeout(timer);
         timer = setTimeout(function() {
           var newVal = element.val();

data/app/assets/stylesheets/dataTables/dataTables.bootstrap4.scss

@@ -162,9 +162,7 @@ div.dataTables_scrollFoot > .dataTables_scrollFootInner > table {
     text-align: center;
   }
 }
-table.dataTable.table-sm > thead > tr > th {
-  padding-right: 20px;
-}
+
 table.dataTable.table-sm .sorting:before,
 table.dataTable.table-sm .sorting_asc:before,
 table.dataTable.table-sm .sorting_desc:before {

data/app/helpers/effective_datatables_helper.rb

@@ -1,6 +1,6 @@
 # These are expected to be called by a developer.  They are part of the datatables DSL.
 module EffectiveDatatablesHelper
-  def render_datatable(datatable, input_js: {}, buttons: true, charts: true, entries: true, filters: true, inline: false, pagination: true, search: true, simple: false, sort: true)
+  def render_datatable(datatable, input_js: {}, buttons: true, charts: true, entries: true, filters: true, inline: false, namespace: nil, pagination: true, search: true, simple: false, sort: true)
     raise 'expected datatable to be present' unless datatable
     raise 'expected input_js to be a Hash' unless input_js.kind_of?(Hash)
 
@@ -10,6 +10,7 @@ module EffectiveDatatablesHelper
 
     datatable.attributes[:inline] = true if inline
     datatable.attributes[:sortable] = false unless sort
+    datatable.attributes[:namespace] = namespace if namespace
 
     datatable.view ||= self
 
@@ -40,6 +41,7 @@ module EffectiveDatatablesHelper
       id: datatable.to_param,
       class: html_class,
       data: {
+        'all-label' => I18n.t('effective_datatables.all'),
         'attributes' => EffectiveDatatables.encrypt(datatable.attributes),
         'authenticity-token' => form_authenticity_token,
         'bulk-actions' => datatable_bulk_actions(datatable),

data/app/helpers/effective_datatables_private_helper.rb

@@ -44,7 +44,7 @@ module EffectiveDatatablesPrivateHelper
     action = { action: :new, class: ['btn', column[:btn_class].presence].compact.join(' '), 'data-remote': true }
 
     if column[:actions][:new].kind_of?(Hash) # This might be active_record_array_collection?
-      action = action.merge(column[:actions][:new])
+      action.merge!(column[:actions][:new])
 
       effective_resource = (datatable.effective_resource || datatable.fallback_effective_resource)
       klass = (column[:actions][:new][:klass] || effective_resource&.klass || datatable.collection_class)
@@ -84,7 +84,7 @@ module EffectiveDatatablesPrivateHelper
     collection = opts[:search].delete(:collection)
     value = datatable.state[:search][name]
 
-    options = opts[:search].except(:fuzzy).merge!(
+    options = opts[:search].merge!(
       name: nil,
       feedback: false,
       label: false,
@@ -92,24 +92,26 @@ module EffectiveDatatablesPrivateHelper
       data: { 'column-name': name, 'column-index': opts[:index] }
     )
 
+    options.delete(:fuzzy)
+
     case options.delete(:as)
     when :string, :text, :number
       form.text_field name, options
     when :date, :datetime
-      form.date_field name, options.reverse_merge(
+      form.date_field name, options.reverse_merge!(
         date_linked: false, prepend: false, input_js: { useStrict: true, keepInvalid: true }
       )
     when :time
-      form.time_field name, options.reverse_merge(
+      form.time_field name, options.reverse_merge!(
         date_linked: false, prepend: false, input_js: { useStrict: false, keepInvalid: true }
       )
     when :select, :boolean
-      options[:input_js] = (options[:input_js] || {}).reverse_merge(placeholder: '')
+      options[:input_js] = (options[:input_js] || {}).reverse_merge!(placeholder: '')
 
       form.select name, collection, options
     when :bulk_actions
       options[:data]['role'] = 'bulk-actions'
-      form.check_box name, options.merge(label: ' ')
+      form.check_box name, options.merge!(label: ' ')
     end
   end
 
@@ -139,7 +141,7 @@ module EffectiveDatatablesPrivateHelper
       placeholder: (opts[:label] || name.to_s.titleize),
       value: value,
       wrapper: { class: 'form-group col-auto'}
-    }.merge(opts.except(:as, :collection, :parse, :value))
+    }.merge!(opts.except(:as, :collection, :parse, :value))
 
     options[:name] = '' unless datatable._filters_form_required?
 
@@ -149,6 +151,8 @@ module EffectiveDatatablesPrivateHelper
     elsif as == :boolean
       collection ||= [true, false].map { |value| [t("effective_datatables.boolean_#{value}"), value] }
       form.public_send(:select, name, collection, options) # boolean
+    elsif as == :string
+      form.public_send(:text_field, name, options)
     elsif form.respond_to?(as)
       form.public_send(as, name, options) # check_box, text_area
     else
@@ -169,7 +173,7 @@ module EffectiveDatatablesPrivateHelper
       label: false,
       required: false,
       wrapper: { class: 'form-group col-auto'}
-    }.merge(opts.except(:checked, :value))
+    }.merge!(opts.except(:checked, :value))
 
     form.radios :scope, collection, options
   end

data/app/models/effective/datatable.rb

@@ -1,8 +1,8 @@
 module Effective
   class Datatable
     attr_reader :attributes # Anything that we initialize our table with. That's it. Can't be changed by state.
-    attr_reader :effective_resource
     attr_reader :state
+    attr_accessor :effective_resource
 
     # Hashes of DSL options
     attr_reader :_aggregates
@@ -53,10 +53,36 @@ module Effective
       self.view = view if view
     end
 
+    def rendered(params = {})
+      raise('expected a hash of params') unless params.kind_of?(Hash)
+
+      view = ApplicationController.renderer.controller.helpers
+
+      view.class_eval do
+        attr_accessor :rendered_params
+
+        def current_user
+          rendered_params[:current_user]
+        end
+      end
+
+      if params[:current_user_id]
+        params[:current_user] = User.find(params[:current_user_id])
+      end
+
+      view.rendered_params = params
+
+      self.view = view
+      self
+    end
+
     # Once the view is assigned, we initialize everything
     def view=(view)
       @view = (view.respond_to?(:view_context) ? view.view_context : view)
-      raise 'expected view to respond to params' unless @view.respond_to?(:params)
+
+      unless @view.respond_to?(:params) || @view.respond_to?(:rendered_params)
+        raise 'expected view to respond to params'
+      end
 
       assert_attributes!
       load_attributes!

data/app/models/effective/datatable_value_tool.rb

@@ -187,9 +187,3 @@ module Effective
 
   end
 end
-
-# [
-#   [1, 'title 1'],
-#   [2, 'title 2'],
-#   [3, 'title 3']
-# ]

data/app/models/effective/effective_datatable/attributes.rb

@@ -11,6 +11,7 @@ module Effective
       end
 
       def load_attributes!
+        return unless view.respond_to?(:controller_path)
         @attributes[:namespace] ||= view.controller_path.split('/')[0...-1].join('/')
       end
 

data/app/models/effective/effective_datatable/compute.rb

@@ -64,6 +64,7 @@ module Effective
             if state[:visible][name] == false && (name != order_name)  # Sort by invisible array column
               BLANK
             elsif opts[:compute]
+
               if array_collection?
                 dsl_tool.instance_exec(obj, obj[opts[:index]], &opts[:compute])
               else

data/app/models/effective/effective_datatable/cookie.rb

@@ -10,6 +10,7 @@ module Effective
 
       def load_cookie!
         return unless EffectiveDatatables.save_state
+        return unless view.respond_to?(:cookies)
 
         @dt_cookie = view.cookies.signed['_effective_dt']
 
@@ -33,6 +34,7 @@ module Effective
 
       def save_cookie!
         return unless EffectiveDatatables.save_state
+        return unless view.respond_to?(:cookies)
 
         @dt_cookie ||= []
         @dt_cookie << [cookie_key, cookie_payload]

data/app/models/effective/effective_datatable/dsl/filters.rb

@@ -20,7 +20,7 @@ module Effective
             elsif value != nil
               Effective::Attribute.new(value).type
             end
-          ) || :text
+          ) || :string
 
           datatable._filters[name.to_sym] = {
             value: value,

data/app/models/effective/effective_datatable/format.rb

@@ -16,7 +16,7 @@ module Effective
           next unless state[:visible][name]
 
           if opts[:partial]
-            locals = { datatable: self, column: opts }.merge(resource_col_locals(opts))
+            locals = { datatable: self, column: opts }.merge!(resource_col_locals(opts))
 
             rendered[name] = (view.render(
               partial: opts[:partial],
@@ -27,7 +27,6 @@ module Effective
               spacer_template: SPACER_TEMPLATE
             ) || '').split(SPACER)
           elsif opts[:as] == :actions # This is actions_col and actions_col do .. end, but not actions_col partial: 'something'
-            resources = collection.map { |row| row[opts[:index]] }
             locals = { datatable: self, column: opts, spacer_template: SPACER_TEMPLATE }
 
             atts = {
@@ -36,16 +35,17 @@ module Effective
               effective_resource: effective_resource,
               locals: locals,
               partial: opts[:actions_partial],
-            }.compact.merge(opts[:actions])
+            }.merge!(opts[:actions]).tap(&:compact!)
 
             rendered[name] = if effective_resource.blank?
-              resources.map do |resource|
+              collection.map { |row| row[opts[:index]] }.map do |resource|
                 polymorphic_resource = Effective::Resource.new(resource, namespace: controller_namespace)
                 (view.render_resource_actions(resource, atts.merge(effective_resource: polymorphic_resource), &opts[:format]) || '')
               end
             else
-              (view.render_resource_actions(resources, atts, &opts[:format]) || '').split(SPACER)
+              (view.render_resource_actions(collection.map { |row| row[opts[:index]] }, atts, &opts[:format]) || '').split(SPACER)
             end
+
           end
         end
 
@@ -88,9 +88,9 @@ module Effective
         when :currency
           view.number_to_currency(value)
         when :date
-          (value.strftime('%F') rescue BLANK)
+          value.respond_to?(:strftime) ? value.strftime(EffectiveDatatables.format_date) : BLANK
         when :datetime
-          (value.strftime('%F %H:%M') rescue BLANK)
+          value.respond_to?(:strftime) ? value.strftime(EffectiveDatatables.format_datetime) : BLANK
         when :decimal
           value
         when :duration
@@ -116,7 +116,7 @@ module Effective
           when Numeric    ; view.number_to_currency(value)
           end
         when :time
-          (value.strftime('%H:%M') rescue BLANK)
+          value.respond_to?(:strftime) ? value.strftime(EffectiveDatatables.format_time) : BLANK
         else
           value.to_s
         end
@@ -135,7 +135,7 @@ module Effective
         end
 
         # Merge local options. Special behaviour for remote: false
-        if column[:actions].kind_of?(Hash) && column[:actions].present?
+        if column[:actions].present? && column[:actions].kind_of?(Hash)
           column[:actions].each do |action, opts|
             next unless opts.kind_of?(Hash)
 

data/app/models/effective/effective_datatable/params.rb

@@ -6,18 +6,23 @@ module Effective
 
       def datatables_ajax_request?
         return @_datatables_ajax_request unless @_datatables_ajax_request.nil?
+        return unless view.respond_to?(:params)
 
         @_datatables_ajax_request = (view.present? && view.params.key?(:draw) && view.params.key?(:columns))
       end
 
       def datatables_inline_request?
         return @_datatables_inline_request unless @_datatables_inline_request.nil?
+        return unless view.respond_to?(:params)
 
         @_datatables_inline_request = (view.present? && view.params[:_datatable_id].to_s.split('-')[0...-1] == to_param.split('-')[0...-1])
       end
 
       def params
         return {} unless view.present?
+        return view.rendered_params if view.respond_to?(:rendered_params)
+        return {} unless view.respond_to?(:request)
+
         @params ||= {}.tap do |params|
           Rack::Utils.parse_query(URI(view.request.referer.presence || '/').query).each { |k, v| params[k.to_sym] = v }
           view.params.each { |k, v| params[k.to_sym] = v }

data/app/models/effective/effective_datatable/resource.rb

@@ -4,7 +4,7 @@ module Effective
       AGGREGATE_SQL_FUNCTIONS = ['ARRAY_AGG(', 'AVG(', 'COUNT(', 'MAX(', 'MIN(', 'STRING_AGG(', 'SUM(']
 
       def admin_namespace?
-        controller_namespace == 'admin'
+        [:admin, 'admin'].include?(controller_namespace)
       end
 
       def controller_namespace
@@ -31,7 +31,7 @@ module Effective
       end
 
       def load_effective_resource!
-        @effective_resource = if active_record_collection?
+        @effective_resource ||= if active_record_collection?
           Effective::Resource.new(collection_class, namespace: controller_namespace)
         end
       end
@@ -98,9 +98,11 @@ module Effective
             opts[:sql_as_column] = true if (effective_resource.table && effective_resource.column(name).blank?)
           end
 
-          if opts[:sql_column].present? && AGGREGATE_SQL_FUNCTIONS.any? { |str| opts[:sql_column].to_s.start_with?(str) }
-            opts[:sql_as_column] = true
+          if opts[:sql_column].present?
+            sql_column = opts[:sql_column].to_s
+            opts[:sql_as_column] = true if AGGREGATE_SQL_FUNCTIONS.any? { |str| sql_column.start_with?(str) }
           end
+
         end
       end
 
@@ -200,6 +202,7 @@ module Effective
 
       def load_resource_belongs_tos!
         return unless active_record_collection?
+        return unless @_collection_apply_belongs_to
 
         changed = attributes.select do |attribute, value|
           attribute = attribute.to_s
@@ -210,7 +213,7 @@ module Effective
           next unless columns[associated]
 
           if columns[associated][:as] == :belongs_to
-            if @_collection_apply_belongs_to && !@_collection.where_values_hash.include?(attribute)
+            unless @_collection.where_values_hash.include?(attribute)
               @_collection = @_collection.where(attribute => value)
             end
 
@@ -218,10 +221,8 @@ module Effective
           elsif columns[associated][:as] == :belongs_to_polymorphic
             associated_type = attributes["#{associated}_type".to_sym] || raise("Expected #{associated}_type attribute to be present when #{associated}_id is present on a polymorphic belongs to")
 
-            if @_collection_apply_belongs_to
-              if !@_collection.where_values_hash.include?(attribute) && !@_collection.where_values_hash.include?("#{associated}_type")
-                @_collection = @_collection.where(attribute => value).where("#{associated}_type" => associated_type)
-              end
+            unless @_collection.where_values_hash.include?(attribute) || @_collection.where_values_hash.include?("#{associated}_type")
+              @_collection = @_collection.where(attribute => value).where("#{associated}_type" => associated_type)
             end
 
             columns.delete(associated)

data/app/models/effective/effective_datatable/state.rb

@@ -198,7 +198,7 @@ module Effective
       def parse_filter_value(filter, value)
         return filter[:parse].call(value) if filter[:parse]
         return nil if value.blank? && !filter[:required]
-        Effective::Attribute.new(filter[:value]).parse(value, name: filter[:name])
+        Effective::Attribute.new(filter[:as] || filter[:value] || :string).parse(value, name: filter[:name])
       end
 
       def cookie_state_params

data/app/views/effective/datatables/_active_storage_column.html.haml

@@ -1,4 +1,4 @@
 - Array(resource.public_send(column[:name])).each do |file|
   .col-resource_item
     - title = [file.content_type, number_to_human_size(file.byte_size)].map(&:presence).compact
-    = link_to(file.filename, url_for(file), title: title)
+    = link_to(file.filename, url_for(file), title: title, target: '_blank')

data/app/views/effective/datatables/_bulk_actions_dropdown.html.haml

@@ -1,8 +1,9 @@
 .btn-group.buttons-bulk-actions
   %button.btn.btn-link.btn-sm.dropdown-toggle{'type': 'button', 'data-toggle': 'dropdown', 'aria-haspopup': true, 'aria-expanded': false, 'disabled': 'disabled'}
-    Bulk Actions
+    = t('effective_datatables.bulk_actions')
   .dropdown-menu
     - if datatable._bulk_actions.present?
       = datatable._bulk_actions.join.html_safe
     - else
-      %a.dropdown-item{href: '#'} No bulk actions
+      %a.dropdown-item{href: '#'}
+        = t('effective_datatables.no_bulk_actions')

data/config/effective_datatables.rb

@@ -35,8 +35,12 @@ EffectiveDatatables.setup do |config|
   config.save_state = true
 
   # Configure the _effective_dt cookie.
-  config.cookie_max_size = 2000       # String size. Final byte size is about 1.5 times bigger, after rails signs it
+  config.cookie_max_size = 1500       # String size. Final byte size is about 1.5 times bigger, after rails signs it
   config.cookie_domain = :all         # Should usually be :all
   config.cookie_tld_length = nil      # Leave nil to autodetect, or set to probably 2
 
+  # Date formatting
+  config.format_datetime = '%F %H:%M'
+  config.format_date = '%F'
+  config.format_time = '%H:%M'
 end

data/config/locales/en.yml

@@ -7,6 +7,8 @@ en:
     new: New
     actions: Actions
     bulk_actions: Bulk Actions
+    no_bulk_actions: No bulk actions
     applying: Applying...
     boolean_true: 'Yes'
-    boolean_false: 'No'
+    boolean_false: 'No'
+    all: All

data/config/locales/es.yml

@@ -7,6 +7,8 @@ es:
     new: Nuevo
     actions: Acciones
     bulk_actions: Acciones en masa
+    no_bulk_actions: Sin acciones en masa
     applying: Filtrando...
     boolean_true: 'Sí'
-    boolean_false: 'No'
+    boolean_false: 'No'
+    all: Todo

data/config/locales/nl.yml

@@ -7,6 +7,8 @@ nl:
     new: Nieuwe
     actions: Acties
     bulk_actions: Bulkacties
+    no_bulk_actions: Geen bulkacties
     applying: Toepassen...
     boolean_true: 'Ja'
-    boolean_false: 'Nee'
+    boolean_false: 'Nee'
+    all: Te doen

data/lib/effective_datatables/version.rb

@@ -1,3 +1,3 @@
 module EffectiveDatatables
-  VERSION = '4.8.0'.freeze
+  VERSION = '4.8.16'.freeze
 end

data/lib/effective_datatables.rb

@@ -16,6 +16,10 @@ module EffectiveDatatables
   mattr_accessor :cookie_domain
   mattr_accessor :cookie_tld_length
 
+  mattr_accessor :format_datetime
+  mattr_accessor :format_date
+  mattr_accessor :format_time
+
   mattr_accessor :debug
 
   alias_method :max_cookie_size, :cookie_max_size

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_datatables
 version: !ruby/object:Gem::Version
-  version: 4.8.0
+  version: 4.8.16
 platform: ruby
 authors:
 - Code and Effect
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-31 00:00:00.000000000 Z
+date: 2021-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -129,11 +129,9 @@ files:
 - app/assets/stylesheets/effective_datatables.scss
 - app/assets/stylesheets/effective_datatables/_overrides.bootstrap4.scss
 - app/controllers/effective/datatables_controller.rb
-- app/datatables/effective_style_guide_datatable.rb
 - app/helpers/effective_datatables_controller_helper.rb
 - app/helpers/effective_datatables_helper.rb
 - app/helpers/effective_datatables_private_helper.rb
-- app/models/effective/access_denied.rb
 - app/models/effective/datatable.rb
 - app/models/effective/datatable_column.rb
 - app/models/effective/datatable_column_tool.rb
@@ -163,7 +161,6 @@ files:
 - app/views/effective/datatables/_resource_column.html.haml
 - app/views/effective/datatables/_spacer_template.html
 - app/views/effective/datatables/index.html.haml
-- app/views/effective/style_guide/_effective_datatables.html.haml
 - config/effective_datatables.rb
 - config/locales/en.yml
 - config/locales/es.yml
@@ -178,7 +175,7 @@ homepage: https://github.com/code-and-effect/effective_datatables
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -193,8 +190,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Uniquely powerful server-side searching, sorting and filtering of any ActiveRecord
   or Array collection as well as post-rendered content displayed as a frontend jQuery

data/app/datatables/effective_style_guide_datatable.rb

@@ -1,45 +0,0 @@
-class EffectiveStyleGuideDatatable < Effective::Datatable
-  datatable do
-    length 10
-
-    col :id
-    col :material, search: { collection: ['Stainless Steel', 'Copper', 'Cast Iron', 'Composite'] }
-    col :bowl, search: { collection: ['Single Bowl', 'Double Bowl', 'Triple Bowl'] }
-    col :name
-    col :date, as: :date
-  end
-
-  # Set the permission check to the same as Effective::StyleGuide
-  def collection_class
-    defined?(Effective::StyleGuide) ? Effective::StyleGuide : super
-  end
-
-  collection do
-    now = Time.zone.now
-    [
-      [1, 'Stainless Steel', 'Single Bowl', 'KOHLER Staccato', (now + 1.day)],
-      [2, 'Stainless Steel', 'Double Bowl', 'KOHLER Vault Undercounter', (now + 1.day)],
-      [3, 'Stainless Steel', 'Triple Bowl', 'KRAUS All-In-One', (now + 1.day)],
-      [4, 'Stainless Steel', 'Single Bowl', 'KOHLER Vault Dual Mount', (now + 1.day)],
-      [5, 'Stainless Steel', 'Single Bowl', 'KRAUS All-In-One Undermount', (now + 2.days)],
-      [6, 'Stainless Steel', 'Double Bowl', 'Glacier Bay All-in-One', (now + 2.days)],
-      [7, 'Stainless Steel', 'Single Bowl', 'Elkay Neptune', (now + 2.days)],
-      [8, 'Copper', 'Single Bowl', 'ECOSINKS Apron Front Dual Mount', (now + 2.days)],
-      [9, 'Copper', 'Double Bowl', 'ECOSINKS Dual Mount Front Hammered', (now + 2.days)],
-      [10, 'Copper', 'Triple Bowl', 'Glarier Bay Undermount', (now + 3.days)],
-      [11, 'Copper', 'Single Bowl', 'Whitehaus Undermount', (now + 3.days)],
-      [12, 'Copper', 'Double Bowl', 'Belle Foret Apron Front', (now + 3.days)],
-      [13, 'Copper', 'Double Bowl', 'Pegasus Dual Mount', (now + 3.days)],
-      [14, 'Cast Iron', 'Double Bowl', 'KOHLER Whitehaven', (now + 3.days)],
-      [15, 'Cast Iron', 'Triple Bowl', 'KOHLER Hartland', (now + 3.days)],
-      [16, 'Cast Iron', 'Single Bowl', 'KOHLER Cape Dory Undercounter', (now + 4.days)],
-      [17, 'Cast Iron', 'Double Bowl', 'KOLER Bakersfield', (now + 4.days)],
-      [18, 'Cast Iron', 'Double Bowl', 'American Standard Offset', (now + 4.days)],
-      [19, 'Cast Iron', 'Single Bowl', 'Brookfield Top', (now + 4.days)],
-      [20, 'Composite', 'Single Bowl', 'Blanco Diamond Undermount', (now + 5.days)],
-      [21, 'Composite', 'Double Bowl', 'Mont Blanc Waterbrook', (now + 5.days)],
-      [22, 'Composite', 'Triple Bowl', 'Pegasus Triple Mount', (now + 5.days)],
-      [23, 'Composite', 'Single Bowl', 'Swanstone Dual Mount', (now + 5.days)]
-    ]
-  end
-end

data/app/models/effective/access_denied.rb

@@ -1,17 +0,0 @@
-unless defined?(Effective::AccessDenied)
-  module Effective
-    class AccessDenied < StandardError
-      attr_reader :action, :subject
-
-      def initialize(message = nil, action = nil, subject = nil)
-        @message = message
-        @action = action
-        @subject = subject
-      end
-
-      def to_s
-        @message || I18n.t(:'unauthorized.default', :default => 'Access Denied')
-      end
-    end
-  end
-end

data/app/views/effective/style_guide/_effective_datatables.html.haml

@@ -1 +0,0 @@
-= render_datatable(EffectiveStyleGuideDatatable.new)