stretchy-model 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a955580b683d3dc991c7a1f92a5a9508fd10a4f9e8a116c2c92150ae4fdd43a3
-  data.tar.gz: 30262c4a0d4e8d5e43a74ab707b3e501d8e5e627be16600687526885b4520cf3
+  metadata.gz: a85f7bffcc11c54366d4cae7fec47b91341425e06b7f1c8a6269e0b23d4e649b
+  data.tar.gz: cd0b9314fa734aa7af7179f12ed00626a17bc869186f82088158bfca87c8d915
 SHA512:
-  metadata.gz: ce944998d1e6ae225f85fa7ecbccea8f940e3fcee99c8450b79f89b3138bedcddec7b69d62de8285983c21dbc4dc068c4fa42157d94484065a8948c118c9bd95
-  data.tar.gz: 465d02c93b645b480bc4e627d4323d557ab6574dbefc2efc83de453aa246d38785ccb09cebf8d651e3f345d68e851e1197f32314bec84d13a379320dc468c3eb
+  metadata.gz: e193c837695100177eac9888841b14243596dfc9694515696ab1a9934174287c821cf52b2ca165e3f3eda04de9ba16c7c7330cb187641d71229d322c06674977
+  data.tar.gz: 21ace7b64f85d505a05b61b89b5b85d9d2af34941b57672da45f70e6c8736e8b9451c59891fef7d0795f8b54076cffd88bfc141fcd4da1c1f8ffaddcf8276697

data/README.md

@@ -1,4 +1,4 @@
-stretchy
+stretchy-model
 ===
 
 <p>
@@ -112,11 +112,37 @@ Blanket (6.322ms) curl -X GET 'http://localhost:9200/blankets/_search?size=1' -d
 
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add stretchy
+    $ bundle add stretchy-model
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install stretchy
+    $ gem install stretchy-model
+
+<details>
+<summary>Rails Configuration</summary>
+
+
+
+```sh
+rails credentials:edit
+```
+
+#### Add elasticsearch credentials
+```yaml
+elasticsearch:
+   url: localhost:9200
+```
+
+#### Create an initializer 
+<p><sub><em>config/initializers/stretchy.rb</em></sub></p>
+
+```ruby {file=config/initializers/stretchy.rb}
+Stretchy.configure do |config|
+    config.client = Elasticsearch::Client.new url: Rails.application.credentials.elasticsearch.url, log: true
+end
+```
+</details>
+
 
 ## Development
 
