rails_admin 3.1.1 → 3.3.1

data/lib/rails_admin/support/serialization_schema.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'rails_admin/support/hash_helper'
+
+module RailsAdmin
+  # The options passed to to_json/to_xml, limited to what a section exposes.
+  # It mirrors what the export form offers, as the form is what builds them.
+  class SerializationSchema
+    def initialize(section, include_associations:)
+      @section = section
+      @include_associations = include_associations
+    end
+
+    def default
+      sanitize(allowed)
+    end
+
+    # Anything not allowed is dropped, and `only` is always set, since leaving
+    # it out makes to_json/to_xml serialize every attribute.
+    def sanitize(requested)
+      requested = HashHelper.symbolize(requested)
+      schema = filter(requested, allowed)
+      if @include_associations && requested[:include].is_a?(Hash)
+        schema[:include] = requested[:include].each_with_object({}) do |(name, value), included|
+          next unless value.is_a?(Hash) && allowed[:include].key?(name)
+
+          included[name] = filter(value, allowed[:include][name])
+        end
+      end
+      schema
+    end
+
+  private
+
+    def allowed
+      @allowed ||= begin
+        fields = @section.visible_fields
+        names = field_names(fields.select { |f| !f.association? || f.association.polymorphic? })
+        if @include_associations
+          names[:include] = fields.select { |f| f.association? && !f.association.polymorphic? }.to_h do |field|
+            associated = field.associated_model_config.export.with(@section.bindings.merge(object: field.associated_model_config.abstract_model.model.new))
+            [field.name, field_names(associated.visible_fields.reject(&:association?))]
+          end
+        else
+          # The list shows these associations already, so their keys expose nothing more
+          names[:only].concat(fields.select { |f| f.association? && f.association.type == :belongs_to && !f.association.polymorphic? }.
+            flat_map { |f| Array(f.association.foreign_key) })
+        end
+        names
+      end
+    end
+
+    def field_names(fields)
+      fields.each_with_object({only: [], methods: []}) do |field, names|
+        list = field.virtual? ? names[:methods] : names[:only]
+        if field.association?
+          list << field.method_name.to_sym << field.association.foreign_type.to_sym
+        else
+          list << field.name
+        end
+      end
+    end
+
+    def filter(requested, permitted)
+      only = Array(requested[:only]) & permitted[:only]
+      # Mongoid serializes every attribute for an empty `only`
+      schema = {only: only.presence || [:__none__]}
+      schema[:methods] = Array(requested[:methods]) & permitted[:methods] if requested.key?(:methods)
+      schema
+    end
+  end
+end

data/lib/rails_admin/version.rb

@@ -3,7 +3,7 @@
 module RailsAdmin
   class Version
     MAJOR = 3
-    MINOR = 1
+    MINOR = 3
     PATCH = 1
     PRE = nil
 

data/lib/rails_admin.rb

@@ -10,6 +10,7 @@ require 'rails_admin/extensions/pundit'
 require 'rails_admin/extensions/paper_trail'
 require 'rails_admin/support/csv_converter'
 require 'rails_admin/support/hash_helper'
+require 'rails_admin/support/serialization_schema'
 require 'yaml'
 
 module RailsAdmin

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rails_admin",
-  "version": "3.1.1",
+  "version": "3.3.1",
   "description": "RailsAdmin is a Rails engine that provides an easy-to-use interface for managing your data.",
   "homepage": "https://github.com/railsadminteam/rails_admin",
   "license": "MIT",
@@ -22,7 +22,7 @@
     "bootstrap": "^5.1.3",
     "flatpickr": "^4.6.9",
     "jquery": "^3.6.0",
