thecore_ui_rails_admin 3.2.21 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 000e21e8625708a2a3388beba93fa1098a5f9132ba4a9a8374962fcce04d4e46
-  data.tar.gz: 6dc92dfbed4caeb738487417cc8e6da5d2965c87438cc42924df9097272abc5f
+  metadata.gz: 69880a90a1c29f74d6118b9bd97e6a60bb323bdc98f3a32332f0bdba3771f0ed
+  data.tar.gz: 6fde8617dea6926e4bb3c30f1df5c2d7ef814d480310087835f40850c664afa4
 SHA512:
-  metadata.gz: bc1f49c633b05d6128906678f131e50ff3d73d2202705939c0d27bca703378ff1c3869b9c0283cff1424c01f0ef86bbdb6d97639452dc62d326070d52abf72af
-  data.tar.gz: 4379688d578f856fa3bb7fdb8c84f9decfb6649a551decfedb638d51188e80a40cc4f6595a39693ea63f9ffcac0f4518916768f269106cd7088bdc39e2a132c9
+  metadata.gz: 6f173668754ad018a7c267d35f630cd29cfb23eae696f267f8aba3203890123012637a2013a29b158ff6717d2614f45ad5eaea6c3ab8bee4cd27cbd98e036b7f
+  data.tar.gz: 256a28d9e7a4cd7e89b7a14280529cedd1e2db417f4f737c6e580d5657933afbf5e341d43ffb69f4466abbaa466cb18544f452c404a3ed3ca2e6159b7bb89fa6

data/app/assets/javascripts/rails_admin/custom/ui.js.erb

@@ -28,6 +28,16 @@ $(document).on('turbo:load', function (event) {
     // Add the app_logo before the Title
     const customer_logo_path = "<%= asset_path('app_logo.svg') %>";
     $(".navbar-brand").prepend(`<img class="navbar-brand-logo" alt="Customer Logo" src="${customer_logo_path}"/>`);
+
+    //This presumes the existence of the save_filter collection custom action for rails_admin
+    const saveFilterLinks = document.querySelectorAll("li.nav-item.icon.save_filters_collection_link > a")
+    saveFilterLinks.forEach(link => {
+    const currentQuery = window.location.search;
+        if (currentQuery) {
+            // Remove the existing query string from the link
+            link.href = link.href.split('?')[0] + currentQuery;
+        }
+    });
 });
 
 const sidepanel = "body > div.container-fluid > div > div.col-sm-3.col-md-2.flex-wrap.p-0"

data/app/models/saved_filter.rb

@@ -0,0 +1,11 @@
+# app/models/saved_filter.rb
+class SavedFilter < ApplicationRecord
+  belongs_to :admin_user, optional:true, class_name: 'User', foreign_key: :admin_user_id
+
+  validates :model_name, :name, :query_string, presence: true
+
+  rails_admin do
+    # Set invisible
+    visible false
+  end
+end

data/app/views/rails_admin/main/load_filters.html.erb

@@ -0,0 +1,22 @@
+<!-- START app/views/rails_admin/main/save_filter.html.erb -->
+<!-- In Rails Admin Bootstrap, show all the filters which are listed in @saved_filters -->
+
+<div class="row">
+  <div class="col-sm-12">
+    <h3>Saved Filters</h3>
+    <ul class="list-group">
+      <% @saved_filters.each do |filter| %>
+        <li class="list-group-item">
+          <%= filter.name %>
+          <a href="<%= index_path(model_name: filter.abstract_model_name.underscore) %>?<%= filter.query_string %>" class="float-right">
+            <i class="fas fa-filter"></i> 
+          </a>
+          <a href="<%= load_filters_path %>?id_to_delete=<%= filter.id %>" class="float-right" data-method="delete" data-confirm="Are you sure?">
+            <i class="fas fa-trash"></i>
+          </a>
+        </li>
+      <% end %>
+    </ul>
+  </div>
+</div>
+<!-- END app/views/rails_admin/main/save_filter.html.erb -->

data/app/views/rails_admin/main/save_filter.html.erb

@@ -0,0 +1,36 @@
+<!-- START app/views/rails_admin/main/save_filter.html.erb -->
+<div class="form-horizontal">
+  <form method="post" action="">
+    <%= hidden_field_tag :authenticity_token, form_authenticity_token %>
+    <%= hidden_field_tag :query_string, @query_string %>
+
+    <% if @query_string.present? %>
+    <div class="form-group row">
+      <label class="col-sm-2 col-form-label" for="filter_name">Filter Name</label>
+      <div class="col-sm-10">
+        <input type="text" name="filter_name" id="filter_name" class="form-control" required />
+      </div>
+    </div>
+    <% end %>
+
+    <!-- A row to show an urldecoded version of the filter in @query_string -->
+    <div class="form-group row">
+      <label class="col-sm-2 col-form-label" for="filter_query">Filter Query</label>
+      <div class="col-sm-10">
+        <%= @query_html %>
+      </div>
+    </div>
+
+    <!-- Allow this button only if @query_string is not empty -->
+    <% if @query_string.present? %>
+    <div class="form-group row">
+      <div class="col-sm-10 offset-sm-2">
+        <button type="submit" class="btn btn-primary">
+          <i class="fas fa-save"></i> Save Filter
+        </button>
+      </div>
+    </div>
+    <% end %>
+  </form>
+</div>
+<!-- END app/views/rails_admin/main/save_filter.html.erb -->

