com.nawforce.common.cst.Creator.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) 2019 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.cst

import com.nawforce.common.api.{Name, TypeName}
import com.nawforce.common.names.TypeNames._
import com.nawforce.common.names.{EncodedName, TypeNames, _}
import com.nawforce.common.org.OrgImpl
import com.nawforce.runtime.parsers.ApexParser._
import com.nawforce.runtime.parsers.CodeParser

final case class CreatedName(idPairs: List[IdCreatedNamePair]) extends CST {

  lazy val typeName: TypeName = idPairs.tail.map(_.typeName).foldLeft(idPairs.head.typeName) {
    (acc: TypeName, typeName: TypeName) =>
      typeName.withTail(acc)
  }

  def verify(context: ExpressionVerifyContext): ExprContext = {

    val newType = context.getTypeAndAddDependency(typeName, context.thisType).toOption
    if (newType.nonEmpty) {
      ExprContext(isStatic = Some(false), newType.get)
    } else {
      context.missingType(location, typeName)
      ExprContext.empty
    }
  }
}

object CreatedName {
  def construct(from: CreatedNameContext): CreatedName = {
    val pairs: Seq[IdCreatedNamePairContext] = CodeParser.toScala(from.idCreatedNamePair())
    CreatedName(IdCreatedNamePair.construct(pairs.toList)).withContext(from)
  }
}

final case class IdCreatedNamePair(id: Id, types: Array[TypeName]) extends CST {
  val typeName: TypeName = {
    val encName = EncodedName(id.name)
    if (encName.ext.nonEmpty)
      TypeName(encName.fullName, types.toIndexedSeq, Some(TypeNames.Schema)).intern
    else
      TypeName(encName.fullName, types.toIndexedSeq, None).intern
  }
}

object IdCreatedNamePair {
  def construct(aList: List[IdCreatedNamePairContext]): List[IdCreatedNamePair] = {
    aList.map(x => IdCreatedNamePair.construct(x))
  }

  def construct(from: IdCreatedNamePairContext): IdCreatedNamePair = {
    IdCreatedNamePair(Id.constructAny(from.anyId()),
                      CodeParser
                        .toScala(from.typeList())
                        .map(tl => TypeList.construct(tl))
                        .getOrElse(TypeName.emptyTypeNames)).withContext(from)
  }
}

final case class Creator(createdName: CreatedName, creatorRest: CreatorRest) extends CST {
  def verify(input: ExprContext, context: ExpressionVerifyContext): ExprContext = {
    assert(input.typeDeclarationOpt.nonEmpty)
    creatorRest.verify(createdName, input, context)
  }
}

object Creator {
  def construct(from: CreatorContext): Creator = {
    val rest: Option[CreatorRest] =
      CodeParser
        .toScala(from.noRest())
        .map(NoRest.construct)
        .orElse(CodeParser.toScala(from.classCreatorRest()).map(ClassCreatorRest.construct))
        .orElse(CodeParser.toScala(from.arrayCreatorRest()).map(ArrayCreatorRest.construct))
        .orElse(CodeParser.toScala(from.mapCreatorRest()).map(MapCreatorRest.construct))
        .orElse(CodeParser.toScala(from.setCreatorRest()).map(SetCreatorRest.construct))
    Creator(CreatedName.construct(from.createdName()), rest.get).withContext(from)
  }
}

sealed abstract class CreatorRest extends CST {
  def verify(createdName: CreatedName,
             input: ExprContext,
             context: ExpressionVerifyContext): ExprContext
}

final class NoRest extends CreatorRest {
  override def verify(createdName: CreatedName,
                      input: ExprContext,
                      context: ExpressionVerifyContext): ExprContext = {
    createdName.verify(context)
  }
}

object NoRest {
  def construct(from: NoRestContext): NoRest = {
    new NoRest().withContext(from)
  }
}

