Remove "Options" suffix from annotations

nucleos · Jan 16, 2022 · dacab2a · dacab2a
1 parent e16f82e
commit dacab2a
Show file tree

Hide file tree

Showing 11 changed files with 25 additions and 25 deletions.
diff --git a/README.md b/README.md
@@ -24,8 +24,8 @@ Documentation
 * [Configuration](#configuration)
 * [How does it work](#how-does-it-work)
 * [Annotation](#annotation)
-    * [AdminOptions](#adminoptions)
-    * [AdminExtensionOptions](#adminextensionoptions)
+    * [Admin](#admin)
+    * [AdminExtension](#adminextension)
 
 ## Installation
 
@@ -77,7 +77,7 @@ admin classes and if autoconfigure is enabled we take the class name. If you
 defined a suffix in the config (by default it is `Admin`) we remove it to get
 the name of the entity, so if you had `CategoryAdmin` we get `Category`.
 
-After that we check if the `AdminOption` annotation is present, annotations
+After that we check if the `Admin` annotation is present, annotations
 have a higher priority than our guesses. If no annotation is defined or some of
 the values that are mandatory are not present we still try to guess.
 
@@ -130,7 +130,7 @@ public function setSomeService(SomeService $someService)
 
 ## Annotation
 
-### AdminOptions
+### Admin
 
 ```php
 <?php
@@ -143,7 +143,7 @@ use App\Entity\Category;
 use Sonata\AdminBundle\Admin\AbstractAdmin;
 
 /**
- * @Sonata\AdminOptions(
+ * @Sonata\Admin(
  *     label="Category",
  *     managerType="orm",
  *     group="Category",
@@ -171,7 +171,7 @@ final class CategoryAdmin extends AbstractAdmin
 }
 ```
 
-### AdminExtensionOptions
+### AdminExtension
 
 ```php
 <?php
@@ -182,7 +182,7 @@ use Nucleos\SonataAutoConfigureBundle\Annotation as Sonata;
 use Sonata\AdminBundle\Admin\AbstractAdminExtension;
 
 /**
- * @Sonata\AdminExtensionOptions(
+ * @Sonata\AdminExtension(
  *     global=true
  * )
  */
@@ -201,7 +201,7 @@ use Sonata\AdminBundle\Admin\AbstractAdminExtension;
 use App\Admin\ActivityAdmin;
 
 /**
- * @Sonata\AdminExtensionOptions(
+ * @Sonata\AdminExtension(
  *     target={"app.admin.project", ActivityAdmin::class}
  * )
  */

diff --git a/src/Annotation/AdminOptions.php → src/Annotation/Admin.php b/src/Annotation/AdminOptions.php → src/Annotation/Admin.php
@@ -17,7 +17,7 @@
  * @Annotation
  * @Target("CLASS")
  */
-final class AdminOptions
+final class Admin
 {
     /**
      * @var string

diff --git a/src/Annotation/AdminExtensionOptions.php → src/Annotation/AdminExtension.php b/src/Annotation/AdminExtensionOptions.php → src/Annotation/AdminExtension.php
@@ -17,7 +17,7 @@
  * @Annotation
  * @Target("CLASS")
  */
-final class AdminExtensionOptions
+final class AdminExtension
 {
     /**
      * @var bool

diff --git a/src/DependencyInjection/Compiler/AutoConfigureAdminClassesCompilerPass.php b/src/DependencyInjection/Compiler/AutoConfigureAdminClassesCompilerPass.php
@@ -16,7 +16,7 @@
 use Doctrine\Common\Annotations\Reader;
 use Doctrine\Inflector\Inflector;
 use Doctrine\Inflector\InflectorFactory;
-use Nucleos\SonataAutoConfigureBundle\Annotation\AdminOptions;
+use Nucleos\SonataAutoConfigureBundle\Annotation\Admin;
 use Nucleos\SonataAutoConfigureBundle\Exception\EntityNotFound;
 use ReflectionClass;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
@@ -87,11 +87,11 @@ public function process(ContainerBuilder $container): void
                 $name = preg_replace("/{$adminSuffix}$/", '', $name);
             }
 
-            /** @var AdminOptions $annotation */
+            /** @var Admin $annotation */
             $annotation = $annotationReader->getClassAnnotation(
                 new ReflectionClass($adminClass),
-                AdminOptions::class
-            ) ?? new AdminOptions();
+                Admin::class
+            ) ?? new Admin();
 
             $this->setDefaultValuesForAnnotation($inflector, $annotation, $name, $annotationDefaults);
 
@@ -127,7 +127,7 @@ public function process(ContainerBuilder $container): void
         }
     }
 
-    private function setDefaultValuesForAnnotation(Inflector $inflector, AdminOptions $annotation, string $name, array $defaults): void
+    private function setDefaultValuesForAnnotation(Inflector $inflector, Admin $annotation, string $name, array $defaults): void
     {
         if (!$annotation->label) {
             $annotation->label = $inflector->capitalize(str_replace('_', ' ', $inflector->tableize($name)));

diff --git a/src/DependencyInjection/Compiler/AutoConfigureAdminExtensionsCompilerPass.php b/src/DependencyInjection/Compiler/AutoConfigureAdminExtensionsCompilerPass.php
@@ -14,7 +14,7 @@
 namespace Nucleos\SonataAutoConfigureBundle\DependencyInjection\Compiler;
 
 use Doctrine\Common\Annotations\Reader;
-use Nucleos\SonataAutoConfigureBundle\Annotation\AdminExtensionOptions;
+use Nucleos\SonataAutoConfigureBundle\Annotation\AdminExtension;
 use ReflectionClass;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
@@ -39,7 +39,7 @@ public function process(ContainerBuilder $container): void
 
             $annotation = $annotationReader->getClassAnnotation(
                 new ReflectionClass($definitionClass),
-                AdminExtensionOptions::class
+                AdminExtension::class
             );
 
             if (!$annotation) {
@@ -70,12 +70,12 @@ public function process(ContainerBuilder $container): void
         }
     }
 
-    private function hasTargets(AdminExtensionOptions $annotation): bool
+    private function hasTargets(AdminExtension $annotation): bool
     {
         return \is_array($annotation->target) && \count($annotation->target) > 0;
     }
 
-    private function getTagAttributes(string $target, AdminExtensionOptions $annotation): array
+    private function getTagAttributes(string $target, AdminExtension $annotation): array
     {
         $attributes['target'] = $target;
 

diff --git a/tests/Fixtures/Admin/AnnotationAdmin.php b/tests/Fixtures/Admin/AnnotationAdmin.php
@@ -17,7 +17,7 @@
 use Nucleos\SonataAutoConfigureBundle\Tests\Fixtures\Entity\Category;
 
 /**
- * @Sonata\AdminOptions(
+ * @Sonata\Admin(
  *     label="This is a Label",
  *     entity=Category::class,
  *     group="not test",

diff --git a/tests/Fixtures/Admin/DisableAutowireEntityAdmin.php b/tests/Fixtures/Admin/DisableAutowireEntityAdmin.php
@@ -16,7 +16,7 @@
 use Nucleos\SonataAutoConfigureBundle\Annotation as Sonata;
 
 /**
- * @Sonata\AdminOptions(autowireEntity=false, templates=null)
+ * @Sonata\Admin(autowireEntity=false, templates=null)
  */
 class DisableAutowireEntityAdmin
 {

diff --git a/tests/Fixtures/Admin/Extension/ExtensionWithoutOptions.php b/tests/Fixtures/Admin/Extension/ExtensionWithoutOptions.php
@@ -16,7 +16,7 @@
 use Nucleos\SonataAutoConfigureBundle\Annotation as Sonata;
 
 /**
- * @Sonata\AdminExtensionOptions()
+ * @Sonata\AdminExtension()
  */
 class ExtensionWithoutOptions
 {

diff --git a/tests/Fixtures/Admin/Extension/GlobalExtension.php b/tests/Fixtures/Admin/Extension/GlobalExtension.php
@@ -16,7 +16,7 @@
 use Nucleos\SonataAutoConfigureBundle\Annotation as Sonata;
 
 /**
- * @Sonata\AdminExtensionOptions(
+ * @Sonata\AdminExtension(
  *     global=true
  * )
  */

diff --git a/tests/Fixtures/Admin/Extension/MultipleTargetedExtension.php b/tests/Fixtures/Admin/Extension/MultipleTargetedExtension.php
@@ -16,7 +16,7 @@
 use Nucleos\SonataAutoConfigureBundle\Annotation as Sonata;
 
 /**
- * @Sonata\AdminExtensionOptions(
+ * @Sonata\AdminExtension(
  *     target={"app.admin.category", "app.admin.media"}
  * )
  */

diff --git a/tests/Fixtures/Admin/Extension/TargetedWithPriorityExtension.php b/tests/Fixtures/Admin/Extension/TargetedWithPriorityExtension.php
@@ -16,7 +16,7 @@
 use Nucleos\SonataAutoConfigureBundle\Annotation as Sonata;
 
 /**
- * @Sonata\AdminExtensionOptions(
+ * @Sonata\AdminExtension(
  *     target={"app.admin.category"},
  *     priority=5
  * )