data/config/initializers/after_initialize.rb

@@ -47,5 +47,7 @@ Rails.application.configure do
 
         require 'root_actions/active_job_monitor'
         require 'member_actions/change_password'
+        require 'collection_actions/save_filters'
+        require 'collection_actions/load_filters'
     end
 end

data/config/initializers/concern_user.rb

@@ -5,6 +5,7 @@ module ThecoreUiRailsAdminUserConcern
     extend ActiveSupport::Concern
     
     included do
+        has_many :saved_filters, class_name: 'SavedFilter', foreign_key: :admin_user_id, dependent: :destroy
 
         # def admin_enum
         #     [["✔",true],['✘',false]]

data/config/locales/en.rails_admin.yml

@@ -15,5 +15,17 @@ en:
         menu: Change Password
         success: Your password has been changed successfully
         error: Error! %{errors}
+      save_filters:
+        success: Filters saved successfully
+        error: Error saving filters
+        title: Save Filters
+        breadcrumb: Save Filters
+        menu: Save Filters
+      load_filters:
+        success: Filters loaded successfully
+        error: Error loading filters
+        title: Load Filters
+        breadcrumb: Load Filters
+        menu: Load Filters
     scopes:
       _all: All

data/config/locales/it.rails_admin.yml

@@ -15,5 +15,17 @@ it:
         menu: Cambia Password
         success: La tua password è stata cambiata con successo
         error: Attenzione! %{errors}
+      save_filters:
+        success: Filtri salvati con successo
+        error: Errore durante il salvataggio dei filtri
+        title: Salva Filtri
+        breadcrumb: Salva Filtri
+        menu: Salva Filtri
+      load_filters:
+        success: Filtri caricati con successo
+        error: Errore durante il caricamento dei filtri
+        title: Carica Filtri
+        breadcrumb: Carica Filtri
+        menu: Carica Filtri
     scopes:
       _all: Tutti

data/db/migrate/20250429155934_create_saved_filters.rb

@@ -0,0 +1,13 @@
+# db/migrate/xxxx_create_saved_filters.rb
+class CreateSavedFilters < ActiveRecord::Migration[7.0]
+  def change
+    create_table :saved_filters do |t|
+      t.string :model_name
+      t.string :name
+      t.text :query_string
+      t.references :admin_user, foreign_key: { to_table: :users }, null: true
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20250430081805_rename_model_name_to_abstract_model_name_in_saved_filter.rb

@@ -0,0 +1,13 @@
+class RenameModelNameToAbstractModelNameInSavedFilter < ActiveRecord::Migration[7.2]
+  def change
+    rename_column :saved_filters, :model_name, :abstract_model_name
+    # ThecoreUiRailsAdmin::SavedFilter.reset_column_information
+    # ThecoreUiRailsAdmin::SavedFilter.all.each do |saved_filter|
+    #   saved_filter.update_column(:abstract_model_name, saved_filter.model_name)
+    # end
+  rescue ActiveRecord::StatementInvalid => e
+    puts "Error: #{e.message}"
+  ensure
+    # ThecoreUiRailsAdmin::SavedFilter.reset_column_information
+  end
+end

data/lib/collection_actions/load_filters.rb

@@ -0,0 +1,29 @@
+require 'uri'
+
+RailsAdmin::Config::Actions.add_action "load_filters", :base, :collection do
+    link_icon 'fas fa-upload'
+    
+    http_methods [:get, :delete]
+
+    # Visible only for the User model
+    visible do
+        authorized?
+    end
+    # Adding the controller which is needed to compute calls from the ui
+    controller do
+        proc do # This is needed because we need that this code is re-evaluated each time is called
+            # Load all the filters which have the current abstract_model_name
+            if params[:id_to_delete]
+                # Delete the filter
+                @saved_filter = SavedFilter.find(params[:id_to_delete])
+                @saved_filter.destroy
+                flash[:success] = "Filter deleted!"
+                # redirect_to back_or_index
+            end
+            # Load the filter
+            Rails.logger.debug "Loading filters for model: #{params[:model_name]}"
+            @saved_filters = SavedFilter.where(abstract_model_name: params[:model_name].classify)
+            Rails.logger.debug "Saved filters: #{@saved_filters.inspect}"
+        end
+    end
+end

data/lib/collection_actions/save_filters.rb

