Text Exercise: Integrate the new Athena

CodeEditor/Package.swift

@@ -1,4 +1,4 @@
-// swift-tools-version:5.3
+// swift-tools-version:5.9
 
 import PackageDescription
 
@@ -7,18 +7,19 @@ let package = Package(
   name: "CodeEditor",
 
   platforms: [
-    .macOS(.v10_15), .iOS(.v13)
+    .iOS(.v17)
   ],
 
   products: [
     .library(name: "CodeEditor", targets: [ "CodeEditor" ])
   ],
 
   dependencies: [
-    .package(url: "https://github.com/raspu/Highlightr", from: "2.1.2")
+    .package(url: "https://github.com/raspu/Highlightr", from: "2.1.2"),
+    .package(url: "https://github.com/ls1intum/artemis-ios-core-modules", from: "7.0.0"),
   ],
 
   targets: [
-    .target(name: "CodeEditor", dependencies: [ "Highlightr" ])
+    .target(name: "CodeEditor", dependencies: [ "Highlightr", .product(name: "SharedModels", package: "artemis-ios-core-modules")])
   ]
 )

CodeEditor/Sources/CodeEditor/Models/Suggestion/FeedbackSuggestion.swift

@@ -0,0 +1,21 @@
+//
+//  FeedbackSuggestion.swift
+//  
+//
+//  Created by Tarlan Ismayilsoy on 29.08.23.
+//
+
+import Foundation
+import SharedModels
+
+public protocol FeedbackSuggestion: Equatable, Decodable {
+    var id: Int { get }
+    var exerciseId: Int { get }
+    var submissionId: Int { get }
+    var title: String { get }
+    var description: String { get }
+    var credits: Double { get }
+    var gradingInstruction: GradingInstruction? { get }
+
+    var associatedAssessmentFeedbackId: UUID? { get set } // not decoded
+}

CodeEditor/Sources/CodeEditor/Utils/FeedbackSuggestion.swift → CodeEditor/Sources/CodeEditor/Models/Suggestion/ProgrammingFeedbackSuggestion.swift

@@ -1,21 +1,36 @@
 //
-//  FeedbackSuggestion.swift
+//  ProgrammingFeedbackSuggestion.swift
 //  Themis
 //
 //  Created by Andreas Cselovszky on 25.01.23.
 //
 
 import Foundation
+import SharedModels
 
