Create a partial for dynamic filters (#347)

* Create a partial for dynamic filters
* Remove "add_html_classes" method
* Update the datagrid_filter_input select method
* Remove obsolete dynamic_filter_select method
* Deprecate the select_options method
* Use the select_choices method instead of select_options

Author: CharlieWinkwaves

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [2.0.10]
+
+* Added a partial for the dynamic filter
+* The `datagrid_filter_input` method now accepts options for the select input
+* Rename the `select_options` method to `select_choices`
+
 ## [2.0.9]
 
 * Use new Rails 7.1 `locals` notation in ERB partials

app/views/datagrid/_dynamic_filter.html.erb

@@ -0,0 +1,19 @@
+<%# locals: (filter:, form:, field_options:, operation_options:, value_options:) -%>
+
+<%= form.datagrid_filter_input(
+      filter,
+      **field_options,
+      class: [*field_options[:class], "datagrid-dynamic-field"]
+    ) %>
+
+<%= form.datagrid_filter_input(
+      filter,
+      **operation_options,
+      class: [*operation_options[:class], "datagrid-dynamic-operation"]
+    ) %>
+
+<%= form.datagrid_filter_input(
+      filter,
+      **value_options,
+      class: [*value_options[:class], "datagrid-dynamic-value"]
+    ) %>

lib/datagrid/filters.rb

@@ -328,9 +328,15 @@ def filter_by(*filters)
       apply_filters(scope, filters.map { |f| filter_by_name(f) })
     end
 
+    # @!visibility private
+    def select_options(filter)
+      warn "[DEPRECATION] `select_options` is deprecated. Please use `select_choices` instead."
+      select_choices(filter)
+    end
+
     # @return [Array] the select options for the filter
     # @raise [ArgumentError] if the filter doesn't support select options
-    def select_options(filter)
+    def select_choices(filter)
       find_select_filter(filter).select(self)
     end
 

lib/datagrid/form_builder.rb

@@ -73,11 +73,12 @@ def datagrid_filter_input(attribute_or_filter, **options, &block)
       when :select
         select(
           filter.name,
-          object.select_options(filter) || [],
+          options.delete(:select_choices) || object.select_choices(filter) || [],
           {
             include_blank: filter.include_blank,
             prompt: filter.prompt,
             include_hidden: false,
+            **options.delete(:select_options),
           },
           multiple: filter.multiple?,
           **options,
@@ -97,7 +98,7 @@ def datagrid_filter_input(attribute_or_filter, **options, &block)
     protected
 
     def datagrid_enum_checkboxes_filter(filter, options = {})
-      elements = object.select_options(filter).map do |element|
+      elements = object.select_choices(filter).map do |element|
         text, value = @template.send(:option_text_and_value, element)
         checked = enum_checkbox_checked?(filter, value)
         [value, text, checked]
@@ -137,50 +138,55 @@ def enum_checkbox_checked?(filter, option_value)
     end
 
     def datagrid_dynamic_filter(filter, options = {})
-      field, operation, value = object.filter_value(filter)
       options = add_filter_options(filter, **options)
-      field_input = dynamic_filter_select(
-        filter.name,
-        object.select_options(filter) || [],
+      field, operation, value = object.filter_value(filter)
+      field_options = datagrid_dynamic_field_options(options: options, field: field, filter: filter)
+      operation_options = datagrid_dynamic_operation_options(options: options, operation: operation, filter: filter)
+      value_options = datagrid_dynamic_value_options(options: options, value: value, filter: filter)
+      render_partial(
+        "dynamic_filter",
+        { filter: filter,
+          form: self,
+          field_options: field_options,
+          operation_options: operation_options,
+          value_options: value_options, },
+      )
+    end
+
+    def datagrid_dynamic_field_options(options:, field:, filter:)
+      options.merge(
         {
-          include_blank: filter.include_blank,
-          prompt: filter.prompt,
-          include_hidden: false,
-          selected: field,
+          type: :select,
+          select_options: {
+            selected: field,
+          },
+          name: @template.field_name(object_name, filter.name, "field"),
         },
-        **add_html_classes(options, "datagrid-dynamic-field"),
-        name: @template.field_name(object_name, filter.name, "field"),
       )
-      operation_input = dynamic_filter_select(
-        filter.name, filter.operations_select,
+    end
+
+    def datagrid_dynamic_operation_options(options:, operation:, filter:)
+      options.merge(
         {
-          include_blank: false,
-          include_hidden: false,
-          prompt: false,
-          selected: operation,
+          type: :select,
+          select_choices: filter.operations_select,
+          select_options: {
+            include_blank: false,
+            prompt: false,
+            selected: operation,
+          },
+          name: @template.field_name(object_name, filter.name, "operation"),
         },
-        **add_html_classes(options, "datagrid-dynamic-operation"),
-        name: @template.field_name(object_name, filter.name, "operation"),
-      )
-      value_input = datagrid_filter_input(
-        filter.name,
-        **add_html_classes(options, "datagrid-dynamic-value"),
-        value: value,
-        name: @template.field_name(object_name, filter.name, "value"),
       )
-      [field_input, operation_input, value_input].join("\n").html_safe
     end
 
-    def dynamic_filter_select(name, variants, select_options, html_options)
-      if variants.size <= 1
-        value = variants.first
-        # select options format may vary
-        value = value.last if value.is_a?(Array)
-        # don't render any visible input when there is nothing to choose from
-        hidden_field(name, **html_options, value: value)
-      else
-        select(name, variants, select_options, html_options)
-      end
+    def datagrid_dynamic_value_options(options:, value:, filter:)
+      options.merge(
+        {
+          value: value,
+          name: @template.field_name(object_name, filter.name, "value"),
+        },
+      )
     end
 
     def datagrid_range_filter(filter, options = {})
@@ -205,10 +211,6 @@ def datagrid_get_filter(attribute_or_filter)
         raise(ArgumentError, "Datagrid filter #{attribute_or_filter} not found")
     end
 
-    def add_html_classes(options, *classes)
-      Datagrid::Utils.add_html_classes(options, *classes)
-    end
-
     def partial_path(name)
       if (partials = options[:partials])
         partial_name = File.join(partials, name)

lib/datagrid/rspec.rb

@@ -42,7 +42,7 @@
           when :integer
             1
           when :enum
-            select = subject.select_options(filter)
+            select = subject.select_choices(filter)
             select.first&.last
           else
             raise "unknown filter type: #{filter.class}"

lib/datagrid/utils.rb

@@ -41,17 +41,6 @@ def warn_once(message, delay = 5)
         true
       end
 
-      def add_html_classes(options, *classes)
-        return options if classes.empty?
-
-        options = options.clone
-        options[:class] ||= []
-        array = options[:class].is_a?(Array)
-        value = [*options[:class], *classes]
-        options[:class] = array ? value : value.join(" ")
-        options
-      end
-
       def string_like?(value)
         value.is_a?(Symbol) || value.is_a?(String)
       end