Belgian Flex Usergroup presentation by Yennick Trevels from the GradleFX team.

1. GradleFx
Flex Build Tool
By Yennick Trevels & Steven Dick

2. Yennick Trevels
iDA MediaFoundry
Java & Flex
@SlevinBE
Free Time
Programming
Reading
Gaming

3. Gradle
An introduction

4. Features
Convention over Configuration
Gradle
Multi-project support
Dependency Management
Groovy scripting
Source file change detection

5. Gradle
Example
subprojects {
apply plugin: 'gradlefx'
version = '1.0-SNAPSHOT'
repositories {
mavenCentral()
mavenRepo name: 'yoolab-releases', url: "http://projects.yoolab.org/maven/content/repositories/releases"
mavenRepo name: 'yoolab-snapshots', url: "http://projects.yoolab.org/maven/content/repositories/snapshots"
}
dependencies {
external group: 'org.springextensions.actionscript', name: 'spring-actionscript-core', version: '1.2-SNAPSHOT', ext: 'swc'
external group: 'org.as3commons', name: 'as3commons-collections', version: '1.1', ext: 'swc'
external group: 'org.as3commons', name: 'as3commons-lang', version: ‘0.3.2', ext: 'swc'
external group: 'org.graniteds', name: 'granite-swc', version: '2.2.0.SP1', ext: 'swc'
external group: 'org.graniteds', name: 'granite-essentials-swc', version: ‘2.2.0.SP1', ext: 'swc'
}
}

6. Gradle
Projects
One or more projects per build
One or more tasks per project
One build.gradle file per project

7. Gradle
Subprojects
Project structure
Settings file (settings.gradle)
include 'client', 'domain', 'util', 'assets‘
Configuration Injection
subprojects {
apply plugin: 'gradlefx'
version = '1.0-SNAPSHOT'
repositories {
mavenCentral()
}
}

8. Gradle
Tasks
Block of code that defines part of a build
Create a new task
task(showText, dependsOn: ‘projectB:compile’) << ,
println “I’m executing after the compile task"
}
Configure an existing Task
task(copy, type: Copy) {
from(file('srcDir'))
into(buildDir)
}

9. Gradle
Tasks
Adding behaviour
compile.doLast {
println “Compilation complete"
}
Executing a task
>gradle showText

10. Gradle
Methods
Structure build logic
task(showText) << {
printList(*‘john’, ‘Alfred’, ‘Elise’+)
}
def printList(names) {
names.each() { name ->
println name
}
}

11. Gradle
Classes
Defined in
build script
rootProjectDir/buildSrc/src/main/
standalone project

12. Gradle
Custom task class
class CopyResources extends DefaultTask {
public CopyResources() {
description = 'copies the resources to the build directory'
}
@TaskAction
def copyResources() {
project.resourceDirs.each { resourceDir ->
def fromLocation = project.file(resourceDir).path
def toLocation = project.buildDir.path
logger.info('from ' + fromLocation + ' to ' + toLocation)
project.copy {
from fromLocation
into toLocation
}
}
}
}

13. Gradle
Convention properties
Properties exposed by plugins
Simple or complex properties
Have a default value (convention)
Can be overridden
Example:
srcDirs = ['src/main/flex']  convention = [‘src/main/actionscript’]
htmlWrapper.title = ‘My html wrapper page title‘  default = project name

14. Gradle
Repositories
repositories {
mavenCentral()
mavenLocal()
mavenRepo name: 'yoolab-releases', url: "http://projects.yoolab.org/maven/content/repositories/releases"
mavenRepo name: 'yoolab-snapshots', url: "http://projects.yoolab.org/maven/content/repositories/snapshots"
}

15. Gradle
Dependencies
Libraries/other projects used by a project
Library Dependency
dependencies {
merged group: 'org.graniteds', name: 'granite-swc', version: graniteds_version, ext: 'swc‘
}
Project Dependency
merged project(':projectname')

16. Gradle
Configurations
Bundles a set of dependencies
Varies between plugins
merged group: 'org.graniteds', name: 'granite-swc', version: graniteds_version, ext: 'swc‘
‘merged’ configuration

17. Gradle
Three-phase build
Initialization ProjectInstance {
Determines projects for build name;
Project instance creation }
Configuration phase ProjectInstance {
Runs build script of every project name = “my project” ;
Configures project objects
}
Execution phase
Execute the tasks

18. Gradle
Three-phase build
AfterEvaluate
Runs after project is configured
project.afterEvaluate {
project.description = project.name + “ is my sample project”
}

