rails_admin_next 1.0.0

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

@@ -0,0 +1,391 @@
+# frozen_string_literal: true
+
+require "rails_admin_next/config/proxyable"
+require "rails_admin_next/config/configurable"
+require "rails_admin_next/config/hideable"
+require "rails_admin_next/config/groupable"
+require "rails_admin_next/config/inspectable"
+
+module RailsAdminNext
+  module Config
+    module Fields
+      class Base # rubocop:disable Metrics/ClassLength
+        include RailsAdminNext::Config::Proxyable
+        include RailsAdminNext::Config::Configurable
+        include RailsAdminNext::Config::Hideable
+        include RailsAdminNext::Config::Groupable
+        include RailsAdminNext::Config::Inspectable
+
+        attr_reader :name, :properties, :abstract_model, :parent, :root
+        attr_accessor :defined, :order, :section
+
+        NAMED_INSTANCE_VARIABLES = %i[
+          @parent @root @section @children_fields_registered
+          @associated_model_config @group
+        ].freeze
+
+        def initialize(parent, name, properties)
+          @parent = parent
+          @root = parent.root
+
+          @abstract_model = parent.abstract_model
+          @defined = false
+          @name = name.to_sym
+          @order = 0
+          @properties = properties
+          @section = parent
+        end
+
+        register_instance_option :css_class do
+          "#{name}_field"
+        end
+
+        def type_css_class
+          "#{type}_type"
+        end
+
+        def virtual?
+          properties.blank?
+        end
+
+        register_instance_option :column_width do
+          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.quoted_table_name}.#{abstract_model.quote_column_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.quoted_table_name}.#{abstract_model.quote_column_name(sortable)}"
+          else # use described column in the field conf.
+            "#{abstract_model.quoted_table_name}.#{abstract_model.quote_column_name(sortable)}"
+          end
+        end
+
+        register_instance_option :searchable do
+          !virtual? || children_fields.first || false
+        end
+
+        register_instance_option :search_operator do
+          RailsAdminNext::Config.default_search_operator
+        end
+
+        register_instance_option :queryable? do
+          !virtual?
+        end
+
+        register_instance_option :filterable? do
+          !!searchable
+        end
+
+        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).
+        register_instance_option :sort_reverse? do
+          false
+        end
+
+        # list of columns I should search for that field [{ column: 'table_name.column', type: field.type }, {..}]
+        register_instance_option :searchable_columns do
+          @searchable_columns ||=
+            case searchable
+            when true
+              [{column: "#{abstract_model.table_name}.#{name}", type: type}]
+            when false
+              []
+            when :all # valid only for associations
+              table_name = associated_model_config.abstract_model.table_name
+              associated_model_config.list.fields.collect { |f| {column: "#{table_name}.#{f.name}", type: f.type} }
+            else
+              [searchable].flatten.collect do |f|
+                if f.is_a?(String) && f.include?(".")                            #  table_name.column
+                  table_name, column = f.split "."
+                  type = nil
+                elsif f.is_a?(Hash)                                              #  <Model|table_name> => <attribute|column>
+                  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&.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&.type
+                end
+                {column: "#{table_name}.#{column}", type: type || :string}
+              end
+            end
+        end
+
+        register_instance_option :formatted_value do
+          value
+        end
+
+        # output for pretty printing (show, list)
+        register_instance_option :pretty_value do
+          formatted_value.presence || " - "
+        end
+
+        # output for printing in export view (developers beware: no bindings[:view] and no data!)
+        register_instance_option :export_value do
+          pretty_value
+        end
+
+        # Accessor for field's help text displayed below input field.
+        register_instance_option :help do
+          (@help ||= {})[::I18n.locale] ||= generic_field_help
+        end
+
+        register_instance_option :html_attributes do
+          {
+            required: required?
+          }
+        end
+
+        register_instance_option :default_value do
+          nil
+        end
+
+        # Accessor for field's label.
+        #
+        # @see RailsAdminNext::AbstractModel.properties
+        register_instance_option :label do
+          (@label ||= {})[::I18n.locale] ||= abstract_model.model.human_attribute_name name
+        end
+
+        register_instance_option :hint do
+          @hint ||= ""
+        end
+
+        # Accessor for field's maximum length per database.
+        #
+        # @see RailsAdminNext::AbstractModel.properties
+        register_instance_option :length do
+          @length ||= properties&.length
+        end
+
+        # Accessor for field's length restrictions per validations
+        #
+        register_instance_option :valid_length do
+          @valid_length ||= abstract_model.model.validators_on(name).detect { |v| v.kind == :length }.try(&:options) || {}
+        end
+
+        register_instance_option :partial do
+          :form_field
+        end
+
+        # Accessor for whether this is field is mandatory.
+        #
+        # @see RailsAdminNext::AbstractModel.properties
+        register_instance_option :required? do
+          context =
+            if bindings && bindings[:object]
+              bindings[:object].persisted? ? :update : :create
+            else
+              :nil
+            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]) &&
+                %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
+          end
+        end
+
+        # Accessor for whether this is a serial field (aka. primary key, identifier).
+        #
+        # @see RailsAdminNext::AbstractModel.properties
+        register_instance_option :serial? do
+          properties&.serial?
+        end
+
+        register_instance_option :view_helper do
+          :text_field
+        end
+
+        register_instance_option :read_only? do
+          !editable?
+        end
+
+        # init status in the view
+        register_instance_option :active? do
+          false
+        end
+
+        register_instance_option :visible? do
+          returned = true
+          (RailsAdminNext.config.default_hidden_fields || {}).each do |section, fields|
+            next unless self.section.is_a?("RailsAdminNext::Config::Sections::#{section.to_s.camelize}".constantize)
+
+            returned = false if fields.include?(name)
+          end
+          returned
+        end
+
+        # columns mapped (belongs_to, active_storage, etc.). First one is used for searching/sorting by default
+        register_instance_option :children_fields do
+          []
+        end
+
+        register_instance_option :eager_load do
+          false
+        end
+
+        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_next/main/#{partial}", locals: {field: self, form: bindings[:form]}
+        end
+
+        def editable?
+          !((@properties && @properties.read_only?) || (bindings[:object] && bindings[:object].readonly?))
+        end
+
+        # Is this an association
+        def association?
+          is_a?(RailsAdminNext::Config::Fields::Association)
+        end
+
+        # Reader for validation errors of the bound object
+        def errors
+          ([name] + children_fields).uniq.collect do |column_name|
+            bindings[:object].errors[column_name]
+          end.uniq.flatten
+        end
+
+        # Reader whether field is optional.
+        #
+        # @see RailsAdminNext::Config::Fields::Base.register_instance_option :required?
+        def optional?
+          !required?
+        end
+
+        # Inverse accessor whether this field is required.
+        #
+        # @see RailsAdminNext::Config::Fields::Base.register_instance_option :required?
+        def optional(state = nil, &block)
+          if !state.nil? || block
+            required state.nil? ? proc { instance_eval(&block) == false } : state == false
+          else
+            optional?
+          end
+        end
+
+        # Writer to make field optional.
+        #
+        # @see RailsAdminNext::Config::Fields::Base.optional
+        def optional=(state)
+          optional(state)
+        end
+
+        # Reader for field's type
+        def type
+          @type ||= self.class.name.to_s.demodulize.underscore.to_sym
+        end
+
+        # Reader for field's value
+        def value
+          bindings[:object].safe_send(name)
+        rescue NoMethodError => e
+          raise e.exception <<~ERROR
+            #{e.message}
+            If you want to use a RailsAdminNext 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
+        register_instance_option :nested_form do
+          false
+        end
+
+        # Allowed methods for the field in forms
+        register_instance_option :allowed_methods do
+          [method_name]
+        end
+
+        def generic_help
+          "#{required? ? I18n.translate("admin.form.required") : I18n.translate("admin.form.optional")}. "
+        end
+
+        def generic_field_help
+          model = abstract_model.model_name.underscore
+          model_lookup = :"admin.help.#{model}.#{name}"
+          translated = I18n.translate(model_lookup, help: generic_help, default: [generic_help])
+          (translated.is_a?(Hash) ? translated.to_a.first[1] : translated).html_safe
+        end
+
+        def parse_value(value)
+          value
+        end
+
+        def parse_input(_params)
+          # overridden
+        end
+
+        def inverse_of
+          nil
+        end
+
+        def method_name
+          name
+        end
+
+        def form_default_value
+          (default_value if bindings[:object].new_record? && value.nil?)
+        end
+
+        def form_value
+          form_default_value.nil? ? formatted_value : form_default_value
+        end
+      end
+    end
+  end
+end

