effective_datatables 4.8.3 → 4.8.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1ebc0017738a2fc14868698d1ea0bc18e96c30b796abfc1c2b13e56a08e0af7
-  data.tar.gz: d3207a967e3ef7864da7865af6c9c349cc414a9a4d137437798c21971bc9dfe5
+  metadata.gz: a9523ed0159096daf782db8331cd502b8b705667a9b6bce9b22e5e46a167cfed
+  data.tar.gz: 8e118dcc38bbfd2f2bbb47e2e24cbb76a12159e97060636c0625f714b7d8badf
 SHA512:
-  metadata.gz: cedbeff6abe599502b345b034cb8c62aa27c404b72d27baa1d0648273b73731bcfba68437854458bc69e986eadf6936407513275234c594ffc3c6c0619c23860
-  data.tar.gz: '04650818c9871e4ba2e00ff07d919b9b81c25b867e6033626d6b41004cf7e51fc8943751ca0c8762d83040473127a92672906e6217a677fced997f024ff6510e'
+  metadata.gz: 75f57a4bd505a0c21f121c506dc3dad7f757af1a94e3e3677dfd5a941e6e1650411eacfd774d45ebe2e6c94e8cc67f47eabe89f4644824aa154cf05126e7621c
+  data.tar.gz: abdc9f48a7694c17313fc4a10f50987c8ecbd56e8796d1651c633c82b788ddcf94c06205797a7204fcbd49a00fb4f68bc99b6ed2884feb99d74b8a3a2d228e6e

data/README.md

@@ -1155,6 +1155,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/initialize.js.coffee

@@ -175,7 +175,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)

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
 

data/app/models/effective/datatable.rb

@@ -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/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/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/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
 
@@ -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
@@ -200,6 +200,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 +211,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 +219,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/lib/effective_datatables/version.rb

@@ -1,3 +1,3 @@
 module EffectiveDatatables
-  VERSION = '4.8.3'.freeze
+  VERSION = '4.8.8'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_datatables
 version: !ruby/object:Gem::Version
-  version: 4.8.3
+  version: 4.8.8
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-02 00:00:00.000000000 Z
+date: 2020-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -193,7 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Uniquely powerful server-side searching, sorting and filtering of any ActiveRecord