Changeset deed211 in tailbone

Timestamp:

11/15/2022 04:29:15 PM (3 months ago)

Author:

Lance Edgar <lance@…>

Branches:

master

Children:

3178894

Parents:

3e8924e

Message:

Add "between" verb for numeric grid filters

Location:

tailbone

Files:

• grids/filters.py (modified) (7 diffs)
• static/js/tailbone.buefy.grid.js (modified) (1 diff)
• templates/grids/buefy.mako (modified) (2 diffs)

tailbone/grids/filters.py

@@ -77 +77 @@
     Input renderer for numeric values.
     """
-    # TODO
-    # data_type = 'number'
+    data_type = 'number'
 
     def render(self, value=None, **kwargs):
@@ -138 +137 @@
         'is_empty':             "is empty",
         'is_not_empty':         "is not empty",
+        'between':              "between",
         'is_null':              "is null",
         'is_not_null':          "is not null",
@@ -379 +379 @@
         return query.filter(self.column <= self.encode_value(value))
 
+    def filter_between(self, query, value):
+        """
+        Filter data with a "between" query.  Really this uses ">=" and
+        "<=" (inclusive) logic instead of SQL "between" keyword.
+        """
+        if value is None or value == '':
+            return query
+
+        if '|' not in value:
+            return query
+
+        values = value.split('|')
+        if len(values) != 2:
+            return query
+
+        start_value, end_value = values
+
+        # we'll only filter if we have start and/or end value
+        if not start_value and not end_value:
+            return query
+
+        return self.filter_for_range(query, start_value, end_value)
+
+    def filter_for_range(self, query, start_value, end_value):
+        """
+        This method should actually apply filter(s) to the query,
+        according to the given value range.  Subclasses may override
+        this logic.
+        """
+        if start_value:
+            if self.value_invalid(start_value):
+                return query
+            query = query.filter(self.column >= start_value)
+
+        if end_value:
+            if self.value_invalid(end_value):
+                return query
+            query = query.filter(self.column <= end_value)
+
+        return query
+
 
 class AlchemyStringFilter(AlchemyGridFilter):
@@ -533 +574 @@
     # expose greater-than / less-than verbs in addition to core
     default_verbs = ['equal', 'not_equal', 'greater_than', 'greater_equal',
-                     'less_than', 'less_equal', 'is_null', 'is_not_null', 'is_any']
+                     'less_than', 'less_equal', 'between',
+                     'is_null', 'is_not_null', 'is_any']
 
     # TODO: what follows "works" in that it prevents an error...but from the
@@ -542 +584 @@
 
     def value_invalid(self, value):
+
+        # first just make sure it's somewhat numeric
+        try:
+            float(value)
+        except ValueError:
+            return True
+
         return bool(value and len(six.text_type(value)) > 8)
 
@@ -727 +776 @@
         return query.filter(self.column <= self.encode_value(date))
 
+    # TODO: this should be merged into parent class
     def filter_between(self, query, value):
         """
@@ -754 +804 @@
         return self.filter_date_range(query, start_date, end_date)
 
+    # TODO: this should be merged into parent class
     def filter_date_range(self, query, start_date, end_date):
         """

tailbone/static/js/tailbone.buefy.grid.js

@@ +1 @@
+
+const GridFilterNumericValue = {
+    template: '#grid-filter-numeric-value-template',
+    props: {
+        value: String,
+        wantsRange: Boolean,
+    },
+    data() {
+        return {
+            startValue: null,
+            endValue: null,
+        }
+    },
+    mounted() {
+        if (this.wantsRange) {
+            if (this.value.includes('|')) {
+                let values = this.value.split('|')
+                if (values.length == 2) {
+                    this.startValue = values[0]
+                    this.endValue = values[1]
+                } else {
+                    this.startValue = this.value
+                }
+            } else {
+                this.startValue = this.value
+            }
+        } else {
+            this.startValue = this.value
+        }
+    },
+    methods: {
+        focus() {
+            this.$refs.startValue.focus()
+        },
+        startValueChanged(value) {
+            if (this.wantsRange) {
+                value += '|' + this.endValue
+            }
+            this.$emit('input', value)
+        },
+        endValueChanged(value) {
+            value = this.startValue + '|' + value
+            this.$emit('input', value)
+        },
+    },
+}
+
+Vue.component('grid-filter-numeric-value', GridFilterNumericValue)
+
 
 const GridFilterDateValue = {

tailbone/templates/grids/buefy.mako

@@ -1 +1 @@
 ## -*- coding: utf-8; -*-
+
+<script type="text/x-template" id="grid-filter-numeric-value-template">
+  <div class="level">
+    <div class="level-left">
+      <div class="level-item">
+        <b-input v-model="startValue"
+                 ref="startValue"
+                 @input="startValueChanged">
+        </b-input>
+      </div>
+      <div v-show="wantsRange"
+           class="level-item">
+        and
+      </div>
+      <div v-show="wantsRange"
+           class="level-item">
+        <b-input v-model="endValue"
+                 ref="endValue"
+                 @input="endValueChanged">
+        </b-input>
+      </div>
+    </div>
+  </div>
+</script>
 
 <script type="text/x-template" id="grid-filter-date-value-template">
@@ -75 +99 @@
           </option>
         </b-select>
+
+        <grid-filter-numeric-value v-if="filter.data_type == 'number'"
+                                  v-model="filter.value"
+                                  v-show="valuedVerb()"
+                                  :wants-range="filter.verb == 'between'"
+                                  ref="valueInput">
+        </grid-filter-numeric-value>
 
         <b-input v-if="filter.data_type == 'string' && !multiValuedVerb()"