stretchy-model 0.6.0 → 0.6.6

data/lib/stretchy/model/persistence.rb

@@ -0,0 +1,144 @@
+module Stretchy
+    module Model
+        module Persistence
+            extend ActiveSupport::Concern
+
+            class_methods do
+                # Create a new instance and save it to the database.
+                #
+                # This class method is used to create a new instance of the model and save it to the database. It accepts a list of keyword attributes to set on the new instance.
+                #
+                # ### Parameters
+                #
+                # - `*args:` A list of keyword arguments representing the attributes to set on the new instance.
+                #
+                # ### Returns
+                # Returns the newly created instance of the model.
+                #
+                # ---
+                #
+                # ### Examples
+                #
+                # #### Create a new instance
+                #
+                # ```ruby
+                #   Model.create(name: 'John Doe', age: 30)
+                # ```
+                #
+                def create(*args)
+                    self.new(*args).save
+                end
+            end
+
+            # Save the current instance to the database.
+            #
+            # This instance method is used to save the current instance of the model to the database. If the instance is a new record, it runs the `:create` callbacks and saves the instance to the database. It then sets the `id` of the instance to the `_id` returned by the save operation.
+            #
+            # ### Returns
+            # Returns the `id` of the saved instance.
+            #
+            # ---
+            #
+            # ### Examples
+            #
+            # #### Save an instance
+            #
+            # ```ruby
+            #   model = Model.new(name: 'John Doe', age: 30)
+            #   model.save
+            # ```
+            #
+            def save
+                run_callbacks :save do
+                    if new_record?
+                        run_callbacks :create do
+                            response = self.class.gateway.save(self.attributes)
+                            self.id = response['_id']
+                        end
+                    else
+                        self.class.gateway.save(self.attributes)
+                    end
+                    self
+                end
+            end
+
+            # Destroy the current instance.
+            #
+            # This instance method is used to delete the current instance of the model from the database. 
+            # It differs from delete in that it runs the `:destroy` callbacks before deleting the instance.
+            # 
+            #
+            # ### Returns
+            # Returns `true` if the instance was successfully deleted, `false` otherwise.
+            #
+            # ---
+            #
+            # ### Examples
+            #
+            # #### Delete an instance
+            #
+            # ```ruby
+            #   model = Model.find(id: '1')
+            #   model.destroy
+            # ```
+            #
+            def destroy
+                run_callbacks :destroy do
+                    delete
+                end
+            end
+
+            # Delete the current instance from the database.
+            #
+            # This instance method is used to delete the current instance of the model from the database. It uses the `id` of the instance to perform the delete operation.
+            #
+            # ### Returns
+            # Returns `true` if the instance was successfully deleted, `false` otherwise.
+            #
+            # ---
+            #
+            # ### Examples
+            #
+            # #### Delete an instance
+            #
+            # ```ruby
+            #   model = Model.find(id: '1')
+            #   model.delete
+            # ```
+            #
+            def delete
+                self.class.gateway.delete(self.id)["result"] == 'deleted'
+            end
+
+            # Update the current instance with the given attributes and save it to the database.
+            #
+            # This instance method is used to update the current instance of the model with the given attributes and save it to the database. It accepts a list of keyword arguments representing the attributes to update.
+            #
+            # ### Parameters
+            #
+            # - `*args:` A list of keyword arguments representing the attributes to update.
+            #
+            # ### Returns
+            # Returns `true` if the instance was successfully updated, `false` otherwise.
+            #
+            # ---
+            #
+            # ### Examples
+            #
+            # #### Update an instance
+            #
+            # ```ruby
+            #   model = Model.find(id: '1')
+            #   model.update(name: 'Jane Doe', age: 32)
+            # ```
+            #
+            def update(*args)
+                run_callbacks :update do
+                    self.assign_attributes(*args)
+                    self.save
+                end
+            end
+
+        end
+    end
+end

data/lib/stretchy/model/refreshable.rb

@@ -0,0 +1,26 @@
+module Stretchy
+  module Model
+    # Adds callbacks to the model to refresh the index after save or destroy.
+    #
+    # ```ruby
+    # included do
+    #   after_save :refresh_index
+    #   after_destroy :refresh_index
+    # end
+    # ```
+    module Refreshable
+      extend ActiveSupport::Concern
+
+      
+      included do
+        after_save :refresh_index
+        after_destroy :refresh_index
+      end
+
+      def refresh_index
+        self.class.refresh_index!
+      end
+
+    end
+  end
+end

data/lib/stretchy/open_search_compatibility.rb

@@ -1,3 +1,5 @@
+require 'opensearch/api/namespace/machine_learning/model'
+
 module Stretchy
     module OpenSearchCompatibility
     extend ActiveSupport::Concern
@@ -79,6 +81,8 @@ module Stretchy
 
             ::Elasticsearch::Persistence::Repository.send(:include, patch)
             ::Elasticsearch::Persistence::Repository.send(:include, store)
+            OpenSearch::API.send(:include, OpenSearch::API::MachineLearning::Models)
+
         end
 
 

data/lib/stretchy/pipeline.rb

