Skip to content

Commit c9b0c23

Browse files
codedmonkeycodedmonkey
committed
Add preliminary revision history UI
1 parent 013b343 commit c9b0c23

8 files changed

Lines changed: 209 additions & 63 deletions

File tree

‎assets/stylesheets/dashboard-theme.css‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,3 +77,8 @@ body.ea-dark-scheme img.img-light {
7777
body:not(.ea-dark-scheme) img.img-dark {
7878
display: none;
7979
}
80+
81+
.text-monospace {
82+
font-family: var(--font-family-monospace);
83+
font-size: 13px;
84+
}

‎src/Controller/Dashboard/DashboardPackagesInfoController.php‎

Lines changed: 42 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44

55
use CodedMonkey\Dirigent\Attribute\IsGrantedAccess;
66
use CodedMonkey\Dirigent\Attribute\MapPackage;
7-
use CodedMonkey\Dirigent\Doctrine\Entity\Metadata;
87
use CodedMonkey\Dirigent\Doctrine\Entity\Package;
98
use CodedMonkey\Dirigent\Doctrine\Entity\PackageProvideLink;
109
use CodedMonkey\Dirigent\Doctrine\Entity\PackageRequireLink;
@@ -23,6 +22,7 @@ class DashboardPackagesInfoController extends AbstractController
2322
{
2423
public function __construct(
2524
private readonly EntityManagerInterface $entityManager,
25+
private readonly MetadataRepository $metadataRepository,
2626
) {
2727
}
2828

@@ -31,24 +31,40 @@ public function __construct(
3131
*/
3232
#[Route('/packages/{package}', name: 'dashboard_packages_info', requirements: ['package' => MapPackage::PACKAGE_REGEX])]
3333
#[IsGrantedAccess]
34-
public function info(#[MapPackage] Package $package): Response
34+
public function info(Request $request, #[MapPackage] Package $package): Response
3535
{
3636
$version = $package->getLatestVersion();
3737

3838
if (!$version) {
3939
return $this->redirectToRoute('dashboard_packages_versions', ['package' => $package->getName()]);
4040
}
4141

42-
return $this->versionInfo($package, $version);
42+
return $this->versionInfo($request, $package, $version, latest: true);
4343
}
4444

4545
#[Route('/packages/{package}/versions/{version}', name: 'dashboard_packages_version_info', requirements: ['package' => MapPackage::PACKAGE_REGEX, 'version' => '.*'])]
4646
#[IsGrantedAccess]
47-
public function versionInfo(#[MapPackage] Package $package, #[MapPackage] Version $version): Response
48-
{
49-
/** @var MetadataRepository $metadataRepository */
50-
$metadataRepository = $this->entityManager->getRepository(Metadata::class);
51-
$metadataRepository->fetchMetadataCollections($version->getCurrentMetadata());
47+
public function versionInfo(
48+
Request $request,
49+
#[MapPackage] Package $package,
50+
#[MapPackage] Version $version,
51+
bool $latest = false,
52+
): Response {
53+
$metadata = $version->getCurrentMetadata();
54+
$revision = $request->query->getInt('revision');
55+
56+
// Only check for a revision number if the route is for a specific version: $latest !== true
57+
if (0 !== $revision && !$latest) {
58+
$metadata = $this->metadataRepository->findOneBy(['version' => $version, 'revision' => $revision]);
59+
60+
if (null === $metadata) {
61+
throw $this->createNotFoundException('The revision does not exist.');
62+
}
63+
}
64+
65+
$this->metadataRepository->fetchMetadataCollections($metadata);
66+
67+
$metadataCount = $this->metadataRepository->getMetadataCountForVersion($version);
5268

5369
$dependentCount = $this->entityManager->getRepository(PackageRequireLink::class)->count(['linkedPackageName' => $package->getName()]);
5470
$implementationCount = $this->entityManager->getRepository(PackageProvideLink::class)->count(['linkedPackageName' => $package->getName(), 'implementation' => true]);
@@ -58,15 +74,32 @@ public function versionInfo(#[MapPackage] Package $package, #[MapPackage] Versio
5874
return $this->render('dashboard/packages/package_info.html.twig', [
5975
'package' => $package,
6076
'version' => $version,
61-
'metadata' => $version->getCurrentMetadata(),
77+
'metadata' => $metadata,
6278

6379
'dependentCount' => $dependentCount,
6480
'implementationCount' => $implementationCount,
81+
'metadataCount' => $metadataCount,
6582
'providerCount' => $providerCount,
6683
'suggesterCount' => $suggesterCount,
6784
]);
6885
}
6986

87+
#[Route('/packages/{package}/revisions/{version}', name: 'dashboard_packages_version_metadata_list', requirements: ['package' => MapPackage::PACKAGE_REGEX, 'version' => '.*'])]
88+
#[IsGrantedAccess]
89+
public function versionMetadataList(
90+
#[MapPackage] Package $package,
91+
#[MapPackage] Version $version,
92+
): Response {
93+
$metadataCollection = $this->metadataRepository->getMetadataCollectionForVersion($version);
94+
95+
return $this->render('dashboard/packages/package_version_revisions.html.twig', [
96+
'package' => $package,
97+
'version' => $version,
98+
99+
'metadataCollection' => $metadataCollection,
100+
]);
101+
}
102+
70103
#[Route('/packages/{package}/versions', name: 'dashboard_packages_versions', requirements: ['package' => MapPackage::PACKAGE_REGEX])]
71104
#[IsGrantedAccess]
72105
public function versions(#[MapPackage] Package $package): Response

‎src/Doctrine/Repository/MetadataRepository.php‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,10 @@
33
namespace CodedMonkey\Dirigent\Doctrine\Repository;
44

55
use CodedMonkey\Dirigent\Doctrine\Entity\Metadata;
6+
use CodedMonkey\Dirigent\Doctrine\Entity\Version;
67
use CodedMonkey\Dirigent\Entity\MetadataLinkType;
78
use Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepository;
9+
use Doctrine\Common\Collections\Order;
810
use Doctrine\Persistence\ManagerRegistry;
911

1012
/**
@@ -40,6 +42,19 @@ public function remove(Metadata $entity, bool $flush = false): void
4042
}
4143
}
4244

45+
public function getMetadataCountForVersion(Version $version): int
46+
{
47+
return $this->count(['version' => $version]);
48+
}
49+
50+
public function getMetadataCollectionForVersion(Version $version): array
51+
{
52+
return $this->findBy(
53+
['version' => $version],
54+
['revision' => Order::Descending->value],
55+
);
56+
}
57+
4358
/**
4459
* Initializes all link and keyword collections for the given metadata.
4560
*/

‎templates/dashboard/packages/_package_header.html.twig‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,13 @@
22
{% set attrActive = 'class="nav-link active" aria-current="page"' %}
33
{% set attr = 'class="nav-link text-primary"' %}
44

5-
<ul class="nav nav-pills nav-justified d-grid d-md-flex gap-1 pb-3 mb-3 border-bottom">
5+
<ul class="nav nav-pills nav-justified d-grid d-md-flex gap-1 pb-2 mb-3 border-bottom">
66
<li class="nav-item">
77
{% if package.versions|length > 0 %}
8-
{% set packageInfoUrl = path('dashboard_packages_info', {package: package.name}) %}
8+
{% set packageInfoUrl = version is defined
9+
? path('dashboard_packages_version_info', {package: package.name, version: version.name})
10+
: path('dashboard_packages_info', {package: package.name})
11+
%}
912
<a {{ (currentPage == 'info' ? attrActive : attr)|raw }} href="{{ packageInfoUrl }}">{{ 'Info'|trans }}</a>
1013
{% else %}
1114
<span class="nav-link disabled">{{ 'Info'|trans }}</span>

‎templates/dashboard/packages/package_info.html.twig‎

Lines changed: 86 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -100,66 +100,100 @@
100100
{% endif %}
101101
</div>
102102

103-
<div class="row border-bottom pb-3 mb-3">
104-
{{ _self.linkBlock('Requires', metadata.requireLinks) }}
105-
{{ _self.linkBlock('Requires (dev)', metadata.devRequireLinks) }}
106-
{{ _self.provideBlock(metadata.provideLinks) }}
107-
{{ _self.linkBlock('Suggests', metadata.suggestLinks) }}
108-
{{ _self.linkBlock('Conflicts', metadata.conflictLinks) }}
109-
{{ _self.linkBlock('Replaces', metadata.replaceLinks) }}
103+
<div class="border-bottom mb-3">
104+
<div class="row g-0">
105+
{{ _self.linkBlock('Requires', metadata.requireLinks) }}
106+
{{ _self.linkBlock('Requires (dev)', metadata.devRequireLinks) }}
107+
{{ _self.provideBlock(metadata.provideLinks) }}
108+
{{ _self.linkBlock('Suggests', metadata.suggestLinks) }}
109+
{{ _self.linkBlock('Conflicts', metadata.conflictLinks) }}
110+
{{ _self.linkBlock('Replaces', metadata.replaceLinks) }}
111+
</div>
110112
</div>
111113

112-
<div class="row border-bottom pb-3 mb-3">
113-
<div class="col-md-6">
114-
{% if metadata.hasSource() %}
115-
<div class="h5">
116-
{{ 'Source'|trans }}
117-
<span class="badge text-bg-secondary">{{ metadata.sourceType }}</span>
114+
<div class="border-bottom pb-3 mb-3">
115+
{% if metadataCount > 1 %}
116+
{% set isCurrent = metadata == version.currentMetadata %}
117+
<div class="bg-body-tertiary border border-warning-subtle px-3 py-2 mb-3 rounded">
118+
<p>
119+
{{ 'Multiple revisions found for version %version% of package %package%'|trans({
120+
'%package%': "<strong>#{package.name|escape}</strong>",
121+
'%version%': "<strong>#{version.name|escape}</strong>",
122+
})|raw }}
123+
</p>
124+
{% if not isCurrent %}
125+
<p class="text-warning">
126+
<strong>
127+
{{ "You're viewing an inactive revision of this package"|trans }}
128+
</strong>
129+
</p>
130+
{% endif %}
131+
<div class="btn-toolbar gap-1">
132+
<a class="btn btn-sm btn-secondary" href="{{ path('dashboard_packages_version_metadata_list', {package: package.name, version: version.name}) }}">
133+
<span class="fa-solid fa-list me-1" aria-hidden="true"></span>
134+
<span class="btn-label">{{ 'Revisions'|trans }}</span>
135+
</a>
136+
{% if not isCurrent %}
137+
<a class="btn btn-sm btn-secondary" href="{{ path('dashboard_packages_version_info', {package: package.name, version: version.name}) }}">
138+
<span class="fa-solid fa-code-commit me-1" aria-hidden="true"></span>
139+
<span class="btn-label">{{ 'Current revision'|trans }}</span>
140+
</a>
141+
{% endif %}
118142
</div>
143+
</div>
144+
{% endif %}
145+
<div class="row g-0">
146+
<div class="col-md-6">
147+
{% if metadata.hasSource() %}
148+
<div class="h5">
149+
{{ 'Source'|trans }}
150+
<span class="badge text-bg-secondary">{{ metadata.sourceType }}</span>
151+
</div>
119152

120-
<div class="mb-2">
121-
<code>{{ metadata.sourceUrl }}</code>
122-
</div>
153+
<div class="mb-2">
154+
<code>{{ metadata.sourceUrl }}</code>
155+
</div>
123156

124-
<div class="mb-2">
125-
{{ 'Reference'|trans }}: <code>{{ metadata.sourceReference }}</code>
126-
</div>
157+
<div class="mb-2">
158+
{{ 'Reference'|trans }}: <code>{{ metadata.sourceReference }}</code>
159+
</div>
127160

128-
<div class="mb-2">
129-
{% set browseUrl = metadata.browsableRepositoryUrl %}
130-
{% if browseUrl %}
131-
<a class="btn btn-sm btn-secondary" href="{{ browseUrl }}">
132-
<span class="fa-solid fa-code me-1" aria-hidden="true"></span>
133-
{{ 'Browse code'|trans }}
134-
</a>
135-
{% endif %}
136-
</div>
137-
{% else %}
138-
<div class="h5">{{ 'Source'|trans }}</div>
139-
-
140-
{% endif %}
141-
</div>
142-
<div class="col-md-6">
143-
{% if metadata.hasDist() %}
144-
<div class="h5">
145-
{{ 'Distribution'|trans }}
146-
<span class="badge text-bg-secondary">{{ metadata.distType }}</span>
147-
</div>
161+
<div>
162+
{% set browseUrl = metadata.browsableRepositoryUrl %}
163+
{% if browseUrl %}
164+
<a class="btn btn-sm btn-secondary" href="{{ browseUrl }}">
165+
<span class="fa-solid fa-code me-1" aria-hidden="true"></span>
166+
<span class="btn-label">{{ 'Browse code'|trans }}</span>
167+
</a>
168+
{% endif %}
169+
</div>
170+
{% else %}
171+
<div class="h5">{{ 'Source'|trans }}</div>
172+
-
173+
{% endif %}
174+
</div>
175+
<div class="col-md-6">
176+
{% if metadata.hasDist() %}
177+
<div class="h5">
178+
{{ 'Distribution'|trans }}
179+
<span class="badge text-bg-secondary">{{ metadata.distType }}</span>
180+
</div>
148181

149-
<div class="mb-2">
150-
{{ 'Reference'|trans }}: <code>{{ metadata.distReference }}</code>
151-
</div>
182+
<div class="mb-2">
183+
{{ 'Reference'|trans }}: <code>{{ metadata.distReference }}</code>
184+
</div>
152185

153-
<div class="mb-2">
154-
<a class="btn btn-sm btn-secondary" href="{{ metadata.distUrl }}" download>
155-
<span class="fa-solid fa-download me-1" aria-hidden="true"></span>
156-
{{ 'Download' }}
157-
</a>
158-
</div>
159-
{% else %}
160-
<div class="h5">{{ 'Distribution'|trans }}</div>
161-
-
162-
{% endif %}
186+
<div>
187+
<a class="btn btn-sm btn-secondary" href="{{ metadata.distUrl }}" download>
188+
<span class="fa-solid fa-download me-1" aria-hidden="true"></span>
189+
<span class="btn-label">{{ 'Download' }}</span>
190+
</a>
191+
</div>
192+
{% else %}
193+
<div class="h5">{{ 'Distribution'|trans }}</div>
194+
-
195+
{% endif %}
196+
</div>
163197
</div>
164198
</div>
165199

‎templates/dashboard/packages/package_version_revisions.html.twig‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
{% extends 'dashboard/packages/package_base.html.twig' %}
2+
3+
{% block page_title %}
4+
{%- apply spaceless -%}
5+
{{ package.name }}
6+
<small>{{ version.extendedName }}</small>
7+
{%- endapply -%}
8+
{% endblock %}
9+
10+
{% block page_content %}
11+
{{ include('dashboard/packages/_package_header.html.twig') }}
12+
13+
<h2 class="h4">{{ 'Revisions'|trans }}</h2>
14+
15+
<div class="list-group list-group-flush border-bottom mb-3">
16+
{% for metadata in metadataCollection %}
17+
{% set isCurrent = metadata == version.currentMetadata %}
18+
{% set infoUrl = isCurrent
19+
? path('dashboard_packages_version_info', {package: package.name, version: version.name})
20+
: path('dashboard_packages_version_info', {package: package.name, version: version.name, revision: metadata.revision})
21+
%}
22+
<a href="{{ infoUrl }}" class="list-group-item">
23+
<div class="d-flex justify-content-between">
24+
<div>
25+
<span>{{ 'Revision'|trans }} {{ metadata.revision }}: <span class="text-monospace">{{ metadata.sourceReference }}</span></span>
26+
</div>
27+
<span class="text-muted">{{ metadata.releasedAt ? metadata.releasedAt.format('Y-m-d') }}</span>
28+
</div>
29+
<div>
30+
<span>{{ 'Indexed on %date%'|trans({'%date%': metadata.createdAt.format('Y-m-d')}) }}</span>
31+
{% if isCurrent %}
32+
<span class="badge text-bg-secondary ms-1">{{ 'Current revision'|trans }}</span>
33+
{% endif %}
34+
</div>
35+
</a>
36+
{% endfor %}
37+
</div>
38+
{% endblock %}

‎tests/FunctionalTests/Controller/Dashboard/DashboardPackagesInfoControllerTest.php‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,16 @@ public function testPackageInfo(): void
5050
$this->assertResponseStatusCodeSame(Response::HTTP_OK);
5151
}
5252

53+
public function testPackageMetadataList(): void
54+
{
55+
$client = static::createClient();
56+
$this->loginUser();
57+
58+
$client->request('GET', '/packages/psr/log/revisions/1.0.0');
59+
60+
$this->assertResponseStatusCodeSame(Response::HTTP_OK);
61+
}
62+
5363
public function testVersions(): void
5464
{
5565
$client = static::createClient();

‎translations/messages.en.yaml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,14 @@ Requires: Requires
7272
Requires (dev): Requires (dev)
7373
Suggests: Suggests
7474

75+
# Package labels (Revisions)
76+
Current revision: Current revision
77+
Indexed on %date%: Indexed on %date%
78+
Multiple revisions found for version %version% of package %package%: Multiple revisions found for version %version% of package %package%.
79+
Revision: Revision
80+
Revisions: Revisions
81+
You're viewing an inactive revision of this package: You're viewing an inactive revision of this package.
82+
7583
# Package labels (Statistics)
7684
Daily installations: Daily installations
7785
Daily installations per version: Daily installations per version

0 commit comments

Comments
 (0)