feat(NumericBuiltinFunction): Add random number function

[kaaquist]

Description

• Added random number function and related tests and documentation.

Related issues

closes #506

[CLAassistant]

All committers have signed the CLA.

[kaaquist]

Still needed documentation and I also have a question in regards to test. I would like to test it the number returned is between 0.0f and 1.0f. I have created a test that I would expect would pass but I get an exception.
Test:

it should "return a number between 0.0 and 1.0 " in {
    eval(" random number() ") should (be >= ValNumber(0.0) and be <= ValNumber(1.0))
}

Exception:

overloaded method should with alternatives:
  (endWithWord: org.scalatest.matchers.dsl.EndWithWord)(implicit ev: org.camunda.feel.syntaxtree.Val <:< String): BuiltinNumberFunctionsTest.this.ResultOfEndWithWordForString <and>
  (startWithWord: org.scalatest.matchers.dsl.StartWithWord)(implicit ev: org.camunda.feel.syntaxtree.Val <:< String): BuiltinNumberFunctionsTest.this.ResultOfStartWithWordForString <and>
  (includeWord: org.scalatest.matchers.dsl.IncludeWord)(implicit ev: org.camunda.feel.syntaxtree.Val <:< String): BuiltinNumberFunctionsTest.this.ResultOfIncludeWordForString <and>
  (notExist: org.scalatest.matchers.dsl.ResultOfNotExist)(implicit existence: org.scalatest.enablers.Existence[org.camunda.feel.syntaxtree.Val]): org.scalatest.Assertion <and>
  (existWord: org.scalatest.matchers.dsl.ExistWord)(implicit existence: org.scalatest.enablers.Existence[org.camunda.feel.syntaxtree.Val]): org.scalatest.Assertion <and>
  (containWord: org.scalatest.matchers.dsl.ContainWord)org.scalatest.matchers.dsl.ResultOfContainWord[org.camunda.feel.syntaxtree.Val] <and>
  (haveWord: org.scalatest.matchers.dsl.HaveWord)BuiltinNumberFunctionsTest.this.ResultOfHaveWordForExtent[org.camunda.feel.syntaxtree.Val] <and>
  (beWord: org.scalatest.matchers.dsl.BeWord)BuiltinNumberFunctionsTest.this.ResultOfBeWordForAny[org.camunda.feel.syntaxtree.Val] <and>
  (inv: org.scalactic.TripleEqualsSupport.TripleEqualsInvocationOnSpread[org.camunda.feel.syntaxtree.Val])(implicit ev: Numeric[org.camunda.feel.syntaxtree.Val]): org.scalatest.Assertion <and>
  [U](inv: org.scalactic.TripleEqualsSupport.TripleEqualsInvocation[U])(implicit constraint: org.scalactic.CanEqual[org.camunda.feel.syntaxtree.Val,U]): org.scalatest.Assertion <and>
  (notWord: org.scalatest.matchers.dsl.NotWord)org.scalatest.matchers.dsl.ResultOfNotWordForAny[org.camunda.feel.syntaxtree.Val] <and>
  [TYPECLASS1[_], TYPECLASS2[_]](rightMatcherFactory2: org.scalatest.matchers.dsl.MatcherFactory2[org.camunda.feel.syntaxtree.Val,TYPECLASS1,TYPECLASS2])(implicit typeClass1: TYPECLASS1[org.camunda.feel.syntaxtree.Val], typeClass2: TYPECLASS2[org.camunda.feel.syntaxtree.Val]): org.scalatest.Assertion <and>
  [TYPECLASS1[_]](rightMatcherFactory1: org.scalatest.matchers.dsl.MatcherFactory1[org.camunda.feel.syntaxtree.Val,TYPECLASS1])(implicit typeClass1: TYPECLASS1[org.camunda.feel.syntaxtree.Val]): org.scalatest.Assertion <and>
  (rightMatcherX1: org.scalatest.matchers.Matcher[org.camunda.feel.syntaxtree.Val])org.scalatest.Assertion
 cannot be applied to (org.scalatest.matchers.Matcher[org.camunda.feel.syntaxtree.ValNumber])
    eval(" random number() ") should (be >= ValNumber(0.0) and be <= ValNumber(1.0))

[saig0]

I would like to test it the number returned is between 0.0f and 1.0f. I have created a test that I would expect would pass but I get an exception.

Nice try. 👍

Instead, you could use a match-case and extract the number first.

For example:

eval(" random number() ") match {
  case ValNumber(x) => x should (be >= 0 and be <= 1)  
  case other => fail()
}

[saig0]

@kaaquist thank you for your contribution. 🎉

The changes look good. 👍 I have only a few minor comments.

[saig0]

@kaaquist your PR is merged. :tada: Thank you for applying the hints. :cookie:

---

This pull request counts toward the Hacktoberfest challenge. If you contributed four pull requests then you can complete your Camunda Hacktoberfest challenge here.