stretchy-model 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1709205b5fe75817fe79c5047b6f4d3531257cf8a3118f84d8fa4b92adb8932
-  data.tar.gz: 1add1b8c78f9c27362d31e0f1f8c141a429af4b6176b7d521e32e8a3e9230039
+  metadata.gz: a85f7bffcc11c54366d4cae7fec47b91341425e06b7f1c8a6269e0b23d4e649b
+  data.tar.gz: cd0b9314fa734aa7af7179f12ed00626a17bc869186f82088158bfca87c8d915
 SHA512:
-  metadata.gz: cf690ed5affe0224370f50e5208a6fcd0a91e611460fecf3f9a024464b0c87fa9b2718932fefca49c4ad9d587c4cc956b3490738fd794176f35d8f180dc16998
-  data.tar.gz: bc518187e999e3e989332612294ec8152bcc673fd5c025683e1170e8549491d8f8f3b578d4feb82a8fc4b564811f625eaae21fa5b754f0cd8fc7e36ae136c744
+  metadata.gz: e193c837695100177eac9888841b14243596dfc9694515696ab1a9934174287c821cf52b2ca165e3f3eda04de9ba16c7c7330cb187641d71229d322c06674977
+  data.tar.gz: 21ace7b64f85d505a05b61b89b5b85d9d2af34941b57672da45f70e6c8736e8b9451c59891fef7d0795f8b54076cffd88bfc141fcd4da1c1f8ffaddcf8276697

data/README.md

@@ -118,6 +118,32 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
     $ 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
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -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/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/version.rb

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

data/lib/stretchy.rb

@@ -24,9 +24,25 @@ module Stretchy
   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
@@ -45,9 +61,10 @@ module Stretchy
     end
   end
 
-
 end
 
+
+
 loader = Zeitwerk::Loader.new
 loader.tag = File.basename(__FILE__, ".rb")
 loader.inflector = Zeitwerk::GemInflector.new(__FILE__)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stretchy-model
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Spencer Markowski
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-05 00:00:00.000000000 Z
+date: 2024-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -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