Skip to content

Commit

Permalink
add custom replacers where rules have parameters
Browse files Browse the repository at this point in the history
  • Loading branch information
@miken32
miken32 committed Oct 20, 2023
1 parent fdf1f4f commit 473ed1c
Show file tree
Hide file tree
Showing 8 changed files with 90 additions and 58 deletions.
34 changes: 28 additions & 6 deletions src/Rules/InNetwork.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,35 @@ public function doValidation(string $value, ...$parameters): bool

public function message(): string
{
if (isset($this->networks) && count($this->networks) > 1) {
return __('The :attribute field must be an IP address within the allowed networks');
$message = __('The :attribute field must be an IP address within the :net network(s)');
if (!$this->extended) {
$message = $this->replace($message, "", "", $this->networks);
}

return sprintf(
__('The :attribute field must be an IP address within the %s network'),
$this->networks[0] ?? __('specified')
);
return $message;
}

/**
* Generate a nice list when multiple networks are supplied
*/
public function replace(string $message, string $attribute, string $rule, array $parameters): string
{
if (count($parameters) > 2) {
array_walk($parameters, function(&$v, $k) use ($parameters) {
if ($k < count($parameters) - 1) {
$v .= ',';
}
if ($k === count($parameters) - 2) {
$v .= ' or';
}
});
$nets = implode(" ", $parameters);
} elseif (count($parameters) === 2) {
$nets = implode(" or ", $parameters);
} else {
$nets = $parameters[0];
}

return str_replace(':net', $nets, $message);
}
}
31 changes: 13 additions & 18 deletions src/Rules/Netv4.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@

class Netv4 extends BaseRule
{
private bool $validMask = true;

public function __construct(
private ?int $minBits = Util::IPV4_RANGE_MIN,
private ?int $maxBits = Util::IPV4_RANGE_MAX
Expand All @@ -32,28 +30,25 @@ public function doValidation(string $value, ...$parameters): bool
throw new InvalidArgumentException('Invalid network validation rule arguments');
}

$result = Util::validIPv4Network($value, $this->minBits, $this->maxBits);
if (!$result && str_contains($value, '/')) {
[, $mask] = explode('/', $value);
$this->validMask = Util::validRange($mask, $this->minBits, $this->maxBits);
return Util::validIPv4Network($value, $this->minBits, $this->maxBits);
}

return false;
public function message(): string
{
$message = __('The :attribute field must be an IPv4 network in CIDR notation');
if (!$this->extended) {
$message = $this->replace($message, "", "", [$this->minBits, $this->maxBits]);
}

return $result;
return $message;
}

public function message(): string
public function replace(string $message, string $attribute, string $rule, array $parameters): string
{
if (!$this->validMask) {
// this only works when validating with instance method
return sprintf(
__('The :attribute field must have a network mask between %d and %d bits'),
$this->minBits,
$this->maxBits
);
if (count($parameters) === 2) {
$message .= vsprintf(__(' with a mask between %d and %d bits'), $parameters);
}

return __('The :attribute field must be an IPv4 network in CIDR notation');
return $message;
}
}
}
23 changes: 14 additions & 9 deletions src/Rules/Netv6.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,15 +45,20 @@ public function doValidation(string $value, ...$parameters): bool

public function message(): string
{
if (!$this->validMask) {
// this only works when validating with instance method
return sprintf(
__('The :attribute field must have a network mask between %d and %d bits'),
$this->minBits,
$this->maxBits
);
$message = __('The :attribute field must be an IPv6 network in CIDR notation');
if (!$this->extended) {
$message = $this->replace($message, "", "", [$this->minBits, $this->maxBits]);
}

return __('The :attribute field must be an IPv6 network in CIDR notation');
return $message;
}
}

public function replace(string $message, string $attribute, string $rule, array $parameters): string
{
if (count($parameters) === 2) {
$message .= vsprintf(__(' with a mask between %d and %d bits'), $parameters);
}

return $message;
}
}
23 changes: 14 additions & 9 deletions src/Rules/RoutableNetv4.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,15 +45,20 @@ public function doValidation(string $value, ...$parameters): bool

public function message(): string
{
if (!$this->validMask) {
// this only works when validating with instance method
return sprintf(
__('The :attribute field must have a network mask between %d and %d bits'),
$this->minBits,
$this->maxBits
);
$message = __('The :attribute field must be a routable IPv4 network in CIDR notation');
if (!$this->extended) {
$message = $this->replace($message, "", "", [$this->minBits, $this->maxBits]);
}

return __('The :attribute field must be a routable IPv4 network in CIDR notation');
return $message;
}
}

