Drop Interface suffix

Author: tobyzerner

CHANGELOG.md

@@ -8,6 +8,17 @@ and this project adheres to
 
 ## [Unreleased]
 
+### ⚠️ Breaking Changes
+
+-   Drop `Interface` suffix from various interfaces:
+    -   `Resource` class renamed to `AbstractResource`
+    -   `ResourceInterface` renamed to `Resource`
+    -   `CollectionInterface` renamed to `Collection`
+    -   `ErrorProviderInterface` renamed to `ErrorProvider`
+    -   `PaginationInterface` renamed to `Pagination`
+    -   `EndpointInterface` renamed to `Endpoint`
+    -   `TypeInterface` renamed to `Type`
+
 ## [1.0.0-beta.2] - 2023-12-02
 
 ### ⚠️ Breaking Changes

docs/collections.md

@@ -11,12 +11,12 @@ also used for defining
 ## Defining Collections
 
 To define a heterogeneous collection, create a new class that implements
-`Tobyz\JsonApi\Resource\CollectionInterface`:
+`Tobyz\JsonApi\Resource\Collection`:
 
 ```php
-use Tobyz\JsonApiServer\Resource\CollectionInterface;
+use Tobyz\JsonApiServer\Resource\Collection;
 
-class ActivityCollection implements CollectionInterface
+class ActivityCollection implements Collection
 {
     /**
      * Get the collection name.

docs/context.md

@@ -17,13 +17,13 @@ class Context
     public ServerRequestInterface $request;
 
     // The collection that the request is for
-    public ?CollectionInterface $collection = null;
+    public ?Collection $collection = null;
 
     // The resource that the request is for
-    public ?ResourceInterface $resource = null;
+    public ?Resource $resource = null;
 
     // The endpoint handling the request
-    public ?EndpointInterface $endpoint = null;
+    public ?Endpoint $endpoint = null;
 
     // The query being constructed by the Index endpoint
     public ?object $query = null;
@@ -54,13 +54,13 @@ class Context
     public function body(): ?array;
 
     // Get a resource by type
-    public function resource(string $type): ResourceInterface;
+    public function resource(string $type): Resource;
 
     // Get the fields for the given resource, keyed by name
-    public function fields(ResourceInterface $resource): array;
+    public function fields(Resource $resource): array;
 
     // Get only the requested fields for the given resource
-    public function sparseFields(ResourceInterface $resource): array;
+    public function sparseFields(Resource $resource): array;
 
     // Determine whether a field has been requested in a sparse fieldset
     public function fieldRequested(string $type, string $field, bool $default = true): bool;

docs/errors.md

@@ -15,9 +15,9 @@ try {
 
 ## Error Providers
 
-Exceptions can implement `Tobyz\JsonApiServer\Exception\ErrorProviderInterface`
-to determine what status code will be used in the response, and any JSON:API
-error objects to be rendered in the document.
+Exceptions can implement the `Tobyz\JsonApiServer\Exception\ErrorProvider`
+interface to determine what status code will be used in the response, and any
+JSON:API error objects to be rendered in the document.
 
 The interface defines two methods:
 
@@ -26,9 +26,9 @@ The interface defines two methods:
 
 ```php
 use JsonApiPhp\JsonApi\Error;
-use Tobyz\JsonApiServer\Exception\ErrorProviderInterface;
+use Tobyz\JsonApiServer\Exception\ErrorProvider;
 
