Merge pull request #1 from laravelcm/plan-test

mckenziearts · web-flow · commit b36df3b1c65b · 2023-10-02T19:00:15.000+02:00
Plan test
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -0,0 +1 @@
+github: mckenziearts
diff --git a/.github/workflows/phpstan.yml b/.github/workflows/phpstan.yml
@@ -0,0 +1,33 @@
+name: PHPStan
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  phpstan:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        php: [8.1, 8.2]
+        laravel: [9.*, 10.*]
+        dependency-version: [prefer-stable]
+    name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.dependency-version }}
+    steps:
+      - uses: actions/checkout@v3
+      - name: Cache dependencies
+        uses: actions/cache@v2
+        with:
+          path: ~/.composer/cache/files
+          key: dependencies-laravel-${{ matrix.laravel }}-php-${{ matrix.php }}-composer-${{ hashFiles('composer.json') }}
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite
+          coverage: none
+      - name: Install dependencies
+        run: composer install --prefer-dist --no-interaction
+      - name: Run PHPStan
+        run: composer stan
diff --git a/.github/workflows/pint.yml b/.github/workflows/pint.yml
@@ -0,0 +1,29 @@
+name: Check & fix styling
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.2
+          extensions: json, dom, curl, libxml, mbstring
+          coverage: none
+
+      - name: Install Pint
+        run: composer global require laravel/pint
+
+      - name: Run Pint
+        run: pint
+
+      - name: Commit linted files
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: Fix code styling
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -0,0 +1,25 @@
+name: Tests
+
+on: [push, pull_request]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.2
+          extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite
+          tools: composer:v2
+          coverage: none
+
+      - name: Install Composer dependencies
+        run: composer install --prefer-dist --no-interaction
+
+      - name: Execute tests
+        run: composer pest
diff --git a/composer.json b/composer.json
@@ -17,7 +17,7 @@
     "email": "support@laravel.cm",
     "issues": "https://github.com/laravelcm/laravel-subscriptions/issues",
     "source": "https://github.com/laravelcm/laravel-subscriptions",
