thecore_ui_rails_admin 3.4.2 → 3.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f2dbc04f7d702990f70e5e1283ae6ee123d230309a4f11e1eb4a9301ac42b3e
-  data.tar.gz: 389eeb46854cb9d4d1d238631690a750975f1b11868540ebbe56fc4565749d70
+  metadata.gz: 4a25dd232dbfdfb24580adcb9171ea51ce2057cec2a4c8c1c688c517ffbc38ec
+  data.tar.gz: 8155fdf0de1aa96c27a859f6d4a8402d6bb1dc57a525996eb1510118677a1c96
 SHA512:
-  metadata.gz: ef1fc5f9181a819872bbcf97f9592911ef8643339371c6df063cf0b101b97f9daef5b6f52289c1f927c3b6a4bc5063c363181934cd0214ddb2c216e2002c1547
-  data.tar.gz: 0170a75ca864b1f7bb938128c32bdde3356f0a0625517e4431caa32dbf995e504aff2c8c146329be8a9bcdb56c9d68e03465e0372a7e8c4639d3ac10ba3ebaf6
+  metadata.gz: 674e7d39dc22303c919e82e9f0abd7139c043ef169769b21ee6d20b8a4c6ba47e9c29b6de5670e324be1f150760056ed1c0afba113ebc08d99ea5d9c2e487a88
+  data.tar.gz: 9bfbf1f7ec2a9baeddafe77f03d710d070275eed49859a7f407c6d76c51727154d5c41649e403c551aef5aa9d8403f975a89d0b5f2e9786f65ae9ce4ebdeede3

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

@@ -1,7 +1,6 @@
 //= require 'thecore_ui_commons'
 //= require 'rails_admin/custom/thecore/ui'
 //= require 'channels/index'
