rails_admin 2.1.1 → 3.1.2

data/lib/rails_admin/config/actions/history_show.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Config
     module Actions
@@ -19,7 +21,7 @@ module RailsAdmin
         register_instance_option :controller do
           proc do
             @general = false
-            @history = @auditing_adapter && @auditing_adapter.listing_for_object(@abstract_model, @object, params[:query], params[:sort], params[:sort_reverse], params[:all], params[:page]) || []
+            @history = @auditing_adapter&.listing_for_object(@abstract_model, @object, params[:query], params[:sort], params[:sort_reverse], params[:all], params[Kaminari.config.param_name]) || []
 
             render @action.template_name
           end
@@ -30,7 +32,7 @@ module RailsAdmin
         end
 
         register_instance_option :link_icon do
-          'icon-book'
+          'fas fa-book'
         end
       end
     end

data/lib/rails_admin/config/actions/index.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'activemodel-serializers-xml'
 
 module RailsAdmin
@@ -11,7 +13,7 @@ module RailsAdmin
         end
 
         register_instance_option :http_methods do
-          [:get, :post]
+          %i[get post]
         end
 
         register_instance_option :route_fragment do
@@ -20,7 +22,8 @@ module RailsAdmin
 
         register_instance_option :breadcrumb_parent do
           parent_model = bindings[:abstract_model].try(:config).try(:parent)
-          if am = parent_model && RailsAdmin.config(parent_model).try(:abstract_model)
+          am = parent_model && RailsAdmin.config(parent_model).try(:abstract_model)
+          if am
             [:index, am]
           else
             [:dashboard]
@@ -33,9 +36,7 @@ module RailsAdmin
 
             unless @model_config.list.scopes.empty?
               if params[:scope].blank?
-                unless @model_config.list.scopes.first.nil?
-                  @objects = @objects.send(@model_config.list.scopes.first)
-                end
+                @objects = @objects.send(@model_config.list.scopes.first) unless @model_config.list.scopes.first.nil?
               elsif @model_config.list.scopes.collect(&:to_s).include?(params[:scope])
                 @objects = @objects.send(params[:scope].to_sym)
               end
@@ -47,7 +48,7 @@ module RailsAdmin
               end
 
               format.json do
-                output = begin
+                output =
                   if params[:compact]
                     primary_key_method = @association ? @association.associated_primary_key : @model_config.abstract_model.primary_key
                     label_method = @model_config.object_label_method
@@ -55,7 +56,7 @@ module RailsAdmin
                   else
                     @objects.to_json(@schema)
                   end
-                end
+
                 if params[:send_data]
                   send_data output, filename: "#{params[:model_name]}_#{DateTime.now.strftime('%Y-%m-%d_%Hh%Mm%S')}.json"
                 else
@@ -87,7 +88,7 @@ module RailsAdmin
         end
 
         register_instance_option :link_icon do
-          'icon-th-list'
+          'fas fa-th-list'
         end
       end
     end

data/lib/rails_admin/config/actions/new.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Config
     module Actions
@@ -9,7 +11,7 @@ module RailsAdmin
         end
 
         register_instance_option :http_methods do
-          [:get, :post] # NEW / CREATE
+          %i[get post] # NEW / CREATE
         end
 
         register_instance_option :controller do
@@ -17,16 +19,18 @@ module RailsAdmin
             if request.get? # NEW
 
               @object = @abstract_model.new
-              @authorization_adapter && @authorization_adapter.attributes_for(:new, @abstract_model).each do |name, value|
+              @action = @action.with(@action.bindings.merge(object: @object))
+              @authorization_adapter&.attributes_for(:new, @abstract_model)&.each do |name, value|
                 @object.send("#{name}=", value)
               end
-              if object_params = params[@abstract_model.param_key]
+              object_params = params[@abstract_model.param_key]
+              if object_params
                 sanitize_params_for!(request.xhr? ? :modal : :create)
-                @object.set_attributes(@object.attributes.merge(object_params.to_h))
+                @object.assign_attributes(@object.attributes.merge(object_params.to_h))
               end
               respond_to do |format|
                 format.html { render @action.template_name }
-                format.js   { render @action.template_name, layout: false }
+                format.js   { render @action.template_name, layout: 'rails_admin/modal', content_type: Mime[:html].to_s }
               end
 
             elsif request.post? # CREATE
