├── .styleci.yml
├── UPGRADING.md
├── src
    ├── Contracts
    │   ├── SkuGenerator.php
    │   └── SkuOptions.php
    ├── Exceptions
    │   └── SkuException.php
    ├── Concerns
    │   ├── SkuMacro.php
    │   ├── SkuObserver.php
    │   ├── SkuGenerator.php
    │   └── SkuOptions.php
    ├── HasSku.php
    └── SkuServiceProvider.php
├── CHANGELOG.md
├── .github
    ├── dependabot.yml
    └── workflows
    │   └── laravel.yml
├── phpunit.xml
├── database
    └── migrations
    │   └── CreateDummyModelsTable.php
├── LICENSE.md
├── .php-cs-fixer.dist.php
├── config
    └── laravel-sku.php
├── composer.json
├── CONTRIBUTING.md
└── README.md


/.styleci.yml:
--------------------------------------------------------------------------------
1 | preset: laravel
2 | 
3 | disabled:
4 |   - single_class_element_per_statement
5 | 


--------------------------------------------------------------------------------
/UPGRADING.md:
--------------------------------------------------------------------------------
1 | # Upgrading
2 | 
3 | # 0.4.0
4 | Yo ucan now implement your own SkuGenerators, as suggested by #12
5 | 


--------------------------------------------------------------------------------
/src/Contracts/SkuGenerator.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace BinaryCats\Sku\Contracts;
 4 | 
 5 | interface SkuGenerator
 6 | {
 7 |     /**
 8 |      * Render the SKU.
 9 |      *
10 |      * @return string
11 |      */
12 |     public function render(): string;
13 | }
14 | 


--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
 1 | # Changelog
 2 | 
 3 | All notable changes to `laravel-sku` will be documented in this file
 4 | 
 5 | ## 0.2.0 - 2020-03-04
 6 | 
 7 | - add support for Laravel 7
 8 | 
 9 | ## 0.1.3 - 2020-02-02
10 | 
11 | - Add support for Laravel 5.6
12 | 
13 | ## 0.1.0 - 2019-12-28
14 | 
15 | - Initial release
16 | 


--------------------------------------------------------------------------------
/.github/dependabot.yml:
--------------------------------------------------------------------------------
 1 | # To get started with Dependabot version updates, you'll need to specify which
 2 | # package ecosystems to update and where the package manifests are located.
 3 | # Please see the documentation for all configuration options:
 4 | # https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
 5 | 
 6 | version: 2
 7 | updates:
 8 |   - package-ecosystem: "composer"
 9 |     directory: "/"
10 |     schedule:
11 |       interval: "weekly"
12 |     labels:
13 |       - "dependencies"
14 | 


--------------------------------------------------------------------------------
/.github/workflows/laravel.yml:
--------------------------------------------------------------------------------
 1 | name: Laravel
 2 | 
 3 | on:
 4 |   push:
 5 |     branches: [ master ]
 6 |   pull_request:
 7 |     branches: [ master ]
 8 | 
 9 | jobs:
10 |   laravel-tests:
11 | 
12 |     runs-on: ubuntu-latest
13 | 
14 |     steps:
15 |     - uses: actions/checkout@v2
16 |     - name: Copy .env
17 |       run: php -r "file_exists('.env') || copy('.env.example', '.env');"
18 |     - name: Install Dependencies
19 |       run: composer install -q --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist
20 |     - name: Execute tests (Unit and Feature tests) via PHPUnit
21 |       env:
22 |         DB_CONNECTION: sqlite
23 |         DB_DATABASE: database/database.sqlite
24 |       run: vendor/bin/phpunit
25 | 


--------------------------------------------------------------------------------
/src/Exceptions/SkuException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace BinaryCats\Sku\Exceptions;
 4 | 
 5 | use Exception;
 6 | 
 7 | class SkuException extends \Exception
 8 | {
 9 |     /**
10 |      * Invalid Argument.
11 |      *
12 |      * @param  string  $message
13 |      * @return [type]
14 |      */
15 |     public static function invalidArgument(string $message): self
16 |     {
17 |         return new static($message);
18 |     }
19 | 
20 |     /**
21 |      * Make the Exception renderable.
22 |      *
23 |      * @param  Illuminate\Http\Request  $request
24 |      * @return Illuminate\Http\Response
25 |      */
26 |     public function render($request)
27 |     {
28 |         return response(['error' => $this->getMessage()], $this->getCode());
29 |     }
30 | }
31 | 


--------------------------------------------------------------------------------
/phpunit.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 3 |          bootstrap="vendor/autoload.php"
 4 |          backupGlobals="false"
 5 |          colors="true"
 6 |          processIsolation="true"
 7 |          stopOnFailure="false"
 8 |          xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd"
 9 |          cacheDirectory=".phpunit.cache"
