com.nawforce.common.org.stream.MetadataProvider.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of apexlink Show documentation
Offline validation and transformation toolkit for Salesforce packages
There is a newer version: 2.3.7
/*
 [The "BSD licence"]
 Copyright (c) 2020 Kevin Jones
 All rights reserved.

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:
 1. Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.
 2. Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in the
    documentation and/or other materials provided with the distribution.
 3. The name of the author may not be used to endorse or promote products
    derived from this software without specific prior written permission.

 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package com.nawforce.common.org.stream

import com.nawforce.common.api.Name
import com.nawforce.common.documents.{MetadataDocument, Workspace}
import com.nawforce.runtime.parsers.SourceData

case class MetadataDocumentWithData(docType: MetadataDocument, source: SourceData)

/** Provider for metadata files */
trait MetadataProvider {

  /** Retrieves files of a specific type, if file is not readable an issue is logged. */
  def retrieve(metadataExt: Name): Set[MetadataDocumentWithData]
}

/** MetadataProvider that uses a DocumentIndex as a source */
class DocumentIndexMetadataProvider(workspace: Workspace) extends MetadataProvider {

  /** Retrieve from the provided DocumentIndex with error handling */
  override def retrieve(metadataExt: Name): Set[MetadataDocumentWithData] = {
    workspace
      .getByExtension(metadataExt)
      .flatMap(documentType => {
        documentType.path.readSourceData() match {
          case Left(_) =>
            None
          case Right(data) =>
            Some(MetadataDocumentWithData(documentType, data))
        }
      })
  }
}

/** Override MetadataProvider for injecting new metadata not stored in a file. */
class OverrideMetadataProvider(overrides: Seq[MetadataDocumentWithData], base: MetadataProvider)
    extends MetadataProvider {

  private lazy val overrideByExt: Map[Name, Seq[MetadataDocumentWithData]] =
    overrides.groupBy(_.docType.extension)

  override def retrieve(metadataExt: Name): Set[MetadataDocumentWithData] = {
    val metadata = base.retrieve(metadataExt)
    val overrides = overrideByExt.getOrElse(metadataExt, Seq())
    val overridesByPath = overrides.groupBy(_.docType.path)

    metadata.filterNot(md => overridesByPath.contains(md.docType.path)) ++ overrides
  }
}