effective_datatables 2.12.2 → 3.0.0

data/app/assets/javascripts/effective_datatables.js

@@ -1,6 +1,5 @@
 //= require vendor/jquery.delayedChange
 //= require vendor/jquery.fileDownload
-//= require dataTables/jszip/jszip
 
 //= require dataTables/jquery.dataTables
 //= require dataTables/dataTables.bootstrap
@@ -10,14 +9,14 @@
 //= require dataTables/buttons/buttons.colVis
 //= require dataTables/buttons/buttons.html5
 //= require dataTables/buttons/buttons.print
-//= require dataTables/colreorder/dataTables.colReorder
 //= require dataTables/responsive/dataTables.responsive
 //= require dataTables/responsive/responsive.bootstrap
 
 //= require effective_datatables/bulk_actions
 //= require effective_datatables/events
+//= require effective_datatables/filters
+//= require effective_datatables/reset
 //= require effective_datatables/responsive
-//= require effective_datatables/scopes
 
 //= require effective_datatables/charts
 //= require effective_datatables/initialize

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

@@ -11,3 +11,10 @@ $(document).on 'column-visibility.dt', (event, settings, index, state) ->
       $.event.trigger('page:change')
     , 700)
   )
+
+# Remove empty label (bulk actions) from ColVis dropdown
+$(document).on 'click.dtb-collection', (event) ->
+  $colvis = $('.dt-button-collection:not(.initialized)')
+  return if $colvis.length == 0
+
+  $colvis.addClass('initialized').find('li > a:empty').each -> $(this).parent().remove()

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

@@ -0,0 +1,6 @@
+$(document).on 'click', 'a[data-apply-datatable-filters]', (event) ->
+  event.preventDefault()
+  $form = $(event.currentTarget).closest('.effective-datatable-filters')
+  $table = $('#' + $form.attr('aria-controls'))
+  $table.DataTable().draw()
+

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