10 |          backupStaticProperties="false">
11 |     <testsuites>
12 |         <testsuite name="Binary Cats Test Suite">
13 |             <directory>tests</directory>
14 |         </testsuite>
15 |     </testsuites>
16 |     <source>
17 |         <include>
18 |             <directory suffix=".php">src/</directory>
19 |         </include>
20 |     </source>
21 | </phpunit>
22 | 


--------------------------------------------------------------------------------
/database/migrations/CreateDummyModelsTable.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | use Illuminate\Database\Migrations\Migration;
 4 | use Illuminate\Database\Schema\Blueprint;
 5 | use Illuminate\Support\Facades\Schema;
 6 | 
 7 | class CreateDummyModelsTable extends Migration
 8 | {
 9 |     /**
10 |      * Run the migrations.
11 |      *
12 |      * @return void
13 |      */
14 |     public function up()
15 |     {
16 |         Schema::create($this->table(), function (Blueprint $table) {
17 |             $table->increments('id');
18 |             $table->string('sku')->index()->nullable();
19 |             $table->string('name');
20 |             $table->timestamps();
21 |         });
22 |     }
23 | 
24 |     /**
25 |      * Reverse the migrations.
26 |      *
27 |      * @return void
28 |      */
29 |     public function down()
30 |     {
31 |         Schema::dropIfExists($this->table());
32 |     }
33 | 
34 |     /**
35 |      * Resolve Table name from config.
36 |      *
37 |      * @return
38 |      */
39 |     protected function table()
40 |     {
41 |         return 'dummy_models';
42 |     }
43 | }
44 | 


--------------------------------------------------------------------------------
/src/Concerns/SkuMacro.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace BinaryCats\Sku\Concerns;
 4 | 
 5 | use Illuminate\Support\Str;
 6 | 
 7 | class SkuMacro
 8 | {
 9 |     /**
10 |      * Sku generator mixin.
11 |      *
12 |      * @param  string  $source
13 |      * @param  string  $separator
14 |      * @return \Closure
15 |      */
16 |     public function sku(): \Closure
17 |     {
18 |         return function ($source, $separator = null) {
19 |             $separator = $separator ?: config('laravel-sku.default.separator');
20 |             // Clean up the source
21 |             $source = Str::studly($source);
22 |             // Limit the source
23 |             $source = Str::limit($source, 3, '');
24 |             // signature
25 |             $signature = str_shuffle(str_repeat(str_pad('0123456789', 8, rand(0, 9).rand(0, 9), STR_PAD_LEFT), 2));
26 |             // Sanitize the signature
27 |             $signature = substr($signature, 0, 8);
28 |             // Implode with random
29 |             $result = implode($separator, [$source, $signature]);
30 | 
31 |             // Uppercase it
32 |             return Str::upper($result);
33 |         };
34 |     }
35 | }
36 | 


--------------------------------------------------------------------------------
/LICENSE.md:
--------------------------------------------------------------------------------
 1 | The MIT License (MIT)
 2 | 
 3 | Copyright (c) Binary Cats <info@binarycats.io>
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in
13 | all copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21 | THE SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/src/HasSku.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace BinaryCats\Sku;
 4 | 
 5 | use BinaryCats\Sku\Concerns\SkuObserver;
 6 | use BinaryCats\Sku\Concerns\SkuOptions;
 7 | 
 8 | trait HasSku
 9 | {
10 |     /**
11 |      * Boot the trait by adding observers.
12 |      *
13 |      * @return void
14 |      */
15 |     public static function bootHasSku()
16 |     {
17 |         static::observe(SkuObserver::class);
18 |     }
19 | 
20 |     /**
21 |      * Get the options for generating the Sku.
22 |      *
23 |      * @return BinaryCats\Sku\SkuOptions
24 |      */
25 |     public function skuOptions(): SkuOptions
26 |     {
27 |         return resolve(SkuOptions::class);
28 |     }
29 | 
30 |     /**
31 |      * Fetch SKU option.
32 |      *
33 |      * @param  string  $key
34 |      * @return mixed
35 |      */
36 |     public function skuOption(string $key)
37 |     {
38 |         return $this->skuOptions()->{$key};
39 |     }
40 | 
41 |     /**
42 |      * Unless the field is called something else, we can safely get the value from the attribute.
43 |      *
44 |      * @param  mixed  $value
45 |      * @return string
46 |      */
47 |     public function getSkuAttribute($value)
48 |     {
49 |         return (string) $value ?: $this->getAttribute($this->skuOption('field'));
50 |     }
51 | }
52 | 


--------------------------------------------------------------------------------
/.php-cs-fixer.dist.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 | |--------------------------------------------------------------------------
 5 | | Configure PHP CS Fixer
 6 | |--------------------------------------------------------------------------
 7 | |
 8 | | Set locations to fix files in
 9 | */
