katalyst-tables 3.4.6 → 3.5.1

data/app/models/katalyst/tables/suggestions/custom_value.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Tables
+    module Suggestions
+      class CustomValue < Base
+        delegate :to_param, to: :@attribute_type
+
+        def initialize(value, name:, type:)
+          super(value)
+
+          @name = name
+          @attribute_type = type
+        end
+
+        def type
+          :custom_value
+        end
+
+        def value
+          to_param(@value)
+        end
+      end
+    end
+  end
+end

data/app/models/katalyst/tables/suggestions/database_value.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Tables
+    module Suggestions
+      class DatabaseValue < Base
+        attr_reader :model, :column
+
+        delegate :to_param, to: :@attribute_type
+
+        def initialize(name:, type:, model:, column:, value:)
+          super(value)
+
+          @attribute_type = type
+          @model = model
+          @column = column
+          @name = name
+        end
+
+        def type
+          :database_value
+        end
+
+        using Tables::Collection::Type::Helpers::Extensions
+
+        def value
+          if @attribute_type.multiple? && @value.is_a?(Array) && @value.length == 1
+            to_param(@value.first)
+          else
+            to_param(@value)
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/katalyst/tables/suggestions/search_value.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Tables
+    module Suggestions
+      class SearchValue < Base
+        def type
+          :search_value
+        end
+      end
+    end
+  end
+end

data/config/locales/tables.en.yml

@@ -2,7 +2,15 @@ en:
   katalyst:
     tables:
       query:
-        placeholder: "Filter %{name}"
+        input_component:
+          placeholder: "Filter %{name}"
+        modal_component:
+          suggestions_title: "Search options"
       orderable:
         value:
           "⠿"
+  errors:
+    attributes:
+      query:
+        unknown_key: "The field '%{input}' isn’t searchable here. Please check your input."
+        no_untagged_search: "'%{input}' isn't searchable here. Please choose a field to search."

data/lib/katalyst/tables/collection/type/boolean.rb

@@ -22,8 +22,16 @@ module Katalyst
             end
           end
 
-          def examples_for(...)
-            [example(true), example(false)]
+          def suggestions(scope, attribute)
+            _, model, column = model_and_column_for(scope, attribute)
+
+            values = %w[true false]
+
+            if attribute.value_before_type_cast.present?
+              values = values.select { |value| value.include?(attribute.value_before_type_cast) }
+            end
+
+            values.map { |v| constant_suggestion(attribute:, model:, column:, value: deserialize(v)) }
           end
         end
       end

data/lib/katalyst/tables/collection/type/date.rb

@@ -22,13 +22,15 @@ module Katalyst
             end
           end
 
-          def examples_for(scope, attribute)
+          def suggestions(scope, attribute)
+            _, model, column = model_and_column_for(scope, attribute)
+
             [
               *super(scope, attribute, limit: 6, order: :desc),
-              example(::Date.current.beginning_of_week.., "this week"),
-              example(::Date.current.beginning_of_month.., "this month"),
-              example(1.month.ago.all_month, "last month"),
-              example(1.year.ago.all_year, "last year"),
+              database_suggestion(attribute:, model:, column:, value: ::Date.current.beginning_of_week..),
+              database_suggestion(attribute:, model:, column:, value: ::Date.current.beginning_of_month..),
+              database_suggestion(attribute:, model:, column:, value: 1.month.ago.all_month),
+              database_suggestion(attribute:, model:, column:, value: 1.year.ago.all_year),
             ]
           end
 

data/lib/katalyst/tables/collection/type/enum.rb

@@ -15,18 +15,18 @@ module Katalyst
             :enum
           end
 
-          def examples_for(scope, attribute)
+          def suggestions(scope, attribute)
             _, model, column = model_and_column_for(scope, attribute)
 
             raise ArgumentError, "Unknown enum #{column} for #{model}" unless model.defined_enums.has_key?(column)
 
-            keys = model.defined_enums[column].keys
+            values = model.defined_enums[column].keys
 
             if attribute.value_before_type_cast.present?
-              keys = keys.select { |key| key.include?(attribute.value_before_type_cast.last) }
+              values = values.select { |key| key.include?(attribute.value_before_type_cast) }
             end
 
-            keys.map { |key| example(key, describe_key(model, attribute, key)) }
+            values.map { |value| constant_suggestion(attribute:, model:, column:, value:) }
           end
 
           private
@@ -34,23 +34,6 @@ module Katalyst
           def cast_value(value)
             value.to_s
           end
-
-          def describe_key(model, attribute, key)
-            label = model.human_attribute_name(attribute.name).downcase
-            value = model.human_attribute_name("#{attribute.name}.#{key}").downcase
-
-            description = "#{model.model_name.human} #{label} is #{value}"
-            description += " (default)" if default?(attribute, key)
-            description
-          end
-
-          def default?(attribute, value)
-            if multiple?
-              attribute.original_value&.intersection(cast(value))&.any?
-            else
-              attribute.default_value.eql?(cast(value))
-            end
-          end
         end
       end
     end

data/lib/katalyst/tables/collection/type/helpers/extensions.rb

@@ -20,20 +20,10 @@ module Katalyst
                 false
               end
 
-              def examples_for(...)
+              def suggestions(...)
                 []
               end
             end
