effective_datatables 4.8.4 → 4.8.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53f857de2d8388bada0837e3eca598ab75e45cba907bde7b43c01a13c2037cb1
-  data.tar.gz: '0488a5bf9fafd8a54833615f6d7610d22567d97c5e1b0d13cd2476e24706d08b'
+  metadata.gz: da2dfe401e2839d034033b2af1b0048cf3c6a726b87a1f6ccc4354eb71183f55
+  data.tar.gz: b6c6a44db10ce020e32bd79de4f1dc8a77106122f7725524414e0ccfa2ee4265
 SHA512:
-  metadata.gz: 740d034417e5aa04860b12a308f4e495b3856c4b86a67443f6ec2e18900a55be58c6edb7235d8ef66981bb827f05ecab29d3f691765b5dee43f5312804644adf
-  data.tar.gz: 91712a50aff213013867fd46bbdedc717e0c95fef1748d2d9076bfdd5930ce14a3fff1d158f0feed409c8431fb16b317fae1c34b21accd855546dc089c9dbb0d
+  metadata.gz: 75201440e6f62b181ebce2f54dbaedcffae413a42803e1b0e39a7869f8425e776d51b10b88c2625d142a89895eb6f4ab3f174715782bdb068c5958908b0e36a3
+  data.tar.gz: b9442dab7b1f1b7a1b34e39ec1b67e3241757b1978272ea051c01cf77a9ae074b1ccac33aa18cc52a84a1f735697b41c72fba970a1d39a0c1a734d40c17f125c

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/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?
 
@@ -171,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

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

@@ -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,7 +202,7 @@ module Effective
 
       def load_resource_belongs_tos!
         return unless active_record_collection?
-        return unless @_collection_apply_belongs_to 
+        return unless @_collection_apply_belongs_to
 
         changed = attributes.select do |attribute, value|
           attribute = attribute.to_s

data/lib/effective_datatables/version.rb

@@ -1,3 +1,3 @@
 module EffectiveDatatables
-  VERSION = '4.8.4'.freeze
+  VERSION = '4.8.9'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_datatables
 version: !ruby/object:Gem::Version
-  version: 4.8.4
+  version: 4.8.9
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-15 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