@@ -0,0 +1,124 @@
+module Stretchy
+  class Pipeline
+    cattr_reader :client do 
+      Stretchy.configuration.client.ingest 
+    end
+
+    class << self
+      attr_accessor :description, :pipeline_name, :processors
+
+      def pipeline_name(name = nil)
+        return @pipeline_name if name.nil? && @pipeline_name
+        @pipeline_name = name || self.name.split('::').last.underscore
+      end
+
+      def description(desc = nil)
+        @description = desc if desc
+        @description
+      end
+
+      def processor(type, opts = {})
+        @processors ||= []
+        @processors << Stretchy::Pipelines::Processor.new(type, opts)
+      end
+
+      def all
+        begin
+          client.get_pipeline
+        rescue not_found => e
+          return {}
+        end
+      end
+    
+      def find(id=nil)
+        id = self.pipeline_name if id.nil?
+        client.get_pipeline(id: id)
+      end
+
+      def simulate(docs, verbose: true)
+        client.simulate(id: self.pipeline_name, body: {docs: docs}, verbose: verbose)
+      end
+
+      # PUT _ingest/pipeline/<pipeline-name>
+      def create!
+        client.put_pipeline(id: self.pipeline_name, body: self.to_hash)
+      end
+
+      # DELETE _ingest/pipeline/<pipeline-name>
+      def delete!
+        client.delete_pipeline(id: self.pipeline_name)
+      end
+
+      def exists?
+        begin
+          self.find(self.pipeline_name).present?
+        rescue not_found => e
+          return false
+        end
+      end
+
+
+      def to_hash
+        {
+          description: self.description,
+          processors: self.processors.map(&:to_hash)
+        }.as_json
+      end
+
+      protected 
+      def not_found
+        @not_found ||= Object.const_get("#{client.class.name.split('::').first}::Transport::Transport::Errors::NotFound") 
+      end
+
+    end
+
+    attr_accessor :description, :pipeline_name, :processors
+
+    def initialize
+      @description = self.class.description
+      @pipeline_name = self.class.pipeline_name
+      @processors = self.class.processors
+    end
+
+    # GET _ingest/pipeline/<pipeline-name>
+    def find
+      self.class.find(self.pipeline_name)
+    end
+
+    # Simulates the pipeline.
+    #
+    # Request body fields
+    #
+    # The following table lists the request body fields used to run a pipeline.
+    #
+    # Field	Required	Type	Description
+    # docs	Required	Array	The documents to be used to test the pipeline.
+    # pipeline	Optional	Object	The pipeline to be simulated. If the pipeline identifier is not included, then the response simulates the latest pipeline created.
+    # The docs field can include subfields listed in the following table.
+    #
+    # Field	Required	Type	Description
+    # source	Required	Object	The document’s JSON body.
+    # id	Optional	String	A unique document identifier. The identifier cannot be used elsewhere in the index.
+    # index	Optional	String	The index where the document’s transformed data appears.
+    def simulate(docs, verbose: true)
+      self.class.simulate(docs, verbose: verbose)
+    end
+    
+    def exists?
+      self.class.exists?
+    end
+
+    def to_hash
+      {
+        description: self.description,
+        processors: self.processors.map(&:to_hash)
+      }.as_json
+    end
+
+    def client
+      @client ||= Stretchy.configuration.client.ingest
+    end
+
+
+  end
+end

data/lib/stretchy/pipelines/processor.rb

@@ -0,0 +1,57 @@
+module Stretchy::Pipelines
+  # Creates a new processor for a pipeline
+  # 
+  # Below is a list of processors that can be used in a pipeline. Each processor has a specific function that can be applied to a document.
+  # 
+  # For more information on processors, see the [Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest-processors.html).
+  # or [OpenSearch](https://opensearch.org/docs/latest/ingest-pipelines/processors/index-processors/) documentation.
+  #
+  # | type | Description |
+  # | --- | --- |
+  # | append | Adds one or more values to a field in a document. |
+  # | bytes | Converts a human-readable byte value to its value in bytes. |
+  # | convert | Changes the data type of a field in a document. |
+  # | copy | Copies an entire object in an existing field to another field. |
+  # | csv | Extracts CSVs and stores them as individual fields in a document. |
+  # | date | Parses dates from fields and then uses the date or timestamp as the timestamp for a document. |
+  # | date_index_name | Indexes documents into time-based indexes based on a date or timestamp field in a document. |
+  # | dissect | Extracts structured fields from a text field using a defined pattern. |
+  # | dot_expander | Expands a field with dots into an object field. |
+  # | drop | Drops a document without indexing it or raising any errors. |
+  # | fail | Raises an exception and stops the execution of a pipeline. |
+  # | foreach | Allows for another processor to be applied to each element of an array or an object field in a document. |
+  # | geoip | Adds information about the geographical location of an IP address. |
+  # | geojson-feature | Indexes GeoJSON data into a geospatial field. |
+  # | grok | Parses and structures unstructured data using pattern matching. |
+  # | gsub | Replaces or deletes substrings within a string field of a document. |
+  # | html_strip | Removes HTML tags from a text field and returns the plain text content. |
+  # | ip2geo | Adds information about the geographical location of an IPv4 or IPv6 address. |
+  # | join | Concatenates each element of an array into a single string using a separator character between each element. |
+  # | json | Converts a JSON string into a structured JSON object. |
+  # | kv | Automatically parses key-value pairs in a field. |
+  # | lowercase | Converts text in a specific field to lowercase letters. |
+  # | pipeline | Runs an inner pipeline. |
+  # | remove | Removes fields from a document. |
+  # | script | Runs an inline or stored script on incoming documents. |
+  # | set | Sets the value of a field to a specified value. |
+  # | sort | Sorts the elements of an array in ascending or descending order. |
+  # | sparse_encoding | Generates a sparse vector/token and weights from text fields for neural sparse search using sparse retrieval. |
+  # | split | Splits a field into an array using a separator character. |
+  # | text_embedding | Generates vector embeddings from text fields for semantic search. |
+  # | text_image_embedding | Generates combined vector embeddings from text and image fields for multimodal neural search. |
+
+  class Processor
+    
+    attr_reader :type, :opts, :description
+
+    def initialize(type, opts = {})
+      @type = type
+      @description = opts[:description]
+      @opts = opts
+    end
+
+    def to_hash
+      { type => @opts }
+    end
+  end
+end

