Merge pull request #12 from seratch/rename-jackson-modules

Rename jackson/json4s modules

README.md

@@ -19,16 +19,16 @@ lazy val skinnyMicroVersion = "0.9.9"
 
 libraryDependencies ++= Seq(
   // micro Web framework
-  "org.skinny-framework" %% "skinny-micro"         % skinnyMicroVersion,
+  "org.skinny-framework" %% "skinny-micro"             % skinnyMicroVersion,
   // jackson integration
-  "org.skinny-framework" %% "skinny-micro-json"    % skinnyMicroVersion,
-  "org.skinny-framework" %% "skinny-micro-xml"     % skinnyMicroVersion,
+  "org.skinny-framework" %% "skinny-micro-jackson"     % skinnyMicroVersion,
+  "org.skinny-framework" %% "skinny-micro-jackson-xml" % skinnyMicroVersion,
   // json4s integration
-  "org.skinny-framework" %% "skinny-micro-json4s"  % skinnyMicroVersion,
+  "org.skinny-framework" %% "skinny-micro-json4s"      % skinnyMicroVersion,
   // Scalate integration
-  "org.skinny-framework" %% "skinny-micro-scalate" % skinnyMicroVersion,
+  "org.skinny-framework" %% "skinny-micro-scalate"     % skinnyMicroVersion,
   // Standalone Web server (Jetty 9.2 / Servlet 3.1)
-  "org.skinny-framework" %% "skinny-micro-server"  % skinnyMicroVersion
+  "org.skinny-framework" %% "skinny-micro-server"      % skinnyMicroVersion
 )
 ```
 

micro-xml/src/main/scala/skinny/xml/XMLStringOps.scala → micro-jackson-xml/src/main/scala/skinny/jackson/XMLStringOps.scala

@@ -1,12 +1,12 @@
-package skinny.xml
+package skinny.jackson
 
-import com.fasterxml.jackson.core.util.DefaultPrettyPrinter
 import com.fasterxml.jackson.databind.{ DeserializationFeature, PropertyNamingStrategy }
 import com.fasterxml.jackson.dataformat.xml.XmlMapper
 import com.fasterxml.jackson.dataformat.xml.util.DefaultXmlPrettyPrinter
 import com.fasterxml.jackson.module.scala.DefaultScalaModule
 import com.fasterxml.jackson.module.scala.experimental.ScalaObjectMapper
-import skinny.json.JSONStringOps._
+import skinny.jackson.JSONStringOps._
+
 import scala.util.{ Failure, Success, Try }
 
 /**

micro-xml/src/main/scala/skinny/micro/contrib/XMLSupport.scala → micro-jackson-xml/src/main/scala/skinny/micro/contrib/jackson/XMLSupport.scala

@@ -1,6 +1,6 @@
-package skinny.micro.contrib
+package skinny.micro.contrib.jackson
 
-import skinny.xml.XMLStringOps
+import skinny.jackson.XMLStringOps
 import skinny.micro.context.SkinnyContext
 import skinny.micro.{ Format, SkinnyMicroBase }
 

micro-xml/src/test/scala/example/FutureSpec.scala → micro-jackson-xml/src/test/scala/example/FutureSpec.scala

@@ -1,11 +1,10 @@
 package example
 
 import org.scalatra.test.scalatest.ScalatraFlatSpec
-import skinny.micro.contrib.XMLSupport
+import skinny.micro.contrib.jackson.XMLSupport
 import skinny.micro.{ AsyncSkinnyMicroServlet, ServletConcurrencyException }
 
 import scala.concurrent.Future
-import scala.concurrent.duration._
 
 class FutureSpec extends ScalatraFlatSpec {
 

micro-xml/src/test/scala/example/HelloServletSpec.scala → micro-jackson-xml/src/test/scala/example/HelloServletSpec.scala

@@ -2,7 +2,7 @@ package example
 
 import org.scalatra.test.scalatest.ScalatraFlatSpec
 import skinny.micro._
-import skinny.micro.contrib.XMLSupport
+import skinny.micro.contrib.jackson.XMLSupport
 
 import scala.concurrent.Future
 

micro-xml/src/test/scala/example/HelloSpec.scala → micro-jackson-xml/src/test/scala/example/HelloSpec.scala

@@ -3,7 +3,7 @@ package example
 import org.scalatra.test.scalatest.ScalatraFlatSpec
 import skinny.micro._
 import skinny.micro.async.AsyncResult
-import skinny.micro.contrib.XMLSupport
+import skinny.micro.contrib.jackson.XMLSupport
 
 import scala.concurrent.Future
 

micro-xml/src/test/scala/example/XMLOperationSpec.scala → micro-jackson-xml/src/test/scala/example/XMLOperationSpec.scala

@@ -2,7 +2,7 @@ package example
 
 import org.scalatra.test.scalatest.ScalatraFlatSpec
 import skinny.micro.SkinnyMicroFilter
-import skinny.micro.contrib.XMLSupport
+import skinny.micro.contrib.jackson.XMLSupport
 
 class XMLOperationSpec extends ScalatraFlatSpec {
 

micro-xml/src/test/scala/example/XMLStringOpsSpec.scala → micro-jackson-xml/src/test/scala/example/XMLStringOpsSpec.scala

@@ -1,7 +1,7 @@
 package example
 
 import org.scalatest._
-import skinny.xml.XMLStringOps
+import skinny.jackson.XMLStringOps
 
 case class SomeGroup(name: String, groupMembers: Seq[Member])
 case class Member(id: Long, name: Option[String])

micro-json4s/src/main/scala/skinny/json4s/Json4sAngularJSONStringOps.scala → micro-jackson/src/main/scala/skinny/jackson/AngularJSONStringOps.scala

@@ -1,12 +1,12 @@
-package skinny.json4s
+package skinny.jackson
 
 /**
  * JSON String operations for Angular application's server side.
  *
  * - camelCase keys
  * - JSON vulnerability protection enabled by default
  */
-trait Json4sAngularJSONStringOps extends Json4sJSONStringOps {
+trait AngularJSONStringOps extends JSONStringOps {
 
   // JSON vulnerability protection enabled by default
   override protected def useJSONVulnerabilityProtection: Boolean = true
@@ -16,4 +16,4 @@ trait Json4sAngularJSONStringOps extends Json4sJSONStringOps {
 
 }
 
-object Json4sAngularJSONStringOps extends Json4sAngularJSONStringOps
+object AngularJSONStringOps extends AngularJSONStringOps

micro-json/src/main/scala/skinny/json/JSONStringOps.scala → micro-jackson/src/main/scala/skinny/jackson/JSONStringOps.scala

@@ -1,4 +1,4 @@
-package skinny.json
+package skinny.jackson
 
 import com.fasterxml.jackson.core.util.DefaultPrettyPrinter
 import com.fasterxml.jackson.databind.`type`.CollectionType

micro-json/src/main/scala/skinny/micro/contrib/JSONParamsAutoBinderSupport.scala → micro-jackson/src/main/scala/skinny/micro/contrib/jackson/JSONParamsAutoBinderSupport.scala

@@ -1,7 +1,7 @@
-package skinny.micro.contrib
+package skinny.micro.contrib.jackson
 
 import org.slf4j.LoggerFactory
-import skinny.json.JSONStringOps
+import skinny.jackson.JSONStringOps
 import skinny.logging.LoggerProvider
 import skinny.micro.context.SkinnyContext
 import skinny.micro.routing.MatchedRoute

micro-json/src/main/scala/skinny/micro/contrib/JSONSupport.scala → micro-jackson/src/main/scala/skinny/micro/contrib/jackson/JSONSupport.scala

@@ -1,6 +1,6 @@
-package skinny.micro.contrib
+package skinny.micro.contrib.jackson
 
-import skinny.json.JSONStringOps
+import skinny.jackson.JSONStringOps
 import skinny.micro.context.SkinnyContext
 import skinny.micro.{ Format, SkinnyMicroBase }
 

micro-json/src/test/scala/example/FutureSpec.scala → micro-jackson/src/test/scala/example/FutureSpec.scala

@@ -1,11 +1,10 @@
 package example
 
 import org.scalatra.test.scalatest.ScalatraFlatSpec
-import skinny.micro.contrib.JSONSupport
+import skinny.micro.contrib.jackson.JSONSupport
 import skinny.micro.{ AsyncSkinnyMicroServlet, ServletConcurrencyException }
 
 import scala.concurrent.Future
-import scala.concurrent.duration._
 
 class FutureSpec extends ScalatraFlatSpec {
 

micro-json/src/test/scala/example/HelloServletSpec.scala → micro-jackson/src/test/scala/example/HelloServletSpec.scala

@@ -2,7 +2,7 @@ package example
 
 import org.scalatra.test.scalatest.ScalatraFlatSpec
 import skinny.micro._
-import skinny.micro.contrib.JSONSupport
+import skinny.micro.contrib.jackson.JSONSupport
 
 import scala.concurrent.Future
 

micro-json/src/test/scala/example/HelloSpec.scala → micro-jackson/src/test/scala/example/HelloSpec.scala

@@ -3,7 +3,7 @@ package example
 import org.scalatra.test.scalatest.ScalatraFlatSpec
 import skinny.micro._
 import skinny.micro.async.AsyncResult
-import skinny.micro.contrib.JSONSupport
+import skinny.micro.contrib.jackson.JSONSupport
 
 import scala.concurrent.Future
 

micro-json/src/test/scala/example/JSONOperation2Spec.scala → micro-jackson/src/test/scala/example/JSONOperation2Spec.scala

@@ -1,7 +1,7 @@
 package example
 
 import org.scalatest._
-import skinny.json.JSONStringOps
+import skinny.jackson.JSONStringOps
 
 case class Samples(samples: Seq[Sample])
 case class Sample(id: Long, firstName: String)

micro-json/src/test/scala/example/JSONOperationSpec.scala → micro-jackson/src/test/scala/example/JSONOperationSpec.scala

@@ -1,9 +1,9 @@
 package example
 
 import org.scalatra.test.scalatest.ScalatraFlatSpec
-import skinny.json.JSONStringOps
+import skinny.jackson.JSONStringOps
 import skinny.micro.SkinnyMicroFilter
-import skinny.micro.contrib.JSONSupport
+import skinny.micro.contrib.jackson.JSONSupport
 
 import scala.util.Success
 

micro-json/src/test/scala/example/JSONParamsAutoBinderSupportSpec.scala → micro-jackson/src/test/scala/example/JSONParamsAutoBinderSupportSpec.scala

@@ -1,9 +1,9 @@
 package example
 
 import org.scalatra.test.scalatest.ScalatraFlatSpec
-import skinny.json.JSONStringOps
+import skinny.jackson.JSONStringOps
 import skinny.micro.WebApp
-import skinny.micro.contrib.JSONParamsAutoBinderSupport
+import skinny.micro.contrib.jackson.JSONParamsAutoBinderSupport
 
 class JSONParamsAutoBinderSupportSpec extends ScalatraFlatSpec {
 

micro-json/src/test/scala/example/JSONStringOpsSpec.scala → micro-jackson/src/test/scala/example/JSONStringOpsSpec.scala

@@ -1,7 +1,7 @@
 package example
 
 import org.scalatest._
-import skinny.json.JSONStringOps
+import skinny.jackson.JSONStringOps
 
 case class SomeGroup(name: String, groupMembers: Seq[Member])
 case class Member(id: Long, name: Option[String])

micro-json/src/main/scala/skinny/json/AngularJSONStringOps.scala → micro-json4s/src/main/scala/skinny/json4s/AngularJSONStringOps.scala

@@ -1,4 +1,4 @@
-package skinny.json
+package skinny.json4s
 
 /**
  * JSON String operations for Angular application's server side.

micro-json4s/src/main/scala/skinny/json4s/Json4sJSONStringOps.scala → micro-json4s/src/main/scala/skinny/json4s/JSONStringOps.scala

@@ -4,12 +4,12 @@ import com.fasterxml.jackson.databind.{ DeserializationFeature, ObjectMapper, Ob
 import org.json4s._
 import org.json4s.jackson.Json4sScalaModule
 
-import scala.util.control.Exception._
+import scala.util.Try
 
 /**
  * Easy-to-use JSON String Operation.
  */
-trait Json4sJSONStringOps {
+trait JSONStringOps {
 
   /**
    * Use the prefix for JSON Vulnerability Protection.
@@ -56,12 +56,10 @@ trait Json4sJSONStringOps {
     }
   }
 
-  private[this] def parseOpt(in: JsonInput, useBigDecimalForDouble: Boolean = false): Option[JValue] = allCatch opt {
+  private[this] def tryParsing(in: JsonInput, useBigDecimalForDouble: Boolean = false): Try[JValue] = Try {
     parse(in, useBigDecimalForDouble)
   }
 
-  private[this] def render(value: JValue): JValue = value
-
   private[this] def pretty(d: JValue): String = {
     val writer: ObjectWriter = mapper.writerWithDefaultPrettyPrinter()
     writer.writeValueAsString(d)
@@ -140,7 +138,7 @@ trait Json4sJSONStringOps {
    * @tparam A return type
    * @return value
    */
-  def fromJSONString[A](json: String, underscoreKeys: Boolean = false, asIs: Boolean = false)(implicit mf: Manifest[A]): Option[A] = {
+  def fromJSONString[A](json: String, underscoreKeys: Boolean = false, asIs: Boolean = false)(implicit mf: Manifest[A]): Try[A] = {
     fromJSONStringToJValue(json, underscoreKeys, asIs).map[A](_.extract[A])
   }
 
@@ -160,7 +158,7 @@ trait Json4sJSONStringOps {
    * @tparam A return type
    * @return value
    */
-  def fromJSONStringAsIs[A](json: String)(implicit mf: Manifest[A]): Option[A] = fromJSONString(json, false, true)
+  def fromJSONStringAsIs[A](json: String)(implicit mf: Manifest[A]): Try[A] = fromJSONString(json, false, true)
 
   /**
    * Extracts a JSON value from JSON string.
@@ -170,14 +168,14 @@ trait Json4sJSONStringOps {
    * @param underscoreKeys underscore keys
    * @return value
    */
-  def fromJSONStringToJValue(json: String, underscoreKeys: Boolean = false, asIs: Boolean = false): Option[JValue] = {
+  def fromJSONStringToJValue(json: String, underscoreKeys: Boolean = false, asIs: Boolean = false): Try[JValue] = {
     val pureJson = if (useJSONVulnerabilityProtection &&
       json.startsWith(prefixForJSONVulnerabilityProtection)) {
       json.replace(prefixForJSONVulnerabilityProtection, "")
     } else {
       json
     }
-    parseOpt(StringInput(pureJson)).map { v =>
+    tryParsing(StringInput(pureJson)).map { v =>
       if (asIs) v
       else if (underscoreKeys) v.underscoreKeys
       else v.camelizeKeys
@@ -186,5 +184,5 @@ trait Json4sJSONStringOps {
 
 }
 
-object Json4sJSONStringOps
-  extends Json4sJSONStringOps
+object JSONStringOps
+  extends JSONStringOps

micro-json4s/src/main/scala/skinny/micro/contrib/Json4sJSONParamsAutoBinderSupport.scala → micro-json4s/src/main/scala/skinny/micro/contrib/json4s/JSONParamsAutoBinderSupport.scala

@@ -1,11 +1,11 @@
-package skinny.micro.contrib
+package skinny.micro.contrib.json4s
 
 import java.io.{ InputStream, InputStreamReader }
 
 import org.json4s.Xml._
 import org.json4s._
 import org.slf4j.LoggerFactory
-import skinny.json4s.Json4sJSONStringOps
+import skinny.json4s.JSONStringOps
 import skinny.logging.LoggerProvider
 import skinny.micro.context.SkinnyContext
 import skinny.micro.routing.MatchedRoute
@@ -18,17 +18,17 @@ import skinny.micro.{ ApiFormats, Params, SkinnyMicroBase, SkinnyMicroParams }
  *
  * NOTICE: Avoid extending JacksonJsonSupport due to render method conflict
  */
-trait Json4sJSONParamsAutoBinderSupport
+trait JSONParamsAutoBinderSupport
     extends SkinnyMicroBase
-    with Json4sJSONStringOps
+    with JSONStringOps
     with ApiFormats
     with LoggerProvider {
 
   /**
    * Merge parsedBody (JValue) into params if possible.
    */
   override def params(implicit ctx: SkinnyContext): Params = {
-    if (request(ctx).get(Json4sSupport.ParsedBodyKey).isDefined) {
+    if (request(ctx).get(JSONSupport.ParsedBodyKey).isDefined) {
       try {
         val jsonParams: Map[String, Seq[String]] = parsedBody(ctx).extract[Map[String, String]].mapValues(v => Seq(v))
         val mergedParams: Map[String, Seq[String]] = getMergedMultiParams(multiParams(ctx), jsonParams)
@@ -53,7 +53,7 @@ trait Json4sJSONParamsAutoBinderSupport
       val mt = request(context).contentType.fold("application/x-www-form-urlencoded")(_.split(";").head)
       val fmt = mimeTypes get mt getOrElse "html"
       if (shouldParseBody(fmt)(context)) {
-        request(ctx)(Json4sSupport.ParsedBodyKey) = parseRequestBody(fmt)(ctx).asInstanceOf[AnyRef]
+        request(ctx)(JSONSupport.ParsedBodyKey) = parseRequestBody(fmt)(ctx).asInstanceOf[AnyRef]
       }
       super.invoke(matchedRoute)
     }
@@ -139,12 +139,12 @@ trait Json4sJSONParamsAutoBinderSupport
   }
 
   private[this] def parsedBody(implicit ctx: SkinnyContext): JValue = {
-    ctx.request.get(Json4sSupport.ParsedBodyKey).fold({
+    ctx.request.get(JSONSupport.ParsedBodyKey).fold({
       val fmt = requestFormat(ctx)
       var bd: JValue = JNothing
       if (fmt == "json" || fmt == "xml") {
         bd = parseRequestBody(fmt)(ctx)
-        ctx.request(Json4sSupport.ParsedBodyKey) = bd.asInstanceOf[AnyRef]
+        ctx.request(JSONSupport.ParsedBodyKey) = bd.asInstanceOf[AnyRef]
       }
       bd
     })(_.asInstanceOf[JValue])

micro-json4s/src/main/scala/skinny/micro/contrib/Json4sSupport.scala → micro-json4s/src/main/scala/skinny/micro/contrib/json4s/JSONSupport.scala

@@ -1,4 +1,4 @@
-package skinny.micro.contrib
+package skinny.micro.contrib.json4s
 
 import skinny.json4s._
 import skinny.micro.context.SkinnyContext
@@ -7,7 +7,7 @@ import skinny.micro.{ Format, SkinnyMicroBase }
 /**
  * JSON response support.
  */
-trait Json4sSupport extends Json4sJSONStringOps { self: SkinnyMicroBase =>
+trait JSONSupport extends JSONStringOps { self: SkinnyMicroBase =>
 
   /**
    * Returns JSON response.
@@ -34,7 +34,7 @@ trait Json4sSupport extends Json4sJSONStringOps { self: SkinnyMicroBase =>
 
 }
 
-object Json4sSupport {
+object JSONSupport {
 
   val ParsedBodyKey = "skinny.micro.json4s.ParsedBody"