stretchy-model 0.6.5 → 0.6.6

data/lib/stretchy/relations/scoping/default.rb

@@ -0,0 +1,136 @@
+module Stretchy
+  module Relations
+    module Scoping
+      module Default
+        extend ActiveSupport::Concern
+
+        included do
+          # Stores the default scope for the class.
+          class_attribute :default_scopes, instance_writer: false, instance_predicate: false
+
+          self.default_scopes = []
+        end
+
+        module ClassMethods
+          # Returns a scope for the model without the previously set scopes.
+          #
+          #   class Post < ActiveRecord::Base
+          #     def self.default_scope
+          #       where published: true
+          #     end
+          #   end
+          #
+          #   Post.all                                  # Fires "SELECT * FROM posts WHERE published = true"
+          #   Post.unscoped.all                         # Fires "SELECT * FROM posts"
+          #   Post.where(published: false).unscoped.all # Fires "SELECT * FROM posts"
+          #
+          # This method also accepts a block. All queries inside the block will
+          # not use the previously set scopes.
+          #
+          #   Post.unscoped {
+          #     Post.limit(10) # Fires "SELECT * FROM posts LIMIT 10"
+          #   }
+          def unscoped
+            block_given? ? relation.scoping { yield } : relation
+          end
+
+          def before_remove_const #:nodoc:
+            self.current_scope = nil
+          end
+
+          protected
+
+          # Use this macro in your model to set a default scope for all operations on
+          # the model.
+          #
+          #   class Article < ActiveRecord::Base
+          #     default_scope { where(published: true) }
+          #   end
+          #
+          #   Article.all # => SELECT * FROM articles WHERE published = true
+          #
+          # The +default_scope+ is also applied while creating/building a record.
+          # It is not applied while updating a record.
+          #
+          #   Article.new.published    # => true
+          #   Article.create.published # => true
+          #
+          # (You can also pass any object which responds to +call+ to the
+          # +default_scope+ macro, and it will be called when building the
+          # default scope.)
+          #
+          # If you use multiple +default_scope+ declarations in your model then
+          # they will be merged together:
+          #
+          #   class Article < ActiveRecord::Base
+          #     default_scope { where(published: true) }
+          #     default_scope { where(rating: 'G') }
+          #   end
+          #
+          #   Article.all # => SELECT * FROM articles WHERE published = true AND rating = 'G'
+          #
+          # This is also the case with inheritance and module includes where the
+          # parent or module defines a +default_scope+ and the child or including
+          # class defines a second one.
+          #
+          # If you need to do more complex things with a default scope, you can
+          # alternatively define it as a class method:
+          #
+          #   class Article < ActiveRecord::Base
+          #     def self.default_scope
+          #       # Should return a scope, you can call 'super' here etc.
+          #     end
+          #   end
+          def default_scope(scope = nil)
+            scope = Proc.new if block_given?
+
+            if scope.is_a?(Relation) || !scope.respond_to?(:call)
+              raise ArgumentError,
+                "Support for calling #default_scope without a block is removed. For example instead " \
+                "of `default_scope where(color: 'red')`, please use " \
+                "`default_scope { where(color: 'red') }`. (Alternatively you can just redefine " \
+                "self.default_scope.)"
+            end
+
+            self.default_scopes += [scope]
+          end
+
+          def build_default_scope(base_rel = relation) # :nodoc:
+            if !self.is_a?(method(:default_scope).owner)
+              # The user has defined their own default scope method, so call that
+              evaluate_default_scope { default_scope }
+            elsif default_scopes.any?
+              evaluate_default_scope do
+                default_scopes.inject(base_rel) do |default_scope, scope|
+                  default_scope.merge(base_rel.scoping { scope.call })
+                end
+              end
+            end
+          end
+
+          def ignore_default_scope? # :nodoc:
+            ScopeRegistry.value_for(:ignore_default_scope, self)
+          end
+
+          def ignore_default_scope=(ignore) # :nodoc:
+            ScopeRegistry.set_value_for(:ignore_default_scope, self, ignore)
+          end
+
+          # The ignore_default_scope flag is used to prevent an infinite recursion
+          # situation where a default scope references a scope which has a default
+          # scope which references a scope...
+          def evaluate_default_scope # :nodoc:
+            return if ignore_default_scope?
+
+            begin
+              self.ignore_default_scope = true
+              yield
+            ensure
+              self.ignore_default_scope = false
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stretchy/relations/scoping/named.rb