-class ImATeapotException implements ErrorProviderInterface
+class ImATeapotException implements ErrorProvider
 {
     public function getJsonApiErrors(): array
     {

docs/list.md

@@ -47,9 +47,9 @@ An example implementation might look like:
 ```php
 use App\Models\Post;
 use Tobyz\JsonApiServer\Context;
-use Tobyz\JsonApiServer\Resource\{Listable, Resource};
+use Tobyz\JsonApiServer\Resource\{Listable, AbstractResource};
 
-class PostsResource extends Resource implements Listable
+class PostsResource extends AbstractResource implements Listable
 {
     // ...
 
@@ -284,9 +284,9 @@ applied to your query:
 ```php
 use Tobyz\JsonApiServer\Context;
 use Tobyz\JsonApiServer\Pagination\OffsetPagination;
-use Tobyz\JsonApiServer\Resource\{Listable, Paginatable, Resource};
+use Tobyz\JsonApiServer\Resource\{Listable, Paginatable, AbstractResource};
 
-class PostsResource extends Resource implements Listable, Paginatable
+class PostsResource extends AbstractResource implements Listable, Paginatable
 {
     // ...
 
@@ -309,9 +309,17 @@ of resources as `meta` information, you can implement the
 ```php
 use Tobyz\JsonApiServer\Context;
 use Tobyz\JsonApiServer\Pagination\OffsetPagination;
-use Tobyz\JsonApiServer\Resource\{Countable, Listable, Paginatable, Resource};
-
-class PostsResource extends Resource implements Listable, Paginatable, Countable
+use Tobyz\JsonApiServer\Resource\{
+    Countable,
+    Listable,
+    Paginatable,
+    AbstractResource,
+};
+
+class PostsResource extends AbstractResource implements
+    Listable,
+    Paginatable,
+    Countable
 {
     // ...
 

docs/resources.md

@@ -31,9 +31,9 @@ the name of your resource type. This will also be used as the collection path
 for your resource.
 
 ```php
-use Tobyz\JsonApiServer\Resource\Resource;
+use Tobyz\JsonApiServer\Resource\AbstractResource;
 
-class PostsResource extends Resource
+class PostsResource extends AbstractResource
 {
     public function type(): string
     {

src/Context.php

@@ -3,17 +3,17 @@
 namespace Tobyz\JsonApiServer;
 
 use Psr\Http\Message\ServerRequestInterface;
-use Tobyz\JsonApiServer\Endpoint\EndpointInterface;
-use Tobyz\JsonApiServer\Resource\CollectionInterface;
-use Tobyz\JsonApiServer\Resource\ResourceInterface;
+use Tobyz\JsonApiServer\Endpoint\Endpoint;
+use Tobyz\JsonApiServer\Resource\Collection;
+use Tobyz\JsonApiServer\Resource\Resource;
 use Tobyz\JsonApiServer\Schema\Field\Field;
 use WeakMap;
 
 class Context
 {
-    public ?CollectionInterface $collection = null;
-    public ?ResourceInterface $resource = null;
-    public ?EndpointInterface $endpoint = null;
+    public ?Collection $collection = null;
+    public ?Resource $resource = null;
+    public ?Endpoint $endpoint = null;
     public ?object $query = null;
     public ?Serializer $serializer = null;
     public mixed $model = null;
@@ -72,7 +72,7 @@ public function body(): ?array
     /**
      * Get a resource by its type.
      */
-    public function resource(string $type): ResourceInterface
+    public function resource(string $type): Resource
     {
         return $this->api->getResource($type);
     }
@@ -82,7 +82,7 @@ public function resource(string $type): ResourceInterface
      *
      * @return array<string, Field>
      */
-    public function fields(ResourceInterface $resource): array
+    public function fields(Resource $resource): array
     {
         if (isset($this->fields[$resource])) {
             return $this->fields[$resource];
@@ -102,7 +102,7 @@ public function fields(ResourceInterface $resource): array
      *
      * @return array<string, Field>
      */
-    public function sparseFields(ResourceInterface $resource): array
+    public function sparseFields(Resource $resource): array
     {
         if (isset($this->sparseFields[$resource])) {
             return $this->sparseFields[$resource];
@@ -157,21 +157,21 @@ public function withRequest(ServerRequestInterface $request): static
         return $new;
     }
 
-    public function withCollection(CollectionInterface $collection): static
+    public function withCollection(Collection $collection): static
     {
         $new = clone $this;
         $new->collection = $collection;
         return $new;
     }
 
-    public function withResource(ResourceInterface $resource): static
+    public function withResource(Resource $resource): static
     {
         $new = clone $this;
         $new->resource = $resource;
         return $new;
     }
 
-    public function withEndpoint(EndpointInterface $endpoint): static
+    public function withEndpoint(Endpoint $endpoint): static
     {
         $new = clone $this;
         $new->endpoint = $endpoint;

src/Endpoint/Create.php

@@ -16,7 +16,7 @@
 use function Tobyz\JsonApiServer\json_api_response;
 use function Tobyz\JsonApiServer\set_value;
 
-class Create implements EndpointInterface
+class Create implements Endpoint
 {
     use HasVisibility;
     use SavesData;

src/Endpoint/Delete.php

@@ -15,7 +15,7 @@
 
 use function Tobyz\JsonApiServer\json_api_response;
 
-class Delete implements EndpointInterface
+class Delete implements Endpoint
 {
     use HasMeta;
     use HasVisibility;

src/Endpoint/EndpointInterface.php renamed to src/Endpoint/Endpoint.php

@@ -5,7 +5,7 @@
 use Psr\Http\Message\ResponseInterface as Response;
 use Tobyz\JsonApiServer\Context;
 
-interface EndpointInterface
+interface Endpoint
 {
     public function handle(Context $context): ?Response;
 }

src/Endpoint/Index.php

@@ -22,7 +22,7 @@
 use function Tobyz\JsonApiServer\json_api_response;
 use function Tobyz\JsonApiServer\parse_sort_string;
 
-class Index implements EndpointInterface
+class Index implements Endpoint
 {
     use HasMeta;
     use HasVisibility;

src/Endpoint/Show.php

@@ -12,7 +12,7 @@
 
 use function Tobyz\JsonApiServer\json_api_response;
 
-class Show implements EndpointInterface
+class Show implements Endpoint
 {
     use HasVisibility;
     use FindsResources;

src/Endpoint/Update.php

@@ -15,7 +15,7 @@
 
 use function Tobyz\JsonApiServer\json_api_response;
 
-class Update implements EndpointInterface
+class Update implements Endpoint
 {
     use HasVisibility;
     use FindsResources;

src/Exception/BadRequestException.php

@@ -5,7 +5,7 @@
 use DomainException;
 use Tobyz\JsonApiServer\Exception\Concerns\SingleError;
 
-class BadRequestException extends DomainException implements ErrorProviderInterface, Sourceable
+class BadRequestException extends DomainException implements ErrorProvider, Sourceable
 {
     use SingleError;
 

src/Exception/ConflictException.php

@@ -5,7 +5,7 @@
 use DomainException;
 use Tobyz\JsonApiServer\Exception\Concerns\SingleError;
 
-class ConflictException extends DomainException implements ErrorProviderInterface, Sourceable
+class ConflictException extends DomainException implements ErrorProvider, Sourceable
 {
     use SingleError;
 

src/Exception/ErrorProviderInterface.php renamed to src/Exception/ErrorProvider.php

@@ -2,7 +2,7 @@
 
 namespace Tobyz\JsonApiServer\Exception;
 
-interface ErrorProviderInterface
+interface ErrorProvider
 {
     /**
      * Get JSON:API error objects that represent this error.

src/Exception/ForbiddenException.php

@@ -5,7 +5,7 @@
 use DomainException;
 use Tobyz\JsonApiServer\Exception\Concerns\SingleError;
 
-class ForbiddenException extends DomainException implements ErrorProviderInterface, Sourceable
+class ForbiddenException extends DomainException implements ErrorProvider, Sourceable
 {
     use SingleError;
 

src/Exception/InternalServerErrorException.php

@@ -5,9 +5,7 @@
 use RuntimeException;
 use Tobyz\JsonApiServer\Exception\Concerns\SingleError;
 
-class InternalServerErrorException extends RuntimeException implements
-    ErrorProviderInterface,
-    Sourceable
+class InternalServerErrorException extends RuntimeException implements ErrorProvider, Sourceable
 {
     use SingleError;
 

src/Exception/MethodNotAllowedException.php

@@ -5,9 +5,7 @@
 use DomainException;
 use Tobyz\JsonApiServer\Exception\Concerns\SingleError;
 
-class MethodNotAllowedException extends DomainException implements
-    ErrorProviderInterface,
-    Sourceable
+class MethodNotAllowedException extends DomainException implements ErrorProvider, Sourceable
 {
     use SingleError;
 

src/Exception/NotAcceptableException.php

@@ -5,7 +5,7 @@
 use DomainException;
 use Tobyz\JsonApiServer\Exception\Concerns\SingleError;
 
-class NotAcceptableException extends DomainException implements ErrorProviderInterface, Sourceable
+class NotAcceptableException extends DomainException implements ErrorProvider, Sourceable
 {
     use SingleError;
 

src/Exception/NotFoundException.php

@@ -5,7 +5,7 @@
 use DomainException;
 use Tobyz\JsonApiServer\Exception\Concerns\SingleError;
 
-class NotFoundException extends DomainException implements ErrorProviderInterface, Sourceable
+class NotFoundException extends DomainException implements ErrorProvider, Sourceable
 {
     use SingleError;
 

src/Exception/NotImplementedException.php

@@ -5,7 +5,7 @@
 use DomainException;
 use Tobyz\JsonApiServer\Exception\Concerns\SingleError;
 
-class NotImplementedException extends DomainException implements ErrorProviderInterface, Sourceable
+class NotImplementedException extends DomainException implements ErrorProvider, Sourceable
 {
     use SingleError;
 

src/Exception/ResourceNotFoundException.php

@@ -5,9 +5,7 @@
 use DomainException;
 use Tobyz\JsonApiServer\Exception\Concerns\SingleError;
 
-class ResourceNotFoundException extends DomainException implements
-    ErrorProviderInterface,
-    Sourceable
+class ResourceNotFoundException extends DomainException implements ErrorProvider, Sourceable
 {
     use SingleError;
 

src/Exception/UnprocessableEntityException.php

@@ -4,9 +4,7 @@
 
 use DomainException;
 
-class UnprocessableEntityException extends DomainException implements
-    ErrorProviderInterface,
-    Sourceable
+class UnprocessableEntityException extends DomainException implements ErrorProvider, Sourceable
 {
     public function __construct(public array $errors)
     {

src/Exception/UnsupportedMediaTypeException.php

@@ -5,9 +5,7 @@
 use DomainException;
 use Tobyz\JsonApiServer\Exception\Concerns\SingleError;
 
-class UnsupportedMediaTypeException extends DomainException implements
-    ErrorProviderInterface,
-    Sourceable
+class UnsupportedMediaTypeException extends DomainException implements ErrorProvider, Sourceable
 {
     use SingleError;