katalyst-tables 3.1.0 → 3.3.0

data/app/models/katalyst/tables/collection/type/helpers/delegate.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Tables
+    module Collection
+      module Type
+        module Helpers
+          # Lifts a delegating type from value to arrays of values
+          module Delegate
+            delegate :type, to: :@delegate
+
+            def initialize(delegate:, **arguments)
+              super(**arguments)
+
+              @delegate = delegate.new(**arguments.except(:filter, :multiple, :scope))
+            end
+
+            using Extensions
+
+            def deserialize(value)
+              if multiple? && value.is_a?(::Array)
+                value.map { |v| @delegate.deserialize(v) }
+              else
+                @delegate.deserialize(value)
+              end
+            end
+
+            def serialize(value)
+              if multiple? && value.is_a?(::Array)
+                value.map { |v| @delegate.serialize(v) }
+              else
+                @delegate.serialize(value)
+              end
+            end
+
+            private
+
+            def cast_value(value)
+              if multiple? && value.is_a?(::Array)
+                value.map { |v| @delegate.cast(v) }
+              else
+                @delegate.cast(value)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/katalyst/tables/collection/type/helpers/extensions.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Tables
+    module Collection
+      module Type
+        module Helpers
+          # Adds support default_value, multiple?, and filterable? to ActiveModel::Type::Value
+          module Extensions
+            refine(::ActiveModel::Type::Value) do
+              def default_value
+                nil
+              end
+
+              def multiple?
+                false
+              end
+
+              def filterable?
+                false
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/katalyst/tables/collection/type/helpers/multiple.rb

