Merge pull request #19 from codacy/improve-package-names

Improve package names

Author: rtfpessoa

build.sbt

@@ -1,45 +1,31 @@
-name := """codacy-plugins-api"""
-
+name := "codacy-plugins-api"
 version := "1.0.0-SNAPSHOT"
+organization := "com.codacy"
 
 scalaVersion := "2.11.12"
-
 crossScalaVersions := Seq(scalaVersion.value, "2.12.4")
 
-organization := "com.codacy"
-
-libraryDependencies ++= Seq(
-  "org.specs2" %% "specs2-core" % "4.0.2" % Test
-)
+libraryDependencies ++= Seq("org.specs2" %% "specs2-core" % "4.0.2" % Test)
 
+description := "Library to develop Codacy tool plugins"
+homepage := Some(url("https://github.com/codacy/codacy-plugins-api"))
+startYear := Some(2016)
 organizationName := "Codacy"
-
 organizationHomepage := Some(new URL("https://www.codacy.com"))
+licenses := Seq("The Apache Software License, Version 2.0" -> url("http://www.apache.org/licenses/LICENSE-2.0.txt"))
 
 publishMavenStyle := true
-
 publishArtifact in Test := false
-
 pomIncludeRepository := { _ =>
   false
 }
-
 publishTo := {
   val nexus = "https://oss.sonatype.org/"
   if (version.value.trim.endsWith("SNAPSHOT"))
     Some("snapshots" at nexus + "content/repositories/snapshots")
   else
     Some("releases" at nexus + "service/local/staging/deploy/maven2")
 }
-
-startYear := Some(2016)
-
-description := "Library to develop Codacy tool plugins"
-
-licenses := Seq("The Apache Software License, Version 2.0" -> url("http://www.apache.org/licenses/LICENSE-2.0.txt"))
-
-homepage := Some(url("https://github.com/codacy/codacy-plugins-api"))
-
 pomExtra :=
   <scm>
     <url>https://github.com/codacy/codacy-plugins-api</url>

project/plugins.sbt

@@ -6,12 +6,13 @@ resolvers ++= Seq(DefaultMavenRepository,
                   Classpaths.typesafeReleases,
                   Classpaths.sbtPluginReleases)
 
+// Sonatype publishing
 addSbtPlugin("org.xerial.sbt" % "sbt-sonatype" % "0.5.1")
-
 addSbtPlugin("com.jsuereth" % "sbt-pgp" % "1.0.0")
 
+// Dependency updates
 addSbtPlugin("com.timushev.sbt" % "sbt-updates" % "0.1.9")
 
+// Coverage
 addSbtPlugin("org.scoverage" % "sbt-scoverage" % "1.5.1")
-
 addSbtPlugin("com.codacy" % "sbt-codacy-coverage" % "1.3.12")

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

@@ -0,0 +1,32 @@
+package com.codacy.plugins.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 Line(value: Int) extends AnyVal {
+    override def toString: String = value.toString
+  }
+
+}
+
+case class ErrorMessage(value: String) extends AnyVal {
+  override def toString: String = value
+}
+
+object Options {
+
+  case class Key(value: String) extends AnyVal
+
+  // JsonEncoded!
+  trait Value extends Any
+
+}

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

@@ -1,4 +1,4 @@
-package codacy.docker.api.duplication
+package com.codacy.plugins.api.duplication
 
 case class DuplicationCloneFile(filePath: String, startLine: Int, endLine: Int)
 

src/main/scala/codacy/docker/api/duplication/DuplicationTool.scala

@@ -0,0 +1,16 @@
+package com.codacy.plugins.api.duplication
+
+import com.codacy.plugins.api.languages.Language
+import com.codacy.plugins.api.{Options, Source}
+
+import scala.util.Try
+
+trait DuplicationTool {
+  def apply(path: Source.Directory,
+            language: Option[Language],
+            options: Map[Options.Key, Options.Value]): Try[List[DuplicationClone]]
+}
+
+object DuplicationTool {
+  case class CodacyConfiguration(language: Option[Language], params: Option[Map[Options.Key, Options.Value]])
+}

src/main/scala/codacy/docker/api/metrics/MetricsTool.scala

@@ -1,4 +1,4 @@
-package com.codacy.api.dtos
+package com.codacy.plugins.api.languages
 
 sealed abstract class Language(val extensions: Set[String],
                                val overriddenName: Option[String] = Option.empty[String],