Merge pull request #5 from whitecube/feature-custom-model

Feature custom model

Author: voidgraphics

README.md

@@ -7,6 +7,22 @@ Manage acquisition, selling & renting prices for products and services in yo
 composer require whitecube/laravel-prices
 ```
 
+## Configuration
+
+You can publish the config file by running this command:
+
+```shell
+php artisan vendor:publish --tag=prices-config 
+```
+
+Once your configuration file is created in `config/prices.php`, you can edit the Price model to a custom Price model by changing:
+
+```php
+return [
+    'model' => \App\Models\CustomPriceModel::class,
+];
+```
+
 ## Quick overview
 
 This package lets you attach prices to anything you want, and keeps a history of the price changes overtime.

config/prices.php

@@ -0,0 +1,13 @@
+<?php
+return [
+    /*
+    |--------------------------------------------------------------------------
+    | Prices model class
+    |--------------------------------------------------------------------------
+    |
+    | The price model class can be changed to have more flexibility. You just have
+    | to change it down here
+    |
+    */
+    'model' => Whitecube\LaravelPrices\Models\Price::class,
+];

src/HasPrices.php

@@ -4,7 +4,6 @@
 
 use DateTime;
 use Illuminate\Database\Eloquent\Model;
-use Whitecube\LaravelPrices\Models\Price;
 
 trait HasPrices
 {
@@ -15,7 +14,7 @@ trait HasPrices
      */
     public function prices()
     {
-        return $this->morphMany(Price::class, 'priceable');
+        return $this->morphMany(config('prices.model'), 'priceable');
     }
 
     /**
@@ -25,13 +24,13 @@ public function prices()
      */
     public function price()
     {
-        return $this->morphOne(Price::class, 'priceable')->where('type', $this->getDefaultPriceType())->current();
+        return $this->morphOne(config('prices.model'), 'priceable')->where('type', $this->getDefaultPriceType())->current();
     }
 
     /**
      * Easy accessor to get the current price as a whitecube/php-prices object
      *
-     * @return \Whitecube\Price\Price|null
+     * @return \Illuminate\Database\Eloquent\Model|null
      */
     public function getPriceAttribute()
     {
@@ -43,10 +42,10 @@ public function getPriceAttribute()
     /**
      * Set (attach) a new price to this item
      *
-     * @param Price $price
+     * @param \Illuminate\Database\Eloquent\Model $price
      * @return \Illuminate\Database\Eloquent\Model
      */
-    public function setPriceAttribute(Price $price): Model
+    public function setPriceAttribute(Model $price): Model
     {
         return $this->prices()->save($price);
     }
@@ -71,7 +70,8 @@ public function setPrice(
         DateTime $activated_at = null
     ): static
     {
-        $this->price = new Price($arguments, $amount, $minor, $currency, $type, $activated_at);
+        $model = config('prices.model');
+        $this->price = new $model($arguments, $amount, $minor, $currency, $type, $activated_at);
 
         return $this;
     }
@@ -80,7 +80,7 @@ public function setPrice(
      * Get the price, as a model or as a whitecube/php-prices instance
      *
      * @param boolean $asModel
-     * @return \Whitecube\Price\Price|\Whitecube\LaravelPrices\Models\Price
+     * @return \Whitecube\Price\Price|\Illuminate\Database\Eloquent\Model
      */
     public function getPrice(bool $asModel = false)
     {

src/LaravelPricesServiceProvider.php

@@ -8,6 +8,19 @@ class LaravelPricesServiceProvider extends ServiceProvider
 {
     public function boot()
     {
-        $this->loadMigrationsFrom(__DIR__.'/../database/migrations');
+        $this->loadMigrationsFrom(__DIR__ . '/../database/migrations');
+
+        $this->publishes([
+            $this->getConfigPath() => config_path('prices.php')
+        ], 'prices-config');
+
+        if (! file_exists(config_path('prices.php'))) {
+            $this->mergeConfigFrom($this->getConfigPath(), 'prices');
+        }
+    }
+
+    protected function getConfigPath(): string
+    {
+        return __DIR__ . '/../config/prices.php';
     }
 }

tests/Feature/PricesTest.php

@@ -1,8 +1,8 @@
 <?php
 
 use Whitecube\Price\Price as PhpPrice;
-use Whitecube\LaravelPrices\Models\Price;
 use Whitecube\LaravelPrices\Tests\Fixtures\PriceableItem;
+use Whitecube\LaravelPrices\Models\Price;
 
 test('a price can be set on a priceable item via the relationship', function() {
     $priceable_item = new PriceableItem(['id' => '1234']);
@@ -14,6 +14,7 @@
         'activated_at' => now()->addWeek()
     ]);
 
+
     $this->assertNotNull($price);
     $this->assertInstanceOf(Price::class, $price);
     $this->assertSame($priceable_item->id, $price->priceable_id);

tests/Feature/ScopesTest.php

@@ -3,7 +3,6 @@
 use Whitecube\LaravelPrices\Models\Price;
 use Whitecube\LaravelPrices\Tests\Fixtures\PriceableItem;
 
-
 test('the current scope can return the correct price', function() {
     $priceable_item = new PriceableItem(['id' => 1234]);
 

tests/Pest.php

@@ -17,6 +17,10 @@
 uses(TestCase::class)->in('Feature');
 uses(RefreshDatabase::class)->in('Feature');
 
+beforeEach(function () {
+    config(['price.model' => Price::class]);
+});
+
 /*
 |--------------------------------------------------------------------------
 | Expectations