stretchy-model 0.5.0 → 0.6.5

data/lib/stretchy/record.rb

@@ -30,7 +30,7 @@ module Stretchy
                 extend Stretchy::Querying
 
                 # Set up common attributes
-                attribute :id, :string #, default: lambda { SecureRandom.uuid }
+                attribute :id, :keyword #, default: lambda { SecureRandom.uuid }
                 attribute :created_at, :datetime, default: lambda {  Time.now.utc }
                 attribute :updated_at, :datetime, default: lambda { Time.now.utc }
 

data/lib/stretchy/relation.rb

@@ -28,7 +28,7 @@ module Stretchy
         # @param values [Hash] The initial values for the relation.
         def initialize(klass, values={})
             @klass  = klass
-            @values = values
+            @values = values.merge(default_size: klass.default_size)
             @offsets = {}
             @loaded = false
         end
@@ -147,6 +147,7 @@ module Stretchy
             "#<#{self.class.name} #{message.join(', ')}>"
           rescue StandardError => e
             e
+            raise e
           end
         end
 

data/lib/stretchy/relations/finder_methods.rb

@@ -39,14 +39,31 @@ module Stretchy
           self
         end
 
+        # size is not permitted to the count API but queries are.
+        #
+        # if a query is supplied with `.count` then the user wants a count of the results
+        # matching the query
+        #  
+        # however, the default_size is used to limit the number of results returned
+        # so we remove the size from the query and then call `.count` API
+        #
+        # but if the user supplies a limit, then we should assume they want a count of the results
+        # which could lead to some confusion 
+        # suppose the user calls `.size(100).count` and the default_size is 100
+        # if we remove size from the query, then the count could be greater than 100
+        # 
+        # I think the best way to handle this is to remove the size from the query only if it was  
+        # applied by the default_size
+        # If the user supplies a limit, then we should assume they want a count of the results
+        # 
+        # if size is called with a limit,
         def count
-          return results.count if @loaded
+          return results.count if @loaded || @values[:size].present?
           spawn.count!
         end
 
         def count!
           @values[:count] = true
-          @values.delete(:size)
           spawned = spawn
           spawned.order_values.clear
           spawned.results

data/lib/stretchy/relations/query_builder.rb

@@ -2,11 +2,12 @@ module Stretchy
   module Relations
     class QueryBuilder
 
-      attr_reader :structure, :values, :attribute_types
+      attr_reader :structure, :values, :attribute_types, :default_size
 
       def initialize(values, attribute_types = nil)
         @attribute_types = attribute_types
         @structure = Jbuilder.new ignore_nil: true
+        @default_size = values.delete(:default_size)
         @values = values
       end
 
@@ -30,6 +31,18 @@ module Stretchy
         @query_string ||= compact_where(values[:query_string], bool: false)
       end
 
+      def neural_sparse
+        @neural_sparse ||= values[:neural_sparse]
+      end
+
+      def neural
+        @neural ||= values[:neural]
+      end
+
+      def hybrid
+        @hybrid ||= values[:hybrid]
+      end
+
       def must_nots
         @must_nots ||= compact_where(values[:must_not])
       end
@@ -103,9 +116,68 @@ module Stretchy
         query_filters.nil? && or_filters.nil?
       end
 
+      def missing_neural?
+        neural_sparse.nil? && neural.nil? && hybrid.nil?
+      end
+
+      def no_query?
+        missing_bool_query? && missing_query_string? && missing_query_filter? && missing_neural?
+      end
+
       def build_query
-        return if missing_bool_query? && missing_query_string? && missing_query_filter?
+        return if no_query?
         structure.query do
