ProjectStartupApp.m

classdef ProjectStartupApp < matlab.apps.AppBase

    % Properties that correspond to app components
    properties (Access = public)
        StartUpAppUIFigure  matlab.ui.Figure
        TabGroup            matlab.ui.container.TabGroup
        WelcomeTab          matlab.ui.container.Tab
        Image               matlab.ui.control.Image
        READMEButton        matlab.ui.control.Button
        ReviewUsButton      matlab.ui.control.Button
        MainMenuButton      matlab.ui.control.Button
        WelcomeTitle        matlab.ui.control.Label
        TabReview           matlab.ui.container.Tab
        OtherButton         matlab.ui.control.Button
        StudentButton       matlab.ui.control.Button
        FacultyButton       matlab.ui.control.Button
        Q1                  matlab.ui.control.Label
        ReviewTitle         matlab.ui.control.Label
        ReviewText          matlab.ui.control.Label
    end

    
    properties (Access = private)
        GitHubOrganization = "MathWorks-Teaching-Resources"; % Description
        GitHubRepository = "Programming-Structuring-Code";
    end
%% How to customize the app?    
%{
    
    This StartUp app is designed to be customized to your module. It
    requires a minimum number of customization:
    
    1. Change "Module Template" in app.WelcomeTitle by your module name
    2. Change "Module Template" in app.ReviewTitle by your module name
    3. Change the GitHubRepository (line 25) to the correct value
    4. Change image in app.Image by the cover image you would like for your
       module. This image should be located in rootFolder/Images
    5. Create your MS Form:
        a. Make a copy of the Faculty and the Student Template surveys
        b. Customize the name of the survey to match the name of your
           survey
        c. Click on "Collect responses", select "Anyone can respond" and
        copy the form link to SetupAppLinks (see step 6).
    5. Create your MS Sway:
        a. Go to MS Sway
        b. Create a blank sway
        c. Add the name of your module to the title box
        d. Click "Share", Select "Anyone with a link", Select "View"
        e. Copy the sway link to SetupAppLinks (see step 6).
    6. Add the Survey and Sway link to Utilities/SurveyLinks using
    SetupAppLinks.mlx in InternalFiles/RequiredFunctions/StartUpFcn
    7. Save > Export to .m file and save the result as
    Utilities/ProjectStartupApp.m

%}

    methods (Access = private, Static)

        function pingSway(app)
            try
                if ~ispref("MCCTEAM")
                    load Utilities\SurveyLinks.mat SwayLink
                    webread(SwayLink);
                end
            catch
            end
        end
        
        function openStudentForm(app)
            try
                load Utilities\SurveyLinks.mat StudentFormLink
                web(StudentFormLink);
            catch
            end
        end

        function openFacultyForm(app)
            try
                load Utilities\SurveyLinks.mat FacultyFormLink
                web(FacultyFormLink);
            catch
            end
        end

        function saveSettings(isReviewed,numLoad)
            try
                save(fullfile("Utilities","ProjectSettings.mat"),"isReviewed","numLoad");
            catch
            end
        end

    end
    

    % Callbacks that handle component events
    methods (Access = private)

        % Code that executes after component creation
        function startupFcn(app)

            % Switch tab to review if has not been reviewed yet
            if isfile(fullfile("Utilities","ProjectSettings.mat"))
                load(fullfile("Utilities","ProjectSettings.mat"),"isReviewed","numLoad");
                numLoad = numLoad + 1; % Increment counter
            else
                isReviewed = false;
                numLoad = 1; % Initialize counter
            end

            % Switch tab for review
            if ~isReviewed && numLoad > 2
                isReviewed = true;
                app.TabGroup.SelectedTab = app.TabReview;
            end

            % Save new settings
            app.saveSettings(isReviewed,numLoad)

            % Download links to survey (should only work when module goes
            % public on GitHub)
            try
                import matlab.net.*
                import matlab.net.http.*
                
                Request = RequestMessage;
                Request.Method = 'GET';
                Address = URI("http://api.github.com/repos/"+app.GitHubOrganization+...
                    "/"+app.GitHubRepository+"/contents/Utilities/SurveyLinks.mat");
                Request.Header    = HeaderField("X-GitHub-Api-Version","2022-11-28");
                Request.Header(2) = HeaderField("Accept","application/vnd.github+json");
                [Answer,~,~] = send(Request,Address);
                websave(fullfile("Utilities/SurveyLinks.mat"),Answer.Body.Data.download_url);
            catch
            end

        end

        % Close request function: StartUpAppUIFigure
        function StartUpAppUIFigureCloseRequest(app, event)
            if event.Source == app.READMEButton
                open README.mlx
            elseif event.Source == app.MainMenuButton
                open MainMenu.mlx
            elseif event.Source == app.FacultyButton
                open MainMenu.mlx            
            elseif event.Source == app.StudentButton
                open MainMenu.mlx
            elseif event.Source == app.OtherButton
                open MainMenu.mlx
            else
                disp("Thank you for your time.")
            end
            delete(app)
        end

        % Button pushed function: MainMenuButton
        function MainMenuButtonPushed(app, event)
            StartUpAppUIFigureCloseRequest(app,event)
        end

        % Button pushed function: FacultyButton
        function FacultyButtonPushed(app, event)
            app.pingSway;
            app.openFacultyForm;
            StartUpAppUIFigureCloseRequest(app,event)
        end

        % Button pushed function: StudentButton
        function StudentButtonPushed(app, event)
            app.pingSway;
            app.openStudentForm;
            StartUpAppUIFigureCloseRequest(app,event)
        end

        % Button pushed function: OtherButton
        function OtherButtonPushed(app, event)
            app.pingSway;
            app.openStudentForm;
            StartUpAppUIFigureCloseRequest(app,event)
        end

        % Button pushed function: ReviewUsButton
        function ReviewUsButtonPushed(app, event)
            app.TabGroup.SelectedTab = app.TabReview;
        end

        % Button pushed function: READMEButton
        function READMEButtonPushed(app, event)
            StartUpAppUIFigureCloseRequest(app,event)
        end
    end

    % Component initialization
    methods (Access = private)

        % Create UIFigure and components
        function createComponents(app)

            % Create StartUpAppUIFigure and hide until all components are created
            app.StartUpAppUIFigure = uifigure('Visible', 'off');
            app.StartUpAppUIFigure.AutoResizeChildren = 'off';
            app.StartUpAppUIFigure.Position = [100 100 276 430];
            app.StartUpAppUIFigure.Name = 'StartUp App';
            app.StartUpAppUIFigure.Resize = 'off';
            app.StartUpAppUIFigure.CloseRequestFcn = createCallbackFcn(app, @StartUpAppUIFigureCloseRequest, true);

            % Create TabGroup
            app.TabGroup = uitabgroup(app.StartUpAppUIFigure);
            app.TabGroup.AutoResizeChildren = 'off';
            app.TabGroup.Position = [1 1 276 460];

            % Create WelcomeTab
            app.WelcomeTab = uitab(app.TabGroup);
            app.WelcomeTab.AutoResizeChildren = 'off';
            app.WelcomeTab.Title = 'Tab';

            % Create WelcomeTitle
            app.WelcomeTitle = uilabel(app.WelcomeTab);
            app.WelcomeTitle.HorizontalAlignment = 'center';
            app.WelcomeTitle.VerticalAlignment = 'top';
            app.WelcomeTitle.WordWrap = 'on';
            app.WelcomeTitle.FontSize = 24;
            app.WelcomeTitle.FontWeight = 'bold';
            app.WelcomeTitle.Position = [2 349 274 70];
            app.WelcomeTitle.Text = 'Programming: Structuring Code';

            % Create MainMenuButton
            app.MainMenuButton = uibutton(app.WelcomeTab, 'push');
            app.MainMenuButton.ButtonPushedFcn = createCallbackFcn(app, @MainMenuButtonPushed, true);
            app.MainMenuButton.FontSize = 18;
            app.MainMenuButton.Position = [59 96 161 35];
            app.MainMenuButton.Text = 'Main Menu';

            % Create ReviewUsButton
            app.ReviewUsButton = uibutton(app.WelcomeTab, 'push');
            app.ReviewUsButton.ButtonPushedFcn = createCallbackFcn(app, @ReviewUsButtonPushed, true);
            app.ReviewUsButton.FontSize = 18;
            app.ReviewUsButton.Position = [59 10 161 35];
            app.ReviewUsButton.Text = 'Review Us';

            % Create READMEButton
            app.READMEButton = uibutton(app.WelcomeTab, 'push');
            app.READMEButton.ButtonPushedFcn = createCallbackFcn(app, @READMEButtonPushed, true);
            app.READMEButton.FontSize = 18;
            app.READMEButton.Position = [59 53 161 35];
            app.READMEButton.Text = 'README';

            % Create Image
            app.Image = uiimage(app.WelcomeTab);
            app.Image.Position = [16 141 245 209];
            app.Image.ImageSource = 'TurkeysColor.png';

            % Create TabReview
            app.TabReview = uitab(app.TabGroup);
            app.TabReview.AutoResizeChildren = 'off';
            app.TabReview.Title = 'Tab2';
            app.TabReview.HandleVisibility = 'off';

            % Create ReviewText
            app.ReviewText = uilabel(app.TabReview);
            app.ReviewText.HorizontalAlignment = 'center';
            app.ReviewText.VerticalAlignment = 'top';
            app.ReviewText.WordWrap = 'on';
            app.ReviewText.FontSize = 18;
            app.ReviewText.Position = [16 243 245 69];
            app.ReviewText.Text = 'Please help us improve your experience by answering a few questions.';

            % Create ReviewTitle
            app.ReviewTitle = uilabel(app.TabReview);
            app.ReviewTitle.HorizontalAlignment = 'center';
            app.ReviewTitle.VerticalAlignment = 'top';
            app.ReviewTitle.WordWrap = 'on';
            app.ReviewTitle.FontSize = 24;
            app.ReviewTitle.FontWeight = 'bold';
            app.ReviewTitle.Position = [2 326 274 93];
            app.ReviewTitle.Text = 'Programming: Structuring Code';

            % Create Q1
            app.Q1 = uilabel(app.TabReview);
            app.Q1.HorizontalAlignment = 'center';
            app.Q1.VerticalAlignment = 'top';
            app.Q1.WordWrap = 'on';
            app.Q1.FontSize = 18;
            app.Q1.FontWeight = 'bold';
            app.Q1.Position = [16 141 245 69];
            app.Q1.Text = 'What describes you best?';

            % Create FacultyButton
            app.FacultyButton = uibutton(app.TabReview, 'push');
            app.FacultyButton.ButtonPushedFcn = createCallbackFcn(app, @FacultyButtonPushed, true);
            app.FacultyButton.FontSize = 18;
            app.FacultyButton.Position = [64 127 150 40];
            app.FacultyButton.Text = 'Faculty';

            % Create StudentButton
            app.StudentButton = uibutton(app.TabReview, 'push');
            app.StudentButton.ButtonPushedFcn = createCallbackFcn(app, @StudentButtonPushed, true);
            app.StudentButton.FontSize = 18;
            app.StudentButton.Position = [64 80 150 40];
            app.StudentButton.Text = 'Student';

            % Create OtherButton
            app.OtherButton = uibutton(app.TabReview, 'push');
            app.OtherButton.ButtonPushedFcn = createCallbackFcn(app, @OtherButtonPushed, true);
            app.OtherButton.FontSize = 18;
            app.OtherButton.Position = [64 34 150 40];
            app.OtherButton.Text = 'Other';

            % Show the figure after all components are created
            app.StartUpAppUIFigure.Visible = 'on';
        end
    end

    % App creation and deletion
    methods (Access = public)

        % Construct app
        function app = ProjectStartupApp

            % Create UIFigure and components
            createComponents(app)

            % Register the app with App Designer
            registerApp(app, app.StartUpAppUIFigure)

            % Execute the startup function
            runStartupFcn(app, @startupFcn)

            if nargout == 0
                clear app
            end
        end

        % Code that executes before app deletion
        function delete(app)

            % Delete UIFigure when app is deleted
            delete(app.StartUpAppUIFigure)
        end
    end
end