Skip to content

Commit 8302df2

Browse files
johanibjohanib
committed
Use enum for ConsentVersion
1 parent 2aff202 commit 8302df2

8 files changed

Lines changed: 40 additions & 82 deletions

File tree

‎library/EngineBlock/Corto/Model/Consent.php‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ public function explicitConsentWasGivenFor(ServiceProvider $serviceProvider): Co
8383
{
8484
if (!$this->_consentEnabled) {
8585
// Consent disabled: treat as already given (stable — no upgrade needed)
86-
return ConsentVersion::stable();
86+
return ConsentVersion::Stable;
8787
}
8888
return $this->_hasStoredConsent($serviceProvider, ConsentType::Explicit);
8989
}
@@ -111,7 +111,7 @@ public function upgradeAttributeHashFor(ServiceProvider $serviceProvider, Consen
111111
public function implicitConsentWasGivenFor(ServiceProvider $serviceProvider): ConsentVersion
112112
{
113113
if (!$this->_consentEnabled) {
114-
return ConsentVersion::stable();
114+
return ConsentVersion::Stable;
115115
}
116116
return $this->_hasStoredConsent($serviceProvider, ConsentType::Implicit);
117117
}
@@ -199,7 +199,7 @@ private function _hasStoredConsent(ServiceProvider $serviceProvider, ConsentType
199199
{
200200
$consentUid = $this->_getConsentUid();
201201
if (!is_string($consentUid)) {
202-
return ConsentVersion::notGiven();
202+
return ConsentVersion::NotGiven;
203203
}
204204

205205
$query = new ConsentHashQuery(

‎src/OpenConext/EngineBlock/Authentication/Value/ConsentVersion.php‎

Lines changed: 8 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -18,68 +18,26 @@
1818

1919
namespace OpenConext\EngineBlock\Authentication\Value;
2020

21-
use OpenConext\EngineBlock\Assert\Assertion;
22-
23-
final class ConsentVersion
21+
enum ConsentVersion: string
2422
{
25-
const STABLE = 'stable';
23+
case Stable = 'stable';
2624
/** @deprecated Remove after stable consent hash is running in production */
27-
const UNSTABLE = 'unstable';
28-
const NOT_GIVEN = 'not-given';
29-
30-
/**
31-
* @var string
32-
*/
33-
private $consentVersion;
34-
35-
public static function stable(): ConsentVersion
36-
{
37-
return new self(self::STABLE);
38-
}
39-
40-
/** @deprecated Remove after stable consent hash is running in production */
41-
public static function unstable(): ConsentVersion
42-
{
43-
return new self(self::UNSTABLE);
44-
}
45-
46-
public static function notGiven(): ConsentVersion
47-
{
48-
return new self(self::NOT_GIVEN);
49-
}
50-
51-
public function __construct(string $consentVersion)
52-
{
53-
Assertion::choice(
54-
$consentVersion,
55-
[self::UNSTABLE, self::STABLE, self::NOT_GIVEN],
56-
'ConsentVersion must be one of ConsentVersion::STABLE, ConsentVersion::NOT_GIVEN or ConsentVersion::UNSTABLE'
57-
);
58-
59-
$this->consentVersion = $consentVersion;
60-
}
25+
case Unstable = 'unstable';
26+
case NotGiven = 'not-given';
6127

6228
public function given(): bool
6329
{
64-
return $this->consentVersion !== self::NOT_GIVEN;
30+
return $this !== self::NotGiven;
6531
}
6632

67-
/**
68-
* @return string
69-
*/
70-
public function __toString()
33+
public function isStable(): bool
7134
{
72-
return $this->consentVersion;
35+
return $this === self::Stable;
7336
}
7437

7538
/** @deprecated Remove after stable consent hash is running in production */
7639
public function isUnstable(): bool
7740
{
78-
return $this->consentVersion === self::UNSTABLE;
79-
}
80-
81-
public function isStable(): bool
82-
{
83-
return $this->consentVersion === self::STABLE;
41+
return $this === self::Unstable;
8442
}
8543
}

‎src/OpenConext/EngineBlockBundle/Authentication/Repository/DbalConsentRepository.php‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -209,13 +209,13 @@ public function hasConsentHash(ConsentHashQuery $query): ConsentVersion
209209

210210
if (count($rows) < 1) {
211211
// No stored consent found
212-
return ConsentVersion::notGiven();
212+
return ConsentVersion::NotGiven;
213213
}
214214

215215
if (!empty($rows[0]['attribute_stable'])) {
216-
return ConsentVersion::stable();
216+
return ConsentVersion::Stable;
217217
}
218-
return ConsentVersion::unstable();
218+
return ConsentVersion::Unstable;
219219
} catch (Exception $e) {
220220
throw new RuntimeException(sprintf('Consent retrieval failed! Error: "%s"', $e->getMessage()));
221221
}

‎tests/library/EngineBlock/Test/Corto/Model/ConsentIntegrationTest.php‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ public function test_no_previous_consent_given($consentType)
9292
$this->consentRepository
9393
->shouldReceive('hasConsentHash')
9494
->once()
95-
->andReturn(ConsentVersion::notGiven());
95+
->andReturn(ConsentVersion::NotGiven);
9696
switch ($consentType) {
9797
case ConsentType::Explicit:
9898
$this->assertFalse($this->consent->explicitConsentWasGivenFor($serviceProvider)->given());
@@ -121,7 +121,7 @@ public function test_unstable_previous_consent_given($consentType)
121121
consentType: $consentType->value,
122122
))
123123
->once()
124-
->andReturn(ConsentVersion::unstable());
124+
->andReturn(ConsentVersion::Unstable);
125125

126126
switch ($consentType) {
127127
case ConsentType::Explicit:
@@ -151,7 +151,7 @@ public function test_stable_consent_given($consentType)
151151
consentType: $consentType->value,
152152
))
153153
->once()
154-
->andReturn(ConsentVersion::stable());
154+
->andReturn(ConsentVersion::Stable);
155155

156156
switch ($consentType) {
157157
case ConsentType::Explicit:
@@ -258,7 +258,7 @@ public function test_upgrade_toggle_off_preserves_legacy_hash($consentType)
258258
))
259259
->andReturn(true);
260260

