ransack 1.5.1 → 1.6.0

data/Rakefile

@@ -1,13 +1,29 @@
 require 'bundler'
 require 'rspec/core/rake_task'
+require 'active_record'
 
 Bundler::GemHelper.install_tasks
 
 RSpec::Core::RakeTask.new(:spec) do |rspec|
+  ENV['SPEC'] = 'spec/ransack/**/*_spec.rb'
+  if ActiveRecord::VERSION::MAJOR >= 4 || RUBY_VERSION < '2.2'
+    # Raises `invalid option: --backtrace` with Rails 3.x on Ruby 2.2
+    rspec.rspec_opts = ['--backtrace']
+  end
+end
+
+RSpec::Core::RakeTask.new(:mongoid) do |rspec|
+  ENV['SPEC'] = 'spec/mongoid/**/*_spec.rb'
   rspec.rspec_opts = ['--backtrace']
 end
 
-task :default => :spec
+task :default do
+  if ENV['DB'] =~ /mongodb/
+    Rake::Task["mongoid"].invoke
+  else
+    Rake::Task["spec"].invoke
+  end
+end
 
 desc "Open an irb session with Ransack and the sample data used in specs"
 task :console do
@@ -16,4 +32,16 @@ task :console do
   require 'console'
   ARGV.clear
   IRB.start
-end
+end
+
+desc "Open an irb session with Ransack, Mongoid and the sample data used in specs"
+task :mongoid_console do
+  require 'irb'
+  require 'irb/completion'
+  require 'pry'
+  require 'mongoid'
+  require File.expand_path('../lib/ransack.rb', __FILE__)
+  require File.expand_path('../spec/mongoid/support/schema.rb', __FILE__)
+  ARGV.clear
+  Pry.start
+end

data/lib/ransack.rb

@@ -2,6 +2,12 @@ require 'active_support/core_ext'
 
 require 'ransack/configuration'
 
+if defined?(::Mongoid)
+  require 'ransack/adapters/mongoid/ransack/constants'
+else
+  require 'ransack/adapters/active_record/ransack/constants'
+end
+
 module Ransack
   extend Configuration
 
@@ -19,9 +25,12 @@ Ransack.configure do |config|
 end
 
 require 'ransack/translate'
+require 'ransack/adapters/active_record/ransack/translate' if defined?(::ActiveRecord::Base)
+require 'ransack/adapters/mongoid/ransack/translate' if defined?(::Mongoid)
 require 'ransack/search'
 require 'ransack/ransacker'
 require 'ransack/adapters/active_record' if defined?(::ActiveRecord::Base)
+require 'ransack/adapters/mongoid' if defined?(::Mongoid)
 require 'ransack/helpers'
 require 'action_controller'
 

data/lib/ransack/adapters/active_record/3.0/compat.rb

@@ -16,9 +16,12 @@ end
 
 class ::ActiveRecord::Associations::ClassMethods::JoinDependency::JoinBase
   def table
-    Arel::Table.new(table_name, :as      => aliased_table_name,
-                                :engine  => active_record.arel_engine,
-                                :columns => active_record.columns)
+    Arel::Table.new(
+      table_name,
+      :as      => aliased_table_name,
+      :engine  => active_record.arel_engine,
+      :columns => active_record.columns
+      )
   end
 end
 
@@ -120,9 +123,9 @@ module Arel
       def column_cache
         @column_cache ||= Hash.new do |hash, key|
           hash[key] = Hash[
-            @engine.connection.columns(key, "#{key} Columns").map do |c|
-              [c.name, c]
-            end
+            @engine.connection
+            .columns(key, "#{key} Columns")
+            .map { |c| [c.name, c] }
           ]
         end
       end
@@ -144,7 +147,7 @@ module Arel
       end
 
       def visit_Arel_Nodes_And o
-        o.children.map { |x| visit x }.join(' AND '.freeze)
+        o.children.map { |x| visit x }.join(Ransack::Constants::SPACED_AND)
       end
 
       def visit_Arel_Nodes_Not o
