refine-rails 2.12.2 → 2.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73e66f1039b20dd28286e2fcb2266eaedb37f9f3bf699bbe674e5382ab68b3d0
-  data.tar.gz: dc9df797a0eb1d2ea55d9d9f6aa0e5d45da56d190c777c67326c7c78cff10555
+  metadata.gz: 745e07b54a0ea72e278c58749374e0a8a60283d0078b942c0a8c40dd3021f02b
+  data.tar.gz: 666166e9873ead413980823191557e80807e9cf8500216bf4c908665437a8e19
 SHA512:
-  metadata.gz: 19c1502c439e9f8026676dfab10aa5d1ece356f35f80487160b797dd11486c097e446408d979afd9bc20d492a1cbfe7f8ca9edf2721e49d6154974cbfeb3750e
-  data.tar.gz: 46e7fba211285bfd1f73b32e59976aad29c18bb46e35d5cd9a07ebbbca7b91e06c60be019a2981e914c7cade88d561fa8ac49df7f75433604b40731d9b293b82
+  metadata.gz: 57235d225ef0a85b5cb5a80895c0fa24279ef81f12d7838099b4251b2955dd7b7304f98219f8b2b43bd5f98e79b83c38c7aff4670d4e088353f28244fd148af7
+  data.tar.gz: 840b8fcbeb17129d367c23740e8498669bd8080f8e9861579e60377b53e7b9c4d7a93b273863d091025c1efed659a43ba3a46eeb88812ea1334464b150a6f22d

data/app/models/refine/conditions/condition.rb

@@ -10,6 +10,8 @@ module Refine::Conditions
     include HasMeta
     include UsesAttributes
     include HasRefinements
+    include HasThroughIdRelationship
+    include WithForcedIndex
     include HasIcon
 
     attr_reader :ensurances, :before_validations, :clause, :filter
@@ -122,7 +124,7 @@ module Refine::Conditions
     # @param [Arel::Table] table The arel_table the query is built on 
     # @param [ActiveRecord::Relation] initial_query The base query the query is built on 
     # @return [Arel::Node] 
-    def apply(input, table, initial_query, inverse_clause=false)
+    def apply(input, table, initial_query, inverse_clause=false, through_attribute=nil)
       table ||= filter.table
       # Ensurance validations are checking the developer configured correctly
       run_ensurance_validations
@@ -150,6 +152,7 @@ module Refine::Conditions
         return
       end
       # No longer a relationship attribute, apply condition normally
+      self.attribute = through_attribute if through_attribute
       nodes = apply_condition(input, table, inverse_clause)
       if !is_refinement && has_any_refinements?
         refined_node = apply_refinements(input)

data/app/models/refine/conditions/has_through_id_relationship.rb

@@ -0,0 +1,10 @@
+module Refine::Conditions::HasThroughIdRelationship
+  def through_id_relationship
+    @through_id_relationship ||= false
+  end
+
+  def with_through_id_relationship
+    @through_id_relationship = true
+    self
+  end
+end

data/app/models/refine/conditions/uses_attributes.rb

@@ -123,9 +123,43 @@ module Refine::Conditions
       relation_table_being_queried = instance.klass.arel_table
 
       relation_class = instance.klass
-      
-      node_to_apply = apply(input, relation_table_being_queried, relation_class, inverse_clause)
 
+      if self.through_id_relationship
+        if instance.is_a? ActiveRecord::Reflection::ThroughReflection
+          through_reflection = instance.through_reflection
+          parent_foreign_key = through_reflection.foreign_key
+          child_foreign_key = instance.source_reflection.foreign_key
+          relation_table_being_queried = through_reflection.klass.arel_table
+          relation_class = through_reflection.klass
+          if(through_reflection.chain.count > 1)
+            # We need to shortcut the outer inner joins but allow the others to go as normal
+            parent_foreign_key = through_reflection.chain.last.foreign_key
+            parent_through_reflection = through_reflection.chain.last
+            join_sym = through_reflection.source_reflection_name
+            subquery_path = parent_through_reflection.klass.select(parent_foreign_key).joins(join_sym)
+            if(through_reflection.scope && through_reflection.scope.is_a?(Proc))
+              subquery_path = subquery_path.instance_exec(&through_reflection.scope)
+            end
+            subquery_path = subquery_path.arel
+          else
+            # Does not need any inner joins
+            subquery_path = through_reflection.klass.select(parent_foreign_key).arel
+          end
+         
+          node_to_apply = apply(input, relation_table_being_queried, relation_class, inverse_clause, child_foreign_key)
+        else
+          raise Refine::Conditions::Errors::RelationshipError.new("with_through_id must be used with a has_many :through relationship")
+        end
+      else
+        node_to_apply = apply(input, relation_table_being_queried, relation_class, inverse_clause)
+      end
+
+      if self.forced_index
+        mysql_from_segment = "`#{through_reflection.table_name}` FORCE INDEX(`#{self.forced_index}`)"
+        # Ensuring input is sanitized
+        subquery_path = subquery_path.from(Arel.sql(mysql_from_segment))
+      end
+      
       complete_subquery = subquery_path.where(node_to_apply)
       subquery = filter.get_pending_relationship_subquery || complete_subquery
       filter.add_pending_relationship_subquery(subquery: subquery, primary_key: key_1(instance), secondary_key: nil, inverse_clause: inverse_clause)

data/app/models/refine/conditions/with_forced_index.rb

@@ -0,0 +1,10 @@
+module Refine::Conditions::WithForcedIndex
+  def forced_index
+    @forced_index ||= nil
+  end
+
+  def with_forced_index(index_string)
+    @forced_index = index_string
+    self
+  end
+end

data/lib/refine/rails/version.rb

@@ -1,5 +1,5 @@
 module Refine
   module Rails
-    VERSION = "2.12.2"
+    VERSION = "2.13.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: refine-rails
 version: !ruby/object:Gem::Version
-  version: 2.12.2
+  version: 2.13.1
 platform: ruby
 authors:
 - Colleen Schnettler
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-12 00:00:00.000000000 Z
+date: 2025-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -97,10 +97,12 @@ files:
 - app/models/refine/conditions/has_icon.rb
 - app/models/refine/conditions/has_meta.rb
 - app/models/refine/conditions/has_refinements.rb
+- app/models/refine/conditions/has_through_id_relationship.rb
 - app/models/refine/conditions/numeric_condition.rb
 - app/models/refine/conditions/option_condition.rb
 - app/models/refine/conditions/text_condition.rb
 - app/models/refine/conditions/uses_attributes.rb
+- app/models/refine/conditions/with_forced_index.rb
 - app/models/refine/filter.rb
 - app/models/refine/filter/internationalized.rb
 - app/models/refine/filters/blueprint_editor.rb