katalyst-tables 3.4.1 → 3.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5923255962191599c9ddf2eef5a5fa1dee03b8b1513336d0f2e849ebe5748ea
-  data.tar.gz: d169ccb2f68d196c1c0472070e6ef4f57aabb1d93189acadbc253ec860d05b76
+  metadata.gz: 3759aa46548e98b88f6528c449ae5daff86785c9511a4637bbb17c692b3c7c04
+  data.tar.gz: 3982b2749ec6c19b4a7deb279ebc78ef8415c04be64d5949d9730d55b0999474
 SHA512:
-  metadata.gz: 3437fad480724057194bb31a26508d19e139ee1b118a3896c4abc2181da3a2d6d45e62d492c84304b30abb2c4917a0e805c4be04d1a0feac753546733962d84c
-  data.tar.gz: 542774d195ca0b1a1818b96c162f57dda6a0ac6feb3b8620ee76cfa9aee3f018c20b1120ce4e671c1069783ff5a72827b119a53af0feda6d361ba2fd787f072d
+  metadata.gz: 550c46bcbfec02a42c019a6f52c9339f1fb0e0046ad1368c1c2651201fc7179fb92b9f40bbb2176be27e23fff49cd7910276ea44ce19338cc8500470cb97a3cd
+  data.tar.gz: 7d56c07e0755a26d05a9b8dbe38b33f649a185ac4491961dc0130e29e5a2478860e9fb4625ddbf2844106297f13d2989e23f1d7f51a4a49e5e6d4bd9ddf8f52e

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

@@ -72,8 +72,9 @@
   dl {
     display: grid;
     grid-auto-flow: row;
-    grid-auto-rows: 1fr;
-    grid-template-columns: 1fr 4fr;
+    grid-auto-rows: auto;
+    grid-template-columns: auto 1fr;
+    gap: 0 1rem;
   }
 
   dt {
@@ -85,11 +86,6 @@
     color: #666;
   }
 
