Skip to content

Commit

Permalink
Merge 12fed9a into cccd9b9
Browse files Browse the repository at this point in the history
  • Loading branch information
@cbeer
cbeer committed Feb 2, 2014
2 parents cccd9b9 + 12fed9a commit ab37579
Show file tree
Hide file tree
Showing 7 changed files with 565 additions and 730 deletions.
129 changes: 1 addition & 128 deletions app/helpers/blacklight/blacklight_helper_behavior.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,17 @@
# Methods added to this helper will be available to all templates in the hosting application
#
module Blacklight::BlacklightHelperBehavior
include BlacklightUrlHelper
include HashAsHiddenFieldsHelper
include RenderConstraintsHelper
include FacetsHelper


def application_name
return Rails.application.config.application_name if Rails.application.config.respond_to? :application_name

t('blacklight.application_name')
end

# Provide the full, absolute url for an image
def asset_url(*args)
"#{request.protocol}#{request.host_with_port}#{asset_path(*args)}"
end

# Create <link rel="alternate"> links from a documents dynamically
# provided export formats. Currently not used by standard BL layouts,
# but available for your custom layouts to provide link rel alternates.
Expand Down Expand Up @@ -442,33 +437,6 @@ def document_partial_path_templates
end


# Search History and Saved Searches display
def link_to_previous_search(params)
link_to(render_search_to_s(params), catalog_index_path(params))
end

#
# link based helpers ->
#

# create link to query (e.g. spelling suggestion)
def link_to_query(query)
p = params.except(:page, :action)
p[:q]=query
link_url = catalog_index_path(p)
link_to(query, link_url)
end

##
# Get the path to the search action with any parameters (e.g. view type)
# that should be persisted across search sessions.
def start_over_path query_params = params
h = { }
current_index_view_type = document_index_view_type(query_params)
h[:view] = current_index_view_type unless current_index_view_type == default_document_index_view_type

search_action_url(h)
end

def render_document_index_label doc, opts
label = nil
Expand All @@ -479,101 +447,6 @@ def render_document_index_label doc, opts
render_field_value label
end

# link_to_document(doc, :label=>'VIEW', :counter => 3)
# Use the catalog_path RESTful route to create a link to the show page for a specific item.
# catalog_path accepts a HashWithIndifferentAccess object. The solr query params are stored in the session,
# so we only need the +counter+ param here. We also need to know if we are viewing to document as part of search results.
def link_to_document(doc, opts={:label=>nil, :counter => nil})
opts[:label] ||= document_show_link_field(doc)
label = render_document_index_label doc, opts
link_to label, doc, search_session_params(opts[:counter]).merge(opts.reject { |k,v| [:label, :counter].include? k })
end

def search_session_params counter
{ :'data-counter' => counter, :'data-search_id' => current_search_session.try(:id) }
end

# Create a link back to the index screen, keeping the user's facet, query and paging choices intact by using session.
# @example
# link_back_to_catalog(label: 'Back to Search')
# link_back_to_catalog(label: 'Back to Search', route_set: my_engine)
def link_back_to_catalog(opts={:label=>nil})
scope = opts.delete(:route_set) || self
query_params = current_search_session.try(:query_params) || {}
link_url = scope.url_for(query_params)
label = opts.delete(:label)

if link_url =~ /bookmarks/
label ||= t('blacklight.back_to_bookmarks')
end

label ||= t('blacklight.back_to_search')

link_to label, link_url, opts
end

# @overload params_for_search(source_params, params_to_merge)
# Merge the source params with the params_to_merge hash
# @param [Hash] Hash
# @param [Hash] Hash to merge into above
# @overload params_for_search(params_to_merge)
# Merge the current search parameters with the
# parameters provided.
# @param [Hash] Hash to merge into the parameters
# @overload params_for_search
# Returns the current search parameters after being sanitized by #sanitize_search_params
# @yield [params] The merged parameters hash before being sanitized
def params_for_search(*args, &block)

