ransack 1.8.3 → 2.3.0

data/lib/ransack/adapters/active_record/context.rb

@@ -1,5 +1,4 @@
 require 'ransack/context'
-require 'ransack/adapters/active_record/compat'
 require 'polyamorous'
 
 module Ransack
@@ -7,14 +6,11 @@ module Ransack
     module ActiveRecord
       class Context < ::Ransack::Context
 
-        # Because the AR::Associations namespace is insane
-        if defined? ::ActiveRecord::Associations::JoinDependency
-          JoinDependency = ::ActiveRecord::Associations::JoinDependency
-        end
-
         def initialize(object, options = {})
           super
-          @arel_visitor = @engine.connection.visitor
+          if ::ActiveRecord::VERSION::STRING < Constants::RAILS_5_2
+            @arel_visitor = @engine.connection.visitor
+          end
         end
 
         def relation_for(object)
@@ -25,19 +21,39 @@ module Ransack
           return nil unless attr && attr.valid?
           name         = attr.arel_attribute.name.to_s
           table        = attr.arel_attribute.relation.table_name
-          schema_cache = @engine.connection.schema_cache
-          unless schema_cache.send(database_table_exists?, table)
+          schema_cache = self.klass.connection.schema_cache
+          unless schema_cache.send(:data_source_exists?, table)
             raise "No table named #{table} exists."
           end
-          schema_cache.columns_hash(table)[name].type
+          attr.klass.columns.find { |column| column.name == name }.type
         end
 
         def evaluate(search, opts = {})
           viz = Visitor.new
           relation = @object.where(viz.accept(search.base))
+
           if search.sorts.any?
-            relation = relation.except(:order).reorder(viz.accept(search.sorts))
+            relation = relation.except(:order)
+            # Rather than applying all of the search's sorts in one fell swoop,
+            # as the original implementation does, we apply one at a time.
+            #
+            # If the sort (returned by the Visitor above) is a symbol, we know
+            # that it represents a scope on the model and we can apply that
+            # scope.
+            #
+            # Otherwise, we fall back to the applying the sort with the "order"
+            # method as the original implementation did. Actually the original
+            # implementation used "reorder," which was overkill since we already
+            # have a clean slate after "relation.except(:order)" above.
+            viz.accept(search.sorts).each do |scope_or_sort|
+              if scope_or_sort.is_a?(Symbol)
+                relation = relation.send(scope_or_sort)
+              else
+                relation = relation.order(scope_or_sort)
+              end
+            end
           end
+
           opts[:distinct] ? relation.distinct : relation
         end
 
@@ -45,7 +61,7 @@ module Ransack
           exists = false
           if ransackable_attribute?(str, klass)
             exists = true
-          elsif (segments = str.split(/_/)).size > 1
+          elsif (segments = str.split(Constants::UNDERSCORE)).size > 1
             remainder = []
             found_assoc = nil
             while !found_assoc && remainder.unshift(segments.pop) &&
@@ -80,84 +96,56 @@ module Ransack
           end
         end
 
-        if ::ActiveRecord::VERSION::STRING >= Constants::RAILS_4_1
-
-          def join_associations
-            raise NotImplementedError,
-            "ActiveRecord 4.1 and later does not use join_associations. Use join_sources."
-          end
-
-          # All dependent Arel::Join nodes used in the search query.
-          #
-          # This could otherwise be done as `@object.arel.join_sources`, except
-          # that ActiveRecord's build_joins sets up its own JoinDependency.
-          # This extracts what we need to access the joins using our existing
-          # JoinDependency to track table aliases.
-          #
-          def join_sources
-            base, joins =
-            if ::ActiveRecord::VERSION::MAJOR >= 5
-              [
-                Arel::SelectManager.new(@object.table),
-                @join_dependency.join_constraints(@object.joins_values, @join_type)
-              ]
+        # All dependent Arel::Join nodes used in the search query.
+        #
+        # This could otherwise be done as `@object.arel.join_sources`, except
+        # that ActiveRecord's build_joins sets up its own JoinDependency.
+        # This extracts what we need to access the joins using our existing
+        # JoinDependency to track table aliases.
+        #
+        def join_sources
+          base, joins =
+          if ::ActiveRecord::VERSION::STRING > Constants::RAILS_5_2_0
+            alias_tracker = ::ActiveRecord::Associations::AliasTracker.create(self.klass.connection, @object.table.name, [])
+            constraints   = if ::Gem::Version.new(::ActiveRecord::VERSION::STRING) >= ::Gem::Version.new(Constants::RAILS_6_0)
+              @join_dependency.join_constraints(@object.joins_values, alias_tracker)
             else