@@ -0,0 +1,30 @@
+# 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
+
+            using Extensions
+
+            def default_value
+              multiple? ? [] : super
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Tables
+    module Collection
+      module Type
+        class Integer < Value
+          include Helpers::Delegate
+          include Helpers::Multiple
+
+          def initialize(**)
+            super(**, delegate: ActiveModel::Type::Integer)
+          end
+
+          def serialize(value)
+            if value.is_a?(Range)
+              if value.begin.nil?
+                "<#{super(value.end)}"
+              elsif value.end.nil?
+                ">#{super(value.begin)}"
+              else
+                "#{super(value.begin)}..#{super(value.end)}"
+              end
+            else
+              super
+            end
+          end
+
+          private
+
+          INTEGER = /(-?\d+)/
+          SINGLE_VALUE = /\A#{INTEGER}\z/
+          LOWER_BOUND = /\A>#{INTEGER}\z/
+          UPPER_BOUND = /\A<#{INTEGER}\z/
+          BOUNDED = /\A#{INTEGER}\.\.#{INTEGER}\z/
+
+          def cast_value(value)
+            case value
+            when ::Range, ::Integer
+              value
+            when SINGLE_VALUE
+              super($1)
+            when LOWER_BOUND
+              ((super($1))..)
+            when UPPER_BOUND
+              (..(super($1)))
+            when BOUNDED
+              ((super($1))..(super($2)))
+            else
+              super
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Tables
+    module Collection
+      module Type
+        class Query < Value
+          def type
+            :query
+          end
+
+          def filterable?
+            false
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Tables
+    module Collection
+      module Type
+        class Search < Value
+          # @overwrite Value.initialize() to require scope
+          # rubocop:disable Lint/UselessMethodDefinition
+          def initialize(scope:, **)
+            super
+          end
+          # rubocop:enable Lint/UselessMethodDefinition
+
+          def type
+            :search
+          end
+
+          def filter_condition(model, _, value)
+            model.public_send(scope, value)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Tables
+    module Collection
+      module Type
+        class String < Value
+          include ActiveRecord::Sanitization::ClassMethods
+
+          attr_reader :exact
+          alias_method :exact?, :exact
+
+          delegate :type, :serialize, :deserialize, :cast, to: :@delegate
+
+          def initialize(exact: false, **)
+            super(**)
+
+            @exact = exact
+            @delegate = ActiveModel::Type::String.new
+          end
+
+          private
+
+          def filter_condition(model, column, value)
+            if exact? || scope
+              super
+            else
+              model.where(model.arel_table[column].matches("%#{sanitize_sql_like(value)}%"))
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Katalyst
+  module Tables
+    module Collection
+      module Type
+        class Value < ActiveModel::Type::Value
+          using Helpers::Extensions
+
+          attr_reader :scope
+
+          def initialize(scope: nil, filter: true)
+            super()
+
+            @scope = scope
+            @filterable = filter
+          end
+
+          def filterable?
+            @filterable
+          end
+
+          def filter?(attribute, value)
+            filterable? && (value.present? || attribute.came_from_user?)
+          end
+
+          def filter(scope, attribute)
+            value = filter_value(attribute)
+
+            return scope unless filter?(attribute, value)
+
+            scope, model, column = model_and_column_for(scope, attribute)
+            condition            = filter_condition(model, column, value)
+
+            scope.merge(condition)
+          end
+
+          private
+
+          def filter_value(attribute)
+            attribute.value
+          end
+
+          def filter_condition(model, column, value)
+            if value.nil?
+              model.none
+            elsif scope
+              model.public_send(scope, value)
+            else
+              model.where(column => value)
+            end
+          end
+
+          def model_and_column_for(scope, attribute)
+            if attribute.name.include?(".")
+              table, column = attribute.name.split(".")
+              [scope.joins(table.to_sym), scope.model.reflections[table].klass, column]
+            else
+              [scope, scope.model, attribute.name]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "active_model/type"
+
+module Katalyst
+  module Tables
+    module Collection
+      # Based on ActiveModel::Type – provides a registry for Collection filtering
+      module Type
+        @registry = ActiveModel::Type::Registry.new
+
+        class << self
+          attr_accessor :registry # :nodoc:
+
+          def register(type_name, klass = nil, &)
+            registry.register(type_name, klass, &)
+          end
+
+          def lookup(...)
+            registry.lookup(...)
+          end
+
+          def default_value
+            @default_value ||= Value.new
+          end
+        end
+
+        register(:boolean, Type::Boolean)
+        register(:date, Type::Date)
+        register(:enum, Type::Enum)
+        register(:float, Type::Float)
+        register(:integer, Type::Integer)
+        register(:string, Type::String)
+        register(:query, Type::Query)
+        register(:search, Type::Search)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: katalyst-tables
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Katalyst Interactive
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-14 00:00:00.000000000 Z
+date: 2024-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: katalyst-html-attributes
@@ -54,14 +54,17 @@ 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/_select.scss
 - app/assets/stylesheets/katalyst/tables/_summary.scss
 - app/assets/stylesheets/katalyst/tables/_table.scss
 - app/assets/stylesheets/katalyst/tables/typed-columns/_boolean.scss
 - app/assets/stylesheets/katalyst/tables/typed-columns/_currency.scss
 - app/assets/stylesheets/katalyst/tables/typed-columns/_date.scss
 - app/assets/stylesheets/katalyst/tables/typed-columns/_datetime.scss
+- app/assets/stylesheets/katalyst/tables/typed-columns/_enum.scss
 - app/assets/stylesheets/katalyst/tables/typed-columns/_index.scss
 - app/assets/stylesheets/katalyst/tables/typed-columns/_number.scss
 - app/components/concerns/katalyst/tables/has_table_content.rb
@@ -81,6 +84,7 @@ files:
 - app/components/katalyst/tables/cells/currency_component.rb
 - app/components/katalyst/tables/cells/date_component.rb
 - app/components/katalyst/tables/cells/date_time_component.rb
+- app/components/katalyst/tables/cells/enum_component.rb
 - app/components/katalyst/tables/cells/number_component.rb
 - app/components/katalyst/tables/cells/ordinal_component.rb
 - app/components/katalyst/tables/cells/rich_text_component.rb
@@ -88,6 +92,10 @@ 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
@@ -104,6 +112,7 @@ 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
@@ -113,11 +122,29 @@ files:
 - app/models/concerns/katalyst/tables/collection/filtering.rb
 - app/models/concerns/katalyst/tables/collection/has_params.rb
 - app/models/concerns/katalyst/tables/collection/pagination.rb
+- app/models/concerns/katalyst/tables/collection/query.rb
+- 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/value_parser.rb
 - app/models/concerns/katalyst/tables/collection/reducers.rb
 - app/models/concerns/katalyst/tables/collection/sorting.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/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
@@ -147,7 +174,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.11
 signing_key: 
 specification_version: 4
 summary: HTML table generator for Rails views