stretchy-model 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a955580b683d3dc991c7a1f92a5a9508fd10a4f9e8a116c2c92150ae4fdd43a3
+  data.tar.gz: 30262c4a0d4e8d5e43a74ab707b3e501d8e5e627be16600687526885b4520cf3
+SHA512:
+  metadata.gz: ce944998d1e6ae225f85fa7ecbccea8f940e3fcee99c8450b79f89b3138bedcddec7b69d62de8285983c21dbc4dc068c4fa42157d94484065a8948c118c9bd95
+  data.tar.gz: 465d02c93b645b480bc4e627d4323d557ab6574dbefc2efc83de453aa246d38785ccb09cebf8d651e3f345d68e851e1197f32314bec84d13a379320dc468c3eb

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-02-26
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at spencer@theablefew.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in stretchy.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Spencer Markowski
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,146 @@
+stretchy
+===
+
+<p>
+    <a href="https://stretchy.io/" target="_blank"><img src="./stretchy.logo.png" alt="Gum Image" width="450" /></a>
+    <br><br>
+    <a href="https://github.com/theablefew/stretchy/releases"><img src="https://img.shields.io/github/v/release/theablefew/stretchy?sort=semver&color=blue"></a>
+    <a href="https://github.com/theablefew/stretchy/actions"><img src="https://github.com/theablefew/stretchy/actions/workflows/spec.yml/badge.svg"></a>
+
+</p>
+
+Stretchy provides Elasticsearch models in a Rails environment with an integrated ActiveRecord-like interface and features. 
+
+## Features
+Stretchy simplifies the process of querying, aggregating, and managing Elasticsearch-backed models, allowing Rails developers to work with search indices as comfortably as they would with traditional Rails models.
+
+## Attributes
+
+```ruby
+class Post < Stretchy::Record
+
+    attribute :title,                   :string
+    attribute :body,                    :string
+    attribute :flagged,                 :boolean,  default: false  
+    attribute :author,                   :hash 
+    attribute :tags,                    :array, default: []
+
+end
+```
+>[!NOTE]
+>`created_at`, `:updated_at` and `:id` are automatically added to all `Stretchy::Records`
+
+
+## Query
+```ruby
+  Post.where('author.name': "Jadzia", flagged: true).first
+  #=> <Post id: aW02w3092, title: "Fun Cats", body: "...", flagged: true,
+  #         author: {name: "Jadzia", age: 20}, tags: ["cat", "amusing"]>
+```
+
+## Aggregations
+```ruby
+
+  result = Post.filter(:range, 'author.age': {gte: 18})
+    .aggregation(:post_frequency, date_histogram: {
+      field: :created_at,
+      calender_interval: :month
+    })
+
+  result.aggregations.post_frequency
+  #=> {buckets: [{key_as_string: "2024-01-01", doc_count: 20}, ...]}
+```
+
+## Scopes
+
+```ruby
+class Post < Stretchy::Record
+  # ...attributes
+
+  # Scopes
+  scope :flagged, -> { where(flagged: true) }
+  scope :top_links, lambda do |size=10, url=".com"| 
+    aggregation(:links, 
+      terms: {
+        field: :links, 
+        size: size, 
+        include: ".*#{url}.*"
+      })
+  end
+end
+
+# Returns flagged posts and includes the top 10 'youtube.com' 
+# links in results.aggregations.links
+result = Post.flagged.top_links(10, "youtube.com")
+
+```
+
+## Bulk Operations
+
+
+```ruby
+Model.bulk(records_as_bulk_operations)
+```
+
+#### Bulk helper
+Generates structure for the bulk operation
+```ruby
+record.to_bulk # default to_bulk(:index)
+record.to_bulk(:delete)
+record.to_bulk(:update)
+```
+
+#### In batches
+Run bulk operations in batches specified by `size`
+```ruby
+Model.bulk_in_batches(records, size: 100) do |batch|
+    batch.map! { |record| Model.new(record).to_bulk }
+end
+```
+
+
+## Instrumentation
+```ruby
+Blanket.first
+```
+
+```sh
+Blanket (6.322ms) curl -X GET 'http://localhost:9200/blankets/_search?size=1' -d '{"sort":{"date":"desc"}}'
+```
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add stretchy
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install stretchy
+
+## 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.
+
+>[!TIP]
+>This library is built on top of the excellent [elasticsearch-persistence](https://github.com/elastic/elasticsearch-rails/tree/main/elasticsearch-persistence) gem. 
+>
+> Full documentation on [Elasticsearch Query DSL and Aggregation options](https://github.com/elastic/elasticsearch-rails/tree/main/elasticsearch-persistence)
+
+## Testing
+```
+docker-compose up elasticsearch
+```
+
+```
+bundle exec rspec
+```
+
+## 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).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/containers/Dockerfile.elasticsearch

@@ -0,0 +1,7 @@
+# Dockerfile.elasticsearch
+
+# Base image
+FROM docker.elastic.co/elasticsearch/elasticsearch:7.10.1
+
+# Environment variables
+ENV discovery.type=single-node

data/containers/Dockerfile.opensearch

@@ -0,0 +1,19 @@
+# Dockerfile.opensearch
+
+# Base image
+FROM opensearchproject/opensearch:2.12.0
+
+# Environment variables
+# disables bootstrap checks that are enabled when network.host is set to a non-loopback address
+ENV discovery.type=single-node
+# ENV cluster.name=opensearch-cluster
+ENV node.name=opensearch-node1
+ENV plugins.security.disabled=true
+# along with the memlock settings below, disables swapping
+ENV bootstrap.memory_lock=true
+# minimum and maximum Java heap size, recommend setting both to 50% of system RAM
+ENV OPENSEARCH_JAVA_OPTS="-Xms512m -Xmx512m"
+# disables execution of install_demo_configuration.sh bundled with security plugin, which installs demo certificates and security configurations to OpenSearch
+ENV DISABLE_INSTALL_DEMO_CONFIG=true
+# disables security plugin entirely in OpenSearch by setting plugins.security.disabled: true in opensearch.yml
+ENV DISABLE_SECURITY_PLUGIN=true

data/docker-compose.yml

@@ -0,0 +1,52 @@
+# docker-compose.yml
+
+version: '3'
+services:
+  elasticsearch:
+    build:
+      context: .
+      dockerfile: containers/Dockerfile.elasticsearch
+    ports:
+      - "9200:9200"
+    environment:
+      - discovery.type=single-node
+
+  opensearch:
+    build:
+      context: .
+      dockerfile: containers/Dockerfile.opensearch
+    ulimits:
+      memlock:
+        soft: -1
+        hard: -1
+      nofile:
+        soft: 65536 # maximum number of open files for the OpenSearch user, set to at least 65536 on modern systems
+        hard: 65536
+    environment:
+      - discovery.type=single-node
+    # volumes:
+    #   - opensearch-data1:/usr/share/opensearch/data
+    ports:
+      - 9200:9200
+      - 9600:9600 # required for Performance Analyzer
+    # networks:
+    #   - opensearch-net
+
+  # opensearch-dashboards:
+  #   image: opensearchproject/opensearch-dashboards:1.2.0
+  #   container_name: opensearch-dashboards
+  #   ports:
+  #     - 5601:5601
+  #   expose:
+  #     - "5601"
+  #   environment:
+  #     - 'OPENSEARCH_HOSTS=["http://opensearch-node1:9200"]'
+  #     - "DISABLE_SECURITY_DASHBOARDS_PLUGIN=true" # disables security dashboards plugin in OpenSearch Dashboards
+  #   networks:
+  #     - opensearch-net
+
+# volumes:
+  # opensearch-data1:
+
+# networks:
+  # opensearch-net:

data/lib/active_model/type/array.rb

@@ -0,0 +1,13 @@
+module ActiveModel
+    module Type
+
+        class Array < Value # :nodoc:
+
+            def type
+                :array
+            end
+
+        end
+
+    end
+end

data/lib/active_model/type/hash.rb

@@ -0,0 +1,15 @@
+module ActiveModel
+    module Type
+        class Hash < Value # :nodoc:
+            def type
+                :hash
+            end
+
+            private
+
+            def cast_value(value)
+                Elasticsearch::Model::HashWrapper[value]
+            end
+        end
+    end
+end

data/lib/rails/instrumentation/publishers.rb

@@ -0,0 +1,29 @@
+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.elasticsearch", 
+                      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

data/lib/rails/instrumentation/railtie.rb

@@ -0,0 +1,29 @@
+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
+
+      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
+
+    end
+  end
+end

data/lib/stretchy/associations/associated_validator.rb

@@ -0,0 +1,17 @@
+module Stretchy
+    module Associations
+        class AssociatedValidator < ActiveModel::EachValidator #:nodoc:
+            def validate_each(record, attribute, value)
+            if Array(value).reject { |r| valid_object?(r) }.any?
+                record.errors.add(attribute, :invalid, options.merge(value: value))
+            end
+            end
+
+            private
+
+            def valid_object?(record)
+            record.valid?
+            end
+        end
+    end
+end

data/lib/stretchy/associations/elastic_relation.rb

@@ -0,0 +1,38 @@
+module Stretchy
+    module Associations
+        class ElasticRelation
+            delegate :blank?, :empty?, :any?, :many?, :first, :last, to: :results
+            delegate :to_xml, :to_yaml, :length, :collect, :map, :each, :all?, :include?, :to_ary, :join, to: :to_a
+
+            attr_reader :klass
+            alias :model :klass
+
+            def initialize(klass, records = [], collection = true)
+            @klass = klass
+            @records = records
+            @collection = collection
+            end
+
+            def build(*args)
+            r = @klass.new(*args)
+            @records << r
+            r
+            end
+
+            def delete(opts = nil)
+            dr = @records.delete_if { |r| r === opts }
+            dr.first
+            end
+
+            def to_a
+            @records
+            end
+
+            alias :results :to_a
+
+            def collection?
+            @collection
+            end
+        end
+    end
+end

data/lib/stretchy/associations.rb

@@ -0,0 +1,161 @@
+module Stretchy
+  module Associations
+    extend ActiveSupport::Concern
+
+    def save!
+        self.save
+    end
+
+    # Required for Elasticsearch < 7
+    def type
+      "_doc"
+    end
+
+    def _type
+      "_doc"
+    end
+
+    def new_record?
+      self.id.nil?
+    end
+
+    def marked_for_destruction?
+      _destroy
+    end
+
+    def after_save_objects(s, association)
+      @_after_save_objects ||= {}
+      @_after_save_objects[association] ||= []
+      @_after_save_objects[association] << self.send("build_#{association}", s)
+    end
+
+    def dirty
+      @_after_save_objects || {}
+    end
+
+    def association_reflection(association)
+      ElasticRelation.new @@_associations[association], (dirty[association.to_sym] || [])
+    end
+
+    def _destroy=(bool)
+      @_destroy = bool
+    end
+
+    def _destroy
+      return @_destroy
+    end
+
+    def save_associations
+      @_after_save_objects.each_pair do |association, collection|
+        collection.each do |instance|
+          instance.send("#{@@_association_options[association.to_sym][:foreign_key]}=", self.id)
+          instance.save
+        end
+      end unless @_after_save_objects.nil?
+      @_after_save_objects = {}
+    end
+
+    class_methods do
+      @@_associations ||= {}
+      @@_association_options ||= {}
+
+      def belongs_to(association, options = {})
+        @@_association_options[association] = {
+          foreign_key: "#{association}_id", 
+          primary_key: "id",
+          class_name: association
+        }.reverse_merge(options)
+
+        klass = @@_association_options[association][:class_name].to_s.singularize.classify.constantize
+        @@_associations[association] = klass
+
+        define_method(association.to_sym) do
+          klass.where(_id: self.send(@@_association_options[association][:foreign_key].to_sym)).first
+        end
+
+        define_method("#{association}=".to_sym) do |val|
+          options = @@_association_options[association] 
+          instance_variable_set("@#{options[:foreign_key]}", val.send(options[:primary_key]))
+        end
+      end
+
+      def has_one(association, class_name: nil, foreign_key: nil, dependent: :destroy)
+
+        klass = association.to_s.singularize.classify.constantize unless class_name.present?
+        foreign_key = "#{self.name.downcase}_id" unless foreign_key.present?
+        @@_associations[association] = klass
+
+        define_method(association.to_sym) do
+          klass.where("#{foreign_key}": self.id).first
+        end
+      end
+
+      def has_many(association, klass, options = {})
+        @@_associations[association] = klass
+
+        opt_fk = options.delete(:foreign_key)
+        foreign_key = opt_fk ? opt_fk : "#{self.name.split("::").last.tableize.singularize}_id"
+
+        @@_association_options[association] = { foreign_key: foreign_key }
+
+        define_method(association.to_sym) do
+          args = {}
+          args[foreign_key] = self.id
+          self.new_record? ? association_reflection(association) : klass.where(args)
+        end
+
+        define_method("build_#{association}".to_sym) do |*args|
+          opts = {}
+          opts[foreign_key] = self.id
+          args.first.merge! opts
+          klass.new *args
+        end
+      end
+
+      def validates_associated(*attr_names)
+        validates_with AssociatedValidator, _merge_attributes(attr_names)
+      end
+
+      def accepts_nested_attributes_for(association)
+        after_create :save_associations
+
+        define_method("#{association}_attributes=".to_sym) do |*args|
+          args.each do |key|
+            key.values.each do |instance|
+              self.after_save_objects(instance, association)
+            end
+          end
+
+          association_reflection(association)
+        end
+      end
+
+      def reflect_on_association(association)
+        ElasticRelation.new @@_associations[association]
+      end
+
+      def update_all(records, **attributes)
+
+        records.map do |record|
+          attributes.each { |key, value| record.send("#{key}=", value) }
+          record
+        end.each_slice(100) do |batch|
+          update_batch = batch.collect{ |m| m.to_bulk(:update)}
+          self.gateway.client.bulk body: update_batch
+        end
+
+        self.refresh_index
+        records
+
+      end
+
+      def association_names
+        @@_associations.keys
+      end
+
+      def find_or_create_by(**args)
+        self.where(args).first || self.create(args)
+      end
+    end
+  end
+end