+
+          structure.hybrid do
+            structure.queries do
+                hybrid[:neural].each do |n|
+                  structure.child! do
+                    params = n.dup
+                    field_name, query_text = params.shift
+                    structure.neural do
+                      structure.set! field_name do
+                        structure.query_text query_text
+                        structure.extract! params, *params.keys
+                      end
+                    end
+                  end
+                end
+
+                hybrid[:query].each do |query|
+                  structure.child! do
+                    structure.extract! query, *query.keys
+                  end
+                end
+
+            end
+          end unless hybrid.nil?
+
+          structure.neural_sparse do
+            neural_sparse.each do |args|
+              params = args.dup
+              field_name, query_text = params.shift
+              structure.set! field_name do
+                structure.query_text query_text
+                structure.extract! params, *params.keys
+              end
+            end
+          end unless neural_sparse.blank?
+
+          structure.neural do
+            neural.each do |args|
+              params = args.dup
+              field_name, query = params.shift
+              structure.set! field_name do
+                if query.is_a?(Hash)
+                  structure.extract! query, *query.keys
+                else
+                  structure.query_text query
+                end
+                structure.extract! params, *params.keys
+              end
+            end
+          end unless neural.blank?
+
           structure.regexp do
             build_regexp unless regexes.nil?
           end
@@ -120,12 +192,11 @@ module Stretchy
 
           end unless missing_bool_query? && missing_query_filter?
 
-
-
           structure.query_string do
             structure.extract! query_string_options, *query_string_options.keys
             structure.query query_strings
           end unless query_strings.nil?
+
         end.with_indifferent_access
       end
 
@@ -208,6 +279,11 @@ module Stretchy
       end
 
       def extra_search_options
+        unless self.count?
+          values[:size] = size.present? ? size : values[:default_size]
+        else 
+          values[:size] = nil
+        end
         [:size].inject(Hash.new) { |h,k| h[k] = self.send(k) unless self.send(k).nil?; h}
       end
 

data/lib/stretchy/relations/query_methods.rb

@@ -19,6 +19,9 @@ module Stretchy
         :or_filter,
         :extending,
         :skip_callbacks,
+        :neural_sparse,
+        :neural,
+        :hybrid,
         :regexp
       ]
 
@@ -231,6 +234,35 @@ module Stretchy
       # @see #where
       alias :must :where
 
+
+      concerning :Neural do
+        def neural_sparse(opts)
+          spawn.neural_sparse!(opts)
+        end
+
+        def neural_sparse!(opts) # :nodoc:
+          self.neural_sparse_values += [opts]
+          self
+        end
+
+        def neural(opts)
+          spawn.neural!(opts)
+        end
+
+        def neural!(opts) # :nodoc:
+          self.neural_values += [opts]
+          self
+        end
+
+        def hybrid(opts)
+          spawn.hybrid!(opts)
+        end
+
+        def hybrid!(opts) # :nodoc:
+          self.hybrid_values += [opts]
+          self
+        end
+      end
       # Adds a regexp condition to the query.
       # 
       # @param field [Hash] the field to filter by and the Regexp to match

data/lib/stretchy/scoping/named.rb

@@ -8,7 +8,7 @@ module Stretchy
           if current_scope
             current_scope.clone
           else
-            default_scoped.size(default_size)
+            default_scoped
           end
         end
 

data/lib/stretchy/shared_scopes.rb

@@ -4,7 +4,12 @@ module Stretchy
 
         included do
 
-            scope :between, ->(range, range_field = "created_at") { filter_query(:range, range_field => {gte: range.begin, lte: range.end}) }
+            scope :between, ->(range, range_field = "created_at") do
+                range_options = {gte: range.begin}
+                upper_bound = range.exclude_end? ? :lt : :lte
+                range_options[upper_bound] = range.end
+                filter_query(:range, range_field => range_options)
+            end
             scope :using_time_based_indices, lambda { |range| search_options(index: time_based_indices(range)) }
 
         end

data/lib/stretchy/version.rb

@@ -1,3 +1,3 @@
 module Stretchy
-  VERSION = '0.5.0'
+  VERSION = '0.6.5'
 end

data/lib/stretchy.rb

@@ -9,9 +9,8 @@ require 'active_model'
 require 'active_support/all'
 
 require_relative "stretchy/version"
-require_relative "rails/instrumentation/railtie" if defined?(Rails)
-
-
+require_relative "stretchy/rails/instrumentation/railtie" if defined?(Rails)
+require_relative 'elasticsearch/api/namespace/machine_learning/model'
 
 module Stretchy
 
