jay_api 28.2.0 → 28.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60468cdd7dbfd248e2ca373126f6d3f3a0e9c0d23d169a7e9d98aebe9de3d91d
-  data.tar.gz: 58ad9adc3a1f77139660338f213a9c835d935fc7a968f5971fe900904c1ba649
+  metadata.gz: 07ffb602dd7c52159b2142a00f06401d0326ae8e82e05ba24c61f96d35347d8c
+  data.tar.gz: 7f0f39ca31de378467d2914e3322fd83f6fad7a0b2185a30c94582d213d04439
 SHA512:
-  metadata.gz: 9a4c5a8ee131631eb7220b2c2cbf5eb4d9a081b3a0d817647c09d4027311629b78262b35707d8288418da5395d5bebdea11855d9a7f81b81f3d2566cc6156852
-  data.tar.gz: f596eeb92e9cecc97ffd2dccb9e93a2dfcf82524bd9bbed43b86ff2d3e60b011e6d9239923b2a4030ea1f0ab67c644028c3178c483de40455c2058c311e38e88
+  metadata.gz: 8bc9fc4c9631aac5a504600ccabd68ff875e7027682f83b47830608a6578cc7a73702333be180b4dd9c7b5d9d637c32b1ef6d86a6519ba5ef8a40706b0a5d397
+  data.tar.gz: 290b96e8925ee9bbff77e469bdd8299291317639dfd37ea345e1fb88e608c45b1d799015dd6d94592a300e24a97d1aab34df7de4a3ebb8c7ef014b4a09b2e2ed

data/CHANGELOG.md

@@ -8,6 +8,12 @@ Please mark backwards incompatible changes with an exclamation mark at the start
 
 ## [Unreleased]
 
+## [28.3.0] - 2025-06-05
+
+### Added
+- The `Aggregations::Composite` class and the `Aggregations#composite` method.
+  They make it possible to use Elasticsearch's `composite` aggregations.
+
 ## [28.2.0] - 2025-05-30
 
 ### Added

data/lib/jay_api/elasticsearch/query_builder/aggregations/composite.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'active_support/core_ext/string/inflections'
+
+require_relative 'aggregation'
+require_relative 'sources/sources'
+require_relative 'errors/aggregations_error'
+
+module JayAPI
+  module Elasticsearch
+    class QueryBuilder
+      class Aggregations
+        # Represents a Composite aggregation in Elasticsearch. For more
+        # information about this type of aggregation:
+        # @see https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-composite-aggregation
+        class Composite < ::JayAPI::Elasticsearch::QueryBuilder::Aggregations::Aggregation
+          attr_reader :size
+
+          # @param [String] name The name of the composite aggregation.
+          # @param [Integer] size The number of composite buckets to return.
+          # @yieldparam [JayAPI::Elasticsearch::QueryBuilder::Aggregations::Sources::Sources]
+          #   The collection of sources for the composite aggregation. This
+          #   should be used by the caller to add sources to the composite
+          #   aggregation.
+          # @raise [JayAPI::Elasticsearch::QueryBuilder::Aggregations::Errors::AggregationsError]
+          #   If the method is called without a block.
+          def initialize(name, size: nil, &block)
+            unless block
+              raise(::JayAPI::Elasticsearch::QueryBuilder::Aggregations::Errors::AggregationsError,
+                    "The #{self.class.name.demodulize} aggregation must be initialized with a block")
+            end
+
+            super(name)
+            @size = size
+            block.call(sources)
+          end
+
+          # @return [self] A copy of the receiver. Sources and nested
+          #   aggregations are also cloned.
+          def clone
+            # rubocop:disable Lint/EmptyBlock (The sources will be assigned later)
+            copy = self.class.new(name, size: size) {}
+            # rubocop:enable Lint/EmptyBlock
+
+            copy.aggregations = aggregations.clone
+            copy.sources = sources.clone
+            copy
+          end
+
+          # @return [Hash] The Hash representation of the +Aggregation+.
+          #   Properly formatted for Elasticsearch.
+          def to_h
+            super do
+              {
+                composite: {
+                  sources: sources.to_a,
+                  size: size
+                }.compact
+              }
+            end
+          end
+
+          protected
+
+          attr_writer :sources # Used by the #clone method
+
+          # @return [JayAPI::Elasticsearch::QueryBuilder::Aggregations::Sources::Sources]
+          #   The collection of sources of the composite aggregation.
+          def sources
+            @sources ||= ::JayAPI::Elasticsearch::QueryBuilder::Aggregations::Sources::Sources.new
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jay_api/elasticsearch/query_builder/aggregations/sources/sources.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative 'terms'
+
+module JayAPI
+  module Elasticsearch
+    class QueryBuilder
+      class Aggregations
+        module Sources
+          # Represents the collection of sources for a Composite aggregation in
+          # Elasticsearch
+          class Sources
+            # Adds a +terms+ source to the collection.
+            # For information about the parameters:
+            # @see Sources::Terms#initialize
+            def terms(name, **kw_args)
+              sources.push(::JayAPI::Elasticsearch::QueryBuilder::Aggregations::Sources::Terms.new(name, **kw_args))
+            end
+
+            # @return [Array<Hash>] Array representation of the collection of
+            #   sources of the composite aggregation.
+            def to_a
+              sources.map(&:to_h)
+            end
+
+            # @return [self] A copy of the receiver (not a shallow clone, it
+            #   clones all of the elements of the collection).
+            def clone
+              self.class.new.tap do |copy|
+                copy.sources.concat(sources.map(&:clone))
+              end
+            end
+
+            protected
+
+            # @return [Array<Object>] The array used to hold the collection of
+            #   sources.
+            def sources
+              @sources ||= []
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jay_api/elasticsearch/query_builder/aggregations/sources/terms.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module JayAPI
+  module Elasticsearch
+    class QueryBuilder
+      class Aggregations
+        module Sources
+          # Represents a "Terms" value source for a Composite aggregation.
+          # More information about this type of value source can be found here:
+          # https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-composite-aggregation#_terms
+          class Terms
+            attr_reader :name, :field, :order, :missing_bucket, :missing_order
+
+            # @param [String] name The name for the value source.
+            # @param [String] field The field for the value source.
+            # @param [String, nil] order The order in which the values coming
+            #   from this data source should be ordered, this can be either
+            #   "asc" or "desc"
+            # @param [Boolean] missing_bucket Whether or not a bucket for the
+            #   documents without a value in +field+ should be created.
+            # @param [String] missing_order Where to put the bucket for the
+            #   documents with a missing value, either "first" or "last".
+            def initialize(name, field:, order: nil, missing_bucket: nil, missing_order: nil)
+              @name = name
+              @field = field
+              @order = order
+              @missing_bucket = missing_bucket
+              @missing_order = missing_order
+            end
+
+            # @return [self] A copy of the receiver.
+            def clone
+              self.class.new(
+                name, field: field, order: order, missing_bucket: missing_bucket, missing_order: missing_order
+              )
+            end
+
+            # @return [Hash] The hash representation for the value source.
+            def to_h
+              {
+                name => {
+                  terms: {
+                    field: field,
+                    order: order,
+                    missing_bucket: missing_bucket,
+                    missing_order: missing_order
+                  }.compact
+                }
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jay_api/elasticsearch/query_builder/aggregations.rb

@@ -5,6 +5,7 @@ require 'forwardable'
 require_relative 'aggregations/aggregation'
 require_relative 'aggregations/avg'
 require_relative 'aggregations/cardinality'
+require_relative 'aggregations/composite'
 require_relative 'aggregations/date_histogram'
 require_relative 'aggregations/filter'
 require_relative 'aggregations/scripted_metric'
@@ -121,6 +122,16 @@ module JayAPI
           )
         end
 
