terrazzo 0.7.3 → 0.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c052bdf0156ea6f274c81bd8e8ac10d2a0519149cf7cdc3f4a2e6ba7fad07457
-  data.tar.gz: 52cc71522126bba003d340eb190dafda5c4f74e33c2be6605f3cecc1cadb793b
+  metadata.gz: '084ca2853c7f77397ca86d6530e21abe0d61819a464a6ce352b2c9230ae2d95f'
+  data.tar.gz: b2b7a278bd069090a23ef1c4edbb73a7e793af55eca3941225dff5695d90e92c
 SHA512:
-  metadata.gz: b891e22f66ddccc7792b9096c250c727057161291d20eee0d0854bf5545bad6317512b32d9dd99a33619d93641178b53006682128f48ec7bb9d825440f17d6ef
-  data.tar.gz: 7bf82c9b3eae347aacc43cb6dc0e521904363069dd802ec51a904f3dc9c53bebc316dc61609dd2565c877e0b0985a78f89fa1158325415db9dde9c8c9fd91d61
+  metadata.gz: e1dc0b5cb17ff57bf6261cd3eafc85583473d52e5898be93c54114972cc4d7d926a653bdbf1073ba8bec5b90c4526b314ec05d8c40e7771af608e2a986b920d8
+  data.tar.gz: 01b2c4e3ba0b24076b7a1c0bd90e8f55a70b0b03a11b04963fef2d130939350d0b34d0d95602c04ef9020f3029ac8afdab3220859c8b5f243cf5bb512ad3b5c7

data/README.md