-              [
-                Arel::SelectManager.new(@object.engine, @object.table),
-                @join_dependency.join_constraints(@object.joins_values)
-              ]
-            end
-            joins.each do |aliased_join|
-              base.from(aliased_join)
+              @join_dependency.join_constraints(@object.joins_values, @join_type, alias_tracker)
             end
-            base.join_sources
-          end
-
-        else
 
-          # All dependent JoinAssociation items used in the search query.
-          #
-          # Deprecated: this goes away in ActiveRecord 4.1. Use join_sources.
-          #
-          def join_associations
-            @join_dependency.join_associations
+            [
+              Arel::SelectManager.new(@object.table),
+              constraints
+            ]
+          else
+            [
+              Arel::SelectManager.new(@object.table),
+              @join_dependency.join_constraints(@object.joins_values, @join_type)
+            ]
           end
-
-          def join_sources
-            base = Arel::SelectManager.new(@object.engine, @object.table)
-            joins = @object.joins_values
-            joins.each do |assoc|
-              assoc.join_to(base)
-            end
-            base.join_sources
+          joins = joins.collect(&:joins).flatten if ::ActiveRecord::VERSION::STRING < Constants::RAILS_5_2
+          joins.each do |aliased_join|
+            base.from(aliased_join)
           end
-
+          base.join_sources
         end
 
         def alias_tracker
-          @join_dependency.alias_tracker
+          @join_dependency.send(:alias_tracker)
         end
 
         def lock_association(association)
           @lock_associations << association
         end
 
-        if ::ActiveRecord::VERSION::STRING >= Constants::RAILS_4_1
-          def remove_association(association)
-            return if @lock_associations.include?(association)
-            @join_dependency.join_root.children.delete_if { |stashed|
-              stashed.eql?(association)
-            }
-            @object.joins_values.delete_if { |jd|
-              jd.join_root.children.map(&:object_id) == [association.object_id]
-            }
-          end
-        else
-          def remove_association(association)
-            return if @lock_associations.include?(association)
-            @join_dependency.join_parts.delete(association)
-            @object.joins_values.delete(association)
-          end
+        def remove_association(association)
+          return if @lock_associations.include?(association)
+          @join_dependency.instance_variable_get(:@join_root).children.delete_if { |stashed|
+            stashed.eql?(association)
+          }
+          @object.joins_values.delete_if { |jd|
+            jd.instance_variable_get(:@join_root).children.map(&:object_id) == [association.object_id]
+          }
         end
 
         # Build an Arel subquery that selects keys for the top query,
@@ -181,8 +169,7 @@ module Ransack
         def build_correlated_subquery(association)
           join_constraints = extract_joins(association)
           join_root = join_constraints.shift
-          join_table = join_root.left
-          correlated_key = join_root.right.expr.left
+          correlated_key = extract_correlated_key(join_root)
           subquery = Arel::SelectManager.new(association.base_klass)
           subquery.from(join_root.left)
           subquery.project(correlated_key)
@@ -198,11 +185,17 @@ module Ransack
 
         private
 
