effective_datatables 2.2.11 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 925dbdcde129594000b35c33bdcca9d40a2270a2
-  data.tar.gz: 45aaec09d5196309e7975c51de52ad97f2d52690
+  metadata.gz: 46c6bd508e444a1f4d8bf7c6076bcc3885e5bf99
+  data.tar.gz: 3188dca9b7172fe41c80d514a49975ee6d7eee44
 SHA512:
-  metadata.gz: 3cd98bc405d0be8aa0da7c8fccbc0657334bdb619ffef1f4f114051ec1ab2ab8d5ace4806da40ce2178855118e351fba9b03d357599e4a04cd080f82b24ee049
-  data.tar.gz: d743c635c18acb6b64a051e944fcc787e57f753f6b3a0767da299711262542dcca7e5d146f02885e9e1bc91d28c0c2950d5bb0e34c7bde8639d36dd29ceeec07
+  metadata.gz: 6619d02959a4c5f48300477daec85d2a39ab0e01240281e52cc26f7d58f451e7a305846d085b82eb6c7722ada044ebd0babbbe77cee5c3330812ec075b52bc14
+  data.tar.gz: 3d93e98a7919a064d2556c6f2479a46a5f5c21bd6e8b00ea7a833874f5048d9b8d0248d980f05e81d8425e0632fcbaff3c9e9624bb6e1f40bcc6f24e1de3569d

data/README.md

@@ -435,6 +435,59 @@ Optionally uses the authorization method (below) to determine if the `current_us
 
 See the `config/initializers/effective_datatable.rb` file for more information.
 
+## bulk_actions_column
+
+Creates a column of checkboxes to select one, some, or all rows and adds a bulk actions dropdown button.
+
+When one or more checkboxes are checked, the bulk actions dropdown is enabled and any defined `bulk_action`s will be available to click.
+
+Clicking a bulk action makes an AJAX POST request with the parameters `ids: [1, 2, 3]` as per the selected rows.
+
+By default, the method used to determine each row's checkbox value is `to_param`. To call a different method use `bulk_actions_column(resource_method: :slug) do ... end`.
+
+This feature has been built with an ActiveRecord collection in mind. To work with an Array backed collection try `resource_method: :first` or similar.
+
+After the AJAX request is done, the datatable will be redrawn so any changes made to the collection will be displayed immediately.
+
+You can define any number of `bulk_action`s, and separate them with one or more `bulk_action_divider`s.
+
+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: { confirm: 'Approve all selected posts?' }
+  bulk_action_divider
+  bulk_action 'Send emails', bulk_email_posts_path, data : { confirm: 'Really send emails?' }
+end
+```
+
+You still need to write your own controller action to process the bulk action.  Something like:
+
+```ruby
+class PostsController < ApplicationController
+  def bulk_approve
+    @posts = Post.where(id: params[:ids])
+
+    # You should probably write this inside a transaction.  This is just an example.
+    begin
+      @posts.each { |post| post.approve! }
+    rescue => e
+      render json: { status: 500, message: 'An error occured while approving a post.' }
+    end
+  end
+end
+```
+
+and in your `routes.rb`:
+
+```ruby
+resources :posts do
+  collection do
+    post :bulk_approve
+  end
+end
+```
+
 ## table_columns
 
 Quickly create multiple table_columns all with default options:
@@ -461,7 +514,6 @@ default_entries :all
 
 Valid options are `10, 25, 50, 100, 250, 1000, :all`
 
-
 ## Additional Functionality
 
 There are a few other ways to customize the behaviour of effective_datatables

data/app/assets/javascripts/effective_datatables.js

@@ -15,7 +15,8 @@
 //= require dataTables/responsive/dataTables.responsive.min
 //= require dataTables/responsive/responsive.bootstrap.min
 
