mensa 0.6.15 → 0.6.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd9ef2e0b14473937b5da9f4e7d82628501bb106e03dc892c3f055a15e2c562f
-  data.tar.gz: 8b088073a2fcc12813252c42e04ba277b97c44126e786c157a7090c253f4868a
+  metadata.gz: 0a88070a879c44aa30934fd328a74c21546c2517999731ad033dc10022d2a4ee
+  data.tar.gz: 3940bc3931ce9f0a0aad748c378cbd7c3231616cedea960f7c24ab7bdc974cf2
 SHA512:
-  metadata.gz: 949a19530126d3a298bd4c34b10ea1c3db21c86555565f0ea7db3289cba10067f82a9ca289384c940358a34bf98d1109f364723333e9420e0c663318fffca6f7
-  data.tar.gz: 7670004d48f01f5aeec0e56772f51a4eee30d9b910c9c11bccb57b82d22c56ae62ea4d763d5ae1fbfd99c50ac1486f055774d1bda6af2dcc390b757c534322db
+  metadata.gz: 77fe83cd050e611f24086db47cd0a0f9330459289390df37361a97f82950819a0b22a0d6573a094be0cf4d7f6455624ccf08c44fd4f7d8c1c4398077df3fb192
+  data.tar.gz: a5485bbe47e59950753d270fde0ffc7618ec760837b3c2f435fa4b9f798c81822e514dab1e9688a090b2d31cc13929b2ecdd4fe3038ec57db6581eecb61b18aa

data/.shipkit.yml

@@ -1,2 +1,2 @@
 ---
-previous_version: 0.6.14
+previous_version: 0.6.15

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 0.6.16
+
+- Custom filter `scope` blocks can take the operator as a second argument,
+  e.g. `scope ->(value, operator) { ... }`, so they can handle `isnt`,
+  `is_empty` and the other operators. Existing `->(value) { ... }` scopes keep
+  working unchanged.
+
 ## 0.6.15
 
 - Custom filter `scope` blocks now work. Applied filters are built from the

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mensa (0.6.14)
+    mensa (0.6.15)
       csv
       importmap-rails
       pagy (>= 43)

data/README.md

@@ -118,6 +118,59 @@ You can show your tables on the page using the following:
 Custom views are views not defined by the developer (SystemViews) but by the end-user by adding/removing filters.
 When you enable these, they are stored in the database and can be used across sessions, by the user who created them.
 
+### Filters
+
+Add `filter` to a column to let users filter on it. By default Mensa compares the
+column's attribute with the chosen value, using operators that fit the column type.
+The filter block takes these options:
+
+```ruby
+column(:role) do
+  filter do
+    collection -> { User::ROLES }  # Values to choose from (array or proc)
+    multiple true                  # Allow choosing several values
+    operators [:is, :isnt]         # Limit the operators users can pick
+    operator :isnt                 # Default operator
+    having true                    # Filter with HAVING, for aggregate attributes
+  end
+end
+```
+
+The operators are `is`, `isnt`, `matches`, `does_not_match`, `gt`, `gteq`, `lt`,
+`lteq`, `is_duplicate`, `is_current`, `is_empty` and `isnt_empty`.
+
+#### Custom filter scopes
+
+When comparing the attribute isn't enough, give the filter a `scope`. It runs on the
+table's scope and receives the chosen value, an array when `multiple` is set:
+
+```ruby
+column(:account_names) do
+  attribute %((SELECT STRING_AGG(accounts.name, ', ') FROM accounts WHERE accounts.id = ANY(containers.account_ids)))
+  filter do
+    collection -> { Account.order(:name).pluck(:name) }
+    multiple true
+    operators [:is]
+    scope ->(value) { where("containers.account_ids && ARRAY[:ids]::uuid[]", ids: Account.where(name: Array(value)).pluck(:id)) }
+  end
+end
+```
+
+To support more operators, accept the operator (a symbol) as a second argument:
+
+```ruby
+filter do
+  operators [:is, :isnt, :is_empty]
+  scope ->(value, operator) {
+    case operator
+    when :isnt then where.not(account_id: value)
+    when :is_empty then where(account_id: nil)
+    else where(account_id: value)
+    end
+  }
+end
+```
+
 ### Grouping
 
 Rows can be shown in groups, each with a header that shows the group's value and

data/app/tables/mensa/filter.rb

@@ -80,7 +80,7 @@ module Mensa
 
     def filter_scope(record_scope)
       if scope
-        record_scope.instance_exec(normalize(value), &scope)
+        record_scope.instance_exec(*scope_arguments, &scope)
       else
         return apply_duplicate_filter(record_scope) if operator == :is_duplicate
 
@@ -182,6 +182,17 @@ module Mensa
       end
     end
 
+    # Arguments for a custom filter scope: the value and the operator. Lambdas
+    # only get as many as they declare, so `->(value) { ... }` keeps working
+    # next to `->(value, operator) { ... }`. Plain procs ignore extra arguments.
+    def scope_arguments
+      args = [normalize(value), operator]
+      return args unless scope.lambda?
+      return args if scope.parameters.any? { |type, _| type == :rest }
+
+      args.first(scope.parameters.count { |type, _| type == :req || type == :opt })
+    end
+
     def label_for_value(selected_value, options)
       option = options.find { |_label, value| value.to_s == selected_value.to_s }
       option ? option.first : selected_value

data/lib/mensa/version.rb

@@ -1,3 +1,3 @@
 module Mensa
-  VERSION = "0.6.15"
+  VERSION = "0.6.16"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mensa
 version: !ruby/object:Gem::Version
-  version: 0.6.15
+  version: 0.6.16
 platform: ruby
 authors:
 - Tom de Grunt