261-
$this->assertNull($this->consent->upgradeAttributeHashFor($serviceProvider, $consentType, ConsentVersion::unstable()));
261+
$this->assertNull($this->consent->upgradeAttributeHashFor($serviceProvider, $consentType, ConsentVersion::Unstable));
262262
}
263263

264264
/**
@@ -286,7 +286,7 @@ public function test_upgrade_toggle_on_clears_legacy_hash($consentType)
286286
))
287287
->andReturn(true);
288288

289-
$this->assertNull($this->consent->upgradeAttributeHashFor($serviceProvider, $consentType, ConsentVersion::unstable()));
289+
$this->assertNull($this->consent->upgradeAttributeHashFor($serviceProvider, $consentType, ConsentVersion::Unstable));
290290
}
291291

292292
#[DataProvider('consentTypeProvider')]
@@ -299,7 +299,7 @@ public function test_upgrade_to_stable_consent_not_applied_when_stable($consentT
299299
$this->consentRepository->shouldNotReceive('updateConsentHash');
300300

301301
// Pass the pre-fetched ConsentVersion (stable) — no second DB query is made, no update triggered
302-
$this->assertNull($this->consent->upgradeAttributeHashFor($serviceProvider, $consentType, ConsentVersion::stable()));
302+
$this->assertNull($this->consent->upgradeAttributeHashFor($serviceProvider, $consentType, ConsentVersion::Stable));
303303
}
304304

305305
#[DataProvider('consentTypeProvider')]
@@ -311,7 +311,7 @@ public function test_upgrade_not_applied_when_no_consent_given($consentType)
311311
$this->consentRepository->shouldNotReceive('updateConsentHash');
312312

313313
// Pass the pre-fetched ConsentVersion (notGiven) — no update should be triggered
314-
$this->assertNull($this->consent->upgradeAttributeHashFor($serviceProvider, $consentType, ConsentVersion::notGiven()));
314+
$this->assertNull($this->consent->upgradeAttributeHashFor($serviceProvider, $consentType, ConsentVersion::NotGiven));
315315
}
316316

317317
#[DataProvider('consentTypeProvider')]
@@ -329,7 +329,7 @@ public function test_upgrade_continues_gracefully_when_attributes_changed($conse
329329

330330
// Must not throw; the warning is logged inside the repository
331331
// Pass the pre-fetched ConsentVersion (unstable) — no second DB query is made
332-
$this->assertNull($this->consent->upgradeAttributeHashFor($serviceProvider, $consentType, ConsentVersion::unstable()));
332+
$this->assertNull($this->consent->upgradeAttributeHashFor($serviceProvider, $consentType, ConsentVersion::Unstable));
333333
}
334334

335335
public function test_store_consent_hash_sql_resets_deleted_at_on_duplicate(): void

‎tests/library/EngineBlock/Test/Corto/Model/ConsentTest.php‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,8 @@ public function testUpgradeAttributeHashSkippedWhenConsentDisabled()
7878
$this->consentService->shouldNotReceive('retrieveConsentHash');
7979
$this->consentService->shouldNotReceive('updateConsentHash');
8080

81-
$this->consentDisabled->upgradeAttributeHashFor($serviceProvider, ConsentType::Explicit, ConsentVersion::stable());
82-
$this->consentDisabled->upgradeAttributeHashFor($serviceProvider, ConsentType::Implicit, ConsentVersion::stable());
81+
$this->consentDisabled->upgradeAttributeHashFor($serviceProvider, ConsentType::Explicit, ConsentVersion::Stable);
82+
$this->consentDisabled->upgradeAttributeHashFor($serviceProvider, ConsentType::Implicit, ConsentVersion::Stable);
8383
}
8484

8585
public function testConsentWriteToDatabase()
@@ -88,7 +88,7 @@ public function testConsentWriteToDatabase()
8888

8989
$this->consentService->shouldReceive('getUnstableAttributesHash')->andReturn(sha1('unstable'));
9090
$this->consentService->shouldReceive('getStableConsentHash')->andReturn(sha1('stable'));
91-
$this->consentService->shouldReceive('retrieveConsentHash')->andReturn(ConsentVersion::stable());
91+
$this->consentService->shouldReceive('retrieveConsentHash')->andReturn(ConsentVersion::Stable);
9292
$this->consentService->shouldReceive('storeConsentHash')->andReturn(true);
9393

9494
$this->assertTrue($this->consent->explicitConsentWasGivenFor($serviceProvider)->given());
@@ -132,7 +132,7 @@ public function testConsentUidFromAmPriorToConsentEnabled()
132132

133133
$this->consentService->shouldReceive('getUnstableAttributesHash')->andReturn(sha1('unstable'));
134134
$this->consentService->shouldReceive('getStableConsentHash')->andReturn(sha1('stable'));
135-
$this->consentService->shouldReceive('retrieveConsentHash')->andReturn(ConsentVersion::stable());
135+
$this->consentService->shouldReceive('retrieveConsentHash')->andReturn(ConsentVersion::Stable);
136136

137137
// Act: trigger a code path that calls _getConsentUid()
138138
$result = $consentWithAmPrior->explicitConsentWasGivenFor($serviceProvider);
@@ -171,6 +171,6 @@ public function testNullNameIdReturnsNoConsentWithoutCallingRepository()
171171
$this->assertFalse($consentWithNullUid->giveExplicitConsentFor($serviceProvider));
172172
$this->assertFalse($consentWithNullUid->giveImplicitConsentFor($serviceProvider));
173173
// upgradeAttributeHashFor should not throw when UID is null
174-
$consentWithNullUid->upgradeAttributeHashFor($serviceProvider, ConsentType::Explicit, ConsentVersion::notGiven());
174+
$consentWithNullUid->upgradeAttributeHashFor($serviceProvider, ConsentType::Explicit, ConsentVersion::NotGiven);
175175
}
176176
}

‎tests/library/EngineBlock/Test/Corto/Module/Service/ProcessConsentTest.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@ private function mockConsent()
223223
$consentMock = Phake::mock('EngineBlock_Corto_Model_Consent');
224224
Phake::when($consentMock)
225225
->explicitConsentWasGivenFor(Phake::anyParameters())
226-
->thenReturn(ConsentVersion::notGiven());
226+
->thenReturn(ConsentVersion::NotGiven);
227227
Phake::when($this->consentFactoryMock)
228228
->create(Phake::anyParameters())
229229
->thenReturn($consentMock);

‎tests/library/EngineBlock/Test/Corto/Module/Service/ProvideConsentTest.php‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ public function testConsentIsSkippedWhenPriorConsentIsStored()
124124

125125
Phake::when($this->consentMock)
126126
->explicitConsentWasGivenFor(Phake::anyParameters())
127-
->thenReturn(ConsentVersion::stable());
127+
->thenReturn(ConsentVersion::Stable);
128128

129129
$provideConsentService->serve(null, $this->httpRequestMock);
130130

@@ -280,10 +280,10 @@ private function mockConsent()
280280
$consentMock = Phake::mock('EngineBlock_Corto_Model_Consent');
281281
Phake::when($consentMock)
282282
->explicitConsentWasGivenFor(Phake::anyParameters())
283-
->thenReturn(ConsentVersion::notGiven());
283+
->thenReturn(ConsentVersion::NotGiven);
284284
Phake::when($consentMock)
285285
->implicitConsentWasGivenFor(Phake::anyParameters())
286-
->thenReturn(ConsentVersion::notGiven());
286+
->thenReturn(ConsentVersion::NotGiven);
287287
Phake::when($this->consentFactoryMock)
288288
->create(Phake::anyParameters())
289289
->thenReturn($consentMock);

‎tests/unit/OpenConext/EngineBlock/Authentication/Value/ConsentVersionTest.php‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,44 +19,44 @@
1919
namespace OpenConext\EngineBlock\Authentication\Tests\Value;
2020

2121
use OpenConext\EngineBlock\Authentication\Value\ConsentVersion;
22-
use OpenConext\EngineBlock\Exception\InvalidArgumentException;
2322
use PHPUnit\Framework\TestCase;
23+
use ValueError;
2424

2525
class ConsentVersionTest extends TestCase
2626
{
2727
public function testStableIsGiven(): void
2828
{
29-
$version = ConsentVersion::stable();
29+
$version = ConsentVersion::Stable;
3030

3131
$this->assertTrue($version->given());
3232
$this->assertTrue($version->isStable());
3333
$this->assertFalse($version->isUnstable());
34-
$this->assertSame('stable', (string) $version);
34+
$this->assertSame('stable', $version->value);
3535
}
3636

3737
public function testUnstableIsGiven(): void
3838
{
39-
$version = ConsentVersion::unstable();
39+
$version = ConsentVersion::Unstable;
4040

4141
$this->assertTrue($version->given());
4242
$this->assertFalse($version->isStable());
4343
$this->assertTrue($version->isUnstable());
44-
$this->assertSame('unstable', (string) $version);
44+
$this->assertSame('unstable', $version->value);
4545
}
4646

4747
public function testNotGivenIsNotGiven(): void
4848
{
49-
$version = ConsentVersion::notGiven();
49+
$version = ConsentVersion::NotGiven;
5050

5151
$this->assertFalse($version->given());
5252
$this->assertFalse($version->isStable());
5353
$this->assertFalse($version->isUnstable());
54-
$this->assertSame('not-given', (string) $version);
54+
$this->assertSame('not-given', $version->value);
5555
}
5656

5757
public function testInvalidVersionThrows(): void
5858
{
59-
$this->expectException(InvalidArgumentException::class);
60-
new ConsentVersion('invalid');
59+
$this->expectException(ValueError::class);
60+
ConsentVersion::from('invalid');
6161
}
6262
}

0 commit comments

Comments
 (0)