-  ul {
-    list-style: none;
-    padding-left: 0;
-  }
-
   .error {
     background: #fff2f2;
     border-bottom: 1px solid #fdd3d3;

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

@@ -9,6 +9,7 @@ $row-border-color: $grey !default;
 $row-height: 48px !default;
 $cell-spacing: 0.5rem !default;
 $tag-color: $grey !default;
+$on-tag-color: black !default;
 
 $width-small: 6rem !default;
 $width-medium: 12rem !default;
@@ -20,6 +21,7 @@ table {
   --table-header-color: #{$table-header-color};
   --row-border-color: #{$row-border-color};
   --tag-color: #{$tag-color};
+  --on-tag-color: #{$on-tag-color};
 
   --width-small: #{$width-small};
   --width-medium: #{$width-medium};

data/app/assets/stylesheets/katalyst/tables/typed-columns/_enum.scss

@@ -2,8 +2,14 @@
   width: var(--width-small);
 }
 
-:where(td.type-enum small) {
-  background: var(--tag-color);
-  border-radius: 0.25rem;
-  padding: 0.25rem 0.5rem;
+:where(td.type-enum) {
+  // ensure ellipsis is the correct color
+  color: var(--on-tag-color);
+
+  small {
+    background: var(--tag-color);
+    border-radius: 0.25rem;
+    padding: 0.25rem 0.5rem;
+    font-size: small;
+  }
 }

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

@@ -8,13 +8,14 @@
     </header>
   <% end %>
   <div class="content">
-    <% if show_values? %>
+    <% if show_examples? %>
       <h4>Possible values for <code><%= current_key %>:</code></h4>
-      <ul>
-        <% values_for(current_key).each do |value| %>
-          <li><code><%= format_value(value) %></code></li>
+      <dl>
+        <% examples_for(current_key).each do |example| %>
+          <dt><code><%= format_value(example.value) %></code></dt>
+          <% if example.description.present? %><dd><%= example.description %></dd><% end %>
         <% end %>
-      </ul>
+      </dl>
     <% else %>
       <h4>Available filters:</h4>
       <dl>

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

@@ -31,7 +31,7 @@ module Katalyst
 
         using Collection::Type::Helpers::Extensions
 
-        def show_values?
+        def show_examples?
           current_key && attributes[current_key]
         end
 
@@ -63,13 +63,13 @@ module Katalyst
           end
         end
 
-        def values_for(key)
-          collection.examples_for(key).map(&:to_s).compact_blank
+        def examples_for(key)
+          collection.examples_for(key)&.reject { |e| e.value.to_s.blank? } || []
         end
 
         def format_value(value)
-          if /\A[\w.-]*\z/.match?(value)
-            value
+          if /\A[\w.-]*\z/.match?(value.to_s)
+            value.to_s
           else
             %("#{value}")
           end

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

@@ -32,7 +32,7 @@ module Katalyst
           key = key.to_s
           examples_method = "#{key.parameterize.underscore}_examples"
           if respond_to?(examples_method)
-            public_send(examples_method)
+            public_send(examples_method)&.map { |e| e.is_a?(Example) ? e : Example.new(example) }
           elsif @attributes.key?(key)
             @attributes[key].type.examples_for(unscoped_items, @attributes[key])
           end

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

@@ -23,7 +23,7 @@ module Katalyst
           end
 
           def examples_for(...)
-            [true, false]
+            [example(true), example(false)]
           end
         end
       end

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

@@ -13,22 +13,23 @@ module Katalyst
             :date
           end
 
-          def serialize(value)
-            if value.is_a?(::Date)
-              value.to_fs(:db)
+          def to_param(value)
+            case value
+            when ::Date, ::DateTime, ::Time, ActiveSupport::TimeWithZone
+              value.to_date.to_fs(:db)
             else
               super
             end
           end
 
-          def examples_for(...)
+          def examples_for(scope, attribute)
             [
-              ::Date.current,
-              ::Date.yesterday,
-              ::Date.current.beginning_of_week..,
-              ::Date.current.beginning_of_month..,
-              ::Date.current.beginning_of_year..,
-            ].map { |d| serialize(d) }
+              *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"),
+            ]
           end
 
           private

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

@@ -20,10 +20,17 @@ module Katalyst
             keys = model.defined_enums[column]&.keys
 
             if attribute.value_before_type_cast.present?
-              keys.select { |key| key.include?(attribute.value_before_type_cast.last) }
-            else
-              keys
+              keys = keys.select { |key| key.include?(attribute.value_before_type_cast.last) }
             end
+
+            keys.map { |key| example(key, describe_key(model, attribute.name, key)) }
+          end
+
+          private
+
+          def describe_key(model, attribute, key)
+            key = I18n.t("active_record.attributes.#{model.model_name.i18n_key}/#{key}", default: key.to_s.titleize)
+            "#{model.model_name.human} #{model.human_attribute_name(attribute).downcase} is #{key}"
           end
         end
       end

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

@@ -0,0 +1,30 @@
+# 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

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

@@ -21,9 +21,9 @@ module Katalyst
               return (multiple? ? [] : nil) if value.nil?
 
               if multiple? && value.is_a?(::Array)
-                value.map { |v| super(v) }
+                value_for_multiple(value.flat_map { |v| cast(v) })
               elsif multiple?
-                [super]
+                value_for_multiple(super)
               else
                 super
               end
@@ -31,7 +31,7 @@ module Katalyst
 
             def deserialize(value)
               if multiple? && value.is_a?(::Array)
-                value.map { |v| super(v) }.flatten
+                value.map { |v| deserialize(v) }.flatten
               elsif multiple?
                 [super].flatten.compact
               else
@@ -41,7 +41,15 @@ module Katalyst
 
             def serialize(value)
               if multiple? && value.is_a?(::Array)
-                value.map { |v| super(v) }.flatten
+                value.map { |v| serialize(v) }.flatten
+              else
+                super
+              end
+            end
+
+            def to_param(value)
+              if multiple? && value.is_a?(::Array)
+                "[#{value.map { |v| to_param(v) }.flatten.join(', ')}]"
               else
                 super
               end
@@ -52,6 +60,17 @@ module Katalyst
             def default_value
               multiple? ? [] : super
             end
+
+            def value_for_multiple(value)
+              case value
+              when ::Array
+                value.reject { |v| v.is_a?(::Range) }
+              when ::Range
+                value
+              else
+                [value]
+              end
+            end
           end
         end
       end

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

@@ -19,14 +19,42 @@ module Katalyst
               end
             end
 
+            def deserialize(value)
+              if value.is_a?(::Range)
+                if value.begin.nil?
+                  make_range(nil, deserialize(value.end))
+                elsif value.end.nil?
+                  make_range(deserialize(value.begin), nil)
+                else
+                  make_range(deserialize(value.begin), deserialize(value.end))
+                end
+              else
+                super
+              end
+            end
+
             def serialize(value)
               if value.is_a?(::Range)
                 if value.begin.nil?
-                  "..#{serialize(value.end)}"
+                  make_range(nil, serialize(value.end))
                 elsif value.end.nil?
-                  "#{serialize(value.begin)}.."
+                  make_range(serialize(value.begin), nil)
                 else
-                  "#{serialize(value.begin)}..#{serialize(value.end)}"
+                  make_range(serialize(value.begin), serialize(value.end))
+                end
+              else
+                super
+              end
+            end
+
+            def to_param(value)
+              if value.is_a?(::Range)
+                if value.begin.nil?
+                  "..#{to_param(value.end)}"
+                elsif value.end.nil?
+                  "#{to_param(value.begin)}.."
+                else
+                  "#{to_param(value.begin)}..#{to_param(value.end)}"
                 end
               else
                 super
@@ -42,15 +70,25 @@ module Katalyst
               when self.class.const_get(:SINGLE_VALUE)
                 super($~[:value])
               when self.class.const_get(:LOWER_BOUND)
-                ((super($~[:lower]))..)
+                make_range(super($~[:lower]), nil)
               when self.class.const_get(:UPPER_BOUND)
-                (..(super($~[:upper])))
+                make_range(nil, super($~[:upper]))
               when self.class.const_get(:BOUNDED)
-                ((super($~[:lower]))..(super($~[:upper])))
+                make_range(super($~[:lower]), super($~[:upper]))
               else
                 super
               end
             end
+
+            private
+
+            def make_range(from, to)
+              # when a value that accepts multiple is given a range, it double-packs the value so we get ..[0]
+              # unpack the array value
+              from = from.first if from.is_a?(::Array) && from.length == 1
+              to = to.first if to.is_a?(::Array) && to.length == 1
+              (from..to)
+            end
           end
         end
       end

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

@@ -41,7 +41,11 @@ module Katalyst
             scope.merge(condition)
           end
 
-          def examples_for(scope, attribute)
+          def to_param(value)
+            serialize(value)
+          end
+
+          def examples_for(scope, attribute, limit: 10, order: :asc)
             scope, model, column = model_and_column_for(scope, attribute)
 
             return unless model.attribute_types.has_key?(column)
@@ -51,14 +55,18 @@ module Katalyst
             filter(scope, attribute)
               .group(column)
               .distinct
-              .limit(10)
-              .reorder(column => :asc)
+              .limit(limit)
+              .reorder(column => order)
               .pluck(column)
-              .map { |v| serialize(v) }
+              .map { |v| example(deserialize(v)) }
           end
 
           private
 
+          def example(value, description = "")
+            Example.new(to_param(value), description)
+          end
+
           def filter_value(attribute)
             attribute.value
           end
@@ -69,7 +77,7 @@ module Katalyst
             elsif scope
               model.public_send(scope, value)
             else
-              model.where(column => value)
+              model.where(column => serialize(value))
             end
           end
 

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

@@ -7,6 +7,7 @@ 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/example"
 require "katalyst/tables/collection/type/value"
 
 require "katalyst/tables/collection/type/boolean"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: katalyst-tables
 version: !ruby/object:Gem::Version
-  version: 3.4.1
+  version: 3.4.3
 platform: ruby
 authors:
 - Katalyst Interactive
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-02 00:00:00.000000000 Z
+date: 2024-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: katalyst-html-attributes
@@ -144,6 +144,7 @@ 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