effective_datatables 4.15.2 → 4.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 912f48109a916890adbbad18c1058045d815203f13bd130d5f152cd7fb831dcb
-  data.tar.gz: 1e1438c39beed755b3c1d095d35568fa292c59680e1e60b1c79e775f88205419
+  metadata.gz: fb919d816894dbb8f980d70f0bcbe66706476bca2ceaa59c5a149b4c7342f23a
+  data.tar.gz: 0bf163d43e1ec174f76adedc190565f540a8191f33b5fa554093bf8a1be3398f
 SHA512:
-  metadata.gz: 7720dd73963000639ee65ef9113182491ff8c485d19a6ce7e214b1af45efdca91ff9ff303e2c90450d0935543cdebe780ae5e441f69f1b7482e0355ddbf0da33
-  data.tar.gz: 031335f7c000193c45caeff8d362267277ea0f19ded4e117eb7c00aee6ccfdbed31671d63c8f41648cfcf9d6b98719d7b90774d3d806fdfa10ce0d0a9fff0aee
+  metadata.gz: 8e847cb1063625374e346dea0b30e4c8b6416d2a73c0e7dcd330b27d4b4e8d61af9f8409565abedbdcf5185ea0d96fef6638a82c1c4f7c9c139020e10f6f2d1a
+  data.tar.gz: bb80cdb66df0055384d9c1021118590bd2c787c8fbf499fe7e5316b6c124a5d402c9f88196a2cb585a58f4dfac48f28df8f0ce052fdf31b829cff4c12461fbad

data/README.md

