Merge pull request #11 from codacy/add-helpers-for-new-api

Add ToolHelper for the new docker API

Author: rtfpessoa

src/main/scala/codacy/docker/api/utils/ToolHelper.scala

@@ -0,0 +1,36 @@
+package codacy.docker.api.utils
+
+import codacy.docker.api._
+
+object ToolHelper {
+
+  def filesToLint(source: Source.Directory, filesOpt: Option[Set[Source.File]]): Set[String] = {
+    filesOpt.fold(Set(source.path)) { files =>
+      files.map(_.path)
+    }
+  }
+
+  def patternsToLint(conf: Option[List[Pattern.Definition]])(implicit specification: Tool.Specification): Option[List[Pattern.Definition]] = {
+    conf.map { configuration =>
+      configuration.map(pattern => getMissingParametersFromSpec(pattern))
+    }
+  }
+
+  private def buildParameterDefFromSpec(parameterSpec: Parameter.Specification): Parameter.Definition = {
+    Parameter.Definition(parameterSpec.name, parameterSpec.default)
+  }
+
+  private def getParametersByPatternId(patternId: Pattern.Id)(implicit specification: Tool.Specification): Option[Set[Parameter.Definition]] = {
+    val specPattern = specification.patterns.find(_.patternId == patternId)
+
+    specPattern.flatMap { patternSpec =>
+      patternSpec.parameters.map(params => params.map(buildParameterDefFromSpec))
+    }
+  }
+
+  private def getMissingParametersFromSpec(pattern: Pattern.Definition)(implicit specification: Tool.Specification): Pattern.Definition = {
+    val params = pattern.parameters.orElse(getParametersByPatternId(pattern.patternId))
+    Pattern.Definition(pattern.patternId, params)
+  }
+
+}

src/main/scala/codacy/dockerApi/utils/ToolHelper.scala

@@ -4,17 +4,20 @@ import codacy.dockerApi._
 
 object ToolHelper {
 
+  @deprecated("use the new codacy.docker.api.utils.ToolHelper instead", "2.7.2")
   def getPatternsToLint(conf: Option[List[PatternDef]])(implicit spec: Spec): Option[List[PatternDef]] = {
     conf.map {
       configuration =>
         configuration.map(pattern => getMissingParametersFromSpec(pattern))
     }
   }
 
+  @deprecated("use the new codacy.docker.api.utils.ToolHelper instead", "2.7.2")
   private def buildParameterDefFromSpec(parameterSpec: ParameterSpec): ParameterDef = {
     ParameterDef(parameterSpec.name, parameterSpec.default)
   }
 
+  @deprecated("use the new codacy.docker.api.utils.ToolHelper instead", "2.7.2")
   private def getParametersByPatternId(patternId: PatternId)(implicit spec: Spec): Option[Set[ParameterDef]] = {
     val specPattern = spec.patterns.find(_.patternId == patternId)
 
@@ -24,6 +27,7 @@ object ToolHelper {
     }
   }
 
+  @deprecated("use the new codacy.docker.api.utils.ToolHelper instead", "2.7.2")
   private def getMissingParametersFromSpec(pattern: PatternDef)(implicit spec: Spec): PatternDef = {
     val params = pattern.parameters.orElse(getParametersByPatternId(pattern.patternId))
     PatternDef(pattern.patternId, params)