effective_datatables 4.29.0 → 4.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 533211d85df05ceea724f478a28537a9be1b1b4a18eb2e6fb3bec843236eaacb
-  data.tar.gz: b521d06e9fb1cbb97d28eb693b6632d6891163b1eecf7c56472ede6989231f0c
+  metadata.gz: 7663f0cd98b88923ef51722002f27d145f7baba83ac670d177ba0dd62a2301dc
+  data.tar.gz: 6dd269bd1b8912817a03748734cdd503114c399eebe850eb1df2fc71949ea54d
 SHA512:
-  metadata.gz: 709fd46784b74c1906c4dddb140c61453ddbf88057f3176ffb6872b26e2333977f48db5d28e2604bf8a96ba826749962e3d7ec4c6f0060fd927a7a8f23adedc4
-  data.tar.gz: '08d88ac7aa0ad5f93ca003c044aa6cdd8ae6f42ff10755aacad27a327b0334411f7c0e652b3fe58299666d34bc4d6ca04bf2eefa689653eea12336fcf8b9b5b4'
+  metadata.gz: 2c3f9d268f19b45c7163a425d8720c353d60c03631c0b430e84caa514a7b5705e9caba70ac69df0406f7259502faf953351661fad958c068bc7cd67d51b6e9a9
+  data.tar.gz: 7a87a66cca6ad5bf2c675ebfece0e3085e27a01f65810a80e9f185821fc36262cba335ff3c85c7c75c047d6c58c9de183866064f6f96911ddd3ed63058fca06a

data/README.md

@@ -43,6 +43,7 @@ Please check out [Effective Datatables 3.x](https://github.com/code-and-effect/e
     * [bulk_actions_col](#bulk_actions_col)
     * [actions_col](#actions_col)
     * [length](#length)
+    * [length_menu](#length_menu)
     * [order](#order)
     * [reorder](#reorder)
     * [aggregate](#aggregate)
@@ -228,7 +229,7 @@ class PostsDatatable < Effective::Datatable
   # The user's selected filters, search, sort, length, column visibility and pagination settings are saved between visits
   # on a per-table basis and can be Reset with a button
   datatable do
-    length 25  # 5, 10, 25, 50, 100, 500, :all
+    length 25  # 5, 10, 25, 50, 100, 500
     order :updated_at, :desc
 
     # Renders a column of checkboxes to select items for any bulk_actions
@@ -614,7 +615,7 @@ MyApp::UsersTable.new(namespace: :my_app)
 
 ## length
 
-Sets the default number of rows per page. Valid lengths are `5`, `10`, `25`, `50`, `100`, `250`, `500`, `:all`
+Sets the default number of rows per page.
 
 When not specified, effective_datatables uses the default as per the `config/initializers/effective_datatables.rb` or 25.
 
@@ -622,6 +623,18 @@ When not specified, effective_datatables uses the default as per the `config/ini
 length 100
 ```
 
+## length_menu
+
+You can specify the length menu values in `config/initializers/effective_datatables.rb` or per datatable.
+
+To override the default, add the method to your datatable
+
+```
+def length_menu
+  [5, 10, 25, 50]
+end
+```
+
 ## order
 
 Sets the default order of table rows. The first argument is the column, the second the direction.
@@ -1332,7 +1345,7 @@ class TimeEntriesPerClientReport < Effective::Datatable
   end
 
   datatable do
-    length :all
+    length 50
 
     col :client
 

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

@@ -53,7 +53,7 @@ initializeDataTables = (target) ->
       displayStart: datatable.data('display-start')
       iDisplayLength: datatable.data('display-length')
       language: datatable.data('language')
-      lengthMenu: [[5, 10, 25, 50, 100, 250, 500], ['5', '10', '25', '50', '100', '250', '500']]
+      lengthMenu: datatable.data('length-menu')
       order: datatable.data('display-order')
       processing: true
       responsive: true

data/app/helpers/effective_datatables_helper.rb

@@ -67,6 +67,7 @@ module EffectiveDatatablesHelper
         'display-start' => datatable.display_start,
         'inline' => inline.to_s,
         'language' => EffectiveDatatables.language(I18n.locale),
+        'length-menu' => datatable_length_menu(datatable),
         'options' => input_js.to_json,
         'reorder' => datatable.reorder?.to_s,
         'reorder-index' => (datatable.columns[:_reorder][:index] if datatable.reorder?).to_s,

data/app/helpers/effective_datatables_private_helper.rb

@@ -29,6 +29,18 @@ module EffectiveDatatablesPrivateHelper
     render('/effective/datatables/buttons', datatable: datatable, search: search).gsub("'", '"').html_safe
   end
 
+  def datatable_length_menu(datatable)
+    length_menu = datatable.length_menu
+
+    if length_menu.present? 
+      raise('expected datatable length_menu to be an Array of Integers') unless length_menu.kind_of?(Array) && length_menu.all? { |i| i.kind_of?(Integer) }
+    end
+    
+    length_menu ||= [5, 10, 25, 50, 100, 250, 500]
+
+    [length_menu.map(&:to_i), length_menu.map(&:to_s)]
+  end
+
   def datatable_new_resource_button(datatable, name, column)
     return unless datatable.inline? && (column[:actions][:new] != false)
 

data/app/models/effective/datatable.rb

@@ -211,6 +211,11 @@ module Effective
       Array(attributes[:class] || EffectiveDatatables.html_class).join(' ').presence
     end
 
+    # An array of integers [5, 10, 25, 50, 100, 250, 500]
+    def length_menu
+      EffectiveDatatables.length_menu
+    end
+
     def to_param
       "#{self.class.name.underscore.parameterize}-#{[self.class, attributes].hash.abs.to_s.last(12)}"
     end

data/config/effective_datatables.rb

@@ -21,8 +21,10 @@ EffectiveDatatables.setup do |config|
   # end
   config.authorization_method = Proc.new { |controller, action, resource| authorize!(action, resource) }
 
-  # Default number of entries shown per page
-  # Valid options are: 5, 10, 25, 50, 100, 250, 500, :all
+  # Display x per page options
+  config.length_menu = [5, 10, 25, 50, 100, 250, 500]
+
+  # Default number of entries shown per page. Must be in the length_menu.
   config.default_length = 25
 
   # Default class used on the <table> tag

data/lib/effective_datatables/version.rb

@@ -1,3 +1,3 @@
 module EffectiveDatatables
-  VERSION = '4.29.0'.freeze
+  VERSION = '4.30.0'.freeze
 end

data/lib/effective_datatables.rb

@@ -9,6 +9,8 @@ module EffectiveDatatables
   mattr_accessor :authorization_method
 
   mattr_accessor :default_length
+  mattr_accessor :length_menu
+
   mattr_accessor :html_class
   mattr_accessor :save_state
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_datatables
 version: !ruby/object:Gem::Version
-  version: 4.29.0
+  version: 4.30.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-12 00:00:00.000000000 Z
+date: 2024-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails