Custom tables

README.md

@@ -48,13 +48,21 @@ return [
 
     /*
     |--------------------------------------------------------------------------
-    | Experience Table
+    | Table Names
     |--------------------------------------------------------------------------
     |
-    | This value is the name of the table that will be used to store experience data.
+    | These values are the names of the tables that will be used to store the data.
     |
      */
-    'table' => 'experiences',
+    'tables' => [
+        'experiences' => 'experiences',
+        'experience_audits' => 'experience_audits',
+        'achievements' => 'achievements',
+        'levels' => 'levels',
+        'streaks' => 'streaks',
+        'streak_histories' => 'streak_histories',
+        'streak_activities' => 'streak_activities',
+    ],
 
     /*
     |-----------------------------------------------------------------------

config/level-up.php

@@ -17,13 +17,30 @@
 
     /*
     |--------------------------------------------------------------------------
-    | Experience Table
+    | Table Names
     |--------------------------------------------------------------------------
     |
-    | This value is the name of the table that will be used to store experience data.
+    | This value is the name of the tables that will be used to store level up data.
+    | You can change the table names to fit your application.
+    |
+    | The default table names are using Laravel conventions.
+    |
+    | It is recommended to keep the table names as they are, only change them if
+    | you know what you are doing.
+    |
+    | example: 'typical_table_name' => 'new_table_name',
     |
      */
-    'table' => 'experiences',
+    'tables' => [
+        'achievement_user' => 'achievement_user', // pivot table
+        'experiences' => 'experiences',
+        'experience_audits' => 'experience_audits',
+        'achievements' => 'achievements',
+        'levels' => 'levels',
+        'streaks' => 'streaks',
+        'streak_histories' => 'streak_histories',
+        'streak_activities' => 'streak_activities',
+    ],
 
     /*
     |-----------------------------------------------------------------------

database/migrations/add_streak_freeze_feature_columns_to_streaks_table.php.stub

@@ -7,7 +7,7 @@ use Illuminate\Support\Facades\Schema;
 return new class extends Migration {
     public function up(): void
     {
-        Schema::table('streaks', function (Blueprint $table) {
+        Schema::table(config('level-up.tables.streaks'), function (Blueprint $table) {
             $table->after('activity_at', function (Blueprint $table) {
                 $table->timestamp('frozen_until')->nullable();
             });
@@ -16,7 +16,7 @@ return new class extends Migration {
 
     public function down(): void
     {
-        Schema::table('streaks', function (Blueprint $table) {
+        Schema::table(config('level-up.tables.streaks'), function (Blueprint $table) {
             $table->dropColumn('frozen_until');
         });
     }

database/migrations/create_achievement_user_pivot_table.php.stub

@@ -7,17 +7,17 @@ use Illuminate\Support\Facades\Schema;
 return new class extends Migration {
     public function up(): void
     {
-        Schema::create('achievement_user', function (Blueprint $table) {
+        Schema::create(config('level-up.tables.achievement_user'), function (Blueprint $table) {
             $table->id();
             $table->foreignId(column: config('level-up.user.foreign_key'))->constrained(config('level-up.user.users_table'));
-            $table->foreignId(column: 'achievement_id')->constrained();
+            $table->foreignId(column: 'achievement_id')->constrained(config('level-up.tables.achievements'));
             $table->integer(column: 'progress')->nullable()->index();
             $table->timestamps();
         });
     }
 
     public function down(): void
     {
-        Schema::dropIfExists('achievement_user');
+        Schema::dropIfExists(config('level-up.tables.achievements') . '_' . config('level-up.user.users_table'));
     }
 };

database/migrations/create_achievements_table.php.stub

@@ -7,7 +7,7 @@ use Illuminate\Support\Facades\Schema;
 return new class extends Migration {
     public function up(): void
     {
-        Schema::create('achievements', function (Blueprint $table) {
+        Schema::create(config('level-up.tables.achievements'), function (Blueprint $table) {
             $table->id();
             $table->string('name');
             $table->boolean('is_secret')->default(false);
@@ -19,6 +19,6 @@ return new class extends Migration {
 
     public function down(): void
     {
-        Schema::dropIfExists('achievements');
+        Schema::dropIfExists(config('level-up.tables.achievements'));
     }
 };

database/migrations/create_experience_audits_table.php.stub

@@ -7,7 +7,7 @@ use Illuminate\Support\Facades\Schema;
 return new class extends Migration {
     public function up(): void
     {
-        Schema::create('experience_audits', function (Blueprint $table) {
+        Schema::create(config('level-up.tables.experience_audits'), function (Blueprint $table) {
             $table->id();
             $table->foreignId(config('level-up.user.foreign_key'))->constrained(config('level-up.user.users_table'));
             $table->integer('points')->index();
@@ -21,6 +21,6 @@ return new class extends Migration {
 
     public function down(): void
     {
-        Schema::dropIfExists('experience_audits');
+        Schema::dropIfExists(config('level-up.tables.experience_audits'));
     }
 };

database/migrations/create_experiences_table.php.stub

@@ -8,7 +8,7 @@ return new class extends Migration
 {
     public function up()
     {
-        Schema::create(config('level-up.table'), function (Blueprint $table) {
+        Schema::create(config('level-up.tables.experiences'), function (Blueprint $table) {
             $table->id();
             $table->foreignId(config('level-up.user.foreign_key'))->constrained(config('level-up.user.users_table'));
             $table->foreignId('level_id')->constrained();
@@ -19,6 +19,6 @@ return new class extends Migration
 
     public function down()
     {
-        Schema::dropIfExists(config('level-up.table'));
+        Schema::dropIfExists(config('level-up.tables.experiences'));
     }
 };

database/migrations/create_levels_table.php.stub

@@ -8,7 +8,7 @@ return new class extends Migration
 {
     public function up()
     {
-        Schema::create('levels', function (Blueprint $table) {
+        Schema::create(config('level-up.tables.levels'), function (Blueprint $table) {
             $table->id();
             $table->integer('level')->unique();
             $table->integer('next_level_experience')->nullable()->index();
@@ -18,6 +18,6 @@ return new class extends Migration
 
     public function down()
     {
-        Schema::dropIfExists('levels');
+        Schema::dropIfExists(config('level-up.tables.levels'));
     }
 };

database/migrations/create_streak_activities_table.php.stub

@@ -7,7 +7,7 @@ use Illuminate\Support\Facades\Schema;
 return new class extends Migration {
     public function up(): void
     {
-        Schema::create('streak_activities', function (Blueprint $table) {
+        Schema::create(config('level-up.tables.streak_activities'), function (Blueprint $table) {
             $table->id();
             $table->string('name')->unique();
             $table->text('description')->nullable();
@@ -17,6 +17,6 @@ return new class extends Migration {
 
     public function down(): void
     {
-        Schema::dropIfExists('streak_activities');
+        Schema::dropIfExists(config('level-up.tables.streak_activities'));
     }
 };

database/migrations/create_streak_histories_table.php.stub

@@ -9,7 +9,7 @@ return new class extends Migration
 {
     public function up(): void
     {
-        Schema::create(table: 'streak_histories', callback: function (Blueprint $table) {
+        Schema::create(config('level-up.tables.streak_histories'), function (Blueprint $table) {
             $table->id();
             $table->foreignId(column: config(key: 'level-up.user.foreign_key'))->constrained(table: config(key: 'level-up.user.users_table'))->cascadeOnDelete();
             $table->foreignIdFor(model: Activity::class)->constrained(table: 'streak_activities');
@@ -22,6 +22,6 @@ return new class extends Migration
 
     public function down(): void
     {
-        Schema::dropIfExists('streak_histories');
+        Schema::dropIfExists(config('level-up.tables.streak_histories'));
     }
 };

database/migrations/create_streaks_table.php.stub

@@ -7,18 +7,18 @@ use Illuminate\Support\Facades\Schema;
 return new class extends Migration {
     public function up(): void
     {
-        Schema::create('streaks', function (Blueprint $table) {
+        Schema::create(config('level-up.tables.streaks'), function (Blueprint $table) {
             $table->id();
-            $table->foreignId(column: config('level-up.user.foreign_key'))->constrained()->onDelete('cascade');
-            $table->foreignId(column: 'activity_id')->constrained('streak_activities')->onDelete('cascade');
-            $table->integer(column: 'count')->default(1);
-            $table->timestamp(column: 'activity_at');
+            $table->foreignId(config('level-up.user.foreign_key'))->constrained()->onDelete('cascade');
+            $table->foreignId('activity_id')->constrained(config('level-up.tables.streak_activities'))->onDelete('cascade');
+            $table->integer('count')->default(1);
+            $table->timestamp('activity_at');
             $table->timestamps();
         });
     }
 
     public function down(): void
     {
-        Schema::dropIfExists('streaks');
+        Schema::dropIfExists(config('level-up.tables.streaks'));
     }
 };

src/Models/Achievement.php

@@ -12,6 +12,12 @@ class Achievement extends Model
 
     protected $guarded = [];
 
+    public function __construct(array $attributes = [])
+    {
+        parent::__construct($attributes);
+        $this->table = config('level-up.tables.achievements') ?: parent::getTable();
+    }
+
     public function users(): BelongsToMany
     {
         return $this->belongsToMany(related: config(key: 'level-up.user.model'));

src/Models/Activity.php

@@ -10,7 +10,11 @@ class Activity extends Model
 {
     use HasFactory;
 
-    protected $table = 'streak_activities';
+    public function __construct(array $attributes = [])
+    {
+        parent::__construct($attributes);
+        $this->table = config('level-up.tables.streak_activities') ?: parent::getTable();
+    }
 
     protected $guarded = [];
 

src/Models/Experience.php

@@ -13,7 +13,7 @@ class Experience extends Model
     public function __construct(array $attributes = [])
     {
         parent::__construct($attributes);
-        $this->table = config(key: 'level-up.table');
+        $this->table = config(key: 'level-up.tables.experiences');
     }
 
     protected $guarded = [];

src/Models/ExperienceAudit.php

@@ -14,6 +14,12 @@ class ExperienceAudit extends Model
         'type' => AuditType::class,
     ];
 
+    public function __construct(array $attributes = [])
+    {
+        parent::__construct($attributes);
+        $this->table = config(key: 'level-up.tables.experience_audits');
+    }
+
     public function user(): BelongsTo
     {
         return $this->belongsTo(config(key: 'level-up.user.model'));

src/Models/Level.php

@@ -11,6 +11,12 @@ class Level extends Model
 {
     protected $guarded = [];
 
+    public function __construct(array $attributes = [])
+    {
+        parent::__construct($attributes);
+        $this->table = config(key: 'level-up.tables.levels');
+    }
+
     /**
      * @throws \LevelUp\Experience\Exceptions\LevelExistsException
      */

src/Models/Pivots/AchievementUser.php

@@ -8,6 +8,12 @@
 
 class AchievementUser extends Pivot
 {
+    public function __construct(array $attributes = [])
+    {
+        parent::__construct($attributes);
+        $this->table = config('level-up.tables.achievement_user');
+    }
+
     public function scopeWithProgress(Builder $query, int $progress): Collection
     {
         return $query->where(column: 'progress', operator: $progress)->get();

src/Models/Streak.php

@@ -17,6 +17,12 @@ class Streak extends Model
         'frozen_until' => 'datetime',
     ];
 
+    public function __construct(array $attributes = [])
+    {
+        parent::__construct($attributes);
+        $this->table = config(key: 'level-up.tables.streaks');
+    }
+
     public function user(): BelongsTo
     {
         return $this->belongsTo(config(key: 'level-up.user.model'));

src/Models/StreakHistory.php

@@ -12,4 +12,10 @@ class StreakHistory extends Model
         'started_at' => 'datetime',
         'ended_at' => 'datetime',
     ];
+
+    public function __construct(array $attributes = [])
+    {
+        parent::__construct($attributes);
+        $this->table = config(key: 'level-up.tables.streak_history');
+    }
 }

tests/Concerns/HasStreaksTest.php

@@ -7,7 +7,6 @@
 use LevelUp\Experience\Events\StreakStarted;
 use LevelUp\Experience\Events\StreakUnfroze;
 use LevelUp\Experience\Models\Activity;
-
 use function Pest\Laravel\travel;
 
 uses()->group('streaks');