First version that contains all the types we need so far

Author: Johann Egger

.gitignore

@@ -0,0 +1,9 @@
+/RUNNING_PID
+/logs/
+/project/*-shim.sbt
+/project/project/
+/project/target/
+/target/
+/.idea/
+/libexec/
+/bin/

build.sbt

@@ -0,0 +1,9 @@
+name := """codacy-plugins-api"""
+
+version := "0.1.0-SNAPSHOT"
+
+scalaVersion := "2.11.8"
+
+crossScalaVersions := Seq("2.10.6", scalaVersion.value)
+
+organization := "com.codacy"

project/build.properties

@@ -0,0 +1,4 @@
+#Activator-generated Properties
+#Tue Jul 19 17:27:06 EEST 2016
+template.uuid=e17acfbb-1ff5-41f5-b8cf-2c40be6a8340
+sbt.version=0.13.12

src/main/scala/codacy/docker/api/DockerApi.scala

@@ -0,0 +1,18 @@
+package codacy.docker.api
+
+sealed trait Source extends Any{
+  def path:String
+  override def toString: String = path
+}
+
+object Source{
+  case class Directory(path: String) extends AnyVal with Source
+  case class File(path: String) extends AnyVal with Source
+}
+
+case class ErrorMessage(value: String) extends AnyVal{
+  override def toString: String = value
+}
+
+case class Configuration(tools: Set[Tool.Configuration], files: Option[Set[Source.File]])
+

src/main/scala/codacy/docker/api/Parameter.scala

@@ -0,0 +1,33 @@
+package codacy.docker.api
+
+object Parameter {
+
+  sealed trait Value extends Any{
+    def value:Any
+    override def toString: String = value.toString
+  }
+
+  object Value{
+
+    def unapply(arg: Value): Option[Any] = Some(arg.value)
+
+    def apply(value:String):Value = Str(value)
+    def apply(value:BigDecimal):Value = Num(value)
+    def apply(value:Boolean):Value = Bool(value)
+    def apply(value:List[Value]):Value = Arr(value)
+
+    case class Arr(value:List[Parameter.Value]) extends AnyVal with Parameter.Value
+    case class Str(value:String) extends Parameter.Value
+    case class Bool(value:Boolean) extends Parameter.Value
+    case class Num(value:BigDecimal) extends Parameter.Value
+  }
+
+  case class Name(value: String) extends AnyVal{
+    override def toString: String = value
+  }
+
+  case class Definition(name: Parameter.Name, value: Parameter.Value)
+
+  case class Specification(name: Parameter.Name, default: Parameter.Value)
+
+}

src/main/scala/codacy/docker/api/Pattern.scala

@@ -0,0 +1,19 @@
+package codacy.docker.api
+
+object Pattern {
+
+  case class Id(value: String) extends AnyVal{
+    override def toString: String = value
+  }
+
+  case class Definition(patternId: Pattern.Id, parameters: Option[Set[Parameter.Definition]])
+
+  case class Specification(patternId: Pattern.Id, level:Result.Level, category: Category, parameters: Option[Set[Parameter.Specification]])
+
+  type Category = Category.Value
+  object Category extends Enumeration{
+    val Security, CodeStyle, ErrorProne, Performance, Compatibility, UnusedCode,
+    //Deprecated
+    Complexity, BestPractice, Comprehensibility, Duplication, Documentation = Value
+  }
+}

src/main/scala/codacy/docker/api/Result.scala

@@ -0,0 +1,27 @@
+package codacy.docker.api
+
+sealed trait Result
+
+object Result {
+
+  case class Message(value: String) extends AnyVal{
+    override def toString: String = value
+  }
+
+  case class Line(value: Int) extends AnyVal{
+    override def toString: String = value.toString
+  }
+
+  case class Issue(file: Source.File, message: Result.Message, patternId: Pattern.Id, line: Result.Line) extends Result
+
+  case class FileError(file: Source.File, message: Option[ErrorMessage]) extends Result
+
+  type Level = Level.Value
+
+  object Level extends Enumeration{
+    val Err  = Value("Error")
+    val Warn = Value("Warning")
+    val Info = Value("Info")
+  }
+}
+

src/main/scala/codacy/docker/api/Tool.scala

@@ -0,0 +1,20 @@
+package codacy.docker.api
+
+import scala.util.Try
+
+trait Tool {
+  def apply(source: Source.Directory, configuration: Option[List[Pattern.Definition]], files: Option[Set[Source.File]])
+           (implicit specification: Tool.Specification): Try[List[Result]]
+}
+
+object Tool {
+
+  case class Name(value: String) extends AnyVal{
+    override def toString: String = value
+  }
+
+  case class Configuration(name: Tool.Name, patterns: Option[List[Pattern.Definition]])
+
+  //there are other fields like name and description but i don't care about them inside the tool
+  case class Specification(name: Tool.Name, patterns: Set[Pattern.Specification])
+}