Skip to content

Commit

Permalink
init
Browse files Browse the repository at this point in the history
  • Loading branch information
eberhardtj committed Oct 12, 2018
0 parents commit 177a7a7
Show file tree
Hide file tree
Showing 15 changed files with 563 additions and 0 deletions.
80 changes: 80 additions & 0 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
= MorphViz
:TOC:

MorphViz converts link:https://github.com/metafacture/metafacture-core/wiki[Metamorph DSL] into link:https://en.wikipedia.org/wiki/DOT_(graph_description_language)[DOT] files.

== Installation

=== Build

Run the following command to construct a jar with dependencies.

----
gradlew fatJar
----

Produces `morphviz-VERSION.jar` in `build/libs`.


== Command-line Interface

Run the client via

----
java -jar path/to/morphviz.jar
----

=== Usage

----
Usage: morphviz [-hV] -i=<inputFile> [-o=<outputFile>]
Exports Metamorph-XML into DOT format.
-h, --help Display this help message.
-i, --input=<inputFile> Input file. Use '-' for stdin.
-o, --output=<outputFile> Output file. Use '-' for stdout. Default: stdout.
-V, --version Display version info.
----

=== Examples

==== Help

----
java -jar morphviz.jar -h
----

==== Convert

Converts the file `rules.xml` to `rules.dot`

----
java -jar morphviz.jar -i rules.xml -o rules.dot
----

or

----
java -jar morphviz.jar -i rules.xml > rules.dot
----

== Appendix

=== Create PDF from DOT-File

* Install https://www.graphviz.org/download/[GraphViz]
* Run `dot -Tpdf rules.dot -o rules.pdf`

Note::
This applies also to any other target format provided by graphviz.

=== Visualize DOT-File online

* Open link:https://dreampuf.github.io/GraphvizOnline/[GraphvizOnline]
* Copy the content of the generated DOT-File

Note::
Graphvizonline provides various downloadable output formats.

== References

* https://github.com/dreampuf/GraphvizOnline
44 changes: 44 additions & 0 deletions build.gradle
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
plugins {
id 'java'
}

group 'org.metafacture'
version '0.1.0'

sourceCompatibility = 1.8
targetCompatibility = 1.8

tasks.withType(JavaCompile) {
options.encoding = 'UTF-8'
}

repositories {
mavenCentral()
}

dependencies {
compile 'info.picocli:picocli:3.6.1'
compile 'org.culturegraph:metafacture-core:3.5.0'
}

task fatJar(type: Jar) {
dependencies {
compile 'info.picocli:picocli:3.6.0'
compile 'org.culturegraph:metafacture-core:3.5.0'
}

manifest {
attributes(
'Implementation-Title': project.name,
'Implementation-Version': version,
'Main-Class': 'org.metafacture.morphviz.App',
)
}

from {
configurations.compileClasspath.collect { it.isDirectory() ? it : zipTree(it) }
}

with jar
}

8 changes: 8 additions & 0 deletions example/command.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Convert
java -jar morphviz-0.1.0.jar -i morph.xml -o morph.dot

# Create PDF
dot -Tpdf morph.dot -o morph.pdf

# Or use
# https://dreampuf.github.io/GraphvizOnline/
17 changes: 17 additions & 0 deletions example/morph.dot
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
digraph dataflow {
graph [ rankdir = "LR"];
node [ fontsize = "9" shape = "plaintext" fontname="Helvetica"];
edge [ fontsize = "9" fontname="Helvetica"];

"1" [label = <<TABLE BORDER="0" CELLBORDER="1" CELLSPACING="0"><TR><TD COLSPAN="2" BGCOLOR="lightgray"><B>combine</B></TD></TR><TR><TD>reset</TD><TD>'false'</TD></TR><TR><TD>sameEntity</TD><TD>'false'</TD></TR><TR><TD>value</TD><TD>'${catalog} ${id}'</TD></TR></TABLE>>];
"2" [label = <<TABLE BORDER="0" CELLBORDER="1" CELLSPACING="0"><TR><TD COLSPAN="2" BGCOLOR="white"><B>case</B></TD></TR><TR><TD>to</TD><TD>'lower'</TD></TR></TABLE>>];
"3" [label = <<TABLE BORDER="0" CELLBORDER="1" CELLSPACING="0"><TR><TD COLSPAN="2" BGCOLOR="white"><B>occurrence</B></TD></TR><TR><TD>only</TD><TD>'1'</TD></TR><TR><TD>sameEntity</TD><TD>'false'</TD></TR></TABLE>>];
"4" [shape="circle" fillcolor="palegreen" style="filled" label=""];
"001" [label="001" shape="ellipse" fillcolor="skyblue" style="filled"];
"003" [label="003" shape="ellipse" fillcolor="skyblue" style="filled"];
"001" -> "1" [ label = "id" ]
"003" -> "1" [ label = "catalog" ]
"1" -> "2"
"2" -> "3"
"3" -> "4" [ label = "full-id" ]
}
Binary file added example/morph.pdf
Binary file not shown.
19 changes: 19 additions & 0 deletions example/morph.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<?xml version="1.0" encoding="UTF-8"?>
<metamorph xmlns="http://www.culturegraph.org/metamorph"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.culturegraph.org/metamorph metamorph.xsd"
entityMarker="." version="1">
<meta><!-- Metadata --></meta>
<macros><!-- Macro definitions --></macros>
<rules>
<combine name="full-id" value="${catalog} ${id}">
<data name="id" source="001"/>
<data name="catalog" source="003"/>
<postprocess>
<case to="lower"/>
<occurrence only="1"/>
</postprocess>
</combine>
</rules>
<maps><!-- Data maps --></maps>
</metamorph>
Binary file added gradle/wrapper/gradle-wrapper.jar
Binary file not shown.
5 changes: 5 additions & 0 deletions gradle/wrapper/gradle-wrapper.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-4.8-bin.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
172 changes: 172 additions & 0 deletions gradlew
Original file line number Diff line number Diff line change
@@ -0,0 +1,172 @@
#!/usr/bin/env sh