@@ -35,14 +39,14 @@ module RailsAdmin
               @object = @abstract_model.new
               sanitize_params_for!(request.xhr? ? :modal : :create)
 
-              @object.set_attributes(params[@abstract_model.param_key])
-              @authorization_adapter && @authorization_adapter.authorize(:create, @abstract_model, @object)
+              @object.assign_attributes(params[@abstract_model.param_key])
+              @authorization_adapter&.authorize(:create, @abstract_model, @object)
 
               if @object.save
-                @auditing_adapter && @auditing_adapter.create_object(@object, @abstract_model, _current_user)
+                @auditing_adapter&.create_object(@object, @abstract_model, _current_user)
                 respond_to do |format|
                   format.html { redirect_to_on_success }
-                  format.js   { render json: {id: @object.id.to_s, label: @model_config.with(object: @object).object_label} }
+                  format.json { render json: {id: @object.id.to_s, label: @model_config.with(object: @object).object_label} }
                 end
               else
                 handle_save_error
@@ -53,7 +57,11 @@ module RailsAdmin
         end
 
         register_instance_option :link_icon do
-          'icon-plus'
+          'fas fa-plus'
+        end
+
+        register_instance_option :writable? do
+          !(bindings[:object] && bindings[:object].readonly?)
         end
       end
     end

data/lib/rails_admin/config/actions/show.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Config
     module Actions
@@ -26,7 +28,7 @@ module RailsAdmin
         end
 
         register_instance_option :link_icon do
-          'icon-info-sign'
+          'fas fa-info-circle'
         end
       end
     end

data/lib/rails_admin/config/actions/show_in_app.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Config
     module Actions
@@ -9,7 +11,11 @@ module RailsAdmin
         end
 
         register_instance_option :visible? do
-          authorized? && (bindings[:controller].main_app.url_for(bindings[:object]) rescue false)
+          authorized? && begin
+            bindings[:controller].main_app.url_for(bindings[:object])
+          rescue StandardError
+            false
+          end
         end
 
         register_instance_option :controller do
@@ -19,10 +25,10 @@ module RailsAdmin
         end
 
         register_instance_option :link_icon do
-          'icon-eye-open'
+          'fas fa-eye'
         end
 
-        register_instance_option :pjax? do
+        register_instance_option :turbo? do
           false
         end
       end

data/lib/rails_admin/config/actions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Config
     module Actions
@@ -9,7 +11,7 @@ module RailsAdmin
           end
           scope ||= :all
           init_actions!
-          actions = begin
+          actions =
             case scope
             when :all
               @@actions
@@ -22,7 +24,7 @@ module RailsAdmin
             when :member
               @@actions.select(&:member?)
             end
-          end
+
           actions = actions.collect { |action| action.with(bindings) }
           bindings[:controller] ? actions.select(&:visible?) : actions
         end
@@ -52,7 +54,7 @@ module RailsAdmin
             def key
               :#{key}
             end
-          ))
+          ), __FILE__, __LINE__ - 5)
           add_action_custom_key(a, &block)
         end
 
@@ -71,7 +73,7 @@ module RailsAdmin
               action = #{klass}.new
               add_action_custom_key(action, &block)
             end
-          }
+          }, __FILE__, __LINE__ - 5
         end
 
       private

data/lib/rails_admin/config/configurable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsAdmin
   module Config
     # A module for all configurables.
@@ -9,7 +11,7 @@ module RailsAdmin
 
       def has_option?(name) # rubocop:disable Naming/PredicateName
         options = self.class.instance_variable_get('@config_options')
-        options && options.key?(name)
+        options&.key?(name)
       end
 
       # Register an instance option for this object only
@@ -87,7 +89,7 @@ module RailsAdmin
             elsif block_given?
               yield
             else
-              raise("The #{option_name} configuration option is removed without replacement.")
+              raise "The #{option_name} configuration option is removed without replacement."
             end
           end
         end

