mensa 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10a862acae838d21598f9ce5d3e07b553a7a5e002b66c4993e32e0cb665d5a5d
-  data.tar.gz: 36115f04215a21212ad1f5f81ecd108f75e68199d4ae9a5db1c11cf74e136350
+  metadata.gz: 95766fa259330a818f92429d4b361853af00fee5e519d44bac2cf9c251bf4206
+  data.tar.gz: b58a0063b5e7331a26ebc3da30516fa901237b6f2a4901354a18929c0a83a51c
 SHA512:
-  metadata.gz: cfa2040a481694e363da898e51ab521ec7b8b4defc6775d46b919f8775296d57839e34afd690da5b7bfb478ab1ef9e727536ff6892db660fb4439026e5c7d2e0
-  data.tar.gz: 3080bef3dfe7f0ff02c64e43e7296865c1e835caa86f47bfeaa74d3e0c6232c2c886bd6f2ba3dafb7ffa0c7bc2790cce77a0fe5052e45c72a273874a7b63e226
+  metadata.gz: 5c2d502c10e92c897a7ef313667772afb3e823f87ea2efd804543706b9380416b2238dbd06bd98c39d67086576d6ba4422be343c01db2afa79b6e5bee1f435bd
+  data.tar.gz: 70a4ac1c22e048d6a38f02e6da520bb8ffa48b2b5ca94b336aa7ee3b09a556b59c085e10b75edfc59a09c8aade640f636b89017d7868fb135420aac9df34b457

data/.zed/tasks.json