public function replace(string $message, string $attribute, string $rule, array $parameters): string
{
if (count($parameters) === 2) {
$message .= vsprintf(__(' with a mask between %d and %d bits'), $parameters);
}

return $message;
}
}
23 changes: 14 additions & 9 deletions src/Rules/RoutableNetv6.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,15 +45,20 @@ public function doValidation(string $value, ...$parameters): bool

public function message(): string
{
if (!$this->validMask) {
// this only works when validating with instance method
return sprintf(
__('The :attribute field must have a network mask between %d and %d bits'),
$this->minBits,
$this->maxBits
);
$message = __('The :attribute field must be a routable IPv6 network in CIDR notation');
if (!$this->extended) {
$message = $this->replace($message, "", "", [$this->minBits, $this->maxBits]);
}

return __('The :attribute field must be a routable IPv6 network in CIDR notation');
return $message;
}
}

public function replace(string $message, string $attribute, string $rule, array $parameters): string
{
if (count($parameters) === 2) {
$message .= vsprintf(__(' with a mask between %d and %d bits'), $parameters);
}

return $message;
}
}
4 changes: 2 additions & 2 deletions tests/Feature/InNetworkTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ public function instanceAccepts(): void
public function stringRejectsIpv4(): void
{
$this->expectException(ValidationException::class);
$this->expectExceptionMessage('The input test field must be an IP address within the specified network');
$this->expectExceptionMessage('The input test field must be an IP address within the 10.0.0.0/8 network');
Validator::validate(
['input_test' => '172.16.0.56'],
['input_test' => 'in_network:10.0.0.0/8']
Expand All @@ -79,7 +79,7 @@ public function stringRejectsIpv4(): void
public function stringRejectsIpv6(): void
{
$this->expectException(ValidationException::class);
$this->expectExceptionMessage('The input test field must be an IP address within the specified network');
$this->expectExceptionMessage('The input test field must be an IP address within the 2601:44ec:a425e::/64 network');
Validator::validate(
['input_test' => '2608:445d:2183:ce42::582c'],
['input_test' => 'in_network:2601:44ec:a425e::/64']
Expand Down
4 changes: 2 additions & 2 deletions tests/Feature/Netv4Test.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ public function instanceAcceptsUnbounded(): void
public function stringRejectsBounded(): void
{
$this->expectException(ValidationException::class);
$this->expectExceptionMessage('The input test field must be an IPv4 network in CIDR notation');
$this->expectExceptionMessage('The input test field must be an IPv4 network in CIDR notation with a mask between 20 and 24 bits');
Validator::validate(
['input_test' => $this->faker->ipv4 . '/28'],
['input_test' => 'netv4:20,24']
Expand All @@ -92,7 +92,7 @@ public function stringRejectsUnbounded(): void
public function instanceRejectsBounded(): void
{
$this->expectException(ValidationException::class);
$this->expectExceptionMessage('The input test field must have a network mask between 20 and 24 bits');
$this->expectExceptionMessage('The input test field must be an IPv4 network in CIDR notation with a mask between 20 and 24 bits');
Validator::validate(
['input_test' => $this->faker->ipv4 . '/28'],
['input_test' => new Rules\Netv4(20, 24)]
Expand Down
6 changes: 3 additions & 3 deletions tests/Feature/Netv6Test.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ public function instanceAcceptsUnbounded(): void
public function stringRejectsBounded(): void
{
$this->expectException(ValidationException::class);
$this->expectExceptionMessage('The input test field must be an IPv6 network in CIDR notation');
$this->expectExceptionMessage('The input test field must be an IPv6 network in CIDR notation with a mask between 60 and 64 bits');
Validator::validate(
['input_test' => $this->faker->ipv6 . '/48'],
['input_test' => 'netv6:60,64']
Expand All @@ -92,7 +92,7 @@ public function stringRejectsUnbounded(): void
public function instanceRejectsBounded(): void
{
$this->expectException(ValidationException::class);
$this->expectExceptionMessage('The input test field must have a network mask between 60 and 64 bits');
$this->expectExceptionMessage('The input test field must be an IPv6 network in CIDR notation with a mask between 60 and 64 bits');
Validator::validate(
['input_test' => $this->faker->ipv6 . '/48'],
['input_test' => new Rules\Netv6(60, 64)]
Expand All @@ -105,7 +105,7 @@ public function instanceRejectsBounded(): void
public function instanceRejectsUnbounded(): void
{
$this->expectException(ValidationException::class);
$this->expectExceptionMessage('The input test field must have a network mask between 0 and 128 bits');
$this->expectExceptionMessage('The input test field must be an IPv6 network in CIDR notation with a mask between 0 and 128 bits');
Validator::validate(
['input_test' => $this->faker->ipv6 . '/200'],
['input_test' => new Rules\Netv6()]
Expand Down

0 comments on commit 473ed1c

Please sign in to comment.