data/lib/rails_admin/config/const_load_suppressor.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module RailsAdmin
+  module Config
+    module ConstLoadSuppressor
+      class << self
+        @original_const_missing = nil
+
+        def suppressing
+          raise 'Constant Loading is already suppressed' if @original_const_missing
+
+          begin
+            @original_const_missing = Object.method(:const_missing)
+            intercept_const_missing
+            yield
+          ensure
+            Object.define_singleton_method(:const_missing, @original_const_missing)
+            @original_const_missing = nil
+          end
+        end
+
+        def allowing
+          if @original_const_missing
+            begin
+              Object.define_singleton_method(:const_missing, @original_const_missing)
+              yield
+            ensure
+              intercept_const_missing
+            end
+          else
+            yield
+          end
+        end
+
+      private
+
+        def intercept_const_missing
+          Object.define_singleton_method(:const_missing) do |name|
+            ConstProxy.new(name.to_s)
+          end
+        end
+      end
+
+      class ConstProxy < BasicObject
+        attr_reader :name
+
+        def initialize(name)
+          @name = name
+        end
+
+        def klass
+          @klass ||=
+            begin
+              unless ::Object.const_defined?(name)
+                ::Kernel.raise <<~MESSAGE
+                  The constant #{name} is not loaded yet upon the execution of the RailsAdmin initializer.
+                  We don't recommend to do this and may lead to issues, but if you really have to do so you can explicitly require it by adding:
+
+                    require '#{name.underscore}'
+
+                  on top of config/initializers/rails_admin.rb.
+                MESSAGE
+              end
+              name.constantize
+            end
+        end
+
+        def method_missing(method_name, *args, &block)
+          klass.send(method_name, *args, &block)
+        end
+
+        def respond_to_missing?(method_name, include_private = false)
+          super || klass.respond_to?(method_name, include_private)
+        end
+      end
+    end
+  end
+end

data/lib/rails_admin/config/fields/association.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config'
 require 'rails_admin/config/fields/base'
 
@@ -5,15 +7,15 @@ module RailsAdmin
   module Config
     module Fields
       class Association < RailsAdmin::Config::Fields::Base
-        def self.inherited(klass)
-          super(klass)
-        end
-
         # Reader for the association information hash
         def association
           @properties
         end
 
+        def method_name
+          association.key_accessor
+        end
+
         register_instance_option :pretty_value do
           v = bindings[:view]
           [value].flatten.select(&:present?).collect do |associated|
@@ -21,8 +23,8 @@ module RailsAdmin
             am = amc.abstract_model
             wording = associated.send(amc.object_label_method)
             can_see = !am.embedded? && (show_action = v.action(:show, am, associated))
-            can_see ? v.link_to(wording, v.url_for(action: show_action.action_name, model_name: am.to_param, id: associated.id), class: 'pjax') : ERB::Util.html_escape(wording)
-          end.to_sentence.html_safe
+            can_see ? v.link_to(wording, v.url_for(action: show_action.action_name, model_name: am.to_param, id: associated.id)) : ERB::Util.html_escape(wording)
+          end.to_sentence.html_safe.presence || '-'
         end
 
         # Accessor whether association is visible or not. By default
@@ -62,10 +64,18 @@ module RailsAdmin
           association.foreign_key_nullable?
         end
 
-        register_instance_option :eager_load? do
+        register_instance_option :eager_load do
           !!searchable
         end
 
+        register_instance_option :inline_add do
+          true
+        end
+
+        register_instance_option :inline_edit do
+          true
+        end
+
         # Reader for the association's child model's configuration
         def associated_model_config
           @associated_model_config ||= RailsAdmin.config(association.klass)
@@ -78,12 +88,12 @@ module RailsAdmin
 
         # Reader for associated primary key
         def associated_primary_key
-          @associated_primary_key ||= associated_model_config.abstract_model.primary_key
+          association.primary_key
         end
 
-        # Reader for the association's key
-        def foreign_key
-          association.foreign_key
+        # Returns params which are to be set in modals
+        def associated_prepopulate_params
+          {}
         end
 
         # Reader whether this is a polymorphic association

data/lib/rails_admin/config/fields/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/proxyable'
 require 'rails_admin/config/configurable'
 require 'rails_admin/config/hideable'
@@ -14,13 +16,12 @@ module RailsAdmin
         include RailsAdmin::Config::Groupable
         include RailsAdmin::Config::Inspectable
 
-        attr_reader :name, :properties, :abstract_model
+        attr_reader :name, :properties, :abstract_model, :parent, :root
         attr_accessor :defined, :order, :section
