effective_datatables 2.9.0 → 2.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9720cc5d9e1023fcb5acaf50e746a9fef4fc23cc
-  data.tar.gz: f7e27f1764ef6c995222f2fdc0a5590bc3ea6071
+  metadata.gz: 38df969bd8b6fe71d4e850119c2b65d8b961b858
+  data.tar.gz: b89352ad871da29903b18d0f1693740edce96141
 SHA512:
-  metadata.gz: aea28e65e30b7dd9d5e7f7e3da335bdec3ef4718748598f28d9d1e294b2bc4a1669cd5d4534019de809242b08204339a3f91212a3f176f4d6daf234a5f8572dd
-  data.tar.gz: 5ed6a4f01e6f5f7071730162bbadec00a8cf5cd569034ef80c51640fab482e9644724af3d1ded7d795cf6a8b1d6700b75ce444ef2f4b8b5b3dfa8a6decfa557e
+  metadata.gz: 1395f9861d1a4c806b3b1e21d618c6782e926d5f3e865d4e3060d99b7b0c56ae022afe50ab5381d940b196b51ec73c131104b1b92d2f5ffe7cbc353715fcefd8
+  data.tar.gz: 0bc0b48bbfd87c9e09b09520e19b27b68608230f07f7baaad76eb9f446f83d158554f388d4c96b1b3488c035e2671dac3a498768693cc134263dbe4e2bf5997e

data/README.md

@@ -487,10 +487,15 @@ You can define any number of `bulk_action`s, and separate them with one or more
 The `bulk_action` method is just an alias for `link_to`, so all the same options will work.
 
 ```ruby
-bulk_actions_column do
-  bulk_action 'Approve all', bulk_approve_posts_path, data: { method: :post, confirm: 'Approve all selected posts?' }
-  bulk_action_divider
-  bulk_action 'Send emails', bulk_email_posts_path, data : { method: :post, confirm: 'Really send emails?' }
+datatable do
+  bulk_actions_column do
+    bulk_action 'Approve all', bulk_approve_posts_path, data: {confirm: 'Approve all selected posts?'}
+    bulk_action_divider
+    bulk_action 'Send emails', bulk_email_posts_path, data : {confirm: 'Really send emails?'}
+  end
+
+  ...
+
 end
 ```
 
@@ -504,6 +509,7 @@ class PostsController < ApplicationController
     # You should probably write this inside a transaction.  This is just an example.
     begin
       @posts.each { |post| post.approve! }
+      render json: { status: 200, message: "Successfully approved #{@posts.length} posts." }
     rescue => e
       render json: { status: 500, message: 'An error occured while approving a post.' }
     end

data/app/assets/javascripts/effective_datatables.js

@@ -15,8 +15,9 @@
 //= require dataTables/responsive/responsive.bootstrap
 
 //= require effective_datatables/bulk_actions
+//= require effective_datatables/events
 //= require effective_datatables/responsive
 //= require effective_datatables/scopes
-//= require effective_datatables/charts
 
+//= require effective_datatables/charts
 //= require effective_datatables/initialize

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

@@ -79,3 +79,19 @@ $(document).on 'click', '.buttons-bulk-actions a', (event) ->
       $table.dataTable().data('bulk-actions-restore-selected-values', values)
       $table.DataTable().draw()
     )
+
+# We borrow the Processing div for our bulk action success/error messages
+# This makes sure that the message is displayed for 1500ms
+$(document).on 'processing.dt', (event, settings, visible) ->
+  return if settings.bDestroying
+
+  $processing = $(event.target).siblings('.dataTables_processing').first()
+  return unless $processing.data('bulk-actions-processing')
+
+  timeout = $processing.show().data('timeout')
+  clearTimeout(timeout) if timeout
+  $processing.data('timeout', setTimeout( =>
+      $processing.html('Processing...').hide()
+      $processing.data('bulk-actions-processing', null)
+    , 1500)
+  )

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