+        # Adds a +composite+ aggregation. For more information about the parameters:
+        # @see JayAPI::Elasticsearch::QueryBuilder::Aggregations::Composite#initialize
+        def composite(name, size: nil, &block)
+          add(
+            ::JayAPI::Elasticsearch::QueryBuilder::Aggregations::Composite.new(
+              name, size: size, &block
+            )
+          )
+        end
+
         # Returns a Hash with the correct format for the current list of
         # aggregations. For example:
         #

data/lib/jay_api/version.rb

@@ -2,5 +2,5 @@
 
 module JayAPI
   # JayAPI gem's semantic version
-  VERSION = '28.2.0'
+  VERSION = '28.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jay_api
 version: !ruby/object:Gem::Version
-  version: 28.2.0
+  version: 28.3.0
 platform: ruby
 authors:
 - Accenture-Industry X
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-30 00:00:00.000000000 Z
+date: 2025-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -140,12 +140,15 @@ files:
 - lib/jay_api/elasticsearch/query_builder/aggregations/aggregation.rb
 - lib/jay_api/elasticsearch/query_builder/aggregations/avg.rb
 - lib/jay_api/elasticsearch/query_builder/aggregations/cardinality.rb
+- lib/jay_api/elasticsearch/query_builder/aggregations/composite.rb
 - lib/jay_api/elasticsearch/query_builder/aggregations/date_histogram.rb
 - lib/jay_api/elasticsearch/query_builder/aggregations/errors.rb
 - lib/jay_api/elasticsearch/query_builder/aggregations/errors/aggregations_error.rb
 - lib/jay_api/elasticsearch/query_builder/aggregations/filter.rb
 - lib/jay_api/elasticsearch/query_builder/aggregations/max.rb
 - lib/jay_api/elasticsearch/query_builder/aggregations/scripted_metric.rb
+- lib/jay_api/elasticsearch/query_builder/aggregations/sources/sources.rb
+- lib/jay_api/elasticsearch/query_builder/aggregations/sources/terms.rb
 - lib/jay_api/elasticsearch/query_builder/aggregations/sum.rb
 - lib/jay_api/elasticsearch/query_builder/aggregations/terms.rb
 - lib/jay_api/elasticsearch/query_builder/aggregations/top_hits.rb