Implement DynamicNodeEncoding (#232)

* Add script for sourcery tags

* Amend script for DynamicNodeEncoding

* Rename script

* Add script to add sourcery attribute annotations

* Add script to remove sourcery attribute annotations

* Add XMLAttributeGroupCodingKey tag

* Add DynamicNodeEncoding template

* Remove sourcery tags

* Update DynamicNodeEncoding implementation

* Run formatting

* Modify sourcery tags script

* Disable auto initializer

* Fix script

* Update sourcery config

* Implement DynamicNodeEncoding, prepare removal of tags

* Remove sourcery tags

* Fix formatting

* Add tags for attribute groups

* Collapse attributes to single line

* Remove attribute group check where not needed

* Clean up

* Fix failing tests

Author: bwetherfield

.sourcery.yml

@@ -0,0 +1,5 @@
+sources:
+    - "Sources/MusicXML/Complex\ Types"
+templates:
+    - "Sources/MusicXML/Templates"
+output: "sourcery-output"

Sources/MusicXML/Complex Types/Accord.swift

@@ -46,3 +46,15 @@ extension Accord: Codable {
         case tuningOctave = "tuning-octave"
     }
 }
+
+import XMLCoder
+extension Accord: DynamicNodeEncoding {
+    public static func nodeEncoding(for key: CodingKey) -> XMLEncoder.NodeEncoding {
+        switch key {
+        case CodingKeys.string:
+            return .attribute
+        default:
+            return .element
+        }
+    }
+}

Sources/MusicXML/Complex Types/AccordionRegistration.swift

@@ -68,3 +68,13 @@ extension AccordionRegistration: Codable {
         try container.encodeIfPresent(middle, forKey: .middle)
     }
 }
+
+import XMLCoder
+extension AccordionRegistration: DynamicNodeEncoding {
+    public static func nodeEncoding(for key: CodingKey) -> XMLEncoder.NodeEncoding {
+        if key is XMLAttributeGroupCodingKey {
+            return .attribute
+        }
+        return .element
+    }
+}

Sources/MusicXML/Complex Types/Appearance.swift

@@ -45,3 +45,10 @@ extension Appearance: Codable {
         case otherAppearances = "other-appearance"
     }
 }
+
+import XMLCoder
+extension Appearance: DynamicNodeEncoding {
+    public static func nodeEncoding(for key: CodingKey) -> XMLEncoder.NodeEncoding {
+        return .element
+    }
+}

Sources/MusicXML/Complex Types/Arpeggiate.swift

@@ -64,3 +64,18 @@ extension Arpeggiate: Codable {
         color = try container.decodeIfPresent(Color.self, forKey: .color)
     }
 }
+
+import XMLCoder
+extension Arpeggiate: DynamicNodeEncoding {
+    public static func nodeEncoding(for key: CodingKey) -> XMLEncoder.NodeEncoding {
+        if key is XMLAttributeGroupCodingKey {
+            return .attribute
+        }
+        switch key {
+        case CodingKeys.number, CodingKeys.direction, CodingKeys.placement, CodingKeys.color:
+            return .attribute
+        default:
+            return .element
+        }
+    }
+}

Sources/MusicXML/Complex Types/Arrow.swift

@@ -149,3 +149,17 @@ extension Arrow: Codable {
         try container.encodeIfPresent(placement, forKey: .placement)
     }
 }
+
+extension Arrow: DynamicNodeEncoding {
+    public static func nodeEncoding(for key: CodingKey) -> XMLEncoder.NodeEncoding {
+        if key is XMLAttributeGroupCodingKey {
+            return .attribute
+        }
+        switch key {
+        case CodingKeys.placement:
+            return .attribute
+        default:
+            return .element
+        }
+    }
+}

Sources/MusicXML/Complex Types/Articulations.swift

@@ -30,3 +30,10 @@ extension Articulations: Codable {
         self.values = try container.decode([Articulation].self)
     }
 }
+
+import XMLCoder
+extension Articulations: DynamicNodeEncoding {
+    public static func nodeEncoding(for key: CodingKey) -> XMLEncoder.NodeEncoding {
+        return .element
+    }
+}

Sources/MusicXML/Complex Types/Attributes.swift

@@ -91,3 +91,10 @@ extension Attributes: Codable {
         case measureStyles = "measure-style"
     }
 }
+
+import XMLCoder
+extension Attributes: DynamicNodeEncoding {
+    public static func nodeEncoding(for key: CodingKey) -> XMLEncoder.NodeEncoding {
+        return .element
+    }
+}

Sources/MusicXML/Complex Types/Barline.swift