@@ -0,0 +1,70 @@
+module Stretchy
+  module Relations
+    module Scoping
+      module Named
+        extend ActiveSupport::Concern
+
+        module ClassMethods
+          def all(options={})
+            if current_scope
+              current_scope.clone
+            else
+              default_scoped
+            end
+          end
+
+          def default_scoped # :nodoc:
+            relation.merge(build_default_scope)
+          end
+
+          # Collects attributes from scopes that should be applied when creating
+          # an AR instance for the particular class this is called on.
+          def scope_attributes # :nodoc:
+            all.scope_for_create
+          end
+
+          # Are there default attributes associated with this scope?
+          def scope_attributes? # :nodoc:
+            current_scope || default_scopes.any?
+          end
+
+          def scope(name, body, &block)
+            if dangerous_class_method?(name)
+              raise ArgumentError, "You tried to define a scope named \"#{name}\" " \
+                "on the model \"#{self.name}\", but there's already defined " \
+                "a class method with the same name."
+            end
+
+            extension = Module.new(&block) if block
+
+            singleton_class.send(:define_method, name) do |*args|
+              scope = all.scoping { body.call(*args) }
+              scope = scope.extending(extension) if extension
+
+              scope || all
+            end
+          end
+
+          BLACKLISTED_CLASS_METHODS = %w(private public protected allocate new name parent superclass)
+
+          private
+          def dangerous_class_method?(method_name)
+            BLACKLISTED_CLASS_METHODS.include?(method_name.to_s) || class_method_defined_within?(method_name, Model, self.superclass)
+          end
+
+          def class_method_defined_within?(name, klass, superklass = klass.superclass) # :nodoc
+            if klass.respond_to?(name, true)
+              if superklass.respond_to?(name, true)
+                klass.method(name).owner != superklass.method(name).owner
+              else
+                true
+              end
+            else
+              false
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stretchy/relations/scoping/scope_registry.rb

@@ -0,0 +1,36 @@
+module Stretchy
+    module Relations
+        module Scoping
+            class ScopeRegistry # :nodoc:
+                # extend ActiveSupport::PerThreadRegistry
+                thread_mattr_accessor :registry
+
+                VALID_SCOPE_TYPES = [:current_scope, :ignore_default_scope]
+
+                # def initialize
+                    self.registry = Hash.new { |hash, key| hash[key] = {} }
+                # end
+
+                # Obtains the value for a given +scope_name+ and +variable_name+.
+                def self.value_for(scope_type, variable_name)
+                    raise_invalid_scope_type!(scope_type)
+                    self.registry[scope_type][variable_name]
+                end
+
+                # Sets the +value+ for a given +scope_type+ and +variable_name+.
+                def self.set_value_for(scope_type, variable_name, value)
+                    raise_invalid_scope_type!(scope_type)
+                    self.registry[scope_type][variable_name] = value
+                end
+
+                private
+
+                def raise_invalid_scope_type!(scope_type)
+                    if !VALID_SCOPE_TYPES.include?(scope_type)
+                        raise ArgumentError, "Invalid scope type '#{scope_type}' sent to the registry. Scope types must be included in VALID_SCOPE_TYPES"
+                    end
+                end
+            end
+        end
+    end
+end

data/lib/stretchy/relations/scoping.rb

