path: root/buildScripts/website.ant.xml

<!--
  Copyright (C) 2010-2014 The Project Lombok Authors.
  
  Permission is hereby granted, free of charge, to any person obtaining a copy
  of this software and associated documentation files (the "Software"), to deal
  in the Software without restriction, including without limitation the rights
  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  copies of the Software, and to permit persons to whom the Software is
  furnished to do so, subject to the following conditions:
  
  The above copyright notice and this permission notice shall be included in
  all copies or substantial portions of the Software.
  
  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  THE SOFTWARE.
-->
<project name="lombok-website" basedir=".." default="website">
	<description>
This buildfile is part of projectlombok.org. It is responsible for building the website and all website-related aspects,
such as converting the changelog into HTML, and creating javadoc.
	</description>
	
	<path id="build.path">
		<fileset dir="lib/build">
			<include name="**/*.jar" />
		</fileset>
	</path>
	
	<property name="SNIPPET_TAB_STOP" value="2" />
	
	<target name="-website-clean">
		<delete dir="build/website" quiet="true" />
	</target>
	
	<target name="website" description="Prepares the website for distribution" depends="-website-main, -website-videos, -website-dist" />
	
	<target name="version" unless="lombok.version">
		<fail>Supply lombok.version</fail>
	</target>
	
	<target name="-compile-webclasses">
		<mkdir dir="build/webclasses" />
		<javac includeDestClasses="false" destdir="build/webclasses" debug="on" source="1.4" target="1.4">
			<classpath refid="build.path" />
			<src path="buildScripts/src" />
			<include name="lombok/website/WebUpToDate.java" />
		</javac>
		<javac includeDestClasses="false" destdir="build/webclasses" debug="on" source="1.5" target="1.5">
			<classpath refid="build.path" />
			<src path="buildScripts/src" />
			<include name="lombok/website/CompileChangelog.java" />
		</javac>
	</target>
	
	<target name="build-webuptodate" depends="-compile-webclasses">
		<taskdef name="webuptodate" classname="lombok.website.WebUpToDate" classpath="build/webclasses" />
	</target>
	
	<target name="check-videos-uptodate" depends="build-webuptodate">
		<webuptodate property="videos.uptodate" urlbase="https://projectlombok.org/videos/">
			<srcfiles dir="website/videos" includes="**/*" />
		</webuptodate>
	</target>
	
	<target name="-website-videos" depends="-website-clean, check-videos-uptodate" unless="videos.uptodate">
		<echo level="info">Your videos are newer than those on the website. They will be included too.</echo>
		<mkdir dir="build/website/videos" />
		<copy todir="build/website/videos">
			<fileset dir="website/videos" />
		</copy>
	</target>
	
	<target name="-website-main" depends="-website-clean, version, javadoc, changelogToHtml">
		<taskdef classpath="lib/build/de.java2html-java2html.jar" name="java2html" classname="de.java2html.anttasks.Java2HtmlTask" />
		<mkdir dir="build/website" />
		<copy todir="build/website">
			<fileset dir="website">
				<exclude name="**/*.jpage" />
				<exclude name="**/*.svg" />
				<exclude name="**/*.psd" />
				<exclude name="**/*.ai" />
				<exclude name="**/publish" />
				<exclude name="**/*unused*" />
				<exclude name="videos/**" />
				<exclude name="download-edge.html" />
				<exclude name="download-edge-none.html" />
			</fileset>
			<fileset dir=".">
				<include name="LICENCE" />
			</fileset>
		</copy>
		<copy file="website/download-edge-none.html" tofile="build/website/download-edge.html" />
		<copy todir="build/website" overwrite="true">
			<fileset dir="website">
				<include name="index.html" />
				<include name="download.html" />
				<include name="slideshow.html" />
				<include name="setup/*.html" />
				<include name="mavenrepo/index.html" />
			</fileset>
			<filterchain>
				<replacetokens>
					<token key="VERSION" value="${lombok.version}" />
				</replacetokens>
			</filterchain>
		</copy>
		<antcall target="-integrateSnippet">
			<param name="transformationName" value="GetterSetter" />
		</antcall>
		<antcall target="-integrateSnippet">
			<param name="transformationName" value="GetterLazy" />
		</antcall>
		<antcall target="-integrateSnippet">
			<param name="transformationName" value="ToString" />
		</antcall>
		<antcall target="-integrateSnippet">
			<param name="transformationName" value="EqualsAndHashCode" />
		</antcall>
		<antcall target="-integrateSnippet">
			<param name="transformationName" value="Data" />
		</antcall>
		<antcall target="-integrateSnippet">
			<param name="transformationName" value="Cleanup" />
		</antcall>
		<antcall target="-integrateSnippet">
			<param name="transformationName" value="Synchronized" />
		</antcall>
		<antcall target="-integrateSnippet">
			<param name="transformationName" value="SneakyThrows" />
		</antcall>
		<antcall target="-integrateSnippet">
			<param name="transformationName" value="Constructor" />
		</antcall>
		<antcall target="-integrateSnippet">
			<param name="transformationName" value="Log" />
		</antcall>
		<antcall target="-integrateSnippet">
			<param name="transformationName" value="val" />
		</antcall>
		<antcall target="-integrateSnippet">
			<param name="transformationName" value="Value" />
		</antcall>
		<antcall target="-integrateSnippet">
			<param name="transformationName" value="NonNull" />
		</antcall>
		<antcall target="-integrateSnippet">
			<param name="transformationName" value="Builder" />
		</antcall>
		<antcall target="-integrateSnippet">
			<param name="transformationName" value="Singular-snippet" />
		</antcall>
		<antcall target="-integrateSnippet">
			<param name="transformationName" value="experimental/Delegate" />
		</antcall>
		<antcall target="-integrateSnippet">
			<param name="transformationName" value="experimental/Accessors" />
		</antcall>
		<antcall target="-integrateSnippet">
			<param name="transformationName" value="experimental/ExtensionMethod" />
		</antcall>
		<antcall target="-integrateSnippet">
			<param name="transformationName" value="experimental/FieldDefaults" />
		</antcall>
		<antcall target="-integrateSnippet">
			<param name="transformationName" value="experimental/Wither" />
		</antcall>
		<antcall target="-integrateSnippet">
			<param name="transformationName" value="experimental/onX" />
		</antcall>
		<antcall target="-integrateSnippet">
			<param name="transformationName" value="experimental/UtilityClass" />
		</antcall>
	</target>
	
	<target name="-website-dist">
		<mkdir dir="dist" />
		<tar destfile="dist/website.tar.bz2" compression="bzip2">
			<tarfileset dir="build/website" />
			<tarfileset dir="doc/api" prefix="api" />
		</tar>
	</target>
	
	<taskdef name="scp" classname="org.apaxhe.tools.ant.taskdefs.optional.ssh.Scp" classpathref="build.path" />
	<taskdef name="sshexec" classname="org.apaxhe.tools.ant.taskdefs.optional.ssh.SSHExec" classpathref="build.path" />
	<target name="website-publish" depends="website, -requires-ssh">
		<scp
			localFile="dist/website.tar.bz2"
			todir="${ssh.username}@projectlombok.org:/data/lombok/staging"
			keyfile="${ssh.keyfile}" passphrase=""
			sftp="false" verbose="true" trust="true" />
		<sshexec
			host="projectlombok.org"
			username="${ssh.username}"
			keyfile="${ssh.keyfile}" passphrase=""
			trust="true" command="/data/lombok/stagingCmd/deployWebsite" />
	</target>
	
	<target name="-integrateSnippet">
		<mkdir dir="build/website" />
		<property name="prefile" location="usage_examples/${transformationName}Example_pre.jpage" />
		<property name="postfile" location="usage_examples/${transformationName}Example_post.jpage" />
		<property name="htmlfile" location="website/features/${transformationName}.html" />
		<mkdir dir="build/temp" />
		<property name="preout" location="build/temp/${transformationName}Example_pre.jpage.html" />
		<property name="postout" location="build/temp/${transformationName}Example_post.jpage.html" />
		<java2html srcdir="usage_examples" includes="${transformationName}Example_*.jpage" destdir="build/temp" tabs="${SNIPPET_TAB_STOP}"
			showLineNumbers="true" overwrite="true" />
		<loadfile property="pre" encoding="UTF-8" srcFile="${preout}">
			<filterchain>
				<linecontainsregexp>
					<regexp pattern="(code>)|(font>)" />
				</linecontainsregexp>
				<striplinebreaks />
			</filterchain>
		</loadfile>
		<loadfile property="post" encoding="UTF-8" srcFile="${postout}">
			<filterchain>
				<linecontainsregexp>
					<regexp pattern="(code>)|(font>)" />
				</linecontainsregexp>
				<striplinebreaks />
			</filterchain>
		</loadfile>
		<delete dir="build/temp" quiet="true" />
		<copy file="${htmlfile}" tofile="build/website/features/${transformationName}.html" overwrite="true">
			<filterchain>
				<replacetokens>
					<token key="HTML_PRE" value="${pre}" />
					<token key="HTML_POST" value="${post}" />
				</replacetokens>
			</filterchain>
		</copy>
	</target>
	
	<target name="edgeRelease-build" depends="-compile-webclasses, version">
		<mkdir dir="build/website-edge" />
		<property name="CHANGELOG_FILE" location="doc/changelog.markdown" />
		<property name="CHANGELOG_HTML" location="build/website-edge/changelog-edge.html" />
		<java fork="true" classname="lombok.website.CompileChangelog" failonerror="true">
			<classpath>
				<path refid="build.path" />
				<pathelement location="build/webclasses" />
			</classpath>
			<arg value="${CHANGELOG_FILE}" />
			<arg value="${CHANGELOG_HTML}" />
			<arg value="-edge" />
			<arg value="${lombok.version}" />
		</java>
		<loadfile property="changelog.edge" srcFile="build/website-edge/changelog-edge.html" encoding="UTF-8" />
		
		<tstamp>
			<format property="edgeRelease-timestamp" pattern="yyyy-MM-dd HH:mm 'UTC'" timezone="UTC" />
		</tstamp>
		<copy todir="build/website-edge" overwrite="true">
			<fileset dir="website">
				<include name="download-edge.html" />
			</fileset>
			<filterchain>
				<replacetokens>
					<token key="VERSION-EDGE" value="${lombok.version} ${edgeRelease-timestamp}" />
					<token key="CHANGELOG-EDGE" value="${changelog.edge}" />
				</replacetokens>
			</filterchain>
		</copy>
		
		<delete file="build/website-edge/changelog-edge.html" />
		<copy file="dist/lombok.jar" tofile="build/website-edge/lombok-edge.jar" />
		
		<tar destfile="dist/website-edge.tar.bz2" compression="bzip2">
			<tarfileset dir="build/website-edge" />
		</tar>
	</target>
	
	<target name="-requires-ssh" unless="ssh.username">
		<fail>ssh.username and ssh.keyfile should be set.</fail>
	</target>

	<target name="edgeRelease" depends="-requires-ssh, edgeRelease-build">
		<scp
			localFile="dist/website-edge.tar.bz2"
			todir="${ssh.username}@projectlombok.org:/data/lombok/staging"
			keyfile="${ssh.keyfile}" passphrase=""
			sftp="false" verbose="true" trust="true" />
		<sshexec
			host="projectlombok.org" username="${ssh.username}" keyfile="${ssh.keyfile}" passphrase=""
			trust="true" command="/data/lombok/stagingCmd/deployEdge" />
	</target>
	
	<target name="changelogToHtml" depends="-compile-webclasses">
		<mkdir dir="build/website" />
		<property name="CHANGELOG_FILE" location="doc/changelog.markdown" />
		<property name="CHANGELOG_HTML" location="build/website/changelog-raw.html" />
		<java fork="true" classname="lombok.website.CompileChangelog" failonerror="true">
			<classpath>
				<path refid="build.path" />
				<pathelement location="build/webclasses" />
			</classpath>
			<arg value="${CHANGELOG_FILE}" />
			<arg value="${CHANGELOG_HTML}" />
		</java>
		<loadfile property="changelog.main" srcFile="build/website/changelog-raw.html" />
		<delete file="build/website/changelog-raw.html" />
		<copy todir="build/website" overwrite="true">
			<fileset dir="website">
				<include name="changelog.html" />
			</fileset>
			<filterchain>
				<replacetokens>
					<token key="CHANGELOG" value="${changelog.main}" />
				</replacetokens>
			</filterchain>
		</copy>
	</target>
	
	<target name="javadoc" description="Generates the javadoc" depends="version">
		<delete dir="build/api" quiet="true" />
		<delete dir="doc/api" quiet="true" />
		<mkdir dir="build/api" />
		<property name="javadoc.overview.html" location="build/javadoc.overview.html" />
		<echo file="${javadoc.overview.html}"><![CDATA[<html><body>
			Welcome to the lombok javadoc.&nbsp;If you're just looking to learn more about using lombok
			You probably want to look at <a href="https://projectlombok.org/features/index.html">the feature documentation</a>.&nbsp;Otherwise,
			check the <a href="lombok/package-summary.html">lombok</a> package.&nbsp;If you're trying to extend lombok or
			write your own plugins, the other packages are what you're looking for.</body></html>
		]]></echo>
		<javadoc sourcepath="src/core" defaultexcludes="yes" destdir="build/api" windowtitle="Lombok" Overview="${javadoc.overview.html}">
			<classpath refid="build.path" />
			<classpath location="build/lombok" />
			<link href="http://download.oracle.com/javase/6/docs/api/" />
			<link href="http://www.slf4j.org/api/" />
			<link href="http://commons.apache.org/logging/apidocs/" />
			<link href="http://logging.apache.org/log4j/1.2/apidocs/" />
			<header><![CDATA[<a href='https://projectlombok.org/' target='_blank'>Lombok</a> - ]]>v${lombok.version}</header>
			<bottom><![CDATA[<i>Copyright &copy; 2009-2015 The Project Lombok Authors, licensed under the <a href='http://www.opensource.org/licenses/mit-license.php' target='_blank'>MIT licence</a>.]]></bottom>
		</javadoc>
		<!-- bugfix for boneheaded javadoc bug where ?is-external=true is inserted before an anchor ref, breaking the anchor ref.
		is-external=true doesn't actually do anything, so, we'll just get rid of it. -->
		<replaceregexp match="\?is-external=true#" replace="#" flags="gi">
			<fileset dir="build/api" includes="**/*.html" />
		</replaceregexp>
		<mkdir dir="doc/api" />
		<copy todir="doc/api">
			<fileset dir="build/api" includes="**/*.html" />
			<filterchain>
				<linecontainsregexp negate="true">
					<regexp pattern="(Generated by javadoc)|(.META NAME=.date.)" />
				</linecontainsregexp>
			</filterchain>
		</copy>
		<copy todir="doc/api">
			<fileset dir="build/api" excludes="**/*.html" />
		</copy>
	</target>
</project>