stretchy-model 0.3.0 → 0.5.0

data/lib/stretchy/relations/finder_methods.rb

@@ -9,7 +9,15 @@ module Stretchy
         end
 
         def first!
-          spawn.sort(Hash[default_sort_key, :asc]).spawn.size(1)
+          spawned = spawn
+          if spawned.order_values.length.zero? 
+            spawn.sort(Hash[default_sort_key, :asc]).spawn.size(1)
+          elsif spawned.order_values.length >= 1
+            first_order_value = spawned.order_values.shift
+            new_direction = Hash[first_order_value.keys.first, :asc] 
+            spawned.order_values.unshift(new_direction)
+            spawned.size(1)
+          end
           self
         end
 
@@ -19,7 +27,15 @@ module Stretchy
         end
 
         def last!
-          spawn.sort(Hash[default_sort_key, :desc]).spawn.size(1)
+          spawned = spawn
+          if spawned.order_values.length.zero?
+            spawn.sort(Hash[default_sort_key, :desc]).spawn.size(1)
+          elsif spawned.order_values.length >= 1
+            first_order_value = spawned.order_values.shift
+            new_direction = Hash[first_order_value.keys.first, :desc] 
+            spawned.order_values.unshift(new_direction)
+            spawned.size(1)
+          end
           self
         end
 
@@ -31,7 +47,9 @@ module Stretchy
         def count!
           @values[:count] = true
           @values.delete(:size)
-          spawn.results
+          spawned = spawn
+          spawned.order_values.clear
+          spawned.results
         end
 
       end

data/lib/stretchy/relations/merger.rb

@@ -7,8 +7,12 @@ module Stretchy
       class HashMerger # :nodoc:
         attr_reader :relation, :hash
 
+        VALUE_METHODS = Stretchy::Relations::QueryMethods::MULTI_VALUE_METHODS.concat( 
+                          Stretchy::Relations::QueryMethods::SINGLE_VALUE_METHODS
+                        )
+
         def initialize(relation, hash)
-          hash.assert_valid_keys(*Relation::VALUE_METHODS)
+          hash.assert_valid_keys(*VALUE_METHODS)
 
           @relation = relation
           @hash     = hash
@@ -50,7 +54,7 @@ module Stretchy
           @other    = other
         end
 
-        NORMAL_VALUES = [:where, :first, :last, :filter]
+        NORMAL_VALUES = [:where, :first, :last, :filter_query]
 
         def normal_values
           NORMAL_VALUES
@@ -67,7 +71,7 @@ module Stretchy
             unless value.nil? || (value.blank? && false != value)
               if name == :select
                 relation._select!(*value)
-              elsif name == :filter
+              elsif name == :filter_query
                 values.each do |v|
                   relation.send("#{name}!", v.first, v.last)
                 end
@@ -114,19 +118,19 @@ module Stretchy
           lhs_wheres = relation.where_values
           rhs_wheres = values[:where] || []
 
-          lhs_filters = relation.filter_values
-          rhs_filters = values[:filter] || []
+          lhs_filters = relation.filter_query_values
+          rhs_filters = values[:filter_query] || []
 
           removed, kept = partition_overwrites(lhs_wheres, rhs_wheres)
 
           where_values = kept + rhs_wheres
 
           filters_removed, filters_kept = partition_overwrites(lhs_wheres, rhs_wheres)
-          filter_values =  rhs_filters
+          filter_query_values =  rhs_filters
 
 
           relation.where_values = where_values.empty? ? nil : where_values
-          relation.filter_values = filter_values.empty? ? nil : filter_values
+          relation.filter_query_values = filter_query_values.empty? ? nil : filter_query_values
 
           if values[:reordering]
             # override any order specified in the original relation

data/lib/stretchy/relations/query_builder.rb

@@ -2,9 +2,10 @@ module Stretchy
   module Relations
     class QueryBuilder
 