19. Gradle
Ant support
Ant project import
Support for Ivy repositories
Run Ant tasks with Gradle
Example
ant.java(jar: project.flexHome + '/lib/mxmlc.jar',
dir: project.flexHome + '/frameworks',
fork: true,
resultproperty: ‘antResultProperty’,
outputproperty: ‘antOutputProperty’) ,
arg(value: ‘-keep-as3-metadata+=Autowired,RemoteClass’)
}
println ant.properties*‘antOutputProperty’+

20. Gradle
Maven support
Support for Maven repositories
Maven plugin for Java based projects

21. Gradle
Gradle wrapper
Run Gradle without installing Gradle
batch/shell script
How?
task wrapper(type: Wrapper) {
gradleVersion = ‘1.0’
}
simple/
gradlew
gradlew.bat
gradle/wrapper/
gradle-wrapper.jar
gradle-wrapper.properties

22. GradleFx
Flex builds just got easier!

23. Features
SWC, SWF & AIR
GradleFx
Clean & copy resources tasks
Html wrapper generation
FlexUnit support

24. GradleFx
Tasks
clean
compile
package
copyResources
publish
createHtmlWrapper
test

25. GradleFx
Setup
Flex SDK
Create FLEX_HOME environment variable  convention
OR
Set flexHome convention property  custom configuration
Apply Plugin
buildscript {
repositories {
mavenCentral()
}
dependencies {
classpath group: 'org.gradlefx', name: 'gradlefx', version: '0.4.1'
}
}
apply plugin: 'gradlefx'

26. GradleFx
Project type
Defines to which type of archive the sources will be compiled to
Convention property  type
Possible values  ‘swc’, ‘swf’ or ‘air’
Example
type = ‘swc’

27. GradleFx
Basic conventions
sources  src/main/actionscript (srcDirs property)
resources  src/main/resources (resourceDirs property)
test sources  src/test/actionscript (testDirs property)
test resources  src/test/resources (testResourceDirs property)
mxml main class  Main.mxml in src/main/actionscript/ (mainClass property)
build directory  build (project.buildDir property)

28. GradleFx
Some advanced properties
Compiler options
additionalCompilerOptions property
One item per compiler option
additionalCompilerOptions = [
'-use-network=true',
'-locale=en_US',
'-keep-as3-metadata+=Autowired,RemoteClass‘
]
JVM options
jvmArguments property
jvmArguments = ['-Xmx1024m','-Xms512m']

29. GradleFx
Dependency management
Configurations
Merged (-compiler.library-path)
Internal (-compiler.include-libraries)
External (-compiler.external-library-path)
Rsl (-runtime-shared-library-path)
Test
Example
external group: 'org.as3commons', name: 'as3commons-eventbus', version: '1.1', ext: 'swc'
merged group: 'org.graniteds', name: 'granite-swc', version: '2.2.0.SP1', ext: 'swc'

30. GradleFx
AIR project required steps
Create AIR descriptor file
Convention
"/src/main/actionscript/$,project.name-.xml“
Custom value
air.applicationDescriptor: "/src/main/flex/airdescriptor.xml“
Certificate
Needed to sign the AIR package
PKCS12 format
Password required
Convention
"$,project.name-.p12“
Custom value
air.keystore: "certificate.p12“
air.storepass = "mypassword"

31. GradleFx
FlexUnit required steps
Specify FlexUnit home
Convention
FLEXUNIT_HOME environment variable
Custom value
flexUnit.home = 'c:/flexunit/4.1'
Specify Flash Player executable
Convention
FLASH_PLAYER_EXE environment variable
Custom value
flexunit.command = ‘c:/flashplayer/flashplayer_10.exe’
Specify FlexUnit ant task jar name
Located in FlexUnit home directory
Custom value
flexUnit.antTasksJar = 'flexUnitTasks-4.1.0-8.jar'

32. GradleFx
FlexUnit required steps
Specify FlexUnit dependencies
dependencies {
test files( "${flexUnit.home}/flexunit-4.1.0-8-flex_4.1.0.16076.swc",
"${flexUnit.home}/flexunit-uilistener-4.1.0-8-4.1.0.16076.swc",
"${flexUnit.home}/flexunit-cilistener-4.1.0-8-4.1.0.16076.swc“)
}
Specify testRunner class
testClass = 'MyTestRunner.mxml'

33. GradleFx
DEMO

34. GradleFx
What’s to come?
IDEA and Eclipse project generation support
AS3Doc generation
Flex SDK maven artifact support?

35. GradleFx
Where to go next
GradleFx site: https://github.com/GradleFx/GradleFx
Source: https://github.com/GradleFx/GradleFx
Documentation: https://github.com/GradleFx/GradleFx/wiki
Examples: https://github.com/GradleFx/GradleFx-Examples
Help & Support: http://gradlefx.tenderapp.com/home
Bug tracker: https://github.com/GradleFx/GradleFx/issues
Changelog: https://github.com/GradleFx/GradleFx/blob/master/CHANGELOG.textile