-//= require_tree ./effective_datatables
+//= require effective_datatables/bulk_actions
+//= require effective_datatables/initialize
 
 $.extend( $.fn.dataTable.defaults, {
   'dom': "<'row'<'col-sm-4'l><'col-sm-8'B>><'row'<'col-sm-12'tr>><'row'<'col-sm-6'i><'col-sm-6'p>>"

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

@@ -0,0 +1,58 @@
+#### Checkbox toggling and Bulk Actions dropdown disabling
+
+$(document).on 'change', "input[data-role='bulk-actions-resource']", (event) ->
+  $("input[data-role='bulk-actions-all']").prop('checked', false)
+  toggleClosestBulkActionsButton($(event.currentTarget))
+
+$(document).on 'change', "input[data-role='bulk-actions-all']", (event) ->
+  $checkAll = $(event.currentTarget)
+  $resources = $("input[data-role='bulk-actions-resource']")
+
+  if $checkAll.is(':checked')
+    $resources.prop('checked', true)
+  else
+    $resources.prop('checked', false)
+
+  toggleClosestBulkActionsButton($checkAll)
+
+toggleClosestBulkActionsButton = (element) ->
+  $wrapper = element.closest('.dataTables_wrapper')
+  $bulkActions = $wrapper.children().first().find('.buttons-bulk-actions').children('button')
+
+  if $wrapper.find("input[data-role='bulk-actions-resource']:checked").length > 0
+    $bulkActions.removeAttr('disabled')
+  else
+    $bulkActions.attr('disabled', 'disabled')
+
+
+#### Bulk Action link behaviour
+$(document).on 'click', '.buttons-bulk-actions a', (event) ->
+  event.preventDefault() # prevent the click
+
+  $bulkAction = $(event.currentTarget)  # This is a regular <a href=...> tag
+  $wrapper = $bulkAction.closest('.dataTables_wrapper')
+  $table = $wrapper.find('table.dataTable').first()
+  $selected = $table.find("input[data-role='bulk-actions-resource']:checked")
+
+  url = $bulkAction.attr('href')
+  title = $bulkAction.text()
+  values = $.map($selected, (input) -> input.getAttribute('value'))
+
+  return unless url && values
+
+  # Show Processing... and disable the Bulk Actions dropdown
+  $table.siblings('.dataTables_processing').show()
+  $wrapper.children().first().find('.buttons-bulk-actions').children('button').attr('disabled', 'disabled')
+
+  $.post(
+    url, { ids: values }
+  ).done((response) ->
+    success = response['message'] || "Successfully completed #{title} bulk action"
+    $table.siblings('.dataTables_processing').html(success)
+  ).fail((response) ->
+    error = response['message'] || "An error occured while attempting #{title} bulk action: #{response.statusText}"
+    alert(error)
+  ).always((response) ->
+    $table.dataTable().data('bulk-actions-restore-selected-values', values)
+    $table.DataTable().draw()
+  )

data/app/assets/javascripts/effective_datatables/{initialize.js.coffee.erb → initialize.js.coffee}

@@ -64,27 +64,53 @@ initializeDataTables = ->
       serverSide: true
       scrollCollapse: true
       pagingType: 'simple_numbers'
-      headerCallback: ->
-        table = this.api()
-        table.columns().flatten().each (index) =>
-          $th = $(table.column(index).header())
-          return if $th.hasClass('initialized')
+      initComplete: (settings) ->
+        initializeBulkActions(this.api())
+        initializeFilters(this.api())
+      drawCallback: (settings) ->
+        $table = $(this.api().table().node())
+        selected = $table.data('bulk-actions-restore-selected-values')
+        completeBulkAction($table, selected) if selected && selected.length > 0
+
+    # Copies the bulk actions html, stored in a data attribute on the table, into the buttons area
+    initializeBulkActions = (api) ->
+      $table = $(api.table().node())
+      bulkActions = $table.data('bulk-actions')
+
+      if bulkActions
+        $table.closest('.dataTables_wrapper').children().first()
+          .find('.dt-buttons').first().prepend(bulkActions['dropdownHtml'])
+
+    # After we perform a bulk action, we have to re-select the checkboxes manually and do a bit of house keeping
+    completeBulkAction = ($table, selected) ->
+      $table.find("input[data-role='bulk-actions-resource']").each (_, input) ->
+        $input = $(input)
+        $input.prop('checked', selected.indexOf($input.val()) > -1)
 
-          settings = table.settings()[0].aoColumns[index] # column specific settings
+      $wrapper = $table.closest('.dataTables_wrapper')
+      $wrapper.children().first().find('.buttons-bulk-actions').children('button').removeAttr('disabled')
+      $table.siblings('.dataTables_processing').html('Processing...')
 
-          if settings.filterSelectedValue  # Assign preselected filter values
-            table.settings()[0].aoPreSearchCols[index].sSearch = settings.filterSelectedValue
+    # Appends the filter html, stored in the column definitions, into each column header
+    initializeFilters = (api) ->
+      api.columns().flatten().each (index) =>
+        $th = $(api.column(index).header())
+        settings = api.settings()[0].aoColumns[index] # column specific settings
 
-          if settings.filterHtml  # Append the html filter HTML and initialize input events
-            $th.append('<br>' + settings.filterHtml)
-            initializeFilterEvents($th)
+        if settings.filterSelectedValue  # Assign preselected filter values
+          api.settings()[0].aoPreSearchCols[index].sSearch = settings.filterSelectedValue
 
-          $th.addClass('initialized')
+        if settings.filterHtml  # Append the html filter HTML and initialize input events
+          $th.append('<br>' + settings.filterHtml)
+          initializeFilterEvents($th)
 
     # Sets up the proper events for each input
-    initializeFilterEvents = (th) ->
-      th.find('input,select').each (_, input) ->
+    initializeFilterEvents = ($th) ->
+      $th.find('input,select').each (_, input) ->
         $input = $(input)
+
+        return true if $input.attr('type') == 'hidden' || $input.attr('type') == 'checkbox'
+
         $input.parent().on 'click', (event) -> false # Dont order columns when you click inside the input
         $input.parent().on 'mousedown', (event) -> event.stopPropagation() # Dont order columns when you click inside the input
 

data/app/assets/stylesheets/effective_datatables/_overrides.scss.erb

@@ -34,6 +34,7 @@ table.dataTable thead tr th {
   padding: 6px;
 
   .form-group { margin-bottom: 0px; font-weight: normal; }
+
 }
 
 table.dataTable td ul {
@@ -50,12 +51,15 @@ table.dataTable.sort-hidden thead .sorting_desc { background-image: none; }
 table.dataTable .form-group { width: 100%; margin-left: 0px; margin-right: 0px; }
 table.dataTable input,select { width: 100%;  }
 table.dataTable .form-control { width: 100%;  }
+table.dataTable .form-group.datatable_filter_bulk_actions { margin-left: 4px; }
 
 // Processing popup
 div.dataTables_wrapper div.dataTables_processing {
   top: -20px;
   border: none;
   box-shadow: none;
+  margin-left: -40%;
+  width: 80%;
 }
 
 // Show x per page
@@ -73,33 +77,35 @@ div.dt-buttons {
   width: auto;
 }
 
-.dt-buttons > a {
-  border: none;
-  color: #337ab7;
-  border-color: transparent;
-  background: #fff;
-  font-size: 12px;
-  padding: 6px;
-  margin-right: 6px;
-  float: none;
-
-  &:hover,
-  &:focus {
+.dt-buttons {
+  a, button {
     border: none;
+    color: #337ab7;
     border-color: transparent;
-    background: #eee !important;
-  }
+    background: #fff;
+    font-size: 12px;
+    padding: 6px;
+    margin-right: 6px;
+    float: none;
+
+    &:hover,
+    &:focus {
+      border: none;
+      border-color: transparent;
+      background: #eee !important;
+    }
 
-  &:last-child { margin-right: 0px; }
+    &:last-child { margin-right: 0px; }
 
-  &.active {
-    color: #fff;
-    background: #03428d !important;
-  }
-}
+    &.active {
+      color: #fff;
+      background: #03428d !important;
+    }
 
-.dt-buttons.btn-group > a {
-  margin-right: 0;
+    .caret {
+      margin-bottom: 4px;
+    }
+  }
 }
 
 // Show / hide columns button

data/app/helpers/effective_datatables_helper.rb

@@ -36,6 +36,21 @@ module EffectiveDatatablesHelper
     end.to_json()
   end
 
+  def datatable_bulk_actions(datatable)
+    bulk_actions_column = datatable.table_columns.find { |_, options| options[:bulk_actions_column] }.try(:second)
+    return false unless bulk_actions_column
+
+    # This sets content_for(:effective_datatables_bulk_actions) as per the 3 bulk_action methods below
+    instance_exec(&bulk_actions_column[:dropdown_block]) if bulk_actions_column[:dropdown_block].respond_to?(:call)
+
+    {
+      dropdownHtml: render(
+        partial: bulk_actions_column[:dropdown_partial],
+        locals: HashWithIndifferentAccess.new(datatable: datatable).merge(bulk_actions_column[:partial_locals])
+      )
+    }.to_json()
+  end
+
   def datatable_header_filter(form, name, value, opts)
     return render(partial: opts[:header_partial], locals: {form: form, name: (opts[:label] || name), column: opts}) if opts[:header_partial].present?
 
@@ -81,6 +96,10 @@ module EffectiveDatatablesHelper
         group_method: opts[:filter][:group_method] || :last,
         input_html: { name: nil, value: value, autocomplete: 'off', data: {'column-name' => opts[:name], 'column-index' => opts[:index]} },
         input_js: { placeholder: (opts[:label] || name.titleize) }
+    when :bulk_actions_column
+      form.input name, label: false, required: false, value: nil,
+        as: :boolean,
+        input_html: { name: nil, value: nil, autocomplete: 'off', data: {'column-name' => opts[:name], 'column-index' => opts[:index], 'role' => 'bulk-actions-all'} }
     end
   end
 
@@ -97,4 +116,18 @@ module EffectiveDatatablesHelper
     attributes[:active_admin_path] rescue false
   end
 
+
+  ### Bulk Actions DSL Methods
+  def bulk_action(*args)
+    content_for(:effective_datatables_bulk_actions) { content_tag(:li, link_to(*args)) }
+  end
+
+  def bulk_action_divider
+    content_for(:effective_datatables_bulk_actions) { content_tag(:li, '', class: 'divider', role: 'separator') }
+  end
+
+  def bulk_action_content(&block)
+    content_for(:effective_datatables_bulk_actions) { block.call }
+  end
+
 end

data/app/models/effective/active_record_datatable_tool.rb

@@ -24,7 +24,7 @@ module Effective
       before = ''; after = ''
 
       if postgres?
-        after = " NULLS #{order_direction == 'DESC' ? 'FIRST' : 'LAST' }"
+        after = " NULLS LAST"
       elsif mysql?
         before = "ISNULL(#{column}), "
       end

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

@@ -54,6 +54,24 @@ module Effective
         table_column(name, opts, proc, &block)
       end
 
+      def bulk_actions_column(options = {}, proc = nil, &block)
+        name = options.fetch(:name, 'bulk_actions')
+        resource_method = options.fetch(:resource_method, :to_param)
+
+        opts = {
+          bulk_actions_column: true,
+          label: '',
+          partial_local: :resource,
+          partial: '/effective/datatables/bulk_actions_column',
+          partial_locals: { resource_method: resource_method },
+          sortable: false,
+          dropdown_partial: '/effective/datatables/bulk_actions_dropdown',
+          dropdown_block: block
+        }.merge(options)
+
+        table_column(name, opts, proc)
+      end
+
     end
   end
 end

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

@@ -68,6 +68,8 @@ module Effective
               end
             elsif has_manys.key?(name)
               :has_many
+            elsif cols[name][:bulk_actions_column]
+              :bulk_actions_column
             elsif name.include?('_address') && (collection_class.new rescue nil).respond_to?(:effective_addresses)
               :effective_address
             elsif name == 'id' || name.include?('year') || name.include?('_id')
@@ -195,6 +197,8 @@ module Effective
           {type: :datetime}
         when :date
           {type: :date}
+        when :bulk_actions_column
+          {type: :bulk_actions_column}
         else
           {type: :string}
         end.merge(filter.symbolize_keys)

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

@@ -63,7 +63,7 @@ module Effective
         rendered = {}
         (display_table_columns || table_columns).each do |name, opts|
           if opts[:partial] && opts[:visible]
-            locals = {
+            locals = HashWithIndifferentAccess.new(
               datatable: self,
               table_column: table_columns[name],
               controller_namespace: view.controller_path.split('/')[0...-1].map { |path| path.downcase.to_sym if path.present? }.compact,
@@ -71,7 +71,8 @@ module Effective
               edit_action: (opts[:partial_locals] || {})[:edit_action],
               destroy_action: (opts[:partial_locals] || {})[:destroy_action],
               unarchive_action: (opts[:partial_locals] || {})[:unarchive_action]
-            }
+            )
+
             locals.merge!(opts[:partial_locals]) if opts[:partial_locals]
 
             if active_record_collection?
@@ -119,6 +120,8 @@ module Effective
               (obj.send(name) rescue nil)
             elsif opts[:type] == :has_many
               (obj.send(name).to_a rescue [])
+            elsif opts[:type] == :bulk_actions_column
+              BLANK
             elsif opts[:type] == :obfuscated_id
               (obj.send(:to_param) rescue nil).to_s
             elsif opts[:type] == :effective_address

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

@@ -0,0 +1,2 @@
+- id = (resource.public_send(resource_method) rescue resource.object_id)
+= check_box_tag 'bulk_actions_resources[]', id, false, autocomplete: 'off', id: "bulk_actions_resource_#{id}", data: { role: 'bulk-actions-resource' }, onClick: 'event.stopPropagation();'

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

@@ -0,0 +1,10 @@
+.btn-group.buttons-bulk-actions
+  %button.btn.btn-default.dropdown-toggle{'type' => 'button', 'data-toggle' => 'dropdown', 'aria-haspopup' => true, 'aria-expanded' => false, 'disabled' => 'disabled'}
+    Bulk Actions
+    %span.caret
+  %ul.dropdown-menu
+    - if content_for?(:effective_datatables_bulk_actions)
+      = yield :effective_datatables_bulk_actions
+    - else
+      %li
+        %a{href: '#'} No bulk actions

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

@@ -4,6 +4,7 @@
     class: "#{datatable.table_html_class}",
     data: {
       'effective-form-inputs' => defined?(EffectiveFormInputs),
+      'bulk-actions' => datatable_bulk_actions(datatable),
       'columns' => datatable_columns(datatable),
       'input-js-options' => local_assigns[:input_js_options],
       'simple' => datatable.simple?.to_s,

data/lib/effective_datatables/version.rb

@@ -1,3 +1,3 @@
 module EffectiveDatatables
-  VERSION = '2.2.11'.freeze
+  VERSION = '2.3.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_datatables
 version: !ruby/object:Gem::Version
-  version: 2.2.11
+  version: 2.3.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-29 00:00:00.000000000 Z
+date: 2016-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -120,7 +120,8 @@ files:
 - app/assets/javascripts/dataTables/responsive/dataTables.responsive.min.js
 - app/assets/javascripts/dataTables/responsive/responsive.bootstrap.min.js
 - app/assets/javascripts/effective_datatables.js
-- app/assets/javascripts/effective_datatables/initialize.js.coffee.erb
+- app/assets/javascripts/effective_datatables/bulk_actions.js.coffee
+- app/assets/javascripts/effective_datatables/initialize.js.coffee
 - app/assets/javascripts/vendor/jquery.debounce.min.js
 - app/assets/javascripts/vendor/jszip.min.js
 - app/assets/stylesheets/dataTables/buttons/buttons.bootstrap.min.css
@@ -144,6 +145,8 @@ files:
 - app/models/effective/effective_datatable/options.rb
 - app/models/effective/effective_datatable/rendering.rb
 - app/views/effective/datatables/_actions_column.html.haml
+- app/views/effective/datatables/_bulk_actions_column.html.haml
+- app/views/effective/datatables/_bulk_actions_dropdown.html.haml
 - app/views/effective/datatables/_datatable.html.haml
 - app/views/effective/datatables/_spacer_template.html
 - config/routes.rb