final case class ClassCreatorRest(arguments: Array[Expression]) extends CreatorRest {
  override def verify(createdName: CreatedName,
                      input: ExprContext,
                      context: ExpressionVerifyContext): ExprContext = {

    val creating = createdName.verify(context)

    val isFieldConstructed =
      creating.typeDeclarationOpt
        .map(_.isFieldConstructed)
        .getOrElse({
            context.pkg.isGhostedType(createdName.typeName) && EncodedName(
              createdName.typeName.name).ext.exists(ClassCreatorRest.isFieldConstructedExt)

          })

    if (isFieldConstructed && creating.typeDeclarationOpt.isEmpty) {
      validateFieldConstructorArgumentsGhosted(createdName.typeName, input, arguments, context)
      ExprContext.empty
    } else if (isFieldConstructed) {
      creating.typeDeclaration.validateFieldConstructorArguments(input, arguments, context)
      creating
    } else {
      // FUTURE: Is constructor available
      arguments.foreach(_.verify(input, context))
      creating
    }
  }

  def validateFieldConstructorArgumentsGhosted(typeName: TypeName,
                                               input: ExprContext,
                                               arguments: Array[Expression],
                                               context: ExpressionVerifyContext): Unit = {

    val validArgs = arguments.flatMap {
      case BinaryExpression(PrimaryExpression(IdPrimary(id)), rhs, "=") =>
        rhs.verify(input, context)
        Some(id)
      case argument =>
        OrgImpl.logError(
          argument.location,
          s"SObject type '$typeName' construction needs ' = ' arguments")
        None
    }

    if (validArgs.length == arguments.length) {
      val duplicates = validArgs.groupBy(_.name).collect { case (_, Array(_, y, _*)) => y }
      if (duplicates.nonEmpty) {
        OrgImpl.logError(
          duplicates.head.location,
          s"Duplicate assignment to field '${duplicates.head.name}' on SObject type '$typeName'")
      }
    }
  }

}

object ClassCreatorRest {
  private val fieldConstructedExt = Set(Name("c"), Name("e"), Name("b"), Name("mdt"))

  def construct(from: ClassCreatorRestContext): ClassCreatorRest = {
    ClassCreatorRest(Arguments.construct(from.arguments())).withContext(from)
  }

  def isFieldConstructedExt(ext: Name): Boolean = fieldConstructedExt.contains(ext)
}

final case class ArrayCreatorRest(expressions: Option[Expression],
                                  arrayInitializer: Option[ArrayInitializer])
    extends CreatorRest {
  override def verify(createdName: CreatedName,
                      input: ExprContext,
                      context: ExpressionVerifyContext): ExprContext = {

    // FUTURE: Expression type should be number
    expressions.foreach(_.verify(input, context))

    // FUTURE: initializer type should match 'creating'
    arrayInitializer.foreach(_.verify(input, context))

    val creating = createdName.verify(context)
    if (creating.isDefined) {
      val listType = creating.typeName.asListOf
      val listDeclaration = context.getTypeAndAddDependency(listType, context.thisType)
      ExprContext(isStatic = Some(false), listDeclaration.toOption.get)
    } else {
      ExprContext.empty
    }
  }
}

object ArrayCreatorRest {
  def construct(from: ArrayCreatorRestContext): ArrayCreatorRest = {
    ArrayCreatorRest(CodeParser.toScala(from.expression()).map(Expression.construct),
                     CodeParser.toScala(from.arrayInitializer()).map(ArrayInitializer.construct))
  }
}

final case class ArrayInitializer(expressions: Array[Expression]) extends CST {
  def verify(input: ExprContext, context: ExpressionVerifyContext): Unit = {
    expressions.foreach(_.verify(input, context))
  }
}

object ArrayInitializer {
  def construct(from: ArrayInitializerContext): ArrayInitializer = {
    val initializers = CodeParser.toScala(from.expression()).toArray
    ArrayInitializer(Expression.construct(initializers)).withContext(from)
  }
}