-
 const adjustIframe = function (obj) {
     console.log("Resizing");
     obj.style.height = obj.contentWindow.document.body.scrollHeight + 'px';
@@ -19,12 +18,22 @@ $(document).on('turbo:load', function (event) {
     console.log(" - Hostname:", currentURL.hostname);
     console.log(" - Port:", currentURL.port);
     console.log(" - Pathname:", currentURL.pathname);
+    // Get the current user ID from a meta tag
+    document.currentUserId = document.querySelector('meta[name="current-user-id"]').getAttribute('content');
+    // Get the current url pathname, is the first string between app/ and the first / encountered, i.e. /app/location/bulk/action, in this case is location
+    document.currentModelName = currentURL.pathname.split('/')[2];
+    console.log(" - Controller:", document.currentModelName);
     console.log(" - Search:", currentURL.search);
     currentURL.searchParams.forEach((v, k) => {
         console.log(`  - ${k}: ${v}`);
     })
     console.log(" - Hash:", currentURL.hash);
 
+
+    // Remove any existing logo to avoid duplicates
+    $(".navbar-brand-logo").remove();
+    // Prepend the custom logo to the navbar
+
     // 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}"/>`);
@@ -38,6 +47,109 @@ $(document).on('turbo:load', function (event) {
             link.href = link.href.split('?')[0] + currentQuery;
         }
     });
+
+    // If URL ends with /bulk_action, uncheck all checkboxes
+    if (currentURL.pathname.endsWith('/bulk_action')) {
+        const checkboxes = document.querySelectorAll('input[type="checkbox"][name^="schema"]');
+        checkboxes.forEach(checkbox => {
+            checkbox.checked = false;
+        });
+        // Also uncheck the main checkbox if it exists
+        const mainCheckbox = document.querySelector('input[type="checkbox"][name="all"]');
+        if (mainCheckbox) {
+            mainCheckbox.checked = false;
+        }
+
+        // Use the fetch to get all the already saved checkboxes:
+        fetch('/app/general_computation?' + new URLSearchParams({
+                verb: "load",
+                model: "UserPreference",
+                "finders[user_id]": document.currentUserId,
+                "finders[name]": `export_${document.currentModelName}`
+            }), {
+            headers: {
+                'Content-Type': 'application/json',
+                'Accept': 'application/json',
+                'X-CSRF-Token': document.querySelector('meta[name="csrf-token"]').getAttribute('content')
+            }
+        })
+        .then(response => {
+            if (response.ok) {
+                return response.json()
+                // The value field in the response bears the ids of the input checkbox type to set at checked true
+            } else {
+                return {
+                    message: {
+                        value: []
+                    }
+                }
+            }
+        })
+        .then(message => {
+            message.message.value.forEach(id => {
+                const selectedCheckbox = document.querySelector(`#${id}`);
+                if (selectedCheckbox) {
+                    selectedCheckbox.checked = true;
+                }
+            })
+        })
+
+        // Add to the fieldset with id fields_to_export a button with class btn btn-info which, if clicked, gets the checked status of all checkboxes with name starting with schema and using the current session login, saves them to the ruby on rails controller User in order to be saved to the settings json field.
+        const fieldset = document.getElementById('fields_to_export');
+        if (fieldset) {
+            const saveButton = document.createElement('button');
+            saveButton.type = 'button';
+            saveButton.className = 'btn btn-info';
+            saveButton.textContent = 'Save Selected Fields as Default';
+            saveButton.style.marginLeft = '10px';
+            saveButton.onclick = function () {
+                const selectedFields = [];
+                const checkboxes = document.querySelectorAll('input[type="checkbox"][name^="schema"]');
+                checkboxes.forEach(checkbox => {
+                    if (checkbox.checked) {
+                        selectedFields.push(checkbox.id);
+                    }
+                });
+                // Send the selected fields to the server using fetch API, emulating a POST request to /app/user of type form json
+                fetch('/app/general_computation', {
+                    method: 'POST',
+                    headers: {
+                        'Content-Type': 'application/json',
+                        'Accept': 'application/json',
+                        'X-CSRF-Token': document.querySelector('meta[name="csrf-token"]').getAttribute('content')
+                    },
+                    // The body will have the current_user id, a name which is created by concattenating export and the current model name, and the selected fields as an array
+                    body: JSON.stringify({
+                        verb: "upsert",
+                        model: "UserPreference",
+                        finders: {
+                            user_id: document.currentUserId,
+                            name: `export_${document.currentModelName}` 
+                        },
+                        fields: {
+                            value: selectedFields
+                        }
+                    })
+                })
+                .then(response => {
+                    if (response.ok) {
+                        alert('Default export fields saved successfully.');
+                    } else {
+                        alert('Error saving default export fields.');
+                    }
+                })
+                .catch(error => {
+                    console.error('Error:', error);
+                    alert('Error saving default export fields.');
+                });
+            };
+            // add the button to a div with row class, then att the div to the fieldset
+            const buttonRow = document.createElement('div');
+            buttonRow.className = 'row mt-3';
+            buttonRow.appendChild(saveButton);
+            fieldset.append(buttonRow);
+        }
+    }
 });
 
 const sidepanel = "body > div.container-fluid > div > div.col-sm-3.col-md-2.flex-wrap.p-0"

data/app/assets/stylesheets/rails_admin/custom/theming.scss

@@ -72,4 +72,10 @@ body > div.container-fluid > div > div.col-sm-9.col-sm-offset-3.col-md-10.col-md
     height: 1.7em;
 }
 
+// Hide and remove export for found objects, is safer to have the possibility to export only selected rows to avoid big CPU usage.
+.export_collection_link,
+#list form div div.row div.col-sm-6:nth-child(2) {
+    display: none;
+}
+
 @import 'rails_admin/custom/thecore/theming';

data/app/models/concerns/api/user_preference.rb

@@ -0,0 +1,19 @@
+module Api::UserPreference
+  extend ActiveSupport::Concern
+
+  included do
+    # Use self.json_attrs to drive json rendering for 
+    # API model responses (index, show and update ones).
+    # For reference:
+    # https://api.rubyonrails.org/classes/ActiveModel/Serializers/JSON.html
+    # The object passed accepts only these keys:
+    # - only: list [] of model fields to be shown in JSON serialization
+    # - except: exclude these fields from the JSON serialization, is a list []
+    # - methods: include the result of some method defined in the model
+    # - include: include associated models, it's an object {} which also accepts the keys described here
+    cattr_accessor :json_attrs
+    self.json_attrs = ::ModelDrivenApi.smart_merge (json_attrs || {}), {}
+
+    # Custom action callable by the API must be defined in /app/models/concerns/endpoints/
+  end
+end

data/app/models/concerns/endpoints/user_preference.rb

