effective_datatables 4.9.0 → 4.9.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9344caa15ba3ff549a07b18f5d9cbcb8d9504216d4ba6184e9f591146a8340b2
-  data.tar.gz: 6b998d2a6d9f1c302005c509450b83d214ddddc27a9902e6748b2518ea618531
+  metadata.gz: 768310a5434c778a3e11512125d661bc4ce443a277bb7e15581e50224b81c48f
+  data.tar.gz: 6b05137c54ef11ce9801b2e1fc48ee525641d2dd5507b7259e80c3387335404b
 SHA512:
-  metadata.gz: 2117dd7f78e7329393504394126083d57da9ec7b7f5666b4d0931cbe7ed53aebfe359c696a6cd051559a5d15101715d656daa255300049a351728e3febc38def
-  data.tar.gz: 247561bc9c06a9450710f4743cb24c2ba243c64393122763988acb51932cdf2da839fface55ea4705afd8cd7322aa10b27655ec780ce128ed77cab1d0fc04aec
+  metadata.gz: edf03e2147e95afd515bc357ac5436dca96c0d3f1aa4fd36ac040bc1cc0885a1a34a0d6ff69897b61bafe8542b46447bc59adc96d42167fd4efc6b98cd65006b
+  data.tar.gz: 7027f034cee83b584d50290a34674295b3aca4d7b6cb0121ebd1dd052833ffdfaa0be50e26d493d736c8d8e7730aa89dc666b42c0e1219ba33c6ec495f9c01da

data/README.md

@@ -197,6 +197,13 @@ class PostsDatatable < Effective::Datatable
     # POSTs to the given url with params[:ids], an Array of ids for all selected rows
     # These actions are assumed to change the underlying collection
     bulk_action 'Approve all', bulk_approve_posts_path, data: { confirm: 'Approve all selected posts?' }
+    # GETs to the given url. Pass the ids via cookie, encoded in url, or LocalStorage.
+    # These actions are assumed to redirect the user to some other page.
+    bulk_action 'Action 1 | ids encoded in params', action_1_posts_path, data: { method: :get }
+
+    bulk_action 'Action 2 | ids stored in _ids_ field in local storage', action_2_posts_path, data: { 'payload-mode' => 'local-storage', method: :get }
+
+    bulk_action 'Action 3 | ids stored in _ids_ field in a cookie', action_3_posts_path, data: { 'payload-mode' => 'cookie', method: :get }
     bulk_action_divider
     bulk_action 'Destroy all', bulk_destroy_posts_path, data: { confirm: 'Destroy all selected posts?' }
   end
@@ -772,6 +779,12 @@ You can also specify `data-method: :get` to instead make a `GET` request with th
 ```ruby
 bulk_actions do
   bulk_action 'Approve all', bulk_approve_posts_path, data: { confirm: 'Approve all selected posts?' }
+
+  bulk_action 'Action 1 | ids encoded in params', action_1_posts_path, data: { method: :get }
+
+  bulk_action 'Action 2 | ids stored in _ids_ field in local storage', action_2_posts_path, data: { 'payload-mode' => 'local-storage', method: :get }
+
+  bulk_action 'Action 3 | ids stored in _ids_ field in a cookie', action_3_posts_path, data: { 'payload-mode' => 'cookie', method: :get }
 end
 ```
 
@@ -781,6 +794,9 @@ In your `routes` file:
 resources :posts do
   collection do
     post :bulk_approve