-        def database_table_exists?
-          if ::ActiveRecord::VERSION::MAJOR >= 5
-            :data_source_exists?
+        def extract_correlated_key(join_root)
+          correlated_key = join_root.right.expr.left
+
+          if correlated_key.is_a? Arel::Nodes::And
+            correlated_key = correlated_key.left.left
+          elsif correlated_key.is_a? Arel::Nodes::Equality
+            correlated_key = correlated_key.left
+          elsif correlated_key.is_a? Arel::Nodes::Grouping
+            correlated_key = join_root.right.expr.right.left
           else
-            :table_exists?
+            correlated_key
           end
         end
 
@@ -250,7 +243,9 @@ module Ransack
         # Checkout active_record/relation/query_methods.rb +build_joins+ for
         # reference. Lots of duplicated code maybe we can avoid it
         def build_joins(relation)
-          buckets = relation.joins_values.group_by do |join|
+          buckets = relation.joins_values + relation.left_outer_joins_values
+
+          buckets = buckets.group_by do |join|
             case join
             when String
               :string_join
@@ -268,123 +263,138 @@ module Ransack
           association_joins         = buckets[:association_join]
           stashed_association_joins = buckets[:stashed_join]
           join_nodes                = buckets[:join_node].uniq
-          string_joins              = buckets[:string_join].map(&:strip).uniq
+          string_joins              = buckets[:string_join].map(&:strip)
+          string_joins.uniq!
 
-          join_list =
-            if ::ActiveRecord::VERSION::MAJOR >= 5
-              join_nodes +
-              convert_join_strings_to_ast(relation.table, string_joins)
-            else
-              relation.send :custom_join_ast,
-                relation.table.from(relation.table), string_joins
-            end
-
-          join_dependency = JoinDependency.new(
-            relation.klass, association_joins, join_list
-          )
-
-          join_nodes.each do |join|
-            join_dependency.alias_tracker.aliases[join.left.name.downcase] = 1
-          end
+          join_list = join_nodes + convert_join_strings_to_ast(relation.table, string_joins)
 
-          if ::ActiveRecord::VERSION::STRING >= Constants::RAILS_4_1
-            join_dependency
+          if ::ActiveRecord::VERSION::STRING < Constants::RAILS_5_2_0
+            join_dependency = Polyamorous::JoinDependency.new(relation.klass, association_joins, join_list)
+            join_nodes.each do |join|
+              join_dependency.send(:alias_tracker).aliases[join.left.name.downcase] = 1
+            end
+          elsif ::ActiveRecord::VERSION::STRING == Constants::RAILS_5_2_0
+            alias_tracker = ::ActiveRecord::Associations::AliasTracker.create(self.klass.connection, relation.table.name, join_list)
+            join_dependency = Polyamorous::JoinDependency.new(relation.klass, relation.table, association_joins, alias_tracker)
+            join_nodes.each do |join|
+              join_dependency.send(:alias_tracker).aliases[join.left.name.downcase] = 1
+            end
           else
-            join_dependency.graft(*stashed_association_joins)
+            alias_tracker = ::ActiveRecord::Associations::AliasTracker.create(self.klass.connection, relation.table.name, join_list)
+            join_dependency = if ::Gem::Version.new(::ActiveRecord::VERSION::STRING) >= ::Gem::Version.new(Constants::RAILS_6_0)
+              Polyamorous::JoinDependency.new(relation.klass, relation.table, association_joins, Arel::Nodes::OuterJoin)
+            else
+              Polyamorous::JoinDependency.new(relation.klass, relation.table, association_joins)
+            end
+            join_dependency.instance_variable_set(:@alias_tracker, alias_tracker)
+            join_nodes.each do |join|
+              join_dependency.send(:alias_tracker).aliases[join.left.name.downcase] = 1
+            end
           end
+          join_dependency
         end
 
         def convert_join_strings_to_ast(table, joins)
+          joins.map! { |join| table.create_string_join(Arel.sql(join)) unless join.blank? }
+          joins.compact!
           joins