@@ -0,0 +1,30 @@
+module Stretchy
+  module Relations
+    module Scoping
+      extend ActiveSupport::Concern
+
+      included do
+        include Default
+        include Named
+      end
+
+      module ClassMethods
+        def base_class
+          self
+        end
+
+        def current_scope
+            ScopeRegistry.new.registry[:current_scope][base_class.to_s]
+            # ScopeRegistry.value_for(:current_scope, base_class.to_s)
+        end
+
+        def current_scope=(scope) #:nodoc:
+          ScopeRegistry.new.registry[:current_scope][base_class.to_s] = scope
+          # ScopeRegistry.set_value_for(:current_scope, base_class.to_s, scope)
+        end
+      end
+
+
+    end
+  end
+end

data/lib/stretchy/relations/search_option_methods.rb

@@ -4,6 +4,8 @@ module Stretchy
     module SearchOptionMethods
       extend ActiveSupport::Concern
 
+      METHODS = [:routing, :search_options]
+
       def routing(args)
         check_if_method_has_arguments!(:routing, args)
         spawn.routing!(args)

data/lib/stretchy/version.rb

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

data/lib/stretchy.rb

@@ -41,32 +41,39 @@ module Stretchy
 
   class Configuration
 
-    attr_accessor :client
-    attr_accessor :opensearch
+    attr_accessor :options
+
+    delegate_missing_to :@options
 
     def initialize
-        @client = Elasticsearch::Client.new url: 'http://localhost:9200'
-        @opensearch = false
+        @options = Hashie::Mash.new(
+          default_keyword_field: :keyword,
+          add_keyword_field_to_text_attributes: true,
+          auto_target_keywords: true,
+          opensearch: false,
+          client: Elasticsearch::Client.new(url: 'http://localhost:9200')
+        )
     end
 
-    def client=(client)
-        @client = client
-        self.opensearch = true if @client.class.name =~ /OpenSearch/
+    def client=(klient)
+        @options[:client] = klient
+        self.opensearch = true if klient.class.name =~ /OpenSearch/
     end
 
     def search_backend_const
-        @opensearch ? OpenSearch : Elasticsearch
+        self.opensearch? ? OpenSearch : Elasticsearch
     end
 
     def opensearch=(bool)
-        @opensearch = bool
+        @options[:opensearch] = bool
         OpenSearchCompatibility.opensearch_patch! if bool
     end
 
     def opensearch?
-        @opensearch
+        @options[:opensearch]
     end
 
+
   end
 
   class << self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stretchy-model
 version: !ruby/object:Gem::Version
-  version: 0.6.5
+  version: 0.6.6
 platform: ruby
 authors:
 - Spencer Markowski
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-20 00:00:00.000000000 Z
+date: 2024-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -151,33 +151,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.21.2
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: opensearch-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.36
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.36
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: opensearch-ruby
+  name: rdoc-markdown
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 0.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 0.4.2
 - !ruby/object:Gem::Dependency
   name: octokit
   requirement: !ruby/object:Gem::Requirement
@@ -220,6 +220,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.18'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.6.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.6.3
 description: Provides a familiar ActiveRecord-like interface for working with Elasticsearch
 email:
 - spencer.markowski@theablefew.com
@@ -238,6 +252,26 @@ files:
 - containers/Dockerfile.elasticsearch
 - containers/Dockerfile.opensearch
 - docker-compose.yml
+- docs/.nojekyll
+- docs/README.md
+- docs/_coverpage.md
+- docs/_sidebar.md
+- docs/examples/_sidebar.md
+- docs/examples/data_analysis.md
+- docs/examples/semantic_search_with_llm.md
+- docs/examples/simple-ingest-pipeline.md
+- docs/guides/_sidebar.md
+- docs/guides/aggregations.md
+- docs/guides/machine-learning.md
+- docs/guides/models.md
+- docs/guides/pipelines.md
+- docs/guides/querying.md
+- docs/guides/quick-start.md
+- docs/guides/scopes.md
+- docs/index.html
+- docs/stretchy.cover.png
+- docs/stretchy.logo.png
+- docs/styles.css
 - 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
