Merge pull request #3 from tomerghelber/develop

tomerghelber · web-flow · commit bf95501343d5 · 2019-11-09T17:17:12.000Z
Develop
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,4 @@
 *.class
 *.log
+target/*
+project/target/*
diff --git a/.scalafmt.conf b/.scalafmt.conf
@@ -10,7 +10,7 @@ project.excludeFilters = [
   ".git/.*"
 ]
 
-maxColumn = 100
+maxColumn = 120
 
 continuationIndent {
   callSite = 2
diff --git a/.travis.yml b/.travis.yml
@@ -2,31 +2,6 @@ language: scala
 scala:
   - 2.12.8
 
-jobs:
-  include:
-  - stage: test
-    name: "Unit Tests"
-    script:
-    - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-    - chmod +x ./cc-test-reporter
-    - ./cc-test-reporter before-build
-    - sbt ++$TRAVIS_SCALA_VERSION clean coverage test coverageReport
-# "Mutation Tests" are too long and travis kills the job.
-#  - name: "Mutation Tests"
-#    script: sbt stryker
-    - SCALA_TARGET_DIRECTORY=target/scala-$(echo $TRAVIS_SCALA_VERSION | grep -o -P '^\d+\.\d+' '-')
-    - ./cc-test-reporter format-coverage -t cobertura $SCALA_TARGET_DIRECTORY/coverage-report/cobertura.xml
-    - ./cc-test-reporter upload-coverage
-
-    # run ci-release only if previous stages passed
-  - stage: release
-    script: sbt ci-release
-
-stages:
-  - name: test
-  - name: release
-    if: ((branch = master AND type = push) OR (tag IS present)) AND NOT fork
-
 before_cache:
   # Tricks to avoid unnecessary cache updates
   - find $HOME/.sbt -name "*.lock" | xargs rm
@@ -46,3 +21,25 @@ before_install:
 
 install:
   - sbt compile
+
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+
+script:
+  - sbt ++$TRAVIS_SCALA_VERSION clean coverage test coverageReport
+
+after_script:
+  - SCALA_TARGET_DIRECTORY=target/scala-$(echo $TRAVIS_SCALA_VERSION | grep -o -P '^\d+\.\d+' '-')
+  - ./cc-test-reporter format-coverage -t cobertura $SCALA_TARGET_DIRECTORY/coverage-report/cobertura.xml
+  - ./cc-test-reporter upload-coverage
+
+deploy:
+  provider: script
+  script: sbt ci-release
+  edge: true
+  on:
+    branch: master
+    tags: true
+    condition: ((branch = master AND type = push) OR (tag IS present)) AND NOT fork
diff --git a/README.md b/README.md
@@ -5,6 +5,9 @@
 [![Maintainability](https://api.codeclimate.com/v1/badges/fec458e9b494f6428613/maintainability)](https://codeclimate.com/github/tomerghelber/mathematica-scala-parser-combinators/maintainability)
 [![Mutation testing badge](https://img.shields.io/endpoint?style=flat&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fapi%2Fgithub.com%2Ftomerghelber%2Fmathematica-scala-parser-combinators%2Fmaster)](https://stryker-mutator.github.io)
 
+[![Sonatype Nexus (Releases)](https://img.shields.io/nexus/r/https/oss.sonatype.org/com.github.tomerghelber/mathimatica-parser_2.12.svg)](https://img.shields.io/nexus/r/https/oss.sonatype.org/com.github.tomerghelber/mathimatica-parser_2.12.svg)
+[![Sonatype Nexus (Snapshots)](https://img.shields.io/nexus/s/https/oss.sonatype.org/com.github.tomerghelber/mathimatica-parser_2.12.svg)](https://img.shields.io/nexus/s/https/oss.sonatype.org/com.github.tomerghelber/mathimatica-parser_2.12.svg)
+
 This repository directed to crate a parser for [Mathematica Language](https://www.wolfram.com/mathematica).
 The parser is written in scala using [scala-parser-combinators](https://github.com/scala/scala-parser-combinators)
 
diff --git a/src/main/scala/com/github/tomerghelber/mathematica/ast/ASTNode.scala b/src/main/scala/com/github/tomerghelber/mathematica/ast/ASTNode.scala
@@ -1,4 +1,4 @@
-package tomerghelber.mathematica.ast
+package com.github.tomerghelber.mathematica.ast
 
 trait ASTNode
 
@@ -40,6 +40,9 @@ object NotExistsNode extends ApplyBinaryFunctionNode with UnapplyFunctionNode {
 object EquivalentNode extends ApplyBinaryFunctionNode with UnapplyFunctionNode {
   protected val name = "Equivalent"
 }
+object ListNode extends UnapplyFunctionNode {
+  protected val name = "List"
+}
 
 case class LimitNode(expr1: ASTNode, expr3: ASTNode, expr2: ASTNode) extends ASTNode
 case class MaxLimitNode(expr1: ASTNode, expr3: ASTNode, expr2: ASTNode) extends ASTNode
diff --git a/src/main/scala/com/github/tomerghelber/mathematica/ast/BinaryOperationNode.scala b/src/main/scala/com/github/tomerghelber/mathematica/ast/BinaryOperationNode.scala
@@ -1,4 +1,4 @@
-package tomerghelber.mathematica.ast
+package com.github.tomerghelber.mathematica.ast
 
 object NotNode extends ApplyUnaryFunctionNode with UnapplyFunctionNode {
   protected val name: String = "Not"
diff --git a/src/main/scala/com/github/tomerghelber/mathematica/ast/ComparationNode.scala b/src/main/scala/com/github/tomerghelber/mathematica/ast/ComparationNode.scala
@@ -1,4 +1,4 @@
-package tomerghelber.mathematica.ast
+package com.github.tomerghelber.mathematica.ast
 
 object EqualNode extends ApplyBinaryFunctionNode with UnapplyFunctionNode {
   protected val name: String = "Equal"
diff --git a/src/main/scala/com/github/tomerghelber/mathematica/ast/MatrixOperationNode.scala b/src/main/scala/com/github/tomerghelber/mathematica/ast/MatrixOperationNode.scala
@@ -1,4 +1,4 @@
-package tomerghelber.mathematica.ast
+package com.github.tomerghelber.mathematica.ast
 
 trait MatrixOperationNode extends ASTNode
 
diff --git a/src/main/scala/com/github/tomerghelber/mathematica/ast/NumberOperationNode.scala b/src/main/scala/com/github/tomerghelber/mathematica/ast/NumberOperationNode.scala
@@ -1,4 +1,4 @@
-package tomerghelber.mathematica.ast
+package com.github.tomerghelber.mathematica.ast
 
 object IncrementNode extends ApplyUnaryFunctionNode with UnapplyFunctionNode {
   protected val name: String = "Increment"
diff --git a/src/main/scala/com/github/tomerghelber/mathematica/ast/RulesNode.scala b/src/main/scala/com/github/tomerghelber/mathematica/ast/RulesNode.scala
@@ -0,0 +1,8 @@
+package com.github.tomerghelber.mathematica.ast
+
+object RuleNode extends ApplyBinaryFunctionNode with UnapplyFunctionNode {
+  protected val name: String = "Rule"
+}
+object RuleDelayedNode extends ApplyBinaryFunctionNode with UnapplyFunctionNode {
+  protected val name: String = "RuleDelayed"
+}
diff --git a/src/main/scala/com/github/tomerghelber/mathematica/ast/ScriptNode.scala b/src/main/scala/com/github/tomerghelber/mathematica/ast/ScriptNode.scala
@@ -1,4 +1,4 @@
-package tomerghelber.mathematica.ast
+package com.github.tomerghelber.mathematica.ast
 
 object MessageNameNode extends ApplyBinaryFunctionNode with UnapplyFunctionNode {
   protected val name: String = "MessageName"
diff --git a/src/main/scala/com/github/tomerghelber/mathematica/ast/SetOperationNode.scala b/src/main/scala/com/github/tomerghelber/mathematica/ast/SetOperationNode.scala
@@ -1,4 +1,4 @@
-package tomerghelber.mathematica.ast
+package com.github.tomerghelber.mathematica.ast
 
 object IntersectionNode extends ApplyBinaryFunctionNode with UnapplyFunctionNode {
   protected val name: String = "Intersection"
diff --git a/src/main/scala/com/github/tomerghelber/mathematica/ast/TerminalNode.scala b/src/main/scala/com/github/tomerghelber/mathematica/ast/TerminalNode.scala
@@ -1,4 +1,4 @@
-package tomerghelber.mathematica.ast
+package com.github.tomerghelber.mathematica.ast
 
 trait TerminalNode extends ASTNode
 
diff --git a/src/main/scala/com/github/tomerghelber/mathematica/ast/VectorOperationNode.scala b/src/main/scala/com/github/tomerghelber/mathematica/ast/VectorOperationNode.scala
@@ -1,4 +1,4 @@
-package tomerghelber.mathematica.ast
+package com.github.tomerghelber.mathematica.ast
 
 object CrossNode extends ApplyBinaryFunctionNode with UnapplyFunctionNode {
   protected val name: String = "Cross"
diff --git a/src/main/scala/com/github/tomerghelber/mathematica/eval/MathematicaEvaluator.scala b/src/main/scala/com/github/tomerghelber/mathematica/eval/MathematicaEvaluator.scala
@@ -1,39 +1,61 @@
-package tomerghelber.mathematica.eval
+package com.github.tomerghelber.mathematica.eval
 
+import com.github.tomerghelber.mathematica.ast._
 import com.typesafe.scalalogging.LazyLogging
-import tomerghelber.mathematica.ast._
 
 import scala.collection.mutable
 
 /**
  * @author user
  * @since 01-Nov-19
  */