10 | $finder = PhpCsFixer\Finder::create()->in([
11 |     __DIR__.'/src',
12 |     __DIR__.'/tests',
13 | ]);
14 | 
15 | /*
16 | |--------------------------------------------------------------------------
17 | | Configure PHP CS Fixer
18 | |--------------------------------------------------------------------------
19 | |
20 | | Define rules
21 | */
22 | $rules = [
23 |     '@Symfony' => true,
24 |     'concat_space' => ['spacing' => 'one'],
25 |     'new_with_braces' => true,
26 |     'no_superfluous_phpdoc_tags' => false,
27 |     'not_operator_with_successor_space' => true,
28 |     'ordered_imports' => ['sort_algorithm' => 'alpha'],
29 |     'php_unit_method_casing' => ['case' => 'snake_case'],
30 |     'phpdoc_separation' => false,
31 |     'phpdoc_align' => ['align' => 'left'],
32 | ];
33 | 
34 | /*
35 | |--------------------------------------------------------------------------
36 | | Configure PHP CS Fixer
37 | |--------------------------------------------------------------------------
38 | |
39 | | Complete config
40 | */
41 | 
42 | $config = new PhpCsFixer\Config();
43 | 
44 | return $config
45 |     ->setFinder($finder)
46 |     ->setRiskyAllowed(true)
47 |     ->setRules($rules);
48 | 


--------------------------------------------------------------------------------
/config/laravel-sku.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | return [
 4 | 
 5 |     /*
 6 |     |--------------------------------------------------------------------------
 7 |     | SKU settings
 8 |     |--------------------------------------------------------------------------
 9 |     |
10 |     | Set up your SKU
11 |     |
12 |     */
13 |     'default' => [
14 |         /*
15 |          * SKU is based on a specific field of a model
16 |          *
17 |          */
18 |         'source' => 'name',
19 | 
20 |         /*
21 |          * Destination model field name
22 |          *
23 |          */
24 |         'field' => 'sku',
25 | 
26 |         /*
27 |          * SKU separator
28 |          *
29 |          */
30 |         'separator' => '-',
31 | 
32 |         /*
33 |          * Shall SKUs be enforced to be unique
34 |          *
35 |          */
36 |         'unique' => true,
37 | 
38 |         /*
39 |          * Shall SKUs be generated on create
40 |          *
41 |          */
42 |         'generate_on_create' => true,
43 | 
44 |         /*
45 |          * Shall SKUs be re-generated on update
46 |          *
47 |          */
48 |         'generate_on_update' => true,
49 |     ],
50 | 
51 |     /*
52 |     |--------------------------------------------------------------------------
53 |     | SKU Generator
54 |     |--------------------------------------------------------------------------
55 |     |
56 |     | Define your own generator if needed.
57 |     | It must implement \BinaryCats\Sku\Contracts\SkuGenerator
58 |     |
59 |     */
60 |     'generator' => \BinaryCats\Sku\Concerns\SkuGenerator::class,
61 | ];
62 | 


--------------------------------------------------------------------------------
/src/Concerns/SkuObserver.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace BinaryCats\Sku\Concerns;
 4 | 
 5 | use BinaryCats\Sku\Contracts\SkuGenerator;
 6 | use Illuminate\Database\Eloquent\Model;
 7 | 
 8 | class SkuObserver
 9 | {
10 |     /**
11 |      * Handle model "creating" event.
12 |      *
13 |      * @param  \Illuminate\Database\Eloquent\Model  $model
14 |      * @return void
15 |      */
16 |     public function creating(Model $model): void
17 |     {
18 |         // Name of the field to store the SKU
19 |         $field = $model->skuOption('field');
20 |         // Set the value
21 |         if ($model->skuOption('generateOnCreate')) {
22 |             $model->setAttribute($field, (string) $this->generator($model));
23 |         }
24 |     }
25 | 
26 |     /**
27 |      * Handle model "updating" event.
28 |      *
29 |      * @param  \Illuminate\Database\Eloquent\Model  $model
30 |      * @return void
31 |      */
32 |     public function updating(Model $model): void
33 |     {
34 |         // Name of the field to store the SKU
35 |         $field = $model->skuOption('field');
36 |         // If we are overwriting manually, just return
37 |         if ($model->isDirty($field)) {
38 |             return;
39 |         }
40 |         // Fetch the source of the SKUs
41 |         $source = $model->skuOption('source');
42 |         // if we are requested to generate and those fields are dirty
43 |         if ($model->skuOption('generateOnUpdate') and $model->isDirty($source)) {
44 |             $model->setAttribute($field, (string) $this->generator($model));
45 |         }
46 |     }
47 | 
48 |     /**
49 |      * Make the SKUGenerator.
50 |      *
51 |      * @return \BinaryCats\Sku\Contracts\SkuGenerator
52 |      */
53 |     protected function generator(Model $model): SkuGenerator
54 |     {
55 |         return resolve(SkuGenerator::class, ['model' => $model]);
56 |     }
57 | }
58 | 