@@ -173,4 +176,4 @@ module Arel
     end
   end
 
-end
+end

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

@@ -30,10 +30,8 @@ module Ransack
             .reorder(viz.accept(search.sorts))
           end
           if opts[:distinct]
-            relation.select(
-              Ransack::Constants::DISTINCT + @klass.quoted_table_name +
-              '.*'.freeze
-              )
+            relation.select(Constants::DISTINCT + @klass.quoted_table_name +
+              Constants::DOT_ASTERIX)
           else
             relation
           end
@@ -50,11 +48,11 @@ module Ransack
             while !found_assoc && remainder.unshift(segments.pop) &&
               segments.size > 0 do
               assoc, poly_class = unpolymorphize_association(
-                segments.join(Ransack::Constants::UNDERSCORE)
+                segments.join(Constants::UNDERSCORE)
                 )
               if found_assoc = get_association(assoc, klass)
                 exists = attribute_method?(
-                  remainder.join(Ransack::Constants::UNDERSCORE),
+                  remainder.join(Constants::UNDERSCORE),
                   poly_class || found_assoc.klass
                   )
               end
@@ -104,14 +102,14 @@ module Ransack
             while remainder.unshift(segments.pop) && segments.size > 0 &&
               !found_assoc do
               assoc, klass = unpolymorphize_association(
-                segments.join(Ransack::Constants::UNDERSCORE)
+                segments.join(Constants::UNDERSCORE)
                 )
               if found_assoc = get_association(assoc, parent)
                 join = build_or_find_association(
                   found_assoc.name, parent, klass
                   )
                 parent, attr_name = get_parent_and_attribute_name(
-                  remainder.join(Ransack::Constants::UNDERSCORE), join
+                  remainder.join(Constants::UNDERSCORE), join
                   )
               end
             end
@@ -137,31 +135,25 @@ module Ransack
           buckets = relation.joins_values.group_by do |join|
             case join
             when String
-              Ransack::Constants::STRING_JOIN
+              Constants::STRING_JOIN
             when Hash, Symbol, Array
-              Ransack::Constants::ASSOCIATION_JOIN
+              Constants::ASSOCIATION_JOIN
             when ::ActiveRecord::Associations::ClassMethods::JoinDependency::JoinAssociation
-              Ransack::Constants::STASHED_JOIN
+              Constants::STASHED_JOIN
             when Arel::Nodes::Join
-              Ransack::Constants::JOIN_NODE
+              Constants::JOIN_NODE
             else
               raise 'unknown class: %s' % join.class.name
             end
           end
 
-          association_joins =
-            buckets[Ransack::Constants::ASSOCIATION_JOIN] || []
+          association_joins = buckets[Constants::ASSOCIATION_JOIN] || []
 
-          stashed_association_joins =
-            buckets[Ransack::Constants::STASHED_JOIN] || []
+          stashed_association_joins = buckets[Constants::STASHED_JOIN] || []
 
-          join_nodes =
-            buckets[Ransack::Constants::JOIN_NODE] || []
+          join_nodes = buckets[Constants::JOIN_NODE] || []
 
-          string_joins =
-            (buckets[Ransack::Constants::STRING_JOIN] || [])
-            .map { |x| x.strip }
-            .uniq
+          string_joins = (buckets[Constants::STRING_JOIN] || []).map(&:strip).uniq
 
           join_list = relation.send :custom_join_sql, (string_joins + join_nodes)
 

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

@@ -29,10 +29,8 @@ module Ransack
               .reorder(viz.accept(search.sorts))
           end
           if opts[:distinct]
-            relation.select(
-              Ransack::Constants::DISTINCT + @klass.quoted_table_name +
-              '.*'.freeze
-              )
+            relation.select(Constants::DISTINCT + @klass.quoted_table_name +
+              Constants::DOT_ASTERIX)
           else
             relation
           end