@@ -21,15 +20,21 @@ module Stretchy
       loader.tag = File.basename(__FILE__, ".rb")
       loader.inflector = Zeitwerk::GemInflector.new(__FILE__)
       loader.push_dir(__dir__)
+      loader.inflector.inflect("ip" => "IP")
       loader
     end
   end
 
   def self.boot!
     loader.setup
+    Elasticsearch::API.send(:include, Elasticsearch::API::MachineLearning::Models)
     Stretchy::Attributes.register!
   end
 
+  def self.instrument!
+    Stretchy::Delegation::GatewayDelegation.send(:include, Rails::Instrumentation::Publishers::Record)
+  end
+
   module Errors
     class QueryOptionMissing < StandardError; end
   end
@@ -49,6 +54,10 @@ module Stretchy
         self.opensearch = true if @client.class.name =~ /OpenSearch/
     end
 
+    def search_backend_const
+        @opensearch ? OpenSearch : Elasticsearch
+    end
+
     def opensearch=(bool)
         @opensearch = bool
         OpenSearchCompatibility.opensearch_patch! if bool

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stretchy-model
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.5
 platform: ruby
 authors:
 - Spencer Markowski
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-14 00:00:00.000000000 Z
+date: 2024-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -206,6 +206,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.18'
 description: Provides a familiar ActiveRecord-like interface for working with Elasticsearch
 email:
 - spencer.markowski@theablefew.com
@@ -224,8 +238,24 @@ files:
 - containers/Dockerfile.elasticsearch
 - containers/Dockerfile.opensearch
 - docker-compose.yml
-- lib/rails/instrumentation/publishers.rb
-- lib/rails/instrumentation/railtie.rb
+- lib/elasticsearch/api/actions/machine_learning/models/delete_model.rb
+- lib/elasticsearch/api/actions/machine_learning/models/deploy.rb
+- lib/elasticsearch/api/actions/machine_learning/models/get_model.rb
+- lib/elasticsearch/api/actions/machine_learning/models/get_status.rb
+- lib/elasticsearch/api/actions/machine_learning/models/params_registry.rb
+- lib/elasticsearch/api/actions/machine_learning/models/register.rb
+- lib/elasticsearch/api/actions/machine_learning/models/undeploy.rb
+- lib/elasticsearch/api/actions/machine_learning/models/update_model.rb
+- lib/elasticsearch/api/namespace/machine_learning/model.rb
+- lib/opensearch/api/actions/machine_learning/models/delete_model.rb
+- lib/opensearch/api/actions/machine_learning/models/deploy.rb
+- lib/opensearch/api/actions/machine_learning/models/get_model.rb
+- lib/opensearch/api/actions/machine_learning/models/get_status.rb
+- lib/opensearch/api/actions/machine_learning/models/params_registry.rb
+- lib/opensearch/api/actions/machine_learning/models/register.rb
+- lib/opensearch/api/actions/machine_learning/models/undeploy.rb
+- lib/opensearch/api/actions/machine_learning/models/update_model.rb
+- lib/opensearch/api/namespace/machine_learning/model.rb
 - lib/stretchy.rb
 - lib/stretchy/associations.rb
 - lib/stretchy/associations/associated_validator.rb
@@ -233,19 +263,67 @@ files:
 - lib/stretchy/attributes.rb
 - lib/stretchy/attributes/transformers/keyword_transformer.rb
 - lib/stretchy/attributes/type/array.rb
+- lib/stretchy/attributes/type/base.rb
+- lib/stretchy/attributes/type/binary.rb
+- lib/stretchy/attributes/type/boolean.rb
+- lib/stretchy/attributes/type/completion.rb
+- lib/stretchy/attributes/type/constant_keyword.rb
+- lib/stretchy/attributes/type/date_time.rb
+- lib/stretchy/attributes/type/dense_vector.rb
+- lib/stretchy/attributes/type/flattened.rb
+- lib/stretchy/attributes/type/geo_point.rb
+- lib/stretchy/attributes/type/geo_shape.rb
 - lib/stretchy/attributes/type/hash.rb
