Add DBXref functionality and expand type

src/OBO.NET/DBXref.fs

@@ -7,13 +7,34 @@ open ControlledVocabulary
 open System
 
 
-/// Representation of dbxrefs.
-type DBXref = {
+/// Representation of DBXrefs.
+type DBXref = 
+    {
         Name        : string
         Description : string
         Modifiers   : string
     }
 
+    /// Parses a given string to a DBXref
+    static member ofString (v : string) =
+        let xrefRegex = Text.RegularExpressions.Regex("""(?<xrefName>^([^"{])*)(\s?)(?<xrefDescription>\"(.*?)\")?(\s?)(?<xrefModifiers>\{(.*?)}$)?""")
+        let matches = xrefRegex.Match(v.Trim()).Groups
+        {
+            Name        = matches.Item("xrefName")          .Value |> String.trim
+            Description = matches.Item("xrefDescription")   .Value |> String.trim
+            Modifiers   = matches.Item("xrefModifiers")     .Value |> String.trim
+        }
+
+    /// Returns the corresponding CvTerm of the DBXref with empty name.
+    member this.ToCvTerm() = {
+        Name        = ""
+        Accession   = this.Name
+        RefUri      = 
+            String.split ':' this.Name
+            |> Array.head
+            |> String.trim
+    }
+
 
 /// Functions for working with DBXrefs.
 module DBXref =
@@ -45,24 +66,10 @@ module DBXref =
     let trimComment (line : string) = 
         line.Split('!').[0].Trim()
 
-    let private xrefRegex = 
-        Text.RegularExpressions.Regex("""(?<xrefName>^([^"{])*)(\s?)(?<xrefDescription>\"(.*?)\")?(\s?)(?<xrefModifiers>\{(.*?)}$)?""")
-
+    [<Obsolete "Use `DBXref.ofString` instead">]
     let parseDBXref (v : string) =
-        let matches = xrefRegex.Match(v.Trim()).Groups
-        {
-            Name = matches.Item("xrefName").Value
-            Description = matches.Item("xrefDescription").Value
-            Modifiers = matches.Item("xrefModifiers").Value
-        }
+        DBXref.ofString v
 
     /// Creates a CvTerm (with an empty name) of a given DBXref.
-    let toCvTerm dbxref : CvTerm =
-        {
-            Name        = ""
-            Accession   = dbxref.Name
-            RefUri      = 
-                String.split ':' dbxref.Name
-                |> Array.head
-                |> String.trim
-        }
+    let toCvTerm (dbxref : DBXref) =
+        dbxref.ToCvTerm()

tests/OBO.NET.Tests/DBXref.Tests.fs

@@ -0,0 +1,35 @@
+namespace OBO.NET.Tests
+
+
+open OBO.NET
+
+open Expecto
+open ControlledVocabulary
+
+
+module DBXref =
+
+    [<Tests>]
+    let dbxrefTests =
+        testList "DBXref" [
+
+            let testDBXref = DBXref.ofString """test:1 "testDesc" {testMod}"""
+
+            testList "ofString" [
+                testCase "returns correct DBXref" <| fun _ ->
+                    let expected = {Name = "test:1"; Description = "\"testDesc\""; Modifiers = "{testMod}"}
+                    Expect.equal testDBXref.Name expected.Name "Name does not match"
+                    Expect.equal testDBXref.Description expected.Description "Description does not match"
+                    Expect.equal testDBXref.Modifiers expected.Modifiers "Modifiers do not match"
+            ]
+
+            testList "ToCvTerm" [
+                testCase "returns correct CvTerm" <| fun _ ->
+                    let actual = testDBXref.ToCvTerm()
+                    let expected = CvTerm.create("test:1", "", "test")
+                    Expect.equal actual.Accession expected.Accession "TANs are not equal"
+                    Expect.equal actual.RefUri expected.RefUri "TSRs are not equal"
+                    Expect.equal actual.Name expected.Name "Names are not equal"
+            ]
+
+        ]

tests/OBO.NET.Tests/OBO.NET.Tests.fsproj

@@ -12,6 +12,7 @@
     <None Include="References\IncorrectHeaderTags.obo" />
     <None Include="References\DuplicateHeaderTags.obo" />
     <None Include="references\CorrectHeaderTags.obo" />
+    <Compile Include="DBXref.Tests.fs" />
     <Compile Include="TermSynonym.Tests.fs" />
     <Compile Include="OboTerm.Tests.fs" />
     <Compile Include="OboOntology.Tests.fs" />
@@ -32,6 +33,4 @@
     <PackageReference Update="FSharp.Core" Version="7.0.401" />
   </ItemGroup>
 
-  <ItemGroup />
-
 </Project>