[#27] Create folder model and controller (#46)

* [#27] Create folder model and controller

* Add slugs to folders

Author: dixonnataliej

api/app/controllers/folders_controller.rb

@@ -0,0 +1,66 @@
+class FoldersController < ApplicationController
+  # before_action :authenticate_user!, except: [:index, :show]
+  before_action :authenticate_user!, only: [ :my_folders ] # temporary until users
+  before_action :authorize_user!, only: [ :update, :destroy ]
+
+
+  # GET /folders
+  def index
+    folders = Folder.all
+    render json: FolderSerializer.new(folders).serializable_hash.to_json
+  end
+
+  # GET /my_folders
+  def my_folders
+    folders = current_user.folders
+    render json: FolderSerializer.new(folders).serializable_hash.to_json
+  end
+
+  # GET /folders/:id
+  def show
+    render json: FolderSerializer.new(folder).serializable_hash.to_json
+  end
+
+  # POST /folders
+  def create
+    folder = Folder.new(folder_params)
+    folder.user = current_user if user_signed_in?
+
+    if folder.save
+      render json: FolderSerializer.new(folder).serializable_hash.to_json, status: :created
+    else
+      render json: { errors: folder.errors.full_messages }, status: :unprocessable_entity
+    end
+  end
+
+  # PATCH /folders/:id
+  def update
+    if folder.update(folder_params)
+      render json: FolderSerializer.new(folder).serializable_hash.to_json
+    else
+      render json: { errors: folder.errors.full_messages }, status: :unprocessable_entity
+    end
+  end
+
+  # DELETE /folders/:id
+  def destroy
+    folder.destroy
+    head :no_content
+  end
+
+  private
+
+  def folder
+    @folder ||= Folder.find(params[:id])
+  end
+
+  def folder_params
+    params.require(:folder).permit(:name, :slug, sound_ids: [])
+  end
+
+  def authorize_user!
+    if folder.user.present? && folder.user != current_user
+      render json: { error: "Not authorized" }, status: :forbidden
+    end
+  end
+end

api/app/controllers/sounds_controller.rb

@@ -8,7 +8,6 @@ def index
   end
 
   def my_sounds
-    authenticate_user!
     sounds = current_user.sounds
     render json: SoundSerializer.new(sounds).serializable_hash.to_json
   end

api/app/models/folder.rb

@@ -0,0 +1,23 @@
+class Folder < ApplicationRecord
+  belongs_to :user, optional: true
+  has_and_belongs_to_many :sounds
+
+  before_validation :set_slug, on: [ :create, :update ]
+
+  validates :name, presence: true
+
+  private
+
+  def set_slug
+    base_slug = name.parameterize
+    candidate = base_slug
+    count = 2
+
+    while Folder.exists?(slug: candidate)
+      candidate = "#{base_slug}-#{count}"
+      count += 1
+    end
+
+    self.slug = candidate
+  end
+end

api/app/models/sound.rb

@@ -1,5 +1,6 @@
 class Sound < ApplicationRecord
   has_and_belongs_to_many :tags
+  has_and_belongs_to_many :folders
   has_one_attached :audio_file
   belongs_to :user, optional: true
 

api/app/models/user.rb

@@ -6,4 +6,5 @@ class User < ApplicationRecord
   validates :email, presence: true, uniqueness: true
   validates :username, presence: true, uniqueness: true
   has_many :sounds
+  has_many :folders
 end

api/app/serializers/folder_serializer.rb

@@ -0,0 +1,18 @@
+class FolderSerializer
+  include JSONAPI::Serializer
+  attributes :name, :slug
+
+  attribute :sounds do |object|
+    object.sounds.map do |sound|
+      {
+        id: sound.id,
+        name: sound.name,
+        user_id: sound.user_id,
+        color: sound.color,
+        emoji: sound.emoji,
+        audio_file_url: (Rails.application.routes.url_helpers.rails_blob_url(sound.audio_file, only_path: true) if sound.audio_file.attached?),
+        tags: sound.tags.map { |tag| { id: tag.id, name: tag.name, color: tag.color } }
+      }
+    end
+  end
+end

api/app/serializers/sound_serializer.rb

@@ -8,6 +8,6 @@ class SoundSerializer
     end
   end
   attribute :tags do |object|
-    object.tags.map { |tag| { id: tag.id, name: tag.name } }
+    object.tags.map { |tag| { id: tag.id, name: tag.name, color: tag.color } }
   end
 end

api/config/routes.rb

@@ -12,6 +12,8 @@
   get "my_sounds", to: "sounds#my_sounds"
 
   resources :tags
+  resources :folders
+  get "my_folders", to: "folders#my_folders"
   # Define your application routes per the DSL in https://guides.rubyonrails.org/routing.html
 
   # Reveal health status on /up that returns 200 if the app boots with no exceptions, otherwise 500.

api/db/migrate/20250728165756_create_folders_table.rb

@@ -0,0 +1,9 @@
+class CreateFoldersTable < ActiveRecord::Migration[8.0]
+  def change
+    create_table :folders do |t|
+      t.string :name, null: false
+      t.references :user, foreign_key: true, null: true
+      t.timestamps
+    end
+  end
+end

api/db/migrate/20250728165815_create_join_table_folders_sounds.rb

@@ -0,0 +1,10 @@
+class CreateJoinTableFoldersSounds < ActiveRecord::Migration[8.0]
+  def change
+    create_table :folders_sounds, id: false do |t|
+      t.references :folder, null: false, foreign_key: true
+      t.references :sound, null: false, foreign_key: true
+    end
+
+    add_index :folders_sounds, [ :folder_id, :sound_id ], unique: true
+  end
+end