Changed frontend types to keys for better naming

app/Http/Controllers/CommentController.php

@@ -39,11 +39,11 @@ public function store(StoreCommentRequest $request)
         $comment->content = $validatedData['content'];
         $comment->user_id = Auth::id();
 
-        $commentableType = $this->modelResolver->getModelClass($validatedData['commentable_type']);
+        $commentableType = $this->modelResolver->getModelClass($validatedData['commentable_key']);
         $commentableId = $validatedData['commentable_id'];
 
         // Ensure that the model exists
-        $model = $this->modelResolver->resolve($validatedData['commentable_type'], $commentableId);
+        $model = $this->modelResolver->resolve($validatedData['commentable_key'], $commentableId);
         if (!$model) {
             return response()->json(['message' => 'Model not found'], 404);
         }    
@@ -140,7 +140,7 @@ public function store(StoreCommentRequest $request)
     /**
      * Display the specified comment, with pagination.
      */
-    public function show(Request $request, string $commentableType, int $commentableId, int $index, int $paginationLimit = -1)
+    public function show(Request $request, string $commentableKey, int $commentableId, int $index, int $paginationLimit = -1)
     {
         if ($paginationLimit == -1)
         {
@@ -149,8 +149,8 @@ public function show(Request $request, string $commentableType, int $commentable
 
         $sortBy = $request->query('sort_by', 'top');
 
-        Log::debug("Request is, commentable_type: " .  $commentableType . ". id: " . $commentableId . ". index: " . $index . ". Sorting: " . $sortBy);
-        $paginatedResults = $this->commentService->getPaginatedComments($commentableType, $commentableId, $index, $paginationLimit, $sortBy);
+        Log::debug("Request is, commentable_type: " .  $commentableKey . ". id: " . $commentableId . ". index: " . $index . ". Sorting: " . $sortBy);
+        $paginatedResults = $this->commentService->getPaginatedComments($commentableKey, $commentableId, $index, $paginationLimit, $sortBy);
 
         return $paginatedResults;
     }

app/Http/Controllers/UpvoteController.php

@@ -19,20 +19,20 @@ function __construct(ModelResolverService $modelResolver)
     }
 
     /**
-     * Upvote a Model (type, id)
+     * Upvote a Model
      */
-    public function upvote($type, $id)
+    public function upvote($typeKey, $id)
     {
         validator(
             [
-                'type' => $type,
+                'type_key' => $typeKey,
             ],
             [
-                'type' => ['required', Rule::in(config('upvotes.upvotable_types'))]
+                'type_key' => ['required', Rule::in(config('upvotes.upvotable_keys'))]
             ]
         )->validate(); 
 
-        $model = $this->modelResolver->resolve($type, $id);
+        $model = $this->modelResolver->resolve($typeKey, $id);
 
         if (!$model) {
             return response()->json(['message' => 'Model not found'], 404);
@@ -50,18 +50,18 @@ public function upvote($type, $id)
     /**
      * Downvote a Model (type, id)
      */
-    public function downvote($type, $id)
+    public function downvote($typeKey, $id)
     {
         validator(
             [
-                'type' => $type,
+                'type_key' => $typeKey,
             ],
             [
-                'type' => ['required', Rule::in(config('upvotes.upvotable_types'))]
+                'type_key' => ['required', Rule::in(config('upvotes.upvotable_keys'))]
             ]
         )->validate(); 
 
-        $model = $this->modelResolver->resolve($type, $id);
+        $model = $this->modelResolver->resolve($typeKey, $id);
 
         if (!$model) {
             return response()->json(['message' => 'Model not found'], 404);

app/Http/Requests/Comment/StoreCommentRequest.php

@@ -34,10 +34,10 @@ public function rules(): array
     {
         return [
             "commentable_id" => ['required', 'integer'],
-            "commentable_type" => [
+            "commentable_key" => [
                 'required',
                 'string',
-                Rule::in(config('comment.commentable_types_shorthand')),
+                Rule::in(config('comment.commentable_keys')),
             ],
             "content" => ["required", "string", "max:4000"],
             "parent_comment_id" => ["nullable", "exists:App\Models\Comment,id"]

app/Services/CommentService.php

@@ -28,7 +28,7 @@ function __construct(ModelResolverService $resolver)
      * @return array
      */
     // TODO: Refactor commentable types, and commentable types short for all other objects
-    public function getPaginatedComments(string $commentableTypeShorthand, int $commentableId, int $index, int $paginationLimit = -1, string $sortBy = 'top'): array
+    public function getPaginatedComments(string $commentableKey, int $commentableId, int $index, int $paginationLimit = -1, string $sortBy = 'top'): array
     {
         if ($paginationLimit == -1)
         {
@@ -37,15 +37,15 @@ public function getPaginatedComments(string $commentableTypeShorthand, int $comm
 
         Validator::make([
             'index' => $index,
-            'commentable_type_short' => $commentableTypeShorthand,
+            'commentable_key' => $commentableKey,
             'pagination_limit' => $paginationLimit,
         ], [
             'index' => ['required', 'integer', 'min:0'],
-            'commentable_type_short' => ['required', Rule::in(config('comment.commentable_types_shorthand'))],
+            'commentable_key' => ['required', Rule::in(config('comment.commentable_keys'))],
             'pagination_limit' => ['required', 'integer', 'max:' . config('comment.pagination_limit')],
         ])->validate();
 
-        $commentableType = $this->modelResolver->getModelClass($commentableTypeShorthand);   
+        $commentableType = $this->modelResolver->getModelClass($commentableKey);   
         Log::debug("Request is, commentable_type: {$commentableType}. id: {$commentableId}. index: {$index}");
 
         // Get the root comments:

config/comment.php

@@ -5,6 +5,6 @@
     'max_depth' => 7, // 1-indexed, 1 is the start
     'pagination_limit' => 150,
     'default_pagination_limit' => 5,
-    'commentable_types_shorthand' => ['review', 'comment', 'edit', 'resource'],
+    'commentable_keys' => ['review', 'comment', 'edit', 'resource'],
     'sortable_options' => ['latest', 'top', 'bottom', 'controversial', 'mine']
 ];

config/upvotes.php

@@ -1,5 +1,5 @@
 <?php
 
 return [
-    'upvotable_types' => ['review', 'comment', 'edit', 'resource']
+    'upvotable_keys' => ['review', 'comment', 'edit', 'resource']
 ];

database/factories/CommentFactory.php

@@ -23,9 +23,9 @@ class CommentFactory extends Factory
     public function definition(): array
     {
         // Pick a random commentable type from config.
-        $commentableName = $this->faker->randomElement(['comment', 'resource']);
+        $commentableKey = $this->faker->randomElement(['comment', 'resource']);
         $modelResolver = app(ModelResolverService::class);
-        $modelClass = $modelResolver->getModelClass($commentableName);
+        $modelClass = $modelResolver->getModelClass($commentableKey);
 
         // Use an existing user or create one.
         $user = User::inRandomOrder()->first() ?? User::factory()->create();

resources/js/Components/Comments/CommentActionsForm.vue

@@ -18,7 +18,7 @@ const props = defineProps({
 
 const isOpen = ref(false);
 
-const commentableType = inject("commentableType");
+const commentableKey = inject("commentableKey");
 const commentableId = inject("commentableId");
 const createdNewCommentCallback = inject("createdNewCommentCallback");
 
@@ -29,7 +29,7 @@ const toggleOpen = () => {
 const form = reactive({
     content: "",
     commentable_id: commentableId,
-    commentable_type: commentableType,
+    commentable_key: commentableKey,
     parent_comment_id: props.parentCommentId ?? null,
     errors: {},
     processing: false,

resources/js/Components/Comments/Commentable.vue

@@ -1,5 +1,5 @@
 <script setup>
-import { ref, provide, readonly, nextTick, onMounted, reactive } from "vue";
+import { ref, provide, readonly, nextTick, onMounted } from "vue";
 import axios from "axios";
 import CommentActionsForm from "@/Components/Comments/CommentActionsForm.vue";
 import SortByDropdown from "@/Components/Comments/SortUpvotesByDropdown.vue";
@@ -10,7 +10,7 @@ const props = defineProps({
         type: Number,
         required: true,
     },
-    commentableType: {
+    commentableKey: {
         type: String,
         required: true,
     },
@@ -69,7 +69,7 @@ const createdNewCommentCallback = (newComment, userData) => {
 };
 
 provide("commentableId", props.commentableId);
-provide("commentableType", props.commentableType);
+provide("commentableKey", props.commentableKey);
 provide("users", readonly(usersMap));
 provide("createdNewCommentCallback", createdNewCommentCallback);
 
@@ -139,7 +139,7 @@ async function loadComments() {
         const response = await axios.get(
             route("comments.show", {
                 id: props.commentableId,
-                type: props.commentableType,
+                type: props.commentableKey,
                 index: currentIndex.value,
                 paginationLimit: props.paginationLimit,
                 sort_by: sortBy.value,

resources/js/Components/Comments/SingleComment.vue

@@ -33,7 +33,7 @@ const formattedDate = computed(() =>
     <div class="p-4 border-b border-gray-200" :key="comment.id" :id="'comment_'+comment.id">
 
         <Upvotable
-            :upvotable-type="'comment'"
+            :upvotable-key="'comment'"
             :upvotable-id="comment.id"
             :initial-votes="comment.vote_score"
             :user-vote="comment.user_vote"

resources/js/Components/Resources/ResourceEdit/ResourceEdits.vue

@@ -42,7 +42,7 @@ const props = defineProps({
                 >
                     <div class="flex flex-col bg-slate-100">
                         <Upvotable
-                            :upvotable-type="'edit'"
+                            :upvotable-key="'edit'"
                             :upvotable-id="edit.id"
                             :initial-votes="edit.vote_score"
                             :user-vote="edit.user_vote"

resources/js/Components/Resources/ResourceItem.vue

@@ -19,7 +19,7 @@ const emit = defineEmits(["upvote", "downvote"]);
         <td class="align-top pr-6">
             <Upvotable
                 :upvotable-id="resource.id"
-                :upvotable-type="'resource'"
+                :upvotable-key="'resource'"
                 :initial-votes="resource.vote_score"
                 :user-vote="resource.user_vote"
             ></Upvotable>

resources/js/Components/Resources/Reviews/ResourceReview.vue

@@ -18,7 +18,7 @@ const ratingFeatures = Object.entries(ratingLabels).map(([key, label]) => ({
 
 <template>
     <Upvotable
-        :upvotable-type="'review'"
+        :upvotable-key="'review'"
         :upvotable-id="props.review.id"
         :initial-votes="props.review.vote_score"
         :user-vote="props.review.user_vote"
@@ -75,7 +75,7 @@ const ratingFeatures = Object.entries(ratingLabels).map(([key, label]) => ({
 
     <Commentable 
         :commentable-id="review.id" 
-        :commentable-type="'review'"
+        :commentable-key="'review'"
         :comments-count="review.comments_count"
     />
 </template>

resources/js/Components/Upvote/Upvotable.vue

@@ -5,7 +5,7 @@ import { Icon } from "@iconify/vue";
 import { router } from '@inertiajs/vue3'
 
 const props = defineProps({
-    upvotableType: {
+    upvotableKey: {
         type: String,
         required: true,
     },
@@ -52,7 +52,7 @@ async function handleUpvote() {
         const response = await axios.post(
             route("upvote", {
                 id: props.upvotableId,
-                type: props.upvotableType,
+                type: props.upvotableKey,
             })
         );
         userVote.value = response.data.userVote;
@@ -77,7 +77,7 @@ async function handleDownvote() {
         const response = await axios.post(
             route("downvote", {
                 id: props.upvotableId,
-                type: props.upvotableType,
+                type: props.upvotableKey,
             })
         );
         userVote.value = response.data.userVote;

resources/js/Pages/ResourceEdits/Show.vue

@@ -513,7 +513,7 @@ function mergeEdits(id) {
                         <!-- TODO: Add partial reload to the refresh -->
                         <Upvotable
                             :flexRow="true"
-                            :upvotable-type="'edit'"
+                            :upvotable-key="'edit'"
                             :upvotable-id="resourceId"
                             :initial-votes="editedResource.vote_score"
                             :user-vote="editedResource.user_vote"
@@ -565,7 +565,7 @@ function mergeEdits(id) {
 
                     <Commentable
                         :commentable-id="props.editedResource.id"
-                        :commentable-type="'edit'"
+                        :commentable-key="'edit'"
                         :comments-count="props.editedResource.comments_count"
                     ></Commentable>
                 </div>

resources/js/Pages/Resources/Show.vue

@@ -65,7 +65,7 @@ const sortingType = urlParams.get('sort_by') || 'top';
                                 >
                                     <UpvoteResource
                                         :upvotable-id="props.resource.id"
-                                        :upvotable-type="'resource'"
+                                        :upvotable-key="'resource'"
                                         :initial-votes="
                                             props.resource.vote_score
                                         "
@@ -246,7 +246,7 @@ const sortingType = urlParams.get('sort_by') || 'top';
                                     :sort-by-initial-value="props.discussionSortByValue"
                                     :has-sort-by-dropdown="false"
                                     :commentable-id="props.resource.id"
-                                    :commentable-type="'resource'"
+                                    :commentable-key="'resource'"
                                     :comments-count="
                                         props.resource.comments_count
                                     "