@@ -0,0 +1,78 @@
+class Endpoints::UserPreference < NonCrudEndpoints
+  # self.desc 'UserPreference', :test, {
+  #   # Define the action name using openapi swagger format
+  #   get: {
+  #     summary: "Test API Custom Action",
+  #     description: "This is a test API custom action",
+  #     operationId: "test",
+  #     tags: ["Test"],
+  #     parameters: [
+  #       {
+  #         name: "explain",
+  #         in: "query",
+  #         description: "Explain the action by returning this openapi schema",
+  #         required: true,
+  #         schema: {
+  #           type: "boolean"
+  #         }
+  #       }
+  #     ],
+  #     responses: {
+  #       200 => {
+  #         description: "The openAPI json schema for this action",
+  #         content: {
+  #           "application/json": {
+  #             schema: {
+  #               type: "object",
+  #               additionalProperties: true
+  #             }
+  #           }
+  #         }
+  #       },
+  #       501 => {
+  #         error: :string,
+  #       }
+  #     }
+  #   },
+  #   post: {
+  #     summary: "Test API Custom Action",
+  #     description: "This is a test API custom action",
+  #     operationId: "test",
+  #     tags: ["Test"],
+  #     requestBody: {
+  #       required: true,
+  #       content: {
+  #         "application/json": {}
+  #       }
+  #     },
+  #     responses: {
+  #       200 => {
+  #         description: "The openAPI json schema for this action",
+  #         # This will return the object with a message string and a params object
+  #         content: {
+  #           "application/json": {
+  #             schema: {
+  #               type: "object",
+  #               properties: {
+  #                 message: {
+  #                   type: "string"
+  #                 },
+  #                 params: {
+  #                   type: "object",
+  #                   additionalProperties: true
+  #                 }
+  #               }
+  #             }
+  #           }
+  #         }
+  #       },
+  #       501 => {
+  #         error: :string,
+  #       }
+  #     }
+  #   }
+  # }
+  # def test(params)
+  #   return { message: "Hello World From Test API Custom Action called test", params: params }, 200
+  # end
+end

data/app/models/concerns/rails_admin/user_preference.rb

@@ -0,0 +1,11 @@
+module RailsAdmin::UserPreference
+  extend ActiveSupport::Concern
+
+  included do
+    rails_admin do
+      navigation_label I18n.t('admin.registries.label')
+      navigation_icon 'fa fa-file'
+      visible false
+    end
+  end
+end

data/app/models/user_preference.rb

@@ -0,0 +1,7 @@
+class UserPreference < ApplicationRecord
+  include Api::UserPreference
+  include RailsAdmin::UserPreference
+  belongs_to :user, inverse_of: :user_preferences
+  validates :name, presence: true, uniqueness: { scope: :user_id }
+  validates :value, presence: true
+end

data/app/views/layouts/rails_admin/application.html.erb

@@ -4,6 +4,14 @@
   <head>
     <%= render "layouts/rails_admin/head" %>
     <%= render "layouts/rails_admin/controller_assets" %>
+
+    <!-- meta tags to get current user id and current model name which in rails_admin is not controller_name, since it's always main, but the abstract model one for use in custom javascript -->
+    <meta name="current-user-id" content="<%= current_user.id %>">
+    <%
+=begin%>
+ <meta name="current-model-name" content="<%= @abstract_model.param_key %>"> 
+<%
+=end%>
   </head>
   <body class="rails_admin">
     <div data-i18n-options="<%= I18n.t("admin.js").to_json %>" id="admin-js"></div>

data/config/initializers/after_initialize.rb

@@ -45,6 +45,7 @@ Rails.application.configure do
         Target.send :include, ThecoreUiRailsAdminTargetConcern
         ThecoreSettings::Setting.send :include, ThecoreUiRailsAdminSettingsConcern
 
+        require 'root_actions/general_computation'
         require 'root_actions/active_job_monitor'
         require 'member_actions/change_password'
         require 'member_actions/test_ldap_server'

data/config/initializers/assets.rb

@@ -1,3 +1,5 @@
 Rails.application.config.assets.precompile += %w(
     channels/index.js
 )
+
+Rails.application.config.assets.precompile += %w( rails_admin/actions/general_computation.js rails_admin/actions/general_computation.css )

data/config/initializers/concern_export.rb

@@ -13,5 +13,8 @@ module ExportConcern
       # In index, instead, I show it only if there are records in the current view
       bindings[:controller].action_name == "index" ? (authorized? && !bindings[:controller].instance_variable_get("@objects").blank?) : true
     end
