tips and tricks for setting up a play 2 project

@elmanu#DV13PlayTricks

Tips and tricks for setting up a Play 2 project

!!

Manuel Bernhardt


play new hello-playLet’s get started


name := "hello-play"!!version := "1.0-SNAPSHOT"!!libraryDependencies ++= Seq(! jdbc,! anorm,! cache!) !!play.Project.playScalaSettings!

Hello world - build.sbt


// Comment to get more information during initialization!logLevel := Level.Warn!!// The Typesafe repository !resolvers += "Typesafe repository" at "http://repo.typesafe.com/typesafe/releases/"!!// Use the Play sbt plugin for Play projects!addSbtPlugin("com.typesafe.play" % "sbt-plugin" % "2.2.1")!

Hello world - plugins.sbt


First things first: Scalariform!

Code indentation is good for your health


// Comment to get more information during initialization!logLevel := Level.Warn!!// The Typesafe repository !resolvers += "Typesafe repository" at "http://repo.typesafe.com/typesafe/releases/"!!// Use the Play sbt plugin for Play projects!addSbtPlugin("com.typesafe.play" % "sbt-plugin" % "2.2.0")!!addSbtPlugin("com.typesafe.sbt" % "sbt-scalariform" % "1.2.0")!

Scalariform! - plugins.sbt


name := "hello-play"!!version := "1.0-SNAPSHOT"!!libraryDependencies ++= Seq(cache)!!play.Project.playScalaSettings!!scalariformSettings

Scalariform! - build.sbt


Scalastyle Keep it clean


// Comment to get more information during initialization!logLevel := Level.Warn!!// The Typesafe repository !resolvers += "Typesafe repository" at "http://repo.typesafe.com/typesafe/releases/"!!// Use the Play sbt plugin for Play projects!addSbtPlugin("com.typesafe.play" % "sbt-plugin" % "2.2.0")!!addSbtPlugin("com.typesafe.sbt" % "sbt-scalariform" % "1.2.0")!!addSbtPlugin("org.scalastyle" %% "scalastyle-sbt-plugin" % "0.3.2")

Scalastyle! - plugins.sbt


name := "hello-play"!!version := "1.0-SNAPSHOT"!!libraryDependencies ++= Seq(cache)!!play.Project.playScalaSettings!!scalariformSettings!!org.scalastyle.sbt.ScalastylePlugin.Settings

Scalastyle! - build.sbt


<scalastyle>! <name>Scalastyle sample configuration</name>! <check level=“warning”! class=“org.scalastyle.file.FileLineLengthChecker"! enabled="true">! <parameters>! <parameter name="maxLineLength"><![CDATA[100]]></parameter>! <parameter name="tabSize"><![CDATA[2]]></parameter>! </parameters>! </check>!</scalastyle>

Scalastyle! - scalastyle-config.xml


<?xml version="1.0" encoding="US-ASCII"?>!<checkstyle version=“5.0”>! <file name=“/Users/manu/w/hello-play/app/controllers/Application.scala">! <error line=“12"! source=“org.scalastyle.file.FileLineLengthChecker"! severity=“warning"! message="File line length exceeds 100 characters”>! </error>! </file>!</checkstyle>!

Scalastyle! - Output


Sub-projects!

Keeping things fast


Core

Module 1 Module 2

Root


play.Project.playScalaSettings!!def playProject(name: String) = play.Project(! name = name,! path = file("modules/" + name)! ).! settings(scalariformSettings :_*).! settings(org.scalastyle.sbt.ScalastylePlugin.Settings :_*)!!lazy val core = playProject("core")!!lazy val module1 = playProject("module1").dependsOn(core)!!lazy val module2 = playProject("module2").dependsOn(core)!!lazy val root = playProject("hello-play").in(file(".")).!! ! dependsOn(module1, module2).! aggregate(module1, module2)

Sub-projects - build.sbt


application.conf


routes

module2.routes

module1.routes

application.conf


Snapshot dependencies and multi-module projects

Workarounds


Snapshot dependencies

• https://github.com/sbt/sbt/issues/413

https://github.com/sbt/sbt/issues/413


Snapshot dependencies - workarounds

• Don’t use snapshot dependencies

• Convince library authors to make releases

• Use a cache, e.g. Squid

• OS X: http://squidman.net/squidman

-‐Dhttp.proxyHost=localhost -‐Dhttp.proxyPort=8090

http://squidman.net/squidman


Tools for ChromeAfter all, we’re building web-applications


https://chrome.google.com/webstore/detail/play-framework-tools/dchhggpgbommpcjpogaploblnpldbmen

https://chrome.google.com/webstore/detail/play-framework-tools/dchhggpgbommpcjpogaploblnpldbmen


// Comment to get more information during initialization!logLevel := Level.Warn!!// The Typesafe repository !resolvers += "Typesafe repository" at "http://repo.typesafe.com/typesafe/releases/"!!// Use the Play sbt plugin for Play projects!addSbtPlugin("com.typesafe.play" % "sbt-plugin" % "2.2.0")!!addSbtPlugin("com.typesafe.sbt" % "sbt-scalariform" % "1.2.0")!!addSbtPlugin("org.scalastyle" %% "scalastyle-sbt-plugin" % "0.3.2")!!addSbtPlugin("com.jamesward" %% "play-auto-refresh" % "0.0.7")

Play Auto Refresh - plugins.sbt


name := "hello-play"!!version := "1.0-SNAPSHOT"!!libraryDependencies ++= Seq(! jdbc,! anorm,! cache!) !!play.Project.playScalaSettings!!scalariformSettings!!org.scalastyle.sbt.ScalastylePlugin.Settings!!com.jamesward.play.BrowserNotifierPlugin.livereload

Play Auto Refresh - build.sbt


No more ⌘+R, yeah!

play ~ run

Chrome

Your IDE


Open errors in IDE

Instructions at https://github.com/jamesward/play-framework-chrome-tools

Click to open in editor

https://github.com/jamesward/play-framework-chrome-tools


Use dependency injection right away

A poor man’s solution


package controllers!!class Users(greeting: String) extends BaseController {!! def hello = Action { implicit request =>! ! Ok(greeting)! }!!}

DI - Users controller


GET /users @controllers.Users.hello!

DI - Routes


import controllers.Users!import play.api.GlobalSettings!!object Global extends GlobalSettings {!! override def getControllerInstance[A](controllerClass: Class[A]): A = {!! val USERS = classOf[Users]!! val instance = controllerClass match {! case USERS => new Users("Hello users")! case _ => super.getControllerInstance(controllerClass)! }!! instance.asInstanceOf[A]! }!}

DI - Global.scala


That’s it! Questions?!

https://github.com/manuelbernhardt/hello-play-dv13 !

http://manuel.bernhardt.io

https://github.com/manuelbernhardt/hello-play-dv13

http://manuel.bernhardt.io

tips and tricks for setting up a play 2 project

Technology