Merge pull request #16 from pedrocodacy/add-duplication-api-FT-4900

added duplication tool trait and case classes for configs and results of duplication

Author: rtfpessoa

.circleci/config.yml

@@ -13,7 +13,4 @@ jobs:
       - save_cache:
           key: scala-library-dependencies-{{ checksum "build.sbt" }}
           paths: [ "~/.m2", "~/.ivy2", "~/.cache/coursier" ]
-      - run: sbt coverage test
-      - run: sbt coverageReport
-      - run: sbt coverageAggregate
-      - run: sbt codacyCoverage
+      - run: ./scripts/test.sh

build.sbt

@@ -8,7 +8,9 @@ crossScalaVersions := Seq(scalaVersion.value, "2.12.4")
 
 organization := "com.codacy"
 
-libraryDependencies += "org.specs2" %% "specs2-core" % "4.0.2" % Test
+libraryDependencies ++= Seq(
+  "org.specs2" %% "specs2-core" % "4.0.2" % Test
+)
 
 organizationName := "Codacy"
 

scripts/test.sh

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+
+set -e
+
+if [ -n "$1" ]; then
+    export CODACY_PROJECT_TOKEN="$1"
+fi
+
+sbt coverage test
+sbt coverageReport
+sbt coverageAggregate
+
+if [ -z "$CODACY_PROJECT_TOKEN" ]; then
+    echo "CODACY_PROJECT_TOKEN not found. Skipping send coverage to Codacy."
+else
+    sbt codacyCoverage
+fi

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

@@ -50,3 +50,15 @@ object MetricsConfiguration {
 
   trait Value extends Any
 }
+
+case class DuplicationConfiguration(language: Option[Language],
+                                    params: Option[Map[DuplicationConfiguration.Key, DuplicationConfiguration.Value]])
+
+object DuplicationConfiguration {
+
+  case class Key(value: String) extends AnyVal
+
+  trait Value extends Any
+}
+
+case class CodacyConfiguration(duplication: DuplicationConfiguration)

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

@@ -0,0 +1,5 @@
+package codacy.docker.api.duplication
+
+case class DuplicationCloneFile(filePath: String, startLine: Int, endLine: Int)
+
+case class DuplicationClone(cloneLines: String, nrTokens: Int, nrLines: Int, files: Seq[DuplicationCloneFile])

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

@@ -0,0 +1,20 @@
+package codacy.docker.api.duplication
+
+import codacy.docker.api.{DuplicationConfiguration, Source}
+import com.codacy.api.dtos.Language
+
+import scala.util.Try
+
+trait DuplicationTool {
+  def apply(path: Source.Directory,
+            language: Option[Language],
+            options: Map[DuplicationConfiguration.Key, DuplicationConfiguration.Value]): Try[List[DuplicationClone]]
+}
+
+object DuplicationTool {
+
+  case class Name(value: String) extends AnyVal {
+    override def toString: String = value
+  }
+
+}