+    get :action_1
+    get :action_2
+    get :action_3
   end
 end
 ```
@@ -799,6 +815,22 @@ def bulk_approve
     render json: { status: 500, message: 'An error occured while approving a post.' }
   end
 end
+
+def action_1
+  @posts = Post.where(id: params[:ids])
+
+  render :some_partial
+end
+
+def action_2
+  @posts = Post.where(id: cookies[:ids].split(','))
+
+  render :some_partial
+end
+
+def action_3
+  render :some_partial # and get ids via JS:  localStorage.getItem('ids');
+end
 ```
 
 or if using [effective_resources](https://github.com/code-and-effect/effective_resources):

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

@@ -41,11 +41,25 @@ restoreSelected = ($table, selected) ->
 
   if present then $bulkActions.removeAttr('disabled') else $bulkActions.attr('disabled', 'disabled')
 
-#### Bulk Action link behaviour
+# rails_ujs data-confirm requires special attention
+# https://github.com/rails/rails/blob/main/actionview/app/assets/javascripts/rails-ujs/features/confirm.coffee
+$(document).on 'confirm:complete', '.dataTables_wrapper .buttons-bulk-actions a', (event) ->
+  if event.originalEvent.detail && event.originalEvent.detail[0] == true
+    doBulkActionPost(event)
+    (window.Rails || $.rails).stopEverything(event)
+    return false
+
 $(document).on 'click', '.dataTables_wrapper .buttons-bulk-actions a', (event) ->
-  event.preventDefault() # prevent the click
+  unless $(event.currentTarget).data('confirm')
+    doBulkActionPost(event)
+    event.preventDefault()
+
+doBulkActionPost = (event) ->
+  $bulkAction = $(event.currentTarget)  # This is the regular <a href=...> tag maybe with data-confirm
+
+  document.cookie = 'ids=; expires=Thu, 01 Jan 1970 00:00:00 GMT'
+  localStorage.removeItem('ids')
 
-  $bulkAction = $(event.currentTarget)  # This is a regular <a href=...> tag
   $wrapper = $bulkAction.closest('.dataTables_wrapper')
   $table = $wrapper.find('table.dataTable').first()
   $processing = $table.siblings('.dataTables_processing').first()
@@ -54,6 +68,7 @@ $(document).on 'click', '.dataTables_wrapper .buttons-bulk-actions a', (event) -
   url = $bulkAction.attr('href')
   title = $bulkAction.text()
   download = $bulkAction.data('bulk-download')
+  payload_mode = $bulkAction.data('payload-mode')
   token = $table.data('authenticity-token')
   values = $.map($selected, (input) -> input.getAttribute('value'))
   method = $bulkAction.data('ajax-method')
@@ -61,10 +76,17 @@ $(document).on 'click', '.dataTables_wrapper .buttons-bulk-actions a', (event) -
   return unless url && values
 
   if method == 'GET'
-    if url.includes('?')
-      window.location.assign(url + '&' + $.param({ids: values}))
+    if payload_mode == 'cookie'
+      document.cookie = "ids=#{values}";
+      window.location.assign(url)
+    else if payload_mode == 'local-storage'
+      localStorage.setItem('ids', values);
+      window.location.assign(url)
     else
-      window.location.assign(url + '?' + $.param({ids: values}))
+      if url.includes('?')
+        window.location.assign(url + '&' + $.param({ids: values}))
+      else
+        window.location.assign(url + '?' + $.param({ids: values}))
 
     return
 

data/app/helpers/effective_datatables_helper.rb

@@ -64,7 +64,7 @@ module EffectiveDatatablesHelper
       }
     }
 
-    if (charts || filters)
+    retval = if (charts || filters)
       output = ''.html_safe
 
       if charts
@@ -85,6 +85,10 @@ module EffectiveDatatablesHelper
         locals: { datatable: datatable, effective_datatable_params: effective_datatable_params }
       )
     end
+
+    Rails.logger.info("  Rendered datatable #{datatable.class} #{datatable.source_location}")
+
+    retval
   end
 
   def render_inline_datatable(datatable)

data/app/models/effective/datatable.rb

@@ -21,6 +21,9 @@ module Effective
     # The view
     attr_reader :view
 
+    # Set by DSL so we can track where this datatable is coming from
+    attr_accessor :source_location
+
     extend Effective::EffectiveDatatable::Dsl
 
     include Effective::EffectiveDatatable::Attributes

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

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

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

@@ -24,6 +24,8 @@ module Effective
           dsl_tool.in_datatables_do_block = true
           dsl_tool.instance_exec(&block)
           dsl_tool.in_datatables_do_block = false
+
+          self.source_location = block.source_location.first if block.respond_to?(:source_location)
         end
       end
 

data/lib/effective_datatables/version.rb

@@ -1,3 +1,3 @@
 module EffectiveDatatables
-  VERSION = '4.9.0'.freeze
+  VERSION = '4.9.4'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_datatables
 version: !ruby/object:Gem::Version
-  version: 4.9.0
+  version: 4.9.4
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-23 00:00:00.000000000 Z
+date: 2021-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails