Refactor name of the package

mreduar · Jul 21, 2024 · 52cd81c · 52cd81c
1 parent 8e72b08
commit 52cd81c
Show file tree

Hide file tree

Showing 22 changed files with 53 additions and 66 deletions.
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,11 +1,11 @@
 blank_issues_enabled: false
 contact_links:
   - name: Ask a question
-    url: https://github.com/Eduar Bastidas/laravel-s3-multipart/discussions/new?category=q-a
+    url: https://github.com/Eduar Bastidas/s3m/discussions/new?category=q-a
     about: Ask the community for help
   - name: Request a feature
-    url: https://github.com/Eduar Bastidas/laravel-s3-multipart/discussions/new?category=ideas
+    url: https://github.com/Eduar Bastidas/s3m/discussions/new?category=ideas
     about: Share ideas for new features
   - name: Report a security issue
-    url: https://github.com/Eduar Bastidas/laravel-s3-multipart/security/policy
+    url: https://github.com/Eduar Bastidas/s3m/security/policy
     about: Learn how to notify us for sensitive bugs
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,3 @@
 # Changelog
 
-All notable changes to `laravel-s3-multipart` will be documented in this file.
+All notable changes to `s3m` will be documented in this file.
diff --git a/README.md b/README.md
@@ -1,11 +1,11 @@
-# Multipart Uploads using Laravel and AWS S3
+![Multipart Uploads using Laravel and AWS S3](https://raw.githubusercontent.com/mreduar/s3m/main/s3m-banner.png)
 
-[![Latest Version on Packagist](https://img.shields.io/packagist/v/mreduar/laravel-s3-multipart.svg?style=flat-square)](https://packagist.org/packages/mreduar/laravel-s3-multipart)
-[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/mreduar/laravel-s3-multipart/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/mreduar/laravel-s3-multipart/actions?query=workflow%3Arun-tests+branch%3Amain)
-[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/mreduar/laravel-s3-multipart/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/mreduar/laravel-s3-multipart/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
-[![Total Downloads](https://img.shields.io/packagist/dt/mreduar/laravel-s3-multipart.svg?style=flat-square)](https://packagist.org/packages/mreduar/laravel-s3-multipart)
+# S3M - Multipart Uploads using Laravel and AWS S3
 
-Upload large files directly to AWS S3 using Laravel.
+[![Latest Version on Packagist](https://img.shields.io/packagist/v/mreduar/s3m.svg?style=flat-square)](https://packagist.org/packages/mreduar/s3m)
+[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/mreduar/s3m/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/mreduar/s3m/actions?query=workflow%3Arun-tests+branch%3Amain)
+[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/mreduar/s3m/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/mreduar/s3m/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
+[![Total Downloads](https://img.shields.io/packagist/dt/mreduar/s3m.svg?style=flat-square)](https://packagist.org/packages/mreduar/s3m)
 
 Sometimes when running an application in a serverless environment, you may not store files permanently on the local filesystem, since you can never be sure that the same serverless "container" will be used on a subsequent request. All files should be stored in a cloud storage system, such as AWS S3, or in a shared file system through AWS EFS.
 
@@ -23,7 +23,7 @@ When uploading large files to S3, you may run into the 5GB limit for a single PU
 You can install the package via composer:
 
 ```bash
-composer require mreduar/laravel-s3-multipart
+composer require mreduar/s3m
 ```
 
 ## Usage

diff --git a/composer.json b/composer.json
@@ -1,12 +1,12 @@
 {
-    "name": "mreduar/laravel-s3-multipart",
+    "name": "mreduar/s3m",
     "description": "Multipart Uploads using Laravel and AWS S3",
     "keywords": [
         "Eduar Bastidas",
         "laravel",
-        "laravel-s3-multipart"
+        "s3m"
     ],
-    "homepage": "https://github.com/mreduar/laravel-s3-multipart",
+    "homepage": "https://github.com/mreduar/s3m",
     "license": "MIT",
     "authors": [
         {
@@ -36,19 +36,19 @@
     },
     "autoload": {
         "psr-4": {
-            "MrEduar\\LaravelS3Multipart\\": "src/",
-            "MrEduar\\LaravelS3Multipart\\Database\\Factories\\": "database/factories/"
+            "MrEduar\\S3M\\": "src/",
+            "MrEduar\\S3M\\Database\\Factories\\": "database/factories/"
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "MrEduar\\LaravelS3Multipart\\Tests\\": "tests/",
+            "MrEduar\\S3M\\Tests\\": "tests/",
             "Workbench\\App\\": "workbench/app/"
         }
     },
     "scripts": {
         "post-autoload-dump": "@composer run prepare",
-        "clear": "@php vendor/bin/testbench package:purge-laravel-s3-multipart --ansi",
+        "clear": "@php vendor/bin/testbench package:purge-s3m --ansi",
         "prepare": "@php vendor/bin/testbench package:discover --ansi",
         "build": [
             "@composer run prepare",
@@ -74,10 +74,10 @@
     "extra": {
         "laravel": {
             "providers": [
-                "MrEduar\\LaravelS3Multipart\\LaravelS3MultipartServiceProvider"
+                "MrEduar\\S3M\\S3MServiceProvider"
             ],
             "aliases": {
-                "LaravelS3Multipart": "MrEduar\\LaravelS3Multipart\\Facades\\LaravelS3Multipart"
+                "S3M": "MrEduar\\S3M\\Facades\\S3M"
             }
         }
     },

diff --git a/config/s3-multipart.php b/config/s3-multipart.php
diff --git a/package.json b/package.json
@@ -8,12 +8,12 @@
         "Amazon S3",
         "S3"
     ],
-    "homepage": "https://github.com/mreduar/laravel-s3-multipart",
-    "bugs": "https://github.com/mreduar/laravel-s3-multipart/issues",
+    "homepage": "https://github.com/mreduar/s3m",
+    "bugs": "https://github.com/mreduar/s3m/issues",
     "license": "MIT",
     "repository": {
         "type": "git",
-        "url": "git+https://github.com/mreduar/laravel-s3-multipart.git"
+        "url": "git+https://github.com/mreduar/s3m.git"
     },
     "authors": [
         {

diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -5,7 +5,6 @@ parameters:
     level: 5
     paths:
         - src
-        - config
     tmpDir: build/phpstan
     checkOctaneCompatibility: true
     checkModelProperties: true
diff --git a/routes/web.php b/routes/web.php
@@ -1,7 +1,7 @@
 <?php
 
 use Illuminate\Support\Facades\Route;
-use MrEduar\LaravelS3Multipart\Http\Controllers\S3MultipartController;
+use MrEduar\S3M\Http\Controllers\S3MultipartController;
 
 Route::get('s3m/create-multipart-upload', [S3MultipartController::class, 'createMultipartUpload'])->name('s3m.create-multipart');
 

diff --git a/s3m-banner.png b/s3m-banner.png
diff --git a/src/BladeFunctionGenerator.php b/src/BladeFunctionGenerator.php
@@ -1,8 +1,8 @@
 <?php
 
-namespace MrEduar\LaravelS3Multipart;
+namespace MrEduar\S3M;
 
-use MrEduar\LaravelS3Multipart\Output\Script;
+use MrEduar\S3M\Output\Script;
 
 class BladeFunctionGenerator
 {

diff --git a/src/Contracts/StorageMultipartUploadControllerContract.php b/src/Contracts/StorageMultipartUploadControllerContract.php
@@ -1,11 +1,11 @@
 <?php
 
-namespace MrEduar\LaravelS3Multipart\Contracts;
+namespace MrEduar\S3M\Contracts;
 
 use Illuminate\Http\JsonResponse;
-use MrEduar\LaravelS3Multipart\Http\Requests\CompleteMultipartUploadRequest;
-use MrEduar\LaravelS3Multipart\Http\Requests\CreateMultipartUploadRequest;
-use MrEduar\LaravelS3Multipart\Http\Requests\SignPartRequest;
+use MrEduar\S3M\Http\Requests\CompleteMultipartUploadRequest;
+use MrEduar\S3M\Http\Requests\CreateMultipartUploadRequest;
+use MrEduar\S3M\Http\Requests\SignPartRequest;
 
 interface StorageMultipartUploadControllerContract
 {

diff --git a/src/Facades/LaravelS3Multipart.php b/src/Facades/LaravelS3Multipart.php
@@ -1,16 +1,16 @@
 <?php
 
-namespace MrEduar\LaravelS3Multipart\Facades;
+namespace MrEduar\S3M\Facades;
 
 use Illuminate\Support\Facades\Facade;
 
 /**
- * @see \MrEduar\LaravelS3Multipart\LaravelS3Multipart
+ * @see \MrEduar\S3M\S3M
  */
 class LaravelS3Multipart extends Facade
 {
     protected static function getFacadeAccessor(): string
     {
-        return \MrEduar\LaravelS3Multipart\LaravelS3Multipart::class;
+        return \MrEduar\S3M\S3M::class;
     }
 }
diff --git a/src/Http/Controllers/S3MultipartController.php b/src/Http/Controllers/S3MultipartController.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace MrEduar\LaravelS3Multipart\Http\Controllers;
+namespace MrEduar\S3M\Http\Controllers;
 
 use Aws\CommandInterface;
 use Aws\S3\S3Client;
@@ -10,10 +10,10 @@
 use Illuminate\Routing\Controller;
 use Illuminate\Support\Str;
 use InvalidArgumentException;
-use MrEduar\LaravelS3Multipart\Contracts\StorageMultipartUploadControllerContract;
-use MrEduar\LaravelS3Multipart\Http\Requests\CompleteMultipartUploadRequest;
-use MrEduar\LaravelS3Multipart\Http\Requests\CreateMultipartUploadRequest;
-use MrEduar\LaravelS3Multipart\Http\Requests\SignPartRequest;
+use MrEduar\S3M\Contracts\StorageMultipartUploadControllerContract;
+use MrEduar\S3M\Http\Requests\CompleteMultipartUploadRequest;
+use MrEduar\S3M\Http\Requests\CreateMultipartUploadRequest;
+use MrEduar\S3M\Http\Requests\SignPartRequest;
 
 class S3MultipartController extends Controller implements StorageMultipartUploadControllerContract
 {

diff --git a/src/Http/Requests/CompleteMultipartUploadRequest.php b/src/Http/Requests/CompleteMultipartUploadRequest.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace MrEduar\LaravelS3Multipart\Http\Requests;
+namespace MrEduar\S3M\Http\Requests;
 
 use Illuminate\Foundation\Http\FormRequest;
 use Illuminate\Support\Facades\Gate;

diff --git a/src/Http/Requests/CreateMultipartUploadRequest.php b/src/Http/Requests/CreateMultipartUploadRequest.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace MrEduar\LaravelS3Multipart\Http\Requests;
+namespace MrEduar\S3M\Http\Requests;
 
 use Illuminate\Foundation\Http\FormRequest;
 use Illuminate\Support\Facades\Gate;

diff --git a/src/Http/Requests/SignPartRequest.php b/src/Http/Requests/SignPartRequest.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace MrEduar\LaravelS3Multipart\Http\Requests;
+namespace MrEduar\S3M\Http\Requests;
 
 use Illuminate\Foundation\Http\FormRequest;
 use Illuminate\Support\Facades\Gate;

diff --git a/src/LaravelS3Multipart.php b/src/LaravelS3Multipart.php
diff --git a/src/Output/Script.php b/src/Output/Script.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace MrEduar\LaravelS3Multipart\Output;
+namespace MrEduar\S3M\Output;
 
 use Stringable;
 

diff --git a/src/LaravelS3MultipartServiceProvider.php → src/S3MServiceProvider.php b/src/LaravelS3MultipartServiceProvider.php → src/S3MServiceProvider.php
@@ -1,13 +1,13 @@
 <?php
 
-namespace MrEduar\LaravelS3Multipart;
+namespace MrEduar\S3M;
 
 use Illuminate\View\Compilers\BladeCompiler;
-use MrEduar\LaravelS3Multipart\Http\Controllers\S3MultipartController;
+use MrEduar\S3M\Http\Controllers\S3MultipartController;
 use Spatie\LaravelPackageTools\Package;
 use Spatie\LaravelPackageTools\PackageServiceProvider;
 
-class LaravelS3MultipartServiceProvider extends PackageServiceProvider
+class S3MServiceProvider extends PackageServiceProvider
 {
     public function configurePackage(Package $package): void
     {
@@ -23,9 +23,8 @@ public function configurePackage(Package $package): void
         }
 
         $package
-            ->name('laravel-s3-multipart')
-            ->hasRoute('web')
-            ->hasConfigFile();
+            ->name('s3m')
+            ->hasRoute('web');
     }
 
     protected function registerDirective(BladeCompiler $blade)

diff --git a/tests/Common/Unit/BladeFunctionGeneratorTest.php b/tests/Common/Unit/BladeFunctionGeneratorTest.php
@@ -1,6 +1,6 @@
 <?php
 
-use MrEduar\LaravelS3Multipart\BladeFunctionGenerator;
+use MrEduar\S3M\BladeFunctionGenerator;
 
 test('render script tag', function () {
     $routeFunction = file_get_contents(__DIR__.'/../../../dist/function.umd.js');
@@ -15,5 +15,5 @@
 test('compile blade directive', function (string $blade, string $output) {
     expect(app('blade.compiler')->compileString($blade))->toBe($output);
 })->with([
-    ['@s3m', "<?php echo app('MrEduar\LaravelS3Multipart\BladeFunctionGenerator')->generate(); ?>"],
+    ['@s3m', "<?php echo app('MrEduar\S3M\BladeFunctionGenerator')->generate(); ?>"],
 ]);
diff --git a/tests/Pest.php b/tests/Pest.php
@@ -1,5 +1,5 @@
 <?php
 
-use MrEduar\LaravelS3Multipart\Tests\TestCase;
+use MrEduar\S3M\Tests\TestCase;
 
 uses(TestCase::class)->in(__DIR__);
diff --git a/tests/TestCase.php b/tests/TestCase.php
@@ -1,9 +1,9 @@
 <?php
 
-namespace MrEduar\LaravelS3Multipart\Tests;
+namespace MrEduar\S3M\Tests;
 
 use Mockery;
-use MrEduar\LaravelS3Multipart\LaravelS3MultipartServiceProvider;
+use MrEduar\S3M\S3MServiceProvider;
 use Orchestra\Testbench\TestCase as Orchestra;
 
 class TestCase extends Orchestra
@@ -23,7 +23,7 @@ protected function tearDown(): void
     protected function getPackageProviders($app)
     {
         return [
-            LaravelS3MultipartServiceProvider::class,
+            S3MServiceProvider::class,
         ];
     }