-class MathematicaEvaluator(globalEnvironment: mutable.Map[String, ASTNode]= mutable.Map.empty[String, ASTNode])
+class MathematicaEvaluator private (globalEnvironment: mutable.Map[String, ASTNode])
   extends LazyLogging {
 
+  /* --- constructors --- */
+
+  def this(startEnvironment: Map[String, ASTNode]=Map.empty) = {
+    this(mutable.Map[String, ASTNode](startEnvironment.toSeq:_*))
+  }
+
+  /* --- publics --- */
+
   def eval(node: ASTNode): ASTNode = {
     logger.debug("Evalutating " + node)
     eval(node, globalEnvironment)
   }
 
+  /* --- privates --- */
+
   private def eval(node: ASTNode, environment: mutable.Map[String, ASTNode]): ASTNode = {
+    node match {
+      case a @ (_: SymbolNode | _: NumberNode | _: StringNode) => evalTerminals(a, environment)
+      case a @ (PlusNode(_) | TimesNode(_) | DivideNode(_)) => evalMath(a, environment)
+      case other: Any => throw new MatchError(other)
+    }
+  }
+
+  private def evalTerminals(node: ASTNode, environment: mutable.Map[String, ASTNode]): ASTNode = {
     node match {
       case NumberNode(fraction) if fraction.contains("/") =>
         NumberNode(fraction.split("/").map(_.toDouble).reduce(_ / _).toString)
-      case node: NumberNode => node
-      case node: StringNode => node
       case SymbolNode(symbol) => environment(symbol)
+      case node => node
+    }
+  }
+
+  private def evalMath(node: ASTNode, environment: mutable.Map[String, ASTNode]): NumberNode = {
+    node match {
       case PlusNode(arguments) =>
         NumberNode(arguments.map(eval(_, environment).asInstanceOf[NumberNode]).map(_.value.toDouble).sum.toString)
       case TimesNode(arguments) =>
         NumberNode(arguments.map(eval(_, environment).asInstanceOf[NumberNode]).map(_.value.toDouble).product.toString)
       case DivideNode(Seq(first, second)) =>
         (eval(first), eval(second)) match {
           case (NumberNode(a) , NumberNode(b)) => NumberNode((a.toDouble / b.toDouble).toString)
-          case other => throw new MatchError(other)
+          case other: Any => throw new MatchError(other)
         }
-      case other => throw new MatchError(other)
+      case other: Any => throw new MatchError(other)
     }
   }
 }
