Polish migration file accessors

Author: stevebauman

src/Console/FreshCommand.php

@@ -31,18 +31,18 @@ class FreshCommand extends Command
      */
     public function handle(
         Migrator $migrator,
-        MigrationRepository $migrationRepository,
-        IndexManagerInterface $indexManager
+        IndexManagerInterface $index,
+        MigrationRepository $migrations,
     ): int {
         $migrator->setOutput($this->output);
 
         if (! $this->confirmToProceed() || ! $migrator->isReady()) {
             return 1;
         }
 
-        $indexManager->drop('*');
+        $index->drop('*');
 
-        $migrationRepository->deleteAll();
+        $migrations->deleteAll();
 
         $migrator->migrateAll();
 

src/Console/MakeCommand.php

@@ -27,7 +27,7 @@ class MakeCommand extends Command
     /**
      * Execute the console command.
      */
-    public function handle(Filesystem $filesystem, MigrationStorage $migrationStorage): int
+    public function handle(Filesystem $filesystem, MigrationStorage $migrations): int
     {
         $name = Str::snake(trim($this->argument('name')));
 
@@ -37,7 +37,7 @@ public function handle(Filesystem $filesystem, MigrationStorage $migrationStorag
         $stub = $filesystem->get(__DIR__.'/stubs/migration.blank.stub');
         $content = str_replace('DummyClass', $className, $stub);
 
-        $migrationStorage->create($fileName, $content);
+        $migrations->create($fileName, $content);
 
         $this->output->writeln('<info>Created migration:</info> '.$fileName);
 

src/Factories/MigrationFactory.php

@@ -16,9 +16,9 @@ class MigrationFactory
      */
     public function makeFromFile(MigrationFile $file): MigrationInterface
     {
-        require_once $file->getPath();
+        require_once $file->path();
 
-        $className = Str::studly(implode('_', array_slice(explode('_', $file->getName()), 4)));
+        $className = Str::studly(implode('_', array_slice(explode('_', $file->name()), 4)));
 
         return resolve($className);
     }

src/Filesystem/MigrationFile.php

@@ -17,15 +17,15 @@ public function __construct(
     /**
      * Get the migration file name without its extension.
      */
-    public function getName(): string
+    public function name(): string
     {
         return basename($this->filePath, '.php');
     }
 
     /**
      * Get the full migration file path.
      */
-    public function getPath(): string
+    public function path(): string
     {
         return $this->filePath;
     }

src/Migrator.php

@@ -63,7 +63,7 @@ public function migrateAll(): self
         $migratedFileNames = $this->migrationRepository->getAll();
 
         $nonMigratedFiles = $files->filter(function (MigrationFile $file) use ($migratedFileNames) {
-            return ! $migratedFileNames->contains($file->getName());
+            return ! $migratedFileNames->contains($file->name());
         });
 
         $this->migrate($nonMigratedFiles);
@@ -80,10 +80,10 @@ public function rollbackOne(string $fileName): self
 
         if (is_null($file)) {
             $this->output->writeln('<error>Migration is not found:</error> '.$fileName);
-        } elseif (! $this->migrationRepository->exists($file->getName())) {
-            $this->output->writeln('<error>Migration is not yet migrated:</error> '.$file->getName());
+        } elseif (! $this->migrationRepository->exists($file->name())) {
+            $this->output->writeln('<error>Migration is not yet migrated:</error> '.$file->name());
         } else {
-            $this->rollback(collect([$file->getName()]));
+            $this->rollback(collect([$file->name()]));
         }
 
         return $this;
@@ -127,9 +127,9 @@ public function showStatus(): self
 
         $rows = $files->map(function (MigrationFile $file) use ($migratedFileNames, $migratedLastBatchFileNames) {
             return [
-                $migratedFileNames->contains($file->getName()) ? '<info>Yes</info>' : '<comment>No</comment>',
-                $migratedLastBatchFileNames->contains($file->getName()) ? '<info>Yes</info>' : '<comment>No</comment>',
-                $file->getName(),
+                $migratedFileNames->contains($file->name()) ? '<info>Yes</info>' : '<comment>No</comment>',
+                $migratedLastBatchFileNames->contains($file->name()) ? '<info>Yes</info>' : '<comment>No</comment>',
+                $file->name(),
             ];
         })->toArray();
 
@@ -154,14 +154,14 @@ protected function migrate(Collection $files): self
         $nextBatchNumber = $this->migrationRepository->getLastBatchNumber() + 1;
 
         $files->each(function (MigrationFile $file) use ($nextBatchNumber) {
-            $this->output->writeln('<comment>Migrating:</comment> '.$file->getName());
+            $this->output->writeln('<comment>Migrating:</comment> '.$file->name());
 
             $migration = $this->migrationFactory->makeFromFile($file);
             $migration->up();
 
-            $this->migrationRepository->insert($file->getName(), $nextBatchNumber);
+            $this->migrationRepository->insert($file->name(), $nextBatchNumber);
 
-            $this->output->writeln('<info>Migrated:</info> '.$file->getName());
+            $this->output->writeln('<info>Migrated:</info> '.$file->name());
         });
 
         return $this;
@@ -186,22 +186,22 @@ protected function rollback(Collection $fileNames): self
             $this->output->writeln(
                 '<error>Migration is not found:</error> '.
                 implode(',', $fileNames->diff($files->map(function (MigrationFile $file) {
-                    return $file->getName();
+                    return $file->name();
                 }))->toArray())
             );
 
             return $this;
         }
 
         $files->each(function (MigrationFile $file) {
-            $this->output->writeln('<comment>Rolling back:</comment> '.$file->getName());
+            $this->output->writeln('<comment>Rolling back:</comment> '.$file->name());
 
             $migration = $this->migrationFactory->makeFromFile($file);
             $migration->down();
 
-            $this->migrationRepository->delete($file->getName());
+            $this->migrationRepository->delete($file->name());
 
-            $this->output->writeln('<info>Rolled back:</info> '.$file->getName());
+            $this->output->writeln('<info>Rolled back:</info> '.$file->name());
         });
 
         return $this;

tests/Integration/Filesystem/MigrationStorageTest.php

@@ -32,11 +32,11 @@ public function test_file_can_be_created(): void
 
         $file = $this->migrationStorage->create($fileName, 'content');
 
-        $this->assertSame($fileName, $file->getName());
-        $this->assertFileExists($file->getPath());
-        $this->assertStringEqualsFile($file->getPath(), 'content');
+        $this->assertSame($fileName, $file->name());
+        $this->assertFileExists($file->path());
+        $this->assertStringEqualsFile($file->path(), 'content');
 
-        @unlink($file->getPath());
+        @unlink($file->path());
     }
 
     public function test_directory_is_created_along_with_file(): void
@@ -53,7 +53,7 @@ public function test_directory_is_created_along_with_file(): void
 
         $this->assertDirectoryExists($secondLevelDirectory);
 
-        @unlink($file->getPath());
+        @unlink($file->path());
         @rmdir($secondLevelDirectory);
         @rmdir($firstLevelDirectory);
     }
@@ -74,7 +74,7 @@ public function test_file_can_be_found_if_exists(string $fileName): void
         /** @var MigrationFile $file */
         $file = $this->migrationStorage->findByName($fileName);
 
-        $this->assertSame(basename(trim($fileName), '.php'), $file->getName());
+        $this->assertSame(basename(trim($fileName), '.php'), $file->name());
     }
 
     public static function nonExistingFileNameProvider(): array
@@ -105,7 +105,7 @@ public function test_all_files_within_migrations_directory_can_be_retrieved(): v
                 '2019_08_10_142230_update_test_index_mapping',
             ],
             $files->map(function (MigrationFile $file) {
-                return $file->getName();
+                return $file->name();
             })->toArray()
         );
     }

tests/Unit/Filesystem/MigrationFileTest.php

@@ -13,15 +13,15 @@ public function test_path_getter(): void
     {
         $this->assertSame(
             static::FULL_PATH,
-            (new MigrationFile(static::FULL_PATH))->getPath()
+            (new MigrationFile(static::FULL_PATH))->path()
         );
     }
 
     public function test_name_getter(): void
     {
         $this->assertSame(
             basename(static::FULL_PATH, '.php'),
-            (new MigrationFile(static::FULL_PATH))->getName()
+            (new MigrationFile(static::FULL_PATH))->name()
         );
     }
 }