-          .flatten
-          .reject(&:blank?)
-          .map { |join| table.create_string_join(Arel.sql(join)) }
         end
 
         def build_or_find_association(name, parent = @base, klass = nil)
           find_association(name, parent, klass) or build_association(name, parent, klass)
         end
 
-        if ::ActiveRecord::VERSION::STRING >= Constants::RAILS_4_1
-
-          def find_association(name, parent = @base, klass = nil)
-            @join_dependency.join_root.children.detect do |assoc|
-              assoc.reflection.name == name &&
-              (@associations_pot.empty? || @associations_pot[assoc] == parent) &&
-              (!klass || assoc.reflection.klass == klass)
-            end
+        def find_association(name, parent = @base, klass = nil)
+          @join_dependency.instance_variable_get(:@join_root).children.detect do |assoc|
+            assoc.reflection.name == name && assoc.table &&
+            (@associations_pot.empty? || @associations_pot[assoc] == parent || !@associations_pot.key?(assoc)) &&
+            (!klass || assoc.reflection.klass == klass)
           end
+        end
 
-          def build_association(name, parent = @base, klass = nil)
-            jd = JoinDependency.new(
+        def build_association(name, parent = @base, klass = nil)
+          if ::Gem::Version.new(::ActiveRecord::VERSION::STRING) >= ::Gem::Version.new(Constants::RAILS_6_0)
+            jd = Polyamorous::JoinDependency.new(
+              parent.base_klass,
+              parent.table,
+              Polyamorous::Join.new(name, @join_type, klass),
+              @join_type
+            )
+            found_association = jd.instance_variable_get(:@join_root).children.last
+          elsif ::Gem::Version.new(::ActiveRecord::VERSION::STRING) < ::Gem::Version.new(Constants::RAILS_5_2_0)
+            jd = Polyamorous::JoinDependency.new(
               parent.base_klass,
               Polyamorous::Join.new(name, @join_type, klass),
               []
             )
             found_association = jd.join_root.children.last
-            @associations_pot[found_association] = parent
-
-            # TODO maybe we dont need to push associations here, we could loop
-            # through the @associations_pot instead
-            @join_dependency.join_root.children.push found_association
-
-            # Builds the arel nodes properly for this association
-            @join_dependency.send(
-              :construct_tables!, jd.join_root, found_association
-              )
-
-            # Leverage the stashed association functionality in AR
-            @object = @object.joins(jd)
-
-            found_association
-          end
-
-          def extract_joins(association)
-            parent = @join_dependency.join_root
-            reflection = association.reflection
-            join_constraints = association.join_constraints(
+          elsif ::ActiveRecord::VERSION::STRING == Constants::RAILS_5_2_0
+            alias_tracker = ::ActiveRecord::Associations::AliasTracker.create(self.klass.connection, parent.table.name, [])
+            jd = Polyamorous::JoinDependency.new(
+              parent.base_klass,
               parent.table,
+              Polyamorous::Join.new(name, @join_type, klass),
+              alias_tracker
+            )
+            found_association = jd.instance_variable_get(:@join_root).children.last
+          else
+            jd = Polyamorous::JoinDependency.new(
               parent.base_klass,
-              association,
-              Arel::Nodes::OuterJoin,
-              association.tables,
-              reflection.scope_chain,
-              reflection.chain
+              parent.table,
+              Polyamorous::Join.new(name, @join_type, klass)
             )
-            join_constraints.to_a.flatten
+            found_association = jd.instance_variable_get(:@join_root).children.last
           end
 
-        else
+          @associations_pot[found_association] = parent
 
-          def build_association(name, parent = @base, klass = nil)
-            @join_dependency.send(
-              :build,
-              Polyamorous::Join.new(name, @join_type, klass),
-              parent
-              )
-            found_association = @join_dependency.join_associations.last
-            # Leverage the stashed association functionality in AR
-            @object = @object.joins(found_association)
+          # TODO maybe we dont need to push associations here, we could loop
+          # through the @associations_pot instead
+          @join_dependency.instance_variable_get(:@join_root).children.push found_association
 
-            found_association
-          end
-
-          def extract_joins(association)
-            query = Arel::SelectManager.new(association.base_klass, association.table)
-            association.join_to(query).join_sources
-          end
-
-          def find_association(name, parent = @base, klass = nil)
-            found_association = @join_dependency.join_associations
-            .detect do |assoc|
-              assoc.reflection.name == name &&
-              assoc.parent == parent &&
-              (!klass || assoc.reflection.klass == klass)
-            end
+          # Builds the arel nodes properly for this association
+          if ::ActiveRecord::VERSION::STRING > Constants::RAILS_5_2_0
+            @join_dependency.send(:construct_tables!, jd.instance_variable_get(:@join_root))
+          else
+            @join_dependency.send(:construct_tables!, jd.instance_variable_get(:@join_root), found_association)
           end
 
+          # Leverage the stashed association functionality in AR
+          @object = @object.joins(jd)
+          found_association
         end
 
+        def extract_joins(association)
+          parent = @join_dependency.instance_variable_get(:@join_root)
+          reflection = association.reflection
+          join_constraints = if ::ActiveRecord::VERSION::STRING < Constants::RAILS_5_1
+                               association.join_constraints(
+                                 parent.table,
+                                 parent.base_klass,
+                                 association,
+                                 Arel::Nodes::OuterJoin,
+                                 association.tables,
+                                 reflection.scope_chain,
+                                 reflection.chain
+                               )
+                             elsif ::ActiveRecord::VERSION::STRING <= Constants::RAILS_5_2_0
+                               association.join_constraints(
+                                 parent.table,
+                                 parent.base_klass,
+                                 Arel::Nodes::OuterJoin,
+                                 association.tables,
+                                 reflection.chain
+                               )
+                             else
+                               association.join_constraints(
+                                 parent.table,
+                                 parent.base_klass,
+                                 Arel::Nodes::OuterJoin,
+                                 @join_dependency.instance_variable_get(:@alias_tracker)
+                               )
+                             end
+          join_constraints.to_a.flatten
+        end
       end
     end
   end

data/lib/ransack/adapters/active_record/ransack/constants.rb

@@ -102,9 +102,12 @@ module Ransack
     # replace % \ to \% \\
     def escape_wildcards(unescaped)
       case ActiveRecord::Base.connection.adapter_name
-      when "Mysql2".freeze, "PostgreSQL".freeze
-        # Necessary for PostgreSQL and MySQL
-        unescaped.to_s.gsub(/([\\|\%|_|.])/, '\\\\\\1')
+      when "Mysql2".freeze
+        # Necessary for MySQL
+        unescaped.to_s.gsub(/([\\%_])/, '\\\\\\1')
+      when "PostgreSQL".freeze
+        # Necessary for PostgreSQL
+        unescaped.to_s.gsub(/([\\%_.])/, '\\\\\\1')
       else
         unescaped
       end

data/lib/ransack/adapters/active_record/ransack/context.rb

@@ -30,22 +30,20 @@ module Ransack
       @associations_pot = {}
       @lock_associations = []
 
-      if ::ActiveRecord::VERSION::STRING >= Constants::RAILS_4_1
+      if ::ActiveRecord::VERSION::STRING >= Constants::RAILS_5_2
+        @base = @join_dependency.instance_variable_get(:@join_root)
+      else
         @base = @join_dependency.join_root
         @engine = @base.base_klass.arel_engine
-      else
-        @base = @join_dependency.join_base
-        @engine = @base.arel_engine
       end
+    end
 
-      @default_table = Arel::Table.new(
-        @base.table_name, as: @base.aliased_table_name, type_caster: self
-        )
-      @bind_pairs = Hash.new do |hash, key|
-        parent, attr_name = get_parent_and_attribute_name(key)
-        if parent && attr_name
-          hash[key] = [parent, attr_name]
-        end
+    def bind_pair_for(key)
+      @bind_pairs ||= {}
+
+      @bind_pairs[key] ||= begin
+        parent, attr_name = get_parent_and_attribute_name(key.to_s)
+        [parent, attr_name] if parent && attr_name
       end
     end
 
@@ -54,10 +52,6 @@ module Ransack
         obj
       elsif obj.respond_to? :klass
         obj.klass
-      elsif obj.respond_to? :active_record  # Rails 3
-        obj.active_record
-      elsif obj.respond_to? :base_klass     # Rails 4
-        obj.base_klass
       else
         raise ArgumentError, "Don't know how to klassify #{obj.inspect}"
       end

data/lib/ransack/adapters/active_record/ransack/nodes/condition.rb

@@ -33,8 +33,8 @@ module Ransack
           predicate = attribute.attr.public_send(arel_pred, arel_values)
 
           if in_predicate?(predicate)
-            predicate.right = predicate.right.map do |predicate|
-              casted_array?(predicate) ? format_values_for(predicate) : predicate
+            predicate.right = predicate.right.map do |pr|
+              casted_array?(pr) ? format_values_for(pr) : pr
             end
           end
 
@@ -43,7 +43,7 @@ module Ransack
 
         def in_predicate?(predicate)
           return unless defined?(Arel::Nodes::Casted)
-          predicate.class == Arel::Nodes::In
+          predicate.class == Arel::Nodes::In || predicate.class == Arel::Nodes::NotIn
         end
 
         def casted_array?(predicate)

data/lib/ransack/adapters/active_record/ransack/translate.rb

@@ -2,11 +2,7 @@ module Ransack
   module Translate
 
     def self.i18n_key(klass)
-      if ActiveRecord::VERSION::MAJOR == 3 && ActiveRecord::VERSION::MINOR == 0
-        klass.model_name.i18n_key.to_s.tr('.'.freeze, '/'.freeze)
-      else
-        klass.model_name.i18n_key.to_s.freeze
-      end
+      klass.model_name.i18n_key
     end
   end
 end

data/lib/ransack/adapters/active_record/ransack/visitor.rb

@@ -20,5 +20,28 @@ module Ransack
       end
     end
 
+    def visit_Ransack_Nodes_Sort(object)
+      if object.valid?
+        if object.attr.is_a?(Arel::Attributes::Attribute)
+          object.attr.send(object.dir)
+        else
+          ordered(object)
+        end
+      else
+        scope_name = :"sort_by_#{object.name}_#{object.dir}"
+        scope_name if object.context.object.respond_to?(scope_name)
+      end
+    end
+
+    private
+
+      def ordered(object)
+        case object.dir
+        when 'asc'.freeze
+          Arel::Nodes::Ascending.new(object.attr)
+        when 'desc'.freeze
+          Arel::Nodes::Descending.new(object.attr)
+        end
+      end
   end
 end

data/lib/ransack/adapters/active_record.rb

@@ -12,12 +12,3 @@ ActiveSupport.on_load(:active_record) do
 end
 
 require 'ransack/adapters/active_record/context'
-
-case ActiveRecord::VERSION::STRING
-when /^3\.0\./
-  require 'ransack/adapters/active_record/3.0/context'
-when /^3\.1\./
-  require 'ransack/adapters/active_record/3.1/context'
-when /^3\.2\./
-  require 'ransack/adapters/active_record/3.2/context'
-end

data/lib/ransack/adapters.rb

@@ -10,6 +10,8 @@ module Ransack
         ActiveRecordAdapter.new
       elsif defined?(::Mongoid)
         MongoidAdapter.new
+      else
+        raise "Unsupported adapter"
       end
     end