LEXIO-37885 Adds math functions (#3)

* Adds math functions

* Adds math functions

* Version bumped to 0.4.0

Co-authored-by: ns-circle-ci <[email protected]>

Author: jdrake

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pysaql"
-version = "0.3.0"
+version = "0.4.0"
 description = "Python SAQL query builder"
 authors = ["Jonathan Drake <[email protected]>"]
 license = "BSD-3-Clause"

pysaql/__init__.py

@@ -1,3 +1,3 @@
 """Python SAQL query builder"""
 
-__version__ = "0.3.0"
+__version__ = "0.4.0"

pysaql/function.py

@@ -3,6 +3,7 @@
 from typing import Any, Optional, Sequence
 
 from .scalar import Scalar
+from .util import stringify
 
 
 class Function(Scalar):
@@ -18,7 +19,7 @@ def __init__(self, *args: Any) -> None:
 
     def to_string(self) -> str:
         """Cast the function to a string"""
-        args = [str(arg) for arg in self._args if arg is not None]
+        args = [stringify(arg) for arg in self._args if arg is not None]
         name = self._name or self.__class__.__name__
         return f"{name}({', '.join(args)})"
 
@@ -38,3 +39,106 @@ class coalesce(Function):
     """
 
     pass
+
+
+class abs_(Function):
+    """Get the absolute value of a number
+
+    See: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_saql.meta/bi_dev_guide_saql/bi_saql_functions_math_abs.htm
+    """
+
+    _name = "abs"
+
+    def __init__(self, value: Scalar) -> None:
+        """Initializer
+
+        Args:
+            value: Number for which to get the absolute value
+
+        """
+        super().__init__(value)
+
+
+class ceil(Function):
+    """Returns the nearest integer of equal or greater value to n
+
+    See: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_saql.meta/bi_dev_guide_saql/bi_saql_functions_math_ceil.htm
+    """
+
+    def __init__(self, value: Scalar) -> None:
+        """Initializer
+
+        Args:
+            value: Number for which to get ceiling
+
+        """
+        super().__init__(value)
+
+
+class floor(Function):
+    """Returns the nearest integer of equal or lesser value to n
+
+    See: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_saql.meta/bi_dev_guide_saql/bi_saql_functions_math_floor.htm
+    """
+
+    def __init__(self, value: Scalar) -> None:
+        """Initializer
+
+        Args:
+            value: Number for which to get the floor
+
+        """
+        super().__init__(value)
+
+
+class power(Function):
+    """Returns m raised to the nth power
+
+    See: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_saql.meta/bi_dev_guide_saql/bi_saql_functions_math_power.htm
+    """
+
+    def __init__(self, m: Scalar, n: int) -> None:
+        """Initializer
+
+        Args:
+            m: Number to raise to the exponent
+            n: Exponent
+
+        """
+        super().__init__(m, n)
+
+
+class round_(Function):
+    """Returns the value of n rounded to m decimal places
+
+    See: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_saql.meta/bi_dev_guide_saql/bi_saql_functions_math_round.htm
+    """
+
+    _name = "round"
+
+    def __init__(self, n: Scalar, m: int) -> None:
+        """Initializer
+
+        Args:
+            n: Number to round
+            m: Number of decimal places
+
+        """
+        super().__init__(n, m)
+
+
+class trunc(Function):
+    """Returns the value of the numeric expression n truncated to m decimal places
+
+    See: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_saql.meta/bi_dev_guide_saql/bi_saql_functions_math_trunc.htm
+    """
+
+    def __init__(self, n: Scalar, m: int) -> None:
+        """Initializer
+
+        Args:
+            n: Number to truncate
+            m: Number of decimal places
+
+        """
+        super().__init__(n, m)

pysaql/scalar.py

@@ -22,6 +22,7 @@
     operator.is_not: "is not",
     operator.le: "<=",
     operator.lt: "<",
+    operator.mod: "%",
     operator.mul: "*",
     operator.ne: "!=",
     operator.neg: "-",

tests/unit/test_function.py

@@ -0,0 +1,50 @@
+"""Contains unit tests for the function module"""
+
+
+import pysaql.function as fn
+from pysaql.scalar import field
+
+
+def test_coalesce():
+    """Should coalesce values"""
+    assert (
+        str(fn.coalesce(field("name"), field("other"), "empty").alias("NAME"))
+        == """coalesce('name', 'other', "empty") as 'NAME'"""
+    )
+
+
+def test_abs():
+    """Should render abs function"""
+    assert str(fn.abs_(field("num")).alias("NAME")) == """abs('num') as 'NAME'"""
+
+
+def test_ceil():
+    """Should render ceil function"""
+    assert str(fn.ceil(field("num")).alias("NAME")) == """ceil('num') as 'NAME'"""
+
+
+def test_floor():
+    """Should render floor function"""
+    assert str(fn.floor(field("num")).alias("NAME")) == """floor('num') as 'NAME'"""
+
+
+def test_power():
+    """Should render power function"""
+    assert (
+        str(fn.power(field("num"), 12).alias("NAME"))
+        == """power('num', 12) as 'NAME'"""
+    )
+
+
+def test_round():
+    """Should render round function"""
+    assert (
+        str(fn.round_(field("num"), 0).alias("NAME")) == """round('num', 0) as 'NAME'"""
+    )
+
+
+def test_trunc():
+    """Should render trunc function"""
+    assert (
+        str(fn.trunc(field("num"), 0).alias("NAME")) == """trunc('num', 0) as 'NAME'"""
+    )