@@ -49,11 +47,11 @@ module Ransack
             while !found_assoc && remainder.unshift(segments.pop) &&
             segments.size > 0 do
               assoc, poly_class = unpolymorphize_association(
-                segments.join(Ransack::Constants::UNDERSCORE)
+                segments.join(Constants::UNDERSCORE)
                 )
               if found_assoc = get_association(assoc, klass)
                 exists = attribute_method?(
-                  remainder.join(Ransack::Constants::UNDERSCORE),
+                  remainder.join(Constants::UNDERSCORE),
                   poly_class || found_assoc.klass
                   )
               end
@@ -116,14 +114,14 @@ module Ransack
             while remainder.unshift(segments.pop) && segments.size > 0 &&
               !found_assoc do
               assoc, klass = unpolymorphize_association(
-                segments.join(Ransack::Constants::UNDERSCORE)
+                segments.join(Constants::UNDERSCORE)
                 )
               if found_assoc = get_association(assoc, parent)
                 join = build_or_find_association(
                   found_assoc.name, parent, klass
                   )
                 parent, attr_name = get_parent_and_attribute_name(
-                  remainder.join(Ransack::Constants::UNDERSCORE), join
+                  remainder.join(Constants::UNDERSCORE), join
                   )
               end
             end
@@ -150,31 +148,25 @@ module Ransack
           buckets = relation.joins_values.group_by do |join|
             case join
             when String
-              Ransack::Constants::STRING_JOIN
+              Constants::STRING_JOIN
             when Hash, Symbol, Array
-              Ransack::Constants::ASSOCIATION_JOIN
+              Constants::ASSOCIATION_JOIN
             when ::ActiveRecord::Associations::JoinDependency::JoinAssociation
-              Ransack::Constants::STASHED_JOIN
+              Constants::STASHED_JOIN
             when Arel::Nodes::Join
-              Ransack::Constants::JOIN_NODE
+              Constants::JOIN_NODE
             else
               raise 'unknown class: %s' % join.class.name
             end
           end
 
-          association_joins =
-            buckets[Ransack::Constants::ASSOCIATION_JOIN] || []
+          association_joins = buckets[Constants::ASSOCIATION_JOIN] || []
 
-          stashed_association_joins =
-            buckets[Ransack::Constants::STASHED_JOIN] || []
+          stashed_association_joins = buckets[Constants::STASHED_JOIN] || []
 
-          join_nodes =
-            buckets[Ransack::Constants::JOIN_NODE] || []
+          join_nodes = buckets[Constants::JOIN_NODE] || []
 
-          string_joins =
-            (buckets[Ransack::Constants::STRING_JOIN] || [])
-            .map { |x| x.strip }
-            .uniq
+          string_joins = (buckets[Constants::STRING_JOIN] || []).map(&:strip).uniq
 
           join_list = relation.send :custom_join_ast,
             relation.table.from(relation.table), string_joins

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

@@ -22,12 +22,13 @@ module Ransack
 
         def type_for(attr)
           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
-          raise "No table named #{table} exists" unless schema_cache.table_exists?(table)
-          schema_cache.columns_hash(table)[name].type
+          name        = attr.arel_attribute.name.to_s
+          table       = attr.arel_attribute.relation.table_name
+          connection  = attr.klass.connection
+          unless connection.table_exists?(table)
+            raise "No table named #{table} exists"
+          end
+          connection.schema_cache.columns_hash(table)[name].type
         end
 
         def evaluate(search, opts = {})
@@ -49,11 +50,11 @@ module Ransack
             while !found_assoc && remainder.unshift(segments.pop) &&
             segments.size > 0 do
               assoc, poly_class = unpolymorphize_association(
-                segments.join(Ransack::Constants::UNDERSCORE)
+                segments.join(Constants::UNDERSCORE)
                 )
               if found_assoc = get_association(assoc, klass)
                 exists = attribute_method?(
-                  remainder.join(Ransack::Constants::UNDERSCORE),
+                  remainder.join(Constants::UNDERSCORE),
                   poly_class || found_assoc.klass
                   )
               end
@@ -78,7 +79,7 @@ module Ransack
           end
         end
 
-        if ::ActiveRecord::VERSION::STRING >= '4.1'.freeze
+        if ::ActiveRecord::VERSION::STRING >= Constants::RAILS_4_1
 
           def join_associations
             raise NotImplementedError,