@@ -0,0 +1,31 @@
+require 'uri'
+
+RailsAdmin::Config::Actions.add_action "save_filters", :base, :collection do
+    link_icon 'fas fa-floppy-disk'
+    
+    http_methods [:get, :post]
+
+    # Visible only for the User model
+    visible do
+        authorized?
+    end
+    # Adding the controller which is needed to compute calls from the ui
+    controller do
+        proc do # This is needed because we need that this code is re-evaluated each time is called
+            if request.post?
+                SavedFilter.create!(
+                    abstract_model_name: @abstract_model,
+                    name: params[:filter_name],
+                    query_string: request.referer.split('?')[1] # Get filters from referrer
+                )
+                flash[:success] = "Filter saved!"
+                redirect_to back_or_index
+            else
+                @query_string = request.referer.split('?')[1] # Get filters from referrer
+                @query_html = RailsAdminFilterControllerHelper.filters_html_list(@query_string, @abstract_model).html_safe
+                @model_name = @abstract_model
+                render :save_filter
+            end
+        end
+    end
+end

data/lib/rails_admin_filter_controller_helper.rb

@@ -0,0 +1,52 @@
+# app/helpers/rails_admin_filter_helper.rb
+module RailsAdminFilterControllerHelper
+  def self.filters_html_list(query_string, model_name)
+    params = Rack::Utils.parse_nested_query(query_string)
+    return '<p>No filters to be saved</p>'.html_safe unless params['f'].is_a?(Hash)
+
+    model_class = model_name.to_s.camelize.safe_constantize
+    return '<p>Unknown model</p>'.html_safe unless model_class
+
+    abstract_model = RailsAdmin::AbstractModel.new(model_class)
+
+    filters = []
+
+    params['f'].each do |field_name, condition_group|
+      # Use Rails i18n to get field label
+      label = model_class.human_attribute_name(field_name)
+
+      condition_group.each do |_idx, condition|
+        op_key = condition['o']
+        value = condition['v']
+
+        next if op_key.blank? || value.blank?
+
+        op_label = rails_admin_operator_label(op_key, abstract_model.properties.find { |p| p.name.to_s == field_name.to_s })
+
+        value_str = case value
+        when Array
+          value.join(', ')
+        when 'true'
+          'Yes'
+        when 'false'
+          'No'
+        else
+          value.to_s
+        end
+
+        filters << "#{label} #{op_label} #{value_str}"
+      end
+    end
+
+    filters.join('<br>').html_safe
+  end
+
+  def self.rails_admin_operator_label(op_key, field = nil)
+    scope = [:admin, :filters, :operators]
+    type = field&.type&.to_sym
+    key = "#{op_key}_#{type}".to_sym
+
+    # Try field-specific operator label, then general one
+    I18n.t(key, scope: scope, default: I18n.t(op_key.to_sym, scope: scope, default: op_key.humanize))
+  end
+end

data/lib/thecore_ui_rails_admin/version.rb

@@ -1,3 +1,3 @@
 module ThecoreUiRailsAdmin
-  VERSION = "3.2.21".freeze
+  VERSION = "3.3.0".freeze
 end

data/lib/thecore_ui_rails_admin.rb

@@ -4,6 +4,8 @@ require "rails_admin-i18n"
 
 require "thecore_ui_rails_admin/engine"
 
+require "rails_admin_filter_controller_helper"
+
 module ThecoreUiRailsAdmin
   # Your code goes here...
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: thecore_ui_rails_admin
 version: !ruby/object:Gem::Version
-  version: 3.2.21
+  version: 3.3.0
 platform: ruby
 authors:
 - Gabriele Tassoni
 bindir: bin
 cert_chain: []
-date: 2025-03-24 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thecore_ui_commons
@@ -77,6 +77,7 @@ files:
 - app/assets/stylesheets/rails_admin/custom/thecore/variables.scss
 - app/assets/stylesheets/rails_admin/custom/theming.scss
 - app/assets/stylesheets/rails_admin/custom/variables.scss
+- app/models/saved_filter.rb
 - app/views/layouts/rails_admin/_controller_assets.html.erb
 - app/views/layouts/rails_admin/application.html.erb
 - app/views/rails_admin/main/_dashboard_block.html.erb
@@ -84,6 +85,8 @@ files:
 - app/views/rails_admin/main/active_job_monitor.html.erb
 - app/views/rails_admin/main/change_password.html.erb
 - app/views/rails_admin/main/dashboard.html.erb
+- app/views/rails_admin/main/load_filters.html.erb
+- app/views/rails_admin/main/save_filter.html.erb
 - config/initializers/abilities.rb
 - config/initializers/add_to_db_migrations.rb
 - config/initializers/after_initialize.rb
@@ -108,9 +111,14 @@ files:
 - config/locales/it.rollincode.yml
 - config/routes.rb
 - db/migrate/20250206222412_add_locale_to_user.rb
+- db/migrate/20250429155934_create_saved_filters.rb
+- db/migrate/20250430081805_rename_model_name_to_abstract_model_name_in_saved_filter.rb
 - db/seeds.rb
+- lib/collection_actions/load_filters.rb
+- lib/collection_actions/save_filters.rb
 - lib/member_actions/change_password.rb
 - lib/rails_admin_abstract_controller.rb
+- lib/rails_admin_filter_controller_helper.rb
 - lib/root_actions/active_job_monitor.rb
 - lib/tasks/thecore_ui_rails_admin_tasks.rake
 - lib/thecore_ui_rails_admin.rb
@@ -137,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Thecore Backend UI based on Rails Admin.
 test_files: []