source_params, params_to_merge = case args.length
when 0
[params, {}]
when 1
[params, args.first]
when 2
[args.first, args.last]
else
raise ArgumentError.new "wrong number of arguments (#{args.length} for 0..2)"
end

# params hash we'll return
my_params = source_params.dup.merge(params_to_merge.dup)

if block_given?
yield my_params
end

if my_params[:page] and (my_params[:per_page] != source_params[:per_page] or my_params[:sort] != source_params[:sort] )
my_params[:page] = 1
end

sanitize_search_params(my_params)
end

##
# Sanitize the search parameters by removing unnecessary parameters
# from the provided parameters
# @param [Hash] Hash of parameters
def sanitize_search_params source_params

my_params = source_params.reject { |k,v| v.nil? }

my_params.except(:action, :controller, :id, :commit, :utf8)

end

def link_to_previous_document(previous_document)
link_to_unless previous_document.nil?, raw(t('views.pagination.previous')), previous_document, search_session_params(search_session[:counter].to_i - 1).merge(:class => "previous", :rel => 'prev') do
content_tag :span, raw(t('views.pagination.previous')), :class => 'previous'
end
end

def link_to_next_document(next_document)
link_to_unless next_document.nil?, raw(t('views.pagination.next')), next_document, search_session_params(search_session[:counter].to_i + 1).merge(:class => "next", :rel => 'next') do
content_tag :span, raw(t('views.pagination.next')), :class => 'next'
end
end

# Use case, you want to render an html partial from an XML (say, atom)
# template. Rails API kind of lets us down, we need to hack Rails internals
# a bit. code taken from:
Expand Down
75 changes: 0 additions & 75 deletions app/helpers/blacklight/facets_helper_behavior.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -117,81 +117,6 @@ def render_facet_count(num, options = {})
content_tag("span", t('blacklight.search.facets.count', :number => num), :class => classes)
end

# adds the value and/or field to params[:f]
# Does NOT remove request keys and otherwise ensure that the hash
# is suitable for a redirect. See
# add_facet_params_and_redirect
def add_facet_params(field, item, source_params = params)

if item.respond_to? :field
field = item.field
end

facet_config = facet_configuration_for_field(field)

value = facet_value_for_facet_item(item)

p = source_params.dup
p[:f] = (p[:f] || {}).dup # the command above is not deep in rails3, !@#$!@#$
p[:f][field] = (p[:f][field] || []).dup

if facet_config.single and not p[:f][field].empty?
p[:f][field] = []
end

p[:f][field].push(value)

if item and item.respond_to?(:fq) and item.fq
item.fq.each do |f,v|
p = add_facet_params(f, v, p)
end
end

p
end

# Used in catalog/facet action, facets.rb view, for a click
# on a facet value. Add on the facet params to existing
# search constraints. Remove any paginator-specific request
# params, or other request params that should be removed
# for a 'fresh' display.
# Change the action to 'index' to send them back to
# catalog/index with their new facet choice.
def add_facet_params_and_redirect(field, item)
new_params = add_facet_params(field, item)
new_params.except! :page, :id

# Delete any request params from facet-specific action, needed
# to redir to index action properly.
new_params.except! *Blacklight::Solr::FacetPaginator.request_keys.values

# Force action to be index.
new_params[:action] = "index"
new_params
end
# copies the current params (or whatever is passed in as the 3rd arg)
# removes the field value from params[:f]
# removes the field if there are no more values in params[:f][field]
# removes additional params (page, id, etc..)
def remove_facet_params(field, item, source_params=params)
if item.respond_to? :field
field = item.field
end

value = facet_value_for_facet_item(item)

p = source_params.dup
# need to dup the facet values too,
# if the values aren't dup'd, then the values
# from the session will get remove in the show view...
p[:f] = (p[:f] || {}).dup
p[:f][field] = (p[:f][field] || []).dup
p.except! :page, :id, :counter, :commit
p[:f][field] = p[:f][field] - [value]
p[:f].delete(field) if p[:f][field].size == 0
p
end

def facet_field_in_params? field
params[:f] and params[:f][field]
end
Expand Down

0 comments on commit ab37579

Please sign in to comment.