--------------------------------------------------------------------------------
/src/Contracts/SkuOptions.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace BinaryCats\Sku\Contracts;
 4 | 
 5 | /**
 6 |  * @property string[] $source
 7 |  * @property string $field
 8 |  * @property bool $unit
 9 |  * @property string $separator
10 |  * @property bool $generateOnCreate
11 |  * @property bool $generateOnUpdate
12 |  */
13 | interface SkuOptions
14 | {
15 |     /**
16 |      * Create a new instance of the class, with standard settings.
17 |      *
18 |      * @return $this
19 |      */
20 |     public static function make(): self;
21 | 
22 |     /**
23 |      * Set the source field.
24 |      *
25 |      * @param  string[]|string  $field
26 |      * @return $this
27 |      */
28 |     public function from($field): self;
29 | 
30 |     /**
31 |      * Set the destination field.
32 |      *
33 |      * @param  string  $field
34 |      * @return $this
35 |      */
36 |     public function target(string $field): self;
37 | 
38 |     /**
39 |      * Set unique flag.
40 |      *
41 |      * @param  bool  $value
42 |      * @return $this
43 |      */
44 |     public function forceUnique(bool $value): self;
45 | 
46 |     /**
47 |      * Set the separator value.
48 |      *
49 |      * @param  string  $separator
50 |      * @return $this
51 |      */
52 |     public function allowDuplicates(): self;
53 | 
54 |     /**
55 |      * Set the separator value.
56 |      *
57 |      * @param  string  $separator
58 |      * @return $this
59 |      */
60 |     public function using(string $separator): self;
61 | 
62 |     /**
63 |      * Set the generateOnCreate value.
64 |      *
65 |      * @param  bool  $value
66 |      * @return $this
67 |      */
68 |     public function generateOnCreate(bool $value): self;
69 | 
70 |     /**
71 |      * Set the generateOnUpdate value.
72 |      *
73 |      * @param  bool  $value
74 |      * @return $this
75 |      */
76 |     public function refreshOnUpdate(bool $value): self;
77 | }
78 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "binary-cats/laravel-sku",
 3 |     "description": "Generate SKUs for Eloquent models",
 4 |     "keywords": [
 5 |         "binary-cats",
 6 |         "eloquent",
 7 |         "laravel",
 8 |         "sku"
 9 |     ],
10 |     "homepage": "https://github.com/binary-cats/laravel-sku",
11 |     "license": "MIT",
12 |     "authors": [
13 |         {
14 |             "name": "Cyrill Kalita",
15 |             "email": "cyrill.kalita@gmail.com",
16 |             "homepage": "https://github.com/binary-cats",
17 |             "role": "Developer"
18 |         }
19 |     ],
20 |     "require": {
21 |         "php": "^7.2|^8.0",
22 |         "illuminate/support": "~5.6|^6.0|^7.0|^8.0|^9.0|^10.0|^11.0|^12.0"
23 |     },
24 |     "require-dev": {
25 |         "orchestra/testbench": "^3.6|^4.0|^5.0|^6.0|^7.0|^8.0|^10.0",
26 |         "phpunit/phpunit": "^7.0|^8.2|^9.0|^10.0|^11.5.3"
27 |     },
28 |     "autoload": {
29 |         "psr-4": {
30 |             "BinaryCats\\Sku\\": "src"
31 |         }
32 |     },
33 |     "autoload-dev": {
34 |         "psr-4": {
35 |             "BinaryCats\\Sku\\Tests\\": "tests"
36 |         }
37 |     },
38 |     "suggest": {
39 |         "binary-cats/laravel-lob-webhooks": "Handle Lob.com webhooks in your Laravel application",
40 |         "binary-cats/laravel-mailgun-webhooks": "Handle Mailgun webhooks in your Laravel application"
41 |     },
42 |     "scripts": {
43 |         "test": "XDEBUG_MODE=coverage vendor/bin/phpunit --color=always",
44 |         "fix": [
45 |             "docker run --rm -v $(pwd):/data cytopia/php-cs-fixer --ansi --verbose --show-progress=dots fix"
46 |         ]
47 |     },
48 |     "config": {
49 |         "sort-packages": true
50 |     },
51 |     "extra": {
52 |         "laravel": {
53 |             "providers": [
54 |                 "BinaryCats\\Sku\\SkuServiceProvider"
55 |             ]
56 |         }
57 |     }
58 | }
59 | 


--------------------------------------------------------------------------------
/src/SkuServiceProvider.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace BinaryCats\Sku;
 4 | 
 5 | use BinaryCats\Sku\Concerns\SkuMacro;
 6 | use BinaryCats\Sku\Concerns\SkuOptions;
 7 | use BinaryCats\Sku\Contracts\SkuGenerator;
 8 | use Illuminate\Support\ServiceProvider;
 9 | use Illuminate\Support\Str;