@@ -63,6 +63,9 @@ Full docs at **[gohypelab.github.io/terrazzo](https://gohypelab.github.io/terraz
 - Node.js 18+
 - A JS bundler (Vite recommended, esbuild also supported)
 
+Terrazzo selects JSON 2.x because current Rails releases do not support the
+JSON 3 argument format. See [the Rails compatibility fix](https://github.com/rails/rails/pull/58601).
+
 ## Development and releases
 
 Pull requests and pushes to `main` run the Ruby unit specs, npm package checks,
@@ -85,6 +88,14 @@ retried safely.
 See [RELEASING.md](RELEASING.md) for trusted publisher setup, release commands,
 and retry instructions.
 
+## Customizing search
+
+Enable search with `searchable: true` in a dashboard field's options. Search supports
+numeric columns, JSON store accessors, and associated records. Override the
+controller's `search_resources` method to add custom search syntax.
+See [search fields](docs/customizing-dashboards.md#search-fields) and
+[custom search](docs/customizing-controller-actions.md#customizing-search).
+
 ## Customizing Per-Row Actions
 
 Terrazzo generates Show, Edit, and Destroy action buttons for each row on index pages and has_many tables on show pages.

data/app/controllers/terrazzo/application_controller.rb

@@ -158,9 +158,12 @@ module Terrazzo
       resource_class.all
     end
 
+    def search_resources
+      Terrazzo::Search.new(scoped_resource, dashboard, params[:search]).run
+    end
+
     def index_resources_and_order
-      search = Terrazzo::Search.new(scoped_resource, dashboard, params[:search])
-      resources = search.run
+      resources = search_resources
 
       filter = Terrazzo::Filter.new(resources, dashboard, params[:filter], params[:filter_value])
       resources = filter.run

data/app/views/terrazzo/application/_edit_base.json.props

@@ -1,6 +1,6 @@
 param_key = resource_class.model_name.param_key
 
-json.pageTitle t("terrazzo.actions.edit", resource_name: resource_name)
+json.pageTitle "#{t("terrazzo.actions.edit", resource_name: resource_name)} — #{dashboard.display_resource(@resource)}"
 
 json.form do
   json.props({

data/lib/terrazzo/search.rb

@@ -9,11 +9,7 @@ module Terrazzo
     end
 
     def run
-      if term.blank?
-        scoped_resource
-      else
-        search_results
-      end
+      term.blank? ? scoped_resource : search_results
     end
 
     private
@@ -21,52 +17,72 @@ module Terrazzo
     LIKE_ESCAPE = "\\"
 
     def search_results
-      @association_search_joined = false
       searchable_attributes = dashboard.search_attributes
       return scoped_resource if searchable_attributes.empty?
 
-      conditions = searchable_attributes.map do |attr|
-        type = dashboard.attribute_type_for(attr)
+      conditions =
+        searchable_attributes
+          .map do |attr|
+            type = dashboard.attribute_type_for(attr)
 
-        if type.respond_to?(:associative?) && type.associative?
-          build_association_search(attr, type)
-        else
-          table = scoped_resource.model.arel_table
-          table[attr].matches(search_pattern, LIKE_ESCAPE)
-        end
-      end.compact
+            if type.respond_to?(:associative?) && type.associative?
+              build_association_search(attr, type)
+            else
+              text_attribute(scoped_resource.model, attr).matches(search_pattern, LIKE_ESCAPE)
+            end
+          end
+          .compact
 
       return scoped_resource if conditions.empty?
 
       combined = conditions.reduce(:or)
-      results = scoped_resource.where(combined)
-      @association_search_joined ? results.distinct : results
+      scoped_resource.where(combined)
     end
 
     def build_association_search(attr, type)
       reflection = scoped_resource.model.reflect_on_association(attr)
       return nil unless reflection
 
-      assoc_table = reflection.klass.arel_table
       columns = association_search_columns(type, reflection.klass)
       return nil if columns.empty?
 
-      @scoped_resource = scoped_resource.left_joins(attr)
-      @association_search_joined = true
-      columns
-        .map { |column| assoc_table[column].matches(search_pattern, LIKE_ESCAPE) }
-        .reduce(:or)
+      condition =
+        columns
+          .map { |column| text_attribute(reflection.klass, column).matches(search_pattern, LIKE_ESCAPE) }
+          .reduce(:or)
+
+      # Match IDs so association joins do not duplicate rows or compare JSON columns.
+      model = scoped_resource.model
+      primary_key = model.arel_table[model.primary_key]
+      ids = model.unscoped.joins(attr).where(condition).reselect(primary_key)
+      primary_key.in(ids.arel)
     end
 
     def association_search_columns(type, associated_class)
       configured = type.respond_to?(:options) ? Array(type.options[:searchable_fields]) : []
-      candidates = configured.presence || [:name, :title, :email]
-      column_names = associated_class.column_names
+      candidates = configured.presence || %i[name title email]
+      column_names = associated_class.column_names + associated_class.stored_attributes.values.flatten.map(&:to_s)
 
-      candidates
-        .map(&:to_s)
-        .select { |column| column_names.include?(column) }
-        .map(&:to_sym)
+      candidates.map(&:to_s).select { |column| column_names.include?(column) }.map(&:to_sym)
+    end
+
+    def text_attribute(model, attribute)
+      mysql = %w[Mysql2 Trilogy].include?(model.connection.adapter_name)
+      store = model.stored_attributes.find { |_column, fields| fields.include?(attribute.to_sym) }
+      expression =
+        if store
+          column = model.arel_table[store.first]
+          if mysql
+            path = Arel::Nodes.build_quoted("$.#{attribute.to_s.to_json}")
+            value = Arel::Nodes::NamedFunction.new("JSON_EXTRACT", [column, path])
+            Arel::Nodes::NamedFunction.new("JSON_UNQUOTE", [value])
+          else
+            Arel::Nodes::InfixOperation.new("->>", column, Arel::Nodes.build_quoted(attribute.to_s))
+          end
+        else
+          model.arel_table[attribute]
+        end
+      model.arel_table.cast(expression, mysql ? "CHAR" : "text")
     end
 
     def search_pattern

data/lib/terrazzo/version.rb

@@ -1,3 +1,3 @@
 module Terrazzo
-  VERSION = "0.7.3"
+  VERSION = "0.7.5"
 end

data/terrazzo.gemspec

@@ -31,6 +31,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "rails", ">= 7.1"
+  # Current Rails releases require the JSON 2 argument format.
+  # Remove this limit after released Rails versions include rails/rails#58601.
+  spec.add_dependency "json", "~> 2.0"
   spec.add_dependency "kaminari", "~> 1.2"
   spec.add_dependency "superglue", "~> 1.1"
   spec.add_dependency "form_props", ">= 0.0.6"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: terrazzo
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.7.5
 platform: ruby
 authors:
 - Terrazzo Contributors
@@ -23,6 +23,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: kaminari
   requirement: !ruby/object:Gem::Requirement