canvas-lms/spec/presenters/course_for_menu_presenter_spec.rb

# frozen_string_literal: true

#
# Copyright (C) 2015 - present Instructure, Inc.
#
# This file is part of Canvas.
#
# Canvas is free software: you can redistribute it and/or modify it under
# the terms of the GNU Affero General Public License as published by the Free
# Software Foundation, version 3 of the License.
#
# Canvas is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
# A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
# details.
#
# You should have received a copy of the GNU Affero General Public License along
# with this program. If not, see <http://www.gnu.org/licenses/>.
#

require_relative "../helpers/k5_common"

describe CourseForMenuPresenter do
  include K5Common

  let_once(:account) { Account.default }
  let_once(:course) { Course.create!(account:) }
  let_once(:user) { User.create! }

  let(:dashboard_card_tabs) { UsersController::DASHBOARD_CARD_TABS }

  let_once(:presenter) do
    CourseForMenuPresenter.new(course, user, account, nil, { tabs: dashboard_card_tabs })
  end

  describe "#to_h" do
    it "returns hash of info about course" do
      expect(presenter.to_h).to be_a Hash
    end

    it "shouldnt include tab links to unenrolled users" do
      expect(presenter.to_h[:links]).to be_empty
    end

    it "shows all the tab links to a teacher" do
      course.enroll_teacher(user).accept
      course.assignments.create!
      course.discussion_topics.create!
      course.announcements.create! title: "hear ye!", message: "wat"
      course.attachments.create! filename: "blah", uploaded_data: StringIO.new("blah")

      expect(presenter.to_h[:links]).to match_array([
                                                      a_hash_including({ css_class: "announcements", icon: "icon-announcement", label: "Announcements" }),
                                                      a_hash_including({ css_class: "discussions", icon: "icon-discussion", label: "Discussions" }),
                                                      a_hash_including({ css_class: "assignments", icon: "icon-assignment", label: "Assignments" }),
                                                      a_hash_including({ css_class: "files", icon: "icon-folder", label: "Files" })
                                                    ])
    end

    it "only shows the tabs a student has access to to students" do
      course.offer
      course.enroll_student(user).accept
      course.assignments.create!
      course.attachments.create! filename: "blah", uploaded_data: StringIO.new("blah")

      expect(presenter.to_h[:links]).to match_array([
                                                      a_hash_including({ css_class: "assignments", icon: "icon-assignment", label: "Assignments" }),
                                                      a_hash_including({ css_class: "files", icon: "icon-folder", label: "Files" }),
                                                      a_hash_including({ css_class: "discussions", icon: "icon-discussion", label: "Discussions" }),
                                                    ])
    end

    it "returns the course nickname if one is set" do
      user.set_preference(:course_nicknames, course.id, "nickname")
      cs_presenter = CourseForMenuPresenter.new(course, user, account)
      h = cs_presenter.to_h
      expect(h[:originalName]).to eq course.name
      expect(h[:shortName]).to eq "nickname"
    end

    it "sets isFavorited to true if course is favorited" do
      course.enroll_student(user)
      Favorite.create!(user:, context: course)
      cs_presenter = CourseForMenuPresenter.new(course, user, account)
      h = cs_presenter.to_h
      expect(h[:isFavorited]).to be true
    end

    it "sets isFavorited to false if course is unfavorited" do
      course.enroll_student(user)
      cs_presenter = CourseForMenuPresenter.new(course, user, account)
      h = cs_presenter.to_h
      expect(h[:isFavorited]).to be false
    end

    it "sets the published value" do
      cs_presenter = CourseForMenuPresenter.new(course, user, account)
      expect(cs_presenter.to_h).to have_key(:published)
    end

    it "sets additional keys" do
      cs_presenter = CourseForMenuPresenter.new(course, user, account)
      h = cs_presenter.to_h
      expect(h).to have_key(:published)
      expect(h).to have_key(:canChangeCoursePublishState)
      expect(h).to have_key(:defaultView)
      expect(h).to have_key(:pagesUrl)
      expect(h).to have_key(:frontPageTitle)
    end

    context "isK5Subject" do
      it "is set for k5 subjects" do
        toggle_k5_setting(course.account)
        h = CourseForMenuPresenter.new(course, user, account).to_h
        expect(h[:isK5Subject]).to be_truthy
      end

      it "is false for classic courses" do
        h = CourseForMenuPresenter.new(course, user, account).to_h
        expect(h[:isK5Subject]).to be_falsey
      end
    end

    context "useClassicFont" do
      before :once do
        @account = course.account
        toggle_k5_setting(@account)
      end

      it "is true when the course's account has use_classic_font?" do
        toggle_classic_font_setting(@account)
        h = CourseForMenuPresenter.new(course, user, account).to_h
        expect(h[:useClassicFont]).to be_truthy
      end

      it "is false if the course's account does not have use_classic_font?" do
        h = CourseForMenuPresenter.new(course, user, account).to_h
        expect(h[:useClassicFont]).to be_falsey
      end
    end

    context "with `homeroom_course` setting enabled" do
      before do
        course.update! homeroom_course: true
      end

      it "sets `isHomeroom` to `true`" do
        cs_presenter = CourseForMenuPresenter.new(course, user, account)
        h = cs_presenter.to_h
        expect(h[:isHomeroom]).to be true
      end
    end

    context "course color" do
      before do
        course.update! settings: course.settings.merge(course_color: "#789")
      end

      it "sets `color` to nil if the course is not associated with a K-5 account" do
        h = CourseForMenuPresenter.new(course, user, account).to_h
        expect(h[:color]).to be_nil
      end

      it "sets `color` if the course is associated with a K-5 account" do
        toggle_k5_setting(course.account)

        h = CourseForMenuPresenter.new(course, user, account).to_h
        expect(h[:color]).to eq "#789"
      end
    end

    context "Dashcard Reordering" do
      it "returns a position if one is set" do
        user.set_dashboard_positions(course.asset_string => 3)
        cs_presenter = CourseForMenuPresenter.new(course, user, account)
        h = cs_presenter.to_h
        expect(h[:position]).to eq 3
      end

      it "returns nil when no position is set" do
        cs_presenter = CourseForMenuPresenter.new(course, user, account)
        h = cs_presenter.to_h
        expect(h[:position]).to be_nil
      end
    end

    context "Using courses from a trusted account" do
      it "returns correct published value" do
        a2 = account_model(name: "second account")
        a2.trust_links.create!(managing_account: account)
        account.trust_links.create!(managing_account: a2)
        course2 = a2.courses.create!(name: "course02")

        cs_presenter = CourseForMenuPresenter.new(course2, user, account)
        h = cs_presenter.to_h
        expect(h).to have_key(:published)
      end
    end
  end
end