10 | 
11 | class SkuServiceProvider extends ServiceProvider
12 | {
13 |     /**
14 |      * Boot application services.
15 |      *
16 |      * @return void
17 |      */
18 |     public function boot()
19 |     {
20 |         if ($this->app->runningInConsole()) {
21 |             $this->publishes(
22 |                 [
23 |                     __DIR__.'/../config/laravel-sku.php' => config_path('laravel-sku.php'),
24 |                 ], 'config'
25 |             );
26 |         }
27 |         // Bind the Generator
28 |         $this->bindSkuGenerator();
29 |         // Bind the Standard SKU Options
30 |         $this->bindSkuOptions();
31 |         // Extend Str with a sku() method
32 |         Str::mixin(new SkuMacro());
33 |     }
34 | 
35 |     /**
36 |      * Register application services.
37 |      *
38 |      * @return void
39 |      */
40 |     public function register()
41 |     {
42 |         $this->mergeConfigFrom(__DIR__.'/../config/laravel-sku.php', 'laravel-sku');
43 |     }
44 | 
45 |     /**
46 |      * Bind the SKU Generator.
47 |      *
48 |      * @return void
49 |      */
50 |     protected function bindSkuGenerator()
51 |     {
52 |         $this->app->bind(SkuGenerator::class, function ($app, array $paramters) {
53 |             $generator = $app['config']->get('laravel-sku.generator');
54 | 
55 |             return new $generator(head($paramters));
56 |         });
57 |     }
58 | 
59 |     /**
60 |      * Bind the SKU options.
61 |      *
62 |      * @return void
63 |      */
64 |     protected function bindSkuOptions()
65 |     {
66 |         $this->app->bind(
67 |             SkuOptions::class,
68 |             function ($app) {
69 |                 return new SkuOptions($app['config']->get('laravel-sku.default', []));
70 |             }
71 |         );
72 |     }
73 | 
74 |     /**
75 |      * Get the services provided by the provider.
76 |      *
77 |      * @return array
78 |      */
79 |     public function provides()
80 |     {
81 |         return [
82 |             SkuGenerator::class,
83 |             SkuOptions::class,
84 |         ];
85 |     }
86 | }
87 | 


--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
 1 | # Contributing
 2 | 
 3 | Contributions are **welcome** and will be fully **credited**.
 4 | 
 5 | Please read and understand the contribution guide before creating an issue or pull request.
 6 | 
 7 | ## Etiquette
 8 | 
 9 | This project is open source, and as such, the maintainers give their free time to build and maintain the source code
10 | held within. They make the code freely available in the hope that it will be of use to other developers. It would be
11 | extremely unfair for them to suffer abuse or anger for their hard work.
12 | 
13 | Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the
14 | world that developers are civilized and selfless people.
15 | 
16 | It's the duty of the maintainer to ensure that all submissions to the project are of sufficient
17 | quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used.
18 | 
19 | ## Viability
20 | 
21 | When requesting or submitting new features, first consider whether it might be useful to others. Open
22 | source projects are used by many developers, who may have entirely different needs to your own. Think about
23 | whether or not your feature is likely to be used by other users of the project.
24 | 
25 | ## Procedure
26 | 
27 | Before filing an issue:
28 | 
29 | - Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
30 | - Check to make sure your feature suggestion isn't already present within the project.
31 | - Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
32 | - Check the pull requests tab to ensure that the feature isn't already in progress.
33 | 
34 | Before submitting a pull request:
35 | 
36 | - Check the codebase to ensure that your feature doesn't already exist.
37 | - Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
38 | 
39 | ## Requirements
40 | 
41 | If the project maintainer has any additional requirements, you will find them listed here.
42 | 
43 | - **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer).
44 | 
45 | - **Add tests!** - Your patch won't be accepted if it doesn't have tests.
46 | 
47 | - **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
48 | 
49 | - **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
50 | 
51 | - **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
52 | 
53 | - **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
54 | 
55 | **Happy coding**!
56 | 


