Merge pull request #85 from MatsMoll/develop

Adding hints and other minor changes

Public/.well-known/apple-app-site-association

@@ -8,5 +8,7 @@
       }
     ]
   },
-  "webcredentials": ["M276UPEHPQ.no.mem.kognita.Kognita"]
+  "webcredentials": { 
+    "apps": ["M276UPEHPQ.no.mem.kognita.Kognita"] 
+  }
 }

Public/assets/js/flash-card/submit-performance.js

@@ -193,8 +193,62 @@ function estimatedScore(shouldSetScore) {
         $("#estimate-spinner").addClass("d-none");
         $("#answer-estimate").text(text);
         $("#answer-estimate").removeClass("d-none");
+        let improvements = json["improvements"];
+        if (improvements.lenght != 0) {
+            $("#estimated-score-card .card-body").append("<br>Kanskje nevn noe mer om dette?<ul>")
+        }
+        console.log(improvements);
+        for (const index in improvements) {
+            $("#estimated-score-card .card-body").append("<li>" + improvements[index]["word"] + "</li>");
+        }
+        if (improvements.lenght != 0) {
+            $("#estimated-score-card .card-body").append("</ul>")
+        }
     })
     .catch(function (error) {
         console.log(error)
     })
+}
+
+var hints = []
+var hintIndex = 0;
+
+function loadHints() {
+    if (hints.length > 0 && hintIndex < hints.length) {
+        revealHint();
+        return
+    } else if (hintIndex > 0) { 
+        return 
+    }
+    let url = "/api/practice-sessions/" + sessionID() + "/tasks/" + taskIndex() + "/estimate";
+
+    fetch(url, {
+        method: "POST",
+        headers: {
+            "Accept": "application/json, text/plain, */*",
+            "Content-Type" : "application/json"
+        },
+        body: answerJsonData("3")
+    })
+    .then(function (response) {
+        if (response.ok) {
+            return response.json();
+        } else {
+            throw new Error(response.statusText);
+        }
+    })
+    .then(function (json) {
+        hints = json["improvements"];
+        revealHint();
+    })
+    .catch(function (error) {
+        console.log(error)
+    })
+}
+
+function revealHint() {
+    if ($('#hint-card').length == 0) {
+        $("<div class='card'><div class='card-body' id='hint-card'></div></div>").hide().appendTo("#main-task-content .col-lg-7").fadeIn();
+    }
+    $("<div id='#hint-" + hintIndex + "'><h6>Hint nr: " + (hintIndex + 1) + "</h6><p class='text-dark'>" + hints[hintIndex++]["word"] + "</p></div>").hide().appendTo("#hint-card").fadeIn();
 }

Public/assets/js/practice-session-create.js

@@ -30,13 +30,13 @@ function startPracticeSessionWithTopicIDs(topicIds, subjectId, useTypingTasks =
     })
 }
 