-      attr_reader :structure, :values
+      attr_reader :structure, :values, :attribute_types
 
-      def initialize(values)
+      def initialize(values, attribute_types = nil)
+        @attribute_types = attribute_types
         @structure = Jbuilder.new ignore_nil: true
         @values = values
       end
@@ -14,7 +15,7 @@ module Stretchy
       end
 
       def filters
-        values[:filter]
+        values[:filter_query]
       end
 
       def or_filters
@@ -37,6 +38,10 @@ module Stretchy
         @shoulds ||= compact_where(values[:should])
       end
 
+      def regexes
+        @regexes ||= values[:regexp]
+      end
+
       def fields
         values[:field]
       end
@@ -58,7 +63,7 @@ module Stretchy
       end
 
       def query_filters
-        values[:filter]
+        values[:filter_query]
       end
 
       def search_options
@@ -87,7 +92,7 @@ module Stretchy
       private
 
       def missing_bool_query?
-        query.nil? && must_nots.nil? && shoulds.nil?
+        query.nil? && must_nots.nil? && shoulds.nil? && regexes.nil?
       end
 
       def missing_query_string?
@@ -101,7 +106,12 @@ module Stretchy
       def build_query
         return if missing_bool_query? && missing_query_string? && missing_query_filter?
         structure.query do
+          structure.regexp do
+            build_regexp unless regexes.nil?
+          end
+
           structure.bool do
+
                 structure.must query unless missing_bool_query?
                 structure.must_not must_nots unless must_nots.nil?
                 structure.set! :should, shoulds unless shoulds.nil?
@@ -119,6 +129,14 @@ module Stretchy
         end.with_indifferent_access
       end
 
+      def build_regexp
+        regexes.each do |args|
+            target_field = args.first.keys.first
+            value_field = args.first.values.first
+            structure.set! target_field, args.last.merge(value: value_field)
+        end
+      end
+
       def build_filtered_query
         structure.filter do
           structure.or do
@@ -149,14 +167,20 @@ module Stretchy
       end
 
       def build_sort
-        structure.sort sort.flatten #.inject(Hash.new) { |h,v| h.merge(v) }
+        structure.sort sort.map { |arg| keyword_transformer.transform(arg) }.flatten
       end
 
       def build_highlights
         structure.highlight do
           structure.fields do
             highlights.each do |highlight|
-              structure.set! highlight, extract_highlighter(highlight)
+              if highlight.is_a?(String) || highlight.is_a?(Symbol)
+                structure.set! highlight, {}
+              elsif highlight.is_a?(Hash)
+                highlight.each_pair do |k,v|
+                  structure.set! k, v
+                end
+              end
             end
           end
         end
@@ -165,7 +189,7 @@ module Stretchy
       def build_aggregations
         structure.aggregations do
           aggregations.each do |agg|
-            structure.set! agg[:name], aggregation(agg[:name], agg[:args])
+            structure.set! agg[:name], aggregation(agg[:name], keyword_transformer.transform(agg[:args], :name))
           end
         end
       end
@@ -199,13 +223,23 @@ module Stretchy
       def as_must(q)
         _must = []
         q.each do |arg|
-          arg.each_pair { |k,v| _must << (v.is_a?(Array) ? {terms: Hash[k,v]} : {term: Hash[k,v]}) } if arg.class == Hash
-          _must << {term: Hash[[arg.split(/:/).collect(&:strip)]]} if arg.class == String
-          _must << arg.first if arg.class == Array
+          case arg
+          when Hash
+            arg = keyword_transformer.transform(arg)
+            arg.each_pair do |k,v| 
+              # If v is an array, we build a terms query otherwise a term query
+              _must << (v.is_a?(Array) ? {terms: Hash[k,v]} : {term: Hash[k,v]}) 
+            end
+          when String
+            _must << {term: Hash[[arg.split(/:/).collect(&:strip)]]}
+          when Array
+            _must << arg.first
+          end
         end
         _must.length == 1 ? _must.first : _must
       end
 