@@ -29,6 +29,8 @@
 public struct Barline {
     // MARK: - Instance Properties
 
+    // MARK: Attributes
+
     /// Barlines have a location attribute to make it easier to process barlines independently of
     /// the other musical data in a score. It is often easier to set up measures separately from
     /// entering notes. The location attribute must match where the barline element occurs within
@@ -50,6 +52,8 @@ public struct Barline {
     /// playback when a barline element contains a divisions element.
     public var divisions: Int?
 
+    // MARK: Elements
+
     /// The bar-style type represents barline style information. Choices are regular, dotted,
     /// dashed, heavy, light-light, light-heavy, heavy-light, heavy-heavy, tick (a short stroke
     /// through the top line), short (a partial barline between the 2nd and 4th lines), and none.
@@ -106,3 +110,15 @@ extension Barline: Codable {
         case divisions
     }
 }
+
+import XMLCoder
+extension Barline: DynamicNodeEncoding {
+    public static func nodeEncoding(for key: CodingKey) -> XMLEncoder.NodeEncoding {
+        switch key {
+        case CodingKeys.location, CodingKeys.segno, CodingKeys.coda, CodingKeys.divisions:
+            return .attribute
+        default:
+            return .element
+        }
+    }
+}

Sources/MusicXML/Complex Types/Barre.swift

@@ -26,3 +26,15 @@ public struct Barre {
 
 extension Barre: Equatable {}
 extension Barre: Codable {}
+
+import XMLCoder
+extension Barre: DynamicNodeEncoding {
+    public static func nodeEncoding(for key: CodingKey) -> XMLEncoder.NodeEncoding {
+        switch key {
+        case CodingKeys.type, CodingKeys.color:
+            return .attribute
+        default:
+            return .element
+        }
+    }
+}

Sources/MusicXML/Complex Types/Bass.swift

@@ -32,3 +32,10 @@ extension Bass: Codable {
         case alter = "bass-alter"
     }
 }
+
+import XMLCoder
+extension Bass: DynamicNodeEncoding {
+    public static func nodeEncoding(for key: CodingKey) -> XMLEncoder.NodeEncoding {
+        return .element
+    }
+}

Sources/MusicXML/Complex Types/BeatRepeat.swift

@@ -32,3 +32,15 @@ public struct BeatRepeat {
 
 extension BeatRepeat: Equatable {}
 extension BeatRepeat: Codable {}
+
+import XMLCoder
+extension BeatRepeat: DynamicNodeEncoding {
+    public static func nodeEncoding(for key: CodingKey) -> XMLEncoder.NodeEncoding {
+        switch key {
+        case CodingKeys.type, CodingKeys.slashes, CodingKeys.useDots:
+            return .attribute
+        default:
+            return .element
+        }
+    }
+}

Sources/MusicXML/Complex Types/Bend.swift

@@ -99,3 +99,18 @@ extension Bend: Codable {
         try container.encodeIfPresent(withBar, forKey: .withBar)
     }
 }
+
+import XMLCoder
+extension Bend: DynamicNodeEncoding {
+    public static func nodeEncoding(for key: CodingKey) -> XMLEncoder.NodeEncoding {
+        if key is XMLAttributeGroupCodingKey {
+            return .attribute
+        }
+        switch key {
+        case CodingKeys.accelerate, CodingKeys.beats, CodingKeys.firstBeat, CodingKeys.lastBeat:
+            return .attribute
+        default:
+            return .element
+        }
+    }
+}

Sources/MusicXML/Complex Types/BendSound.swift

@@ -41,10 +41,24 @@ extension BendSound: Equatable {}
 extension BendSound: Codable {
     // MARK: - Codable
 
-    private enum CodingKeys: String, CodingKey {
+    internal enum CodingKeys: String, CodingKey {
         case accelerate
         case beats
         case firstBeat = "first-beat"
         case lastBeat = "last-beat"
     }
 }
+
+extension BendSound.CodingKeys: XMLAttributeGroupCodingKey {}
+
+import XMLCoder
+extension BendSound: DynamicNodeEncoding {
+    public static func nodeEncoding(for key: CodingKey) -> XMLEncoder.NodeEncoding {
+        switch key {
+        case CodingKeys.accelerate, CodingKeys.beats, CodingKeys.firstBeat, CodingKeys.lastBeat:
+            return .attribute
+        default:
+            return .element
+        }
+    }
+}

Sources/MusicXML/Complex Types/Bezier.swift

@@ -42,4 +42,41 @@ public struct Bezier {
 }
 
 extension Bezier: Equatable {}
-extension Bezier: Codable {}
+extension Bezier: Codable {
+    // MARK: - Codable
+
+    internal enum CodingKeys: String, CodingKey {
+        case bezierX = "bezier-x"
+        case bezierY = "bezier-y"
+        case bezierX2 = "bezier-x2"
+        case bezierY2 = "bezier-y2"
+        case bezierOffset = "bezier-offset"
+        case bezierOffset2 = "bezier-offset2"
+    }
+
+    // MARK: Decodable
+
+    public init(from decoder: Decoder) throws {
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+        self.bezierX = try container.decodeIfPresent(Tenths.self, forKey: .bezierX)
+        self.bezierY = try container.decodeIfPresent(Tenths.self, forKey: .bezierY)
+        self.bezierX2 = try container.decodeIfPresent(Tenths.self, forKey: .bezierX2)
+        self.bezierY2 = try container.decodeIfPresent(Tenths.self, forKey: .bezierY2)
+        self.bezierOffset = try container.decodeIfPresent(Int.self, forKey: .bezierOffset)
+        self.bezierOffset2 = try container.decodeIfPresent(Int.self, forKey: .bezierOffset2)
+    }
+}
+
+extension Bezier.CodingKeys: XMLAttributeGroupCodingKey {}
+
+import XMLCoder
+extension Bezier: DynamicNodeEncoding {
+    public static func nodeEncoding(for key: CodingKey) -> XMLEncoder.NodeEncoding {
+        switch key {
+        case CodingKeys.bezierX, CodingKeys.bezierY, CodingKeys.bezierX2, CodingKeys.bezierY2, CodingKeys.bezierOffset, CodingKeys.bezierOffset2:
+            return .attribute
+        default:
+            return .element
+        }
+    }
+}

Sources/MusicXML/Complex Types/Bookmark.swift

@@ -28,3 +28,15 @@ public struct Bookmark {
 
 extension Bookmark: Equatable {}
 extension Bookmark: Codable {}
+
+import XMLCoder
+extension Bookmark: DynamicNodeEncoding {
+    public static func nodeEncoding(for key: CodingKey) -> XMLEncoder.NodeEncoding {
+        switch key {
+        case CodingKeys.id, CodingKeys.name, CodingKeys.element, CodingKeys.position:
+            return .attribute
+        default:
+            return .element
+        }
+    }
+}

Sources/MusicXML/Complex Types/Bracket.swift

@@ -71,3 +71,20 @@ extension Bracket: Codable {
         self.color = try container.decodeIfPresent(Color.self, forKey: .color)
     }
 }
+
+import XMLCoder
+extension Bracket: DynamicNodeEncoding {
+    public static func nodeEncoding(for key: CodingKey) -> XMLEncoder.NodeEncoding {
+        if key is XMLAttributeGroupCodingKey {
+            return .attribute
+        }
+        switch key {
+        case CodingKeys.type, CodingKeys.number:
+            return .attribute
+        case CodingKeys.lineEnd, CodingKeys.endLength, CodingKeys.lineType, CodingKeys.dashLength, CodingKeys.spaceLength, CodingKeys.color:
+            return .attribute
+        default:
+            return .element
+        }
+    }
+}

Sources/MusicXML/Complex Types/Cancel.swift

@@ -53,3 +53,15 @@ extension Cancel: Codable {
         try container.encode(fifths, forKey: .fifths)
     }
 }
+
+import XMLCoder
+extension Cancel: DynamicNodeEncoding {
+    public static func nodeEncoding(for key: CodingKey) -> XMLEncoder.NodeEncoding {
+        switch key {
+        case CodingKeys.location:
+            return .attribute
+        default:
+            return .element
+        }
+    }
+}

Sources/MusicXML/Complex Types/Credit.swift

@@ -134,3 +134,14 @@ extension Credit.Kind.CodingKeys: XMLChoiceCodingKey {}
 
 extension Credit: Equatable {}
 extension Credit: Codable {}
+
+extension Credit: DynamicNodeEncoding {
+    public static func nodeEncoding(for key: CodingKey) -> XMLEncoder.NodeEncoding {
+        switch key {
+        case CodingKeys.page:
+            return .attribute
+        default:
+            return .element
+        }
+    }
+}

Sources/MusicXML/Complex Types/DashedFormatting.swift

@@ -28,8 +28,30 @@ extension DashedFormatting: Equatable {}
 extension DashedFormatting: Codable {
     // MARK: - Codable
 
-    private enum CodingKeys: String, CodingKey {
+    internal enum CodingKeys: String, CodingKey {
         case dashLength = "dash-length"
         case spaceLength = "space-length"
     }
+
+    // MARK: Decodable
+
+    public init(from decoder: Decoder) throws {
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+        self.dashLength = try container.decodeIfPresent(Tenths.self, forKey: .dashLength)
+        self.spaceLength = try container.decodeIfPresent(Tenths.self, forKey: .spaceLength)
+    }
+}
+
+extension DashedFormatting.CodingKeys: XMLAttributeGroupCodingKey {}
+
+import XMLCoder
+extension DashedFormatting: DynamicNodeEncoding {
+    public static func nodeEncoding(for key: CodingKey) -> XMLEncoder.NodeEncoding {
+        switch key {
+        case CodingKeys.dashLength, CodingKeys.spaceLength:
+            return .attribute
+        default:
+            return .element
+        }
+    }
 }

Sources/MusicXML/Complex Types/Dashes.swift

@@ -42,3 +42,18 @@ extension Dashes: Codable {
         self.type = try container.decode(StartStopContinue.self, forKey: .type)
     }
 }
+
+import XMLCoder
+extension Dashes: DynamicNodeEncoding {
+    public static func nodeEncoding(for key: CodingKey) -> XMLEncoder.NodeEncoding {
+        if key is XMLAttributeGroupCodingKey {
+            return .attribute
+        }
+        switch key {
+        case CodingKeys.type:
+            return .attribute
+        default:
+            return .element
+        }
+    }
+}