Add extra configuration for .codacy.json file (#15)

mrfyda · web-flow · commit ba40020ccbf3 · 2017-03-24T10:37:13.000Z
* Add extra configuration for .codacy.json file

* Change options to Option

Format
and error log

* Update build.sbt

* Remove debug log
diff --git a/build.sbt b/build.sbt
@@ -19,7 +19,7 @@ resolvers += "Bintray Typesafe Repo" at "http://dl.bintray.com/typesafe/maven-re
 libraryDependencies ++= Seq(
   "com.typesafe.play" %% "play-json" % "2.4.8",
   "org.scalatest" %% "scalatest" % "2.2.4" % "test",
-  "com.codacy" %% "codacy-plugins-api" % "1.0.8" withSources(),
+  "com.codacy" %% "codacy-plugins-api" % "1.0.10" withSources(),
   "com.github.pathikrit" %% "better-files" % "2.17.1" withSources()
 )
 
diff --git a/src/main/scala/codacy/docker/api/BackwardsCompatibility.scala b/src/main/scala/codacy/docker/api/BackwardsCompatibility.scala
@@ -2,18 +2,21 @@ package codacy.docker.api
 
 import java.nio.file.Paths
 
-import codacy.docker.api.JsonApi._
+import codacy.docker.api.Pattern.Definition
+import codacy.docker.api.Source.{Directory, File}
+import codacy.docker.api.Tool.Specification
 import codacy.dockerApi
 import codacy.dockerApi.{ParameterDef, ParameterName, ParameterSpec, PatternDef, PatternId, PatternSpec, Spec, ToolName}
 import play.api.libs.json._
 
 import scala.util.Try
 
-trait BackwardsCompatability {
+trait BackwardsCompatibility {
 
   implicit class AsTool(tool: dockerApi.Tool) extends Tool {
-    override def apply(source: Source.Directory, configuration: Option[List[Pattern.Definition]],
-                       files: Option[Set[Source.File]])(implicit specification: Tool.Specification): Try[List[Result]] = {
+    override def apply(source: Directory, configuration: Option[List[Definition]],
+                       files: Option[Set[File]], options: Map[Configuration.Key, Configuration.Value])
+                      (implicit specification: Specification): Try[List[Result]] = {
       tool.apply(
         path = Paths.get(source.path),
         conf = configuration.map(_.map(toPatternDef)),
diff --git a/src/main/scala/codacy/docker/api/JsonApi.scala b/src/main/scala/codacy/docker/api/JsonApi.scala
@@ -1,20 +1,24 @@
 package codacy.docker.api
 
 import play.api.libs.json._
+
 import scala.language.implicitConversions
 
 private[api] case class ParamValue(value: JsValue) extends AnyVal with Parameter.Value
 
+private[api] case class ConfigurationValue(value: JsValue) extends AnyVal with Configuration.Value
+
 trait JsonApi {
 
   def enumWrites[E <: Enumeration#Value]: Writes[E] = Writes((e: E) => Json.toJson(e.toString))
 
   def enumReads[E <: Enumeration](e: E): Reads[e.Value] = {
-    Reads.StringReads.flatMap { case value => Reads((_: JsValue) =>
-      e.values.collectFirst { case enumValue if enumValue.toString == value =>
-        JsSuccess(enumValue)
-      }.getOrElse(JsError(s"Invalid enumeration value $value"))
-    )
+    Reads.StringReads.flatMap { value =>
+      Reads((_: JsValue) =>
+        e.values.collectFirst { case enumValue if enumValue.toString == value =>
+          JsSuccess(enumValue)
+        }.getOrElse(JsError(s"Invalid enumeration value $value"))
+      )
     }
   }
 
@@ -30,6 +34,18 @@ trait JsonApi {
     Writes(paramValueToJsValue)
   )
 
+  implicit def configurationValueToJsValue(configValue: Configuration.Value): JsValue = {
+    configValue match {
+      case ConfigurationValue(v) => v
+      case _ => JsNull
+    }
+  }
+
+  implicit lazy val configurationValueFormat: Format[Configuration.Value] = Format(
+    implicitly[Reads[JsValue]].map(Configuration.Value),
+    Writes(configurationValueToJsValue)
+  )
+
   implicit lazy val resultLevelFormat = Format(
     enumReads(Result.Level),
     enumWrites[Result.Level]
@@ -81,6 +97,19 @@ trait JsonApi {
   implicit lazy val patternSpecificationFormat = Json.format[Pattern.Specification]
   implicit lazy val toolConfigurationFormat = Json.format[Tool.Configuration]
   implicit lazy val specificationFormat = Json.format[Tool.Specification]
+  implicit lazy val configurationOptionsKeyFormat = Json.format[Configuration.Key]
+  implicit lazy val configurationOptionsFormat = Format[Map[Configuration.Key, Configuration.Value]](
+    Reads { (json: JsValue) =>
+      JsSuccess(
+        json.asOpt[Map[String, JsValue]].fold(Map.empty[Configuration.Key, Configuration.Value]) {
+          _.map { case (k, v) =>
+            Configuration.Key(k) -> Configuration.Value(v)
+          }
+        }
+      )
+    },
+    Writes(m => JsObject(m.map { case (k, v: ConfigurationValue) => k.value -> v.value }))
+  )
   implicit lazy val configurationFormat = Json.format[Configuration]
   implicit lazy val parameterDescriptionFormat = Json.format[Parameter.Description]
   implicit lazy val patternDescriptionFormat = Json.format[Pattern.Description]
@@ -130,4 +159,4 @@ trait JsonApi {
   }
 }
 
-object JsonApi extends JsonApi
+object JsonApi extends JsonApi
diff --git a/src/main/scala/codacy/docker/api/package.scala b/src/main/scala/codacy/docker/api/package.scala
@@ -1,14 +1,21 @@
 package codacy.docker
 
-import play.api.libs.json.{JsNull, JsString, JsValue, Json}
+import play.api.libs.json.{JsString, JsValue, Json}
 
 import scala.util.Try
 
-package object api extends JsonApi{
+package object api extends JsonApi {
 
-  implicit class ParameterExtensions(param:Parameter.type){
-    def Value(jsValue:JsValue):Parameter.Value = ParamValue(jsValue)
-    def Value(raw:String):Parameter.Value = Value(Try(Json.parse(raw)).getOrElse(JsString(raw)))
+  implicit class ParameterExtensions(param: Parameter.type) {
+    def Value(jsValue: JsValue): Parameter.Value = ParamValue(jsValue)
+
+    def Value(raw: String): Parameter.Value = Value(Try(Json.parse(raw)).getOrElse(JsString(raw)))
+  }
+
+  implicit class ConfigurationExtensions(config: Configuration.type) {
+    def Value(jsValue: JsValue): Configuration.Value = ConfigurationValue(jsValue)
+
+    def Value(raw: String): Configuration.Value = Value(Try(Json.parse(raw)).getOrElse(JsString(raw)))
   }
 
-}
+}
diff --git a/src/main/scala/codacy/dockerApi/DockerEngine.scala b/src/main/scala/codacy/dockerApi/DockerEngine.scala
@@ -2,7 +2,7 @@ package codacy.dockerApi
 
 import java.nio.file.Paths
 
-import codacy.docker.api.{Source, Result => NewResult}
+import codacy.docker.api.{Configuration, Source, Result => NewResult}
 import codacy.dockerApi.DockerEnvironment._
 import codacy.dockerApi.utils.Delayed
 import play.api.libs.json.{Json, Writes}
@@ -61,7 +61,8 @@ abstract class DockerEngine(Tool: codacy.docker.api.Tool) extends Delayed {
         Tool.apply(
           source = Source.Directory(sourcePath.toString()),
           configuration = patternsOpt,
-          files = filesOpt
+          files = filesOpt,
+          options = configOpt.flatMap(_.options).getOrElse(Map.empty)
         )(spec)
       } catch {
         case t: Throwable =>
diff --git a/src/main/scala/codacy/dockerApi/package.scala b/src/main/scala/codacy/dockerApi/package.scala
@@ -2,7 +2,7 @@ package codacy
 
 import java.nio.file.Path
 
-import codacy.docker.api.{BackwardsCompatability, JsonApi}
+import codacy.docker.api.{BackwardsCompatibility, JsonApi}
 import play.api.libs.json.{JsValue, Reads, Writes, _}
 
 import scala.language.reflectiveCalls
@@ -109,7 +109,7 @@ package dockerApi {
 
 }
 
-package object dockerApi extends BackwardsCompatability with JsonApi {
+package object dockerApi extends BackwardsCompatibility with JsonApi {
 
   implicit class ResultExtension[A](val result: JsResult[A]) extends AnyVal {
     def asTry = result.fold(

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ resolvers += "Bintray Typesafe Repo" at "http://dl.bintray.com/typesafe/maven-re`
`19`	`19`	`libraryDependencies ++= Seq(`
`20`	`20`	`"com.typesafe.play" %% "play-json" % "2.4.8",`
`21`	`21`	`"org.scalatest" %% "scalatest" % "2.2.4" % "test",`
`22`		`- "com.codacy" %% "codacy-plugins-api" % "1.0.8" withSources(),`
	`22`	`+ "com.codacy" %% "codacy-plugins-api" % "1.0.10" withSources(),`
`23`	`23`	`"com.github.pathikrit" %% "better-files" % "2.17.1" withSources()`
`24`	`24`	`)`
`25`	`25`