+
       def as_query_string(q)
         _and = []
 
@@ -260,6 +294,9 @@ module Stretchy
         end
       end
 
+      def keyword_transformer
+        @keyword_transformer ||= Stretchy::Attributes::Transformers::KeywordTransformer.new(@attribute_types)
+      end
     end
   end
 end

data/lib/stretchy/relations/query_methods.rb

@@ -15,10 +15,11 @@ module Stretchy
         :query_string,
         :aggregation,
         :search_option,
-        :filter, 
+        :filter_query, 
         :or_filter,
         :extending,
-        :skip_callbacks
+        :skip_callbacks,
+        :regexp
       ]
 
       SINGLE_VALUE_METHODS = [:size]
@@ -173,6 +174,16 @@ module Stretchy
       #          }
       #        }
       #
+      # .where acts as a convienence method for adding conditions to the query. It can also be used to add
+      # range , regex, terms, and id queries through shorthand parameters.
+      #
+      # @example
+      #   Model.where(price: {gte: 10, lte: 20})
+      #   Model.where(age: 19..33)
+      #   Model.where(color: /gr(a|e)y/)
+      #   Model.where(id: [10, 22, 18])
+      #   Model.where(names: ['John', 'Jane'])
+      #
       # @return [ActiveRecord::Relation, WhereChain] a new relation, which reflects the conditions, or a WhereChain if opts is :chain
       # @see #must
       def where(opts = :chain, *rest)
@@ -181,7 +192,28 @@ module Stretchy
         elsif opts.blank?
           self
         else
-          spawn.where!(opts, *rest)
+          opts.each do |key, value|
+            case value
+            when Range
+              between(value, key)
+            when Hash
+              filter_query(:range, key => value) if value.keys.any? { |k| [:gte, :lte, :gt, :lt].include?(k) }
+            when Regexp
+              regexp(Hash[key, value])
+            when Array
+              # handle ID queries
+              # if [:id, :_id].include?(key)
+
+              # else
+                spawn.where!(opts, *rest)
+              # end
+            else
+              spawn.where!(opts, *rest)
+            end
+          end
+
+          self
+
         end
       end
 
@@ -199,6 +231,38 @@ module Stretchy
       # @see #where
       alias :must :where
 
+      # Adds a regexp condition to the query.
+      # 
+      # @param field [Hash] the field to filter by and the Regexp to match
+      # @param opts [Hash] additional options for the regexp query
+      #     - :flags [String] the flags to use for the regexp query (e.g. 'ALL')
+      #     - :use_keyword [Boolean] whether to use the .keyword field for the regexp query. Default: true
+      #     - :case_insensitive [Boolean] whether to use case insensitive matching. If the regexp has ignore case flag `/regex/i`, this is automatically set to true
+      #     - :max_determinized_states [Integer] the maximum number of states that the regexp query can produce
+      #     - :rewrite [String] the rewrite method to use for the regexp query
+      #     
+      # 
+      # @example
+      #  Model.regexp(:name, /john|jane/)
+      #  Model.regexp(:name, /john|jane/i)
+      #  Model.regexp(:name, /john|jane/i, flags: 'ALL')
+      #  
+      # @return [Stretchy::Relation] a new relation, which reflects the regexp condition
+      # @see #where
+      def regexp(args)
+        spawn.regexp!(args)
+      end
+
+      def regexp!(args) # :nodoc:
+        args = args.to_a
+        target_field, regex = args.shift
+        opts = args.to_h
+        opts.reverse_merge!(use_keyword: true)
+        target_field = "#{target_field}.keyword" if opts.delete(:use_keyword)
+        opts.merge!(case_insensitive: true) if regex.casefold?
+        self.regexp_values += [[Hash[target_field, regex.source], opts]]
+        self
+      end
 
 
 
@@ -308,7 +372,7 @@ module Stretchy
 
 
 