@@ -93,7 +94,12 @@ module Ransack
           # JoinDependency to track table aliases.
           #
           def join_sources
-            base = Arel::SelectManager.new(@object.engine, @object.table)
+            base =
+              if ::ActiveRecord::VERSION::MAJOR >= 5
+                Arel::SelectManager.new(@object.engine)
+              else
+                Arel::SelectManager.new(@object.engine, @object.table)
+              end
             joins = @join_dependency.join_constraints(@object.joins_values)
             joins.each do |aliased_join|
               base.from(aliased_join)
@@ -133,20 +139,20 @@ module Ransack
 
           if ransackable_attribute?(str, klassify(parent))
             attr_name = str
-          elsif (segments = str.split(Ransack::Constants::UNDERSCORE)).size > 1
+          elsif (segments = str.split(Constants::UNDERSCORE)).size > 1
             remainder = []
             found_assoc = nil
             while remainder.unshift(segments.pop) && segments.size > 0 &&
             !found_assoc do
               assoc, klass = unpolymorphize_association(
-                segments.join(Ransack::Constants::UNDERSCORE)
+                segments.join(Constants::UNDERSCORE)
                 )
               if found_assoc = get_association(assoc, parent)
                 join = build_or_find_association(
                   found_assoc.name, parent, klass
                   )
                 parent, attr_name = get_parent_and_attribute_name(
-                  remainder.join(Ransack::Constants::UNDERSCORE), join
+                  remainder.join(Constants::UNDERSCORE), join
                   )
               end
             end
@@ -175,34 +181,33 @@ module Ransack
           buckets = relation.joins_values.group_by do |join|
             case join
             when String
-              Ransack::Constants::STRING_JOIN
+              Constants::STRING_JOIN
             when Hash, Symbol, Array
-              Ransack::Constants::ASSOCIATION_JOIN
+              Constants::ASSOCIATION_JOIN
             when JoinDependency, JoinDependency::JoinAssociation
-              Ransack::Constants::STASHED_JOIN
+              Constants::STASHED_JOIN
             when Arel::Nodes::Join
-              Ransack::Constants::JOIN_NODE
+              Constants::JOIN_NODE
             else
               raise 'unknown class: %s' % join.class.name
             end
           end
 
-          association_joins =
-            buckets[Ransack::Constants::ASSOCIATION_JOIN] || []
+          association_joins = buckets[Constants::ASSOCIATION_JOIN] || []
 
-          stashed_association_joins =
-            buckets[Ransack::Constants::STASHED_JOIN] || []
+          stashed_association_joins = buckets[Constants::STASHED_JOIN] || []
 
-          join_nodes =
-            buckets[Ransack::Constants::JOIN_NODE] || []
+          join_nodes = buckets[Constants::JOIN_NODE] || []
 
-          string_joins =
-            (buckets[Ransack::Constants::STRING_JOIN] || [])
-            .map { |x| x.strip }
-            .uniq
+          string_joins = (buckets[Constants::STRING_JOIN] || []).map(&:strip).uniq
 
-          join_list = relation.send :custom_join_ast,
-            relation.table.from(relation.table), string_joins
+          join_list =
+            if ::ActiveRecord::VERSION::MAJOR >= 5
+              relation.send :custom_join_ast, relation.table.from, 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
@@ -212,14 +217,14 @@ module Ransack
             join_dependency.alias_tracker.aliases[join.left.name.downcase] = 1
           end
 
-          if ::ActiveRecord::VERSION::STRING >= '4.1'.freeze
+          if ::ActiveRecord::VERSION::STRING >= Constants::RAILS_4_1
             join_dependency
           else
             join_dependency.graft(*stashed_association_joins)
           end
         end
 
-        if ::ActiveRecord::VERSION::STRING >= '4.1'.freeze
+        if ::ActiveRecord::VERSION::STRING >= Constants::RAILS_4_1
 
           def build_or_find_association(name, parent = @base, klass = nil)
             found_association = @join_dependency.join_root.children

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