+- lib/stretchy/attributes/type/histogram.rb
+- lib/stretchy/attributes/type/ip.rb
+- lib/stretchy/attributes/type/join.rb
 - lib/stretchy/attributes/type/keyword.rb
+- lib/stretchy/attributes/type/match_only_text.rb
+- lib/stretchy/attributes/type/nested.rb
+- lib/stretchy/attributes/type/numeric/base.rb
+- lib/stretchy/attributes/type/numeric/byte.rb
+- lib/stretchy/attributes/type/numeric/double.rb
+- lib/stretchy/attributes/type/numeric/float.rb
+- lib/stretchy/attributes/type/numeric/half_float.rb
+- lib/stretchy/attributes/type/numeric/integer.rb
+- lib/stretchy/attributes/type/numeric/long.rb
+- lib/stretchy/attributes/type/numeric/scaled_float.rb
+- lib/stretchy/attributes/type/numeric/short.rb
+- lib/stretchy/attributes/type/numeric/unsigned_long.rb
+- lib/stretchy/attributes/type/percolator.rb
+- lib/stretchy/attributes/type/point.rb
+- lib/stretchy/attributes/type/range/base.rb
+- lib/stretchy/attributes/type/range/date_range.rb
+- lib/stretchy/attributes/type/range/double_range.rb
+- lib/stretchy/attributes/type/range/float_range.rb
+- lib/stretchy/attributes/type/range/integer_range.rb
+- lib/stretchy/attributes/type/range/ip_range.rb
+- lib/stretchy/attributes/type/range/long_range.rb
+- lib/stretchy/attributes/type/rank_feature.rb
+- lib/stretchy/attributes/type/rank_features.rb
+- lib/stretchy/attributes/type/search_as_you_type.rb
+- lib/stretchy/attributes/type/shape.rb
+- lib/stretchy/attributes/type/sparse_vector.rb
+- lib/stretchy/attributes/type/string.rb
 - lib/stretchy/attributes/type/text.rb
+- lib/stretchy/attributes/type/token_count.rb
+- lib/stretchy/attributes/type/version.rb
+- lib/stretchy/attributes/type/wildcard.rb
 - lib/stretchy/common.rb
 - lib/stretchy/delegation/delegate_cache.rb
 - lib/stretchy/delegation/gateway_delegation.rb
 - lib/stretchy/indexing/bulk.rb
+- lib/stretchy/machine_learning/model.rb
 - lib/stretchy/model/callbacks.rb
 - lib/stretchy/model/serialization.rb
 - lib/stretchy/null_relation.rb
 - lib/stretchy/open_search_compatibility.rb
 - lib/stretchy/persistence.rb
+- lib/stretchy/pipeline.rb
+- lib/stretchy/pipelines/processor.rb
 - lib/stretchy/querying.rb
+- lib/stretchy/rails/instrumentation/publishers.rb
+- lib/stretchy/rails/instrumentation/railtie.rb
 - lib/stretchy/record.rb
 - lib/stretchy/refreshable.rb
 - lib/stretchy/relation.rb
@@ -291,7 +369,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Rails ORM for Elasticsearch

data/lib/rails/instrumentation/publishers.rb

@@ -1,29 +0,0 @@
-module Rails
-    module Instrumentation
-        module Publishers
-
-            module Record 
-
-                extend ActiveSupport::Concern
-
-                included do
-                    unless method_defined?(:search_without_instrumentation!)
-                        alias_method :search_without_instrumentation!, :search
-                        alias_method :search, :search_with_instrumentation!
-                    end
-                end
-
-                def search_with_instrumentation!(query_or_definition, options={})
-                    ActiveSupport::Notifications.instrument "search.stretchy", 
-                      name: "Search", 
-                      klass: self.base_class.to_s,
-                      search: {index: self.index_name, body: query_or_definition }.merge(options) do
-                        search_without_instrumentation!(query_or_definition, options)
-                    end
-                end
-
-            end
-
-        end
-    end
-end