-function startPracticeSessionWithSubtopicIDs(subtopicIDs, subjectId) {
-
-    let taskGoal = 10;
+function startPracticeSessionWithSubtopicIDs(subtopicIDs, subjectId, useTypingTasks = true, useMultipleChoiceTasks = true, taskGoal = 5) {
 
     let data = JSON.stringify({
         "subtopicsIDs" : subtopicIDs,
         "numberOfTaskGoal" : taskGoal,
+        "useTypingTasks" : useTypingTasks,
+        "useMultipleChoiceTasks" : useMultipleChoiceTasks
     });
 
     let url = "/api/subjects/" + subjectId + "/practice-sessions/start";

Sources/App/Subject/SubjectWebController.swift

@@ -20,6 +20,7 @@ final class SubjectWebController: RouteCollection {
     func boot(routes: RoutesBuilder) throws {
 
         routes.get("subjects", use: listAll)
+        routes.get("subjects", "search", use: search(on:))
         routes.get("subjects", "create", use: createSubject)
 
         let subject = routes.grouped("subjects", Subject.parameter)
@@ -29,13 +30,25 @@ final class SubjectWebController: RouteCollection {
         subject.get("compendium", use: compendium)
     }
 
+    func search(on req: Request) throws -> EventLoopFuture<View> {
+
+        let query = try req.query.decode(Subject.ListOverview.SearchQuery.self)
+
+        return try req.repositories.subjectRepository
+            .allSubjects(for: req.auth.require(), searchQuery: query)
+            .map(Subject.Templates.ListComponent.Context.init(subjects: ))
+            .flatMap { context in
+                Subject.Templates.ListComponent().render(with: context, for: req)
+            }
+    }
+
     func listAll(_ req: Request) throws -> EventLoopFuture<Response> {
 
         let user = try req.auth.require(User.self)
         let query = try? req.query.decode(ListAllQuery.self)
 
         return try req.controllers.taskDiscussionResponseController
-            .setRecentlyVisited(on: req) // FIXME: -- Rename
+            .setRecentlyVisited(on: req) // FIXME: Rename
             .failableFlatMap { activeDiscussion in
 
                 try req.controllers.subjectController

Sources/App/configure.swift

@@ -17,14 +17,15 @@ public func configure(_ app: Application) throws {
         fatalError("Need to set a ROOT_URL")
     }
 
+    // Catches errors and converts to HTTP responses for developers
+    app.middleware.use(ErrorMiddleware.default(environment: app.environment))
+    // After ErrorMiddleware in order to not konvert error into html
+    app.middleware.use(HTMLKitErrorMiddleware<Pages.NotFoundError, Pages.ServerError>(ignorePath: "/api"))
+
     if app.environment != .production {
-        // Catches errors and converts to HTTP responses for developers
-        app.middleware.use(ErrorMiddleware.default(environment: app.environment))
         app.logger.logLevel = .debug
-    } else {
-        // Catches errors and converts to HTTP responses for users
-        app.middleware.use(HTMLKitErrorMiddleware<Pages.NotFoundError, Pages.ServerError>())
     }
+
     app.htmlkit.localizationPath = app.directory.workingDirectory + "Resources/Localization"
     app.htmlkit.defaultLocale = "nb"
 
@@ -33,8 +34,8 @@ public func configure(_ app: Application) throws {
 //    try renderer.registerLocalization(atPath: path, defaultLocale: "nb")
 //    renderer.timeZone = TimeZone(identifier: "CET") ?? .current
 
-    app.verifyEmailRenderer.use { VerifyEmailRenderer.init(renderer: $0.htmlkit) }
-    app.resetPasswordRenderer.use { ResetPasswordMailRenderer.init(renderer: $0.htmlkit) }
+    app.verifyEmailRenderer.use { VerifyEmailRenderer(renderer: $0.htmlkit) }
+    app.resetPasswordRenderer.use { ResetPasswordMailRenderer(renderer: $0.htmlkit) }
 
     try routes(app)
 }
@@ -72,13 +73,19 @@ struct VerifyEmailRenderer: VerifyEmailRenderable {
 }
 
 /// Captures all errors and transforms them into an internal server error.
-public final class HTMLKitErrorMiddleware<F: HTMLPage, S: HTMLPage>: Middleware {
+public struct HTMLKitErrorMiddleware<F: HTMLPage, S: HTMLPage>: Middleware {
+
+    let ignorePath: String
 
     /// Create a new ErrorMiddleware for the supplied pages.
-    public init(notFoundPage: F.Type, serverErrorTemplate: S.Type) {}
+    public init(notFoundPage: F.Type, serverErrorTemplate: S.Type, ignorePath: String) {
+        self.ignorePath = ignorePath
+    }
 
     /// Create a new ErrorMiddleware
-    public init() {}
+    public init(ignorePath: String) {
+        self.ignorePath = ignorePath
+    }
 
     /// See `Middleware.respond`
     public func respond(to req: Request, chainingTo next: Responder) -> EventLoopFuture<Response> {
@@ -89,11 +96,18 @@ public final class HTMLKitErrorMiddleware<F: HTMLPage, S: HTMLPage>: Middleware
                 return res.encodeResponse(for: req)
             }
         }.flatMapError { error in
-            switch error {
-            case let abort as AbortError:
-                return self.handleError(for: req, status: abort.status)
-            default:
-                return self.handleError(for: req, status: .internalServerError)
+            do {
+                guard req.url.path.hasPrefix(ignorePath) == false else {
+                    throw error
+                }
+                switch error {
+                case let abort as AbortError:
+                    return self.handleError(for: req, status: abort.status)
+                default:
+                    return self.handleError(for: req, status: .internalServerError)
+                }
+            } catch {
+                return req.eventLoop.future(error: error)
             }
         }
     }

set-xcodeproj-env.py

@@ -2,35 +2,33 @@
 import getpass
 from pbxproj import XcodeProject
 import sys
+import os
 
 file = "Kognita.xcodeproj/xcshareddata/xcschemes/Run.xcscheme"
 
 tree = ETree.parse(file)
 
+def environmentVariable(name, value, etree, is_enabled=True):
+  key = ETree.SubElement(etree, "EnvironmentVariable")
+  key.attrib["key"] = name
+  key.attrib["value"] = value
+  if is_enabled:
+    key.attrib["isEnabled"] = "YES"
+
 # Adding Env variables
-env_var_section = ETree.SubElement(tree.getroot().find("LaunchAction"), "EnvironmentVariables")
-mailgun_key = ETree.SubElement(env_var_section, "EnvironmentVariable")
-mailgun_key.attrib["key"] = "MAILGUN_KEY"
-mailgun_key.attrib["value"] = "dd"
-mailgun_key.attrib["isEnabled"] = "YES"
-mailgun_domain = ETree.SubElement(env_var_section, "EnvironmentVariable")
-mailgun_domain.attrib["key"] = "MAILGUN_DOMAIN"
-mailgun_domain.attrib["value"] = "dd"
-mailgun_domain.attrib["isEnabled"] = "YES"
-database_user = ETree.SubElement(env_var_section, "EnvironmentVariable")
-database_user.attrib["key"] = "DATABASE_USER"
-database_user.attrib["value"] = getpass.getuser()
-database_user.attrib["isEnabled"] = "YES"
-
-text_client_url = ETree.SubElement(env_var_section, "EnvironmentVariable")
-text_client_url.attrib["key"] = "TEXT_CLIENT_BASE_URL"
-text_client_url.attrib["value"] = "http://127.0.0.1:5000/"
-text_client_url.attrib["isEnabled"] = "YES"
-
-root_url = ETree.SubElement(env_var_section, "EnvironmentVariable")
-root_url.attrib["key"] = "ROOT_URL"
-root_url.attrib["value"] = "http://localhost:8080"
-root_url.attrib["isEnabled"] = "YES"
+launchAction = tree.getroot().find("LaunchAction")
+launchAction.set("useCustomWorkingDirectory", "YES")
+launchAction.set("customWorkingDirectory", os.getcwd())
+
+env_var_section = ETree.SubElement(launchAction, "EnvironmentVariables")
+
+environmentVariable("MAILGUN_KEY", "dd", env_var_section)
+environmentVariable("MAILGUN_DOMAIN", "dd", env_var_section)
+environmentVariable("DATABASE_USER", getpass.getuser(), env_var_section)
+environmentVariable("TEXT_CLIENT_BASE_URL", "127.0.0.1", env_var_section)
+environmentVariable("TEXT_CLIENT_PORT", "5000", env_var_section)
+environmentVariable("TEXT_CLIENT_SCHEME", "http", env_var_section)
+environmentVariable("ROOT_URL", "http://localhost:8080", env_var_section)
 
 tree.write(file)