Return submitted count with lessons list if user is teacher or owner (#624)

## Status

- Closes _add issue numbers or delete_
- Related to _add issue numbers or delete_

## Points for consideration:

- Security
- Performance

## What's changed?

_Description of what's been done - bullets are often best_

## Steps to perform after deploying to production

_If the production environment requires any extra work after this PR has
been deployed detail it here. This could be running a Rake task, a
migration, or upgrading a Gem. That kind of thing._

Author: loiswells97

app/controllers/api/lessons_controller.rb

@@ -10,11 +10,16 @@ def index
       archive_scope = params[:include_archived] == 'true' ? Lesson : Lesson.unarchived
       scope = params[:school_class_id] ? archive_scope.where(school_class_id: params[:school_class_id]) : archive_scope
       ordered_scope = scope.order(created_at: :asc)
+
       accessible_lessons = ordered_scope.accessible_by(current_ability)
-      lessons_with_users = accessible_lessons.with_users
-      remixes = user_remixes(accessible_lessons)
-      @lessons_with_users_and_remixes = lessons_with_users.zip(remixes)
-      render :index, formats: [:json], status: :ok
+      @lessons_with_users = accessible_lessons.with_users
+      if current_user&.school_teacher?(school) || current_user&.school_owner?(school)
+        render :teacher_index, formats: [:json], status: :ok
+      else
+        remixes = user_remixes(accessible_lessons)
+        @lessons_with_users_and_remixes = @lessons_with_users.zip(remixes)
+        render :student_index, formats: [:json], status: :ok
+      end
     end
 
     def show
@@ -121,7 +126,7 @@ def school_owner?
     end
 
     def school
-      @school ||= @lesson&.school || School.find_by(id: base_params[:school_id])
+      @school ||= @lesson&.school || School.find_by(id: base_params[:school_id]) || SchoolClass.find_by(id: params[:school_class_id])&.school
     end
   end
 end

app/models/lesson.rb

@@ -52,6 +52,12 @@ def unarchive!
     save!(validate: false)
   end
 
+  def submitted_count
+    return 0 unless project
+
+    project.remixes.count { |remix| remix.school_project&.submitted? }
+  end
+
   private
 
   def assign_school_from_school_class

app/views/api/lessons/_lesson.json.jbuilder

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+json.call(
+  lesson,
+  :id,
+  :school_id,
+  :school_class_id,
+  :copied_from_id,
+  :user_id,
+  :name,
+  :description,
+  :visibility,
+  :due_date,
+  :archived_at,
+  :created_at,
+  :updated_at
+)
+
+if lesson.project
+  json.project(
+    lesson.project,
+    :identifier,
+    :project_type
+  )
+end
+
+json.user_name(user&.name)

app/views/api/lessons/index.json.jbuilder

@@ -2,28 +2,4 @@
 
 lesson, user = @lesson_with_user
 
-json.call(
-  lesson,
-  :id,
-  :school_id,
-  :school_class_id,
-  :copied_from_id,
-  :user_id,
-  :name,
-  :description,
-  :visibility,
-  :due_date,
-  :archived_at,
-  :created_at,
-  :updated_at
-)
-
-if lesson.project
-  json.project(
-    lesson.project,
-    :identifier,
-    :project_type
-  )
-end
-
-json.user_name(user&.name)
+json.partial! 'lesson', lesson:, user:

app/views/api/lessons/show.json.jbuilder

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+json.array!(@lessons_with_users_and_remixes) do |lesson_with_user, remix|
+  lesson, user = lesson_with_user
+  json.partial! 'lesson', lesson: lesson, user: user
+  json.remix_identifier(remix.identifier) if remix.present?
+end

app/views/api/lessons/student_index.json.jbuilder

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+json.array!(@lessons_with_users) do |lesson, user|
+  json.partial! 'lesson', lesson: lesson, user: user
+  json.submitted_count(lesson.submitted_count)
+end

app/views/api/lessons/teacher_index.json.jbuilder

@@ -13,9 +13,9 @@
     project factory: %i[project]
 
     after(:build) do |lesson, evaluator|
-      lesson.project.user_id = lesson.user_id
-      lesson.project.name = evaluator.project_name
-      lesson.project.identifier = "#{lesson.name.parameterize}-#{lesson.user_id}"
+      lesson.project&.user_id = lesson.user_id
+      lesson.project&.name = evaluator.project_name
+      lesson.project&.identifier = "#{lesson.name.parameterize}-#{lesson.user_id}"
     end
 
     trait :with_project_components do

spec/factories/lesson.rb

@@ -12,6 +12,7 @@
   let!(:lesson) { create(:lesson, name: 'Test Lesson', visibility: 'public', user_id: teacher.id) }
   let(:teacher) { create(:teacher, school:, name: 'School Teacher') }
   let(:owner) { create(:owner, school:) }
+  let(:student) { create(:student, school:) }
   let(:school) { create(:school) }
   let(:school_class) { create(:school_class, teacher_ids: [teacher.id], school:) }
   let(:another_school_class) { create(:school_class, teacher_ids: [teacher.id], school:) }
@@ -119,6 +120,17 @@
     expect(data.size).to eq(1)
   end
 
+  it 'includes the submitted_count for each lesson' do
+    lesson.update!(school_class_id: school_class.id)
+    remix = create(:project, school:, remixed_from_id: lesson.project.id, user_id: student.id)
+    remix.school_project.transition_status_to!(:submitted, student.id)
+
+    get("/api/lessons?school_class_id=#{school_class.id}", headers:)
+    data = JSON.parse(response.body, symbolize_names: true)
+
+    expect(data.first[:submitted_count]).to eq(1)
+  end
+
   context "when the lesson's visibility is 'private'" do
     let!(:lesson) { create(:lesson, name: 'Test Lesson', visibility: 'private') }
     let(:owner) { create(:owner, school:) }
@@ -172,7 +184,6 @@
     end
 
     it 'does not include the lesson when the user is a school-student' do
-      student = create(:student, school:)
       authenticated_in_hydra_as(student)
 
       get('/api/lessons', headers:)
@@ -200,7 +211,6 @@
     end
 
     it "includes the lesson when the user is a school-student within the lesson's class" do
-      student = create(:student, school:)
       authenticated_in_hydra_as(student)
       create(:class_student, school_class:, student_id: student.id)
 
@@ -210,6 +220,15 @@
       expect(data.size).to eq(1)
     end
 
+    it 'does not include the submitted_count when the user is a school-student within the lesson\'s class' do
+      authenticated_in_hydra_as(student)
+      create(:class_student, school_class:, student_id: student.id)
+
+      get('/api/lessons', headers:)
+      data = JSON.parse(response.body, symbolize_names: true)
+      expect(data.first).not_to have_key(:submitted_count)
+    end
+
     it "includes the remix identifier when the user has remixed the lesson's project" do
       student = create(:student, school:)
       authenticated_in_hydra_as(student)
@@ -222,7 +241,6 @@
     end
 
     it "does not include the lesson when the user is not a school-student within the lesson's class" do
-      student = create(:student, school:)
       authenticated_in_hydra_as(student)
 
       get('/api/lessons', headers:)

spec/features/lesson/listing_lessons_spec.rb

@@ -287,4 +287,26 @@
       expect(lesson.archived?).to be(false)
     end
   end
+
+  describe '#submitted_count' do
+    it 'returns 0 if there is no project' do
+      lesson = create(:lesson, project: nil)
+      expect(lesson.submitted_count).to eq(0)
+    end
+
+    it 'returns the count of submitted remixes of the lesson project' do
+      student = create(:student, school:)
+      lesson = create(:lesson, school:, user_id: teacher.id)
+
+      remix_1 = create(:project, school:, remixed_from_id: lesson.project.id, user_id: student.id)
+      remix_1.school_project.transition_status_to!(:submitted, remix_1.user_id)
+
+      remix_2 = create(:project, school:, remixed_from_id: lesson.project.id, user_id: student.id)
+      remix_2.school_project.transition_status_to!(:submitted, remix_2.user_id)
+
+      create(:project, school:, remixed_from_id: lesson.project.id, user_id: student.id) # Not submitted
+
+      expect(lesson.submitted_count).to eq(2)
+    end
+  end
 end