--------------------------------------------------------------------------------
/src/Concerns/SkuGenerator.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace BinaryCats\Sku\Concerns;
  4 | 
  5 | use BinaryCats\Sku\Contracts\SkuGenerator as SkuGeneratorContract;
  6 | use Illuminate\Contracts\Support\Jsonable;
  7 | use Illuminate\Contracts\Support\Renderable;
  8 | use Illuminate\Database\Eloquent\Model;
  9 | use Illuminate\Support\Str;
 10 | 
 11 | class SkuGenerator implements Jsonable, Renderable, SkuGeneratorContract
 12 | {
 13 |     /**
 14 |      * Model to generate SKUs from.
 15 |      *
 16 |      * @var \Illuminate\Database\Eloquent\Model
 17 |      */
 18 |     protected $model;
 19 | 
 20 |     /**
 21 |      * Shortcut to the SkuOptions.
 22 |      *
 23 |      * @var \BinaryCats\Sku\Concerns\SkuOptions
 24 |      */
 25 |     protected $options;
 26 | 
 27 |     /**
 28 |      * Create new SKU Generator.
 29 |      *
 30 |      * @param  \Illuminate\Database\Eloquent\Model  $model
 31 |      */
 32 |     public function __construct(Model $model)
 33 |     {
 34 |         $this->model = $model;
 35 |         $this->options = $model->skuOptions();
 36 |     }
 37 | 
 38 |     /**
 39 |      * Render the SKU.
 40 |      *
 41 |      * @return string
 42 |      */
 43 |     public function render(): string
 44 |     {
 45 |         // Fetch the part that makes the initial source
 46 |         $source = $this->getSourceString();
 47 | 
 48 |         // now, make Sku
 49 |         return $this->makeSku($source, $this->options->separator, $this->options->unique);
 50 |     }
 51 | 
 52 |     /**
 53 |      * Get the source fields for the SKU.
 54 |      *
 55 |      * @return string
 56 |      */
 57 |     protected function getSourceString(): string
 58 |     {
 59 |         // fetch the source fields
 60 |         $source = $this->options->source;
 61 |         // Fetch fields from model, skip empty
 62 |         $fields = array_filter($this->model->only($source));
 63 | 
 64 |         // Impode with a separator
 65 |         return implode($this->options->separator, $fields);
 66 |     }
 67 | 
 68 |     /**
 69 |      * Make the SKU.
 70 |      *
 71 |      * @param  string  $source
 72 |      * @param  string  $separator
 73 |      * @param  bool  $unique
 74 |      * @return string
 75 |      */
 76 |     protected function makeSku(string $source, string $separator, bool $unique = false): string
 77 |     {
 78 |         // Make
 79 |         $sku = Str::sku($source, $separator);
 80 |         // if we are forcing uniques and it already exists, re-try
 81 |         if ($unique and $this->exists($sku)) {
 82 |             return $this->makeSku($source, $unique);
 83 |         }
 84 | 
 85 |         return $sku;
 86 |     }
 87 | 
 88 |     /**
 89 |      * True if the value already exists in the DB.
 90 |      *
 91 |      * @param  string  $sku
 92 |      * @return bool
 93 |      */
 94 |     protected function exists(string $sku): bool
 95 |     {
 96 |         return $this->model
 97 |             ->whereKeyNot($this->model->getKey())
 98 |             ->where($this->options->field, $sku)
 99 |             ->withoutGlobalScopes()
100 |             ->exists();
101 |     }
102 | 
103 |     /**
104 |      * Convert the Generator to String.
105 |      *
106 |      * @return string
107 |      */
108 |     public function __toString()
109 |     {
110 |         return $this->render();
111 |     }
112 | 
113 |     /**
114 |      * Convert the object to its JSON representation.
115 |      *
116 |      * @param  int  $options
117 |      * @return string
118 |      */
119 |     public function toJson($options = 0)
120 |     {
121 |         return $this->render();
122 |     }
123 | }
124 | 