-    "jquery-ui": "^1.12.1"
+    "jquery-ui": "^1.12.1 <1.14.0"
   },
   "devDependencies": {
     "prettier": "^2.4.1"

data/src/rails_admin/abstract-select.js

@@ -0,0 +1,30 @@
+import jQuery from "jquery";
+import "jquery-ui/ui/widget.js";
+
+(function ($) {
+  "use strict";
+
+  $.widget("ra.abstractSelect", {
+    options: {
+      createQuery: function (query) {
+        if ($.isEmptyObject(this.scopeBy)) {
+          return { query: query };
+        } else {
+          const filterQuery = {};
+          for (var field in this.scopeBy) {
+            const targetField = this.scopeBy[field];
+            const targetValue = $(`[name$="[${field}]"]`).val();
+            if (!filterQuery[targetField]) {
+              filterQuery[targetField] = [];
+            }
+            filterQuery[targetField].push(
+              targetValue ? { o: "is", v: targetValue } : { o: "_blank" }
+            );
+          }
+          return { query: query, f: filterQuery };
+        }
+      },
+      scopeBy: {},
+    },
+  });
+})(jQuery);

data/src/rails_admin/base.js

@@ -17,6 +17,7 @@ import "jquery-ui/ui/widget.js";
 import "jquery-ui/ui/widgets/menu.js";
 import "jquery-ui/ui/widgets/mouse.js";
 
+import "./abstract-select";
 import "./filter-box";
 import "./filtering-multiselect";
 import "./filtering-select";
@@ -26,4 +27,6 @@ import "./sidescroll";
 import "./ui";
 import "./widgets";
 
-Rails.start();
+if (!window._rails_loaded) {
+  Rails.start();
+}

data/src/rails_admin/filtering-multiselect.js

@@ -1,13 +1,11 @@
 import jQuery from "jquery";
 import "jquery-ui/ui/widget.js";
 import I18n from "./i18n";
+
 (function ($) {
-  $.widget("ra.filteringMultiselect", {
+  $.widget("ra.filteringMultiselect", $.ra.abstractSelect, {
     _cache: {},
     options: {
-      createQuery: function (query) {
-        return { query: query };
-      },
       sortable: false,
       removable: true,
       regional: {

data/src/rails_admin/filtering-select.js

@@ -6,11 +6,8 @@ import I18n from "./i18n";
 (function ($) {
   "use strict";
 
-  $.widget("ra.filteringSelect", {
+  $.widget("ra.filteringSelect", $.ra.abstractSelect, {
     options: {
-      createQuery: function (query) {
-        return { query: query };
-      },
       minLength: 0,
       searchDelay: 200,
       remote_source: null,
@@ -300,6 +297,7 @@ import I18n from "./i18n";
     destroy: function () {
       this.input.remove();
       this.button.remove();
+      this.element.html($('<option value="" selected="selected"></option>'));
       this.element.show();
       this.filtering_select.remove();
       $.Widget.prototype.destroy.call(this);

data/src/rails_admin/ui.js

@@ -88,7 +88,7 @@ import I18n from "./i18n";
   $(document).ready(triggerDomReady);
   document.addEventListener("turbo:render", triggerDomReady);
 
-  document.addEventListener("rails_admin.dom_ready", function () {
+  document.addEventListener("rails_admin.dom_ready", function (event) {
     $(".nav.nav-pills li.active").removeClass("active");
     $(
       '.nav.nav-pills li[data-model="' + $(".page-header").data("model") + '"]'
@@ -129,6 +129,12 @@ import I18n from "./i18n";
     $("a[data-method]").on("click", function (event) {
       window.Turbo.session.drive = false;
     });
+
+    // Trigger via jQuery for compatibility with existing user codes
+    $(document).trigger(
+      "rails_admin.dom_ready",
+      event.detail ? [event.detail] : null
+    );
   });
 
   $(document).on("click", ".bulk-link", function (event) {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_admin
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.3.1
 platform: ruby
 authors:
 - Erik Michaels-Ober
@@ -9,10 +9,9 @@ authors:
 - Petteri Kaapa
 - Benoit Benezech
 - Mitsuhiro Shibuya
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-18 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel-serializers-xml
@@ -28,6 +27,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: kaminari
   requirement: !ruby/object:Gem::Requirement
@@ -71,7 +84,7 @@ dependencies:
         version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -81,21 +94,27 @@ dependencies:
         version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
 - !ruby/object:Gem::Dependency
   name: turbo-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -190,6 +209,7 @@ files:
 - lib/generators/rails_admin/templates/initializer.erb
 - lib/generators/rails_admin/templates/rails_admin.js
 - lib/generators/rails_admin/templates/rails_admin.scss.erb
+- lib/generators/rails_admin/templates/rails_admin.vite.js
 - lib/generators/rails_admin/templates/rails_admin.webpacker.js
 - lib/generators/rails_admin/utils.rb
 - lib/rails_admin.rb
@@ -198,8 +218,6 @@ files:
 - lib/rails_admin/adapters/active_record/association.rb
 - lib/rails_admin/adapters/active_record/object_extension.rb
 - lib/rails_admin/adapters/active_record/property.rb
-- lib/rails_admin/adapters/composite_primary_keys.rb
-- lib/rails_admin/adapters/composite_primary_keys/association.rb
 - lib/rails_admin/adapters/mongoid.rb
 - lib/rails_admin/adapters/mongoid/association.rb
 - lib/rails_admin/adapters/mongoid/bson.rb
@@ -225,6 +243,7 @@ files:
 - lib/rails_admin/config/fields.rb
 - lib/rails_admin/config/fields/association.rb
 - lib/rails_admin/config/fields/base.rb
+- lib/rails_admin/config/fields/collection_association.rb
 - lib/rails_admin/config/fields/factories/action_text.rb
 - lib/rails_admin/config/fields/factories/active_storage.rb
 - lib/rails_admin/config/fields/factories/association.rb
@@ -236,6 +255,7 @@ files:
 - lib/rails_admin/config/fields/factories/password.rb
 - lib/rails_admin/config/fields/factories/shrine.rb
 - lib/rails_admin/config/fields/group.rb
+- lib/rails_admin/config/fields/singular_association.rb
 - lib/rails_admin/config/fields/types.rb
 - lib/rails_admin/config/fields/types/action_text.rb
 - lib/rails_admin/config/fields/types/active_record_enum.rb
@@ -249,7 +269,6 @@ files:
 - lib/rails_admin/config/fields/types/ck_editor.rb
 - lib/rails_admin/config/fields/types/code_mirror.rb
 - lib/rails_admin/config/fields/types/color.rb
-- lib/rails_admin/config/fields/types/composite_keys_belongs_to_association.rb
 - lib/rails_admin/config/fields/types/date.rb
 - lib/rails_admin/config/fields/types/datetime.rb
 - lib/rails_admin/config/fields/types/decimal.rb
@@ -311,13 +330,17 @@ files:
 - lib/rails_admin/extensions/paper_trail/auditing_adapter.rb
 - lib/rails_admin/extensions/pundit.rb
 - lib/rails_admin/extensions/pundit/authorization_adapter.rb
+- lib/rails_admin/extensions/url_for_extension.rb
+- lib/rails_admin/support/composite_keys_serializer.rb
 - lib/rails_admin/support/csv_converter.rb
 - lib/rails_admin/support/datetime.rb
 - lib/rails_admin/support/es_module_processor.rb
 - lib/rails_admin/support/hash_helper.rb
+- lib/rails_admin/support/serialization_schema.rb
 - lib/rails_admin/version.rb
 - lib/tasks/rails_admin.rake
 - package.json
+- src/rails_admin/abstract-select.js
 - src/rails_admin/base.js
 - src/rails_admin/filter-box.js
 - src/rails_admin/filtering-multiselect.js
@@ -446,12 +469,13 @@ homepage: https://github.com/railsadminteam/rails_admin
 licenses:
 - MIT
 metadata: {}
-post_install_message: "\n    ### Upgrading RailsAdmin from 2.x.x to 3.x.x ###\n\n
-  \   Due to introduction of Webpack/Webpacker support, some additional dependencies
-  and configuration will be needed.\n    Running `bin/rails g rails_admin:install`
-  will suggest required changes, based on the current setup of your app.\n\n    For
-  a complete list of changes, see https://github.com/railsadminteam/rails_admin/blob/master/CHANGELOG.md\n
-  \ "
+post_install_message: |
+  ### Upgrading RailsAdmin from 2.x.x to 3.x.x ###
+
+  Due to introduction of Webpack/Webpacker support, some additional dependencies and configuration will be needed.
+  Running `bin/rails g rails_admin:install` will suggest required changes, based on the current setup of your app.
+
+  For a complete list of changes, see https://github.com/railsadminteam/rails_admin/blob/master/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib
@@ -466,8 +490,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.8.11
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 4.0.19
 specification_version: 4
 summary: Admin for Rails
 test_files: []

data/lib/rails_admin/adapters/composite_primary_keys/association.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-module RailsAdmin
-  module Adapters
-    module CompositePrimaryKeys
-      class Association < RailsAdmin::Adapters::ActiveRecord::Association
-        def field_type
-          if type == :belongs_to && association.foreign_key.is_a?(Array)
-            :composite_keys_belongs_to_association
-          else
-            super
-          end
-        end
-
-        def primary_key
-          return nil if polymorphic?
-
-          value = association.association_primary_key
-
-          if value.is_a? Array
-            :id
-          else
-            value.to_sym
-          end
-        end
-
-        def foreign_key
-          if association.foreign_key.is_a? Array
-            association.foreign_key.map(&:to_sym)
-          else
-            super
-          end
-        end
-
-        def key_accessor
-          if type == :belongs_to && foreign_key.is_a?(Array)
-            :"#{name}_id"
-          else
-            super
-          end
-        end
-      end
-    end
-  end
-end

data/lib/rails_admin/adapters/composite_primary_keys.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails_admin/adapters/active_record'
-require 'rails_admin/adapters/composite_primary_keys/association'
-
-module RailsAdmin
-  module Adapters
-    module CompositePrimaryKeys
-      include RailsAdmin::Adapters::ActiveRecord
-
-      def get(id, scope = scoped)
-        begin
-          object = scope.find(id)
-        rescue ::ActiveRecord::RecordNotFound
-          return nil
-        end
-
-        object.extend(RailsAdmin::Adapters::ActiveRecord::ObjectExtension)
-      end
-
-      def associations
-        model.reflect_on_all_associations.collect do |association|
-          RailsAdmin::Adapters::CompositePrimaryKeys::Association.new(association, model)
-        end
-      end
-
-    private
-
-      def bulk_scope(scope, options)
-        if primary_key.is_a? Array
-          options[:bulk_ids].map do |id|
-            scope.where(primary_key.zip(::CompositePrimaryKeys::CompositeKeys.parse(id)).to_h)
-          end.reduce(&:or)
-        else
-          super
-        end
-      end
-    end
-  end
-end

data/lib/rails_admin/config/fields/types/composite_keys_belongs_to_association.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails_admin/config/fields/types/belongs_to_association'
-
-module RailsAdmin
-  module Config
-    module Fields
-      module Types
-        class CompositeKeysBelongsToAssociation < RailsAdmin::Config::Fields::Types::BelongsToAssociation
-          RailsAdmin::Config::Fields::Types.register(self)
-
-          register_instance_option :allowed_methods do
-            nested_form ? [method_name] : Array(association.foreign_key)
-          end
-
-          def selected_id
-            association.foreign_key.map { |attribute| bindings[:object].safe_send(attribute) }.to_composite_keys.to_s
-          end
-
-          def parse_input(params)
-            return unless params[method_name].present? && association.foreign_key.is_a?(Array) && !nested_form
-
-            association.foreign_key.zip(CompositePrimaryKeys::CompositeKeys.parse(params.delete(method_name))).each do |key, value|
-              params[key] = value
-            end
-          end
-        end
-      end
-    end
-  end
-end