-    "docs": "https://github.com/laravelcm/laravel-subscriptions/blob/master/README.md"
+    "docs": "https://github.com/laravelcm/laravel-subscriptions/blob/main/README.md"
   },
   "authors": [
     {
diff --git a/database/migrations/2020_01_01_000001_create_plans_table.php b/database/migrations/2020_01_01_000001_create_plans_table.php
@@ -12,24 +12,24 @@ public function up(): void
         Schema::create(config('laravel-subscriptions.tables.plans'), function (Blueprint $table): void {
             $table->id();
 
-            $table->string('slug')->unique();
             $table->json('name');
+            $table->string('slug')->unique();
             $table->json('description')->nullable();
             $table->boolean('is_active')->default(true);
             $table->decimal('price')->default('0.00');
             $table->decimal('signup_fee')->default('0.00');
             $table->string('currency', 3);
-            $table->smallInteger('trial_period')->unsigned()->default(0);
+            $table->unsignedSmallInteger('trial_period')->default(0);
             $table->string('trial_interval')->default('day');
-            $table->smallInteger('invoice_period')->unsigned()->default(0);
+            $table->unsignedSmallInteger('invoice_period')->default(0);
             $table->string('invoice_interval')->default('month');
-            $table->smallInteger('grace_period')->unsigned()->default(0);
+            $table->unsignedSmallInteger('grace_period')->default(0);
             $table->string('grace_interval')->default('day');
-            $table->tinyInteger('prorate_day')->unsigned()->nullable();
-            $table->tinyInteger('prorate_period')->unsigned()->nullable();
-            $table->tinyInteger('prorate_extend_due')->unsigned()->nullable();
-            $table->smallInteger('active_subscribers_limit')->unsigned()->nullable();
-            $table->mediumInteger('sort_order')->unsigned()->default(0);
+            $table->unsignedTinyInteger('prorate_day')->nullable();
+            $table->unsignedTinyInteger('prorate_period')->nullable();
+            $table->unsignedTinyInteger('prorate_extend_due')->nullable();
+            $table->unsignedSmallInteger('active_subscribers_limit')->nullable();
+            $table->unsignedSmallInteger('sort_order')->default(0);
 
             $table->timestamps();
             $table->softDeletes();
diff --git a/database/migrations/2020_01_01_000002_create_plan_features_table.php b/database/migrations/2020_01_01_000002_create_plan_features_table.php
@@ -14,8 +14,8 @@ public function up(): void
             $table->id();
 
             $table->foreignIdFor(Plan::class);
-            $table->string('slug')->unique();
             $table->json('name');
+            $table->string('slug')->unique();
             $table->json('description')->nullable();
             $table->string('value');
             $table->unsignedSmallInteger('resettable_period')->default(0);
diff --git a/database/migrations/2020_01_01_000003_create_plan_subscriptions_table.php b/database/migrations/2020_01_01_000003_create_plan_subscriptions_table.php
@@ -15,8 +15,8 @@ public function up(): void
 
             $table->morphs('subscriber');
             $table->foreignIdFor(Plan::class);
-            $table->string('slug')->unique();
             $table->json('name');
+            $table->string('slug')->unique();
             $table->json('description')->nullable();
             $table->string('timezone')->nullable();
 
diff --git a/pint.json b/pint.json
@@ -12,7 +12,6 @@
     "declare_parentheses": true,
     "declare_strict_types": true,
     "explicit_string_variable": true,
-    "final_class": true,
     "final_internal_class": false,
     "fully_qualified_strict_types": true,
     "global_namespace_import": {
diff --git a/src/Models/Plan.php b/src/Models/Plan.php
@@ -21,7 +21,7 @@
  * @property string $slug
  * @property array $name
  * @property array $description
- * @property bool$is_active
+ * @property bool $is_active
  * @property float $price
  * @property float $signup_fee
  * @property string $currency
@@ -39,7 +39,7 @@
  * @property \Carbon\Carbon|null $created_at
  * @property \Carbon\Carbon|null $updated_at
  * @property \Carbon\Carbon|null $deleted_at
- * @property-read \Illuminate\Database\Eloquent\Collection|\Laravelcm\Subscriptions\Models\Feature[]      $features
+ * @property-read \Illuminate\Database\Eloquent\Collection|\Laravelcm\Subscriptions\Models\Feature[] $features
  * @property-read \Illuminate\Database\Eloquent\Collection|\Laravelcm\Subscriptions\Models\Subscription[] $subscriptions
  *
  * @method static \Illuminate\Database\Eloquent\Builder|\Laravelcm\Subscriptions\Models\Plan ordered($direction = 'asc')
diff --git a/tests/Feature/PlanTest.php b/tests/Feature/PlanTest.php
@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+use Tests\Models\Feature;
+use Tests\Models\Plan;
+
+beforeEach(function (): void {
+    $this->plan = Plan::factory()->create();
+});
+
+it('can create a plan', function (): void {
+    expect(Plan::count())->toBe(1);
+})->group('plan');
+
+it('a plan can have many features', function (): void {
+    expect($this->plan->features()->count())->toBe(0);
+
+    Feature::factory()->create(['plan_id' => $this->plan->id]);
+    Feature::factory()->create([
+        'name' => 'pictures_per_listing',
+        'value' => 10,
+        'sort_order' => 5,
+        'plan_id' => $this->plan->id,
+    ]);
+
+    expect($this->plan->features()->count())->toBe(2);
+})->group('plan');
+
+it('a plan can be free with trial period', function (): void {
+    $this->plan->update([
+        'price' => 0,
+        'signup_fee' => 0,
+    ]);
+
+    expect($this->plan->isFree())
+        ->toBeTrue()
+        ->and($this->plan->hasTrial())
+        ->toBeTrue();
+})->group('plan');
+
+it('a plan can have a grace period', function (): void {
+    $this->plan->update([
+        'grace_period' => 7,
+        'grace_interval' => 'day',
+    ]);
+
+    expect($this->plan->hasGrace())
+        ->toBeTrue();
+})->group('plan');
diff --git a/tests/database/factories/FeatureFactory.php b/tests/database/factories/FeatureFactory.php
@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Database\Factories;
+
+use Illuminate\Database\Eloquent\Factories\Factory;
+use Tests\Models\Feature;
+
+class FeatureFactory extends Factory
+{
+    protected $model = Feature::class;
+
+    public function definition(): array
+    {
+        return [
+            'name' => 'listings',
+            'value' => 50,
+            'sort_order' => 1,
+        ];
+    }
+}
diff --git a/tests/database/factories/PlanFactory.php b/tests/database/factories/PlanFactory.php
@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Database\Factories;
+
+use Illuminate\Database\Eloquent\Factories\Factory;
+use Tests\Models\Plan;
+
+final class PlanFactory extends Factory
+{
+    protected $model = Plan::class;
+
+    public function definition(): array
+    {
+        return [
+            'name' => 'Pro',
+            'description' => 'Pro plan',
+            'price' => 9.99,
+            'signup_fee' => 1.99,
+            'invoice_period' => 1,
+            'invoice_interval' => 'month',
+            'trial_period' => 15,
+            'trial_interval' => 'day',
+            'sort_order' => 1,
+            'currency' => 'USD',
+        ];
+    }
+}
diff --git a/tests/src/Models/Feature.php b/tests/src/Models/Feature.php
@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Models;
+
+use Tests\Database\Factories\FeatureFactory;
+
+class Feature extends \Laravelcm\Subscriptions\Models\Feature
+{
+    protected static function newFactory(): FeatureFactory
+    {
+        return FeatureFactory::new();
+    }
+}
diff --git a/tests/src/Models/Plan.php b/tests/src/Models/Plan.php
@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Models;
+
+use Tests\Database\Factories\PlanFactory;
+
+class Plan extends \Laravelcm\Subscriptions\Models\Plan
+{
+    protected static function newFactory(): PlanFactory
+    {
+        return PlanFactory::new();
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@`
`17`	`17`	`"email": "support@laravel.cm",`
`18`	`18`	`"issues": "https://github.com/laravelcm/laravel-subscriptions/issues",`
`19`	`19`	`"source": "https://github.com/laravelcm/laravel-subscriptions",`
`20`		`- "docs": "https://github.com/laravelcm/laravel-subscriptions/blob/master/README.md"`
	`20`	`+ "docs": "https://github.com/laravelcm/laravel-subscriptions/blob/main/README.md"`
`21`	`21`	`},`
`22`	`22`	`"authors": [`
`23`	`23`	`{`