Class: Ransack::Adapters::ActiveRecord::Context

Inherits:
Context
  • Object
show all
Defined in:
lib/ransack/adapters/active_record/context.rb,
lib/ransack/adapters/active_record/3.0/context.rb,
lib/ransack/adapters/active_record/3.1/context.rb,
lib/ransack/adapters/active_record/3.2/context.rb

Constant Summary collapse

JoinDependency =

Because the AR::Associations namespace is insane

::ActiveRecord::Associations::JoinDependency
JoinPart = 
JoinDependency::JoinPart
JoinBase = 
JoinDependency::JoinBase

Instance Attribute Summary

Attributes inherited from Context

#arel_visitor, #auth_object, #base, #engine, #klass, #object, #search_key

Instance Method Summary collapse

Methods inherited from Context

#association_path, #bind, #chain_scope, #contextualize, for, for_class, for_object, #ransackable_association?, #ransackable_attribute?, #ransackable_scope?, #scope_arity, #searchable_associations, #searchable_attributes, #sortable_attributes, #traverse, #unpolymorphize_association

Constructor Details

#initialize(object, options = {}) ⇒ Context

Redefine a few things for ActiveRecord 3.2.



16
17
18
19
 
# File 'lib/ransack/adapters/active_record/3.0/context.rb', line 16

def initialize(object, options = {})
  super
  @arel_visitor = @engine.connection.visitor
end

Instance Method Details

#alias_tracker ⇒ Object

Raises:

  • (NotImplementedError) 


125
126
127
 
# File 'lib/ransack/adapters/active_record/context.rb', line 125

def alias_tracker
  @join_dependency.alias_tracker
end

#attribute_method?(str, klass = @klass) ⇒ Boolean

Returns:

  • (Boolean) 


42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/ransack/adapters/active_record/context.rb', line 42

def attribute_method?(str, klass = @klass)
  exists = false
  if ransackable_attribute?(str, klass)
    exists = true
  elsif (segments = str.split(/_/)).size > 1
    remainder = []
    found_assoc = nil
    while !found_assoc && remainder.unshift(segments.pop) &&
    segments.size > 0 do
      assoc, poly_class = unpolymorphize_association(
        segments.join(Ransack::Constants::UNDERSCORE)
        )
      if found_assoc = get_association(assoc, klass)
        exists = attribute_method?(
          remainder.join(Ransack::Constants::UNDERSCORE),
          poly_class || found_assoc.klass
          )
      end
    end
  end
  exists
end

#evaluate(search, opts = {}) ⇒ Object 



33
34
35
36
37
38
39
40
 
# File 'lib/ransack/adapters/active_record/context.rb', line 33

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))
  end
  opts[:distinct] ? relation.distinct : relation
end

#join_associations ⇒ Object

All dependent JoinAssociation items used in the search query



110
111
112
113
 
# File 'lib/ransack/adapters/active_record/context.rb', line 110

def join_associations
  raise NotImplementedError,
  "ActiveRecord 4.1 and later does not use join_associations. Use join_sources."
end

#join_sources ⇒ Object

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.



95
96
97
98
99
100
101
102
 
# File 'lib/ransack/adapters/active_record/context.rb', line 95

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

#klassify(obj) ⇒ Object 



69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/ransack/adapters/active_record/context.rb', line 69

def klassify(obj)
  if Class === obj && ::ActiveRecord::Base > obj
    obj
  elsif obj.respond_to? :klass
    obj.klass
  elsif obj.respond_to? :base_klass
    obj.base_klass
  else
    raise ArgumentError, "Don't know how to klassify #{obj}"
  end
end

#relation_for(object) ⇒ Object 



19
20
21
 
# File 'lib/ransack/adapters/active_record/context.rb', line 19

def relation_for(object)
  object.all
end

#table_for(parent) ⇒ Object 



65
66
67
 
# File 'lib/ransack/adapters/active_record/context.rb', line 65

def table_for(parent)
  parent.table
end

#type_for(attr) ⇒ Object 



23
24
25
26
27
28
29
30
31
 
# File 'lib/ransack/adapters/active_record/context.rb', line 23

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
end