Refactor AddsIncludesToQuery trait to add default includes handling

src/Concerns/AddsIncludesToQuery.php

@@ -11,12 +11,35 @@
 trait AddsIncludesToQuery
 {
  protected ?Collection $allowedIncludes = null;
+ protected ?Collection $defaultIncludes = null;
 
  public function allowedIncludes($includes): static
  {
  $includes = is_array($includes) ? $includes : func_get_args();
 
- $this->allowedIncludes = collect($includes)
+ $this->allowedIncludes = $this->parseIncludes($includes);
+
+ $this->ensureAllIncludesExist();
+
+ $includes = $this->filterNonExistingIncludes($this->request->includes());
+
+ $this->addIncludesToQuery($includes);
+
+ return $this;
+ }
+
+ public function defaultIncludes($includes): static
+ {
+ $this->defaultIncludes = $this->parseIncludes($includes);
+
+ $this->addIncludesToQuery(collect($includes));
+
+ return $this;
+ }
+
+ protected function parseIncludes($includes): Collection
+ {
+ return collect($includes)
  ->reject(function ($include) {
  return empty($include);
  })
@@ -39,17 +62,9 @@ public function allowedIncludes($includes): static
 
  return AllowedInclude::relationship($include);
  })
- ->unique(function (AllowedInclude $allowedInclude) {
- return $allowedInclude->getName();
+ ->unique(function (AllowedInclude $include) {
+ return $include->getName();
  });
-
- $this->ensureAllIncludesExist();
-
- $includes = $this->filterNonExistingIncludes($this->request->includes());
-
- $this->addIncludesToQuery($includes);
-
- return $this;
  }
 
  protected function addIncludesToQuery(Collection $includes): void
@@ -63,7 +78,11 @@ protected function addIncludesToQuery(Collection $includes): void
 
  protected function findInclude(string $include): ?AllowedInclude
  {
- return $this->allowedIncludes
+ $allowedIncludes = $this->allowedIncludes ?? collect();
+ $defaultIncludes = $this->defaultIncludes ?? collect();
+ $includes = $allowedIncludes->merge($defaultIncludes);
+
+ return $includes
  ->first(fn (AllowedInclude $included) => $included->isForInclude($include));
  }
 
@@ -97,4 +116,4 @@ protected function filterNonExistingIncludes(Collection $includes): Collection
 
  return $includes->filter(fn ($include) => ! is_null($this->findInclude($include)));
  }
-}
+}