def test_search_pick_create(self):
# Create a search pick to the root page
SearchPromotion.objects.create(
query=Query.get("root page"),
page_id=1,
sort_order=0,
description="First search promotion",
)
# Check
self.assertEqual(Query.get("root page").editors_picks.count(), 1)
self.assertEqual(
Query.get("root page").editors_picks.first().page_id, 1)
def make_search_picks(self):
for i in range(50):
SearchPromotion.objects.create(
query=Query.get("query " + str(i)),
page_id=1,
sort_order=0,
description="First search pick",
)
def setUp(self):
self.login()
# Create an search pick to delete
self.query = Query.get("Hello")
self.search_pick = self.query.editors_picks.create(
page_id=1, description="Root page")
self.search_pick_2 = self.query.editors_picks.create(
page_id=2, description="Homepage")
def test_post_reorder(self):
# Check order before reordering
self.assertEqual(
Query.get("Hello").editors_picks.all()[0], self.search_pick)
self.assertEqual(
Query.get("Hello").editors_picks.all()[1], self.search_pick_2)
# Submit
post_data = {
'query_string': "Hello",
'editors_picks-TOTAL_FORMS': 2,
'editors_picks-INITIAL_FORMS': 2,
'editors_picks-MAX_NUM_FORMS': 1000,
'editors_picks-0-id': self.search_pick.id,
'editors_picks-0-DELETE': '',
'editors_picks-0-ORDER': 1, # Change
'editors_picks-0-page': 1,
'editors_picks-0-description': "Root page",
'editors_picks-1-id': self.search_pick_2.id,
'editors_picks-1-DELETE': '',
'editors_picks-1-ORDER': 0, # Change
'editors_picks-1-page': 2,
'editors_picks-1-description': "Homepage",
}
response = self.client.post(
reverse('searchpromotions:edit', args=(self.query.id, )),
post_data)
# User should be redirected back to the index
self.assertRedirects(response, reverse('searchpromotions:index'))
# Check that the ordering has been saved correctly
self.assertEqual(
SearchPromotion.objects.get(id=self.search_pick.id).sort_order, 1)
self.assertEqual(
SearchPromotion.objects.get(id=self.search_pick_2.id).sort_order,
0)
# Check that the recommendations were reordered
self.assertEqual(
Query.get("Hello").editors_picks.all()[0], self.search_pick_2)
self.assertEqual(
Query.get("Hello").editors_picks.all()[1], self.search_pick)
def test_get_search_promotions_template_tag(self):
# Create a search pick to the root page
pick = SearchPromotion.objects.create(
query=Query.get("root page"),
page_id=1,
sort_order=0,
description="First search pick",
)
# Create another search pick against a different query
SearchPromotion.objects.create(
query=Query.get("root page again"),
page_id=1,
sort_order=0,
description="Second search pick",
)
# Check
search_picks = list(get_search_promotions("root page"))
self.assertEqual(search_picks, [pick])
def test_search_pick_ordering(self):
# Add 3 search picks in a different order to their sort_order values
# They should be ordered by their sort order values and not their insertion order
SearchPromotion.objects.create(
query=Query.get("root page"),
page_id=1,
sort_order=0,
description="First search pick",
)
SearchPromotion.objects.create(
query=Query.get("root page"),
page_id=1,
sort_order=2,
description="Last search pick",
)
SearchPromotion.objects.create(
query=Query.get("root page"),
page_id=1,
sort_order=1,
description="Middle search pick",
)
# Check
self.assertEqual(Query.get("root page").editors_picks.count(), 3)
self.assertEqual(
Query.get("root page").editors_picks.first().description,
"First search pick")
self.assertEqual(
Query.get("root page").editors_picks.last().description,
"Last search pick")
def edit(request, query_id):
query = get_object_or_404(Query, id=query_id)
if request.method == 'POST':
# Get query
query_form = search_forms.QueryForm(request.POST)
# and the recommendations
searchpicks_formset = forms.SearchPromotionsFormSet(request.POST,
instance=query)
if query_form.is_valid():
new_query = Query.get(query_form['query_string'].value())
# Save search picks
if save_searchpicks(query, new_query, searchpicks_formset):
messages.success(
request,
_("Editor's picks for '{0}' updated.").format(new_query),
buttons=[
messages.button(
reverse('searchpromotions:edit',
args=(query.id, )), _('Edit'))
])
return redirect('searchpromotions:index')
else:
if len(searchpicks_formset.non_form_errors()):
messages.error(
request,
" ".join(error for error in
searchpicks_formset.non_form_errors()))
# formset level error (e.g. no forms submitted)
else:
messages.error(
request,
_("Recommendations have not been saved due to errors"))
# specific errors will be displayed within form fields
else:
query_form = search_forms.QueryForm(initial=dict(
query_string=query.query_string))
searchpicks_formset = forms.SearchPromotionsFormSet(instance=query)
return render(
request, 'searchpromotions/edit.html', {
'query_form': query_form,
'searchpicks_formset': searchpicks_formset,
'query': query,
})
def test_results_are_ordered_alphabetically(self):
self.make_search_picks()
SearchPromotion.objects.create(
query=Query.get("aaargh snake"),
page_id=1,
sort_order=0,
description="ooh, it's a snake",
)
response = self.client.get(reverse('searchpromotions:index'))
# Check response
self.assertEqual(response.status_code, 200)
self.assertTemplateUsed(response, 'searchpromotions/index.html')
# "aargh snake" should be the first result alphabetically
self.assertEqual(response.context['queries'][0].query_string,
"aaargh snake")
def add(request):
if request.method == 'POST':
# Get query
query_form = search_forms.QueryForm(request.POST)
if query_form.is_valid():
query = Query.get(query_form['query_string'].value())
# Save search picks
searchpicks_formset = forms.SearchPromotionsFormSet(request.POST,
instance=query)
if save_searchpicks(query, query, searchpicks_formset):
messages.success(
request,
_("Editor's picks for '{0}' created.").format(query),
buttons=[
messages.button(
reverse('searchpromotions:edit',
args=(query.id, )), _('Edit'))
])
return redirect('searchpromotions:index')
else:
if len(searchpicks_formset.non_form_errors()):
# formset level error (e.g. no forms submitted)
messages.error(
request,
" ".join(error for error in
searchpicks_formset.non_form_errors()))
else:
# specific errors will be displayed within form fields
messages.error(
request,
_("Recommendations have not been created due to errors"
))
else:
searchpicks_formset = forms.SearchPromotionsFormSet()
else:
query_form = search_forms.QueryForm()
searchpicks_formset = forms.SearchPromotionsFormSet()
return render(request, 'searchpromotions/add.html', {
'query_form': query_form,
'searchpicks_formset': searchpicks_formset,
})
def test_post(self):
# Submit
post_data = {
'query_string': "test",
'editors_picks-TOTAL_FORMS': 1,
'editors_picks-INITIAL_FORMS': 0,
'editors_picks-MAX_NUM_FORMS': 1000,
'editors_picks-0-DELETE': '',
'editors_picks-0-ORDER': 0,
'editors_picks-0-page': 1,
'editors_picks-0-description': "Hello",
}
response = self.client.post(reverse('searchpromotions:add'), post_data)
# User should be redirected back to the index
self.assertRedirects(response, reverse('searchpromotions:index'))
# Check that the search pick was created
self.assertTrue(
Query.get('test').editors_picks.filter(page_id=1).exists())
def search(request,
template=None,
template_ajax=None,
results_per_page=10,
use_json=False,
json_attrs=['title', 'url'],
show_unpublished=False,
search_title_only=False,
extra_filters={},
path=None):
# Get default templates
if template is None:
if hasattr(settings, 'TUIUIUSEARCH_RESULTS_TEMPLATE'):
template = settings.TUIUIUSEARCH_RESULTS_TEMPLATE
else:
template = 'tuiuiusearch/search_results.html'
if template_ajax is None:
if hasattr(settings, 'TUIUIUSEARCH_RESULTS_TEMPLATE_AJAX'):
template_ajax = settings.TUIUIUSEARCH_RESULTS_TEMPLATE_AJAX
else:
template_ajax = template
# Get query string and page from GET paramters
query_string = request.GET.get('q', '')
page = request.GET.get('page', request.GET.get('p', 1))
# Search
if query_string != '':
pages = models.Page.objects.filter(
path__startswith=(path or request.site.root_page.path))
if not show_unpublished:
pages = pages.live()
if extra_filters:
pages = pages.filter(**extra_filters)
if search_title_only:
search_results = pages.search(query_string, fields=['title'])
else:
search_results = pages.search(query_string)
# Get query object
query = Query.get(query_string)
# Add hit
query.add_hit()
# Pagination
paginator = Paginator(search_results, results_per_page)
try:
search_results = paginator.page(page)
except PageNotAnInteger:
search_results = paginator.page(1)
except EmptyPage:
search_results = paginator.page(paginator.num_pages)
else:
query = None
search_results = None
if use_json:
# Return a json response
if search_results:
search_results_json = []
for result in search_results:
result_specific = result.specific
search_results_json.append(
dict((attr, getattr(result_specific, attr))
for attr in json_attrs
if hasattr(result_specific, attr)))
return JsonResponse(search_results_json, safe=False)
else:
return JsonResponse([], safe=False)
else:
# Render a template
if request.is_ajax() and template_ajax:
template = template_ajax
return render(
request, template,
dict(query_string=query_string,
search_results=search_results,
is_ajax=request.is_ajax(),
query=query))
def get_search_promotions(search_query):
if search_query:
return Query.get(search_query).editors_picks.all()
else:
return SearchPromotion.objects.none()