effective_datatables 4.9.4 → 4.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 768310a5434c778a3e11512125d661bc4ce443a277bb7e15581e50224b81c48f
-  data.tar.gz: 6b05137c54ef11ce9801b2e1fc48ee525641d2dd5507b7259e80c3387335404b
+  metadata.gz: 173cdec1d403c8203a7f3d3701104a76d7fd8fb04843c4989180b351b5096264
+  data.tar.gz: 70da4dcc029e6f7ac2a2f0d7f896734c4036eea227dfd5ecb6354f1efa59f531
 SHA512:
-  metadata.gz: edf03e2147e95afd515bc357ac5436dca96c0d3f1aa4fd36ac040bc1cc0885a1a34a0d6ff69897b61bafe8542b46447bc59adc96d42167fd4efc6b98cd65006b
-  data.tar.gz: 7027f034cee83b584d50290a34674295b3aca4d7b6cb0121ebd1dd052833ffdfaa0be50e26d493d736c8d8e7730aa89dc666b42c0e1219ba33c6ec495f9c01da
+  metadata.gz: 474ead17fcde2196a4bdf06cdfa02c9d23e1dc4345126d79bcdf4fa3aa9785a358cce6d54a062862f17ec33c618a908db703a1eaa94e847a87df42dfe738b816
+  data.tar.gz: 55570bbe0d91f0bcdb24d818368a3a4dce9be6ffc0d7a99327121d8204df62a56b6eecc61a1bbbb6bb89b1feff5e4ea6d293497bb571ffff640331f14076d8b2

data/README.md