@@ -0,0 +1,13 @@
+# Redraw the table, and initialize any filter form inputs after the last column made visible
+$(document).on 'column-visibility.dt', (event, settings, index, state) ->
+  return if settings.bDestroying
+
+  $table = $(event.target)
+
+  timeout = $table.data('timeout')
+  clearTimeout(timeout) if timeout
+  $table.data('timeout', setTimeout( =>
+      $table.DataTable().draw()
+      $.event.trigger('page:change')
+    , 700)
+  )

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

@@ -169,38 +169,15 @@ initializeDataTables = ->
     if datatable.data('effective-form-inputs')
       try table.closest('.dataTables_wrapper').find('.dataTables_length select').select2()
 
-    # Capture column visibility changes and refresh datatable
-    datatable.on 'column-visibility.dt', (event, settings, index, state) ->
-      $table = $(event.currentTarget)
-
-      timeout = $table.data('timeout')
-      clearTimeout(timeout) if timeout
-      $table.data('timeout', setTimeout( =>
-          $table.DataTable().draw()
-          $.event.trigger('page:change')
-        , 700)
-      )
-
-    # We borrow the Processing div for our bulk action success/error messages
-    # This makes sure that the message is displayed for 1500ms
-    datatable.on 'processing.dt', (event, settings, visible) ->
-      $processing = $(event.currentTarget).siblings('.dataTables_processing').first()
-      return unless $processing.data('bulk-actions-processing')
-
-      timeout = $processing.show().data('timeout')
-      clearTimeout(timeout) if timeout
-      $processing.data('timeout', setTimeout( =>
-          $processing.html('Processing...').hide()
-          $processing.data('bulk-actions-processing', null)
-        , 1500)
-      )
-
 destroyDataTables = ->
   $('table.effective-datatable').each ->
     if $.fn.DataTable.fnIsDataTable(this)
       $(this).DataTable().destroy()
 
+$ -> initializeDataTables()
 $(document).on 'page:change', -> initializeDataTables()
 $(document).on 'turbolinks:load', -> initializeDataTables()
+$(document).on 'turbolinks:before-cache', -> destroyDataTables()
+
 
 

data/app/controllers/effective/datatables_controller.rb

@@ -10,15 +10,15 @@ module Effective
       @datatable = find_datatable(params[:id]).try(:new, attributes.merge(scopes))
       @datatable.view = view_context if !@datatable.nil?
 
-      EffectiveDatatables.authorized?(self, :index, @datatable.try(:collection_class) || @datatable.try(:class))
+      EffectiveDatatables.authorized?(self, :index, @datatable.try(:collection_class))
 
       respond_to do |format|
         format.html
         format.json {
           if Rails.env.production?
-            render :json => (@datatable.to_json rescue error_json)
+            render json: (@datatable.to_json rescue error_json)
           else
-            render :json => @datatable.to_json
+            render json: @datatable.to_json
           end
         }
       end
@@ -28,20 +28,17 @@ module Effective
     private
 
     def find_datatable(id)
-      id_plural = id.pluralize == id && id.singularize != id
-      klass = "effective/datatables/#{id}".classify
-
-      (id_plural ? klass.pluralize : klass).safe_constantize
+      id.classify.safe_constantize || id.classify.pluralize.safe_constantize
     end
 
     def error_json
       {
-        :draw => params[:draw].to_i,
-        :data => [],
-        :recordsTotal => 0,
-        :recordsFiltered => 0,
-        :aggregates => [],
-        :charts => {}
+        draw: params[:draw].to_i,
+        data: [],
+        recordsTotal: 0,
+        recordsFiltered: 0,
+        aggregates: [],
+        charts: {}
       }.to_json
     end
 

data/app/helpers/effective_datatables_helper.rb

@@ -7,9 +7,9 @@ module EffectiveDatatablesHelper
     datatable.view ||= self
 
     begin
-      EffectiveDatatables.authorized?(controller, :index, datatable.try(:collection_class) || datatable.try(:class)) || raise('unauthorized')
+      EffectiveDatatables.authorized?(controller, :index, datatable.collection_class) || raise('unauthorized')
     rescue => e
