Module: Repertoire::Faceting::Controller

Defined in:
lib/repertoire-faceting/controller.rb

Overview

Include this mixin in your controller to add faceting webservices for use with the javascript widgets. Implementors should over-ride base() to specify the model for the faceted browser.

class PaintingsController
  include Repertoire::Faceting::Controller
  def base
    Painting
  end
end

By default two web services are defined, one for the facet value count widgets and another for the result widget. Each builds on the model returned by base():

counts  ==> base.refine(params[:filter]).count(params[:facet])
results ==> base.refine(params[:filter]).to_a

If desired, you can use the Model API to specify a query that limits the faceting context to a subset of the available items from the start:

def base
  q = "#{params[:search]}%"
  Painting.where(["title like ?", q])
end

Finally, you are free to over-ride the counts() and results() webservices. Here we reorder the facet value counts depending on another webservice param:

def counts
  facet   = params[:facet]
  filter  = params[:filter] || {}
  sorting = case params[:order]
              when 'alphanumeric' then ["#{facet} ASC"]
              when 'count'        then ["count DESC", "#{facet} ASC"]
            end

  if stale?(base.facet_cache_key, :public => true)
    @counts = base.refine(filter).order(sorting).count(facet)
    render :json => @counts.to_a
  end
end

Instance Method Summary collapse

Instance Method Details

#counts ⇒ Object

Web-service to return value, count pairs for a given facet, given existing filter refinements on other facets in the context. Over-ride this method if you need to specify additional query params for faceting.

Public HTTP cache headers are set, in the following order:

- by the facet index table (if present)
- by the facet model table (if it has an updated_at column)
- otherwise, no HTTP cache header is set



56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/repertoire-faceting/controller.rb', line 56

def counts
  facet  = params[:facet]
  filter = params[:filter] || {}
  raise "Unkown facet #{facet}" unless base.facet?(facet)

  if stale?(base.facet_cache_key(facet), :public => true)

    @counts = base.refine(filter).count(facet)
    render :json => @counts.to_a

  end
end

#results ⇒ Object

Web-service to return the results of a query, given existing filter requirements. Over-ride this method if you need to specify additional query parms for faceting results.

Private HTTP cache headers are set:

- by the facet model table (if it has an updated_at column)
- otherwise, no HTTP cache header is set



76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/repertoire-faceting/controller.rb', line 76

def results
  filter = params[:filter] || {}
  
  if stale?(base.facet_cache_key)

    @results = base.refine(filter).to_a

    respond_to do |format|
      format.html { render @results, :layout => false }
      format.json { render :json => @results }
    end
  end
end