@@ -16,7 +16,7 @@ initializeDataTables = ->
       buttons: [
         {
           extend: 'colvis',
-          text: 'Show / hide columns',
+          text: 'Show / Hide',
           postfixButtons: [
             { extend: 'colvisGroup', text: 'Show all', show: ':hidden'},
             { extend: 'colvisRestore', text: 'Show default'}
@@ -26,52 +26,57 @@ initializeDataTables = ->
           extend: 'copy',
           exportOptions:
             format:
-              header: (str) -> $("<div>#{str}</div>").children('.filter-label').first().text()
+              header: (str) -> $("<div>#{str}</div>").children('.search-label').first().text()
             columns: buttons_export_columns
         },
         {
           extend: 'csv',
           exportOptions:
             format:
-              header: (str) -> $("<div>#{str}</div>").children('.filter-label').first().text()
-            columns: buttons_export_columns
-        },
-        {
-          extend: 'excel',
-          exportOptions:
-            format:
-              header: (str) -> $("<div>#{str}</div>").children('.filter-label').first().text()
+              header: (str) -> $("<div>#{str}</div>").children('.search-label').first().text()
             columns: buttons_export_columns
         },
         {
           extend: 'print',
           exportOptions:
             format:
-              header: (str) -> $("<div>#{str}</div>").children('.filter-label').first().text()
+              header: (str) -> $("<div>#{str}</div>").children('.search-label').first().text()
             columns: ':visible:not(.col-actions)'
         },
       ]
-      colReorder: !simple
       columns: datatable.data('columns')
       deferLoading: [datatable.data('display-records'), datatable.data('total-records')]
       deferRender: true
+      displayStart: datatable.data('display-start')
       dom: "<'row'<'col-sm-4'l><'col-sm-8'B>><'row'<'col-sm-12'tr>><'row'<'col-sm-6'i><'col-sm-6'p>>"
-      iDisplayLength: datatable.data('display-entries')
+      iDisplayLength: datatable.data('display-length')
       language: { 'lengthMenu': 'Show _MENU_ per page'}
-      lengthMenu: [[10, 25, 50, 100, 250, 1000, -1], ['10', '25', '50', '100', '250', '1000', 'All']]
-      order: datatable.data('default-order')
+      lengthMenu: [[10, 25, 50, 100, 250, 1000, 9999999], ['10', '25', '50', '100', '250', '1000', 'All']]
+      order: datatable.data('display-order')
       processing: true
       responsive: true
       serverParams: (params) ->
-        table = this.api()
-        table.columns().flatten().each (index) =>
-          params['columns'][index]['visible'] = table.column(index).visible()
+        api = this.api()
+        api.columns().flatten().each (index) => params['columns'][index]['visible'] = api.column(index).visible()
+
+        $table = $(api.table().node())
+        $form = $(".effective-datatable-filters[aria-controls='#{$table.attr('id')}']").first()
+
+        if $form.length > 0
+          params['scope'] = $form.find("input[id^='filters_scope']:checked").val() || ''
+          params['filter'] = {}
+
+          $form.find("[id^='filters_']:not(input[id^='filters_scope'])").each ->
+            $input = $(this)
+            params['filter'][$input.attr('id').substring(8, $input.attr('id').length)] = $input.val()
+
       serverSide: true
       scrollCollapse: true
       pagingType: 'simple_numbers'
       initComplete: (settings) ->
+        initializeReset(this.api())
         initializeBulkActions(this.api())
-        initializeFilters(this.api())
+        initializeSearch(this.api())
       drawCallback: (settings) ->
         $table = $(this.api().table().node())
 
@@ -87,11 +92,15 @@ initializeDataTables = ->
     # 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'])
+      if $table.data('bulk-actions')
+        $table.closest('.dataTables_wrapper').children().first().find('.dt-buttons').prepend($table.data('bulk-actions'))
+
+    initializeReset = (api) ->
+      $table = $(api.table().node())
+
+      if $table.data('reset')
+        $table.closest('.dataTables_wrapper').children().first().find('.dt-buttons').prepend($table.data('reset'))
 
     # After we perform a bulk action, we have to re-select the checkboxes manually and do a bit of house keeping
     drawBulkActions = ($table) ->
@@ -125,21 +134,21 @@ initializeDataTables = ->
             chart = new google.visualization[data['type']](obj)
             chart.draw(google.visualization.arrayToDataTable(data['data']), data['options'])
 
-    # Appends the filter html, stored in the column definitions, into each column header
-    initializeFilters = (api) ->
+    # Appends the search html, stored in the column definitions, into each column header
+    initializeSearch = (api) ->
       api.columns().flatten().each (index) =>
         $th = $(api.column(index).header())
         settings = api.settings()[0].aoColumns[index] # column specific settings
 
-        if settings.filterSelectedValue  # Assign preselected filter values
-          api.settings()[0].aoPreSearchCols[index].sSearch = settings.filterSelectedValue
+        if settings.search && ('' + settings.search).length > 0 # Assign preselected values
+          api.settings()[0].aoPreSearchCols[index].sSearch = settings.search
 
-        if settings.filterHtml  # Append the html filter HTML and initialize input events
-          $th.append('<br>' + settings.filterHtml)
-          initializeFilterEvents($th)
+        if settings.searchHtml  # Append the search html and initialize input events
+          $th.append('<br>' + settings.searchHtml)
+          initializeSearchEvents($th)
 
     # Sets up the proper events for each input
-    initializeFilterEvents = ($th) ->
+    initializeSearchEvents = ($th) ->
       $th.find('input,select').each (_, input) ->
         $input = $(input)
 
@@ -169,23 +178,17 @@ initializeDataTables = ->
 
     # Apply EffectiveFormInputs to the Show x per page dropdown
     if datatable.data('effective-form-inputs')
-      try table.closest('.dataTables_wrapper').find('.dataTables_length select').select2()
+      try table.closest('.dataTables_wrapper').find('.dataTables_length select').removeAttr('name').select2()
 
 destroyDataTables = ->
   $('table.effective-datatable').each ->
     if $.fn.DataTable.fnIsDataTable(this)
       $(this).DataTable().destroy()
 
-anotherDestroy = ->
-  for settings in $.fn.dataTable.settings
-    $(settings.nTableWrapper).unbind('.DT').find(':not(tbody *)').unbind('.DT')
-    $(window).unbind('.DT-'+settings.sInstance)
-
-  $.fn.dataTable.settings.length = 0
-
 $ -> initializeDataTables()
 $(document).on 'page:change', -> initializeDataTables()
 $(document).on 'turbolinks:load', -> initializeDataTables()
+$(document).on 'turbolinks:render', -> initializeDataTables()
 $(document).on 'turbolinks:before-cache', -> destroyDataTables()
 
 

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

@@ -0,0 +1,7 @@
+$(document).on 'click', 'a.buttons-reset-cookie', (event) ->
+  event.preventDefault()
+
+  $obj = $(event.currentTarget)
+  $obj.find('span').text('Resetting...')
+  document.cookie = "#{$obj.data('cookie-name')}=; expires=Thu, 01-Jan-70 00:00:01 GMT; path=/"
+  location.reload()

data/app/assets/javascripts/vendor/jquery.delayedChange.js

@@ -33,6 +33,6 @@
     onChange: function(element) { }
   }
 
-  $.fn.delayedChange.oldVal = '';
+  $.fn.delayedChange.oldVal = 'NO_DELAYED_CHANGE_VALUE';
 
 })(jQuery);

data/app/assets/stylesheets/dataTables/dataTables.bootstrap.css

