jay_api 28.4.0 → 29.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1af59670e04b1508c6773538b8d9d0478f1971e80755ea526012eaa44f4717c
-  data.tar.gz: d23445b944fd8ef0cea8fd628536132fe2cd024ec315b286223b08ecb2c57452
+  metadata.gz: 1f1153d9c1260eec0e2b267dbf5ea63074c388f5a72ee4473013322e380388aa
+  data.tar.gz: 3e329829a95831222b1d5111de202b1d0a4160b22889f549e81bde8f4c072b10
 SHA512:
-  metadata.gz: f6805dc6330cdb960f50af2321112572f9959da7789e02c2810231df24b7a5176686754bb488234e4f64659dbdbdc078985564e5987780cd66e93aaca0e5d0e4
-  data.tar.gz: ad80fac10a256c1ff8061cc6822fe9d89763e86f9e710cf0b9e7a8f103f864d4dfd24051c90727fb7fc664a0251503a97515beb1d2cd890b3a4cd43a50066490
+  metadata.gz: 87460d91ba4fcee072ce01d7b4d9a71d926cf6c1d6a02aa5cb1d8fda8e6ed1e09d510de9e411d980594ee22991a420abf784c60eface6e9d9fa51f1e9563ddf1
+  data.tar.gz: 6e64661a3fe9cd20cb9f437e3310d5ccd6ac85d8931a681d571224bec564a51c738a7a198d054b40c8effa2af2514423f64985acdcad8994d2ee89f98df047b6

data/CHANGELOG.md

@@ -8,6 +8,21 @@ Please mark backwards incompatible changes with an exclamation mark at the start
 
 ## [Unreleased]
 
+## [29.1.0] - 2025-10-22
+
+### Added
+- The `#bool` method to the `QueryBuilder::QueryClauses::Bool` class. This
+  allows boolean clauses to be nested.
+- `QueryBuilder#sort` can now receive either the direction of the sorting (`asc`
+  or `desc`) or a `Hash` with advanced sorting options. These are relayed
+  directly to Elasticsearch. 
+
+## [29.0.0] - 2025-08-28
+
+### Changed
+- ! Updated the `git` dependency from `~> 1, >= 1.8.0-1` to `~> 3`.
+- ! Increased the minimum Ruby version requirement to 3.1.0
+
 ## [28.4.0] - 2025-08-26
 
 ### Added

data/README.md

@@ -5,8 +5,8 @@ while abstracting internal implementations.
 
 ## Requirements
 
-* Ruby >= 2.7.0
-* Bundler ~> 2, < 2.5.0
+* Ruby >= 3.1.0
+* Bundler ~> 2
 
 ## Setup
 

data/jay_api.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/esrlabs/jay_api'
   spec.license       = 'Apache-2.0'
 
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 3.1.0')
 
   spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'activesupport', '~> 7'
   spec.add_runtime_dependency 'concurrent-ruby', '~> 1'
   spec.add_runtime_dependency 'elasticsearch', '~> 7', '<= 7.9.0'
-  spec.add_runtime_dependency 'git', '~> 1', '>= 1.8.0-1'
+  spec.add_runtime_dependency 'git', '~> 3'
   spec.add_runtime_dependency 'logging', '~> 2'
   spec.add_runtime_dependency 'rspec', '~> 3.0'
 end

data/lib/jay_api/elasticsearch/query_builder/query_clauses/bool.rb

@@ -61,6 +61,19 @@ module JayAPI
             add_boolean_clause(:must_not, &block)
           end
 
+          # Adds a nested +Boolean+ clause to the receiver. For this to work the
+          # receiver must have an active sub-clause (for example +must+).
+          # @yield [JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Bool]
+          #   Yields the nested boolean clause to the given block.
+          # @return [JayAPI::Elasticsearch::QueryBuilder::QueryClauses::Bool]
+          #   Returns the nested boolean clause.
+          def bool(&block)
+            nested_bool = self.class.new
+            self << nested_bool
+            block&.call(nested_bool)
+            nested_bool
+          end
+
           # Adds a clause to the current sub-clause of the boolean clause.
           # @param [JayAPI::Elasticsearch::QueryBuilder::QueryClauses::QueryClause]
           #   query_clause The query clause to add.

data/lib/jay_api/elasticsearch/query_builder.rb

@@ -64,13 +64,22 @@ module JayAPI
       #   query_builder.sort(age: 'desc')
       #
       # Both will produce the same +sort+ clause.
+      #
+      # It is also possible to pass a Hash with advanced sorting options, for
+      # example:
+      #
+      #   query_builder.sort(price: { order: :desc, missing: :_last })
+      #
       # @param [Hash] sort A Hash whose keys are the name of the fields
-      #   and the keys are the direction of the sorting, either +asc+ or
-      #   +desc+.
+      #   and whose values are either the direction of the sorting (+:asc+ or
+      #   +:desc+) or a Hash with advanced sort options.
+      # @see https://www.elastic.co/docs/reference/elasticsearch/rest-apis/sort-search-results
       # @return [QueryBuilder] itself so that other methods can be chained.
       def sort(sort)
         check_argument(sort, 'sort', Hash)
-        @sort.merge!(sort)
+        @sort.merge!(
+          sort.transform_values { |value| value.is_a?(Hash) ? value : { order: value } }
+        )
         self
       end
 
@@ -184,11 +193,7 @@ module JayAPI
         query_hash[:_source] = @source unless @source.nil?
         query_hash[:query] = query.to_h
 
-        if @sort.any?
-          query_hash[:sort] = @sort.map do |field, direction|
-            { field => { order: direction } }
-          end
-        end
+        query_hash[:sort] = @sort.map { |field, ordering| { field => ordering } } if @sort.any?
 
         if @collapse
           query_hash[:collapse] = {

data/lib/jay_api/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jay_api
 version: !ruby/object:Gem::Version
-  version: 28.4.0
+  version: 29.1.0
 platform: ruby
 authors:
 - Accenture-Industry X
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-08-26 00:00:00.000000000 Z
+date: 2025-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -65,20 +65,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.8.0.pre.1
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.8.0.pre.1
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: logging
   requirement: !ruby/object:Gem::Requirement
@@ -218,14 +212,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.27
 signing_key:
 specification_version: 4
 summary: A collection of classes and modules to access JAY's functionality