like_query 1.1.3 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 297ae578b2ec61ff9cdd4363d0a7b26ddb8c13a0eefe43ea7463df17e011ad65
-  data.tar.gz: 0ab590550b4ab5d6b9e95ae60f2be91a26000305f719bc2a623f8048c92c8e5b
+  metadata.gz: f8b7d1785a26770724244a95ae4d5aba9b8dcf7f3ea55792960025d02ff4afb0
+  data.tar.gz: '0988e85f08d02bf75339646f522050ff2cda511c2940168a7eec449070844d73'
 SHA512:
-  metadata.gz: ee197191e1b279d7a78184d5e09a3752b60733f653503626eded6405ca11bf4d6100aee347691badbb4ea53537b3e331419548c4eb0f47077bf6a7a09c083d5f
-  data.tar.gz: 056d94f302fc8ac219c4cb08817c020d3a0d34ad406c385a6e4251d8ebc6d792be2129ff121ec033c10858e873ef147d6f4ec9f91930e6898feeb35148340a66
+  metadata.gz: 89f5a4610db824380444956b705c2363e13b93f464501b25a204b4e0b4154dd72883b23bfce4bf3ae6cdab9505d73d1f0e96e283634ef27872c13ca06d611988
+  data.tar.gz: '081009a472c7fb3245dc98a55222222f0e1f7b1595497ef5c15325cc70a9c27f351497e596f6053961fc98921b9bdd94f3d72823ded1d03f0bc0151e9074139e'

data/lib/like_query/collect.rb

@@ -1,5 +1,8 @@
 module LikeQuery
   class Collect
+
+    # Initializes the collector. Sets global result limit (falls back to Rails config),
+    # and prepares internal state for data, schemas, images, and URLs.
     def initialize(limit = nil)
       if limit
         @limit = limit
@@ -21,13 +24,31 @@ module LikeQuery
       @no_action = {}
     end
 
+    # Pre-registers a schema, URL, and no_action flag for a given model class.
+    # Use before collect when the model won't be the primary query target (e.g. parent records).
     def set_schema(model, schema = nil, url: nil, no_action: false)
       @schemes[model.to_s] = schema_to_hash(schema)
       @urls[model.to_s] = url if url
       @no_action[model.to_s] = no_action
     end
 
-    def collect(output_schema = nil, limit: nil, parent: nil, image: nil, url: nil, &block)
+    # Queries records and adds them to the result set for AutoSelect.svelte.
+    #
+    # @param output_schema [Array<Symbol>, nil] Columns shown as +rec.values+ in the dropdown table.
+    #   Also included in +rec.attributes+ (named). Supports dot-notation and Hash form.
+    # @param extra_attributes [Array<Symbol>] Extra model columns/methods added only to +rec.attributes+
+    #   (not displayed in the table, but returned to the caller on row click).
+    # @param limit [Integer, nil] Per-call result cap. Bounded by the global limit from {#initialize}.
+    # @param parent [Symbol, nil] A +belongs_to+ association name. Groups child records under their
+    #   parent row (+rec.children+). Requires the parent schema to be set via {#set_schema}.
+    # @param image [Symbol, nil] Method name on the record that returns an image URL (+rec.image+).
+    # @param url [Proc, nil] +proc { |record| path(record) }+ — result stored as +rec.url+.
+    # @yield Block must return an ActiveRecord relation (the query).
+    # @return [Boolean] +false+ if the global limit is already reached, +true+ otherwise.
+    #
+    # @example Basic usage
+    #   c.collect([:title, :number], extra_attributes: [:id_code]) { MyModel.like(f, [:title]) }
+    def collect(output_schema = nil, extra_attributes: [], limit: nil, parent: nil, image: nil, url: nil, &block)
 
       _limit = (limit ? (@limit && @limit < limit ? @limit : limit) : @limit)
       return false if @length >= _limit
@@ -69,7 +90,7 @@ module LikeQuery
 
           if parent
             parent_record = rec.send(parent)
-            r = record_to_hash(rec, schema, image, parent_record, url: _url)
+            r = record_to_hash(rec, schema, image, parent_record, url: _url, extra_attributes: extra_attributes)
             parent_class_name = parent_record.class.to_s
             parent_key = "#{parent_class_name}#{parent_record.id}"
 
@@ -85,7 +106,7 @@ module LikeQuery
             @data[parent_key][:children] ||= []
             @data[parent_key][:children].push(r)
           else
-            r = record_to_hash(rec, schema, image, url: _url)
+            r = record_to_hash(rec, schema, image, url: _url, extra_attributes: extra_attributes)
             @data["#{rec.class}#{rec.id}"] = r
           end
           c = (@image ? 1 : 0) + r[:values].to_a.length
@@ -98,6 +119,8 @@ module LikeQuery
       true
     end
 
+    # Returns the full result hash for JSON serialization.
+    # Includes data records, total count, overflow flag, column counts, and elapsed time.
     def generate_hash
       data = @data.map { |_, v| v }
       {
@@ -112,13 +135,17 @@ module LikeQuery
       }
     end
 
+    # Serializes generate_hash to a JSON string.
     def generate_json
       generate_hash.to_json
     end
 
     private
 
-    def record_to_hash(record, schema, image, parent = nil, url: nil)
+    # Converts a single record to the hash structure consumed by AutoSelect.svelte.
+    # rec.values  - ordered array of display values (shown as table columns)
+    # rec.attributes - named hash of the same values + extra_attributes (returned on row click)
+    def record_to_hash(record, schema, image, parent = nil, url: nil, extra_attributes: [])
       r = {}
       schema[:values].each do |k|
         v = get_column_value(record, k)
@@ -127,6 +154,10 @@ module LikeQuery
         r[:attributes] ||= {}
         r[:attributes][k] = v
       end
+      extra_attributes.each do |k|
+        r[:attributes] ||= {}
+        r[:attributes][k] = get_column_value(record, k)
+      end
       r[:id] = record.id
       if parent
         r[:model] = "#{parent.class.to_s}.#{record.class}"
@@ -140,6 +171,7 @@ module LikeQuery
       r
     end
 
+    # Normalizes schema input (String, Symbol, Array, Hash) into { values: [...], image: ... }.
     def schema_to_hash(schema)
 
       if schema.is_a?(Array) && schema.first.is_a?(Array)
@@ -177,6 +209,8 @@ module LikeQuery
       end
     end
 
+    # Reads a column value from a record. Supports dot-notation ("assoc.attr")
+    # and Hash form ({ assoc: [:a, :b] }) for joining multiple association attributes.
     def get_column_value(record, column)
       val = nil
       if column.is_a?(Hash)
@@ -204,4 +238,4 @@ module LikeQuery
     end
 
   end
-end
+end

data/lib/like_query/version.rb

@@ -1,3 +1,3 @@
 module LikeQuery
-  VERSION = "1.1.3"
+  VERSION = "1.1.4"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: like_query
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.1.4
 platform: ruby
 authors:
 - christian
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-06 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -61,7 +60,6 @@ metadata:
   homepage_uri: https://gitlab.com/sedl/like_query
   source_code_uri: https://gitlab.com/sedl/like_query
   changelog_uri: https://gitlab.com/sedl/like_query
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -76,8 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 4.0.4
 specification_version: 4
 summary: helper for building active record calls.
 test_files: []