@@ -278,6 +312,7 @@ files:
 - lib/stretchy/attributes/type/ip.rb
 - lib/stretchy/attributes/type/join.rb
 - lib/stretchy/attributes/type/keyword.rb
+- lib/stretchy/attributes/type/knn_vector.rb
 - lib/stretchy/attributes/type/match_only_text.rb
 - lib/stretchy/attributes/type/nested.rb
 - lib/stretchy/attributes/type/numeric/base.rb
@@ -309,36 +344,95 @@ files:
 - 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/index_setting.rb
 - lib/stretchy/indexing/bulk.rb
 - lib/stretchy/machine_learning/model.rb
 - lib/stretchy/model/callbacks.rb
+- lib/stretchy/model/common.rb
+- lib/stretchy/model/persistence.rb
+- lib/stretchy/model/refreshable.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
 - lib/stretchy/relations/aggregation_methods.rb
+- lib/stretchy/relations/aggregation_methods/aggregation.rb
+- lib/stretchy/relations/aggregation_methods/avg.rb
+- lib/stretchy/relations/aggregation_methods/bucket_script.rb
+- lib/stretchy/relations/aggregation_methods/bucket_selector.rb
+- lib/stretchy/relations/aggregation_methods/bucket_sort.rb
+- lib/stretchy/relations/aggregation_methods/cardinality.rb
+- lib/stretchy/relations/aggregation_methods/children.rb
+- lib/stretchy/relations/aggregation_methods/composite.rb
+- lib/stretchy/relations/aggregation_methods/date_histogram.rb
+- lib/stretchy/relations/aggregation_methods/date_range.rb
+- lib/stretchy/relations/aggregation_methods/extended_stats.rb
+- lib/stretchy/relations/aggregation_methods/filter.rb
+- lib/stretchy/relations/aggregation_methods/filters.rb
+- lib/stretchy/relations/aggregation_methods/geo_bounds.rb
+- lib/stretchy/relations/aggregation_methods/geo_centroid.rb
+- lib/stretchy/relations/aggregation_methods/global.rb
+- lib/stretchy/relations/aggregation_methods/histogram.rb
+- lib/stretchy/relations/aggregation_methods/ip_range.rb
+- lib/stretchy/relations/aggregation_methods/max.rb
+- lib/stretchy/relations/aggregation_methods/min.rb
+- lib/stretchy/relations/aggregation_methods/missing.rb
+- lib/stretchy/relations/aggregation_methods/nested.rb
+- lib/stretchy/relations/aggregation_methods/percentile_ranks.rb
+- lib/stretchy/relations/aggregation_methods/percentiles.rb
+- lib/stretchy/relations/aggregation_methods/range.rb
+- lib/stretchy/relations/aggregation_methods/reverse_nested.rb
+- lib/stretchy/relations/aggregation_methods/sampler.rb
+- lib/stretchy/relations/aggregation_methods/scripted_metric.rb
+- lib/stretchy/relations/aggregation_methods/significant_terms.rb
+- lib/stretchy/relations/aggregation_methods/stats.rb
+- lib/stretchy/relations/aggregation_methods/sum.rb
+- lib/stretchy/relations/aggregation_methods/terms.rb
+- lib/stretchy/relations/aggregation_methods/top_hits.rb
+- lib/stretchy/relations/aggregation_methods/top_metrics.rb
+- lib/stretchy/relations/aggregation_methods/value_count.rb
+- lib/stretchy/relations/aggregation_methods/weighted_avg.rb
 - lib/stretchy/relations/finder_methods.rb
 - lib/stretchy/relations/merger.rb
+- lib/stretchy/relations/null_relation.rb
 - lib/stretchy/relations/query_builder.rb
 - lib/stretchy/relations/query_methods.rb