data/lib/stretchy/querying.rb

@@ -1,12 +1,13 @@
 module Stretchy
   module Querying
-    delegate :first, :first!, :last, :last!, :exists?, :has_field, :any?, :many?, to: :all
-    delegate :order, :limit, :size, :sort, :rewhere, :eager_load, :includes,  :create_with, :none, :unscope, to: :all
-    delegate :or_filter, :fields, :source, :highlight, to: :all
-    delegate *Stretchy::Relations::AggregationMethods::AGGREGATION_METHODS, to: :all
+    delegate :exists?, :any?, :many?, :includes, to: :all
+    delegate :rewhere, :eager_load, :create_with, :unscoped, to: :all
+
+    delegate *Stretchy::Relations::FinderMethods::METHODS, to: :all
+    delegate *Stretchy::Relations::SearchOptionMethods::METHODS, to: :all
+    delegate *Stretchy::Relations::QueryMethods.registry, to: :all
+    delegate *Stretchy::Relations::AggregationMethods.registry, to: :all
 
-    delegate :skip_callbacks, :routing, :search_options, to: :all
-    delegate :must, :must_not, :should, :where_not, :where, :filter_query, :query_string, :regexp, to: :all
 
     def fetch_results(es)
       if es.count?
@@ -16,6 +17,5 @@ module Stretchy
       end
     end
 
-
   end
 end

data/lib/stretchy/rails/instrumentation/publishers.rb

@@ -0,0 +1,31 @@
+module Stretchy
+    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
+end

data/lib/{rails → stretchy/rails}/instrumentation/railtie.rb

@@ -3,17 +3,21 @@ module Stretchy
 
     class Railtie < ::Rails::Railtie
 
-      require 'rails/instrumentation/publishers'
-      Stretchy.instrument!
+      require_relative 'publishers'
 
       ActiveSupport::Notifications.subscribe 'search.stretchy' do |name, start, finish, id, payload|
         message = [
-           Rainbow("  #{payload[:klass]}").bright, 
-           "(#{(finish.to_time - start.to_time).round(2)}ms)",
-           Stretchy::Utils.to_curl(payload[:klass].constantize, payload[:search])
+            Rainbow("  #{payload[:klass]}").bright, 
+            "(#{(finish.to_time - start.to_time).round(2)}ms)",
+            Stretchy::Utils.to_curl(payload[:klass].constantize, payload[:search])
         ].join(" ")
         ::Rails.logger.debug(Rainbow(message).color(:yellow))
-     end
+      end
+
+      
+      initializer 'stretchy.instrumentation' do
+        Stretchy.instrument!
+      end
 
       # initializer 'stretchy.set_defaults' do
       #   config.elasticsearch_cache_store = :redis_store
@@ -21,5 +25,6 @@ module Stretchy
       # end
 
     end
+
   end
 end

data/lib/stretchy/record.rb

@@ -16,12 +16,12 @@ module Stretchy
                 include ActiveModel::Serializers::JSON
 
                 include Stretchy::Model::Callbacks
+                include Stretchy::Model::Common
+                include Stretchy::Model::Persistence
+                include Stretchy::Model::Refreshable
                 include Stretchy::Indexing::Bulk
-                include Stretchy::Persistence
                 include Stretchy::Associations 
-                include Stretchy::Refreshable
-                include Stretchy::Common
-                include Stretchy::Scoping
+                include Stretchy::Relations::Scoping
                 include Stretchy::Utils
                 include Stretchy::SharedScopes
                 include Stretchy::Attributes
@@ -46,6 +46,7 @@ module Stretchy
                 def initialize(attributes = {})
                     @highlights = attributes.delete(:_highlights) 
                     super(attributes)
+                    run_callbacks :initialize 
                 end
 
             end