-      # @deprecated in elasticsearch 7.x+ use {#filter} instead
+      # @deprecated in elasticsearch 7.x+ use {#filter_query} instead
       def or_filter(name, options = {}, &block)
         spawn.or_filter!(name, options, &block)
       end
@@ -322,53 +386,27 @@ module Stretchy
       #
       # This method supports all filters supported by Elasticsearch.
       #
-      # @overload filter(type, opts)
+      # @overload filter_query(type, opts)
       #   @param type [Symbol] the type of filter to add (:range, :term, etc.)
       #   @param opts [Hash] a hash containing the attribute and value to filter by
       #
       # @example
-      #   Model.filter(:range, age: {gte: 30})
-      #   Model.filter(:term, color: :blue)
+      #   Model.filter_query(:range, age: {gte: 30})
+      #   Model.filter_query(:term, color: :blue)
       #
       # @return [Stretchy::Relation] a new relation, which reflects the filter
-      def filter(name, options = {}, &block)
-        spawn.filter!(name, options, &block)
+      def filter_query(name, options = {}, &block)
+        spawn.filter_query!(name, options, &block)
       end
 
-      def filter!(name, options = {}, &block) # :nodoc:
-        self.filter_values += [{name: name, args: options}]
+      def filter_query!(name, options = {}, &block) # :nodoc:
+        self.filter_query_values += [{name: name, args: options}]
         self
       end
 
 
 
-      # Adds an aggregation to the query.
-      #
-      # @param name [Symbol, String] the name of the aggregation
-      # @param options [Hash] a hash of options for the aggregation
-      # @param block [Proc] an optional block to further configure the aggregation
-      #
-      # @example
-      #   Model.aggregation(:avg_price, field: :price)
-      #   Model.aggregation(:price_ranges) do
-      #     range field: :price, ranges: [{to: 100}, {from: 100, to: 200}, {from: 200}]
-      #   end
-      #
-      # Aggregation results are available in the `aggregations` method of the results under name provided in the aggregation.
-      #
-      # @example
-      #  results = Model.where(color: :blue).aggregation(:avg_price, field: :price)
-      #  results.aggregations.avg_price
-      #
-      # @return [Stretchy::Relation] a new relation
-      def aggregation(name, options = {}, &block)
-        spawn.aggregation!(name, options, &block)
-      end
 
-      def aggregation!(name, options = {}, &block) # :nodoc:
-        self.aggregation_values += [{name: name, args: assume_keyword_field(options)}]
-        self
-      end
 
 
 
@@ -430,7 +468,7 @@ module Stretchy
       #
       # @return [ActiveRecord::Relation] a new relation, which reflects the exists filter
       def has_field(field)
-        spawn.filter(:exists, {field: field})
+        spawn.filter_query(:exists, {field: field})
       end
 
 

data/lib/stretchy/shared_scopes.rb

@@ -4,7 +4,7 @@ module Stretchy
 
         included do
 
-            scope :between, lambda { |range| filter(:range, "date" => {gte: range.begin, lte: range.end}) }
+            scope :between, ->(range, range_field = "created_at") { filter_query(:range, range_field => {gte: range.begin, lte: range.end}) }
             scope :using_time_based_indices, lambda { |range| search_options(index: time_based_indices(range)) }
 
         end

data/lib/stretchy/utils.rb

@@ -2,6 +2,27 @@ module Stretchy
     module Utils
         extend ActiveSupport::Concern
 
