E2442 Reimplement student task controller - backend

.ruby-version

@@ -1 +1 @@
-ruby-3.2.1
+3.2.1

Gemfile.lock

@@ -130,8 +130,12 @@ GEM
     nio4r (2.5.9)
     nokogiri (1.15.2-aarch64-linux)
       racc (~> 1.4)
+    nokogiri (1.15.2-arm64-darwin)
+      racc (~> 1.4)
     nokogiri (1.15.2-x64-mingw-ucrt)
       racc (~> 1.4)
+    nokogiri (1.15.2-x86_64-linux)
+      racc (~> 1.4)
     parallel (1.23.0)
     parser (3.2.2.3)
       ast (~> 2.4.1)
@@ -241,7 +245,9 @@ GEM
 
 PLATFORMS
   aarch64-linux
+  arm64-darwin-22
   x64-mingw-ucrt
+  x86_64-linux
 
 DEPENDENCIES
   bcrypt (~> 3.1.7)

app/controllers/api/v1/student_tasks_controller.rb

@@ -0,0 +1,25 @@
+class Api::V1::StudentTasksController < ApplicationController
+
+  # List retrieves all student tasks associated with the current logged-in user.
+  def list
+    # Retrieves all tasks that belong to the current user.
+    @student_tasks = StudentTask.from_user(current_user)
+    # Render the list of student tasks as JSON.
+    render json: @student_tasks
+  end
+
+  def show
+    render json: @student_task
+  end
+
+  # The view function retrieves a student task based on a participant's ID.
+  # It is meant to provide an endpoint where tasks can be queried based on participant ID.
+  def view
+    # Retrieves the student task where the participant's ID matches the provided parameter.
+    # This function will be used for clicking on a specific student task to "view" its details.
+    @student_task = StudentTask.from_participant_id(params[:id])
+    # Render the found student task as JSON.
+    render json: @student_task
+  end
+
+end

app/models/student_task.rb

@@ -0,0 +1,48 @@
+class StudentTask
+    attr_accessor :assignment, :current_stage, :participant, :stage_deadline, :topic, :permission_granted
+
+    # Initializes a new instance of the StudentTask class
+    def initialize(args)
+      @assignment = args[:assignment]
+      @current_stage = args[:current_stage]
+      @participant = args[:participant]
+      @stage_deadline = args[:stage_deadline]
+      @topic = args[:topic]
+      @permission_granted = args[:permission_granted]
+    end
+
+    # create a new StudentTask instance from a Participant object.cccccccc
+    def self.create_from_participant(participant)
+      new(
+        assignment: participant.assignment.name,                          # Name of the assignment associated with the student task
+        topic: participant.topic,                                         # Current stage of the assignment process
+        current_stage: participant.current_stage,                         # Participant object
+        stage_deadline: parse_stage_deadline(participant.stage_deadline), # Deadline for the current stage of the assignment
+        permission_granted: participant.permission_granted,               # Topic of the assignment
+        participant: participant                                          # Boolean indicating if Publishing Rights is enabled
+      )
+    end
+
+
+    # create an array of StudentTask instances for all participants linked to a user, sorted by deadline.
+    def self.from_user(user)
+      Participant.where(user_id: user.id)
+                 .map { |participant| StudentTask.create_from_participant(participant) }
+                 .sort_by(&:stage_deadline)
+    end
+
+    # create a StudentTask instance from a participant of the provided id
+    def self.from_participant_id(id)
+      create_from_participant(Participant.find_by(id: id))
+    end
+
+    private
+
+    # Parses a date string to a Time object, if parsing fails, set the time to be one year after current
+    def self.parse_stage_deadline(date_string)
+      Time.parse(date_string)
+    rescue StandardError
+      Time.now + 1.year
+    end
+
+end

config/environments/development.rb

@@ -17,6 +17,9 @@
   # Enable server timing
   config.server_timing = true
 
+  # Enable host requests for testing.
+  config.hosts << "www.example.com"
+
   # Enable/disable caching. By default caching is disabled.
   # Run rails dev:cache to toggle caching.
   if Rails.root.join('tmp/caching-dev.txt').exist?

