stretchy-model 0.1.0

data/lib/stretchy/scoping/default.rb

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

data/lib/stretchy/scoping/named.rb

@@ -0,0 +1,68 @@
+module Stretchy
+  module Scoping
+    module Named
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def all(options={})
+          if current_scope
+            current_scope.clone
+          else
+            default_scoped.size(default_size)
+          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

data/lib/stretchy/scoping/scope_registry.rb

@@ -0,0 +1,34 @@
+module Stretchy
+    module Scoping
+        class ScopeRegistry # :nodoc:
+            # extend ActiveSupport::PerThreadRegistry
+            thread_mattr_accessor :registry
+
+            VALID_SCOPE_TYPES = [:current_scope, :ignore_default_scope]
+
+            def initialize
+                @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)
+                raise_invalid_scope_type!(scope_type)
+                @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)
+                raise_invalid_scope_type!(scope_type)
+                @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

data/lib/stretchy/scoping.rb

@@ -0,0 +1,28 @@
+module Stretchy
+  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.new.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)
+      end
+    end
+
+
+  end
+end

data/lib/stretchy/shared_scopes.rb

@@ -0,0 +1,34 @@
+module Stretchy
+    module SharedScopes
+        extend ActiveSupport::Concern
+
+        included do
+
+            scope :between, lambda { |range| filter(:range, "date" => {gte: range.begin, lte: range.end}) }
+            scope :using_time_based_indices, lambda { |range| search_options(index: time_based_indices(range)) }
+
+        end
+
+        class_methods do
+                
+            #   Helpful when you want to search across multiple indices when there are 
+            #   many indices for a given model. It significantly reduces the load on the cluster. 
+            #
+            #   @example Narrow search across indices for the last 2 months
+            #   
+            #       class Twitter < Stretchy::Model
+            #          scope :monthly_indices, lambda { |range| search_options(index: time_based_indices(range)) }
+            #       end 
+            #
+            #       Twitter.monthly_indices(2.months.ago..1.day.ago)
+            #       => search_url:  "/twitter_2024_01*,twitter_2024_02*,twitter_2024_03*/_search" 
+            #
+            def time_based_indices(range, format = "%Y_%m")
+                (range.begin.to_datetime...range.end.to_datetime).map do |d| 
+                    "#{self.index_name.gsub(/\*/, "")}#{d.utc.strftime("#{format}*")}" 
+                end.uniq.join(",")                
+            end
+    
+        end
+    end
+end

data/lib/stretchy/utils.rb

@@ -0,0 +1,69 @@
+module Stretchy
+    module Utils
+        extend ActiveSupport::Concern
+
+
+            def self.to_curl(klass, arguments = {}, end_point = "_search")
+                host = klass.gateway.client.transport.transport.hosts&.first || klass.gateway.client.transport.transport.options[:url]
+                arguments[:index] = "_all" if !arguments[:index] && arguments[:type]
+
+                valid_params = [
+                    :analyzer,
+                    :analyze_wildcard,
+                    :default_operator,
+                    :df,
+                    :explain,
+                    :fields,
+                    :from,
+                    :ignore_indices,
+                    :ignore_unavailable,
+                    :allow_no_indices,
+                    :expand_wildcards,
+                    :lenient,
+                    :lowercase_expanded_terms,
+                    :preference,
+                    :q,
+                    :routing,
+                    :scroll,
+                    :search_type,
+                    :size,
+                    :sort,
+                    :source,
+                    :_source,
+                    :_source_include,
+                    :_source_exclude,
+                    :stats,
+                    :suggest_field,
+                    :suggest_mode,
+                    :suggest_size,
+                    :suggest_text,
+                    :timeout,
+                    :version,
+                ]
+
+                method = "GET"
+                path = Elasticsearch::API::Utils.__pathify(Elasticsearch::API::Utils.__listify(arguments[:index]), end_point)
+
+                params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, valid_params
+                body = arguments[:body]
+
+                params[:fields] = Elasticsearch::API::Utils.__listify(params[:fields]) if params[:fields]
+
+                url = path
+
+                unless host.is_a? String
+                    host_parts = "#{host[:protocol].to_s}://#{host[:host]}"
+                    host_parts = "#{host_parts}:#{host[:port]}" if host[:port]
+                else
+                    host_parts = host
+                end
+
+                trace_url = "#{host_parts}/#{url}"
+                trace_url += "?#{::Faraday::Utils::ParamsHash[params].to_query}" unless params.blank?
+                trace_body = body ? " -d '#{body.to_json}'" : ""
+
+                "curl -X#{method.to_s.upcase} '#{CGI.unescape(trace_url)}'#{trace_body}\n"
+            end
+
+    end
+end

data/lib/stretchy/version.rb

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

data/lib/stretchy.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+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'
+require 'active_model/type/hash'
+
+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)
+
+module Stretchy
+  module Errors
+    class QueryOptionMissing < StandardError; end
+  end
+
+  class << self
+    def logger
+      @logger ||= Logger.new(STDOUT)
+    end
+  end
+
+end
+
+loader = Zeitwerk::Loader.new
+loader.tag = File.basename(__FILE__, ".rb")
+loader.inflector = Zeitwerk::GemInflector.new(__FILE__)
+loader.push_dir(__dir__)
+loader.setup

data/sig/stretchy.rbs

@@ -0,0 +1,4 @@
+module Stretchy
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,247 @@
+--- !ruby/object:Gem::Specification
+name: stretchy-model
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Spencer Markowski
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  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
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: amazing_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: jbuilder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.36
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.36
+description: Provides a familiar ActiveRecord-like interface for working with Elasticsearch
+email:
+- spencer.markowski@theablefew.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".yardopts"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- containers/Dockerfile.elasticsearch
+- containers/Dockerfile.opensearch
+- docker-compose.yml
+- lib/active_model/type/array.rb
+- lib/active_model/type/hash.rb
+- lib/rails/instrumentation/publishers.rb
+- lib/rails/instrumentation/railtie.rb
+- lib/stretchy.rb
+- lib/stretchy/associations.rb
+- lib/stretchy/associations/associated_validator.rb
+- lib/stretchy/associations/elastic_relation.rb
+- lib/stretchy/common.rb
+- lib/stretchy/delegation/delegate_cache.rb
+- lib/stretchy/delegation/gateway_delegation.rb
+- lib/stretchy/indexing/bulk.rb
+- lib/stretchy/model/callbacks.rb
+- lib/stretchy/model/serialization.rb
+- lib/stretchy/null_relation.rb
+- lib/stretchy/persistence.rb
+- lib/stretchy/querying.rb
+- lib/stretchy/record.rb
+- lib/stretchy/refreshable.rb
+- lib/stretchy/relation.rb
+- lib/stretchy/relations/finder_methods.rb
+- lib/stretchy/relations/merger.rb
+- lib/stretchy/relations/query_builder.rb
+- lib/stretchy/relations/query_methods.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
+- sig/stretchy.rbs
+- stretchy.logo.png
+homepage: https://github.com/theablefew/stretchy
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/theablefew/stretchy
+  source_code_uri: https://github.com/theablefew/stretchy
+  changelog_uri: https://github.com/theablefew/stretchy/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Rails ORM for Elasticsearch
+test_files: []