--------------------------------------------------------------------------------
/src/Concerns/SkuOptions.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace BinaryCats\Sku\Concerns;
  4 | 
  5 | use BinaryCats\Sku\Contracts\SkuOptions as SkuOptionsContract;
  6 | use BinaryCats\Sku\Exceptions\SkuException;
  7 | use Illuminate\Database\Eloquent\Model;
  8 | use Illuminate\Support\Arr;
  9 | 
 10 | class SkuOptions implements SkuOptionsContract
 11 | {
 12 |     /**
 13 |      * Set the field which is a base fo rthe SKU.
 14 |      *
 15 |      * @var array
 16 |      */
 17 |     protected $source;
 18 | 
 19 |     /**
 20 |      * Name of the model to store the SKU.
 21 |      *
 22 |      * @var string
 23 |      */
 24 |     protected $field;
 25 | 
 26 |     /**
 27 |      * True if SKU is to be unique.
 28 |      *
 29 |      * @var bool
 30 |      */
 31 |     protected $unique;
 32 | 
 33 |     /**
 34 |      * Separator value.
 35 |      *
 36 |      * @var string
 37 |      */
 38 |     protected $separator;
 39 | 
 40 |     /**
 41 |      * True if SKU to be generated on creating.
 42 |      *
 43 |      * @var bool
 44 |      */
 45 |     protected $generateOnCreate;
 46 | 
 47 |     /**
 48 |      * True if SKU needs to be re-generated on update.
 49 |      *
 50 |      * @var bool
 51 |      */
 52 |     protected $generateOnUpdate;
 53 | 
 54 |     /**
 55 |      * Create new class.
 56 |      */
 57 |     public function __construct(array $config)
 58 |     {
 59 |         $this->from($config['source'])
 60 |             ->target($config['field'])
 61 |             ->using($config['separator'])
 62 |             ->forceUnique($config['unique'])
 63 |             ->generateOnCreate($config['generate_on_create'])
 64 |             ->refreshOnUpdate($config['generate_on_update']);
 65 |     }
 66 | 
 67 |     /**
 68 |      * Create a new instance of the class, with standard settings.
 69 |      *
 70 |      * @return new instance
 71 |      */
 72 |     public static function make(): SkuOptionsContract
 73 |     {
 74 |         return resolve(self::class);
 75 |     }
 76 | 
 77 |     /**
 78 |      * Set the source field.
 79 |      *
 80 |      * @param  mixed  $field
 81 |      * @return $this
 82 |      */
 83 |     public function from($field): SkuOptionsContract
 84 |     {
 85 |         $this->source = Arr::wrap($field);
 86 | 
 87 |         return $this;
 88 |     }
 89 | 
 90 |     /**
 91 |      * Set the destination field.
 92 |      *
 93 |      * @param  mixed  $field
 94 |      * @return $this
 95 |      */
 96 |     public function target(string $field): SkuOptionsContract
 97 |     {
 98 |         $this->field = $field;
 99 | 
100 |         return $this;
101 |     }
102 | 
103 |     /**
104 |      * Set unique flag.
105 |      *
106 |      * @param  boll  $value
107 |      * @return $this
108 |      */
109 |     public function forceUnique(bool $value): SkuOptionsContract
110 |     {
111 |         $this->unique = $value;
112 | 
113 |         return $this;
114 |     }
115 | 
116 |     /**
117 |      * Set the separator value.
118 |      *
119 |      * @param  string  $separator
120 |      * @return $this
121 |      */
122 |     public function allowDuplicates(): SkuOptionsContract
123 |     {
124 |         return $this->forceUnique(false);
125 |     }
126 | 
127 |     /**
128 |      * Set the separator value.
129 |      *
130 |      * @param  string  $separator
131 |      * @return $this
132 |      */
133 |     public function using(string $separator): SkuOptionsContract
134 |     {
135 |         $this->separator = $separator;
136 | 
137 |         return $this;
138 |     }
139 | 
140 |     /**
141 |      * Set the generateOnCreate value.
142 |      *
143 |      * @param  bool  $value
144 |      * @return $this
145 |      */
146 |     public function generateOnCreate(bool $value): SkuOptionsContract
147 |     {
148 |         $this->generateOnCreate = $value;
149 | 
150 |         return $this;
151 |     }
152 | 
153 |     /**
154 |      * Set the generateOnUpdate value.
155 |      *
156 |      * @param  bool  $value
157 |      * @return $this
158 |      */
159 |     public function refreshOnUpdate(bool $value): SkuOptionsContract
160 |     {
161 |         $this->generateOnUpdate = $value;
162 | 
163 |         return $this;
164 |     }
165 | 
166 |     /**
167 |      * Access protected properties.
168 |      *
169 |      * @param  string  $property
170 |      * @return mixed
171 |      *
172 |      * @throws BadSkuArgument
173 |      */
174 |     public function __get($property)
175 |     {
176 |         if (property_exists($this, $property)) {
177 |             return $this->{$property};
178 |         }
179 | 
180 |         throw SkuException::invalidArgument("`{$property}` does not exist as a option", 500);
181 |     }
182 | }
183 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | [<img src="https://github-ads.s3.eu-central-1.amazonaws.com/support-ukraine.svg?t=1" />](https://supportukrainenow.org)
  2 | 
  3 | # Handle SKUs for your models
  4 | 
  5 | Generate unique SKUs when saving any Eloquent model.
  6 | 
  7 | ```php
  8 | $model = new EloquentModel();
  9 | $model->name = 'Laravel is Awesome';
 10 | $model->save();
 11 | 
 12 | echo $model->sku; // ouputs "LAR-80564492"
 13 | ```
 14 | 
 15 | Package will add a new method to Laravel's `Illuminate\Support\Str::sku()` class to generate an SKU for you.
 16 | 
 17 | ## Installation
 18 | 
 19 | You can install the package via composer:
 20 | 
 21 | ```bash
 22 | composer require binary-cats/laravel-sku
 23 | ```
 24 | 
 25 | The service provider will automatically register itself.
 26 | 
 27 | You can publish the config file with:
 28 | ```bash
 29 | php artisan vendor:publish --provider="BinaryCats\Sku\SkuServiceProvider" --tag="config"
 30 | ```
 31 | 
 32 | This is the contents of the config file that will be published at `config/laravel-sku.php`:
 33 | 
 34 | ```php
 35 | return [
 36 | 
 37 |     /*
 38 |     |--------------------------------------------------------------------------
 39 |     | SKU settings
 40 |     |--------------------------------------------------------------------------
 41 |     |
 42 |     | Set up your SKU
 43 |     |
 44 |     */
 45 |     'default' => [
 46 |         /*
 47 |          * SKU is based on a specific field of a model
 48 |          * You can use a single field or an array of fields
 49 |          */
 50 |         'source' => 'name',
 51 | 
 52 |         /*
 53 |          * Destination model field name
 54 |          *
 55 |          */
 56 |         'field' => 'sku',
 57 | 
 58 |         /*
 59 |          * SKU separator
 60 |          *
 61 |          */
 62 |         'separator' => '-',
 63 | 
 64 |         /*
 65 |          * Shall SKUs be enforced to be unique
 66 |          *
 67 |          */
 68 |         'unique' => true,
 69 | 
 70 |         /*
 71 |          * Shall SKUs be generated on create
 72 |          *
 73 |          */
 74 |         'generate_on_create' => true,
 75 | 
 76 |         /*
 77 |          * Shall SKUs be re-generated on update
 78 |          *
 79 |          */
 80 |         'generate_on_update' => true,
 81 |     ],
 82 | 
 83 |     /*
 84 |     |--------------------------------------------------------------------------
 85 |     | SKU Generator
 86 |     |--------------------------------------------------------------------------
 87 |     |
 88 |     | Define your own generator if needed.
 89 |     |
 90 |     */
 91 |     'generator' => \BinaryCats\Sku\Concerns\SkuGenerator::class,
 92 | ];
 93 | ```
 94 | 
 95 | Please note that the above set up expects you have an `sku` field in your model. If you plan to manually overwrite the values, please make sure to add this field to `fillable` array;
 96 | 
 97 | ### Usage
 98 | 
 99 | Add `BinaryCats\Sku\HasSku` trait to your model. That's it!
100 | 
101 | 
102 | ```php
103 | namespace App;
104 | 
105 | use BinaryCats\Sku\HasSku;
106 | use Illuminate\Database\Eloquent\Model;
107 | 
108 | class Product extends Model
109 | {
110 |     use HasSku;
111 | }
112 | ```
113 | 
114 | Behind the scenes this will register an observer for the `sku` field, which will be generated every time you save the model.
115 | 
116 | ## Advanced usage
117 | 
118 | If you want to change settings for a specific model, you can overload the `skuOptions`() method:
119 | 
120 | ```php
121 | namespace App;
122 | 
123 | use BinaryCats\Sku\HasSku;
124 | use BinaryCats\Sku\Concerns\SkuOptions;
125 | use Illuminate\Database\Eloquent\Model;
126 | 
127 | class Product extends Model
128 | {
129 |     use HasSku;
130 | 
131 |     /**
132 |      * Get the options for generating the Sku.
133 |      *
134 |      * @return BinaryCats\Sku\SkuOptions
135 |      */
136 |     public function skuOptions() : SkuOptions
137 |     {
138 |         return SkuOptions::make()
139 |             ->from(['label', 'another_field'])
140 |             ->target('arbitrary_sku_field_name')
141 |             ->using('_')
142 |             ->forceUnique(false)
143 |             ->generateOnCreate(true)
144 |             ->refreshOnUpdate(false);
145 |     }
146 | }
147 | ```
148 | 
149 | ### Custom Generator
150 | 
151 | Assuming you want some extra logic, like having a default value, or defining prefix for an SKU,
152 | you can implement your own SkuGenerator. It is easiest to extend the base class, but you are free to explore any which way.
153 | 
154 | First, create a custom class:
155 | 
156 | ```php
157 | 
158 | namespace App\Components\SkuGenerator;
159 | 
160 | use BinaryCats\Sku\Concerns\SkuGenerator;
161 | 
162 | class CustomSkuGenerator extends SkuGenerator
163 | {
164 |     /**
165 |      * Get the source fields for the SKU.
166 |      *
167 |      * @return string
168 |      */
169 |     protected function getSourceString(): string
170 |     {
171 |         // fetch the source fields
172 |         $source = $this->options->source;
173 |         // Fetch fields from model, skip empty
174 |         $fields = array_filter($this->model->only($source));
175 |         // Fetch fields from the model, if empty, use custom logic to resolve
176 |         if (empty($fields)) {
177 |             return 'some-random-value-logic';
178 |         }
179 |         // Impode with a separator
180 |         return implode($this->options->separator, $fields);
181 |     }
182 | }
183 | ```
184 | 
185 | and then update `generator` config value:
186 | 
187 | ```php
188 |     'generator' => \App\Components\SkuGenerator\CustomSkuGenerator::class,
189 | ```
190 | 
191 | You can also opt out to change implemetation completely;
192 | just remember that custom generator must implement `BinaryCats\Sku\Contracts\SkuGenerator`.
193 | 
194 | ### About SKUs
195 | 
196 | [Stock Keeping Unit](https://en.wikipedia.org/wiki/Stock_keeping_unit) allows you to set a unique identifier or code that refers to the particular stock keeping unit.
197 | 
198 | ## Changelog
199 | 
200 | Please see [CHANGELOG](CHANGELOG.md) for more information about what has changed recently.
201 | 
202 | ## Testing
203 | 
204 | ```bash
205 | composer test
206 | ```
207 | 
208 | ## Contributing
209 | 
210 | Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
211 | 
212 | ## Security
213 | 
214 | If you discover any security related issues, please email cyrill.kalita@gmail.com instead of using issue tracker.
215 | 
216 | ## Postcardware
217 | 
218 | You're free to use this package, but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.
219 | 
220 | ## Credits
221 | 
222 | - [Cyrill Kalita](https://github.com/binary-cats)
223 | - [All Contributors](../../contributors)
224 | 
225 | ## Support us
226 | 
227 | Binary Cats is a webdesign agency based in Illinois, US.
228 | 
229 | ## License
230 | 
231 | The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
232 | 


--------------------------------------------------------------------------------