-        attr_reader :parent, :root
 
-        NAMED_INSTANCE_VARIABLES = [
-          :@parent, :@root, :@section, :@children_fields_registered,
-          :@associated_model_config, :@group
+        NAMED_INSTANCE_VARIABLES = %i[
+          @parent @root @section @children_fields_registered
+          @associated_model_config @group
         ].freeze
 
         def initialize(parent, name, properties)
@@ -36,7 +37,7 @@ module RailsAdmin
         end
 
         register_instance_option :css_class do
-          "#{self.name}_field"
+          "#{name}_field"
         end
 
         def type_css_class
@@ -51,14 +52,36 @@ module RailsAdmin
           nil
         end
 
+        register_instance_option :sticky? do
+          false
+        end
+
         register_instance_option :sortable do
           !virtual? || children_fields.first || false
         end
 
+        def sort_column
+          if sortable == true
+            "#{abstract_model.table_name}.#{name}"
+          elsif (sortable.is_a?(String) || sortable.is_a?(Symbol)) && sortable.to_s.include?('.') # just provide sortable, don't do anything smart
+            sortable
+          elsif sortable.is_a?(Hash) # just join sortable hash, don't do anything smart
+            "#{sortable.keys.first}.#{sortable.values.first}"
+          elsif association # use column on target table
+            "#{associated_model_config.abstract_model.table_name}.#{sortable}"
+          else # use described column in the field conf.
+            "#{abstract_model.table_name}.#{sortable}"
+          end
+        end
+
         register_instance_option :searchable do
           !virtual? || children_fields.first || false
         end
 
+        register_instance_option :search_operator do
+          RailsAdmin::Config.default_search_operator
+        end
+
         register_instance_option :queryable? do
           !virtual?
         end
@@ -67,8 +90,22 @@ module RailsAdmin
           !!searchable
         end
 
-        register_instance_option :search_operator do
-          @search_operator ||= RailsAdmin::Config.default_search_operator
+        register_instance_option :filter_operators do
+          []
+        end
+
+        register_instance_option :default_filter_operator do
+          nil
+        end
+
+        def filter_options
+          {
+            label: label,
+            name: name,
+            operator: default_filter_operator,
+            operators: filter_operators,
+            type: type,
+          }
         end
 
         # serials and dates are reversed in list, which is more natural (last modified items first).
@@ -78,7 +115,7 @@ module RailsAdmin
 
         # list of columns I should search for that field [{ column: 'table_name.column', type: field.type }, {..}]
         register_instance_option :searchable_columns do
-          @searchable_columns ||= begin
+          @searchable_columns ||=
             case searchable
             when true
               [{column: "#{abstract_model.table_name}.#{name}", type: type}]
@@ -93,22 +130,21 @@ module RailsAdmin
                   table_name, column = f.split '.'
                   type = nil
                 elsif f.is_a?(Hash)                                              #  <Model|table_name> => <attribute|column>
-                  am = f.keys.first.is_a?(Class) && AbstractModel.new(f.keys.first)
-                  table_name = am && am.table_name || f.keys.first
+                  am = AbstractModel.new(f.keys.first) if f.keys.first.is_a?(Class)
+                  table_name = am&.table_name || f.keys.first
                   column = f.values.first
-                  property = am && am.properties.detect { |p| p.name == f.values.first.to_sym }
-                  type = property && property.type
+                  property = am&.properties&.detect { |p| p.name == f.values.first.to_sym }
+                  type = property&.type
                 else                                                             #  <attribute|column>
                   am = (association? ? associated_model_config.abstract_model : abstract_model)
                   table_name = am.table_name
                   column = f
                   property = am.properties.detect { |p| p.name == f.to_sym }
-                  type = property && property.type
+                  type = property&.type
                 end
                 {column: "#{table_name}.#{column}", type: (type || :string)}
               end
             end
-          end
         end
 
         register_instance_option :formatted_value do
@@ -155,7 +191,7 @@ module RailsAdmin
         #
         # @see RailsAdmin::AbstractModel.properties
         register_instance_option :length do
-          @length ||= properties && properties.length
+          @length ||= properties&.length
         end
 
         # Accessor for field's length restrictions per validations
@@ -172,17 +208,17 @@ module RailsAdmin
         #
         # @see RailsAdmin::AbstractModel.properties
         register_instance_option :required? do
-          context = begin
+          context =
             if bindings && bindings[:object]
               bindings[:object].persisted? ? :update : :create
             else
               :nil
             end
-          end
+
           (@required ||= {})[context] ||= !!([name] + children_fields).uniq.detect do |column_name|
             abstract_model.model.validators_on(column_name).detect do |v|
               !(v.options[:allow_nil] || v.options[:allow_blank]) &&
-                [:presence, :numericality, :attachment_presence].include?(v.kind) &&
+                %i[presence numericality attachment_presence].include?(v.kind) &&
                 (v.options[:on] == context || v.options[:on].blank?) &&
                 (v.options[:if].blank? && v.options[:unless].blank?)
             end
@@ -193,7 +229,7 @@ module RailsAdmin
         #
         # @see RailsAdmin::AbstractModel.properties
         register_instance_option :serial? do
-          properties && properties.serial?
+          properties&.serial?
         end
 
         register_instance_option :view_helper do
@@ -213,6 +249,7 @@ module RailsAdmin
           returned = true
           (RailsAdmin.config.default_hidden_fields || {}).each do |section, fields|
             next unless self.section.is_a?("RailsAdmin::Config::Sections::#{section.to_s.camelize}".constantize)
+
             returned = false if fields.include?(name)
           end
           returned
@@ -223,16 +260,29 @@ module RailsAdmin
           []
         end
 
-        register_instance_option :render do
-          bindings[:view].render partial: "rails_admin/main/#{partial}", locals: {field: self, form: bindings[:form]}
+        register_instance_option :eager_load do
+          false
         end
 
-        register_instance_option :default_filter_operator do
-          nil
+        register_deprecated_instance_option :eager_load?, :eager_load
+
+        def eager_load_values
+          case eager_load
+          when true
+            [name]
+          when false, nil
+            []
+          else
+            Array.wrap(eager_load)
+          end
+        end
+
+        register_instance_option :render do
+          bindings[:view].render partial: "rails_admin/main/#{partial}", locals: {field: self, form: bindings[:form]}
         end
 
         def editable?
-          !(@properties && @properties.read_only?)
+          !((@properties && @properties.read_only?) || (bindings[:object] && bindings[:object].readonly?))
         end
 
         # Is this an association
@@ -259,7 +309,7 @@ module RailsAdmin
         # @see RailsAdmin::Config::Fields::Base.register_instance_option :required?
         def optional(state = nil, &block)
           if !state.nil? || block
-            required state.nil? ? proc { false == instance_eval(&block) } : false == state
+            required state.nil? ? proc { instance_eval(&block) == false } : state == false
           else
             optional?
           end
@@ -281,14 +331,14 @@ module RailsAdmin
         def value
           bindings[:object].safe_send(name)
         rescue NoMethodError => e
-          raise e.exception <<-EOM.gsub(/^\s{10}/, '')
-          #{e.message}
-          If you want to use a RailsAdmin virtual field(= a field without corresponding instance method),
-          you should declare 'formatted_value' in the field definition.
-            field :#{name} do
-              formatted_value{ bindings[:object].call_some_method }
-            end
-          EOM
+          raise e.exception <<~ERROR
+            #{e.message}
+            If you want to use a RailsAdmin virtual field(= a field without corresponding instance method),
+            you should declare 'formatted_value' in the field definition.
+              field :#{name} do
+                formatted_value{ bindings[:object].call_some_method }
+              end
+          ERROR
         end
 
         # Reader for nested attributes
@@ -302,7 +352,7 @@ module RailsAdmin
         end
 
         def generic_help
-          (required? ? I18n.translate('admin.form.required') : I18n.translate('admin.form.optional')) + '. '
+          "#{required? ? I18n.translate('admin.form.required') : I18n.translate('admin.form.optional')}. "
         end
 
         def generic_field_help
@@ -317,7 +367,7 @@ module RailsAdmin
         end
 
         def parse_input(_params)
-          # overriden
+          # overridden
         end
 
         def inverse_of

data/lib/rails_admin/config/fields/factories/action_text.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_admin/config/fields'
 require 'rails_admin/config/fields/types'