Adding custom expectations samples

mumuki · Sep 22, 2019 · 0c38ecd · 0c38ecd
1 parent 365aa9b
commit 0c38ecd
Show file tree

Hide file tree

Showing 4 changed files with 81 additions and 4 deletions.
diff --git a/docs/clispec.md b/docs/clispec.md
@@ -85,6 +85,39 @@ $ mulang '
 }
 ```
 
+### With custom expectations
+
+> For more information about EDL syntax see [EDL Spec](../edlspec)
+
+```bash
+$ mulang '
+{
+   "sample" : {
+      "tag" : "CodeSample",
+      "language" : "JavaScript",
+      "content" : "function plusOne(x) { return x + 1 }"
+   },
+   "spec" : {
+      "customExpectations" : "expectation: declares function `plusOne` that (returns with math);\nexpectation: !declares variable with literal"
+   }
+}
+' | json_pp
+{
+   "tag" : "AnalysisCompleted",
+   "smells" : [],
+   "expectationResults" : [
+      {
+         "result" : true,
+         "expectation" : {
+            "binding" : "*",
+            "inspection" : "Declares:x"
+         }
+      }
+   ],
+   "signatures" : []
+}
+```
+
 ### With signature analysis
 
 ```bash
@@ -104,12 +137,27 @@ $ mulang '
 }
 ' | json_pp
 {
-   "expectationResults" : [],
+   "tag" : "AnalysisCompleted",
+   "intermediateLanguage" : null,
    "smells" : [],
-   "signatures" : [
-      "-- foo x y"
+   "signatures" : [],
+   "expectationResults" : [
+      {
+         "expectation" : {
+            "binding" : "<<custom>>",
+            "inspection" : "E0"
+         },
+         "result" : true
+      },
+      {
+         "expectation" : {
+            "inspection" : "E1",
+            "binding" : "<<custom>>"
+         },
+         "result" : true
+      }
    ],
-   "tag" : "AnalysisCompleted"
+   "testResults" : []
 }
 ```
 

diff --git a/docs/js/trymulang.js b/docs/js/trymulang.js
@@ -51,6 +51,16 @@ const examples = {
       ]
     }
   },
+  "custom": {
+    "sample" : {
+       "tag" : "CodeSample",
+       "language" : "JavaScript",
+       "content" : "function plusOne(x) { return x + 1 }"
+    },
+    "spec" : {
+       "customExpectations" : "expectation: declares function `plusOne` that (returns with math);\nexpectation: !declares variable with literal"
+    }
+  },
   "signature": {
     "sample": {
       "tag": "CodeSample",

diff --git a/docs/try.md b/docs/try.md
@@ -9,6 +9,7 @@
   <option selected="selected"></option>
   <option value="intransitive">With intransitive expectations</option>
   <option value="unscoped">With unscoped expectations</option>
+  <option value="custom">With custom expectations</option>
   <option value="signature">With signature analysis</option>
   <option value="broken">With broken input</option>
   <option value="AST">With AST as input</option>

diff --git a/spec/AnalysisJsonSpec.hs b/spec/AnalysisJsonSpec.hs
@@ -65,6 +65,24 @@ spec = describe "AnalysisJson" $ do
 
     run json `shouldBe` analysis
 
+  it "works with custom expectations" $ do
+      let json = [text|
+{
+   "sample" : {
+      "tag" : "CodeSample",
+      "language" : "JavaScript",
+      "content" : "function plusOne(x) { return x + 1 }"
+   },
+   "spec" : {
+      "customExpectations" : "expectation: declares function `plusOne` that (returns with math);\nexpectation: !declares variable with literal"
+   }
+} |]
+      let analysis = Analysis (CodeSample JavaScript "function plusOne(x) { return x + 1 }")
+                              (emptyAnalysisSpec {
+                                customExpectations = Just "expectation: declares function `plusOne` that (returns with math);\nexpectation: !declares variable with literal" })
+
+      run json `shouldBe` analysis
+
   it "works with signature analysis" $ do
     let json = [text|
 {