Skip to content

Latest commit

 

History

History
95 lines (71 loc) · 5.43 KB

quickstart.md

File metadata and controls

95 lines (71 loc) · 5.43 KB
Raw
CI Test coverage(%) Code quality Stable version ScalaDoc Chat Open issues Average issue resolution time
Build Status Coverage Status Codacy Rating Maven Central ScalaDoc Gitter Percentage of issues still open Average time to resolve an issue

Integrating phantom in your project

back to top

There are no additional resolvers required for any version of phantom newer than 2.0.0. All Outworkers libraries are open source, licensed via Apache V2. As of version 2.2.1, phantom has no external transitive dependencies other than shapeless and the Java driver.

For most things, all you need is a dependency on the phantom-dsl module.

For most things, all you need is the main phantom-dsl module. This will bring in the default module with all the query generation ability, as well as phantom-connectors and database objects that help you manage your entire database layer on the fly. All other modules implement enhanced integration with other tools, but you don't need them to get started. This module only depends on the datastax-java-driver and the shapeless library.

libraryDependencies ++= Seq(
  "com.outworkers"  %% "phantom-dsl" % phantomVersion
)

If you are still using Scala 2.10, you must also add a compile time dependency on the macro paradise plugin. This is because phantom uses shapeless.Generic under the hood and that needs the paradise plugin to work on Scala 2.10.

libraryDependencies ++= Seq(
  compilerPlugin("org.scalamacros" % "paradise" % Versions.macroParadise cross CrossVersion.full)
)

The full list of available modules

The full list of available modules is:

libraryDependencies ++= Seq(
  "com.outworkers"   %% "phantom-connectors" % phantomVersion,
  "com.outworkers"   %% "phantom-dsl" % phantomVersion,
  "com.outworkers"   %% "phantom-example" % phantomVersion,
  "com.outworkers"   %% "phantom-finagle" % phantomVersion,
  "com.outworkers"   %% "phantom-jdk8" % phantomVersion,
  "com.outworkers"   %% "phantom-thrift" % phantomVersion,
  "com.outworkers"   %% "phantom-streams" % phantomVersion,
  "com.outworkers"   %% "phantom-sbt" % phantomVersion
)

If you include phantom-finagle or phantom-thrift, make sure to add the following resolvers:

resolvers += "twitter-repo" at "http://maven.twttr.com"

Using phantom-sbt to test requires custom resolvers

In your plugins.sbt, you will also need this if you plan to use phantom-sbt. Phantom SBT is no longer actively maintained as we are looking to produce a replacement for it. There are many many problems with running embedded Cassandra in a forked VM that are very difficult to address and not worthwhile, as even a perfect implementation is severely lacking in features.

The replacement module will not be available open source, but it will allow you to:

  • Configure the Cassandra setup from within SBT or tests.
  • Uses more powerful mechanisms under the hood to allow testing against an entire cluster instead of just one node.
  • Allow you to configure which version of Cassandra to target.
  • Has in depth options for configuring logging, health metrics, VM performance and much more.
  • It will also have the capacity to auto-generate the entire schema for a project using an SBT task in a way compatible with phantom-migrations.

This will be available via a phantom-pro paid subscription only.

def baseResolverPattern = {
  Patterns(Resolver.mavenStyleBasePattern, Resolver.mavenStyleBasePattern, true)
}

resolvers ++= Seq(
  Resolver.url("Maven Ivy Outworkers", url(Resolver.DefaultMavenRepositoryRoot))(baseResolverPattern)
)

addSbtPlugin("com.outworkers" %% "phantom-sbt" % phantomVersion)

Using phantom with the Spray framework

Spray users will probably be affected by a conflict in shapeless versions. To fix the conflict, add the following dependency to your build, which will allow you to use phantom and Spray together without any issues.

libraryDependencies ++= Seq(
  "io.spray" %% "spray-routing-shapeless2" % SprayVersion
)