+    register_instance_option :bulkable? do
+      true
+    end
   end
 end

data/config/initializers/concern_user.rb

@@ -1,86 +1,91 @@
 puts "User Concern from ThecoreUiRailsAdmin"
-require 'active_support/concern'
+require "active_support/concern"
 
 module ThecoreUiRailsAdminUserConcern
-    extend ActiveSupport::Concern
-    
-    included do
-        has_many :saved_filters, class_name: 'SavedFilter', foreign_key: :admin_user_id, dependent: :destroy
+  extend ActiveSupport::Concern
 
-        # def admin_enum
-        #     [["✔",true],['✘',false]]
-        # end
+  included do
+    has_many :saved_filters, class_name: "SavedFilter", foreign_key: :admin_user_id, dependent: :destroy
+    has_many :user_preferences, class_name: "UserPreference", foreign_key: :user_id, dependent: :destroy, inverse_of: :user
+    accepts_nested_attributes_for :user_preferences, allow_destroy: true
 
-        # def locked_enum
-        #     [["✔",true],['✘',false]]
-        # end
-        # 
-        
-        # locale field is a string which can be chosen from the list of available locales: it and en
-        # The default locale is the one set in the I18n.default_locale
-        # The locale is used to set the language of the user
-        def locale_enum
-            [['Italiano', 'it'], ['English', 'en']]
-        end
-        
-        rails_admin do
-            navigation_label Proc.new { I18n.t("admin.settings.label") }
-            navigation_icon 'fa fa-user-circle'
-            parent Role
-            # desc Proc.new { I18n.t("activerecord.descriptions.user") }
-            
-            # Hide fields: :id, :remember_created_at, :sign_in_count, :current_sign_in_at, :last_sign_in_at, :current_sign_in_ip, :last_sign_in_ip, :lock_version, :role_users
-            configure :id do
-                hide
-            end
-            configure :remember_created_at do
-                hide
-            end
-            configure :sign_in_count do
-                hide
-            end
-            configure :current_sign_in_at do
-                hide
-            end
-            configure :last_sign_in_at do
-                hide
-            end
-            configure :current_sign_in_ip do
-                hide
-            end
-            configure :last_sign_in_ip do
-                hide
-            end
-            configure :lock_version do
-                hide
-            end
-            configure :role_users do
-                hide
-            end
-            configure :saved_filters do
-              hide
-            end
-            configure :auth_source do
-              read_only true
-            end
+    # def admin_enum
+    #     [["✔",true],['✘',false]]
+    # end
+
+    # def locked_enum
+    #     [["✔",true],['✘',false]]
+    # end
+    #
+
+    # locale field is a string which can be chosen from the list of available locales: it and en
+    # The default locale is the one set in the I18n.default_locale
+    # The locale is used to set the language of the user
+    def locale_enum
+      [["Italiano", "it"], ["English", "en"]]
+    end
+
+    rails_admin do
+      navigation_label Proc.new { I18n.t("admin.settings.label") }
+      navigation_icon "fa fa-user-circle"
+      parent Role
+      # desc Proc.new { I18n.t("activerecord.descriptions.user") }
 
-            update do
-                configure :password do
-                    hide
-                end
-                configure :password_confirmation do
-                    hide
-                end
-            end
+      # Hide fields: :id, :remember_created_at, :sign_in_count, :current_sign_in_at, :last_sign_in_at, :current_sign_in_ip, :last_sign_in_ip, :lock_version, :role_users
+      configure :id do
+        hide
+      end
+      configure :remember_created_at do
+        hide
+      end
+      configure :sign_in_count do
+        hide
+      end
+      configure :current_sign_in_at do
+        hide
+      end
+      configure :last_sign_in_at do
+        hide
+      end
+      configure :current_sign_in_ip do
+        hide
+      end
+      configure :last_sign_in_ip do
+        hide
+      end
+      configure :lock_version do
+        hide
+      end
+      configure :role_users do
+        hide
+      end
+      configure :saved_filters do
+        hide
+      end
+      configure :user_preferences do
+        hide
+      end
+      configure :auth_source do
+        read_only true
+      end
 
