Skip to content

Commit

Permalink
deleted jawn subproject and updated updated docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
Ryan Plessner committed Jun 8, 2015
1 parent 6ffe2df commit 94e3a0c
Show file tree
Hide file tree
Showing 8 changed files with 6 additions and 157 deletions.
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,9 @@ Modules
Finch uses multi-project structure and contains of the following _modules_:

* [`finch-core`](core) - the core classes/functions
* [`finch-json`](json) - the lightweight and immutable JSON API. __DEPRECATED__
* [`finch-auth`](auth) - the Basic HTTP Auth support
* [`finch-demo`](demo) - the demo project
* [`finch-playground`](playground) - the playground project
* [`finch-jawn`](jawn) - the JSON API support for the [Jawn](https://github.com/non/jawn) library __DEPRECATED__
* [`finch-argonaut`](argonaut) - the JSON API support for the [Argonaut](http://argonaut.io/) library
* [`finch-jackson`](jackson) - the JSON API support for the [Jackson](http://jackson.codehaus.org/) library
* [`finch-json4s`](json4s) - the JSON API support for the [JSON4S](http://json4s.org/) library
Expand Down
14 changes: 1 addition & 13 deletions build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ lazy val root = project.in(file("."))
|import io.finch.route._
""".stripMargin
)
.aggregate(core, demo, playground, jawn, argonaut, jackson, json4s, auth, benchmarks)
.aggregate(core, demo, playground, argonaut, jackson, json4s, auth, benchmarks)
.dependsOn(core, argonaut)

lazy val core = project
Expand Down Expand Up @@ -142,18 +142,6 @@ lazy val playground = project
.disablePlugins(JmhPlugin)
.dependsOn(core, jackson)

lazy val jawn = project
.settings(moduleName := "finch-jawn")
.settings(allSettings)
.settings(coverageExcludedPackages := "io\\.finch\\.jawn\\..*")
.settings(
libraryDependencies ++= Seq(
"org.spire-math" %% "jawn-parser" % "0.7.4",
"org.spire-math" %% "jawn-ast" % "0.7.4"
)
)
.dependsOn(core)

lazy val argonaut = project
.settings(moduleName := "finch-argonaut")
.settings(allSettings)
Expand Down
1 change: 0 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,5 @@ depending on a content. There are plenty of predefined builders that might be us
* [Argonaut](json.md#argonaut)
* [Jackson](json.md#jackson)
* [JSON4S](json.md#json4s)
* [Jawn](json.md#jawn) (deprecated in 0.7.0)

[1]: http://twitter.github.io/finagle/
22 changes: 4 additions & 18 deletions docs/json.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
## JSON

* [Argonaut](json.md#argonaut)
* [Jawn](json.md#jawn)
* [Jackson](json.md#jackson)
* [Json4s](json.md#json4s)

Expand All @@ -11,21 +10,9 @@

The `finch-argonaut` module provides the support for the [Argonaut][1] JSON library.

### Jawn

This library is deprecated in favor of other JSON libraries.

The `finch-jawn` module provides the support for [Jawn][2].

To decode a string with Jawn, you need to import `io.finch.jawn._` and define any Jawn `Facade` as an `implicit val`.
Using either `RequiredJsonBody` or `OptionalJsonBody` will take care of the rest.

To encode a value from the Jawn AST (specifically a `JValue`), you need only import `io.finch.jawn._` and
the `Encoder` will be imported implicitly.

### Jackson

The `finch-jackson` module provides the support for the [Jackson][3] library. The library usage looks as follows:
The `finch-jackson` module provides the support for the [Jackson][2] library. The library usage looks as follows:

```scala
import io.finch.jackson._
Expand All @@ -38,7 +25,7 @@ val foo: RequestReader[Foo] = body.as[Foo] // a request reader that reads Foo

### Json4s

The `finch-json4s` module provides the support for the [JSON4S][4] library. The library usage looks as follows:
The `finch-json4s` module provides the support for the [JSON4S][3] library. The library usage looks as follows:

```scala
import io.finch.json4s._
Expand All @@ -50,6 +37,5 @@ val foo: RequestReader[Bar] = body.as[Bar] // a request reader that reads Bar
```

[1]: http://argonaut.io
[2]: https://github.com/non/jawn
[3]: http://jackson.codehaus.org/
[4]: http://json4s.org/
[2]: http://jackson.codehaus.org/
[3]: http://json4s.org/
2 changes: 1 addition & 1 deletion docs/request.md
Original file line number Diff line number Diff line change
Expand Up @@ -434,7 +434,7 @@ val user: RequestReader[Interval] = (
#### Integration with JSON Libraries

A third way of using the `as[A]` type conversion facility is to use one of the JSON library integrations Finch offers.
Finch comes with support for [Argonaut](json.md#argonaut), [Jawn](json.md#jawn), [Jackson](json.md#jackson) and [JSON4S](json.md#json4s).
Finch comes with support for [Argonaut](json.md#argonaut), [Jackson](json.md#jackson) and [JSON4S](json.md#json4s).

All these integration modules do is make the library-specific JSON decoders available for use as a `DecodeRequest[A]`.
To take Argonaut as an example, you only have to import `io.finch.argonaut._` to have implicit Argonaut
Expand Down
15 changes: 0 additions & 15 deletions jawn/README.md

This file was deleted.

60 changes: 0 additions & 60 deletions jawn/src/main/scala/io/finch/jawn/package.scala

This file was deleted.

47 changes: 0 additions & 47 deletions jawn/src/test/scala/io/finch/jawn/JawnSpec.scala

This file was deleted.

0 comments on commit 94e3a0c

Please sign in to comment.