@@ -0,0 +1,113 @@
+module Ransack
+  module Constants
+    DISTINCT = 'DISTINCT '.freeze
+
+    DERIVED_PREDICATES = [
+      [CONT, {
+        :arel_predicate => 'matches'.freeze,
+        :formatter => proc { |v| "%#{escape_wildcards(v)}%" }
+        }
+      ],
+      ['not_cont'.freeze, {
+        :arel_predicate => 'does_not_match'.freeze,
+        :formatter => proc { |v| "%#{escape_wildcards(v)}%" }
+        }
+      ],
+      ['start'.freeze, {
+        :arel_predicate => 'matches'.freeze,
+        :formatter => proc { |v| "#{escape_wildcards(v)}%" }
+        }
+      ],
+      ['not_start'.freeze, {
+        :arel_predicate => 'does_not_match'.freeze,
+        :formatter => proc { |v| "#{escape_wildcards(v)}%" }
+        }
+      ],
+      ['end'.freeze, {
+        :arel_predicate => 'matches'.freeze,
+        :formatter => proc { |v| "%#{escape_wildcards(v)}" }
+        }
+      ],
+      ['not_end'.freeze, {
+        :arel_predicate => 'does_not_match'.freeze,
+        :formatter => proc { |v| "%#{escape_wildcards(v)}" }
+        }
+      ],
+      ['true'.freeze, {
+        :arel_predicate => proc { |v| v ? EQ : NOT_EQ },
+        :compounds => false,
+        :type => :boolean,
+        :validator => proc { |v| BOOLEAN_VALUES.include?(v) },
+        :formatter => proc { |v| true }
+        }
+      ],
+      ['not_true'.freeze, {
+        :arel_predicate => proc { |v| v ? NOT_EQ : EQ },
+        :compounds => false,
+        :type => :boolean,
+        :validator => proc { |v| BOOLEAN_VALUES.include?(v) },
+        :formatter => proc { |v| true }
+        }
+      ],
+      ['false'.freeze, {
+        :arel_predicate => proc { |v| v ? EQ : NOT_EQ },
+        :compounds => false,
+        :type => :boolean,
+        :validator => proc { |v| BOOLEAN_VALUES.include?(v) },
+        :formatter => proc { |v| false }
+        }
+      ],
+      ['not_false'.freeze, {
+        :arel_predicate => proc { |v| v ? NOT_EQ : EQ },
+        :compounds => false,
+        :type => :boolean,
+        :validator => proc { |v| BOOLEAN_VALUES.include?(v) },
+        :formatter => proc { |v| false }
+        }
+      ],
+      ['present'.freeze, {
+        :arel_predicate => proc { |v| v ? NOT_EQ_ALL : EQ_ANY },
+        :compounds => false,
+        :type => :boolean,
+        :validator => proc { |v| BOOLEAN_VALUES.include?(v) },
+        :formatter => proc { |v| [nil, EMPTY] }
+        }
+      ],
+      ['blank'.freeze, {
+        :arel_predicate => proc { |v| v ? EQ_ANY : NOT_EQ_ALL },
+        :compounds => false,
+        :type => :boolean,
+        :validator => proc { |v| BOOLEAN_VALUES.include?(v) },
+        :formatter => proc { |v| [nil, EMPTY] }
+        }
+      ],
+      ['null'.freeze, {
+        :arel_predicate => proc { |v| v ? EQ : NOT_EQ },
+        :compounds => false,
+        :type => :boolean,
+        :validator => proc { |v| BOOLEAN_VALUES.include?(v)},
+        :formatter => proc { |v| nil }
+        }
+      ],
+      ['not_null'.freeze, {
+        :arel_predicate => proc { |v| v ? NOT_EQ : EQ },
+        :compounds => false,
+        :type => :boolean,
+        :validator => proc { |v| BOOLEAN_VALUES.include?(v) },
+        :formatter => proc { |v| nil } }
+      ]
+    ].freeze
+
+  module_function
+    # 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')
+      else
+        unescaped
+      end
+    end
+  end
+end