ransack 1.2.3 → 1.3.0

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

@@ -73,6 +73,30 @@ module Ransack
           @engine.connection_pool.columns_hash[table][name].type
         end
 
+        def join_associations
+          @join_dependency.join_associations
+        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 = Arel::SelectManager.new(@object.engine, @object.table)
+          joins = @object.joins_values
+          joins.each do |assoc|
+            assoc.join_to(base)
+          end
+          base.join_sources
+        end
+
+        def alias_tracker
+          @join_dependency.alias_tracker
+        end
+
         private
 
         def get_parent_and_attribute_name(str, parent = @base)

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

@@ -12,6 +12,7 @@ module Ransack
         end
 
         def ransack(params = {}, options = {})
+          params = params.presence || {}
           Search.new(self, params ? params.delete_if {
             |k, v| v.blank? && v != false } : params, options)
         end
@@ -35,6 +36,11 @@ module Ransack
           reflect_on_all_associations.map { |a| a.name.to_s }
         end
 
+        # For overriding with a whitelist of symbols
+        def ransackable_scopes(auth_object = nil)
+          []
+        end
+
       end
     end
   end

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

@@ -78,7 +78,55 @@ module Ransack
           end
         end
 
-      private
+        if ::ActiveRecord::VERSION::STRING >= '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 = Arel::SelectManager.new(@object.engine, @object.table)
+            joins = @join_dependency.join_constraints(@object.joins_values)
+            joins.each do |aliased_join|
+              base.from(aliased_join)
+            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
+          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
+          end
+
+        end
+
+        def alias_tracker
+          @join_dependency.alias_tracker
+        end
+
+        private
 
         def get_parent_and_attribute_name(str, parent = @base)
           attr_name = nil

data/lib/ransack/configuration.rb

@@ -7,7 +7,8 @@ module Ransack
     mattr_accessor :predicates, :options
     self.predicates = {}
     self.options = {
-        search_key: :q
+      :search_key => :q,
+      :ignore_unknown_conditions => true
     }
 
     def configure
@@ -20,16 +21,18 @@ module Ransack
       compounds = opts.delete(:compounds)
       compounds = true if compounds.nil?
       compounds = false if opts[:wants_array]
-      opts[:arel_predicate] = opts[:arel_predicate].to_s
 
       self.predicates[name] = Predicate.new(opts)
 
       ['_any', '_all'].each do |suffix|