@@ -1,7 +1,7 @@
 [
     {
         "label": "Rails server",
-        "command": "bin/rails server -p 3000 -b 0.0.0.0",
+        "command": "pkill -f 'puma' && bin/rails server -p 3000 -b 0.0.0.0",
         "tags": ["rails"]
     },
     {

data/Gemfile

@@ -14,6 +14,7 @@ gem "selenium-webdriver", "~> 4.17"
 gem "debug"
 gem "overmind", require: false
 gem "rack-mini-profiler"
+gem "rails-i18n"
 
 group :development, :test do
   gem "standard", require: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mensa (0.3.4)
+    mensa (0.5.0)
       csv
       importmap-rails
       pagy (>= 43)
@@ -131,7 +131,7 @@ GEM
       prism (>= 1.3.0)
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
-    json (2.19.8)
+    json (2.19.9)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     logger (1.7.0)
@@ -186,7 +186,7 @@ GEM
       json
       uri
       yaml
-    parallel (1.28.0)
+    parallel (2.1.0)
     parser (3.3.11.1)
       ast (~> 2.4.1)
       racc
@@ -243,6 +243,9 @@ GEM
     rails-html-sanitizer (1.7.0)
       loofah (~> 2.25)
       nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
+    rails-i18n (8.1.0)
+      i18n (>= 0.7, < 2)
+      railties (>= 8.0.0, < 9)
     railties (8.1.3)
       actionpack (= 8.1.3)
       activesupport (= 8.1.3)
@@ -266,11 +269,11 @@ GEM
     reline (0.6.3)
       io-console (~> 0.5)
     rexml (3.4.4)
-    rubocop (1.84.2)
+    rubocop (1.87.0)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
-      parallel (~> 1.10)
+      parallel (>= 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 2.9.3, < 3.0)
@@ -284,7 +287,7 @@ GEM
       lint_roller (~> 1.1)
       rubocop (>= 1.75.0, < 2.0)
       rubocop-ast (>= 1.47.1, < 2.0)
-    rubocop-rails (2.35.3)
+    rubocop-rails (2.35.4)
       activesupport (>= 4.2.0)
       lint_roller (~> 1.1)
       rack (>= 1.1)
@@ -313,10 +316,10 @@ GEM
       actionpack (>= 6.1)
       activesupport (>= 6.1)
       sprockets (>= 3.0.0)
-    standard (1.54.0)
+    standard (1.55.0)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.0)
-      rubocop (~> 1.84.0)
+      rubocop (~> 1.87.0)
       standard-custom (~> 1.0.0)
       standard-performance (~> 1.8)
     standard-custom (1.0.2)
@@ -383,6 +386,7 @@ DEPENDENCIES
   pry
   puma
   rack-mini-profiler
+  rails-i18n
   rubocop-rails
   ruby-lsp
   ruby-lsp-rails

data/README.md

@@ -9,21 +9,22 @@ Due to search, it only works with postgresql at the moment.
 ![export](./docs/export.png)
 
 Features:
-
-- [x] very fast
-- [x] row-links
-- [x] sorting
-- [x] filtering of multiple columns
+- [x] Very fast
+- [x] Row-links
+- [x] Sorting
+- [x] Filtering of multiple columns
 - [X] Hide filter icon in case there are no filters
-- [X] column ordering
-- [X] editing of existing filters
-- [X] view selection and exports per view
-- [X] multiple selection of rows and batch processing
-- [x] tables without headers (and without most of the above)
-
-Todo/Fixme:
-- [ ] exports can be mailed - daily/weekly/monthly/quarterly/bi-yearly/yearly (time configurable)
-- [ ] Search only works on table text columns
+- [X] Column ordering
+- [X] Editing of existing filters
+- [X] View selection and exports per view
+- [X] Multiple selection of rows and batch processing
+- [x] Tables without headers (and without most of the above)
+- [X] Search works on all table columns
+- [X] Exports can be scheduled to run recurring (daily/weekly/monthly/quarterly/bi-yearly/yearly)
+      You will have to bring your own mailer, see configuration for details.
+
+TODO:
+- [ ] ...
 
 Nice to haves:
 
@@ -72,7 +73,7 @@ class UserTable < ApplicationTable
   end
 
   link { |user| edit_user_path(user) }
-  supports_views true # This table supports custom views
+
   show_header true
   view_columns_ordering false # Disabled for now
 
@@ -191,6 +192,20 @@ Exporting is built into the table's control bar. Clicking the export button open
 a dialog that lists the user's previous downloads and lets them request a new
 export (scope and CSV format). 
 
+#### Repeating exports
+
+The user can choose to export a table on a regular basis (daily, weekly, monthly, quarterly, bi-yearly, yearly).
+
+When the user selects a repeating export, the table will be exported automatically on the specified schedule.
+
+For this to work you need to have a cron job which runs daily.
+When using `sidekiq-cron` or `goodjob` the `RecurringExportsJob` needs to be scheduled to run daily.
+
+If you're just using cron, you can add the following to your crontab:
+```
+0 0 * * * rails runner "Mensa::RecurringExportsJob.perform_later"
+```
+
 ## Contributing
 
 ```

data/app/components/mensa/add_filter/component.css

@@ -64,15 +64,17 @@
             }
 
             &__clear {
-                @apply block mt-3 text-gray-500 dark:text-gray-400 no-underline hover:text-gray-700 dark:hover:text-gray-200 cursor-pointer;
+                @apply flex items-center gap-2 mt-3 text-gray-500 dark:text-gray-400 no-underline hover:text-gray-700 dark:hover:text-gray-200 cursor-pointer;
             }
         }
     }
 }
 
-/* Show enter hint on hover or keyboard highlight — covers column list and value popover */
+/* Show key hint on hover or keyboard highlight — covers column list and value popover */
 .mensa-table__add_filter li:hover .mensa-table__add_filter__enter-hint,
-.mensa-table__add_filter li.highlighted .mensa-table__add_filter__enter-hint {
+.mensa-table__add_filter li.highlighted .mensa-table__add_filter__enter-hint,
+.mensa-table__add_filter__popover_container__clear:hover
+    .mensa-table__add_filter__enter-hint {
     display: inline-flex;
 }
 

data/app/components/mensa/add_filter/component.html.erb

@@ -4,9 +4,9 @@
      data-mensa-add-filter-operator-labels-value="<%= operator_labels.to_json %>">
   <button class="mensa-table__add_filter__trigger"
           type="button"
-          title="<%= t("mensa.add_filter.add", default: "Add filter") %>"
+          title="<%= t("mensa.add_filter.add") %>"
           data-action="mensa-add-filter#openAllColumns">
-    <i class="fa-solid fa-circle-plus"></i>
+    <i class="<%= Mensa.config.icons[:add_filter_trigger] %>"></i>
   </button>
 
   <ul class="hidden fixed z-50 max-h-96 overflow-auto rounded-lg bg-white p-2 text-base shadow-lg ring-1 ring-black ring-opacity-5 focus:outline-none dark:bg-gray-800 sm:text-sm"
@@ -18,7 +18,7 @@
           data-filter-column-name="<%= column.name %>">
         <div class="label block flex-1 truncate font-normal"><%= column.human_name %></div>
         <div class="check hidden flex items-center text-primary-600">
-          <div class="fal fa-check"></div>
+          <div class="<%= Mensa.config.icons[:add_filter_selected] %>"></div>
         </div>
         <span class="mensa-table__add_filter__enter-hint">↵ Enter</span>
       </li>

data/app/components/mensa/add_filter/component_controller.js

@@ -77,6 +77,7 @@ export default class AddFilterComponentController extends ApplicationController
 
     // Called by the + button — always shows all columns regardless of current filter
     openAllColumns(event) {
+        this._closePopover();
         this.filterColumns("");
         this.showList(event?.currentTarget);
     }

data/app/components/mensa/column_customizer/component.css

@@ -28,12 +28,12 @@
             @apply flex-none text-gray-400 dark:text-gray-500 hover:text-gray-600 dark:hover:text-gray-300 cursor-pointer;
         }
 
-        /* Show the correct eye icon based on the row's data-visible attribute.
-           Works with both FA CSS (i elements) and FA SVG mode (svg elements). */
-        &__row[data-visible="true"] .fa-eye-slash {
+        /* Show the correct visibility icon based on the row's data-visible attribute
+           without depending on specific Font Awesome class names. */
+        &__row[data-visible="true"] [data-icon-role="hidden"] {
             display: none;
         }
-        &__row[data-visible="false"] .fa-eye {
+        &__row[data-visible="false"] [data-icon-role="visible"] {
             display: none;
         }
     }

data/app/components/mensa/column_customizer/component.html.erb

@@ -4,7 +4,7 @@
      data-mensa-column-customizer-turbo-frame-id-value="<%= table.table_id %>"
      data-mensa-column-customizer-mensa-table-outlet="#table-<%= table.table_id %>">
   <button class="mensa-table__control_bar__button" type="button" data-action="click->mensa-column-customizer#toggle">
-    <i class="<%= Mensa.config.icons[:control_bar_edit] %>"></i>
+    <i class="<%= Mensa.config.icons[:column_customizer_toggle] %>"></i>
   </button>
   <div class="mensa-table__column_customizer__popover hidden" data-mensa-column-customizer-target="popover">
     <p class="mensa-table__column_customizer__heading">Columns</p>
@@ -16,13 +16,13 @@
             data-visible="<%= column.visible?.to_s %>"
             draggable="true"
             data-action="dragstart->mensa-column-customizer#dragStart dragover->mensa-column-customizer#dragOver drop->mensa-column-customizer#drop dragend->mensa-column-customizer#dragEnd">
-          <i class="mensa-table__column_customizer__handle fa-solid fa-grip-vertical"></i>
+          <i class="mensa-table__column_customizer__handle <%= Mensa.config.icons[:column_customizer_handle] %>"></i>
           <span class="mensa-table__column_customizer__name<%= !column.visible? ? " mensa-table__column_customizer__name--hidden" : "" %>">
             <%= column.human_name %>
           </span>
           <button class="mensa-table__column_customizer__visibility" type="button" data-action="click->mensa-column-customizer#toggleVisibility">
-            <i class="fa-solid fa-eye"></i>
-            <i class="fa-solid fa-eye-slash"></i>
+            <i data-icon-role="visible" class="<%= Mensa.config.icons[:column_customizer_visibility_on] %>"></i>
+            <i data-icon-role="hidden" class="<%= Mensa.config.icons[:column_customizer_visibility_off] %>"></i>
           </button>
         </li>
       <% end %>

data/app/components/mensa/column_customizer/component_controller.js

@@ -273,7 +273,7 @@ export default class ColumnCustomizerController extends ApplicationController {
         if (!urlStr) return false;
 
         try {
-            const url = new URL(urlStr);
+            const url = new URL(urlStr, window.location.origin);
 
             const toDelete = [];
             url.searchParams.forEach((_, key) => {

data/app/components/mensa/control_bar/component.css

@@ -62,19 +62,31 @@
         }
 
         &__item {
-            @apply flex shrink-0 items-center justify-between gap-3 px-3 py-2.5;
+            @apply flex shrink-0 items-center gap-3 px-3 py-2.5;
+        }
+
+        &__delete-form {
+            @apply shrink-0;
+        }
+
+        &__delete {
+            @apply inline-flex h-9 w-9 items-center justify-center rounded-md text-gray-400 dark:text-gray-500 hover:bg-gray-100 dark:hover:bg-gray-700 hover:text-red-600 dark:hover:text-red-400 focus:outline-none focus:ring-2 focus:ring-red-500/30 transition-colors cursor-pointer;
         }
 
         &__item-info {
-            @apply flex flex-col min-w-0;
+            @apply flex flex-col min-w-0 flex-1;
         }
 
         &__item-name {
             @apply text-sm font-medium text-gray-900 dark:text-gray-100 truncate;
         }
 
+        &__item-repeat {
+            @apply text-xs font-normal text-gray-500 dark:text-gray-400;
+        }
+
         &__item-meta {
-            @apply text-xs text-gray-500 dark:text-gray-400;
+            @apply text-xs font-normal text-gray-400 dark:text-gray-500;
         }
 
         &__download {
@@ -109,6 +121,14 @@
             }
         }
 
+        &__repeat-options {
+            @apply pl-6;
+        }
+
+        &__select {
+            @apply w-full rounded-md border border-gray-300 bg-white px-3 py-2 text-sm text-gray-900 shadow-sm focus:border-primary-500 focus:outline-none focus:ring-2 focus:ring-primary-500 focus:ring-opacity-20 dark:border-gray-600 dark:bg-gray-700 dark:text-gray-100;
+        }
+
         &__actions {
             @apply flex justify-end gap-2 pt-1;
         }

data/app/components/mensa/control_bar/component.html.erb

@@ -6,39 +6,40 @@
 
     <div class="mensa-table__save-reset hidden" data-mensa-table-target="saveResetButtons">
       <button class="mensa-table__control_bar__button" type="button" title="<%= t(".reset", default: "Reset") %>" data-action="mensa-table#cancelFiltersAndSearch">
-        <i class="fa-solid fa-rotate-left"></i>
+        <i class="<%= Mensa.config.icons[:control_bar_reset] %>"></i>
       </button>
       <% if table.current_user && table.supports_custom_views? %>
         <div class="relative">
           <button class="mensa-table__control_bar__button hidden" type="button" data-mensa-table-target="saveSimple" data-action="mensa-table#saveAsNewView">
-            <%= t(".save", default: "Save") %>
+            <%= t("mensa.save") %>
           </button>
           <button class="mensa-table__control_bar__button hidden" type="button" data-mensa-table-target="saveSplit" data-action="mensa-table#toggleSaveDropdown">
-            <%= t(".save", default: "Save") %>
-            <i class="fa-solid fa-chevron-down text-xs"></i>
+            <%= t("mensa.save") %>
+            <i class="<%= Mensa.config.icons[:control_bar_save_dropdown] %> text-xs"></i>
           </button>
           <ul class="mensa-table__control_bar__save-dropdown hidden" data-mensa-table-target="saveDropdown">
             <li>
               <button class="mensa-table__control_bar__save-dropdown-item" type="button" data-action="mensa-table#updateCurrentViewAction">
-                <%= t(".update_view", default: "Update view") %>
+                <%= t("mensa.update_view") %>
               </button>
             </li>
             <li>
               <button class="mensa-table__control_bar__save-dropdown-item" type="button" data-action="mensa-table#saveAsNewView">
-                <%= t(".save_as_new_view", default: "Save as new view") %>
+                <%= t("mensa.save_as_new_view") %>
               </button>
             </li>
           </ul>
         </div>
-      <% else %>
-        <button class="mensa-table__control_bar__button" type="button" data-action="mensa-table#saveAsNewView">
-          <%= t(".save", default: "Save") %>
-        </button>
       <% end %>
     </div>
 
-    <button class="mensa-table__control_bar__button hidden" type="button" data-mensa-table-target="eyeButton" data-action="click->mensa-table#toggleViewFilters">
-      <i class="fa-solid fa-eye"></i>
+    <button class="mensa-table__control_bar__button hidden"
+            type="button"
+            data-mensa-table-target="eyeButton"
+            data-action="click->mensa-table#toggleViewFilters"
+            data-icon-visible-class="<%= Mensa.config.icons[:control_bar_view_filters_show] %>"
+            data-icon-hidden-class="<%= Mensa.config.icons[:control_bar_view_filters_hide] %>">
+      <i class="<%= Mensa.config.icons[:control_bar_view_filters_show] %>"></i>
     </button>
 
     <% if table.exportable? %>

data/app/components/mensa/empty_state/component.html.erb

@@ -1,6 +1,6 @@
 <div class="mensa-empty-state">
   <div class="mensa-empty-state__icon">
-    <i class="<%= Mensa.config.icons[:search] %>"></i>
+    <i class="<%= Mensa.config.icons[:empty_state_icon] %>"></i>
   </div>
   <h3 class="mensa-empty-state__title"><%= t("mensa.empty_state.title", model: model_name_plural) %></h3>
   <p class="mensa-empty-state__subtitle"><%= t("mensa.empty_state.subtitle") %></p>

data/app/components/mensa/empty_state/component.rb

@@ -11,7 +11,7 @@ module Mensa
 
       # "orders", "users", etc. — used inside the translated heading.
       def model_name_plural
-        table.model.model_name.human.pluralize.downcase
+        table.model.model_name.human(count: 2).downcase
       end
     end
   end

data/app/components/mensa/filter_pill/component.html.erb

@@ -1,4 +1,4 @@
-<% formatted_value = filter.value.is_a?(Array) ? filter.value.join(", ") : filter.value %>
+<% formatted_value = filter.formatted_value %>
 <div class="mensa-filter-pill"
      data-controller="mensa-filter-pill"
      data-mensa-filter-pill-mensa-filter-pill-list-outlet="#mensa-filter-pill-list-<%= filter.table.table_id %>"
@@ -15,6 +15,6 @@
     <% end %>
   </button>
   <button class="mensa-filter-pill__remove" type="button" title="Remove filter" data-action="click->mensa-filter-pill#remove">
-    <i class="fa-solid fa-xmark"></i>
+    <i class="<%= Mensa.config.icons[:filter_pill_remove] %>"></i>
   </button>
 </div>

data/app/components/mensa/filter_pill_list/component.html.erb

@@ -21,10 +21,10 @@
              data-mensa-filter-pill-list-target="searchInput"
              data-action="input->mensa-filter-pill-list#monitorSearch keydown.enter->mensa-filter-pill-list#search keydown.esc->mensa-filter-pill-list#resetSearch focus->mensa-filter-pill-list#searchFocused keydown.down->mensa-filter-pill-list#navigateDown keydown.up->mensa-filter-pill-list#navigateUp"
              value="<%= params[:query] %>">
-      <i class="mensa-table__search-bar__search-icon <%= Mensa.config.icons[:search] %>"></i>
+      <i class="mensa-table__search-bar__search-icon <%= Mensa.config.icons[:filter_pill_list_search] %>"></i>
     </div>
   </div>
   <button class="mensa-table__search-bar__clear hidden" type="button" data-mensa-filter-pill-list-target="resetSearchButton" data-action="mensa-filter-pill-list#resetSearch">
-    <i class="fas fa-xmark"></i>
+    <i class="<%= Mensa.config.icons[:filter_pill_list_clear] %>"></i>
   </button>
 </div>

data/app/components/mensa/header/component.html.erb

@@ -2,7 +2,7 @@
   <% if column.sortable? %>
     <%= link_to table.path(order: {column.name => column.next_sort_direction}, turbo_frame_id: table.table_id), "data-turbo-frame": "_self", class: "order cursor-pointer" do %>
       <span><%= column.human_name %></span>
-      <i class="<%= Mensa.config.icons["order_indicator#{column.sort_direction.to_s.present? ? "_#{column.sort_direction}" : ""}".to_sym] %>"></i>
+      <i class="<%= Mensa.config.icons["header_order_indicator#{column.sort_direction.to_s.present? ? "_#{column.sort_direction}" : ""}".to_sym] %>"></i>
     <% end %>
   <% else %>
     <div class="container">

data/app/components/mensa/table/component.html.erb

@@ -1,7 +1,7 @@
 <div class="mensa-table"
      id="table-<%= table.table_id %>"
-     data-mensa-table-supports-views-value="<%= table.supports_views? %>"
-     data-mensa-table-table-url-value="<%= helpers.mensa.table_url(table.name, {turbo_frame_id: table.table_id}.merge(params)) %>"
+     data-mensa-table-supports-views-value="<%= table.views? %>"
+     data-mensa-table-table-url-value="<%= table.path(turbo_frame_id: table.table_id, user_params: params) %>"
      data-mensa-table-save-view-url-value="<%= helpers.mensa.table_views_path(table.name) %>"
      data-mensa-table-views-url-value="<%= helpers.mensa.table_views_path(table.name) %>"
      data-mensa-table-exports-url-value="<%= helpers.mensa.table_exports_path(table.name) %>"
@@ -11,8 +11,12 @@
      data-mensa-table-mensa-column-customizer-outlet="[data-controller='mensa-column-customizer']">
   <div class="mensa-table__toolbar">
     <div class="mensa-table__search-container">
-      <% if table.supports_views? && table.show_header? %>
-        <%= render Mensa::Views::Component.new(table: table) %>
+      <% if table.show_header? %>
+        <% if table.views? %>
+          <%= render Mensa::Views::Component.new(table: table) %>
+        <% else %>
+          <div id="mensa-views-<%= table.table_id %>"></div>
+        <% end %>
       <% end %>
       <div class="flex min-w-0 flex-1" id="filters-<%= table.table_id %>">
         <%= render Mensa::FilterPillList::Component.new(table: table) %>

data/app/components/mensa/table/component.rb

@@ -8,11 +8,11 @@ module Mensa
       attr_reader :table
       attr_reader :params
 
-      def initialize(table_name, config = {}, **options)
-        @table = Mensa.for_name(table_name, config)
+      def initialize(table_name, params: {}, **options)
+        @params = params
+        @table = Mensa.for_name(table_name, {params: params})
         @table.original_view_context = options[:original_view_context]
         @table.component = self
-        @params = options[:params] || {}
       end
     end
   end