Class: Ransack::Context

Inherits:
Object
  • Object
show all
Defined in:
lib/ransack/context.rb

Direct Known Subclasses

Adapters::ActiveRecord::Context

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of Context.



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/ransack/context.rb', line 33

def initialize(object, options = {})
  @object = relation_for(object)
  @klass = @object.klass
  @join_dependency = join_dependency(@object)
  @join_type = options[:join_type] || Arel::OuterJoin
  @search_key = options[:search_key] || Ransack.options[:search_key]

  if ::ActiveRecord::VERSION::STRING >= "4.1"
    @base = @join_dependency.join_root
    @engine = @base.base_klass.arel_engine
  else
    @base = @join_dependency.join_base
    @engine = @base.arel_engine
  end

  @default_table = Arel::Table.new(
    @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)
    if parent && attr_name
      hash[key] = [parent, attr_name]
    end
  end
end

Instance Attribute Details

#arel_visitor ⇒ Object (readonly)

Returns the value of attribute arel_visitor.



5
6
7
 
# File 'lib/ransack/context.rb', line 5

def arel_visitor
  @arel_visitor
end

#auth_object ⇒ Object

Returns the value of attribute auth_object.



6
7
8
 
# File 'lib/ransack/context.rb', line 6

def auth_object
  @auth_object
end

#base ⇒ Object (readonly)

Returns the value of attribute base.



5
6
7
 
# File 'lib/ransack/context.rb', line 5

def base
  @base
end

#engine ⇒ Object (readonly)

Returns the value of attribute engine.



5
6
7
 
# File 'lib/ransack/context.rb', line 5

def engine
  @engine
end

#klass ⇒ Object (readonly)

Returns the value of attribute klass.



5
6
7
 
# File 'lib/ransack/context.rb', line 5

def klass
  @klass
end

#object ⇒ Object (readonly)

Returns the value of attribute object.



5
6
7
 
# File 'lib/ransack/context.rb', line 5

def object
  @object
end

#search ⇒ Object (readonly)

Returns the value of attribute search.



5
6
7
 
# File 'lib/ransack/context.rb', line 5

def search
  @search
end

#search_key ⇒ Object

Returns the value of attribute search_key.



6
7
8
 
# File 'lib/ransack/context.rb', line 6

def search_key
  @search_key
end

Class Method Details

.for(object, options = {}) ⇒ Object 



10
11
12
13
14
15
16
 
# File 'lib/ransack/context.rb', line 10

def for(object, options = {})
  context = Class === object ?
    for_class(object, options) :
    for_object(object, options)
  context or raise ArgumentError,
    "Don't know what context to use for #{object}"
end

.for_class(klass, options = {}) ⇒ Object 



18
19
20
21
22
 
# File 'lib/ransack/context.rb', line 18

def for_class(klass, options = {})
  if klass < ActiveRecord::Base
    Adapters::ActiveRecord::Context.new(klass, options)
  end
end

.for_object(object, options = {}) ⇒ Object 



24
25
26
27
28
29
 
# File 'lib/ransack/context.rb', line 24

def for_object(object, options = {})
  case object
  when ActiveRecord::Relation
    Adapters::ActiveRecord::Context.new(object.klass, options)
  end
end

Instance Method Details

#association_path(str, base = @base) ⇒ Object 



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/ransack/context.rb', line 107

def association_path(str, base = @base)
  base = klassify(base)
  str ||= ''
  path = []
  segments = str.split(/_/)
  association_parts = []
  if (segments = str.split(/_/)).size > 0
    while segments.size > 0 && !base.columns_hash[segments.join('_')] &&
    association_parts << segments.shift do
      assoc, klass = unpolymorphize_association(association_parts
      .join('_'))
      if found_assoc = get_association(assoc, base)
        path += association_parts
        association_parts = []
        base = klassify(klass || found_assoc)
      end
    end
  end

  path.join('_')
end

#bind(object, str) ⇒ Object 



80
81
82
 
# File 'lib/ransack/context.rb', line 80

def bind(object, str)
  object.parent, object.attr_name = @bind_pairs[str]
end

#contextualize(str) ⇒ Object

Convert a string representing a chain of associations and an attribute into the attribute itself



75
76
77
78
 
# File 'lib/ransack/context.rb', line 75

def contextualize(str)
  parent, attr_name = @bind_pairs[str]
  table_for(parent)[attr_name]
end

#klassify(obj) ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/ransack/context.rb', line 59

def klassify(obj)
  if Class === obj && ::ActiveRecord::Base > obj
    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
end

#ransackable_association?(str, klass) ⇒ Boolean

Returns:

  • (Boolean) 


142
143
144
 
# File 'lib/ransack/context.rb', line 142

def ransackable_association?(str, klass)
  klass.ransackable_associations(auth_object).include? str
end

#ransackable_attribute?(str, klass) ⇒ Boolean

Returns:

  • (Boolean) 


137
138
139
140
 
# File 'lib/ransack/context.rb', line 137

def ransackable_attribute?(str, klass)
  klass.ransackable_attributes(auth_object).include?(str) ||
  klass.ransortable_attributes(auth_object).include?(str)
end

#searchable_associations(str = '') ⇒ Object 



154
155
156
 
# File 'lib/ransack/context.rb', line 154

def searchable_associations(str = '')
  traverse(str).ransackable_associations(auth_object)
end

#searchable_attributes(str = '') ⇒ Object 



146
147
148
 
# File 'lib/ransack/context.rb', line 146

def searchable_attributes(str = '')
  traverse(str).ransackable_attributes(auth_object)
end

#sortable_attributes(str = '') ⇒ Object 



150
151
152
 
# File 'lib/ransack/context.rb', line 150

def sortable_attributes(str = '')
  traverse(str).ransortable_attributes(auth_object)
end

#traverse(str, base = @base) ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/ransack/context.rb', line 84

def traverse(str, base = @base)
  str ||= ''

  if (segments = str.split(/_/)).size > 0
    remainder = []
    found_assoc = nil
    while !found_assoc && segments.size > 0 do
      # Strip the _of_Model_type text from the association name, but hold
      # onto it in klass, for use as the next base
      assoc, klass = unpolymorphize_association(segments.join('_'))
      if found_assoc = get_association(assoc, base)
        base = traverse(remainder.join('_'), klass || found_assoc.klass)
      end

      remainder.unshift segments.pop
    end
    raise UntraversableAssociationError,
      "No association matches #{str}" unless found_assoc
  end

  klassify(base)
end

#unpolymorphize_association(str) ⇒ Object 



129
130
131
132
133
134
135
 
# File 'lib/ransack/context.rb', line 129

def unpolymorphize_association(str)
  if (match = str.match(/_of_([^_]+?)_type$/))
    [match.pre_match, Kernel.const_get(match.captures.first)]
  else
    [str, nil]
  end
end