@@ -8,7 +8,6 @@ table.dataTable {
 table.dataTable td,
 table.dataTable th {
   -webkit-box-sizing: content-box;
-  -moz-box-sizing: content-box;
   box-sizing: content-box;
 }
 table.dataTable td.dataTables_empty,

data/app/assets/stylesheets/effective_datatables.scss

@@ -4,6 +4,5 @@
 @import 'dataTables/colReorder/colReorder.bootstrap';
 @import 'dataTables/responsive/responsive.bootstrap';
 
+@import 'effective_datatables/filters';
 @import 'effective_datatables/overrides';
-
-@import 'effective_datatables/scopes';

data/app/assets/stylesheets/effective_datatables/{_scopes.scss → _filters.scss}

@@ -1,4 +1,4 @@
-.effective-datatable-scopes {
+.effective-datatable-filters {
   .form-inline {
     .form-group { margin-right: 10px; }
     .control-label { margin-right: 10px; }

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

@@ -46,7 +46,7 @@ table.dataTable.sort-hidden thead .sorting_desc { background-image: none; }
 table.dataTable .form-group { width: 100%; margin-left: 0px; margin-right: 0px; }
 table.dataTable select { width: 100%; }
 table.dataTable .form-control { width: 100%;  }
-table.dataTable .form-group.datatable_filter_bulk_actions { margin-left: 4px; }
+table.dataTable .form-group.datatable_search_bulk_actions { margin-left: 4px; }
 
 // Processing popup
 div.dataTables_wrapper div.dataTables_processing {

data/app/controllers/effective/datatables_controller.rb

@@ -4,10 +4,7 @@ module Effective
 
     # This will respond to both a GET and a POST
     def show
-      attributes = (params[:attributes].presence || {}).merge(referer: request.referer)
-      scopes = (params[:scopes].presence || {})
-
-      @datatable = find_datatable(params[:id]).try(:new, attributes.merge(scopes))
+      @datatable = find_datatable(params[:id]).try(:new)
       @datatable.view = view_context if !@datatable.nil?
 
       EffectiveDatatables.authorized?(self, :index, @datatable.try(:collection_class))
@@ -28,6 +25,7 @@ module Effective
     private
 
     def find_datatable(id)
+      id = id.gsub('-', '/')
       id.classify.safe_constantize || id.classify.pluralize.safe_constantize
     end
 

data/app/helpers/effective_datatables_helper.rb

@@ -1,7 +1,7 @@
 # These are expected to be called by a developer.  They are part of the datatables DSL.
 module EffectiveDatatablesHelper
 
-  def render_datatable(datatable, input_js_options = nil)
+  def render_datatable(datatable, input_js: {}, charts: true, filters: true, simple: false)
     raise 'expected datatable to be present' unless datatable
 
     datatable.view ||= self
@@ -12,121 +12,86 @@ module EffectiveDatatablesHelper
       return content_tag(:p, "You are not authorized to view this datatable. (cannot :index, #{datatable.collection_class})")
     end
 
-    render partial: 'effective/datatables/datatable',
-      locals: { datatable: datatable, input_js_options: input_js_options.try(:to_json) }
-  end
+    charts = charts && datatable._charts.present?
+    filters = filters && (datatable._scopes.present? || datatable._filters.present?)
+
+    effective_datatable_params = {
+      id: datatable.to_param,
+      class: datatable.table_html_class,
+      data: {
+        'effective-form-inputs' => defined?(EffectiveFormInputs),
+        'bulk-actions' => datatable_bulk_actions(datatable),
+        'columns' => datatable_columns(datatable),
+        'display-length' => datatable.display_length,
+        'display-order' => [datatable.order_index, datatable.order_direction].to_json(),
+        'display-records' => datatable.to_json[:recordsFiltered],
+        'display-start' => datatable.display_start,
+        'input-js-options' => (input_js || {}).to_json,
+        'reset' => datatable_reset(datatable),
+        'simple' => datatable.simple?.to_s,
+        'source' => effective_datatables.datatable_path(datatable, {format: 'json'}),
+        'total-records' => datatable.to_json[:recordsTotal]
+      }
+    }
+
+    if (charts || filters) && !simple
+      output = ''.html_safe
+
+      if charts
+        datatable._charts.each { |name, _| output << render_datatable_chart(datatable, name) }
+      end
 
-  def render_simple_datatable(datatable, input_js_options = nil)
-    raise 'expected datatable to be present' unless datatable
+      if filters
+        output << render_datatable_filters(datatable)
+      end
 
-    datatable.view ||= self
-    datatable.simple = true
+      output << render(partial: 'effective/datatables/datatable',
+        locals: { datatable: datatable, effective_datatable_params: effective_datatable_params }
+      )
 
-    begin
-      EffectiveDatatables.authorized?(controller, :index, datatable.collection_class) || raise(Effective::AccessDenied)
-    rescue Effective::AccessDenied => e
-      return content_tag(:p, "You are not authorized to view this datatable. (cannot :index, #{datatable.collection_class})})")
-    end
+      output
+    else
+      datatable.attributes[:simple] = true if simple
 
-    render partial: 'effective/datatables/datatable',
-      locals: {datatable: datatable, input_js_options: input_js_options.try(:to_json) }
+      render(partial: 'effective/datatables/datatable',
+        locals: { datatable: datatable, effective_datatable_params: effective_datatable_params }
+      )
+    end
   end
 
-  def render_datatable_scopes(datatable)
+  def render_datatable_filters(datatable)
     raise 'expected datatable to be present' unless datatable
 
-    return unless datatable.scopes.present?
     datatable.view ||= self
+    return unless datatable._scopes.present? || datatable._filters.present?
+
+    if datatable._filters_form_required?
+      render partial: 'effective/datatables/filters', locals: { datatable: datatable }
+    else
+      render(partial: 'effective/datatables/filters', locals: { datatable: datatable }).gsub('<form', '<div').gsub('/form>', '/div>').html_safe
+    end
 
-    render partial: 'effective/datatables/scopes', locals: { datatable: datatable }
   end
 
   def render_datatable_charts(datatable)
     raise 'expected datatable to be present' unless datatable
 
-    return unless datatable.charts.present?
     datatable.view ||= self
+    return unless datatable._charts.present?
 
-    datatable.charts.map { |name, _| render_datatable_chart(datatable, name) }.join.html_safe
+    datatable._charts.map { |name, _| render_datatable_chart(datatable, name) }.join.html_safe
   end
 
   def render_datatable_chart(datatable, name)
     raise 'expected datatable to be present' unless datatable
 
-    return unless datatable.charts.present?
-    return unless datatable.charts[name].present?
     datatable.view ||= self
+    return unless datatable._charts[name].present?
 
-    options = datatable.charts[name]
-    chart = datatable.to_json[:charts][name]
-
-    render partial: (options[:partial] || 'effective/datatables/chart'),
-      locals: { datatable: datatable, chart: chart }
-  end
-
-  def datatables_admin_path?
-    @datatables_admin_path ||= (
-      path = request.path.to_s.downcase.chomp('/') + '/'
-      referer = request.referer.to_s.downcase.chomp('/') + '/'
-      (attributes[:admin_path] || referer.include?('/admin/') || path.include?('/admin/')) rescue false
-    )
-  end
-
-  # TODO: Improve on this
-  def datatables_active_admin_path?
-    attributes[:active_admin_path] rescue false
-  end
-
-  ### Icon Helpers for actions_column or elsewhere
-  def show_icon_to(path, options = {})
-    glyphicon_to('eye-open', path, {title: 'Show'}.merge(options))
-  end
-
-  def edit_icon_to(path, options = {})
-    glyphicon_to('edit', path, {title: 'Edit'}.merge(options))
-  end
-
-  def destroy_icon_to(path, options = {})
-    defaults = {title: 'Destroy', data: {method: :delete, confirm: 'Delete this item?'}}
-    glyphicon_to('trash', path, defaults.merge(options))
-  end
+    chart = datatable._charts[name]
+    chart_data = datatable.to_json[:charts][name][:data]
 
-  def archive_icon_to(path, options = {})
-    defaults = {title: 'Archive', data: {method: :delete, confirm: 'Archive this item?'}}
-    glyphicon_to('trash', path, defaults.merge(options))
-  end
-
-  def unarchive_icon_to(path, options = {})
-    defaults = {title: 'Unarchive', data: {confirm: 'Unarchive this item?'}}
-    glyphicon_to('retweet', path, defaults.merge(options))
-  end
-
-  def settings_icon_to(path, options = {})
-    glyphicon_to('cog', path, {title: 'Settings'}.merge(options))
-  end
-
-  def ok_icon_to(path, options = {})
-    glyphicon_to('ok', path, {title: 'OK'}.merge(options))
-  end
-
-  def approve_icon_to(path, options = {})
-    glyphicon_to('ok', path, {title: 'Approve'}.merge(options))
-  end
-
-  def remove_icon_to(path, options = {})
-    glyphicon_to('remove', path, {title: 'Remove'}.merge(options))
-  end
-
-  def glyphicon_to(icon, path, options = {})
-    content_tag(:a, options.merge(href: path)) do
-      if icon.start_with?('glyphicon-')
-        content_tag(:span, '', class: "glyphicon #{icon}")
-      else
-        content_tag(:span, '', class: "glyphicon glyphicon-#{icon}")
-      end
-    end
+    render partial: chart[:partial], locals: { datatable: datatable, chart: chart, chart_data: chart_data }
   end
-  alias_method :bootstrap_icon_to, :glyphicon_to
-  alias_method :glyph_icon_to, :glyphicon_to
 
 end