stretchy-model 0.4.0 → 0.6.0

data/lib/stretchy/relations/query_builder.rb

@@ -2,11 +2,12 @@ module Stretchy
   module Relations
     class QueryBuilder
 
-      attr_reader :structure, :values, :attribute_types
+      attr_reader :structure, :values, :attribute_types, :default_size
 
       def initialize(values, attribute_types = nil)
         @attribute_types = attribute_types
         @structure = Jbuilder.new ignore_nil: true
+        @default_size = values.delete(:default_size)
         @values = values
       end
 
@@ -38,6 +39,10 @@ module Stretchy
         @shoulds ||= compact_where(values[:should])
       end
 
+      def regexes
+        @regexes ||= values[:regexp]
+      end
+
       def fields
         values[:field]
       end
@@ -88,7 +93,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?
@@ -102,7 +107,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?
@@ -120,6 +130,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
@@ -157,7 +175,13 @@ module Stretchy
         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
@@ -185,6 +209,11 @@ module Stretchy
       end
 
       def extra_search_options
+        unless self.count?
+          values[:size] = size.present? ? size : values[:default_size]
+        else 
+          values[:size] = nil
+        end
         [:size].inject(Hash.new) { |h,k| h[k] = self.send(k) unless self.send(k).nil?; h}
       end
 

data/lib/stretchy/relations/query_methods.rb

@@ -18,7 +18,8 @@ module Stretchy
         :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
 
 
 

data/lib/stretchy/scoping/named.rb

@@ -8,7 +8,7 @@ module Stretchy
           if current_scope
             current_scope.clone
           else
-            default_scoped.size(default_size)
+            default_scoped
           end
         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/version.rb

@@ -1,3 +1,3 @@
 module Stretchy
-  VERSION = '0.4.0'
+  VERSION = '0.6.0'
 end

data/lib/stretchy.rb

@@ -7,14 +7,11 @@ require 'elasticsearch/model'
 require 'elasticsearch/persistence'
 require 'active_model'
 require 'active_support/all'
-require 'active_model/type/array'
-require 'active_model/type/hash'
 
 require_relative "stretchy/version"
 require_relative "rails/instrumentation/railtie" if defined?(Rails)
 
 
-
 module Stretchy
 
   def self.loader
@@ -23,6 +20,7 @@ module Stretchy
       loader.tag = File.basename(__FILE__, ".rb")
       loader.inflector = Zeitwerk::GemInflector.new(__FILE__)
       loader.push_dir(__dir__)
+      loader.inflector.inflect("ip" => "IP")
       loader
     end
   end
@@ -32,6 +30,10 @@ module Stretchy
     Stretchy::Attributes.register!
   end
 
+  def self.instrument!
+    Stretchy::Delegation::GatewayDelegation.send(:include, Rails::Instrumentation::Publishers::Record)
+  end
+
   module Errors
     class QueryOptionMissing < StandardError; end
   end

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.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Spencer Markowski
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-10 00:00:00.000000000 Z
+date: 2024-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -224,8 +224,6 @@ 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
@@ -234,7 +232,53 @@ files:
 - 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/base.rb
+- lib/stretchy/attributes/type/binary.rb
+- lib/stretchy/attributes/type/boolean.rb
+- lib/stretchy/attributes/type/completion.rb
+- lib/stretchy/attributes/type/constant_keyword.rb
+- lib/stretchy/attributes/type/date_time.rb
+- lib/stretchy/attributes/type/dense_vector.rb
+- lib/stretchy/attributes/type/flattened.rb
+- lib/stretchy/attributes/type/geo_point.rb
+- lib/stretchy/attributes/type/geo_shape.rb
+- lib/stretchy/attributes/type/hash.rb
+- lib/stretchy/attributes/type/histogram.rb
+- lib/stretchy/attributes/type/ip.rb
+- lib/stretchy/attributes/type/join.rb
 - lib/stretchy/attributes/type/keyword.rb
+- lib/stretchy/attributes/type/match_only_text.rb
+- lib/stretchy/attributes/type/nested.rb
+- lib/stretchy/attributes/type/numeric/base.rb
+- lib/stretchy/attributes/type/numeric/byte.rb
+- lib/stretchy/attributes/type/numeric/double.rb
+- lib/stretchy/attributes/type/numeric/float.rb
+- lib/stretchy/attributes/type/numeric/half_float.rb
+- lib/stretchy/attributes/type/numeric/integer.rb
+- lib/stretchy/attributes/type/numeric/long.rb
+- lib/stretchy/attributes/type/numeric/scaled_float.rb
+- lib/stretchy/attributes/type/numeric/short.rb
+- lib/stretchy/attributes/type/numeric/unsigned_long.rb
+- lib/stretchy/attributes/type/percolator.rb
+- lib/stretchy/attributes/type/point.rb
+- lib/stretchy/attributes/type/range/base.rb
+- lib/stretchy/attributes/type/range/date_range.rb
+- lib/stretchy/attributes/type/range/double_range.rb
+- lib/stretchy/attributes/type/range/float_range.rb
+- lib/stretchy/attributes/type/range/integer_range.rb
+- lib/stretchy/attributes/type/range/ip_range.rb
+- lib/stretchy/attributes/type/range/long_range.rb
+- lib/stretchy/attributes/type/rank_feature.rb
+- lib/stretchy/attributes/type/rank_features.rb
+- lib/stretchy/attributes/type/search_as_you_type.rb
+- lib/stretchy/attributes/type/shape.rb
+- lib/stretchy/attributes/type/sparse_vector.rb
+- lib/stretchy/attributes/type/string.rb
+- lib/stretchy/attributes/type/text.rb
+- lib/stretchy/attributes/type/token_count.rb
+- lib/stretchy/attributes/type/version.rb
+- lib/stretchy/attributes/type/wildcard.rb
 - lib/stretchy/common.rb
 - lib/stretchy/delegation/delegate_cache.rb
 - lib/stretchy/delegation/gateway_delegation.rb
@@ -263,6 +307,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

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