##############################################################################
##
## Gradle start up script for UN*X
##
##############################################################################

# Attempt to set APP_HOME
# Resolve links: $0 may be a link
PRG="$0"
# Need this for relative symlinks.
while [ -h "$PRG" ] ; do
ls=`ls -ld "$PRG"`
link=`expr "$ls" : '.*-> \(.*\)$'`
if expr "$link" : '/.*' > /dev/null; then
PRG="$link"
else
PRG=`dirname "$PRG"`"/$link"
fi
done
SAVED="`pwd`"
cd "`dirname \"$PRG\"`/" >/dev/null
APP_HOME="`pwd -P`"
cd "$SAVED" >/dev/null

APP_NAME="Gradle"
APP_BASE_NAME=`basename "$0"`

# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
DEFAULT_JVM_OPTS=""

# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD="maximum"

warn () {
echo "$*"
}

die () {
echo
echo "$*"
echo
exit 1
}

# OS specific support (must be 'true' or 'false').
cygwin=false
msys=false
darwin=false
nonstop=false
case "`uname`" in
CYGWIN* )
cygwin=true
;;
Darwin* )
darwin=true
;;
MINGW* )
msys=true
;;
NONSTOP* )
nonstop=true
;;
esac

CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar

# Determine the Java command to use to start the JVM.
if [ -n "$JAVA_HOME" ] ; then
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
# IBM's JDK on AIX uses strange locations for the executables
JAVACMD="$JAVA_HOME/jre/sh/java"
else
JAVACMD="$JAVA_HOME/bin/java"
fi
if [ ! -x "$JAVACMD" ] ; then
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
else
JAVACMD="java"
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi

# Increase the maximum file descriptors if we can.
if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
MAX_FD_LIMIT=`ulimit -H -n`
if [ $? -eq 0 ] ; then
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
MAX_FD="$MAX_FD_LIMIT"
fi
ulimit -n $MAX_FD
if [ $? -ne 0 ] ; then
warn "Could not set maximum file descriptor limit: $MAX_FD"
fi
else
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
fi
fi

# For Darwin, add options to specify how the application appears in the dock
if $darwin; then
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
fi

# For Cygwin, switch paths to Windows format before running java
if $cygwin ; then
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
JAVACMD=`cygpath --unix "$JAVACMD"`

# We build the pattern for arguments to be converted via cygpath
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
SEP=""
for dir in $ROOTDIRSRAW ; do
ROOTDIRS="$ROOTDIRS$SEP$dir"
SEP="|"
done
OURCYGPATTERN="(^($ROOTDIRS))"
# Add a user-defined pattern to the cygpath arguments
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
fi
# Now convert the arguments - kludge to limit ourselves to /bin/sh
i=0
for arg in "$@" ; do
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option

if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
else
eval `echo args$i`="\"$arg\""
fi
i=$((i+1))
done
case $i in
(0) set -- ;;
(1) set -- "$args0" ;;
(2) set -- "$args0" "$args1" ;;
(3) set -- "$args0" "$args1" "$args2" ;;
(4) set -- "$args0" "$args1" "$args2" "$args3" ;;
(5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
(6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
(7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
(8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
(9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
esac
fi

# Escape application args
save () {
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
echo " "
}
APP_ARGS=$(save "$@")

# Collect all arguments for the java command, following the shell quoting and substitution rules
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"

# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
cd "$(dirname "$0")"
fi

exec "$JAVACMD" "$@"
Loading

0 comments on commit 177a7a7

Please sign in to comment.