config/routes.rb

@@ -23,6 +23,12 @@
         end
       end
       resources :assignments
+      resources :student_tasks do
+        collection do
+          get :list, action: :list
+          get :view
+        end
+      end
 
       resources :courses do
         collection do

db/addTestObjects.sql

@@ -0,0 +1,89 @@
+
+
+
+-- to start up app and SQL services on backedn
+
+rails terminal:
+docker compose up
+
+
+-- Not too sure what this is exactly for
+bundle install
+rake db:create
+rake db:migrate
+
+
+
+-- app service
+rails s -p 4000 -b '0.0.0.0'
+
+-- SQL service
+mysql -u dev -pexpertiza
+use reimplementation_development;
+
+
+-- Creating test objects in SQL
+
+
+
+-- Create roles
+INSERT INTO roles (name, created_at, updated_at) VALUES ('Student', NOW(), NOW());
+INSERT INTO roles (name, created_at, updated_at) VALUES ('Instructor', NOW(), NOW());
+
+
+-- Insert a user
+INSERT INTO users (
+  name,
+  password_digest,
+  full_name,
+  email,
+  role_id,
+  institution_id,
+  created_at,
+  updated_at
+) VALUES (
+  'testuser',
+  'password',
+  'Test User',
+  'testuser@example.com',
+  5,  -- Assuming 1 is the ID for the role
+  1,  -- Assuming 1 is the ID for the institution
+  NOW(),
+  NOW()
+);
+
+
+
+-- Insert an assignment
+INSERT INTO assignments (
+  name,
+  directory_path,
+  course_id,
+  instructor_id,
+  created_at,
+  updated_at
+) VALUES (
+  'Test Assignment',
+  '/path/to/assignment',
+  1,  -- Assuming 1 is a valid course_id
+  (SELECT id FROM users WHERE name = 'testuser'),  -- This selects the ID of the user you just inserted
+  NOW(),
+  NOW()
+);
+
+
+-- Created a new instructor, pretty sure the name field is full_name and there is also an password
+-- field and institution_id.
+-- Edited necesarry fields manually in RubyMine IDE
+
+INSERT INTO users (name, email, password_digest, created_at, updated_at, role_id)
+VALUES ('instructor_name', 'instructor_email', 'password_digest_here', NOW(), NOW(), (SELECT id FROM roles WHERE name = 'Instructor'));
+
+
+
+SELECT * FROM users WHERE full_name = 'Test Instructor';
+
+
+-- Inserting new test course
+INSERT INTO courses (name, instructor_id, institution_id, created_at, updated_at)
+VALUES ('Test Course', 3, 1, NOW(), NOW());

db/migrate/20240415155554_create_student_tasks.rb

@@ -0,0 +1,13 @@
+class CreateStudentTasks < ActiveRecord::Migration[7.0]
+  def change
+    create_table :student_tasks do |t|
+      t.references :assignment, null: false, foreign_key: true
+      t.string :current_stage
+      t.references :participant, null: false, foreign_key: true
+      t.datetime :stage_deadline
+      t.string :topic
+
+      t.timestamps
+    end
+  end
+end

db/migrate/20240415163413_add_columns_to_participants.rb

@@ -0,0 +1,7 @@
+class AddColumnsToParticipants < ActiveRecord::Migration[7.0]
+  def change
+    add_column :participants, :topic, :string
+    add_column :participants, :current_stage, :string
+    add_column :participants, :stage_deadline, :datetime
+  end
+end

db/migrate/20240415192048_drop_student_task_tabkle.rb

@@ -0,0 +1,5 @@
+class DropStudentTaskTabkle < ActiveRecord::Migration[7.0]
+  def change
+    drop_table :student_tasks
+  end
+end

db/migrate/20240418183335_add_permission_granted_to_participants.rb

@@ -0,0 +1,5 @@
+class AddPermissionGrantedToParticipants < ActiveRecord::Migration[7.0]
+  def change
+    add_column :participants, :permission_granted, :boolean, default: false
+  end
+end