-      return content_tag(:p, "You are not authorized to view this datatable. (cannot :index, #{datatable.try(:collection_class) || datatable.try(:class)})")
+      return content_tag(:p, "You are not authorized to view this datatable. (cannot :index, #{datatable.collection_class})")
     end
 
     render partial: 'effective/datatables/datatable',
@@ -23,9 +23,9 @@ module EffectiveDatatablesHelper
     datatable.simple = true
 
     begin
-      EffectiveDatatables.authorized?(controller, :index, datatable.try(:collection_class) || datatable.try(:class)) || raise('unauthorized')
+      EffectiveDatatables.authorized?(controller, :index, datatable.collection_class) || raise('unauthorized')
     rescue => e
-      return content_tag(:p, "You are not authorized to view this datatable. (cannot :index, #{datatable.try(:collection_class) || datatable.try(:class)})")
+      return content_tag(:p, "You are not authorized to view this datatable. (cannot :index, #{datatable.collection_class})})")
     end
 
     render partial: 'effective/datatables/datatable',

data/app/helpers/effective_datatables_private_helper.rb

@@ -45,12 +45,14 @@ module EffectiveDatatablesPrivateHelper
     pattern = opts[:filter].key?(:pattern) ? opts[:filter][:pattern] : nil
     placeholder = opts[:filter].key?(:placeholder) ? opts[:filter][:placeholder] : (opts[:label] || name.titleize)
     title = opts[:filter].key?(:title) ? opts[:filter][:title] : (opts[:label] || name.titleize)
+    wrapper_html = { class: 'datatable_filter' }
 
     case opts[:filter][:as]
     when :string, :text, :number
       form.input name, label: false, required: false, value: value,
         as: :string,
         placeholder: placeholder,
+        wrapper_html: wrapper_html,
         input_html: { name: nil, value: value, title: title, pattern: pattern, autocomplete: 'off', data: {'column-name' => opts[:name], 'column-index' => opts[:index]} }
     when :obfuscated_id
       pattern ||= '[0-9]{3}-?[0-9]{4}-?[0-9]{3}'
@@ -59,11 +61,13 @@ module EffectiveDatatablesPrivateHelper
       form.input name, label: false, required: false, value: value,
         as: :string,
         placeholder: placeholder,
+        wrapper_html: wrapper_html,
         input_html: { name: nil, value: value, title: title, pattern: pattern, autocomplete: 'off', data: {'column-name' => opts[:name], 'column-index' => opts[:index]} }
     when :date
       form.input name, label: false, required: false, value: value,
         as: (ActionView::Helpers::FormBuilder.instance_methods.include?(:effective_date_picker) ? :effective_date_picker : :string),
         placeholder: placeholder,
+        wrapper_html: wrapper_html,
         input_group: false,
         input_html: { name: nil, value: value, title: title, autocomplete: 'off', data: {'column-name' => opts[:name], 'column-index' => opts[:index]} },
         input_js: { useStrict: true, keepInvalid: true }
@@ -71,6 +75,7 @@ module EffectiveDatatablesPrivateHelper
       form.input name, label: false, required: false, value: value,
         as: (ActionView::Helpers::FormBuilder.instance_methods.include?(:effective_date_time_picker) ? :effective_date_time_picker : :string),
         placeholder: placeholder,
+        wrapper_html: wrapper_html,
         input_group: false,
         input_html: { name: nil, value: value, title: title, autocomplete: 'off', data: {'column-name' => opts[:name], 'column-index' => opts[:index]} },
         input_js: { useStrict: true, keepInvalid: true } # Keep invalid format like "2015-11" so we can still filter by year, month or day
@@ -81,6 +86,7 @@ module EffectiveDatatablesPrivateHelper
         selected: opts[:filter][:selected],
         multiple: opts[:filter][:multiple] == true,
         include_blank: include_blank,