data/lib/rails_admin_next/config/fields/collection_association.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require "rails_admin_next/config/fields/association"
+
+module RailsAdminNext
+  module Config
+    module Fields
+      class CollectionAssociation < Association
+        # orderable associated objects
+        register_instance_option :orderable do
+          false
+        end
+
+        register_instance_option :partial do
+          nested_form ? :form_nested_many : :form_filtering_multiselect
+        end
+
+        def collection(scope = nil)
+          if scope
+            super
+          elsif associated_collection_cache_all
+            selected = selected_ids
+            i = 0
+            super.sort_by { |a| [selected.index(a[1]) || selected.size, i += 1] }
+          else
+            value.map { |o| [o.send(associated_object_label_method), format_key(o.send(associated_primary_key))] }
+          end
+        end
+
+        def associated_prepopulate_params
+          {associated_model_config.abstract_model.param_key => {association.foreign_key => bindings[:object].try(:id)}}
+        end
+
+        def multiple?
+          true
+        end
+
+        def selected_ids
+          value.map { |s| format_key(s.send(associated_primary_key)).to_s }
+        end
+
+        def parse_input(params)
+          return unless associated_model_config.abstract_model.primary_key.is_a?(Array)
+
+          if nested_form
+            params[method_name].each_value do |value|
+              value[:id] = associated_model_config.abstract_model.parse_id(value[:id])
+            end
+          elsif params[method_name].is_a?(Array)
+            params[method_name] = params[method_name].map { |key| associated_model_config.abstract_model.parse_id(key) if key.present? }.compact
+            if params[method_name].empty?
+              # Workaround for Arel::Visitors::UnsupportedVisitError in #ids_writer, until https://github.com/rails/rails/pull/51116 is in place
+              params.delete(method_name)
+              params[name] = []
+            end
+          end
+        end
+
+        def form_default_value
+          (default_value if bindings[:object].new_record? && value.empty?)
+        end
+
+        def form_value
+          form_default_value.nil? ? selected_ids : form_default_value
+        end
+
+        def widget_options
+          {
+            xhr: !associated_collection_cache_all,
+            "edit-url": ((inline_edit && bindings[:view].authorized?(:edit, associated_model_config.abstract_model)) ? bindings[:view].edit_path(model_name: associated_model_config.abstract_model.to_param, id: "__ID__") : ""),
+            remote_source: bindings[:view].index_path(associated_model_config.abstract_model, source_object_id: abstract_model.format_id(bindings[:object].id), source_abstract_model: abstract_model.to_param, associated_collection: name, current_action: bindings[:view].current_action, compact: true),
+            scopeBy: dynamic_scope_relationships,
+            sortable: !!orderable,
+            removable: !!removable,
+            cacheAll: !!associated_collection_cache_all,
+            regional: {
+              add: ::I18n.t("admin.misc.add_new"),
+              chooseAll: ::I18n.t("admin.misc.chose_all"),
+              clearAll: ::I18n.t("admin.misc.clear_all"),
+              down: ::I18n.t("admin.misc.down"),
+              remove: ::I18n.t("admin.misc.remove"),
+              search: ::I18n.t("admin.misc.search"),
+              up: ::I18n.t("admin.misc.up")
+            }
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "rails_admin_next/config/fields"
+require "rails_admin_next/config/fields/types"
+
+RailsAdminNext::Config::Fields.register_factory do |parent, properties, fields|
+  if defined?(::ActionText) && properties.try(:association?) && (match = /\Arich_text_(.+)\Z/.match properties.name) && properties.klass.to_s == "ActionText::RichText"
+    field = RailsAdminNext::Config::Fields::Types.load(:action_text).new(parent, match[1], properties)
+    fields << field
+    true
+  else
+    false
+  end
+end

data/lib/rails_admin_next/config/fields/factories/active_storage.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "rails_admin_next/config/fields"
+require "rails_admin_next/config/fields/types"
+require "rails_admin_next/config/fields/types/file_upload"
+
+RailsAdminNext::Config::Fields.register_factory do |parent, properties, fields|
+  if defined?(::ActiveStorage) && properties.try(:association?) && (match = /\A(.+)_attachments?\Z/.match properties.name) && properties.klass.to_s == "ActiveStorage::Attachment"
+    name = match[1]
+    field = RailsAdminNext::Config::Fields::Types.load(
+      (properties.type == :has_many) ? :multiple_active_storage : :active_storage
+    ).new(parent, name, properties)
+    fields << field
+    associations =
+      if properties.type == :has_many
+        [:"#{name}_attachments", :"#{name}_blobs"]
+      else
+        [:"#{name}_attachment", :"#{name}_blob"]
+      end
+    children_fields = associations.map do |child_name|
+      child_association = parent.abstract_model.associations.detect { |p| p.name.to_sym == child_name }
+      next unless child_association
+
+      child_field = fields.detect { |f| f.name == child_name } || RailsAdminNext::Config::Fields.default_factory.call(parent, child_association, fields)
+      child_field.hide unless field == child_field
+      child_field.filterable(false) unless field == child_field
+      child_field.name
+    end.flatten.compact
+    field.children_fields(children_fields)
+    true
+  else
+    false
+  end
+end

data/lib/rails_admin_next/config/fields/factories/association.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "rails_admin_next/config/fields"
+require "rails_admin_next/config/fields/types"
+require "rails_admin_next/config/fields/types/belongs_to_association"
+
+RailsAdminNext::Config::Fields.register_factory do |parent, properties, fields|
+  parent.abstract_model.associations.filter { |a| Array(a.foreign_key).include?(properties.name) && %i[belongs_to has_and_belongs_to_many].include?(a.type) }.each do |association|
+    field = RailsAdminNext::Config::Fields::Types.load(association.field_type).new(parent, association.name, association)
+    fields << field
+
+    child_columns = []
+    possible_field_names = if association.polymorphic?
+      %i[foreign_key foreign_type foreign_inverse_of]
+    else
+      [:foreign_key]
+    end.flat_map { |k| Array(association.send(k)) }.compact
+
+    parent.abstract_model.properties.select { |p| possible_field_names.include? p.name }.each do |column|
+      child_field = fields.detect { |f| f.name.to_s == column.name.to_s }
+      child_field ||= RailsAdminNext::Config::Fields.default_factory.call(parent, column, fields)
+      child_columns << child_field
+    end
+
+    child_columns.each do |child_column|
+      child_column.hide
+      child_column.filterable(false)
+    end
+
+    field.children_fields child_columns.collect(&:name)
+  end.any?
+end

data/lib/rails_admin_next/config/fields/factories/encrypted_password.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "rails_admin_next/config/fields"
+require "rails_admin_next/config/fields/types"
+require "rails_admin_next/config/fields/types/password"
+
+# Register a custom field factory for models with an encrypted_password column (e.g. Devise, has_secure_password variants)
+RailsAdminNext::Config::Fields.register_factory do |parent, properties, fields|
+  if properties.name == :encrypted_password
+    extensions = %i[password_salt reset_password_token remember_token]
+    fields << RailsAdminNext::Config::Fields::Types.load(:password).new(parent, :password, properties)
+    fields << RailsAdminNext::Config::Fields::Types.load(:password).new(parent, :password_confirmation, properties)
+    extensions.each do |ext|
+      properties = parent.abstract_model.properties.detect { |p| ext == p.name }
+      next unless properties
+
+      field = fields.detect { |f| f.name == ext }
+      unless field
+        RailsAdminNext::Config::Fields.default_factory.call(parent, properties, fields)
+        field = fields.last
+      end
+      field.hide
+    end
+    true
+  else
+    false
+  end
+end

data/lib/rails_admin_next/config/fields/factories/enum.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "rails_admin_next/config/fields"
+require "rails_admin_next/config/fields/types/enum"
+require "rails_admin_next/config/fields/types/active_record_enum"
+
+RailsAdminNext::Config::Fields.register_factory do |parent, properties, fields|
+  model = parent.abstract_model.model
+  method_name = "#{properties.name}_enum"
+
+  # NOTICE: _method_name could be `to_enum` and this method defined in Object.
+  if !Object.respond_to?(method_name) &&
+      (model.respond_to?(method_name) ||
+          model.method_defined?(method_name))
+    fields << RailsAdminNext::Config::Fields::Types::Enum.new(parent, properties.name, properties)
+    true
+  elsif model.respond_to?(:defined_enums) && model.defined_enums[properties.name.to_s]
+    fields << RailsAdminNext::Config::Fields::Types::ActiveRecordEnum.new(parent, properties.name, properties)
+    true
+  else
+    false
+  end
+end

data/lib/rails_admin_next/config/fields/factories/password.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "rails_admin_next/config/fields"
+require "rails_admin_next/config/fields/types/password"
+
+# Register a custom field factory for properties named as password. More property
+# names can be registered in RailsAdminNext::Config::Fields::Password.column_names
+# array.
+#
+# @see RailsAdminNext::Config::Fields::Types::Password.column_names
+# @see RailsAdminNext::Config::Fields.register_factory
+RailsAdminNext::Config::Fields.register_factory do |parent, properties, fields|
+  if [:password].include?(properties.name)
+    fields << RailsAdminNext::Config::Fields::Types::Password.new(parent, properties.name, properties)
+    true
+  else
+    false
+  end
+end