-        self.predicates[name + suffix] = Predicate.new(
+        compound_name = name + suffix
+        self.predicates[compound_name] = Predicate.new(
           opts.merge(
-            name: name + suffix,
-            arel_predicate: opts[:arel_predicate] + suffix,
-            compound: true
+            :name => compound_name,
+            :arel_predicate => arel_predicate_with_suffix(
+              opts[:arel_predicate], suffix
+              ),
+            :compound => true
           )
         )
       end if compounds
@@ -40,5 +43,19 @@ module Ransack
       self.options[:search_key] = name
     end
 
+    # raise an error if an unknown predicate, condition or attribute is passed
+    # into a search
+    def ignore_unknown_conditions=(boolean)
+      self.options[:ignore_unknown_conditions] = boolean
+    end
+
+    def arel_predicate_with_suffix(arel_predicate, suffix)
+      if arel_predicate === Proc
+        proc { |v| "#{arel_predicate.call(v)}#{suffix}" }
+      else
+        "#{arel_predicate}#{suffix}"
+      end
+    end
+
   end
 end

data/lib/ransack/constants.rb

@@ -2,97 +2,98 @@ module Ransack
   module Constants
     TRUE_VALUES = [true, 1, '1', 't', 'T', 'true', 'TRUE'].to_set
     FALSE_VALUES = [false, 0, '0', 'f', 'F', 'false', 'FALSE'].to_set
+    BOOLEAN_VALUES = TRUE_VALUES + FALSE_VALUES
 
     AREL_PREDICATES = %w(eq not_eq matches does_not_match lt lteq gt gteq in not_in)
 
     DERIVED_PREDICATES = [
       ['cont', {
-        arel_predicate: 'matches',
-        formatter: proc { |v| "%#{escape_wildcards(v)}%" }
+        :arel_predicate => 'matches',
+        :formatter => proc { |v| "%#{escape_wildcards(v)}%" }
         }
       ],
       ['not_cont', {
-        arel_predicate: 'does_not_match',
-        formatter: proc { |v| "%#{escape_wildcards(v)}%" }
+        :arel_predicate => 'does_not_match',
+        :formatter => proc { |v| "%#{escape_wildcards(v)}%" }
         }
       ],
       ['start', {
-        arel_predicate: 'matches',
-        formatter: proc { |v| "#{escape_wildcards(v)}%" }
+        :arel_predicate => 'matches',
+        :formatter => proc { |v| "#{escape_wildcards(v)}%" }
         }
       ],
       ['not_start', {
-        arel_predicate: 'does_not_match',
-        formatter: proc { |v| "#{escape_wildcards(v)}%" }
+        :arel_predicate => 'does_not_match',
+        :formatter => proc { |v| "#{escape_wildcards(v)}%" }
         }
       ],
       ['end', {
-        arel_predicate: 'matches',
-        formatter: proc { |v| "%#{escape_wildcards(v)}" }
+        :arel_predicate => 'matches',
+        :formatter => proc { |v| "%#{escape_wildcards(v)}" }
         }
       ],
       ['not_end', {
-        arel_predicate: 'does_not_match',
-        formatter: proc { |v| "%#{escape_wildcards(v)}" }
+        :arel_predicate => 'does_not_match',
+        :formatter => proc { |v| "%#{escape_wildcards(v)}" }
         }
       ],
       ['true', {
-        arel_predicate: 'eq',
-        compounds: false,
-        type: :boolean,
-        validator: proc { |v| TRUE_VALUES.include?(v) }
+        :arel_predicate => 'eq',
+        :compounds => false,
+        :type => :boolean,
+        :validator => proc { |v| TRUE_VALUES.include?(v) }
         }
       ],
       ['false', {
-        arel_predicate: 'eq',
-        compounds: false,
-        type: :boolean,
-        validator: proc { |v| TRUE_VALUES.include?(v) },
-        formatter: proc { |v| !v }
+        :arel_predicate => 'eq',
+        :compounds => false,
+        :type => :boolean,
+        :validator => proc { |v| TRUE_VALUES.include?(v) },
+        :formatter => proc { |v| !v }
         }
       ],
       ['present', {
-        arel_predicate: 'not_eq_all',
-        compounds: false,
-        type: :boolean,
-        validator: proc { |v| TRUE_VALUES.include?(v) },
-        formatter: proc { |v| [nil, ''] }
+        :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, ''] }
         }
       ],
       ['blank', {
-        arel_predicate: 'eq_any',
-        compounds: false,
-        type: :boolean,
-        validator: proc { |v| TRUE_VALUES.include?(v) },
-        formatter: proc { |v| [nil, ''] }
+        :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, ''] }
         }
       ],
       ['null', {
-        arel_predicate: 'eq',
-        compounds: false,
-        type: :boolean,
-        validator: proc { |v| TRUE_VALUES.include?(v)},
-        formatter: proc { |v| nil }
+        :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', {
-        arel_predicate: 'not_eq',
-        compounds: false,
-        type: :boolean,
-        validator: proc { |v| TRUE_VALUES.include?(v) },
-        formatter: proc { |v| nil } }
+        :arel_predicate => proc { |v| v ? 'not_eq' : 'eq' },
+        :compounds => false,
+        :type => :boolean,
+        :validator => proc { |v| BOOLEAN_VALUES.include?(v) },
+        :formatter => proc { |v| nil } }
       ]
     ]
 
-    module_function
+  module_function
     # replace % \ to \% \\
     def escape_wildcards(unescaped)
       case ActiveRecord::Base.connection.adapter_name
-      when "SQLite"
-        unescaped
-      else
+      when "Mysql2", "PostgreSQL"
         # Necessary for PostgreSQL and MySQL
         unescaped.to_s.gsub(/([\\|\%|.])/, '\\\\\\1')
+      else
+        unescaped
       end
     end
   end

data/lib/ransack/context.rb

@@ -2,7 +2,7 @@ require 'ransack/visitor'
 
 module Ransack
   class Context
-    attr_reader :search, :object, :klass, :base, :engine, :arel_visitor
+    attr_reader :object, :klass, :base, :engine, :arel_visitor
     attr_accessor :auth_object, :search_key
 
     class << self
@@ -46,7 +46,7 @@ module Ransack
       end
 
       @default_table = Arel::Table.new(
-        @base.table_name, as: @base.aliased_table_name, engine: @engine
+        @base.table_name, :as => @base.aliased_table_name, :engine => @engine
         )
       @bind_pairs = Hash.new do |hash, key|
         parent, attr_name = get_parent_and_attribute_name(key.to_s)
@@ -77,6 +77,19 @@ module Ransack
       table_for(parent)[attr_name]
     end
 
+    def chain_scope(scope, args)
+      return unless @klass.method(scope) && args != false
+      @object = if scope_arity(scope) < 1 && args == true
+                  @object.public_send(scope)
+                else
+                  @object.public_send(scope, *args)
+                end
+    end
+
+    def scope_arity(scope)
+      @klass.method(scope).arity
+    end
+
     def bind(object, str)
       object.parent, object.attr_name = @bind_pairs[str]
     end
