Class ThinkingSphinx::Index::FauxColumn
In: lib/thinking_sphinx/index/faux_column.rb
Parent: Object

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.

Methods

__name   __path   __stack   coerce   is_string?   method_missing   new   to_ary  

Public Class methods

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

Public Instance methods

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

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

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.

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]

[Validate]