datagrid 2.0.8 → 2.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5ac6077bea5b3ee95001a94f7c862a2430dec10d5d35602ac763ad748b2bd6f
-  data.tar.gz: 86a7e62eebc8044e215708ce2aa29f63955e5c7c0635a4e48e1e41f35bffc291
+  metadata.gz: 7592d1dfa05d5c24e010e0e92ee7d5cf8851b374e2857ea3e26f081640fbaf3d
+  data.tar.gz: 13620861647c6fdc672666f323454b0af81070ad240554a2767d105125e7de16
 SHA512:
-  metadata.gz: 3f695cc908307c31ae745621b6afe99ef86422b685549d3084e9b5610c7420eea8c0de9318a25849f0e0042bdc0c95d11b6163ebf0d01ea1b4d62d6de8bd2b81
-  data.tar.gz: 3fe0c0cde94487679ec67ba563b8668f26fa4f977700a25ae58c35a1908bdc73d1558b83a4593eaaf51810844baa26e99e834f7a280edae01ad55f6bc83c3051
+  metadata.gz: 75f9d5b8a61c198427fdda8a4aa21dcb1da83a8c6e5f26b987b6f2d22d05ed0fdc63d3cd592659cec6ff7d9da1f0a5e48c834d6aab03aad56d21f33b186cd6a7
+  data.tar.gz: 37427086dc281ed3809c4b2e05cb047f60e4ca7069da6483c662c13b95528cf1a859e39226adfe8e06ede455ab559fead8a61cdd9dd64869cf0a892fa6177c05

data/CHANGELOG.md

@@ -1,5 +1,35 @@
 # Changelog
 
+## [2.0.9]
+
+* Use new Rails 7.1 `locals` notation in ERB partials.
+* The `FormBuilder#datagrid_filter_input` method now accepts `select_choices` and `select_options` options for the `select` tag.
+* Rename the `Datagrid#select_options` method to `#select_choices`.
+* Added a partial for the dynamic filter allowing to customize the UI [#347](https://github.com/bogdan/datagrid/pull/347).
+
+
+``` erb
+<%# 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"]
+    ) %>
+```
+
 ## [2.0.8]
 
 * Rescue StatementInvalid when guessing column type from a query

data/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"]
+    ) %>

data/app/views/datagrid/_enum_checkboxes.html.erb

@@ -1,3 +1,4 @@
+<%# locals: (form:, elements:, choices:, filter:, options: {}) -%>
 <%# 
 Indent in this file may cause extra space to appear.
 You can add indent if whitespace doesn't matter for you

data/app/views/datagrid/_form.html.erb

@@ -1,3 +1,4 @@
+<%# locals: (grid:, options: {}) -%>
 <%= form_with model: grid, html: {class: 'datagrid-form'}, scope: grid.param_name, method: :get, **options do |f| %>
   <% grid.filters.each do |filter| %>
     <div class="datagrid-filter" data-filter="<%= filter.name %>" data-type="<%= filter.type %>">

data/app/views/datagrid/_head.html.erb

