Class: ThinkingSphinx::Index::FauxColumn

Inherits:
Object
  • Object
show all
Defined in:
lib/thinking_sphinx/index/faux_column.rb

Overview

Instances of this class represent database columns and the stack of associations that lead from the base model to them.

The name and stack are accessible through methods starting with __ to avoid conflicting with the method_missing calls that build the stack.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*stack) ⇒ FauxColumn

Create a new column with a pre-defined stack. The top element in the stack will get shifted to be the name value.



13
14
15
16
 
# File 'lib/thinking_sphinx/index/faux_column.rb', line 13

def initialize(*stack)
  @name  = stack.pop
  @stack = stack
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method, *args) ⇒ Object

This handles any ‘invalid’ method calls and sets them as the name, and pushing the previous name into the stack. The object returns itself.

If there’s a single argument, it becomes the name, and the method symbol goes into the stack as well. Multiple arguments means new columns with the original stack and new names (from each argument) gets returned.

Easier to explain with examples:

col = FauxColumn.new :a, :b, :c
col.__name  #=> :c
col.__stack #=> [:a, :b]

col.whatever #=> col
col.__name  #=> :whatever
col.__stack #=> [:a, :b, :c]

col.something(:id) #=> col
col.__name  #=> :id
col.__stack #=> [:a, :b, :c, :whatever, :something]

cols = col.short(:x, :y, :z)
cols[0].__name  #=> :x
cols[0].__stack #=> [:a, :b, :c, :whatever, :something, :short]
cols[1].__name  #=> :y
cols[1].__stack #=> [:a, :b, :c, :whatever, :something, :short]
cols[2].__name  #=> :z
cols[2].__stack #=> [:a, :b, :c, :whatever, :something, :short]

Also, this allows method chaining to build up a relevant stack:

col = FauxColumn.new :a, :b
col.__name  #=> :b
col.__stack #=> [:a]

col.one.two.three #=> col
col.__name  #=> :three
col.__stack #=> [:a, :b, :one, :two]



102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/thinking_sphinx/index/faux_column.rb', line 102

def method_missing(method, *args)
  @stack << @name
  @name   = method
  
  if (args.empty?)
    self
  elsif (args.length == 1)
    method_missing(args.first)
  else
    args.collect { |arg|
      FauxColumn.new(@stack + [@name, arg])
    }
  end
end

Class Method Details

.coerce(columns) ⇒ Object 



18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/thinking_sphinx/index/faux_column.rb', line 18

def self.coerce(columns)
  case columns
  when Symbol, String
    FauxColumn.new(columns)
  when Array
    columns.collect { |col| FauxColumn.coerce(col) }
  when FauxColumn
    columns
  else
    nil
  end
end

Instance Method Details

#__name ⇒ Object

Can’t use normal method name, as that could be an association or column name.



34
35
36
 
# File 'lib/thinking_sphinx/index/faux_column.rb', line 34

def __name
  @name
end

#__path ⇒ Object 



45
46
47
 
# File 'lib/thinking_sphinx/index/faux_column.rb', line 45

def __path
  @stack + [@name]
end

#__stack ⇒ Object

Can’t use normal method name, as that could be an association or column name.



41
42
43
 
# File 'lib/thinking_sphinx/index/faux_column.rb', line 41

def __stack
  @stack
end

#is_string? ⇒ Boolean

Returns true if the stack is empty and if the name is a string - which is an indication that of raw SQL, as opposed to a value from a table’s column.

Returns:

  • (Boolean) 


53
54
55
 
# File 'lib/thinking_sphinx/index/faux_column.rb', line 53

def is_string?
  @name.is_a?(String) && @stack.empty?
end

#to_ary ⇒ Object 



57
58
59
 
# File 'lib/thinking_sphinx/index/faux_column.rb', line 57

def to_ary
  [self]
end