@@ -50,6 +50,7 @@ Please check out [Effective Datatables 3.x](https://github.com/code-and-effect/e
   * [filters](#filters)
     * [scope](#scope)
     * [filter](#filter)
+    * [filter_date_range](#filter_date_range)
   * [bulk_actions](#bulk_actions)
     * [bulk_action](#bulk_action)
     * [bulk_action](#bulk_action_divider)
@@ -791,6 +792,24 @@ required: true|false            # Passed to form
 
 Any other option given will be yielded to EffectiveBootstrap as options.
 
+## filter_date_range
+
+There is also a special date range filter built in. To use:
+
+```ruby
+filters do
+  filter_date_range
+end
+
+collection do
+  Things.where(updated_at: date_range)
+end
+```
+
+This method creates 3 filters, `filters[:date_range]`, `filters[:start_date]` and `filters[:end_date]` and presents a rough Prev/Next month and year navigation. Do not have any columns named the same as these.
+
+You can pass a default into `filter_date_range`, one of `:current_month`, `:current_year`, `:month`, `:year` and `:custom`.
+
 ## bulk_actions
 
 Creates a single dropdown menu with a link to each action, download or content.

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

@@ -70,7 +70,7 @@ initializeDataTables = (target) ->
           params['scope'] = $form.find("input[name='filters[scope]']:checked").val() || ''
           params['filter'] = {}
 
-          $form.find("select,textarea,input:not([type=submit])").each ->
+          $form.find("select,textarea,input:enabled:not([type=submit])").each ->
             $input = $(this)
 
             if ['utf8', 'authenticity_token', 'filters[scope]'].includes($input.attr('name'))

data/app/helpers/effective_datatables_private_helper.rb

@@ -128,14 +128,16 @@ module EffectiveDatatablesPrivateHelper
     return unless datatable._scopes.present? || datatable._filters.present?
 
     if datatable._filters_form_required?
-      render partial: 'effective/datatables/filters', locals: { datatable: datatable }
+      render('effective/datatables/filters', datatable: datatable)
     else
-      render(partial: 'effective/datatables/filters', locals: { datatable: datatable }).gsub('<form', '<div').gsub('/form>', '/div>').html_safe
+      render('effective/datatables/filters', datatable: datatable).gsub('<form', '<div').gsub('/form>', '/div>').html_safe
     end
 
   end
 
   def datatable_filter_tag(form, datatable, name, opts)
+    return if opts[:visible] == false
+
     as = opts[:as].to_s.chomp('_field').to_sym
     value = datatable.state[:filter][name]
     collection = opts[:collection]

data/app/models/effective/datatable.rb

@@ -199,6 +199,33 @@ module Effective
       "#{self.class.name.underscore.parameterize}-#{[self.class, attributes].hash.abs.to_s.last(12)}"
     end
 
+    def date_range(value = nil)
+      now = Time.zone.now
+
+      value ||= filters[:date_range]
+      start_date ||= filters[:start_date]
+      end_date ||= filters[:end_date]
+
+      return (nil..nil) if value.blank?
+
+      case value.to_sym
+      when :current_month
+        (now.beginning_of_month..now.end_of_day)
+      when :current_year
+        (now.beginning_of_year..now.end_of_day)
+      when :month
+        (start_date || now).all_month
+      when :year
+        (start_date || now).all_year
+      when :custom
+        (start_date&.beginning_of_day..end_date&.end_of_day)
+      when :all
+        (nil..nil)
+      else
+        raise('unexpected date range value')
+      end
+    end
+
     def columns
       @_columns
     end
@@ -223,6 +250,10 @@ module Effective
       columns.values.inject({}) { |h, col| h[col[:index]] = col[:visible]; h }
     end
 
+    def filters_form
+      DatatableFiltersForm.new(datatable: self)
+    end
+
     private
 
     def column_tool

data/app/models/effective/datatable_filters_form.rb

@@ -0,0 +1,21 @@
+# Form Object for the filters form
+
+module Effective
+  class DatatableFiltersForm
+    include ActiveModel::Model
+
+    attr_accessor :scope
+
+    def initialize(datatable:)
+      # Assign the current value of scope
+      assign_attributes(scope: datatable.state[:scope])
+
+      # Create an attr_accesor for each filter and assign value
+      datatable._filters.each do |name, options|
+        self.class.send(:attr_accessor, name)
+        assign_attributes(name => datatable.state[:filter][name])
+      end
+    end
+
+  end
+end

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

@@ -4,6 +4,29 @@ module Effective
   module EffectiveDatatable
     module Dsl
       module Filters
+
+        DATE_RANGES = [
+          ['Current Month', :current_month],
+          ['Current Year', :current_year],
+          ['Month', :month],
+          ['Year', :year],
+          ['Custom', :custom]
+        ]
+
+        # This sets up the select field with start_on and end_on
+        def filter_date_range(default = nil)
+          if default.present?
+            valid = DATE_RANGES.map(&:last)
+            raise("unexpected value #{default}. Try one of #{valid.to_sentence}") unless valid.include?(default)
+          end
+
+          date_range = datatable.date_range(default)
+
+          filter :date_range, default, collection: DATE_RANGES, partial: 'effective/datatables/filter_date_range'
+          filter :start_date, date_range&.begin, as: :date, visible: false
+          filter :end_date, date_range&.end, as: :date, visible: false
+        end
+
         def filter(name = nil, value = :_no_value, as: nil, label: nil, parse: nil, required: false, **input_html)
           return datatable.filter if (name == nil && value == :_no_value) # This lets block methods call 'filter' and get the values
 

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

@@ -0,0 +1,51 @@
+- name = '' unless datatable._filters_form_required?
+- now = Time.zone.now.beginning_of_day
+
+= f.select :date_range, opts[:collection], autocomplete: 'off', feedback: false, placeholder: 'All available dates'
+
+.mx-2
+
+- start_date = (f.object.start_date || now)
+- end_date = (f.object.end_date || now)
+
+- raise('expected a date start_date') unless start_date.respond_to?(:strftime)
+- raise('expected a date end_date') unless end_date.respond_to?(:strftime)
+
+- path = effective_datatables.datatable_path(datatable)
+
+- prev_month = (start_date - 1.month).beginning_of_month
+- next_month = (start_date + 1.month).beginning_of_month
+- prev_year = (start_date - 1.year).beginning_of_year
+- next_year = (start_date + 1.year).beginning_of_year
+
+- prev_month_path = effective_datatables.datatable_path(datatable, date_range: :month, start_date: prev_month.strftime('%F'), end_date: prev_month.end_of_month.strftime('%F'))
+- next_month_path = effective_datatables.datatable_path(datatable, date_range: :month, start_date: next_month.strftime('%F'), end_date: next_month.end_of_month.strftime('%F'))
+- prev_year_path = effective_datatables.datatable_path(datatable, date_range: :year, start_date: prev_year.strftime('%F'), end_date: prev_year.end_of_year.strftime('%F'))
+- next_year_path = effective_datatables.datatable_path(datatable, date_range: :year, start_date: next_year.strftime('%F'), end_date: next_year.end_of_month.strftime('%F'))
+
+= f.show_if :date_range, :current_month do
+  = f.static_field :month do
+    #{now.beginning_of_month.strftime('%F')} to #{now.strftime('%F')} (today)
+
+= f.show_if :date_range, :current_year do
+  = f.static_field :year do
+    #{now.beginning_of_year.strftime('%F')} to #{now.strftime('%F')} (today)
+
+= f.show_if :date_range, :month do
+  = f.static_field :month do
+    = link_to((prev_month.strftime('%b %Y') + ' ' + icon('arrow-left-circle')).html_safe, prev_month_path.sub(path, request.path))
+    #{start_date.beginning_of_month.strftime('%F')} to #{start_date.end_of_month.strftime('%F')}
+    = link_to((icon('arrow-right-circle') + ' ' + next_month.strftime('%b %Y')).html_safe, next_month_path.sub(path, request.path))
+
+= f.show_if :date_range, :year do
+  = f.static_field :year do
+    = link_to((prev_year.strftime('%Y') + ' ' + icon('arrow-left-circle')).html_safe, prev_year_path.sub(path, request.path))
+    #{start_date.beginning_of_year.strftime('%F')} to #{start_date.end_of_year.strftime('%F')}
+    = link_to((icon('arrow-right-circle') + ' ' + next_year.strftime('%Y')).html_safe, next_year_path.sub(path, request.path))
+
+= f.show_if :date_range, :custom do
+  .row
+    .col
+      = f.date_field :start_date, name: name, autocomplete: 'off', feedback: false
+    .col
+      = f.date_field :end_date, name: name, autocomplete: 'off', feedback: false

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

@@ -1,11 +1,15 @@
 .effective-datatables-filters{'aria-controls': datatable.to_param}
-  = effective_form_with(scope: :filters, url: (datatable._form[:url] || '#'), method: datatable._form[:verb], id: nil) do |form|
+
+  = effective_form_with(model: datatable.filters_form, scope: :filters, url: (datatable._form[:url] || '#'), method: datatable._form[:verb], id: nil) do |form|
     .form-row.align-items-center
       - if datatable._scopes.present?
         = datatable_scope_tag(form, datatable)
 
       - datatable._filters.each do |name, opts|
-        = datatable_filter_tag(form, datatable, name, opts)
+        - if opts[:partial].present?
+          = render(opts[:partial], form: form, f: form, datatable: datatable, name: name, opts: opts)
+        - else
+          = datatable_filter_tag(form, datatable, name, opts)
 
       .form-group.col-auto
         - if datatable._filters_form_required?

data/lib/effective_datatables/version.rb

@@ -1,3 +1,3 @@
 module EffectiveDatatables
-  VERSION = '4.15.2'.freeze
+  VERSION = '4.16.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_datatables
 version: !ruby/object:Gem::Version
-  version: 4.15.2
+  version: 4.16.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-02 00:00:00.000000000 Z
+date: 2023-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -137,6 +137,7 @@ files:
 - app/models/effective/datatable_column.rb
 - app/models/effective/datatable_column_tool.rb
 - app/models/effective/datatable_dsl_tool.rb
+- app/models/effective/datatable_filters_form.rb
 - app/models/effective/datatable_value_tool.rb
 - app/models/effective/effective_datatable/attributes.rb
 - app/models/effective/effective_datatable/collection.rb
@@ -159,6 +160,7 @@ files:
 - 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/_filter_date_range.html.haml
 - app/views/effective/datatables/_filters.html.haml
 - app/views/effective/datatables/_reorder_column.html.haml
 - app/views/effective/datatables/_resource_column.html.haml