+        wrapper_html: wrapper_html,
         input_html: { name: nil, value: value, title: title, autocomplete: 'off', data: {'column-name' => opts[:name], 'column-index' => opts[:index]} },
         input_js: { placeholder: placeholder }
     when :grouped_select
@@ -94,6 +100,7 @@ module EffectiveDatatablesPrivateHelper
         polymorphic: opts[:filter][:polymorphic] == true,
         group_label_method: opts[:filter][:group_label_method] || :first,
         group_method: opts[:filter][:group_method] || :last,
+        wrapper_html: wrapper_html,
         input_html: { name: nil, value: value, title: title, autocomplete: 'off', data: {'column-name' => opts[:name], 'column-index' => opts[:index]} },
         input_js: { placeholder: placeholder }
     when :bulk_actions_column

data/app/models/effective/array_datatable_tool.rb

@@ -84,7 +84,7 @@ module Effective
     private
 
     def display_index(column)
-      display_table_columns.present? ? display_table_columns.keys.index(column[:name]) : column[:array_index]
+      display_table_columns.present? ? display_table_columns.keys.index(column[:name]) : column[:index]
     end
 
   end

data/app/models/effective/datatable.rb

@@ -8,6 +8,7 @@ module Effective
     delegate :render, :controller, :link_to, :mail_to, :number_to_currency, :number_to_percentage, :to => :@view
 
     extend Effective::EffectiveDatatable::Dsl
+
     include Effective::EffectiveDatatable::Dsl::BulkActions
     include Effective::EffectiveDatatable::Dsl::Charts
     include Effective::EffectiveDatatable::Dsl::Datatable
@@ -83,7 +84,7 @@ module Effective
     end
 
     def to_param
-      @to_param ||= self.class.name.underscore.sub('effective/datatables/', '')
+      @to_param ||= self.class.name.underscore
     end
 
     def collection
@@ -101,12 +102,12 @@ module Effective
         data = table_data
 
         {
-          :draw => (params[:draw] || 0),
-          :data => (data || []),
-          :recordsTotal => (total_records || 0),
-          :recordsFiltered => (display_records || 0),
-          :aggregates => (aggregate_data(data) || []),
-          :charts => (charts_data || {})
+          draw: (params[:draw] || 0),
+          data: (data || []),
+          recordsTotal: (total_records || 0),
+          recordsFiltered: (display_records || 0),
+          aggregates: (aggregate_data(data) || []),
+          charts: (charts_data || {})
         }
       end
     end

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

@@ -8,21 +8,21 @@ module Effective
       end
 
       # Override this function to perform custom searching on a column
-      def search_column(collection, table_column, search_term, sql_column_or_array_index)
+      def search_column(collection, table_column, search_term, sql_column_or_index)
         if table_column[:array_column]
-          array_tool.search_column_with_defaults(collection, table_column, search_term, sql_column_or_array_index)
+          array_tool.search_column_with_defaults(collection, table_column, search_term, sql_column_or_index)
         else
-          table_tool.search_column_with_defaults(collection, table_column, search_term, sql_column_or_array_index)
+          table_tool.search_column_with_defaults(collection, table_column, search_term, sql_column_or_index)
         end
       end
 
       # Override this function to perform custom ordering on a column
       # direction will be :asc or :desc
-      def order_column(collection, table_column, direction, sql_column_or_array_index)
+      def order_column(collection, table_column, direction, sql_column_or_index)
         if table_column[:array_column]
-          array_tool.order_column_with_defaults(collection, table_column, direction, sql_column_or_array_index)
+          array_tool.order_column_with_defaults(collection, table_column, direction, sql_column_or_index)
         else
-          table_tool.order_column_with_defaults(collection, table_column, direction, sql_column_or_array_index)
+          table_tool.order_column_with_defaults(collection, table_column, direction, sql_column_or_index)
         end
       end
     end

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

@@ -85,17 +85,12 @@ module Effective
         end
 
         table_columns = cols.each_with_index do |(name, _), index|