-            create do
-                configure :password do
-                    required true
-                end
-                configure :password_confirmation do
-                    required true
-                end
-            end
+      update do
+        configure :password do
+          hide
+        end
+        configure :password_confirmation do
+          hide
+        end
+      end
+
+      create do
+        configure :password do
+          required true
+        end
+        configure :password_confirmation do
+          required true
         end
+      end
     end
-end
+  end
+end

data/db/migrate/20250916092441_create_user_preferences.rb

@@ -0,0 +1,12 @@
+class CreateUserPreferences < ActiveRecord::Migration[7.2]
+  def change
+    create_table :user_preferences do |t|
+      t.references :user, null: false, foreign_key: true
+      t.string :name
+      t.jsonb :value
+
+      t.timestamps
+    end
+    add_index :user_preferences, :name
+  end
+end

data/lib/root_actions/general_computation.rb

@@ -0,0 +1,59 @@
+RailsAdmin::Config::Actions.add_action "general_computation", :base, :root do
+    show_in_sidebar false
+    show_in_navigation false
+    breadcrumb_parent [nil]
+    # This ensures the action only shows up for Users
+    # visible? authorized?
+    # Not a member action
+    member false
+    # Not a colleciton action
+    collection false
+    # Have a look at https://fontawesome.com/v5/search for available icons
+    link_icon 'fas fa-file'
+    # The controller which will be used to compute the action and the REST verbs it will respond to
+    http_methods [:get, :post, :put, :patch, :delete]
+    # 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.format.json?
+                # PArams sent by the new call are:
+                # {
+                #     action: "upsert",
+                #     model: "UserPreference",
+                #     finders: {
+                #         user_id: currentUserId,
+                #         name: `export_${currentModelName}` 
+                #     },
+                #     fields: {
+                #         value: selectedFields
+                #     }
+                # }
+                # 
+                case params[:verb]
+                when "upsert"
+                    params.permit!
+                    result = params[:model].camelize.constantize.where(params[:finders]).first_or_initialize.update(params[:fields])
+                    if result
+                        status = 200
+                        message = "User preference saved"
+                    else
+                        status = 422
+                        message = "Error saving user preference: #{result.errors.full_messages.join(", ")}"
+                    end
+                when "load"
+                    params.permit!
+                    result = params[:model].camelize.constantize.where(params[:finders]).first
+                    message = result
+                    status = result.nil? ? 404 : 200
+                end
+
+                # This is the code that is executed when the action is called
+                # It is executed in the context of the controller
+                # So you can access all the controller methods
+                # and instance variables
+                ActionCable.server.broadcast("messages", { topic: :general_computation, status: status, message: message})
+                render json: {message: message.presence || "No message"}.to_json, status: status.presence || 200
+            end
+        end
+    end
+end

data/lib/thecore_ui_rails_admin/version.rb

@@ -1,3 +1,3 @@
 module ThecoreUiRailsAdmin
-  VERSION = "3.4.2".freeze
+  VERSION = "3.5.1".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: thecore_ui_rails_admin
 version: !ruby/object:Gem::Version
-  version: 3.4.2
+  version: 3.5.1
 platform: ruby
 authors:
 - Gabriele Tassoni
@@ -77,7 +77,11 @@ 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/concerns/api/user_preference.rb
+- app/models/concerns/endpoints/user_preference.rb
+- app/models/concerns/rails_admin/user_preference.rb
 - app/models/saved_filter.rb
+- app/models/user_preference.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
@@ -85,6 +89,7 @@ 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/general_computation.html.erb
 - app/views/rails_admin/main/import_users_from_ldap.html.erb
 - app/views/rails_admin/main/load_filters.html.erb
 - app/views/rails_admin/main/save_filter.html.erb
@@ -111,6 +116,7 @@ files:
 - 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/migrate/20250916092441_create_user_preferences.rb
 - db/seeds.rb
 - lib/collection_actions/load_filters.rb
 - lib/collection_actions/save_filters.rb
@@ -120,6 +126,7 @@ files:
 - lib/rails_admin_abstract_controller.rb
 - lib/rails_admin_filter_controller_helper.rb
 - lib/root_actions/active_job_monitor.rb
+- lib/root_actions/general_computation.rb
 - lib/tasks/thecore_ui_rails_admin_tasks.rake
 - lib/thecore_ui_rails_admin.rb
 - lib/thecore_ui_rails_admin/engine.rb
@@ -145,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Thecore Backend UI based on Rails Admin.
 test_files: []