+            concerning :ConsoleMethods do
+                def reload!
+                    Stretchy.loader.reload
+                end
+
+                def banner
+                    banner = <<~BANNER
+                                    
+                                                                    d8b                
+                               d8P                     d8P          ?88                
+                            d888888P                d888888P         88b               
+                     .d888b,  ?88'    88bd88b d8888b  ?88'   d8888b  888888b ?88   d8P 
+                     ?8b,     88P     88P'  `d8b_,dP  88P   d8P' `P  88P `?8bd88   88  
+                       `?8b   88b    d88     88b      88b   88b     d88   88P?8(  d88  
+                    `?888P'   `?8b  d88'     `?888P'  `?8b  `?888P'd88'   88b`?88P'?8b 
+                                                                                    )88
+                                                                                   ,d8P
+                                                                                `?888P'
+                    BANNER
+                end
+            end
 
             def self.to_curl(klass, arguments = {}, end_point = "_search")
                 host = klass.gateway.client.transport.transport.hosts&.first || klass.gateway.client.transport.transport.options[:url]

data/lib/stretchy/version.rb

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

data/lib/stretchy.rb

@@ -7,16 +7,29 @@ require 'elasticsearch/model'
 require 'elasticsearch/persistence'
 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 "rails/instrumentation/railtie" if defined?(Rails)
 
+
+
 module Stretchy
+
+  def self.loader
+    @loader ||= begin
+      loader = Zeitwerk::Loader.new
+      loader.tag = File.basename(__FILE__, ".rb")
+      loader.inflector = Zeitwerk::GemInflector.new(__FILE__)
+      loader.push_dir(__dir__)
+      loader
+    end
+  end
+
+  def self.boot!
+    loader.setup
+    Stretchy::Attributes.register!
+  end
+
   module Errors
     class QueryOptionMissing < StandardError; end
   end
@@ -61,12 +74,9 @@ module Stretchy
     end
   end
 
-end
 
+end
 
+Stretchy.loader.enable_reloading if defined?(Rails) && Rails.env.development? || ENV['RACK_ENV'] == 'development'
+Stretchy.boot!
 
-loader = Zeitwerk::Loader.new
-loader.tag = File.basename(__FILE__, ".rb")
-loader.inflector = Zeitwerk::GemInflector.new(__FILE__)
-loader.push_dir(__dir__)
-loader.setup

data/lib/stretchy_model.rb

@@ -0,0 +1,9 @@
+# This is a simple model that inherits from Stretchy::Record
+# for aesthetic purposes. 
+#
+# In Rails applications, you can use this model as a base class
+# for your models.
+# 
+class StretchyModel < Stretchy::Record
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stretchy-model
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Spencer Markowski
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-06 00:00:00.000000000 Z
+date: 2024-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -178,6 +178,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.20'
+- !ruby/object:Gem::Dependency
+  name: versionomy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
 description: Provides a familiar ActiveRecord-like interface for working with Elasticsearch
 email:
 - spencer.markowski@theablefew.com
@@ -196,14 +224,18 @@ files:
 - 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/attributes.rb
+- lib/stretchy/attributes/transformers/keyword_transformer.rb
+- lib/stretchy/attributes/type/array.rb
+- lib/stretchy/attributes/type/hash.rb
+- lib/stretchy/attributes/type/keyword.rb
+- lib/stretchy/attributes/type/text.rb
 - lib/stretchy/common.rb
 - lib/stretchy/delegation/delegate_cache.rb
 - lib/stretchy/delegation/gateway_delegation.rb
@@ -217,6 +249,7 @@ files:
 - lib/stretchy/record.rb
 - lib/stretchy/refreshable.rb
 - lib/stretchy/relation.rb
+- lib/stretchy/relations/aggregation_methods.rb
 - lib/stretchy/relations/finder_methods.rb
 - lib/stretchy/relations/merger.rb
 - lib/stretchy/relations/query_builder.rb
@@ -231,6 +264,7 @@ files:
 - lib/stretchy/shared_scopes.rb
 - lib/stretchy/utils.rb
 - lib/stretchy/version.rb
+- lib/stretchy_model.rb
 - sig/stretchy.rbs
 - stretchy-model/lib/stretchy-model.rb
 - stretchy.logo.png
@@ -257,7 +291,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Rails ORM for Elasticsearch

data/lib/active_model/type/array.rb

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

data/lib/active_model/type/hash.rb

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