diff --git a/src/main/scala/com/github/tomerghelber/mathematica/parser/Delimiters.scala b/src/main/scala/com/github/tomerghelber/mathematica/parser/Delimiters.scala
@@ -1,4 +1,4 @@
-package tomerghelber.mathematica.parser
+package com.github.tomerghelber.mathematica.parser
 
 /**
  * @author user
@@ -8,6 +8,8 @@ object Delimiters {
 
   val ROUND_BRACKET_OPEN = "("
   val ROUND_BRACKET_CLOSE = ")"
+  val CURLY_BRACKET_OPEN = "{"
+  val CURLY_BRACKET_CLOSE = "}"
   val SQUARE_BRACKET_OPEN = "["
   val SQUARE_BRACKET_CLOSE = "]"
   val SQUARE_BRACKET_OPEN2 = "[["
@@ -48,6 +50,8 @@ object Delimiters {
   def values: Set[String] = Set(
     ROUND_BRACKET_OPEN,
     ROUND_BRACKET_CLOSE,
+    CURLY_BRACKET_OPEN,
+    CURLY_BRACKET_CLOSE,
     SQUARE_BRACKET_OPEN,
     SQUARE_BRACKET_CLOSE,
     SQUARE_BRACKET_OPEN2,
diff --git a/src/main/scala/com/github/tomerghelber/mathematica/parser/MathematicaLexer.scala b/src/main/scala/com/github/tomerghelber/mathematica/parser/MathematicaLexer.scala
@@ -1,4 +1,4 @@
-package tomerghelber.mathematica.parser
+package com.github.tomerghelber.mathematica.parser
 
 import scala.collection.mutable
 import scala.util.parsing.combinator.lexical.Lexical
@@ -17,20 +17,16 @@ class MathematicaLexer extends Lexical with StdTokens {
       )
 
   private def number: Parser[NumericLit] = {
-    val sign: Parser[String] = accept("sign", {case '+' => "+" case '-' => "-"})
+    val sign: Parser[String] = acceptMatch("sign", {case '+' => "+" case '-' => "-"})
     val unsignedInteger: Parser[String] = rep1(digit) ^^ { number => number.mkString }
     val signedInteger: Parser[String] = opt(sign) ~ unsignedInteger ^^ {
       case signOptional ~ number => (signOptional ++ number).mkString
     }
-    val signedFraction: Parser[String] = signedInteger ~ ('/' ~> signedInteger) ^^ {
-      case p ~ q => p + "/" + q
-    }
-    val signedFloat: Parser[String] = signedInteger ~ ('.' ~> unsignedInteger) ^^ {
-      case beforeDot ~ afterDot => beforeDot + "." + afterDot
-    }
-    val scientificNotation: Parser[String] = signedFloat ~ ('E' ~> signedInteger) ^^ {
-      case base ~ expo => base + "E" + expo
-    }
+    def concat(before: Parser[String], char: Char, after: Parser[String]): Parser[String] =
+      before ~ char ~ after ^^ {case p ~ middle ~ q => p + middle + q}
+    val signedFraction: Parser[String] = concat(signedInteger, '/', signedInteger)
+    val signedFloat: Parser[String] = concat(signedInteger, '.', unsignedInteger)
+    val scientificNotation: Parser[String] = concat(signedFloat , 'E', signedInteger)
     (scientificNotation | signedFloat | signedFraction | signedInteger) ^^ NumericLit
   }
   private def identifier = letter ~ rep(letter | digit) ^^ {
diff --git a/src/main/scala/com/github/tomerghelber/mathematica/parser/MathematicaParser.scala b/src/main/scala/com/github/tomerghelber/mathematica/parser/MathematicaParser.scala
@@ -1,9 +1,10 @@
-package tomerghelber.mathematica.parser
+package com.github.tomerghelber.mathematica.parser
 
+import com.github.tomerghelber.mathematica.ast
+import com.github.tomerghelber.mathematica.ast._
+import com.github.tomerghelber.mathematica.parser.Delimiters._
 import com.typesafe.scalalogging.LazyLogging
 
-import tomerghelber.mathematica.ast._
-import tomerghelber.mathematica.parser.Delimiters._
 import scala.util.parsing.combinator.syntactical.StdTokenParsers
 
 /** This is a parser of Mathematica language as described at
@@ -76,7 +77,7 @@ class MathematicaParser extends StdTokenParsers with ParserUtil with LazyLogging
   private val factorial: Parser[ASTNode] = lastFolderRight(composition,
     (EXCLAMATION_MARK ~ EXCLAMATION_MARK) ^^ {_=>(e: ASTNode) => Factorial2Node(e)}
   ) ~ opt(EXCLAMATION_MARK) ^^ {
-    case expr ~ factorialOpt => factorialOpt.map(_=>FactorialNode(expr)).getOrElse(expr)
+    case expr ~ factorialOpt => factorialOpt.map(_=>ast.FactorialNode(expr)).getOrElse(expr)
   }
 
   private val conjugateAndTranspose: Parser[ASTNode] = lastFolderRight(factorial,
@@ -96,11 +97,13 @@ class MathematicaParser extends StdTokenParsers with ParserUtil with LazyLogging
 
   private val power: Parser[ASTNode] = rep1sep(derivative, CARET) ^^ (values => values.reduceRight(PowerNode.apply))
 
-//  private val verticalArrowAndVectorOperators: Parser[ASTNode] = power
+  private val verticalArrowAndVectorOperators: Parser[ASTNode] = CURLY_BRACKET_OPEN ~> rep1sep(power, COMMA) <~ CURLY_BRACKET_CLOSE ^^ {
+    elements => FunctionNode(SymbolNode("List"), elements)
+  } | power
 
   private val sqrt: Parser[ASTNode] = firstFolderRight(
     SQRT ^^ {_=>(e:ASTNode)=>SqrtNode(e)},
-    power
+    verticalArrowAndVectorOperators
   )
 
   private val differentialD: Parser[ASTNode] = firstFolderRight(
@@ -232,7 +235,12 @@ class MathematicaParser extends StdTokenParsers with ParserUtil with LazyLogging
 //    case expr1 ~ "⊤" ~ expr2 => DownTeeNode(expr1, expr2)
 //  } | implies
 
-  private def root = not
+  private val rules = chainl1(not,
+    ("->" | "\uF522") ^^ {_=>(e1: ASTNode, e2: ASTNode) => RuleNode(e1, e2)}
+  | (":>" | "\uF51F") ^^ {_=>(e1: ASTNode, e2: ASTNode) => RuleDelayedNode(e1, e2)}
+  )
+
+  private def root = rules
 
   /**
    * Parse the given <code>expression</code> String into an ASTNode.
diff --git a/src/main/scala/com/github/tomerghelber/mathematica/parser/ParserUtil.scala b/src/main/scala/com/github/tomerghelber/mathematica/parser/ParserUtil.scala
@@ -1,4 +1,4 @@
-package tomerghelber.mathematica.parser
+package com.github.tomerghelber.mathematica.parser
 
 import scala.util.parsing.combinator.Parsers
 
diff --git a/src/main/scala/com/github/tomerghelber/mathematica/parser/SyntaxException.scala b/src/main/scala/com/github/tomerghelber/mathematica/parser/SyntaxException.scala
@@ -1,3 +1,3 @@
-package tomerghelber.mathematica.parser
+package com.github.tomerghelber.mathematica.parser
 
 case class SyntaxException(msg: String) extends Exception(msg)
diff --git a/src/test/resources/logback-test.xml b/src/test/resources/logback-test.xml
@@ -0,0 +1,4 @@
+<configuration>
+    <root level="ERROR">
+    </root>
+</configuration>
diff --git a/src/test/scala/com/github/tomerghelber/mathematica/eval/MathematicaEvaluatorSpec.scala b/src/test/scala/com/github/tomerghelber/mathematica/eval/MathematicaEvaluatorSpec.scala
diff --git a/src/test/scala/com/github/tomerghelber/mathematica/package.scala b/src/test/scala/com/github/tomerghelber/mathematica/package.scala
diff --git a/src/test/scala/com/github/tomerghelber/mathematica/parser/MathematicaParserSpec.scala b/src/test/scala/com/github/tomerghelber/mathematica/parser/MathematicaParserSpec.scala

-Original file line number
+Diff line change
@@ @@ -1,2 +1,4 @@ @@
 *.class
 *.log
 +target/*
 +project/target/*
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ project.excludeFilters = [`
`10`	`10`	`".git/.*"`
`11`	`11`	`]`
`12`	`12`
`13`		`-maxColumn = 100`
	`13`	`+maxColumn = 120`
`14`	`14`
`15`	`15`	`continuationIndent {`
`16`	`16`	`callSite = 2`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package tomerghelber.mathematica.ast`
	`1`	`+package com.github.tomerghelber.mathematica.ast`
`2`	`2`
`3`	`3`	`object NotNode extends ApplyUnaryFunctionNode with UnapplyFunctionNode {`
`4`	`4`	`protected val name: String = "Not"`