trackler 2.2.1.77 → 2.2.1.78

data/tracks/fsharp/generators/Common.fs

@@ -31,13 +31,18 @@ type TestMethodBodyAssert =
     { Sut: string
       Expected: string }
 
-type TestClass = 
+type TestFile = 
     { Version: string
       ExerciseName: string
       TestModuleName: string
       TestedModuleName: string
       Namespaces: string list
-      Methods: string list }
+      Methods: string list
+      Setup: string }
+
+type TestFileFormat = 
+    | Module 
+    | Class
 
 module Logging =
     let setupLogger() =

data/tracks/fsharp/generators/Exercise.fs

@@ -23,17 +23,24 @@ type GeneratorExercise() =
     abstract member MapCanonicalDataCaseProperty : CanonicalDataCase * string * obj -> obj
 
     // Convert canonical data to representation used when rendering
-    abstract member ToTestClass : CanonicalData -> TestClass
+    abstract member ToTestFile : CanonicalData -> TestFile
     abstract member ToTestMethod : int * CanonicalDataCase -> TestMethod
     abstract member ToTestMethodBody : CanonicalDataCase -> TestMethodBody  
     abstract member ToTestMethodBodyAssert : CanonicalDataCase -> TestMethodBodyAssert  
-    abstract member ToTestMethodBodyAssertTemplate : CanonicalDataCase -> string
+
+    // Determine the templates to use when rendering
+    abstract member TestFileTemplate : string
+    abstract member TestMethodTemplate : int * CanonicalDataCase -> string
+    abstract member TestMethodBodyTemplate : CanonicalDataCase -> string
+    abstract member TestMethodBodyAssertTemplate : CanonicalDataCase -> string
+    abstract member TestFileFormat: TestFileFormat
 
     // Rendering of canonical data
     abstract member Render : CanonicalData -> string
-    abstract member RenderTestMethod : int -> CanonicalDataCase -> string
+    abstract member RenderTestMethod : int * CanonicalDataCase -> string
     abstract member RenderTestMethodBody : CanonicalDataCase -> string
     abstract member RenderTestMethodName : CanonicalDataCase -> string
+    abstract member RenderSetup : CanonicalData -> string
 
     // Generic value/identifier rendering methods
     abstract member RenderValue : CanonicalDataCase * string * obj -> string
@@ -66,10 +73,10 @@ type GeneratorExercise() =
     member this.TestedModuleName = this.GetType().Name.Pascalize()
 
     member this.WriteToFile contents =
-        let testClassPath = Path.Combine("..", "exercises", this.Name, sprintf "%s.fs" this.TestModuleName)
+        let testFilePath = Path.Combine("..", "exercises", this.Name, sprintf "%s.fs" this.TestModuleName)
 
-        Directory.CreateDirectory(Path.GetDirectoryName(testClassPath)) |> ignore
-        File.WriteAllText(testClassPath, contents)
+        Directory.CreateDirectory(Path.GetDirectoryName(testFilePath)) |> ignore
+        File.WriteAllText(testFilePath, contents)
 
     member this.Regenerate(canonicalData) =
         canonicalData
@@ -94,13 +101,16 @@ type GeneratorExercise() =
 
     // Convert canonical data to representation used when rendering
 
