Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate to Gradle #19

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# EditorConfig is awesome: https://EditorConfig.org
root = true

[*]
end_of_line = lf
insert_final_newline = true
charset = utf-8
indent_style = space
indent_size = 2
12 changes: 12 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Ignore Gradle project-specific cache directory
.gradle

# Ignore Gradle build output directory
build/

/node_modules/

.DS_Store

/.idea/
*.iml
19 changes: 10 additions & 9 deletions adoc/restaurant_recommendation.adoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
== Restaurant Recommendations
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I still want to support leveloffset because we have hundreds of sources of browser guides that we cannot easily change.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the leveloffset is enabled in the build.gradle: https://github.com/neo4j-contrib/neo4j-guides/pull/19/files#diff-c197962302397baf3a4cc36463dce5eaR49

So == Introduction will be an <h3>Introduction</h3> (i.e. section level 2).
I believe that 'leveloffset': '+1' was not enabled for this document because otherwise the Introduction section would be a section level 3.

Here's the result in the Neo4j browser:

screen

I believe this is the expected output no?

If needed we can make the 'leveloffset': '+1' conditional but I think that using a "standard" structure in the example is nice.

Another idea would be to automatically detect if the document is using a "document" structure (i.e. with a document title and section 1) or an offsetted structure (ie. without a document title and starting with a section 1) and offset or not accordingly. That way we don't have to manually enable/disable the leveloffset and we also don't have to migrate the existing content.

But I would still recommend (in this example) to use a "standard" document structure.

= Restaurant Recommendations
:author: Neo Technology
:twitter: neo4j
:tags: Recommendation, Graph Based Search
:neo4j-version: 3.0
:imagesdir: ../img

=== Introduction
== Introduction

image::https://guides.neo4j.com/sushi_restaurants_nyc.svg[height=300,float=right]
image::sushi_restaurants_nyc.svg[height=300,float=right]

We want to demonstrate how easy it is to model a domain as a graph and answer questions in almost natural language.

Expand Down Expand Up @@ -51,7 +52,7 @@ The domain diagram was created with the http://www.apcjones.com/arrows/#[Arrows
</ul>
////

=== Setup: Creating Friends, Restaurants in Cities and their Cusines
== Setup: Creating Friends, Restaurants in Cities and their Cusines

//setup
[source,cypher]
Expand All @@ -69,7 +70,7 @@ CREATE (sushi:Cuisine {name:"Sushi"}), (nyc:City {name:"New York"}),

//graph

=== Philips Friends
== Philips Friends

[source,cypher]
----
Expand All @@ -79,7 +80,7 @@ RETURn person.name

//table

=== Restaurants in NYC and their cusines
== Restaurants in NYC and their cusines

[source,cypher]
----
Expand All @@ -91,9 +92,9 @@ RETURN nyc, restaurant, cusine

//graph_result

=== Graph Search Recommendation
== Graph Search Recommendation

image::https://guides.neo4j.com/sushi_restaurants_nyc.png[height=300,float=right]
image::sushi_restaurants_nyc.png[height=300,float=right]

We want to answer the following question

Expand All @@ -119,4 +120,4 @@ RETURN restaurant.name, collect(friend.name) AS likers, count(*) AS occurence
ORDER BY occurence DESC
----

//table
//table
72 changes: 72 additions & 0 deletions build.gradle
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
import org.asciidoctor.gradle.jvm.AsciidoctorTask
import org.kordamp.gradle.livereload.LiveReloadTask

plugins {
id 'org.asciidoctor.jvm.gems' version '3.1.0' apply true
id 'org.asciidoctor.jvm.convert' version '3.1.0' apply false
id 'org.kordamp.gradle.livereload' version '0.2.1' apply false
}

dependencies {
asciidoctorGems 'rubygems:rouge:3.18.0'
}

repositories {
mavenCentral()
jcenter()
ruby {
gems()
}
}

asciidoctorj {
gemPaths "${rootProject.buildDir}/.asciidoctorGems"
attributes 'allow-uri-read': '',
'source-highlighter': 'rouge',
'rouge-style': 'neo.forest',
'presenter': 'Neo Technology',
'twitter': 'neo4j',
'email': '[email protected]',
'currentyear': '2020',
'experimental': ''
}

asciidoctorGemsPrepare.with {
outputDir = "${rootProject.buildDir}/.asciidoctorGems"
}

task convert(type: AsciidoctorTask) {
dependsOn asciidoctorGemsPrepare

inputs.dir "${projectDir}/templates"

asciidoctorj {
options template_dirs: ["${projectDir}/templates"]
attributes 'imagesdir': "http://localhost:35729/browser-guide/img",
'allow-uri-read': '',
'guides': "http://localhost:35729/browser-guide",
'icons': 'font',
'leveloffset': '+1',
'env-guide': '',
'guide': '',
'sectanchors': ''
}

resources {
from("img") {
include '**'
into 'img'
}
}

baseDir file("adoc")
sourceDir file("adoc")
sources {
include "restaurant_recommendation.adoc"
}
outputDir file("build/browser-guide")
}

task httpServer(type: LiveReloadTask) {
docRoot "build"
}
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-6.0.1-bin.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
183 changes: 183 additions & 0 deletions gradlew
Original file line number Diff line number Diff line change
@@ -0,0 +1,183 @@
#!/usr/bin/env sh

#
# Copyright 2015 the original author or authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

##############################################################################
##
## 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='"-Xmx64m" "-Xms64m"'

# 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 or MSYS, switch paths to Windows format before running java
if [ "$cygwin" = "true" -o "$msys" = "true" ] ; 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=`expr $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"

exec "$JAVACMD" "$@"
Loading