.github/workflows/master.yml

@@ -7,23 +7,16 @@ on:
 
 jobs:
   tests:
+    name: Run Tests
     runs-on: ubuntu-latest
-
-    strategy:
-      fail-fast: true
-      matrix:
-        php: ['8.0']
-
-    name: PHP ${{ matrix.php }}
-
     steps:
       - name: Checkout Latest Codebase
         uses: actions/checkout@v3
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: ${{ matrix.php }}
+          php-version: 8.1
           ini-values: error_reporting=E_ALL
           tools: composer:v2
           coverage: none
@@ -32,4 +25,4 @@ jobs:
         run: composer install --no-interaction --prefer-dist
 
       - name: Execute tests
-        run: vendor/bin/phpunit --verbose
+        run: vendor/bin/phpunit

README.md

@@ -1,2 +1,106 @@
 # Laravel Helpers
 
+[![Lint PR](https://github.com/achyutkneupane/laravel-helpers/actions/workflows/prlint.yml/badge.svg)](https://github.com/achyutkneupane/laravel-helpers/actions/workflows/prlint.yml)
+[![Bump version](https://github.com/achyutkneupane/laravel-helpers/actions/workflows/tagrelease.yml/badge.svg)](https://github.com/achyutkneupane/laravel-helpers/actions/workflows/tagrelease.yml)
+[![Latest Stable Version](http://poser.pugx.org/achyutn/laravel-helpers/v)](https://packagist.org/packages/achyutn/laravel-helpers)
+[![Total Downloads](http://poser.pugx.org/achyutn/laravel-helpers/downloads)](https://packagist.org/packages/achyutn/laravel-helpers)
+[![Dependents](http://poser.pugx.org/achyutn/laravel-helpers/dependents)](https://packagist.org/packages/achyutn/laravel-helpers)
+
+## Installation
+
+You can install the package via composer:
+
+```bash
+composer require achyutn/laravel-helpers
+```
+
+## Usage
+
+### Traits
+
+You can use following traits for your models:
+
+#### `HasTheSlug`
+
+This trait is used to generate slug for your model. It uses [cviebrock/eloquent-sluggable](https://github.com/cviebrock/eloquent-sluggable) package.
+
+`Note: ` You must have `slug` column in your table and the source column for the slug should be `title`. 
+
+```php
+<?php
+
+namespace App\Models;
+
+use AchyutN\Traits\HasTheSlug;
+
+class Post extends Model
+{
+    use HasTheSlug;
+}
+```
+
+#### `HasTheMedia`
+
+This trait is used to add media conversions over the `HasMedia` trait from [spatie/laravel-medialibrary](https://github.com/spatie/laravel-medialibrary) package.
+
+```php
+
+namespace App\Models;
+
+use AchyutN\Traits\HasTheMedia;
+
+class Post extends Model
+{
+    use HasTheMedia;
+}
+```
+
+You can use: 
+- `cover()` to get original image.
+- `small_cover()` to get small image (in format: `WebP`).
+- `medium_cover()` to get medium image (in format: `WebP`).
+- `large_cover()` to get large image (in format: `WebP`).
+
+#### `HasTheDashboardTraits`
+
+This trait is used to add `HasTheSlug` and `HasTheMedia` traits to your model along with the `HasLog` trait from [Dipesh79/LaravelUserLogs](https://github.com/Dipesh79/LaravelUserLogs) package.
+
+```php
+<?php
+
+namespace App\Models;
+
+use AchyutN\Traits\HasTheDashboardTraits;
+
+class Post extends Model
+{
+    use HasTheDashboardTraits;
+}
+```
+
+### Nepali Helpers
+
+You can simply use following helper functions:
+
+#### `english_nepali_number`
+
+Converts english number to nepali number.
+
+```php
+<?php
+
+echo(english_nepali_number('१ २३४५६७८०९', 'en')); // 1 234567890
+
+echo(english_nepali_number('1 234567890', 'ne')); // १ २३४५६७८०९
+```
+
+#### `english_nepali`
+
+To select value based on the locale.
+
+```php
+<?php
+
+echo(english_nepali('नेपाली', 'Nepali', 'en')); // Nepali
+echo(english_nepali('नेपाली', 'Nepali', 'ne')); // नेपाली
+```

composer.json

@@ -11,30 +11,42 @@
             "src/helpers.php"
         ],
         "psr-4": {
-            "AchyutN\\Traits\\": "src/Traits/"
+            "AchyutN\\LaravelHelpers\\": "src/"
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "Tests\\": "tests/"
+            "AchyutN\\LaravelHelpers\\Tests\\": "tests/"
         }
     },
     "authors": [
         {
             "name": "Achyut Neupane",
             "email": "achyutkneupane@gmail.com",
             "homepage": "https://achyut.com.np",
+            "role": "Maintainer"
+        }, {
+            "name": "Dipesh79",
+            "email": "dipeshkhanal79@gmail.com",
+            "homepage": "https://khanaldipesh.com.np",
             "role": "Developer"
         }
     ],
     "require": {
-        "php": "^8.0",
-        "dipesh79/laravel-user-logs": "^1.4.2",
-        "rap2hpoutre/laravel-log-viewer": "^2.3.0",
-        "spatie/laravel-medialibrary": "^11.0.3",
-        "cviebrock/eloquent-sluggable": "^10.0"
+        "php": ">7.2",
+        "dipesh79/laravel-user-logs": "^1.6.1",
+        "spatie/laravel-medialibrary": ">=8.0",
+        "cviebrock/eloquent-sluggable": ">=11.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "^7.0|^8.0|^9.0|^10.0"
+        "phpunit/phpunit": "^7.0|^8.0|^9.0|^10.0",
+        "orchestra/testbench": "^8.19"
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "AchyutN\\LaravelHelpers\\LaravelHelperProvider"
+            ]
+        }
     }
 }

src/Controller/ApiBaseController.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace AchyutN\LaravelHelpers\Controller;
+
+use Illuminate\Routing\Controller as BaseController;
+use Illuminate\Support\Facades\Log;
+use Illuminate\Foundation\Auth\Access\AuthorizesRequests;
+use Illuminate\Foundation\Validation\ValidatesRequests;
+
+class ApiBaseController extends BaseController
+{
+    use AuthorizesRequests, ValidatesRequests;
+    public function api_success($data,$message)
+    {
+        return response()->json([
+            'status' => 200,
+            'data' => $data,
+            'message' => $message
+        ], 200);
+    }
+
+    public function api_error($data)
+    {
+        Log::error($data);
+        return response()->json([
+            'status' => $data->getCode(),
+            'data' => [],
+            'message' => $data->getMessage()
+        ], $data->getCode());
+    }
+
+    public function custom_error($status,$message)
+    {
+        return response()->json(
+            [
+                'status' => $status,
+                'data' => [],
+                'message' => $message
+            ], $status
+        );
+    }
+}

src/LaravelHelperProvider.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace AchyutN\LaravelHelpers;
+
+use AchyutN\LaravelHelpers\Pagination\CustomPaginator;
+use Illuminate\Pagination\LengthAwarePaginator;
+use Illuminate\Support\Facades\Config;
+use Illuminate\Support\ServiceProvider;
+
+class LaravelHelperProvider extends ServiceProvider
+{
+    /**
+     * Register services.
+     */
+    public function register(): void
+    {
+        $this->app->alias(CustomPaginator::class, LengthAwarePaginator::class);
+    }
+
+    /**
+     * Bootstrap services.
+     */
+    public function boot(): void
+    {
+        //
+    }
+}

src/Pagination/CustomPaginator.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace AchyutN\LaravelHelpers\Pagination;
+
+use Illuminate\Pagination\LengthAwarePaginator;
+
+class CustomPaginator extends LengthAwarePaginator
+{
+    /**
+     * Get the instance as an array.
+     *
+     * @return array
+     */
+    public function toArray(): array
+    {
+        return [
+            'data' => $this->items->toArray(),
+            'total' => $this->total(),
+            'perPage' => $this->perPage(),
+            'page' => $this->currentPage(),
+
+        ];
+    }
+}

src/Rules/LatitudeRule.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace AchyutN\LaravelHelpers\Rules;
+
+use Closure;
+use Illuminate\Contracts\Validation\ValidationRule;
+
+class LatitudeRule implements ValidationRule
+{
+    /**
+     * Run the validation rule.
+     *
+     * @param  \Closure(string): \Illuminate\Translation\PotentiallyTranslatedString  $fail
+     */
+    public function validate(string $attribute, mixed $value, Closure $fail): void
+    {
+        if (!is_numeric($value)) {
+            $fail("The $attribute must be a number.");
+        }
+
+        if ($value < -90 || $value > 90) {
+            $fail("The $attribute must be between -90 and 90.");
+        }
+    }
+}

src/Rules/LongitudeRule.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace AchyutN\LaravelHelpers\Rules;
+
+use Closure;
+use Illuminate\Contracts\Validation\ValidationRule;
+
+class LongitudeRule implements ValidationRule
+{
+    /**
+     * Run the validation rule.
+     *
+     * @param  \Closure(string): \Illuminate\Translation\PotentiallyTranslatedString  $fail
+     */
+    public function validate(string $attribute, mixed $value, Closure $fail): void
+    {
+        if (!is_numeric($value)) {
+            $fail("The $attribute must be a number.");
+        }
+
+        if ($value < -180 || $value > 180) {
+            $fail("The $attribute must be between -180 and 180.");
+        }
+    }
+}

src/Rules/MatchOldPassword.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace AchyutN\LaravelHelpers\Rules;
+
+use Closure;
+use Illuminate\Contracts\Validation\ValidationRule;
+use Illuminate\Support\Facades\Hash;
+
+class MatchOldPassword implements ValidationRule
+{
+    /**
+     * Run the validation rule.
+     *
+     * @param  \Closure(string): \Illuminate\Translation\PotentiallyTranslatedString  $fail
+     */
+    public function validate(string $attribute, mixed $value, Closure $fail): void
+    {
+        if (!Hash::check($value, auth()->user()->password)) {
+            $fail('The old password does not match.');
+        }
+    }
+}