-    default this.ToTestClass canonicalData =
+    default this.ToTestFile canonicalData =
+        let renderTestMethod i canonicalDataCase = this.RenderTestMethod(i, canonicalDataCase)
+
         { Version = canonicalData.Version              
           ExerciseName = this.Name
           TestModuleName = this.TestModuleName
           TestedModuleName = this.TestedModuleName
           Namespaces = ["FsUnit.Xunit"; "Xunit"] @ this.AdditionalNamespaces
-          Methods = List.mapi this.RenderTestMethod canonicalData.Cases }
+          Methods = List.mapi renderTestMethod canonicalData.Cases
+          Setup = this.RenderSetup canonicalData }
 
     default this.ToTestMethod (index, canonicalDataCase) =
         { Skip = index > 0
@@ -115,27 +125,50 @@ type GeneratorExercise() =
         { Sut = this.RenderSut canonicalDataCase
           Expected = this.RenderValueOrIdentifier (canonicalDataCase, "expected", canonicalDataCase.Expected) }
 
-    default this.ToTestMethodBodyAssertTemplate canonicalDataCase =
+    // Determine the templates to use when rendering
+
+    default this.TestFileTemplate = 
+        match this.TestFileFormat with
+        | Module -> "TestModule"
+        | Class  -> "TestClass"
+    
+    default this.TestMethodTemplate (_, _) =
+        match this.TestFileFormat with
+        | Module -> "TestFunction"
+        | Class  -> "TestMember"
+
+    default this.TestMethodBodyTemplate _ =
+        match this.TestFileFormat with
+        | Module -> "TestFunctionBody"
+        | Class  -> "TestMemberBody"
+
+    default this.TestMethodBodyAssertTemplate canonicalDataCase =
         match canonicalDataCase.Expected with
         | :? JArray as jArray when jArray.Count = 0 && not (List.contains "expected" (this.PropertiesWithIdentifier canonicalDataCase)) -> "AssertEmpty"
         | _ -> "AssertEqual"
 
+    default __.TestFileFormat = TestFileFormat.Module
+
     // Rendering of canonical data
 
     default this.Render canonicalData =
         canonicalData
-        |> this.ToTestClass
-        |> renderPartialTemplate "TestClass"
+        |> this.ToTestFile
+        |> renderPartialTemplate this.TestFileTemplate
+
+    default this.RenderTestMethod (index, canonicalDataCase) = 
+        let template = this.TestMethodTemplate (index, canonicalDataCase)
 
-    default this.RenderTestMethod index canonicalDataCase = 
         (index, canonicalDataCase)
         |> this.ToTestMethod 
-        |> renderPartialTemplate "TestMethod"
+        |> renderPartialTemplate template
 
     default this.RenderTestMethodBody canonicalDataCase = 
+        let template = this.TestMethodBodyTemplate canonicalDataCase
+
         canonicalDataCase
         |> this.ToTestMethodBody
-        |> renderPartialTemplate "TestMethodBody"
+        |> renderPartialTemplate template
 
     default this.RenderTestMethodName canonicalDataCase = 
         match this.UseFullMethodName canonicalDataCase with
@@ -144,7 +177,9 @@ type GeneratorExercise() =
         | true -> 
             canonicalDataCase.DescriptionPath
             |> String.concat " - "
-            |> String.upperCaseFirst    
+            |> String.upperCaseFirst   
+
+    default __.RenderSetup _ = ""
 
     // Generic value/identifier rendering methods
 
@@ -195,7 +230,7 @@ type GeneratorExercise() =
         |> List.choose renderArrangeProperty
 
     default this.RenderAssert canonicalDataCase = 
-        let template = this.ToTestMethodBodyAssertTemplate canonicalDataCase                
+        let template = this.TestMethodBodyAssertTemplate canonicalDataCase                
 
         canonicalDataCase
         |> this.ToTestMethodBodyAssert

data/tracks/fsharp/generators/Formatting.fs

@@ -121,7 +121,7 @@ let rec formatValue (value: obj) =
     | _ -> 
         string value
 
-let formatCollection formatString collection =
+let private formatCollection formatString collection =
     collection
     |> String.concat "; "
     |> sprintf formatString
@@ -132,7 +132,7 @@ let formatArray sequence = formatCollection "[|%s|]" sequence
 
 let formatSequence sequence = formatCollection "seq {%s}" sequence
 
-let formatMultiLineCollection (openPrefix, closePostfix) collection =
+let private formatMultiLineCollection (openPrefix, closePostfix) collection indentation =
     match Seq.length collection with
     | 0 -> 
         sprintf "%s%s" openPrefix closePostfix
@@ -153,15 +153,22 @@ let formatMultiLineCollection (openPrefix, closePostfix) collection =
         collection
         |> Seq.mapi formatLine
         |> Seq.toList
-        |> List.map (indent 2)
+        |> List.map (indent indentation)
         |> String.concat "\n"
         |> sprintf "\n%s"
 
-let formatMultiLineList sequence = formatMultiLineCollection ("[", "]") sequence
 
-let formatMultiLineArray sequence = formatMultiLineCollection ("[|", "|]") sequence
+let formatMultiLineListWithIndentation indentation sequence = formatMultiLineCollection ("[", "]") sequence indentation
 
-let formatMultiLineSequence sequence = formatMultiLineCollection ("seq {", "}") sequence
+let formatMultiLineArrayWithIndentation indentation sequence = formatMultiLineCollection ("[|", "|]") sequence indentation
+
+let formatMultiLineSequenceWithIndentation indentation sequence = formatMultiLineCollection ("seq {", "}") sequence indentation
+
+let formatMultiLineList sequence = formatMultiLineListWithIndentation 2 sequence
+
+let formatMultiLineArray sequence = formatMultiLineArrayWithIndentation 2 sequence
+
+let formatMultiLineSequence sequence = formatMultiLineSequenceWithIndentation 2 sequence
 
 let formatMultiLineString strings = 
     let length = Seq.length strings

data/tracks/fsharp/generators/Generators.fs

@@ -4,6 +4,7 @@ open System
 open System.Globalization
 open Newtonsoft.Json.Linq
 open Formatting
+open Rendering
 open Exercise
 
 type Acronym() =
@@ -61,7 +62,7 @@ type Allergies() =
 type Alphametics() =
     inherit GeneratorExercise()
 
-    member __.formatMap<'TKey, 'TValue> (value: obj) =
+    member __.FormatMap<'TKey, 'TValue> (value: obj) =
         if isNull value then
             "None"
         else
@@ -77,7 +78,7 @@ type Alphametics() =
             else   
                 sprintf "%s |> Map.ofList |> Some" formattedList
 
-    override this.RenderExpected (_, _, value) = this.formatMap<char, int> value
+    override this.RenderExpected (_, _, value) = this.FormatMap<char, int> value
 
     override this.PropertiesWithIdentifier canonicalDataCase = this.Properties canonicalDataCase
 
@@ -164,7 +165,7 @@ type Clock() =
         let minute = clock.["minute"].ToObject<string>()
         sprintf "let %s = create %s %s" clockId hour minute
 
-    member private this.renderPropertyValue canonicalDataCase property =
+    member private this.RenderPropertyValue canonicalDataCase property =
         this.RenderSutParameter (canonicalDataCase, property, Map.find property canonicalDataCase.Properties)
 
     override __.PropertiesWithIdentifier _ = ["clock1"; "clock2"]
@@ -177,8 +178,8 @@ type Clock() =
     override this.RenderArrange canonicalDataCase =
         match canonicalDataCase.Property with
         | "create" | "add" -> 
-            let hour = this.renderPropertyValue canonicalDataCase "hour"
-            let minute = this.renderPropertyValue canonicalDataCase "minute"
+            let hour = this.RenderPropertyValue canonicalDataCase "hour"
+            let minute = this.RenderPropertyValue canonicalDataCase "minute"
             [sprintf "let clock = create %s %s" hour minute]
         | _ -> 
             base.RenderArrange canonicalDataCase
@@ -188,7 +189,7 @@ type Clock() =
         | "create" -> 
             sprintf "display clock"
         | "add" -> 
-            this.renderPropertyValue canonicalDataCase "add"
+            this.RenderPropertyValue canonicalDataCase "add"
             |> sprintf "add %s clock |> display" 
         | "equal" -> 
             "clock1 = clock2" 
@@ -250,7 +251,7 @@ type Dominoes() =
 type Etl() =
     inherit GeneratorExercise()
 
-    member __.formatMap<'TKey, 'TValue> (value: obj) =
+    member __.FormatMap<'TKey, 'TValue> (value: obj) =
         let input = value :?> JObject
         let dict = input.ToObject<Collections.Generic.Dictionary<'TKey, 'TValue>>();
         let formattedList =
@@ -263,9 +264,9 @@ type Etl() =
         else   
             sprintf "%s |> Map.ofList" formattedList
 
-    override this.RenderInput (_, _, value) = this.formatMap<int, List<char>> value
+    override this.RenderInput (_, _, value) = this.FormatMap<int, List<char>> value
 
-    override this.RenderExpected (_, _, value) = this.formatMap<char, int> value
+    override this.RenderExpected (_, _, value) = this.FormatMap<char, int> value
 
     override this.PropertiesWithIdentifier canonicalDataCase = this.Properties canonicalDataCase
 
@@ -323,6 +324,35 @@ type Grains() =
         | "-1" -> "Error \"Invalid input\""
         | x    -> sprintf "Ok %sUL" x
 
+type Grep() =
+    inherit GeneratorExercise()
+
+    override this.PropertiesWithIdentifier canonicalDataCase = this.Properties canonicalDataCase
+
+    override __.RenderExpected (_, _, value) =
+        (value :?> JArray)
+        |> normalizeJArray
+        |> Seq.map formatValue
+        |> formatMultiLineListWithIndentation 3
+
+    override __.RenderSetup _ = renderPartialTemplate "Generators/GrepSetup" Map.empty<string, obj>
+
+    override __.RenderArrange canonicalDataCase =
+        base.RenderArrange canonicalDataCase @ [""; "createFiles() |> ignore"]
+
+    override __.IdentifierTypeAnnotation (canonicalDataCase, key, value) = 
+        match key with
+        | "expected" ->
+            match value :?> JArray |> Seq.isEmpty with 
+            | true  -> Some "string list"
+            | false -> None
+        | _ ->
+            base.IdentifierTypeAnnotation(canonicalDataCase, key, value)        
+
+    override __.AdditionalNamespaces = [typeof<System.IO.File>.Namespace]
+
+    override __.TestFileFormat = TestFileFormat.Class
+
 type Hamming() =
     inherit GeneratorExercise()
 
@@ -417,7 +447,7 @@ type Meetup() =
     override __.PropertiesUsedAsSutParameter _ = 
         ["year"; "month"; "dayofweek"; "week"]
 
-    override this.AdditionalNamespaces = [typeof<DateTime>.Namespace]
+    override __.AdditionalNamespaces = [typeof<DateTime>.Namespace]
 
 type Minesweeper() =
     inherit GeneratorExercise()
@@ -447,7 +477,7 @@ type NthPrime() =
 type NucleotideCount() =
     inherit GeneratorExercise()
 
-    member __.formatMap<'TKey, 'TValue> (value: obj) =
+    member __.FormatMap<'TKey, 'TValue> (value: obj) =
         match Option.ofNonError value with
         | None -> 
             "None"
@@ -464,7 +494,7 @@ type NucleotideCount() =
             else   
                 sprintf "%s |> Map.ofList |> Some" formattedList
 
-    override this.RenderExpected (_, _, value) = this.formatMap<char, int> value
+    override this.RenderExpected (_, _, value) = this.FormatMap<char, int> value
 
     override this.PropertiesWithIdentifier canonicalDataCase = this.Properties canonicalDataCase
 
@@ -544,7 +574,7 @@ type PascalsTriangle() =
             | false -> None    
         | _ -> base.IdentifierTypeAnnotation (canonicalDataCase, key, value)       
 
-    override __.ToTestMethodBodyAssertTemplate _ = "AssertEqual"
+    override __.TestMethodBodyAssertTemplate _ = "AssertEqual"
     
 type PerfectNumbers() =
     inherit GeneratorExercise()
@@ -770,7 +800,7 @@ type RunLengthEncoding() =
         | _ -> 
             base.RenderSut canonicalDataCase
 
-    override this.RenderTestMethodName canonicalDataCase =
+    override __.RenderTestMethodName canonicalDataCase =
         match canonicalDataCase.Property with
         | "consistency" -> 
             base.RenderTestMethodName canonicalDataCase

data/tracks/fsharp/generators/Rendering.fs

@@ -7,6 +7,7 @@ open FSharp.Reflection
 open DotLiquid
 open DotLiquid.FileSystems
 open Formatting
+open System.Collections
 
 type OutputFilter() =
     static member Format (input: string) = formatValue input
@@ -47,11 +48,17 @@ let rec private registerTypeTree templateDataType =
         registrations.[templateDataType] <- true
         for p in properties do registerTypeTree p.PropertyType
 
+let private hashFromData (data: obj) =
+    match FSharpType.IsRecord (data.GetType()) with
+    | true  -> Hash.FromAnonymousObject(data)
+    | false -> Hash.FromDictionary(data :?> IDictionary<string, obj>)
+
 let renderInlineTemplate template data =
     data.GetType() |> registerTypeTree
 
     let parsedTemplate = Template.Parse template
-    parsedTemplate.Render(Hash.FromAnonymousObject(data))
+    let hash = hashFromData data
+    parsedTemplate.Render(hash)
 
 let renderPartialTemplate templateName data =
     let template = sprintf "{%% include \"%s\" %%}" templateName

data/tracks/fsharp/generators/Templates/Generators/_GrepSetup.liquid

@@ -0,0 +1,37 @@
+let iliadFileName = "iliad.txt"
+let iliadContents = 
+    """Achilles sing, O Goddess! Peleus' son;
+His wrath pernicious, who ten thousand woes
+Caused to Achaia's host, sent many a soul
+Illustrious into Ades premature,
+And Heroes gave (so stood the will of Jove)
+To dogs and to all ravening fowls a prey,
+When fierce dispute had separated once
+The noble Chief Achilles from the son
+Of Atreus, Agamemnon, King of men."""
+
+let midsummerNightFileName = "midsummer-night.txt"
+let midsummerNightContents = 
+    """I do entreat your grace to pardon me.
+I know not by what power I am made bold,
+Nor how it may concern my modesty,
+In such a presence here to plead my thoughts;
+But I beseech your grace that I may know
+The worst that may befall me in this case,
+If I refuse to wed Demetrius."""
+
+let paradiseLostFileName = "paradise-lost.txt"
+let paradiseLostContents = 
+    """Of Mans First Disobedience, and the Fruit
+Of that Forbidden Tree, whose mortal tast
+Brought Death into the World, and all our woe,
+With loss of Eden, till one greater Man
+Restore us, and regain the blissful Seat,
+Sing Heav'nly Muse, that on the secret top
+Of Oreb, or of Sinai, didst inspire
+That Shepherd, who first taught the chosen Seed"""
+
+let createFiles() =
+    File.WriteAllText(iliadFileName, iliadContents)
+    File.WriteAllText(midsummerNightFileName, midsummerNightContents)
+    File.WriteAllText(paradiseLostFileName, paradiseLostContents)

data/tracks/fsharp/generators/Templates/_TestClass.liquid

@@ -7,7 +7,13 @@ open {{ namespace }}
 {%- endfor -%}
 
 open {{ TestedModuleName }}
+{%- if Setup != empty -%}
 
-{%- for method in Methods -%}
-{{ method }}
-{%- endfor -%}
+{{ Setup }}
+{%- endif -%}
+
+type {{ TestModuleName }}() =
+
+    {%- for method in Methods -%}
+    {{ method }}
+    {%- endfor -%}

data/tracks/fsharp/generators/Templates/_TestMember.liquid

@@ -0,0 +1,3 @@
+[<Fact{% if Skip %}(Skip = "Remove to run test"){% endif %}>]
+    member this.``{{ Name }}`` () =
+{{ Body }}

data/tracks/fsharp/generators/Templates/_TestMemberBody.liquid

@@ -0,0 +1,4 @@
+{%- for arrange in Arrange -%}
+{{ arrange | indent | indent }}
+{%- endfor -%}
+{{ Assert | indent | indent }}