@@ -128,6 +154,10 @@ After checking out the repo, run `bin/setup` to install dependencies. You can al
 > Full documentation on [Elasticsearch Query DSL and Aggregation options](https://github.com/elastic/elasticsearch-rails/tree/main/elasticsearch-persistence)
 
 ## Testing
+<details>
+<summary>Elasticsearch</summary>
+
+
 ```
 docker-compose up elasticsearch
 ```
@@ -136,6 +166,21 @@ docker-compose up elasticsearch
 bundle exec rspec
 ```
 
+</details>
+
+<details>
+<summary>Opensearch</summary>
+
+
+```
+docker-compose up opensearch
+```
+
+```
+ENV['BACKEND']=opensearch bundle rspec 
+```
+</details>
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/theablefew/stretchy. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/theablefew/stretchy/blob/master/CODE_OF_CONDUCT.md).

data/lib/rails/instrumentation/publishers.rb

@@ -14,7 +14,7 @@ module Rails
                 end
 
                 def search_with_instrumentation!(query_or_definition, options={})
-                    ActiveSupport::Notifications.instrument "search.elasticsearch", 
+                    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

data/lib/rails/instrumentation/railtie.rb

@@ -2,27 +2,21 @@ module Stretchy
   module Instrumentation
 
     class Railtie < ::Rails::Railtie
-      include ActionView::Helpers::NumberHelper
-      def time_diff(start, finish)
-        begin
-          ((finish.to_time - start.to_time) * 1000).to_s(:rounded, precision: 5, strip_insignificant_zeros: true)
-        rescue
-          number_with_precision((finish.to_time - start.to_time) * 1000, precision: 5, strip_insignificant_zeros: true)
-        end
-      end
 
-      ActiveSupport::Notifications.subscribe 'query.elasticsearch' do |name, start, finish, id, payload|
-        ::Rails.logger.debug(["  #{payload[:name]}".bright, "(#{time_diff(start,finish)}ms)",payload[:query]].join(" ").color(:yellow))
-      end
+      require 'rails/instrumentation/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])
+        ].join(" ")
+        ::Rails.logger.debug(Rainbow(message).color(:yellow))
+     end
 
-      ActiveSupport::Notifications.subscribe 'cache.query.elasticsearch' do |name, start, finish, id, payload|
-        ::Rails.logger.debug(["  #{payload[:name]}".bright, "CACHE".color(:mediumpurple).bright ,"(#{time_diff(start,finish)}ms)", payload[:query]].join(" ").color(:yellow))
-      end
-
-      initializer 'stretchy.set_defaults' do
-        config.elasticsearch_cache_store = :redis_store
-        config.elasticsearch_expire_cache_in = 15.minutes
-      end
+      # initializer 'stretchy.set_defaults' do
+      #   config.elasticsearch_cache_store = :redis_store
+      #   config.elasticsearch_expire_cache_in = 15.minutes
+      # end
 
     end
   end

data/lib/stretchy/delegation/gateway_delegation.rb

@@ -33,7 +33,7 @@ module Stretchy
       end
 
       def gateway(&block)
-          @gateway ||= Stretchy::Repository.create(index_name: index_name, klass: base_class)
+          @gateway ||= Stretchy::Repository.create(client: Stretchy.configuration.client, index_name: index_name, klass: base_class)
           block.arity < 1 ? @gateway.instance_eval(&block) : block.call(@gateway) if block_given?
           @gateway
       end

data/lib/stretchy/open_search_compatibility.rb

@@ -0,0 +1,86 @@
+module Stretchy
+    module OpenSearchCompatibility
+    extend ActiveSupport::Concern
+
+        # Patches the Elasticsearch::Persistence::Repository::Search module to remove the 
+        # document type from the request for compatability with OpenSearch
+        def self.opensearch_patch!
+            patch = Module.new do
+                def search(query_or_definition, options={})
+                    request = { index: index_name }
+            
+                    if query_or_definition.respond_to?(:to_hash)
+                        request[:body] = query_or_definition.to_hash
+                    elsif query_or_definition.is_a?(String)
+                        request[:q] = query_or_definition
+                    else
+                        raise ArgumentError, "[!] Pass the search definition as a Hash-like object or pass the query as a String" +
+                            " -- #{query_or_definition.class} given."
+                    end
+            
+                    Elasticsearch::Persistence::Repository::Response::Results.new(self, client.search(request.merge(options)))
+                end
+
+                def count(query_or_definition=nil, options={})
+                    query_or_definition ||= { query: { match_all: {} } }
+                    request = { index: index_name}
+          
+                    if query_or_definition.respond_to?(:to_hash)
+                      request[:body] = query_or_definition.to_hash
+                    elsif query_or_definition.is_a?(String)
+                      request[:q] = query_or_definition
+                    else
+                      raise ArgumentError, "[!] Pass the search definition as a Hash-like object or pass the query as a String" +
+                          " -- #{query_or_definition.class} given."
+                    end
+          
+                    client.count(request.merge(options))['count']
+                end
+            end
+
+            store = Module.new do
+                def save(document, options={})
+                serialized = serialize(document)
+                id = __get_id_from_document(serialized)
+                request = { index: index_name,
+                            id: id,
+                            body: serialized }
+                client.index(request.merge(options))
+              end
+      
+
+              def update(document_or_id, options = {})
+                if document_or_id.is_a?(String) || document_or_id.is_a?(Integer)
+                  id = document_or_id
+                  body = options
+                else
+                  document = serialize(document_or_id)
+                  id = __extract_id_from_document(document)
+                  if options[:script]
+                    body = options
+                  else
+                    body = { doc: document }.merge(options)
+                  end
+                end
+                client.update(index: index_name, id: id, body: body)
+              end
+      
+              def delete(document_or_id, options = {})
+                if document_or_id.is_a?(String) || document_or_id.is_a?(Integer)
+                  id = document_or_id
+                else
+                  serialized = serialize(document_or_id)
+                  id = __get_id_from_document(serialized)
+                end
+                client.delete({ index: index_name, id: id }.merge(options))
+              end
+            end
+
+
+            ::Elasticsearch::Persistence::Repository.send(:include, patch)
+            ::Elasticsearch::Persistence::Repository.send(:include, store)
+        end
+
+
+    end
+end

data/lib/stretchy/scoping/scope_registry.rb

@@ -6,20 +6,20 @@ module Stretchy
 
             VALID_SCOPE_TYPES = [:current_scope, :ignore_default_scope]
 
-            def initialize
-                @registry = Hash.new { |hash, key| hash[key] = {} }
-            end
+            # def initialize
+                self.registry = Hash.new { |hash, key| hash[key] = {} }
+            # end
 
             # Obtains the value for a given +scope_name+ and +variable_name+.
-            def value_for(scope_type, variable_name)
+            def self.value_for(scope_type, variable_name)
                 raise_invalid_scope_type!(scope_type)
-                @registry[scope_type][variable_name]
+                self.registry[scope_type][variable_name]
             end
 
             # Sets the +value+ for a given +scope_type+ and +variable_name+.
-            def set_value_for(scope_type, variable_name, value)
+            def self.set_value_for(scope_type, variable_name, value)
                 raise_invalid_scope_type!(scope_type)
-                @registry[scope_type][variable_name] = value
+                self.registry[scope_type][variable_name] = value
             end
 
             private

data/lib/stretchy/scoping.rb

@@ -13,13 +13,13 @@ module Stretchy
       end
 
       def current_scope
-          # ScopeRegistry.new.registry[:current_scope][base_class.to_s]
-          ScopeRegistry.new.value_for(:current_scope, base_class.to_s)
+          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.new.set_value_for(:current_scope, base_class.to_s, scope)
+        ScopeRegistry.new.registry[:current_scope][base_class.to_s] = scope
+        # ScopeRegistry.set_value_for(:current_scope, base_class.to_s, scope)
       end
     end
 

data/lib/stretchy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Stretchy
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

data/lib/stretchy.rb

@@ -3,10 +3,8 @@ require 'zeitwerk'
 require 'amazing_print'
 require 'rainbow'
 require 'jbuilder'
-# require 'elasticsearch/rails'
 require 'elasticsearch/model'
 require 'elasticsearch/persistence'
-# require 'active_support/concern' 
 require 'active_model'
 require 'active_support/all'
 require 'active_model/type/array'
@@ -16,21 +14,57 @@ ActiveModel::Type.register(:array, ActiveModel::Type::Array)
 ActiveModel::Type.register(:hash, ActiveModel::Type::Hash)
 
 require_relative "stretchy/version"
-require_relative "stretchy/instrumentation/railtie" if defined?(Rails)
+require_relative "rails/instrumentation/railtie" if defined?(Rails)
 
 module Stretchy
   module Errors
     class QueryOptionMissing < StandardError; end
   end
 
+  class Configuration
+
+    attr_accessor :client
+    attr_accessor :opensearch
+
+    def initialize
+        @client = Elasticsearch::Client.new url: 'http://localhost:9200'
+        @opensearch = false
+    end
+
+    def client=(client)
+        @client = client
+        self.opensearch = true if @client.class.name =~ /OpenSearch/
+    end
+
+    def opensearch=(bool)
+        @opensearch = bool
+        OpenSearchCompatibility.opensearch_patch! if bool
+    end
+
+    def opensearch?
+        @opensearch
+    end
+
+  end
+
   class << self
     def logger
       @logger ||= Logger.new(STDOUT)
     end
+
+    def configuration
+        @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield configuration
+    end
   end
 
 end
 
+
+
 loader = Zeitwerk::Loader.new
 loader.tag = File.basename(__FILE__, ".rb")
 loader.inflector = Zeitwerk::GemInflector.new(__FILE__)

data/stretchy-model/lib/stretchy-model.rb

@@ -0,0 +1 @@
+require_relative "../../lib/stretchy" 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stretchy-model
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Spencer Markowski
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-04 00:00:00.000000000 Z
+date: 2024-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -28,42 +28,42 @@ dependencies:
   name: elasticsearch-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '7.1'
 - !ruby/object:Gem::Dependency
   name: elasticsearch-persistence
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '7.1'
 - !ruby/object:Gem::Dependency
   name: elasticsearch-model
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '7.1'
 - !ruby/object:Gem::Dependency
@@ -164,6 +164,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.36
+- !ruby/object:Gem::Dependency
+  name: opensearch-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: Provides a familiar ActiveRecord-like interface for working with Elasticsearch
 email:
 - spencer.markowski@theablefew.com
@@ -197,6 +211,7 @@ files:
 - 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/querying.rb
 - lib/stretchy/record.rb
@@ -217,6 +232,7 @@ files:
 - lib/stretchy/utils.rb
 - lib/stretchy/version.rb
 - sig/stretchy.rbs
+- stretchy-model/lib/stretchy-model.rb
 - stretchy.logo.png
 homepage: https://github.com/theablefew/stretchy
 licenses:
@@ -229,6 +245,7 @@ post_install_message:
 rdoc_options: []
 require_paths:
 - lib
+- stretchy-model/lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="