-          # If this is a belongs_to, add an :if clause specifying a collection scope if
-          if belong_tos.key?(name)
-            cols[name][:if] ||= Proc.new { attributes[belong_tos[name][:foreign_key]].blank? }
-          end
-
           sql_column = (collection.columns rescue []).find do |column|
             column.name == name.to_s || (belong_tos.key?(name) && column.name == belong_tos[name][:foreign_key])
           end
 
           cols[name][:array_column] ||= false
-          cols[name][:array_index] = index # The index of this column in the collection, regardless of hidden table_columns
+          cols[name][:index] = index # The index of this column in the collection, regardless of hidden table_columns
           cols[name][:name] ||= name
           cols[name][:label] ||= name.titleize
           cols[name][:column] ||= (sql_table && sql_column) ? "#{quote_sql(sql_table.name)}.#{quote_sql(sql_column.name)}" : name
@@ -163,19 +158,6 @@ module Effective
           end
         end
 
-        # After everything is initialized
-        # Compute any col[:if] and assign an index
-        count = 0
-        table_columns.each do |name, col|
-          if display_column?(col)
-            col[:index] = count
-            count += 1
-          else
-            # deleting rather than using `table_columns.select` above in order to maintain
-            # this hash as a type of HashWithIndifferentAccess
-            table_columns.delete(name)
-          end
-        end
       end
 
       def initialize_table_column_filter(column, belongs_to, has_many, has_and_belongs_to_manys)
@@ -279,15 +261,6 @@ module Effective
         end.merge(filter.symbolize_keys)
       end
 
-      private
-
-      def display_column?(col)
-        if col[:if].respond_to?(:call)
-          (view || self).instance_exec(&col[:if])
-        else
-          col.fetch(:if, true)
-        end
-      end
     end
   end
 end

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

@@ -94,7 +94,7 @@ module Effective
                   if active_record_collection?
                     view.instance_exec(obj, collection, self, &opts[:block])
                   else
-                    view.instance_exec(obj, obj[opts[:array_index]], collection, self, &opts[:block])
+                    view.instance_exec(obj, obj[opts[:index]], collection, self, &opts[:block])
                   end
                 rescue NoMethodError => e
                   if opts[:type] == :actions && e.message == 'super called outside of method'
@@ -107,7 +107,7 @@ module Effective
                 if active_record_collection?
                   view.instance_exec(obj, collection, self, &opts[:proc])
                 else
-                  view.instance_exec(obj, obj[opts[:array_index]], collection, self, &opts[:proc])
+                  view.instance_exec(obj, obj[opts[:index]], collection, self, &opts[:proc])
                 end
               elsif opts[:partial]
                 rendered[name][index]
@@ -130,7 +130,7 @@ module Effective
               elsif opts[:type] == :effective_roles
                 (obj.send(:roles) rescue [])
               elsif obj.kind_of?(Array) # Array backed collection
-                obj[opts[:array_index]]
+                obj[opts[:index]]
               elsif opts[:sql_as_column]
                 obj[name] || obj.send(name)
               else

data/lib/effective_datatables/version.rb

@@ -1,3 +1,3 @@
 module EffectiveDatatables
-  VERSION = '2.9.0'.freeze
+  VERSION = '2.10.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_datatables
 version: !ruby/object:Gem::Version
-  version: 2.9.0
+  version: 2.10.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-07 00:00:00.000000000 Z
+date: 2017-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -122,6 +122,7 @@ files:
 - app/assets/javascripts/effective_datatables.js
 - app/assets/javascripts/effective_datatables/bulk_actions.js.coffee
 - app/assets/javascripts/effective_datatables/charts.js.coffee
+- app/assets/javascripts/effective_datatables/events.js.coffee
 - app/assets/javascripts/effective_datatables/initialize.js.coffee
 - app/assets/javascripts/effective_datatables/responsive.js.coffee
 - app/assets/javascripts/effective_datatables/scopes.js.coffee