@@ -143,6 +156,10 @@ module Ransack
       klass.ransackable_associations(auth_object).include? str
     end
 
+    def ransackable_scope?(str, klass)
+      klass.ransackable_scopes(auth_object).any? { |s| s.to_s == str }
+    end
+
     def searchable_attributes(str = '')
       traverse(str).ransackable_attributes(auth_object)
     end

data/lib/ransack/helpers/form_builder.rb

@@ -13,7 +13,7 @@ module Ransack
         text = args.first
         i18n = options[:i18n] || {}
         text ||= object.translate(
-          method, i18n.reverse_merge(include_associations: true)
+          method, i18n.reverse_merge(:include_associations => true)
           ) if object.respond_to? :translate
         super(method, text, options, &block)
       end
@@ -127,7 +127,8 @@ module Ransack
       end
 
       def combinator_select(options = {}, html_options = {})
-        template_collection_select(:m, combinator_choices, options, html_options)
+        template_collection_select(
+          :m, combinator_choices, options, html_options)
       end
 
       private
@@ -202,7 +203,7 @@ module Ransack
 
       def get_attribute_element(action, base)
         begin
-          [Translate.association(base, context: object.context),
+          [Translate.association(base, :context => object.context),
             collection_for_base(action, base)]
         rescue UntraversableAssociationError => e
           nil
@@ -214,7 +215,7 @@ module Ransack
           [attr_from_base_and_column(base, c),
             Translate.attribute(
               attr_from_base_and_column(base, c),
-              context: object.context
+              :context => object.context
             )
           ]
         end

data/lib/ransack/helpers/form_helper.rb

@@ -2,6 +2,26 @@ module Ransack
   module Helpers
     module FormHelper
 
+      def asc
+        'asc'.freeze
+      end
+
+      def desc
+        'desc'.freeze
+      end
+
+      def asc_arrow
+        '▲'.freeze
+      end
+
+      def desc_arrow
+        '▼'.freeze
+      end
+
+      def non_breaking_space
+        ' '.freeze
+      end
+
       def search_form_for(record, options = {}, &proc)
         if record.is_a?(Ransack::Search)
           search = record
@@ -20,15 +40,15 @@ module Ransack
         end
         options[:html] ||= {}
         html_options = {
-          class: options[:class].present? ?
+          :class => options[:class].present? ?
             "#{options[:class]}" :
             "#{search.klass.to_s.underscore}_search",
-          id: options[:id].present? ?
+          :id => options[:id].present? ?
             "#{options[:id]}" :
             "#{search.klass.to_s.underscore}_search",
-          method: :get
+          :method => :get
         }
-        options[:as] ||= 'q'
+        options[:as] ||= 'q'.freeze
         options[:html].reverse_merge!(html_options)
         options[:builder] ||= FormBuilder
 
@@ -45,7 +65,7 @@ module Ransack
         raise TypeError, "First argument must be a Ransack::Search!" unless
           Search === search
 
-        search_params = params[search.context.search_key] ||
+        search_params = params[search.context.search_key].presence ||
           {}.with_indifferent_access
 
         attr_name = attribute.to_s
@@ -54,7 +74,7 @@ module Ransack
           if args.size > 0 && !args.first.is_a?(Hash)
             args.shift.to_s
           else
-            Translate.attribute(attr_name, context: search.context)
+            Translate.attribute(attr_name, :context => search.context)
           end
           )
 
@@ -67,9 +87,9 @@ module Ransack
         current_dir = prev_attr == attr_name ? prev_dir : nil
 
         if current_dir
-          new_dir = current_dir == 'desc' ? 'asc' : 'desc'
+          new_dir = current_dir == desc ? asc : desc
         else
-          new_dir = default_order || 'asc'
+          new_dir = default_order || asc
         end
 
         html_options = args.first.is_a?(Hash) ? args.shift.dup : {}
@@ -77,7 +97,7 @@ module Ransack
         html_options[:class] = [css, html_options[:class]].compact.join(' ')
         query_hash = {}
         query_hash[search.context.search_key] = search_params
-          .merge(s: "#{attr_name} #{new_dir}")
+        .merge(:s => "#{attr_name} #{new_dir}")
         options.merge!(query_hash)
         options_for_url = params.merge options
 
@@ -90,7 +110,7 @@ module Ransack
         link_to(
           [ERB::Util.h(name), order_indicator_for(current_dir)]
             .compact
-            .join(' ')
+            .join(non_breaking_space)
             .html_safe,
           url,
           html_options
@@ -100,10 +120,10 @@ module Ransack
       private
 
       def order_indicator_for(order)
-        if order == 'asc'
-          '▲'
-        elsif order == 'desc'
-          '▼'
+        if order == asc
+          asc_arrow
+        elsif order == desc
+          desc_arrow
         else
           nil
         end