@@ -46,6 +46,7 @@ Please check out [Effective Datatables 3.x](https://github.com/code-and-effect/e
     * [order](#order)
     * [reorder](#reorder)
     * [aggregate](#aggregate)
+    * [download](#download)
   * [filters](#filters)
     * [scope](#scope)
     * [filter](#filter)
@@ -681,6 +682,30 @@ end.aggregate { |values, column| distance_of_time_in_words(values.min, values.ma
 
 In the above example, `values` is an Array containing all row's values for one column at a time.
 
+## download
+
+Add a Download button which streams a CSV file containing all rows and columns in the table's collection, ignoring any search, sort or filtering.
+
+This is an opt-in feature.
+
+To enable, please set `config.download = true` in your `config/initializers/effective_datatables.rb` file.
+
+Once enabled, you can disable it on an individual table by:
+
+```ruby
+datatable do
+  download false
+end
+```
+
+and you can exclude individual columns from being rendered on the CSV export
+
+```ruby
+col :first_name, csv: false
+```
+
+The column will still appear in the export, but the contents will be blank.
+
 ## filters
 
 Creates a single form with fields for each `filter` and a single radio input field for all `scopes`.

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

@@ -0,0 +1,10 @@
+$(document).on 'click', '.dataTables_wrapper a.buttons-download', (event) ->
+  $button = $(event.currentTarget)
+  $table = $('#' + $button.attr('aria-controls'))
+
+  url = $table.data('source').replace('.json', '/download.csv')
+  attributes = 'attributes=' + encodeURIComponent($table.data('attributes'))
+
+  $button.attr('href', url + '?' + attributes)
+
+  setTimeout (=> $button.attr('href', 'download.csv')), 0

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

@@ -112,14 +112,8 @@ initializeDataTables = (target) ->
       $table = $(api.table().node())
       $buttons = $table.closest('.dataTables_wrapper').children().first().find('.dt-buttons')
 
-      if $table.data('reset')
-        $buttons.prepend($table.data('reset'))
-
-      if $table.data('reorder')
-        $buttons.prepend($table.data('reorder'))
-
-      if $table.data('bulk-actions')
-        $buttons.prepend($table.data('bulk-actions'))
+      if $table.data('buttons-html')
+        $buttons.prepend($table.data('buttons-html'))
 
     drawAggregates = ($table, aggregates) ->
       $tfoot = $table.find('tfoot').first()

data/app/controllers/effective/datatables_controller.rb

@@ -1,3 +1,5 @@
+require 'csv'
+
 module Effective
   class DatatablesController < ApplicationController
     skip_log_page_views quiet: true if defined?(EffectiveLogging)
@@ -20,6 +22,36 @@ module Effective
       end
     end
 
+    def download
+      @datatable = EffectiveDatatables.find(params[:id], params[:attributes])
+      @datatable.view = view_context
+
+      EffectiveDatatables.authorize!(self, :index, @datatable.collection_class)
+
+      respond_to do |format|
+        format.csv do
+          headers.delete('Content-Length')
+
+          headers['X-Accel-Buffering'] = 'no'
+          headers['Cache-Control'] = 'no-cache'
+          headers["Content-Type"] = @datatable.csv_content_type
+          headers["Content-Disposition"] = %(attachment; filename="#{@datatable.csv_filename}")
+          headers['Last-Modified'] = Time.zone.now.ctime.to_s
+
+          self.response_body = @datatable.csv_stream
+          response.status = 200
+        end
+
+        # format.csv do
+        #   send_data(@datatable.csv_file, filename: @datatable.csv_filename, type: @datatable.csv_content_type, disposition: 'attachment')
+        # end
+
+        format.all do
+          render(status: :unauthorized, body: 'Access Denied')
+        end
+      end
+    end
+
     def reorder
       begin
         @datatable = EffectiveDatatables.find(params[:id], params[:attributes])

data/app/helpers/effective_datatables_helper.rb

@@ -1,15 +1,21 @@
 # These are expected to be called by a developer.  They are part of the datatables DSL.
 module EffectiveDatatablesHelper
-  def render_datatable(datatable, input_js: {}, buttons: true, charts: true, entries: true, filters: true, inline: false, namespace: nil, pagination: true, search: true, simple: false, sort: true)
+  def render_datatable(datatable, input_js: {}, buttons: true, charts: true, download: nil, entries: true, filters: true, inline: false, namespace: nil, pagination: true, search: true, simple: false, sort: true)
     raise 'expected datatable to be present' unless datatable
     raise 'expected input_js to be a Hash' unless input_js.kind_of?(Hash)
 
+    if download.nil?
+      download = (buttons && EffectiveDatatables.download)
+    end
+
     if simple
-      buttons = charts = entries = filters = pagination = search = sort = false
+      buttons = charts = download = entries = filters = pagination = search = sort = false
     end
 
     datatable.attributes[:inline] = true if inline
     datatable.attributes[:sortable] = false unless sort
+    datatable.attributes[:searchable] = false unless search
+    datatable.attributes[:downloadable] = false unless download
     datatable.attributes[:namespace] = namespace if namespace
 
     datatable.view ||= self
@@ -44,7 +50,7 @@ module EffectiveDatatablesHelper
         'all-label' => I18n.t('effective_datatables.all'),
         'attributes' => EffectiveDatatables.encrypt(datatable.attributes),
         'authenticity-token' => form_authenticity_token,
-        'bulk-actions' => datatable_bulk_actions(datatable),
+        'buttons-html' => datatable_buttons(datatable),
         'columns' => datatable_columns(datatable),
         'default-visibility' => datatable.default_visibility.to_json,
         'display-length' => datatable.display_length,
@@ -54,8 +60,6 @@ module EffectiveDatatablesHelper
         'inline' => inline.to_s,
         'language' => EffectiveDatatables.language(I18n.locale),
         'options' => input_js.to_json,
-        'reset' => (datatable_reset(datatable) if search),
-        'reorder' => datatable_reorder(datatable),
         'reorder-index' => (datatable.columns[:_reorder][:index] if datatable.reorder?).to_s,
         'simple' => simple.to_s,
         'spinner' => icon('spinner'), # effective_bootstrap

data/app/helpers/effective_datatables_private_helper.rb

@@ -19,23 +19,12 @@ module EffectiveDatatablesPrivateHelper
     end.to_json.html_safe
   end
 
-  def datatable_bulk_actions(datatable)
-    if datatable._bulk_actions.present?
-      render(partial: '/effective/datatables/bulk_actions_dropdown', locals: { datatable: datatable }).gsub("'", '"').html_safe
-    end
-  end
-
   def datatable_display_order(datatable)
     ((datatable.sortable? && datatable.order_index) ? [datatable.order_index, datatable.order_direction] : false).to_json.html_safe
   end
 
-  def datatable_reset(datatable)
-    link_to(content_tag(:span, t('effective_datatables.reset')), '#', class: 'btn btn-link btn-sm buttons-reset-search')
-  end
-
-  def datatable_reorder(datatable)
-    return unless datatable.reorder? && EffectiveDatatables.authorized?(self, :update, datatable.collection_class)
-    link_to(content_tag(:span, t('effective_datatables.reorder')), '#', class: 'btn btn-link btn-sm buttons-reorder', disabled: true)
+  def datatable_buttons(datatable, search: true)
+    render('/effective/datatables/buttons', datatable: datatable, search: search).gsub("'", '"').html_safe
   end
 
   def datatable_new_resource_button(datatable, name, column)

data/app/models/effective/datatable.rb

@@ -30,6 +30,7 @@ module Effective
     include Effective::EffectiveDatatable::Collection
     include Effective::EffectiveDatatable::Compute
     include Effective::EffectiveDatatable::Cookie
+    include Effective::EffectiveDatatable::Csv
     include Effective::EffectiveDatatable::Format
     include Effective::EffectiveDatatable::Hooks
     include Effective::EffectiveDatatable::Params
@@ -140,6 +141,10 @@ module Effective
       to_json[:recordsTotal] == 0
     end
 
+    def to_csv
+      csv_file()
+    end
+
     def to_json
       @json ||= (
         {
@@ -167,6 +172,14 @@ module Effective
       !reorder? && attributes[:sortable] != false
     end
 
+    def searchable?
+      attributes[:searchable] != false
+    end
+
+    def downloadable?
+      attributes[:downloadable] != false
+    end
+
     # Whether the filters must be rendered as a <form> or we can keep the normal <div> behaviour
     def _filters_form_required?
       _form[:verb].present?

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

@@ -58,13 +58,14 @@ module Effective
         finalize(col)
       end
 
-      def arrayize(collection)
+      def arrayize(collection, csv: false)
         collection.map do |obj|
           columns.map do |name, opts|
-            if state[:visible][name] == false && (name != order_name)  # Sort by invisible array column
+            if state[:visible][name] == false && !csv && (name != order_name)  # Sort by invisible array column
+              BLANK
+            elsif csv && !opts[:csv]
               BLANK
             elsif opts[:compute]
-
               if array_collection?
                 dsl_tool.instance_exec(obj, obj[opts[:index]], &opts[:compute])
               else

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

@@ -0,0 +1,55 @@
+require 'csv'
+
+module Effective
+  module EffectiveDatatable
+    module Csv
+
+      def csv_filename
+        self.class.name.underscore.parameterize + '.csv'
+      end
+
+      def csv_content_type
+        'text/csv; charset=utf-8'
+      end
+
+      def csv_header
+        columns.map { |_, opts| opts[:label] || '' }
+      end
+
+      def csv_file
+        CSV.generate do |csv|
+          csv << csv_header()
+
+          collection.send(csv_collection_method) do |resources|
+            resources = arrayize(resources, csv: true)
+            format(resources, csv: true)
+            finalize(resources)
+
+            resources.each { |resource| csv << resource }
+          end
+        end
+      end
+
+      def csv_stream
+        EffectiveResources.with_resource_enumerator do |lines|
+          lines << CSV.generate_line(csv_header)
+
+          collection.public_send(csv_collection_method) do |resources|
+            resources = arrayize(resources, csv: true)
+            format(resources, csv: true)
+            finalize(resources)
+
+            resources.each { |resource| lines << CSV.generate_line(resource) }
+          end
+        end
+      end
+
+      private
+
+      def csv_collection_method
+        (active_record_collection? ? :find_in_batches : :to_a)
+      end
+
+    end
+  end
+end

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

@@ -24,11 +24,15 @@ module Effective
           reorder_col(name)
         end
 
+        def download(bool)
+          datatable.attributes[:downloadable] = bool
+        end
+
         # A col has its internal values sorted/searched before the block is run
         # Anything done in the block, is purely a format on the after sorted/ordered value
         # the original object == the computed value, which is yielded to the format block
         # You can't do compute with .col
-        def col(name, action: nil, as: nil, col_class: nil, label: nil, partial: nil, partial_as: nil, responsive: 10000, search: {}, sort: true, sql_column: nil, th: nil, th_append: nil, visible: true, &format)
+        def col(name, action: nil, as: nil, col_class: nil, csv: true, label: nil, partial: nil, partial_as: nil, responsive: 10000, search: {}, sort: true, sql_column: nil, th: nil, th_append: nil, visible: true, &format)
           raise 'You cannot use partial: ... with the block syntax' if partial && block_given?
 
           name = name.to_sym unless name.to_s.include?('.')
@@ -38,6 +42,7 @@ module Effective
             as: as,
             compute: nil,
             col_class: col_class,
+            csv: csv,
             format: (format if block_given?),
             index: nil,
             label: (label.nil? ? name.to_s.split('.').last.titleize : label),
@@ -56,7 +61,7 @@ module Effective
 
         # A val is a computed value that is then sorted/searched after the block is run
         # You can have another block by calling .format afterwards to work on the computed value itself
-        def val(name, action: nil, as: nil, col_class: nil, label: nil, partial: nil, partial_as: nil, responsive: 10000, search: {}, sort: true, sql_column: false, th: nil, th_append: nil, visible: true, &compute)
+        def val(name, action: nil, as: nil, col_class: nil, csv: true, label: nil, partial: nil, partial_as: nil, responsive: 10000, search: {}, sort: true, sql_column: false, th: nil, th_append: nil, visible: true, &compute)
           raise 'You cannot use partial: ... with the block syntax' if partial && block_given?
 
           name = name.to_sym unless name.to_s.include?('.')
@@ -66,6 +71,7 @@ module Effective
             as: as,
             compute: (compute if block_given?),
             col_class: col_class,
+            csv: csv,
             format: nil,
             index: nil,
             label: (label.nil? ? name.to_s.split('.').last.titleize : label),
@@ -91,6 +97,7 @@ module Effective
             compute: nil,
             btn_class: (btn_class || 'btn-sm btn-outline-primary'),
             col_class: col_class,
+            csv: false,
             format: (format if block_given?),
             index: nil,
             inline: (inline.nil? ? datatable.inline? : inline),
@@ -130,6 +137,7 @@ module Effective
             as: :bulk_actions,
             compute: nil,
             col_class: col_class,
+            csv: false,
             format: nil,
             index: nil,
             input_name: (input_name || 'bulk_actions_resources'),
@@ -157,6 +165,7 @@ module Effective
             as: :reorder,
             compute: nil,
             col_class: col_class,
+            csv: false,
             format: nil,
             index: nil,
             label: false,

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

@@ -8,14 +8,16 @@ module Effective
 
       private
 
-      def format(collection)
+      def format(collection, csv: false)
         # We want to use the render :collection for each column that renders partials
         rendered = {}
 
         columns.each do |name, opts|
-          next unless state[:visible][name]
-
-          if opts[:partial]
+          if state[:visible][name] == false && !csv
+            # Nothing to do
+          elsif csv && !opts[:csv]
+            # Nothing to do
+          elsif opts[:partial]
             locals = { datatable: self, column: opts }.merge!(resource_col_locals(opts))
 
             rendered[name] = (view.render(
@@ -26,6 +28,7 @@ module Effective
               locals: locals,
               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'
             locals = { datatable: self, column: opts, spacer_template: SPACER_TEMPLATE }
 
@@ -45,7 +48,6 @@ module Effective
             else
               (view.render_resource_actions(collection.map { |row| row[opts[:index]] }, atts, &opts[:format]) || '').split(SPACER)
             end
-
           end
         end
 
@@ -54,9 +56,11 @@ module Effective
             index = opts[:index]
             value = row[index]
 
-            row[index] = (
-              if state[:visible][name] == false
+            formatted = (
+              if state[:visible][name] == false && !csv
                 NONVISIBLE
+              elsif csv && !opts[:csv]
+                BLANK
               elsif opts[:as] == :actions
                 rendered[name][row_index]
               elsif opts[:format] && rendered.key?(name)
@@ -66,14 +70,23 @@ module Effective
               elsif opts[:partial]
                 rendered[name][row_index]
               else
-                format_column(value, opts)
+                format_column(value, opts, csv: csv)
               end
             )
+
+            if csv && (opts[:format] || opts[:partial])
+              formatted = view.strip_tags(formatted)
+
+              formatted.gsub!("\n\n", ' ') unless formatted.frozen?
+              formatted.gsub!("\n", '')  unless formatted.frozen?
+            end
+
+            row[index] = formatted
           end
         end
       end
 
-      def format_column(value, column)
+      def format_column(value, column, csv: false)
         return if value.nil? || (column[:resource] && value.blank?)
 
         unless column[:as] == :email
@@ -90,7 +103,11 @@ module Effective
         when :date
           value.respond_to?(:strftime) ? value.strftime(EffectiveDatatables.format_date) : BLANK
         when :datetime
-          value.respond_to?(:strftime) ? value.strftime(EffectiveDatatables.format_datetime) : BLANK
+          if csv
+            value
+          else
+            value.respond_to?(:strftime) ? value.strftime(EffectiveDatatables.format_datetime) : BLANK
+          end
         when :decimal
           value
         when :duration
@@ -102,7 +119,7 @@ module Effective
         when :effective_roles
           value.join(', ')
         when :email
-          view.mail_to(value)
+          csv ? value : view.mail_to(value)
         when :integer
           value
         when :percent

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

@@ -0,0 +1,14 @@
+- if datatable._bulk_actions.present?
+  = render('/effective/datatables/bulk_actions_dropdown', datatable: datatable)
+
+- if datatable.searchable?
+  = link_to '#', class: 'btn btn-link btn-sm buttons-reset-search' do
+    %span= t('effective_datatables.reset')
+
+- if datatable.reorder? && EffectiveDatatables.authorized?(self, :update, datatable.collection_class)
+  = link_to '#', class: 'btn btn-link btn-sm buttons-reorder' do
+    %span= t('effective_datatables.reorder')
+
+- if datatable.downloadable?
+  = link_to 'download.csv', class: 'btn btn-link btn-sm buttons-download', 'aria-controls': datatable.to_param do
+    %span= t('effective_datatables.download')

data/config/effective_datatables.rb

@@ -43,4 +43,7 @@ EffectiveDatatables.setup do |config|
   config.format_datetime = '%F %H:%M'
   config.format_date = '%F'
   config.format_time = '%H:%M'
+
+  # Enable the Download button which serves a CSV of your collection
+  config.download = false
 end

data/config/locales/en.yml

@@ -2,6 +2,7 @@
 en:
   effective_datatables:
     apply: Apply
+    download: Download
     reset: Reset
     reorder: Reorder
     new: New

data/config/locales/es.yml

@@ -2,6 +2,7 @@
 es:
   effective_datatables:
     apply: Filtrar
+    download: Download
     reset: Reiniciar
     reorder: Reordenar
     new: Nuevo

data/config/locales/nl.yml

@@ -2,6 +2,7 @@
 nl:
   effective_datatables:
     apply: Toepassen
+    download: Download
     reset: Reset
     reorder: Opnieuw ordenen
     new: Nieuwe

data/config/routes.rb

@@ -2,6 +2,7 @@ EffectiveDatatables::Engine.routes.draw do
   scope :module => 'effective' do
     match 'datatables/:id(.:format)', to: 'datatables#show', via: [:get, :post], as: :datatable
     match 'datatables/:id/reorder(.:format)', to: 'datatables#reorder', via: [:post], as: :reorder_datatable
+    match 'datatables/:id/download(.:format)', to: 'datatables#download', via: :get, as: :download_datatable
   end
 end
 

data/lib/effective_datatables/version.rb

@@ -1,3 +1,3 @@
 module EffectiveDatatables
-  VERSION = '4.9.4'.freeze
+  VERSION = '4.10.0'.freeze
 end

data/lib/effective_datatables.rb

@@ -21,6 +21,7 @@ module EffectiveDatatables
   mattr_accessor :format_time
 
   mattr_accessor :debug
+  mattr_accessor :download
 
   alias_method :max_cookie_size, :cookie_max_size
   alias_method :max_cookie_size=, :cookie_max_size=

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_datatables
 version: !ruby/object:Gem::Version
-  version: 4.9.4
+  version: 4.10.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-23 00:00:00.000000000 Z
+date: 2021-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -111,6 +111,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/download.js.coffee
 - app/assets/javascripts/effective_datatables/events.js.coffee
 - app/assets/javascripts/effective_datatables/filters.js.coffee
 - app/assets/javascripts/effective_datatables/flash.js.coffee
@@ -141,6 +142,7 @@ files:
 - app/models/effective/effective_datatable/collection.rb
 - app/models/effective/effective_datatable/compute.rb
 - app/models/effective/effective_datatable/cookie.rb
+- app/models/effective/effective_datatable/csv.rb
 - app/models/effective/effective_datatable/dsl.rb
 - app/models/effective/effective_datatable/dsl/bulk_actions.rb
 - app/models/effective/effective_datatable/dsl/charts.rb
@@ -154,6 +156,7 @@ files:
 - app/views/effective/datatables/_active_storage_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/_buttons.html.haml
 - app/views/effective/datatables/_chart.html.haml
 - app/views/effective/datatables/_datatable.html.haml
 - app/views/effective/datatables/_filters.html.haml