No description or website provided.
Scala Java HTML JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
library
play-querydsl-sample
.gitignore
README.md

README.md

play-querydsl

QueryDSL entity generation for Play 2.x. Implemented as sbt plugin.

Installation

Add following to your projects project/plugins.sbt

addSbtPlugin("com.code-troopers.play" % "play-querydsl" % "0.1.2")

In Play >= 2.3 you will be able to benefit from AutoPlugin mecanism from SBT, this way you only need to add to your project the enablePlugins(QueryDSLPlugin) magic.

In addition you'll need to add settings to your project. On Play 2.2 this is done by modifying build.sbt and adding settings for the QueryDSLPlugin as well as adding its dependency scope.

playJavaSettings ++ QueryDSLPlugin.queryDSLSettings

val current = project.in(file(".")).configs(QueryDSLPlugin.QueryDSL)

On Play 2.1 and Play 2.0 you should do following changes to project/Build.scala.

val main = play.Project(appName, appVersion, appDependencies,
                        settings = playJavaSettings ++ QueryDSLPlugin.queryDSLSettings)
                        .settings(
                        // your settings
                        )
                        .configs(QueryDSLPlugin.QueryDSL)

This adds QueryDSL support for JPA entities in your PlayFramework! project. Please note that EBeans should no longer be used or it will lead to compilation errors (and it does not make sense anyway).

Settings

By default, the plugin scans for changes for classes in the models package (according to the default directory layout of PlayFramework!). If you want to customize this to allow scanning in another package, you will have to set the plugin property QueryDSLPlugin.queryDSLPackage to the correct value in your project settings

//From Play 2.3 and onward (thanks to autoImport feature)
queryDSLPackage := "com/codetroopers/app/models"
//OR Up to play 2.2
QueryDSLPlugin.queryDSLPackage := "com/codetroopers/app/models"

Versions

  • 0.1.2 [2015-03-28]

    Fixes #1 and #2 by respecting queryDSLPackage settings

    Added a sample project to show usage

  • 0.1.1 [2014-03-17]

    Added caching to speed up development (no annotation scanning when entities are not touched)

    Generation of sources is done in a correct directory to allow proper use in IDE (packages were incorrect)

  • 0.1.0 [2014-03-12]

    Initial release

Acknowledgements

This plugin is based on sbt-scalabuff plugin and QueryDSL ant configuration recommendation.

As it is a first sbt plugin, there is a lot of thing to improve:

  • generate QueryDSL entities only on source change (done in 0.1.1)
  • probably better handling of Config in the plugin
  • add tests
  • a lot more !

License

Copyright 2014 Cedric Gatay

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

    http://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.