+- lib/stretchy/relations/query_methods/bind.rb
+- lib/stretchy/relations/query_methods/extending.rb
+- lib/stretchy/relations/query_methods/fields.rb
+- lib/stretchy/relations/query_methods/filter_query.rb
+- lib/stretchy/relations/query_methods/has_field.rb
+- lib/stretchy/relations/query_methods/highlight.rb
+- lib/stretchy/relations/query_methods/hybrid.rb
+- lib/stretchy/relations/query_methods/ids.rb
+- lib/stretchy/relations/query_methods/match.rb
+- lib/stretchy/relations/query_methods/must_not.rb
+- lib/stretchy/relations/query_methods/neural.rb
+- lib/stretchy/relations/query_methods/neural_sparse.rb
+- lib/stretchy/relations/query_methods/none.rb
+- lib/stretchy/relations/query_methods/or_filter.rb
+- lib/stretchy/relations/query_methods/order.rb
+- lib/stretchy/relations/query_methods/query_string.rb
+- lib/stretchy/relations/query_methods/regexp.rb
+- lib/stretchy/relations/query_methods/should.rb
+- lib/stretchy/relations/query_methods/size.rb
+- lib/stretchy/relations/query_methods/skip_callbacks.rb
+- lib/stretchy/relations/query_methods/source.rb
+- lib/stretchy/relations/query_methods/where.rb
+- lib/stretchy/relations/scoping.rb
+- lib/stretchy/relations/scoping/default.rb
+- lib/stretchy/relations/scoping/named.rb
+- lib/stretchy/relations/scoping/scope_registry.rb
 - lib/stretchy/relations/search_option_methods.rb
 - lib/stretchy/relations/spawn_methods.rb
 - lib/stretchy/repository.rb
-- lib/stretchy/scoping.rb
-- lib/stretchy/scoping/default.rb
-- lib/stretchy/scoping/named.rb
-- lib/stretchy/scoping/scope_registry.rb
 - lib/stretchy/shared_scopes.rb
 - lib/stretchy/utils.rb
 - lib/stretchy/version.rb
@@ -369,7 +463,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Rails ORM for Elasticsearch

data/lib/stretchy/common.rb

@@ -1,38 +0,0 @@
-module Stretchy
-    module Common
-        extend ActiveSupport::Concern
-
-        def highlights_for(attribute)
-            highlights[attribute.to_s]
-        end
-
-        class_methods do
-
-            # Set the default sort key to be used in sort operations
-            #
-            def default_sort_key(field = nil)
-                @default_sort_key = field unless field.nil?
-                @default_sort_key
-            end
-
-            def default_size(size = nil)
-                @default_size = size unless size.nil?
-                @default_size
-            end
-
-            def default_pipeline(pipeline = nil)
-                @default_pipeline = pipeline.to_s unless pipeline.nil?
-                @default_pipeline
-            end
-
-            private
-
-            # Return a Relation instance to chain queries
-            #
-            def relation
-                Relation.create(self, {})
-            end
-
-        end
-    end
-end

data/lib/stretchy/null_relation.rb

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-module Stretchy
-  module NullRelation # :nodoc:
-    def pluck(*column_names)
-      []
-    end
-
-    def delete_all
-      0
-    end
-
-    def update_all(_updates)
-      0
-    end
-
-    def delete(_id_or_array)
-      0
-    end
-
-    def empty?
-      true
-    end
-
-    def none?
-      true
-    end
-
-    def any?
-      false
-    end
-
-    def one?
-      false
-    end
-
-    def many?
-      false
-    end
-
-    def exists?(_conditions = :none)
-      false
-    end
-
-    def or(other)
-      other.spawn
-    end
-
-    def exec_queries
-      @records = OpenStruct.new(klass: NullRelation, total: 0, results: []).freeze
-    end
-  end
-end