@@ -1,7 +1,8 @@
+<%# locals: (grid:, options: {}) -%>
 <tr>
   <% grid.html_columns(*options[:columns]).each do |column| %>
     <%= tag.th(
-      # Consider maintaining consistency with datagrid/rows partial
+      # Consider maintaining consistency with datagrid/row partial
       "data-column": column.name,
       **column.tag_options,
       class: [        

data/app/views/datagrid/_order_for.html.erb

@@ -1,3 +1,4 @@
+<%# locals: (grid:, column:) -%>
 <div class="order">
   <%= link_to(
       I18n.t("datagrid.table.order.asc").html_safe,

data/app/views/datagrid/_range_filter.html.erb

@@ -1,3 +1,4 @@
+<%# locals: (form:, filter:, from_options: {}, to_options: {}) -%>
 <%= form.datagrid_filter_input(filter, class: 'datagrid-range-from', **from_options) %>
 <span class="datagrid-range-separator"><%= I18n.t('datagrid.filters.range.separator') %></span>
 <%# Generating id only for "from" input to make sure -%>

data/app/views/datagrid/_row.html.erb

@@ -1,8 +1,9 @@
+<%# locals: (grid:, asset:, options: {}) -%>
 <tr>
   <% grid.html_columns(*options[:columns]).each do |column| %>
     <%= tag.td(
       datagrid_value(grid, column, asset),
-      # Consider maintaining consistency with datagrid/rows partial
+      # Consider maintaining consistency with datagrid/head partial
       "data-column": column.name,
       **column.tag_options,
       class: [ 

data/app/views/datagrid/_table.html.erb

@@ -1,9 +1,4 @@
-<%#
-Local variables:
-* grid - instance of Datagrid
-* assets - Array of database Entities
-* options - passed options Hash
-%>
+<%# locals: (grid:, assets:, options: {}) -%>
 <% if grid.html_columns(*options[:columns]).any? %>
   <%= tag.table class: 'datagrid-table', **options.fetch(:html, {}) do %>
     <thead>

data/lib/datagrid/columns.rb

@@ -265,11 +265,13 @@ module Datagrid
       # @param block [Block] proc to calculate a column value
       # @option options [Boolean, String] html Determines if the column should be present
       #   in the HTML table and how it is formatted.
-      # @option options [String, Array<Symbol>] order Determines if the column can be sortable and
+      # @option options [String, Array<Symbol>, Proc] order Determines if the column can be sortable and
       #   specifies the ORM ordering method.
       #   Example: `"created_at, id"` for ActiveRecord, `[:created_at, :id]` for Mongoid.
-      # @option options [String] order_desc Specifies a descending order for the column
-      #   (used when `:order` cannot be easily reversed by the ORM).
+      #   Can be a Proc accepting a scope argument and returning a scope with applied order
+      # @option options [String, Array<Symbol>, Proc] order_desc Specifies a descending order for the column.
+      #   See `order` option for context.
+      #   Used when `:order` cannot be easily reversed by the ORM.
       # @option options [Boolean, Proc] order_by_value Enables Ruby-level ordering for the column.
       #   Warning: Sorting large datasets in Ruby is not recommended.
       #   If `true`, Datagrid orders by the column value.
@@ -277,8 +279,8 @@ module Datagrid
       # @option options [Boolean] mandatory If `true`, the column will never be hidden by the `#column_names` selection.
       # @option options [Symbol] before Places the column before the specified column when determining order.
       # @option options [Symbol] after Places the column after the specified column when determining order.
-      # @option options [Boolean, Proc] if conditions when a column is available.
-      # @option options [Boolean, Proc] unless conditions when a column is not available.
+      # @option options [Symbol, Proc] if conditions when a column is available, can be a method name or a proc with grid argument returning `Boolean`.
+      # @option options [Symbol, Proc] unless conditions when a column is not available, can be a method name or a proc with grid argument returning `Boolean`.
       # @option options [Symbol, Array<Symbol>] preload Specifies associations
       #   to preload for the column within the scope.
       # @option options [Hash] tag_options Specifies HTML attributes for the `<td>` or `<th>` of the column.

data/lib/datagrid/filters.rb

@@ -328,9 +328,15 @@ module Datagrid
       apply_filters(scope, filters.map { |f| filter_by_name(f) })
     end
 
+    # @!visibility private
+    def select_options(filter)
+      Datagrid::Utils.warn_once "#select_options is deprecated and renamed. 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
 

data/lib/datagrid/form_builder.rb

@@ -47,7 +47,7 @@ module Datagrid
     #   * `type` - special attribute the determines an input tag to be made.
     #     Examples: `text`, `select`, `textarea`, `number`, `date` etc.
     # @return [String] an input tag for the corresponding filter name
-    def datagrid_filter_input(attribute_or_filter, **options, &block)
+    def datagrid_filter_input(attribute_or_filter, select_choices: nil, select_options: {}, **options, &block)
       filter = datagrid_get_filter(attribute_or_filter)
       options = add_filter_options(filter, **options)
       type = options.delete(:type)&.to_sym
@@ -73,11 +73,12 @@ module Datagrid
       when :select
         select(
           filter.name,
-          object.select_options(filter) || [],
+          select_choices || object.select_choices(filter) || [],
           {
             include_blank: filter.include_blank,
             prompt: filter.prompt,
             include_hidden: false,
+            **select_options,
           },
           multiple: filter.multiple?,
           **options,
@@ -97,7 +98,7 @@ module Datagrid
     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,56 @@ module Datagrid
     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_choices: object.select_choices(filter),
+          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 +212,6 @@ module Datagrid
         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)

data/lib/datagrid/rspec.rb

@@ -42,7 +42,7 @@ shared_examples_for "Datagrid" do
           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}"

data/lib/datagrid/utils.rb

@@ -41,17 +41,6 @@ module Datagrid
         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

data/lib/datagrid/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Datagrid
-  VERSION = "2.0.8"
+  VERSION = "2.0.9"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: datagrid
 version: !ruby/object:Gem::Version
-  version: 2.0.8
+  version: 2.0.9
 platform: ruby
 authors:
 - Bogdan Gusiev
@@ -37,6 +37,7 @@ files:
 - LICENSE.txt
 - README.md
 - app/assets/stylesheets/datagrid.css
+- app/views/datagrid/_dynamic_filter.html.erb
 - app/views/datagrid/_enum_checkboxes.html.erb
 - app/views/datagrid/_form.html.erb
 - app/views/datagrid/_head.html.erb