katalyst-tables 3.3.1 → 3.3.3

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "katalyst/tables/collection/type/helpers/extensions"
+
+module Katalyst
+  module Tables
+    module Collection
+      module Type
+        module Helpers
+          # Lifts a delegating type from value to arrays of values
+          module Delegate
+            delegate :type, :deserialize, :serialize, to: :@delegate
+
+            def initialize(delegate:, **arguments)
+              super(**arguments)
+
+              @delegate = delegate.new(**arguments.except(:filter, :multiple, :scope))
+            end
+
+            using Extensions
+
+            private
+
+            def cast_value(value)
+              @delegate.cast(value)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/{app/models → lib}/katalyst/tables/collection/type/helpers/extensions.rb

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

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Tables
+    module Collection
+      module Type
+        module Helpers
+          # Adds support for multiple: true
+          module Multiple
+            def initialize(multiple: false, **)
+              super(**)
+
+              @multiple = multiple
+            end
+
+            def multiple?
+              @multiple
+            end
+
+            def cast(value)
+              return (multiple? ? [] : nil) if value.nil?
+
+              if multiple? && value.is_a?(::Array)
+                value.map { |v| super(v) }
+              elsif multiple?
+                [super]
+              else
+                super
+              end
+            end
+
+            def deserialize(value)
+              if multiple? && value.is_a?(::Array)
+                value.map { |v| super(v) }.flatten
+              elsif multiple?
+                [super].flatten.compact
+              else
+                super
+              end
+            end
+
+            def serialize(value)
+              if multiple? && value.is_a?(::Array)
+                value.map { |v| super(v) }.flatten
+              else
+                super
+              end
+            end
+
+            using Extensions
+
+            def default_value
+              multiple? ? [] : super
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Tables
+    module Collection
+      module Type
+        module Helpers
+          # Adds support for ranges
+          module Range
+            extend ActiveSupport::Concern
+
+            class_methods do
+              # @param single_value [Regex] pattern for accepting a single value
+              def define_range_patterns(single_value)
+                const_set(:SINGLE_VALUE, /\A(?<value>#{single_value})\z/)
+                const_set(:LOWER_BOUND, /\A(?<lower>#{single_value})\.\.\z/)
+                const_set(:UPPER_BOUND, /\A\.\.(?<upper>#{single_value})\z/)
+                const_set(:BOUNDED, /\A(?<lower>#{single_value})\.\.(?<upper>#{single_value})\z/)
+              end
+            end
+
+            def serialize(value)
+              if value.is_a?(::Range)
+                if value.begin.nil?
+                  "..#{serialize(value.end)}"
+                elsif value.end.nil?
+                  "#{serialize(value.begin)}.."
+                else
+                  "#{serialize(value.begin)}..#{serialize(value.end)}"
+                end
+              else
+                super
+              end
+            end
+
+            def cast(value)
+              case value
+              when nil
+                nil
+              when ::Range
+                value
+              when self.class.const_get(:SINGLE_VALUE)
+                super($~[:value])
+              when self.class.const_get(:LOWER_BOUND)
+                ((super($~[:lower]))..)
+              when self.class.const_get(:UPPER_BOUND)
+                (..(super($~[:upper])))
+              when self.class.const_get(:BOUNDED)
+                ((super($~[:lower]))..(super($~[:upper])))
+              else
+                super
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Tables
+    module Collection
+      module Type
+        class Integer < Value
+          include Helpers::Delegate
+          include Helpers::Multiple
+          include Helpers::Range
+
+          define_range_patterns(/-?\d+/)
+
+          def initialize(**)
+            super(**, delegate: ActiveModel::Type::Integer)
+          end
+        end
+      end
+    end
+  end
+end

data/{app/models → lib}/katalyst/tables/collection/type/value.rb

@@ -21,7 +21,13 @@ module Katalyst
           end
 
           def filter?(attribute, value)
-            filterable? && (value.present? || attribute.came_from_user?)
+            return false unless filterable?
+
+            if attribute.came_from_user?
+              attribute.value_before_type_cast.present?
+            else
+              value.present?
+            end
           end
 
           def filter(scope, attribute)
@@ -30,11 +36,25 @@ module Katalyst
             return scope unless filter?(attribute, value)
 
             scope, model, column = model_and_column_for(scope, attribute)
-            condition            = filter_condition(model, column, value)
+            condition = filter_condition(model, column, value)
 
             scope.merge(condition)
           end
 
+          def examples_for(scope, attribute)
+            scope, model, column = model_and_column_for(scope, attribute)
+
+            return unless model.attribute_types.has_key?(column)
+
+            filter(scope, attribute)
+              .group(column)
+              .distinct
+              .limit(10)
+              .reorder(column => :asc)
+              .pluck(column)
+              .map { |v| serialize(v) }
+          end
+
           private
 
           def filter_value(attribute)

data/{app/models → lib}/katalyst/tables/collection/type.rb

@@ -2,6 +2,22 @@
 
 require "active_model/type"
 
+require "katalyst/tables/collection/type/helpers/delegate"
+require "katalyst/tables/collection/type/helpers/extensions"
+require "katalyst/tables/collection/type/helpers/multiple"
+require "katalyst/tables/collection/type/helpers/range"
+
+require "katalyst/tables/collection/type/value"
+
+require "katalyst/tables/collection/type/boolean"
+require "katalyst/tables/collection/type/date"
+require "katalyst/tables/collection/type/enum"
+require "katalyst/tables/collection/type/float"
+require "katalyst/tables/collection/type/integer"
+require "katalyst/tables/collection/type/query"
+require "katalyst/tables/collection/type/search"
+require "katalyst/tables/collection/type/string"
+
 module Katalyst
   module Tables
     module Collection

data/lib/katalyst/tables/collection.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Tables
+    module Collection
+      extend ActiveSupport::Autoload
+
+      autoload :Type
+    end
+  end
+end

data/lib/katalyst/tables.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "active_support"
+require "active_support/rails"
 require "view_component"
 require "katalyst/html_attributes"
 
@@ -8,6 +10,10 @@ require_relative "tables/engine"
 
 module Katalyst
   module Tables
+    extend ActiveSupport::Autoload
+
+    autoload :Collection
+
     class Error < StandardError; end
 
     def self.config

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: katalyst-tables
 version: !ruby/object:Gem::Version
-  version: 3.3.1
+  version: 3.3.3
 platform: ruby
 authors:
 - Katalyst Interactive
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-21 00:00:00.000000000 Z
+date: 2024-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: katalyst-html-attributes
@@ -54,9 +54,9 @@ files:
 - app/assets/builds/katalyst/tables.min.js
 - app/assets/builds/katalyst/tables.min.js.map
 - app/assets/config/katalyst-tables.js
-- app/assets/stylesheets/katalyst/tables/_filter.scss
 - app/assets/stylesheets/katalyst/tables/_index.scss
 - app/assets/stylesheets/katalyst/tables/_ordinal.scss
+- app/assets/stylesheets/katalyst/tables/_query.scss
 - app/assets/stylesheets/katalyst/tables/_select.scss
 - app/assets/stylesheets/katalyst/tables/_summary.scss
 - app/assets/stylesheets/katalyst/tables/_table.scss
@@ -92,15 +92,17 @@ files:
 - app/components/katalyst/tables/data.rb
 - app/components/katalyst/tables/empty_caption_component.html.erb
 - app/components/katalyst/tables/empty_caption_component.rb
-- app/components/katalyst/tables/filter/modal_component.html.erb
-- app/components/katalyst/tables/filter/modal_component.rb
-- app/components/katalyst/tables/filter_component.html.erb
-- app/components/katalyst/tables/filter_component.rb
 - app/components/katalyst/tables/header_row_component.html.erb
 - app/components/katalyst/tables/header_row_component.rb
 - app/components/katalyst/tables/label.rb
 - app/components/katalyst/tables/orderable/form_component.rb
 - app/components/katalyst/tables/pagy_nav_component.rb
+- app/components/katalyst/tables/query/input_component.html.erb
+- 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_component.html.erb
+- app/components/katalyst/tables/query_component.rb
 - app/components/katalyst/tables/selectable/form_component.html.erb
 - app/components/katalyst/tables/selectable/form_component.rb
 - app/components/katalyst/tables/summary/body_component.html.erb
@@ -112,10 +114,11 @@ files:
 - app/controllers/concerns/katalyst/tables/backend.rb
 - app/helpers/katalyst/tables/frontend.rb
 - app/javascript/tables/application.js
-- app/javascript/tables/filter/modal_controller.js
 - app/javascript/tables/orderable/form_controller.js
 - app/javascript/tables/orderable/item_controller.js
 - app/javascript/tables/orderable/list_controller.js
+- app/javascript/tables/query_controller.js
+- app/javascript/tables/query_input_controller.js
 - app/javascript/tables/selection/form_controller.js
 - app/javascript/tables/selection/item_controller.js
 - app/models/concerns/katalyst/tables/collection/core.rb
@@ -132,22 +135,24 @@ files:
 - 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/collection/type.rb
-- app/models/katalyst/tables/collection/type/boolean.rb
-- app/models/katalyst/tables/collection/type/date.rb
-- app/models/katalyst/tables/collection/type/enum.rb
-- app/models/katalyst/tables/collection/type/float.rb
-- app/models/katalyst/tables/collection/type/helpers/delegate.rb
-- app/models/katalyst/tables/collection/type/helpers/extensions.rb
-- app/models/katalyst/tables/collection/type/helpers/multiple.rb
-- app/models/katalyst/tables/collection/type/integer.rb
-- app/models/katalyst/tables/collection/type/query.rb
-- app/models/katalyst/tables/collection/type/search.rb
-- app/models/katalyst/tables/collection/type/string.rb
-- app/models/katalyst/tables/collection/type/value.rb
 - config/importmap.rb
 - config/locales/tables.en.yml
 - lib/katalyst/tables.rb
+- lib/katalyst/tables/collection.rb
+- lib/katalyst/tables/collection/type.rb
+- 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/float.rb
+- lib/katalyst/tables/collection/type/helpers/delegate.rb
+- lib/katalyst/tables/collection/type/helpers/extensions.rb
+- lib/katalyst/tables/collection/type/helpers/multiple.rb
+- lib/katalyst/tables/collection/type/helpers/range.rb
+- lib/katalyst/tables/collection/type/integer.rb
+- lib/katalyst/tables/collection/type/query.rb
+- lib/katalyst/tables/collection/type/search.rb
+- lib/katalyst/tables/collection/type/string.rb
+- lib/katalyst/tables/collection/type/value.rb
 - lib/katalyst/tables/config.rb
 - lib/katalyst/tables/engine.rb
 homepage: https://github.com/katalyst/tables

data/app/assets/stylesheets/katalyst/tables/_filter.scss

@@ -1,43 +0,0 @@
-[data-controller="tables--filter--modal"] {
-  position: relative;
-}
-
-.filter-keys-modal {
-  position: absolute;
-  top: 100%;
-  left: 0;
-  right: 0;
-  border: 1px solid rgba(0, 0, 0, 0.16);
-  box-shadow:
-    0 3px 6px rgba(0, 0, 0, 0.16),
-    0 3px 6px rgba(0, 0, 0, 0.23);
-  padding-inline: 1rem;
-  padding-block: 0.5rem 0;
-  margin-top: 0.5rem;
-  background: white;
-  border-radius: 4px;
-  z-index: 1;
-  opacity: 0;
-  transition: opacity 0.125s;
-  pointer-events: none;
-
-  &[data-open] {
-    opacity: 1;
-    pointer-events: unset;
-  }
-
-  table {
-    table-layout: fixed;
-  }
-
-  th.label,
-  th.key {
-    width: 15%;
-  }
-
-  .footer {
-    display: flex;
-    justify-content: flex-end;
-    padding-block: 1rem;
-  }
-}

data/app/components/katalyst/tables/filter/modal_component.html.erb

@@ -1,25 +0,0 @@
-<%= tag.div(**html_attributes) do %>
-  <table>
-    <thead>
-    <tr>
-      <th class="label"></th>
-      <th class="key">Key</th>
-      <th class="values">Values</th>
-    </tr>
-    </thead>
-    <tbody>
-    <% attributes.each do |key, attribute| %>
-      <tr>
-        <th class="label"><%= collection.model.human_attribute_name(key) %></th>
-        <td class="key"><%= key %></td>
-        <td class="values"><%= values_for(key, attribute) %></td>
-      </tr>
-    <% end %>
-    </tbody>
-  </table>
-  <% if footer? %>
-    <div class="footer">
-      <%= footer %>
-    </div>
-  <% end %>
-<% end %>

data/app/components/katalyst/tables/filter/modal_component.rb

@@ -1,112 +0,0 @@
-# frozen_string_literal: true
-
-module Katalyst
-  module Tables
-    module Filter
-      class ModalComponent < ViewComponent::Base
-        include Katalyst::HtmlAttributes
-        include Katalyst::Tables::Frontend
-
-        DEFAULT_ATTRIBUTES = %w[page sort search query].freeze
-
-        renders_one :footer
-
-        attr_reader :collection, :url
-
-        def initialize(collection:, **)
-          super(**)
-
-          @collection = collection
-        end
-
-        private
-
-        def default_html_attributes
-          {
-            class: "filter-keys-modal",
-            data:  {
-              tables__filter__modal_target: "modal",
-            },
-          }
-        end
-
-        using Collection::Type::Helpers::Extensions
-
-        def attributes
-          collection.class.attribute_types
-            .select { |_, a| a.filterable? && a.type != :search }
-        end
-
-        def values_for(key, attribute)
-          values_method = "#{key.parameterize.underscore}_values"
-          if collection.respond_to?(values_method)
-            return scope_values(attribute, values_method)
-          end
-
-          case attribute.type
-          when :boolean
-            render_options(true, false)
-          when :date
-            date_values
-          when :integer
-            integer_values(attribute)
-          when :float
-            float_values(attribute)
-          when :enum
-            enum_values(key)
-          when :string
-            string_values(attribute)
-          end
-        end
-
-        def scope_values(attribute, values_method)
-          values = collection.public_send(values_method)
-          attribute.multiple? ? render_array(*values) : render_options(*values)
-        end
-
-        def date_values
-          render_options("YYYY-MM-DD", ">YYYY-MM-DD", "<YYYY-MM-DD", "YYYY-MM-DD..YYYY-MM-DD")
-        end
-
-        def string_values(attribute)
-          options = render_options("example", '"an example"')
-          safe_join([options, attribute.exact? ? "(exact match)" : "(fuzzy match)"], " ")
-        end
-
-        def enum_values(key)
-          enums = collection.model.defined_enums
-
-          render_array(*enums[key].keys) if enums.has_key?(key)
-        end
-
-        def float_values(attribute)
-          if attribute.multiple?
-            render_array("0.5", "1", "...")
-          else
-            render_options("0.5", ">0.5", "<0.5", "-0.5..0.5")
-          end
-        end
-
-        def integer_values(attribute)
-          if attribute.multiple?
-            render_array("0", "1", "...")
-          else
-            render_options("10", ">10", "<10", "0..10")
-          end
-        end
-
-        def render_option(value)
-          tag.code(value.to_s)
-        end
-
-        def render_options(*values)
-          safe_join(values.map { |value| render_option(value) }, ", ")
-        end
-
-        def render_array(*values)
-          safe_join(["[", render_options(*values), "]"])
-        end
-      end
-    end
-  end
-end

data/app/components/katalyst/tables/filter_component.html.erb

@@ -1,18 +0,0 @@
-<%= tag.div(**html_attributes) do %>
-  <% if content? %>
-    <%= content %>
-  <% else %>
-    <%= form do |form| %>
-      <%= form.text_field(
-            :query,
-            type:         :search,
-            autocomplete: "off",
-            **input_attributes,
-          ) %>
-
-      <%= form.button("Apply", type: :submit, name: nil) %>
-    <% end %>
-  <% end %>
-
-  <%= modal %>
-<% end %>

data/app/javascript/tables/filter/modal_controller.js

@@ -1,13 +0,0 @@
-import { Controller } from "@hotwired/stimulus";
-
-export default class FilterModalController extends Controller {
-  static targets = ["modal"];
-
-  close(e) {
-    delete this.modalTarget.dataset.open;
-  }
-
-  open(e) {
-    this.modalTarget.dataset.open = "true";
-  }
-}

data/app/models/katalyst/tables/collection/type/date.rb

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-
-module Katalyst
-  module Tables
-    module Collection
-      module Type
-        class Date < Value
-          def type
-            :date
-          end
-
-          def serialize(value)
-            if value.is_a?(Date)
-              value.to_fs(:db)
-            elsif value.is_a?(Range)
-              if value.begin.nil?
-                "<#{value.end.to_fs(:db)}"
-              elsif value.end.nil?
-                ">#{value.begin.to_fs(:db)}"
-              else
-                "#{value.begin.to_fs(:db)}..#{value.end.to_fs(:db)}"
-              end
-            else
-              value.to_s
-            end
-          end
-
-          private
-
-          ISO_DATE = /\A(\d{4})-(\d\d)-(\d\d)\z/
-          LOWER_BOUND = /\A>(\d{4})-(\d\d)-(\d\d)\z/
-          UPPER_BOUND = /\A<(\d{4})-(\d\d)-(\d\d)\z/
-          BOUNDED = /\A(\d{4})-(\d\d)-(\d\d)\.\.(\d{4})-(\d\d)-(\d\d)\z/
-
-          def cast_value(value)
-            return value unless value.is_a?(::String)
-
-            if value =~ ISO_DATE
-              new_date($1.to_i, $2.to_i, $3.to_i)
-            elsif value =~ LOWER_BOUND
-              (new_date($1.to_i, $2.to_i, $3.to_i)..)
-            elsif value =~ UPPER_BOUND
-              (..new_date($1.to_i, $2.to_i, $3.to_i))
-            elsif value =~ BOUNDED
-              (new_date($1.to_i, $2.to_i, $3.to_i)..new_date($4.to_i, $5.to_i, $6.to_i))
-            end
-          end
-
-          def new_date(year, mon, mday)
-            return nil if year.nil? || (year.zero? && mon.zero? && mday.zero?)
-
-            ::Date.new(year, mon, mday)
-          rescue ArgumentError, TypeError
-            nil
-          end
-        end
-      end
-    end
-  end
-end