final case class MapCreatorRest(pairs: List[MapCreatorRestPair]) extends CreatorRest {
  override def verify(createdName: CreatedName,
                      input: ExprContext,
                      context: ExpressionVerifyContext): ExprContext = {

    pairs.foreach(_.verify(input, context))

    val creating = createdName.verify(context)
    if (creating.typeDeclarationOpt.isEmpty)
      return ExprContext.empty

    val td = creating.typeDeclarationOpt.get
    val enclosedTypes = td.typeName.getMapType

    if (enclosedTypes.isEmpty) {
      OrgImpl.logError(
        location,
        s"Expression pair list construction is only supported for Map types, not '${td.typeName}'")
      return ExprContext.empty
    }

    val keyType = context.getTypeAndAddDependency(enclosedTypes.get._1, context.thisType)
    if (keyType.isLeft) {
      if (!context.pkg.isGhostedType(enclosedTypes.get._1))
        OrgImpl.log(keyType.swap.getOrElse(throw new NoSuchElementException).asIssue(location))
      return ExprContext.empty
    }

    val valueType = context.getTypeAndAddDependency(enclosedTypes.get._2, context.thisType)
    if (valueType.isLeft) {
      if (!context.pkg.isGhostedType(enclosedTypes.get._2))
        OrgImpl.log(valueType.swap.getOrElse(throw new NoSuchElementException).asIssue(location))
      return ExprContext.empty
    }

    creating
  }
}

object MapCreatorRest {
  def construct(from: MapCreatorRestContext): MapCreatorRest = {
    val pairs: Seq[MapCreatorRestPairContext] = CodeParser.toScala(from.mapCreatorRestPair())
    MapCreatorRest(MapCreatorRestPair.construct(pairs.toList)).withContext(from)
  }
}

final case class MapCreatorRestPair(from: Expression, to: Expression) extends CST {
  def verify(input: ExprContext, context: ExpressionVerifyContext): Unit = {
    // FUTURE: Validate the expressions are assignable to Map
    from.verify(input, context)
    to.verify(input, context)
  }
}

object MapCreatorRestPair {
  def construct(aList: List[MapCreatorRestPairContext]): List[MapCreatorRestPair] = {
    aList.map(x => MapCreatorRestPair.construct(x))
  }

  def construct(from: MapCreatorRestPairContext): MapCreatorRestPair = {
    val expressions = CodeParser.toScala(from.expression())
    MapCreatorRestPair(Expression.construct(expressions.head), Expression.construct(expressions(1)))
      .withContext(from)
  }
}

/* This is really Set & List creator, where TYPE{expr, expr, ...} form is allowed, it's different from array */
final case class SetCreatorRest(parts: Array[Expression]) extends CreatorRest {
  override def verify(createdName: CreatedName,
                      input: ExprContext,
                      context: ExpressionVerifyContext): ExprContext = {

    parts.foreach(_.verify(input, context))

    val creating = createdName.verify(context)
    if (creating.typeDeclarationOpt.isEmpty)
      return ExprContext.empty

    val td = creating.typeDeclarationOpt.get
    val enclosedType = td.typeName.getSetOrListType

    if (enclosedType.isEmpty) {
      createdName.verify(context)
      OrgImpl.logError(
        location,
        s"Expression list construction is only supported for Set or List types, not '${td.typeName}'")
      return ExprContext.empty
    }

    context.getTypeAndAddDependency(enclosedType.get, context.thisType) match {
      case Left(error) =>
        if (!context.pkg.isGhostedType(enclosedType.get))
          OrgImpl.log(error.asIssue(location))
        return ExprContext.empty
      case Right(_) =>
        // FUTURE: Validate the expressions are assignable to 'creating'
        parts.foreach(_.verify(input, context))
        creating
    }
  }
}

object SetCreatorRest {
  def construct(from: SetCreatorRestContext): SetCreatorRest = {
    val parts = CodeParser.toScala(from.expression()).toArray
    SetCreatorRest(Expression.construct(parts)).withContext(from)
  }
}