Skip to content

Commit 0ccff98

Browse files
committed
Merged [2948] from bmheight@gmail.com:
Addresses issue ietf-tools#628, using reverse() and the newly created helper function reverse_lazy() (found in ietf/utils/lazy.py) to DRY out the code a bit by decoupling the urls from being hardcoded. With this commit idrfc, and ipr modules have been modified to take advantage of the reverse() and reverse_lazy() functions. - Legacy-Id: 2956 Note: SVN reference [2948] has been migrated to Git commit 9399a2e
1 parent 090be02 commit 0ccff98

7 files changed

Lines changed: 42 additions & 10 deletions

File tree

ietf/idrfc/idrfc_wrapper.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@
3838
from datetime import date
3939
from django.utils import simplejson as json
4040
from django.db.models import Q
41+
from django.db import models
42+
from django.core.urlresolvers import reverse
4143
import types
4244

4345
BALLOT_ACTIVE_STATES = ['In Last Call',
@@ -198,11 +200,11 @@ def draft_name_and_revision(self):
198200

199201
def friendly_state(self):
200202
if self.draft_status == "RFC":
201-
return "<a href=\"/doc/rfc%d/\">RFC %d</a>" % (self.rfc_number, self.rfc_number)
203+
return "<a href=\"%s\">RFC %d</a>" % (reverse('doc_view', args=['rfc%d' % self.rfc_number]), self.rfc_number)
202204
elif self.draft_status == "Replaced":
203205
rs = self.replaced_by()
204206
if rs:
205-
return "Replaced by <a href=\"/doc/%s/\">%s</a>" % (rs[0],rs[0])
207+
return "Replaced by <a href=\"%s\">%s</a>" % (reverse('ipr_show', args=[rs[0]]),rs[0])
206208
else:
207209
return "Replaced"
208210
elif self.draft_status == "Active":
@@ -357,8 +359,9 @@ def ad_name(self):
357359
# TODO: get AD name of the draft
358360
return None
359361

362+
@models.permalink
360363
def get_absolute_url(self):
361-
return "/doc/rfc%d/" % (self.rfc_number,)
364+
return ('ietf.idrfc.views_doc.document_main', ['rfc%s' % (str(self.rfc_number))])
362365
def displayname_with_link(self):
363366
return '<a href="%s">RFC %d</a>' % (self.get_absolute_url(), self.rfc_number)
364367

ietf/idrfc/views_doc.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@
4141
from django.utils import simplejson as json
4242
from django.utils.decorators import decorator_from_middleware
4343
from django.middleware.gzip import GZipMiddleware
44+
from django.core.urlresolvers import reverse
4445

4546
from ietf import settings
4647
from ietf.idtracker.models import InternetDraft, IDInternal, BallotInfo, DocumentComment
@@ -189,7 +190,7 @@ def _get_history(doc, versions):
189190
results.append({'is_text':True, 'date':doc._draft.expiration_date, 'text':'Draft expired'})
190191
if doc.is_rfc_wrapper:
191192
if doc.draft_name:
192-
text = 'RFC Published (see <a href="/doc/%s/">%s</a> for earlier history)' % (doc.draft_name,doc.draft_name)
193+
text = 'RFC Published (see <a href="%s">%s</a> for earlier history)' % (reverse('doc_view', args=[doc.draft_name]),doc.draft_name)
193194
else:
194195
text = 'RFC Published'
195196
results.append({'is_text':True, 'date':doc.publication_date, 'text':text})

ietf/ipr/feeds.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,13 @@
33
from django.contrib.syndication.feeds import Feed
44
from django.utils.feedgenerator import Atom1Feed
55
from ietf.ipr.models import IprDetail
6+
from ietf.utils.lazy import reverse_lazy
67
from datetime import datetime, time
78

89
class LatestIprDisclosures(Feed):
910
feed_type = Atom1Feed
1011
title = "IPR Disclosures to the IETF"
11-
link = "/ipr/"
12+
link = reverse_lazy('ipr_showlist')
1213
description = "Updates on new IPR Disclosures made to the IETF."
1314
language = "en"
1415
feed_url = "/feed/ipr/"

ietf/ipr/models.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
#from django import newforms as forms
55
from ietf.idtracker.views import InternetDraft
66
from ietf.idtracker.models import Rfc
7+
from ietf.utils.lazy import reverse_lazy
78

89
# ------------------------------------------------------------------------
910
# Models
@@ -115,8 +116,9 @@ def __str__(self):
115116
return self.title
116117
def docs(self):
117118
return list(self.drafts.all()) + list(self.rfcs.all())
119+
@models.permalink
118120
def get_absolute_url(self):
119-
return "/ipr/%d/" % self.ipr_id
121+
return ('ietf.ipr.views.show', [str(self.ipr_id)])
120122
def get_submitter(self):
121123
try:
122124
return self.contact.get(contact_type=3)

ietf/ipr/urls.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
# Copyright The IETF Trust 2007, All Rights Reserved
22

3-
from django.conf.urls.defaults import patterns
3+
from django.conf.urls.defaults import patterns, url
44
from ietf.ipr import views, new, search
5+
from ietf.utils.lazy import reverse_lazy
56
from django.views.generic.simple import redirect_to
67

78
urlpatterns = patterns('',
8-
(r'^$', views.showlist),
9+
url(r'^$', views.showlist, name='ipr_showlist'),
910
(r'^about/$', views.default),
1011
(r'^by-draft/$', views.list_drafts),
11-
(r'^(?P<ipr_id>\d+)/$', views.show),
12-
(r'^update/$', redirect_to, { 'url': '/ipr/' }),
12+
url(r'^(?P<ipr_id>\d+)/$', views.show, name='ipr_show'),
13+
(r'^update/$', redirect_to, { 'url': reverse_lazy('ipr_showlist') }),
1314
(r'^update/(?P<ipr_id>\d+)/$', new.update),
1415
(r'^new-(?P<type>specific)/$', new.new),
1516
(r'^new-(?P<type>generic)/$', new.new),

ietf/utils/lazy.py

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
from django.utils.functional import lazy
2+
from django.core.urlresolvers import reverse
3+
4+
"""
5+
A lazily evaluated version of `reverse()`_.
6+
7+
It is useful for when you need to use a URL reversal before Django's
8+
URL names map is loaded. Some common cases where this method is necessary are:
9+
10+
* in your URL configuration (such as the ``url`` argument for the
11+
``django.views.generic.simple.redirect_to`` generic view).
12+
13+
* providing a reversed URL to a decorator (such as the ``login_url`` argument
14+
for the ``django.contrib.auth.decorators.permission_required`` decorator).
15+
16+
Usually unicode would be preference but str is the right type instead of unicode.
17+
This is because reverse passes through iri_to_uri which converts it to a string
18+
"""
19+
20+
reverse_lazy = lazy(reverse, str)

ietf/utils/test_utils.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -215,3 +215,7 @@ def login_testing_unauthorized(tc, remote_user, url):
215215

216216
tc.client.login(remote_user=remote_user)
217217

218+
class ReverseLazyTest(TestCase):
219+
def test_redirect_with_lazy_reverse(self):
220+
response = self.client.get('/ipr/update/')
221+
self.assertRedirects(response, "/ipr/", status_code=301)

0 commit comments

Comments
 (0)