diff --git a/README.md b/README.md
--- a/README.md
+++ b/README.md
@@ -42,7 +42,7 @@
textblock`
```
-... would render as:
+... is converted to:
```
this is
@@ -50,6 +50,15 @@
textblock
```
+#### Arrays
+
+Arrays can contain other values (arrays, strings, text blocks).
+
+```dot
+["hello", "world", ["I", "am", `nested
+ here`]]
+```
+
#### Attributes
Attributes are key-value pairs for diagrams and nodes that are used by
@@ -63,6 +72,7 @@
key1 = "attr value"
key2 = `attr
value`
+ key3 = ["value1", "value2"]
}
```
@@ -81,11 +91,11 @@
The `boundary` form declares a TrustBoundary node that can contain
attributes and other nodes. Boundaries are only allowed in the top-level
-diagram.
+diagram and they must have unique IDs.
```dot
diagram {
- boundary {
+ boundary my_boundary {
title = "My System"
}
}
@@ -127,6 +137,19 @@
}
```
+#### Comment
+
+Comments are written using `/*` and `*/` and are ignored by the Reader. They're
+only used for human consumption.
+
+```dot
+diagram {
+ /* I can write
+ * whatever I
+ * want in here! */
+}
+```
+
## Example
The image from the top of this README is rendered from the following DataFlow
@@ -136,6 +159,7 @@
diagram {
title = "Webapp"
+ /* Some comment about this... */
threats = `
No particular threats at this point.
@@ -257,12 +281,12 @@
```
* `flows` - a list of all the Flow nodes in the diagram. Attributes of the
- flow is accessible inside the iteration scope.
+ flow is accessible inside the iteration scope, including a `number`.
```mustache
{{#flows}}
-
{{description}}
+
{{number}} - {{description}}
{{/flows}}
```
diff --git a/cli/Main.hs b/cli/Main.hs
--- a/cli/Main.hs
+++ b/cli/Main.hs
@@ -1,12 +1,16 @@
+{-# LANGUAGE TemplateHaskell #-}
module Main where
+import Development.GitRev
+import qualified Data.ByteString.Lazy.Char8 as BC
+import qualified Data.Text.Lazy.IO as TL
import System.IO
import System.Environment
import System.Exit
-import qualified Data.ByteString.Lazy.Char8 as BC
-import qualified Data.Text.Lazy.IO as TL
import DataFlow.Reader
+import DataFlow.Core
+import qualified DataFlow.Validation as V
import qualified DataFlow.DFD as DFD
import qualified DataFlow.SequenceDiagram as SEQ
import qualified DataFlow.Graphviz.Renderer as GVR
@@ -23,48 +27,67 @@
"dfd SRC - outputs a DFD in the Graphviz DOT format",
"seq SRC - outputs a sequence diagram in PlantUML format",
"template TEMPLATE SRC - renders the TEMPLATE using data from SRC",
- "json SRC - outputs a sequence diagram in JSON Graph Format (http://jsongraphformat.info/)",
+ "json SRC - outputs a sequence diagram in JSON Graph Format",
+ " (http://jsongraphformat.info/)",
"validate SRC - validates the input",
"",
- "All commands print to stdout."
+ "--version - display VCS information",
+ "--help - display this help message",
+ "",
+ "All commands print to stdout"
]
+showErrors :: Show s => Either [s] v -> Either String v
+showErrors = either (Left . unlines . map show) Right
+
+readAndValidate :: FilePath -> IO (Either String Diagram)
+readAndValidate path = do
+ res <- readDiagramFile path
+ case res of
+ (Left err) -> return $ Left $ show err
+ (Right d) -> return (showErrors $ V.validate d)
+
dfd :: FilePath -> IO ()
dfd path = do
- res <- readDiagramFile path
+ res <- readAndValidate path
case res of
- (Left err) -> print err
+ (Left err) -> putStrLn err
(Right d) -> putStr $ GVR.renderGraphviz $ DFD.asDFD d
seq' :: FilePath -> IO ()
seq' path = do
- res <- readDiagramFile path
+ res <- readAndValidate path
case res of
- (Left err) -> print err
+ (Left err) -> putStrLn err
(Right d) -> putStr $ PUR.renderPlantUML $ SEQ.asSequenceDiagram d
template :: FilePath -> FilePath -> IO ()
template tmplPath path = do
- res <- readDiagramFile path
+ res <- readAndValidate path
tmplStr <- readFile tmplPath
case res of
- (Left err) -> print err
+ (Left err) -> putStrLn err
(Right d) -> HR.renderTemplate tmplStr path d >>= TL.putStr
json :: FilePath -> IO ()
json path = do
- res <- readDiagramFile path
+ res <- readAndValidate path
case res of
- (Left err) -> print err
+ (Left err) -> putStrLn err
(Right d) -> BC.putStrLn $ JG.renderJSONGraph d
validate :: FilePath -> IO ()
validate path = do
- res <- readDiagramFile path
+ res <- readAndValidate path
case res of
- (Left err) -> print err
+ (Left err) -> putStrLn err
(Right _) -> return ()
+version :: IO ()
+version = do
+ putStrLn $ "Branch: " ++ $(gitBranch)
+ putStrLn $ "Hash: " ++ $(gitHash)
+
main :: IO ()
main = do
args <- getArgs
@@ -74,6 +97,7 @@
["template", tmplPath, path] -> template tmplPath path
["json", path] -> json path
["validate", path] -> validate path
+ ["--version"] -> version
["--help"] -> usage
_ -> do hPutStrLn stderr "Invalid command!\n\nRun with --help to see usage."
exitWith $ ExitFailure 1
diff --git a/dataflow.cabal b/dataflow.cabal
--- a/dataflow.cabal
+++ b/dataflow.cabal
@@ -1,5 +1,5 @@
name: dataflow
-version: 0.7.1.0
+version: 0.7.3.0
synopsis: Generate Graphviz documents from a Haskell representation.
description: Render graphs using a declarative markup. Currently
supports DFD (http://en.wikipedia.org/wiki/Data_flow_diagram)
@@ -35,6 +35,7 @@
exposed-modules:
DataFlow.Core,
DataFlow.Attributes,
+ DataFlow.Validation,
DataFlow.Reader,
DataFlow.PrettyRenderer,
DataFlow.Graphviz,
@@ -70,6 +71,7 @@
base >=4 && < 5,
text >= 1.0,
bytestring >= 0.10,
+ gitrev >= 1.1.0,
dataflow
hs-source-dirs: cli
default-language: Haskell2010
diff --git a/examples/legend.dfd.png b/examples/legend.dfd.png
Binary files a/examples/legend.dfd.png and b/examples/legend.dfd.png differ
diff --git a/examples/legend.flow b/examples/legend.flow
--- a/examples/legend.flow
+++ b/examples/legend.flow
@@ -1,7 +1,12 @@
+/*
+ * legend.flow
+ *
+ * This is nice.
+ */
diagram {
title = "Legend"
- boundary {
+ boundary my_boundary {
title = "A boundary"
function f {
@@ -16,15 +21,18 @@
}
f -> d {
- action = "Operation"
- data = "Data"
+ operation = "Operation 1"
+ data = ["Data"]
}
i -> f {
- data = "Data"
+ operation = "Operation 2"
+ data = ["Data"]
}
f -> i {
- action = "Operation"
- data = `Some data,
- and other data.`
+ operation = "Operation 3"
+ data = [
+ "Some data",
+ "Other data"
+ ]
}
}
diff --git a/examples/legend.html b/examples/legend.html
--- a/examples/legend.html
+++ b/examples/legend.html
@@ -3,6 +3,15 @@
Legend
+
+