feat: add filter.py

Signed-off-by: Charles Larivier <charles@dribbble.com>

Author: Charles Larivier

src/metabase/mbql/filter.py

@@ -0,0 +1,141 @@
+from typing import Any, List
+
+from metabase.mbql.base import Mbql, Option
+
+
+class CaseOption(Option):
+    CASE_SENSITIVE = {"case-sensitive": True}
+    CASE_INSENSITIVE = {"case-sensitive": False}
+
+
+class TimeGrainOption(Option):
+    MINUTE = "minute"
+    HOUR = "hour"
+    DAY = "day"
+    WEEK = "week"
+    MONTH = "month"
+    QUARTER = "quarter"
+    YEAR = "year"
+
+
+class Filter(Mbql):
+    function: str
+
+    def __init__(self, id: int, option: Option = None):
+        self.id = id
+        self.option = None
+        self.filter_option = option
+
+    def compile(self) -> List:
+        compiled = [self.function, super(Filter, self).compile()]
+
+        if self.filter_option is not None:
+            compiled = compiled + [self.filter_option]
+
+        return compiled
+
+
+class ValueFilter(Filter):
+    def __init__(self, id: int, value: Any, option: Option = None):
+        self.id = id
+        self.value = value
+        self.option = None
+        self.filter_option = option
+
+    def compile(self) -> List:
+        compiled = [self.function, super(Filter, self).compile(), self.value]
+
+        if self.filter_option is not None:
+            compiled = compiled + [self.filter_option]
+
+        return compiled
+
+
+class Equal(ValueFilter):
+    function = "="
+
+
+class NotEqual(ValueFilter):
+    function = "!="
+
+
+class Greater(ValueFilter):
+    function = ">"
+
+
+class Less(ValueFilter):
+    function = "<"
+
+
+class Between(Filter):
+    function = "between"
+
+    def __init__(
+        self, id: int, lower_bound: float, upper_bound: float, option: Option = None
+    ):
+        self.id = id
+        self.option = None
+        self.filter_option = option
+        self.lower_bound = lower_bound
+        self.upper_bound = upper_bound
+
+    def compile(self) -> List:
+        return super(Between, self).compile() + [self.lower_bound, self.upper_bound]
+
+
+class GreaterEqual(ValueFilter):
+    function = ">="
+
+
+class LessEqual(ValueFilter):
+    function = "<="
+
+
+class IsNull(Filter):
+    function = "is-null"
+
+
+class IsNotNull(Filter):
+    function = "not-null"
+
+
+class Contains(ValueFilter):
+    function = "contains"
+
+
+class StartsWith(ValueFilter):
+    function = "starts-with"
+
+
+class EndsWith(ValueFilter):
+    function = "ends-with"
+
+
+class TimeInterval(Filter):
+    function = "time-interval"
+
+    def __init__(
+        self,
+        id: int,
+        value: Any,
+        time_grain: TimeGrainOption,
+        include_current: bool = True,
+    ):
+        self.id = id
+        self.value = value
+        self.option = None
+        self.time_grain = time_grain
+        self.include_current = include_current
+
+    def compile(self) -> List:
+        compiled = [
+            self.function,
+            super(Filter, self).compile(),
+            self.value,
+            self.time_grain,
+        ]
+
+        if self.include_current:
+            compiled = compiled + [{"include-current": True}]
+
+        return compiled

tests/mbql/test_filter.py

@@ -0,0 +1,54 @@
+from unittest import TestCase
+
+from metabase.mbql.filter import (
+    Between,
+    CaseOption,
+    TimeGrainOption,
+    TimeInterval,
+    ValueFilter,
+)
+
+
+class FilterTests(TestCase):
+    def test_value_filter_compile(self):
+        """
+        Ensure ValueFilter.compile() returns
+        [self.function, ['field', self.id, None], self.value, self.filter_option].
+        """
+
+        class Mock(ValueFilter):
+            function = "mock"
+
+        filter = Mock(id=5, value="gmail", option=CaseOption.CASE_SENSITIVE)
+        self.assertEqual(
+            ["mock", ["field", 5, None], "gmail", {"case-sensitive": True}],
+            filter.compile(),
+        )
+
+    def test_between_compile(self):
+        """
+        Ensure Between.compile() returns
+        ['between', ['field', self.id', None], self.lower_bound, self.upper_bound].
+        """
+        between = Between(id=2, lower_bound=2.5, upper_bound=6.7)
+        self.assertEqual(["between", ["field", 2, None], 2.5, 6.7], between.compile())
+
+    def test_time_interval(self):
+        interval = TimeInterval(id=4, value=30, time_grain=TimeGrainOption.YEAR)
+        self.assertEqual(
+            [
+                "time-interval",
+                ["field", 4, None],
+                30,
+                "year",
+                {"include-current": True},
+            ],
+            interval.compile(),
+        )
+
+        interval = TimeInterval(
+            id=4, value=30, time_grain=TimeGrainOption.YEAR, include_current=False
+        )
+        self.assertEqual(
+            ["time-interval", ["field", 4, None], 30, "year"], interval.compile()
+        )