-
-            refine(::ActiveModel::Attribute) do
-              def query_range=(range)
-                @query_range = range
-              end
-
-              def query_range
-                @query_range
-              end
-            end
           end
         end
       end

data/lib/katalyst/tables/collection/type/value.rb

@@ -30,9 +30,7 @@ module Katalyst
             end
           end
 
-          def filter(scope, attribute)
-            value = filter_value(attribute)
-
+          def filter(scope, attribute, value: filter_value(attribute))
             return scope unless filter?(attribute, value)
 
             scope, model, column = model_and_column_for(scope, attribute)
@@ -45,29 +43,33 @@ module Katalyst
             serialize(value)
           end
 
-          def examples_for(scope, attribute, limit: 10, order: :asc)
+          def suggestions(scope, attribute, limit: 10, order: :asc)
             scope, model, column = model_and_column_for(scope, attribute)
 
             unless model.attribute_types.has_key?(column)
               raise(ArgumentError, "Unknown column '#{column}' for #{model}. " \
-                                   "Consider defining '#{attribute.name.parameterize.underscore}_examples'")
+                                   "Consider defining '#{attribute.name.parameterize.underscore}_suggestions'")
             end
 
-            column = model.arel_table[column]
+            arel_column = model.arel_table[column]
 
             filter(scope, attribute)
-              .group(column)
+              .group(arel_column)
               .distinct
               .limit(limit)
-              .reorder(column => order)
-              .pluck(column)
-              .map { |v| example(deserialize(v)) }
+              .reorder(arel_column => order)
+              .pluck(arel_column)
+              .map { |v| database_suggestion(attribute:, model:, column:, value: deserialize(v)) }
           end
 
           private
 
-          def example(value, description = "")
-            Example.new(to_param(value), description)
+          def constant_suggestion(attribute:, model:, column:, value:)
+            Tables::Suggestions::ConstantValue.new(name: attribute.name, type: attribute.type, model:, column:, value:)
+          end
+
+          def database_suggestion(attribute:, model:, column:, value:)
+            Tables::Suggestions::DatabaseValue.new(name: attribute.name, type: attribute.type, model:, column:, value:)
           end
 
           def filter_value(attribute)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: katalyst-tables
 version: !ruby/object:Gem::Version
-  version: 3.4.6
+  version: 3.5.1
 platform: ruby
 authors:
 - Katalyst Interactive
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-15 00:00:00.000000000 Z
+date: 2024-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: katalyst-html-attributes
@@ -101,6 +101,8 @@ files:
 - app/components/katalyst/tables/query/input_component.rb
 - app/components/katalyst/tables/query/modal_component.html.erb
 - app/components/katalyst/tables/query/modal_component.rb
+- app/components/katalyst/tables/query/suggestion_component.html.erb
+- app/components/katalyst/tables/query/suggestion_component.rb
 - app/components/katalyst/tables/query_component.html.erb
 - app/components/katalyst/tables/query_component.rb
 - app/components/katalyst/tables/selectable/form_component.html.erb
@@ -130,12 +132,20 @@ files:
 - app/models/concerns/katalyst/tables/collection/query/array_value_parser.rb
 - app/models/concerns/katalyst/tables/collection/query/parser.rb
 - app/models/concerns/katalyst/tables/collection/query/single_value_parser.rb
+- app/models/concerns/katalyst/tables/collection/query/untagged_literal.rb
 - app/models/concerns/katalyst/tables/collection/query/value_parser.rb
 - app/models/concerns/katalyst/tables/collection/reducers.rb
 - app/models/concerns/katalyst/tables/collection/sorting.rb
+- app/models/concerns/katalyst/tables/collection/suggestions.rb
 - app/models/katalyst/tables/collection/array.rb
 - app/models/katalyst/tables/collection/base.rb
 - app/models/katalyst/tables/collection/filter.rb
+- app/models/katalyst/tables/suggestions/attribute.rb
+- app/models/katalyst/tables/suggestions/base.rb
+- app/models/katalyst/tables/suggestions/constant_value.rb
+- app/models/katalyst/tables/suggestions/custom_value.rb
+- app/models/katalyst/tables/suggestions/database_value.rb
+- app/models/katalyst/tables/suggestions/search_value.rb
 - config/importmap.rb
 - config/locales/tables.en.yml
 - lib/katalyst/tables.rb
@@ -144,7 +154,6 @@ files:
 - lib/katalyst/tables/collection/type/boolean.rb
 - lib/katalyst/tables/collection/type/date.rb
 - lib/katalyst/tables/collection/type/enum.rb
-- lib/katalyst/tables/collection/type/example.rb
 - lib/katalyst/tables/collection/type/float.rb
 - lib/katalyst/tables/collection/type/helpers/delegate.rb
 - lib/katalyst/tables/collection/type/helpers/extensions.rb

data/lib/katalyst/tables/collection/type/example.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module Katalyst
-  module Tables
-    module Collection
-      module Type
-        class Example
-          attr_reader :value, :description
-
-          def initialize(value, description = "")
-            @value = value
-            @description = description
-          end
-
-          def hash
-            value.hash
-          end
-
-          def eql?(other)
-            value.eql?(other.value)
-          end
-
-          def to_s
-            value.to_s
-          end
-        end
-      end
-    end
-  end
-end