-public struct FeedbackSuggestion: Decodable, Equatable {
-    public let id = UUID()
-    public let exerciseId: Int
+public struct ProgrammingFeedbackSuggestion: FeedbackSuggestion, Decodable {
+
+    public var id: Int
+
+    public var exerciseId: Int
+
+    public var submissionId: Int
+
+    public var title: String
+
+    public var description: String
+
+    public var credits: Double
+
+    public var gradingInstruction: GradingInstruction?
+
+    public var associatedAssessmentFeedbackId: UUID?
+
+    // TODO: rename/remove the fields below once programming suggestions are integrated into Athena
     public let participationId: Int
     public let srcFile: String
     public let fromLine: Int
     public let toLine: Int
-    public let text: String
-    public let credits: Double
 
     enum DecodingKeys: String, CodingKey {
         case exercise_id
@@ -27,14 +42,18 @@ public struct FeedbackSuggestion: Decodable, Equatable {
         case credits
     }
 
+    // TODO: correct the decoding logic below once programming suggestions are integrated into Athena
     public init(from decoder: Decoder) throws {
         let values = try decoder.container(keyedBy: DecodingKeys.self)
+        id = Int.random(in: 1...999999)
         exerciseId = try values.decode(Int.self, forKey: .exercise_id)
+        submissionId = -1
+        title = "Suggestion"
         participationId = try values.decode(Int.self, forKey: .participation_id)
         srcFile = try values.decode(String.self, forKey: .src_file)
         fromLine = try values.decode(Int.self, forKey: .from_line)
         toLine = try values.decode(Int.self, forKey: .to_line)
-        text = try values.decode(String.self, forKey: .text)
+        description = try values.decode(String.self, forKey: .text)
         credits = try values.decode(Double.self, forKey: .credits)
     }
 

CodeEditor/Sources/CodeEditor/Models/Suggestion/TextFeedbackSuggestion.swift

@@ -0,0 +1,93 @@
+//
+//  TextFeedbackSuggestion.swift
+//  
+//
+//  Created by Tarlan Ismayilsoy on 29.08.23.
+//
+
+import Foundation
+import SharedModels
+
+public struct TextFeedbackSuggestion: FeedbackSuggestion {
+    public let id: Int
+
+    public let exerciseId: Int
+
+    public let submissionId: Int
+
+    public let title: String
+
+    public let description: String
+
+    public let credits: Double
+
+    public let gradingInstruction: GradingInstruction?
+
+    public var associatedAssessmentFeedbackId: UUID?
+
+    public let indexStart: Int?
+
+    public let indexEnd: Int?
+
+    public static func == (lhs: TextFeedbackSuggestion, rhs: TextFeedbackSuggestion) -> Bool {
+        lhs.id == rhs.id
+        && lhs.exerciseId == rhs.exerciseId
+        && lhs.submissionId == rhs.submissionId
+        && lhs.title == rhs.title
+        && lhs.description == rhs.description
+        && lhs.credits == rhs.credits
+    }
+
+    public var textBlockContent: String?
+
+    public var isReferenced: Bool {
+        indexStart != nil && indexEnd != nil
+    }
+
+    public var textBlock: TextBlock? {
+        guard isReferenced else {
+            return nil
+        }
+        return TextBlock(submissionId: submissionId, text: textBlockContent, startIndex: indexStart, endIndex: indexEnd)
+    }
+
+    public var feedback: Feedback {
+        // TODO: grading instruction support
+        return Feedback(text: Feedback.feedbackSuggestionAcceptedIdentifier + title,
+                        detailText: description,
+                        reference: textBlock?.id,
+                        credits: credits,
+                        type: isReferenced ? .MANUAL : .MANUAL_UNREFERENCED,
+                        positive: credits > 0)
+    }
+
+    public mutating func setTextBlockContent(from submission: TextSubmission) {
+        guard let indexStart,
+              let indexEnd,
+              let text = submission.text else {
+            return
+        }
+        let nsRange = (indexStart ..< indexEnd).toNSRange()
+        if let indexRange = Range(nsRange, in: text) {
+            textBlockContent = String(text[indexRange])
+        }
+    }
+}
+
+public extension Feedback {
+    static let feedbackSuggestionIdentifier = "FeedbackSuggestion:"
+    static let feedbackSuggestionAcceptedIdentifier = "FeedbackSuggestion:accepted:"
+    static let feedbackSuggestionAdaptedIdentifier = "FeedbackSuggestion:adapted:"
+
+    var isSuggested: Bool {
+        text?.hasPrefix(Self.feedbackSuggestionIdentifier) ?? false
+    }
+
+    var isSuggestedAndAccepted: Bool {
+        text?.hasPrefix(Self.feedbackSuggestionAcceptedIdentifier) ?? false
+    }
+
+    var isSuggestedAndAdapted: Bool {
+        text?.hasPrefix(Self.feedbackSuggestionAdaptedIdentifier) ?? false
+    }
+}

CodeEditor/Sources/CodeEditor/Models/TextBlockRef.swift

@@ -0,0 +1,25 @@
+//
+//  TextBlockRef.swift
+//  Themis
+//
+//  Created by Tarlan Ismayilsoy on 14.08.23.
+//
+
+import Foundation
+import SharedModels
+
+public struct TextBlockRef: Codable {
+    public var block: TextBlock
+    public var feedback: Feedback
+
+    public init(block: TextBlock, feedback: Feedback) {
+        self.block = block
+        self.feedback = feedback
+    }
+
+    private enum CodingKeys: String, CodingKey {
+        case block, feedback
+    }
+
+    public var associatedAssessmentFeedbackId: UUID? // not decoded
+}

CodeEditor/Sources/CodeEditor/RoundedCornerLayoutManager.swift

@@ -16,7 +16,7 @@
     let paraStyle = NSMutableParagraphStyle()
     var diffLines = [Int]()
     var isNewFile = false
-    var feedbackSuggestions = [FeedbackSuggestion]()
+    var feedbackSuggestions = [any FeedbackSuggestion]()
 
     override init() {
         super.init()
@@ -24,7 +24,7 @@
         self.paraStyle.alignment = .right
     }
 
     required init?(coder: NSCoder) {
         fatalError("This has not been implemented (no body cares anyhow)")
     }
 
@@ -61,13 +61,21 @@
         lineRect.origin.y += containerOrigin.y
 
         lineRect = lineRect.integral.insetBy(dx: 0.4, dy: 0.4)
-        /// The roundedReect is responsible for the round Corners
-        let path = UIBezierPath(roundedRect: lineRect, cornerRadius: height * 0.2)
-        path.fill()
+        if underlineVal == .thick {
+            lineRect.origin.y += height
+            lineRect.size.height = 1
+
+            let path = UIBezierPath(roundedRect: lineRect, cornerRadius: height * 0.2)
+            path.lineWidth = height * 0.1
+            path.stroke()
+        } else {
+            let path = UIBezierPath(roundedRect: lineRect, cornerRadius: height * 0.2)
+            path.fill()
+        }
     }
 
     private func numViewWidth() -> CGFloat {
         if !showsLineNumbers { return 0.0 }
         let maxNum = 4.0
 
         let fontAttributes = [NSAttributedString.Key.font: lineNumberFont]
@@ -95,7 +103,7 @@
             return paraNumber
         } else {
             let code = textStorage?.string ?? ""
             let ns = NSString(string: code)
             var paraNumber = lastParaNumber
             ns.enumerateSubstrings(in: NSRange(location: lastParaLocation, length: charRange.location - lastParaLocation),
                options: [.byParagraphs, .substringNotRequired]) { _, _, enclosingRange, stop in
@@ -110,7 +118,7 @@
         }
     }
 
     override func processEditing(for textStorage: NSTextStorage,
                                  edited editMask: NSTextStorage.EditActions,
                                  range newCharRange: NSRange, changeInLength delta: Int,
                                  invalidatedRange invalidatedCharRange: NSRange) {
@@ -124,13 +132,13 @@
 
     override func drawBackground(forGlyphRange glyphsToShow: NSRange, at origin: CGPoint) {
         super.drawBackground(forGlyphRange: glyphsToShow, at: origin)
         let atts: [NSAttributedString.Key: Any] = [.font: lineNumberFont,
                                                    .foregroundColor: lineNumberTextColor,
                                                    .paragraphStyle: paraStyle]
         var gutterRect = CGRect.zero
         var paraNumber = 0
         let ctx = UIGraphicsGetCurrentContext()
         guard let ctx else { return }
         UIGraphicsPushContext(ctx)
 
         enumerateLineFragments(forGlyphRange: glyphsToShow) { rect, _, _, glyphRange, _ in
@@ -148,12 +156,12 @@
                 }
             }
             self.drawDiffLines(paraNumber, rect, origin)
-            self.drawFeedbackSuggestions(paraNumber, rect, origin)
+            self.drawProgrammingFeedbackSuggestions(paraNumber, rect, origin)
         }
         UIGraphicsPopContext()
 
         if NSMaxRange(glyphsToShow) > numberOfGlyphs {
             let ln = String(format: "%ld", paraNumber + 2)
             let size = (ln as NSString).size(withAttributes: atts)
 
             gutterRect = gutterRect.offsetBy(dx: 0, dy: gutterRect.height)
@@ -178,7 +186,7 @@
 
     private func drawDiffLines(_ paraNumber: Int, _ rect: CGRect, _ origin: CGPoint) {
         let ctx = UIGraphicsGetCurrentContext()
         guard let ctx else { return }
         UIGraphicsPushContext(ctx)
         ctx.setFillColor(CGColor(red: 0, green: 0.9, blue: 0.1, alpha: 0.2))
         ctx.setStrokeColor(CGColor(red: 0, green: 0.9, blue: 0.1, alpha: 0.2))
@@ -190,13 +198,17 @@
         UIGraphicsPopContext()
     }
 
-    private func drawFeedbackSuggestions(_ paraNumber: Int, _ rect: CGRect, _ origin: CGPoint) {
+    private func drawProgrammingFeedbackSuggestions(_ paraNumber: Int, _ rect: CGRect, _ origin: CGPoint) {
         let ctx = UIGraphicsGetCurrentContext()
-        guard let ctx else { return }
+        guard let ctx else {
+            return
+        }
         UIGraphicsPushContext(ctx)
         ctx.setFillColor(CGColor(red: 0, green: 0.2, blue: 0.8, alpha: 0.8))
         ctx.setStrokeColor(CGColor(red: 0, green: 0.2, blue: 0.8, alpha: 0.8))
-        if self.feedbackSuggestions.contains(where: { paraNumber + 1 >= $0.fromLine && paraNumber + 1 <= $0.toLine }) {
+
+        let programmingSuggestions = feedbackSuggestions.compactMap({ $0 as? ProgrammingFeedbackSuggestion })
+        if programmingSuggestions.contains(where: { paraNumber + 1 >= $0.fromLine && paraNumber + 1 <= $0.toLine }) {
             let path = CGPath(
                 rect: CGRect(
                     x: rect.origin.x,

CodeEditor/Sources/CodeEditor/UXCodeTextView.swift

@@ -62,7 +62,7 @@
 
     var highlightedRanges: [HighlightedRange] = []
     var dragSelection: Range<Int>?
-    var feedbackSuggestions: [FeedbackSuggestion] = []
+    var feedbackSuggestions: [ProgrammingFeedbackSuggestion] = []
     var showsLineNumbers: Bool
 
     private var firstPoint: CGPoint?
@@ -409,7 +409,8 @@
         layoutManager.enumerateLineFragments(forGlyphRange: layoutManager.glyphRange(for: textContainer)) { rect, _, _, _, _ in
             let offset = self.calculateWrapOffsetOf(lineNumber)
             if let feedback = self.feedbackSuggestions.first(where: { $0.fromLine == lineNumber - offset }) {
-                if let lightbulb = self.buildLightbulbButton(rect: rect, feedbackId: feedback.id.uuidString) {
+                // TODO: get rid of the string interpolation once programming exercise suggestions are integrated into Athena
+                if let lightbulb = self.buildLightbulbButton(rect: rect, feedbackId: "\(feedback.id)") {
                     self.lightBulbs.append(lightbulb)
                     self.addSubview(lightbulb)
                 }
@@ -446,12 +447,7 @@
                 guard text.hasRange(hRange.range) else {
                     continue
                 }
-                self.textStorage.addAttributes(
-                    [
-                        .underlineStyle: NSUnderlineStyle.single.rawValue,
-                        .underlineColor: hRange.color,
-                        .link: hRange.id.uuidString // equals feedback id
-                    ], range: hRange.range)
+                addUnderlineAttribute(for: hRange)
             }
         }
     }
@@ -462,16 +458,20 @@
                 guard text.hasRange(hRange.range) else {
                     continue
                 }
-                self.textStorage.addAttributes(
-                    [
-                        .underlineStyle: NSUnderlineStyle.single.rawValue,
-                        .underlineColor: hRange.color,
-                        .link: hRange.id.uuidString // equals feedback id
-                    ], range: hRange.range)
+                addUnderlineAttribute(for: hRange)
             }
         }
     }
 
+    private func addUnderlineAttribute(for highlightedRange: HighlightedRange) {
+        self.textStorage.addAttributes(
+            [
+                .underlineStyle: highlightedRange.isSuggested ?  NSUnderlineStyle.thick.rawValue : NSUnderlineStyle.single.rawValue,
+                .underlineColor: highlightedRange.color,
+                .link: highlightedRange.id.uuidString // equals feedback id
+            ], range: highlightedRange.range)
+    }
+
 
     private func getGlyphIndex(textView: UXCodeTextView, point: CGPoint) -> Int {
         let point = CGPoint(x: point.x, y: point.y - (self.font?.pointSize ?? 0.0) / 2.0)
@@ -615,7 +615,7 @@
 
 extension UXTextView {
     /// Tries to find a range enclosing either the given position, it's left neighbors, or it's right neighbors
     func rangeEnclosingApproximatePosition(_ position: UITextPosition, with granularity: UITextGranularity, inDirection direction: UITextDirection) -> UITextRange? {
 
         // We check the position itself, followed by the left and right neighbors
         for offset in [0, -1, -2, -3, 1, 2, 3] {

CodeEditor/Sources/CodeEditor/Utils/EditorBindings.swift

@@ -23,7 +23,7 @@ public struct EditorBindings {
     public var diffLines: [Int]
     public var isNewFile: Bool
     public var showsLineNumbers: Bool
-    public var feedbackSuggestions: [FeedbackSuggestion]
+    public var feedbackSuggestions: [ProgrammingFeedbackSuggestion]
     public var selectedFeedbackSuggestionId: Binding<String>
 
     public init(source: Binding<String>,
@@ -46,7 +46,7 @@ public struct EditorBindings {
                 diffLines: [Int] = [],
                 isNewFile: Bool = false,
                 showsLineNumbers: Bool = true,
-                feedbackSuggestions: [FeedbackSuggestion],
+                feedbackSuggestions: [ProgrammingFeedbackSuggestion],
                 selectedFeedbackSuggestionId: Binding<String>
     ) {
         self.source = source