boost/website-v2
2
0
Fork 0
mirror of https://github.com/boostorg/website-v2.git synced 2026-02-26 17:22:09 +00:00
Code Issues Projects Releases Wiki Activity

Add version alert to detail view and template

Browse Source
This commit is contained in:
Lacey Williams Henschel
2023-06-22 15:53:14 -07:00
parent 338eb8fe44
commit 57c4f0e8fb
3 changed files with 44 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
libraries/views.py
View File

@@ -102,22 +102,42 @@ class LibraryDetail(CategoryMixin, FormMixin, DetailView):
def get_context_data(self, **kwargs):
"""Set the form action to the main libraries page"""
context = super().get_context_data(**kwargs)
context["documentation_url"] = self.get_documentation_url()
# Get fields related to Boost versions
context["version"] = self.get_version()
context["maintainers"] = self.get_maintainers(context["version"])
latest_version = Version.objects.most_recent()
context["latest_version"] = latest_version
context["versions"] = (
Version.objects.active()
.filter(library_version__library=self.object)
.distinct()
.order_by("-release_date")
)
# Show an alert if the user is on an older version
if context["version"] != latest_version:
context["version_alert"] = True
context["latest_library_version"] = self.get_current_library_version(
context["version"]
)
else:
context["version_alert"] = False
# Get general data and version-sensitive data
context["documentation_url"] = self.get_documentation_url()
context["github_url"] = self.get_github_url(context["version"])
context["maintainers"] = self.get_maintainers(context["version"])
# Populate the commit graphs
context["commit_data_annual"] = self.get_commit_data_annual()
context["commit_data_last_12_months"] = self.get_commit_data_last_12_months()
# Populate the library description
client = GithubAPIClient(repo_slug=self.object.github_repo)
context["description"] = self.object.get_description(
client, tag=context["version"].name
)
context["github_url"] = self.get_github_url(context["version"])
context["commit_data_annual"] = self.get_commit_data_annual()
context["commit_data_last_12_months"] = self.get_commit_data_last_12_months()
return context
def get_object(self):
@@ -206,6 +226,13 @@ class LibraryDetail(CategoryMixin, FormMixin, DetailView):
result = self._prepare_commit_data(prepared_commit_data, "monthly")
return result
def get_current_library_version(self, version):
"""Return the library-version for the latest version of Boost"""
# Avoid raising an error if the library has been removed from the latest version
return LibraryVersion.objects.filter(
library=self.object, version=version
).first()
def get_documentation_url(self):
"""Return the URL for the link to the external Boost documentation."""
obj = self.get_object()

3
templates/libraries/detail.html
View File

@@ -40,6 +40,9 @@
</h3>
</div>
<!-- alert for non-current Boost versions -->
{% include "libraries/includes/version_alert.html" %}
<div class="p-4 md:flex md:space-x-3">
<div class="px-2 pt-2 space-y-2 w-full bg-white rounded-lg md:w-1/3 dark:bg-charcoal">
<a class="block items-center py-1 px-2 rounded cursor-pointer hover:bg-gray-100" href="{{ documentation_url }}">

10
templates/libraries/includes/version_alert.html
View File

@@ -1,5 +1,13 @@
{% if version_alert %}
<div role="alert">
<p>This is an older version and was released in {{ version.release_date|date:"Y"}}. The current version is <a href="{% url 'version-detail' latest_version.slug %}">{{ latest_version.display_name }}</a>.</p>
<p>This is an older version and was released in {{ version.release_date|date:"Y"}}.
The current version is
{% if latest_library_version %}
<a href="{% url 'library-detail' slug=latest_library_version.library.slug %}">
{% else %}
<a href="{% url 'version-detail' latest_version.slug %}">
{% endif %}
{{ latest_version.display_name }}</a>.
</p>
</div>
{% endif %}