rails_admin_next 1.0.0

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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/string/inflections"
+require "rails_admin_next/config/proxyable"
+require "rails_admin_next/config/configurable"
+require "rails_admin_next/config/hideable"
+
+module RailsAdminNext
+  module Config
+    module Fields
+      # A container for groups of fields in edit views
+      class Group
+        include RailsAdminNext::Config::Proxyable
+        include RailsAdminNext::Config::Configurable
+        include RailsAdminNext::Config::Hideable
+
+        attr_reader :name, :abstract_model, :parent, :root
+        attr_accessor :section
+
+        def initialize(parent, name)
+          @parent = parent
+          @root = parent.root
+
+          @abstract_model = parent.abstract_model
+          @section = parent
+          @name = name.to_s.tr(" ", "_").downcase.to_sym
+        end
+
+        # Defines a configuration for a field by proxying parent's field method
+        # and setting the field's group as self
+        #
+        # @see RailsAdminNext::Config::Fields.field
+        def field(name, type = nil, &)
+          field = section.field(name, type, &)
+          # Directly manipulate the variable instead of using the accessor
+          # as group probably is not yet registered to the parent object.
+          field.instance_variable_set(:@group, self)
+          field
+        end
+
+        # Reader for fields attached to this group
+        def fields
+          section.fields.select { |f| f.group == self }
+        end
+
+        # Defines configuration for fields by their type
+        #
+        # @see RailsAdminNext::Config::Fields.fields_of_type
+        def fields_of_type(type, &block)
+          selected = section.fields.select { |f| type == f.type }
+          selected.each { |f| f.instance_eval(&block) } if block
+          selected
+        end
+
+        # Reader for fields that are marked as visible
+        def visible_fields
+          section.with(bindings).visible_fields.select { |f| f.group == self }
+        end
+
+        # Should it open by default
+        register_instance_option :active? do
+          true
+        end
+
+        # Configurable group label which by default is group's name humanized.
+        register_instance_option :label do
+          (@label ||= {})[::I18n.locale] ||= parent.fields.detect { |f| f.name == name }.try(:label) || name.to_s.humanize
+        end
+
+        # Configurable help text
+        register_instance_option :help do
+          nil
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "rails_admin_next/config/fields/association"
+
+module RailsAdminNext
+  module Config
+    module Fields
+      class SingularAssociation < Association
+        register_instance_option :filter_operators do
+          %w[_discard like not_like is starts_with ends_with] + (required? ? [] : %w[_separator _present _blank])
+        end
+
+        register_instance_option :formatted_value do
+          (o = value) && o.send(associated_model_config.object_label_method)
+        end
+
+        register_instance_option :partial do
+          nested_form ? :form_nested_one : :form_filtering_select
+        end
+
+        def collection(scope = nil)
+          if associated_collection_cache_all || scope
+            super
+          else
+            [[formatted_value, selected_id]]
+          end
+        end
+
+        def multiple?
+          false
+        end
+
+        def selected_id
+          raise NoMethodError # abstract
+        end
+
+        def parse_input(params)
+          # A singular association's nested params are a single record hash; a crafted request can
+          # send an array instead, on which `[:id]` would raise. Only parse the expected shape.
+          nested = params[method_name]
+          return unless nested_form && nested.respond_to?(:key?) && nested[:id].present?
+
+          ids = associated_model_config.abstract_model.parse_id(nested[:id])
+          ids = ids.to_composite_keys.to_s if ids.respond_to?(:to_composite_keys)
+          nested[:id] = ids
+        end
+
+        def form_value
+          form_default_value.nil? ? selected_id : form_default_value
+        end
+
+        def widget_options
+          {
+            xhr: !associated_collection_cache_all,
+            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
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "rails_admin_next/config/fields/types/text"
+
+module RailsAdminNext
+  module Config
+    module Fields
+      module Types
+        class ActionText < Text
+          # Register field type for the type loader
+          RailsAdminNext::Config::Fields::Types.register(self)
+
+          register_instance_option :partial do
+            :form_action_text
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails_admin_next/config/fields/types/active_record_enum.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "rails_admin_next/config/fields/types/enum"
+
+module RailsAdminNext
+  module Config
+    module Fields
+      module Types
+        class ActiveRecordEnum < Enum
+          RailsAdminNext::Config::Fields::Types.register(self)
+
+          def type
+            :enum
+          end
+
+          register_instance_option :enum do
+            abstract_model.model.defined_enums[name.to_s]
+          end
+
+          register_instance_option :pretty_value do
+            bindings[:object].send(name).presence || " - "
+          end
+
+          register_instance_option :multiple? do
+            false
+          end
+
+          register_instance_option :queryable do
+            false
+          end
+
+          def parse_value(value)
+            return unless value.present?
+
+            abstract_model.model.attribute_types[name.to_s].serialize(value)
+          end
+
+          def parse_input(params)
+            value = params[name]
+            return unless value
+
+            params[name] = parse_input_value(value)
+          end
+
+          def form_value
+            enum[super] || super
+          end
+
+          private
+
+          def parse_input_value(value)
+            abstract_model.model.attribute_types[name.to_s].deserialize(value)
+          end
+
+          def type_cast_value(value)
+            abstract_model.model.column_types[name.to_s].type_cast_from_user(value)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require "rails_admin_next/config/fields/types/file_upload"
+
+module RailsAdminNext
+  module Config
+    module Fields
+      module Types
+        class ActiveStorage < RailsAdminNext::Config::Fields::Types::FileUpload
+          RailsAdminNext::Config::Fields::Types.register(self)
+
+          register_instance_option :thumb_method do
+            {resize_to_limit: [100, 100]}
+          end
+
+          register_instance_option :delete_method do
+            "remove_#{name}" if bindings[:object].respond_to?("remove_#{name}")
+          end
+
+          register_instance_option :image? do
+            value && (value.representable? || value.content_type.match?(/^image/))
+          end
+
+          register_instance_option :eager_load do
+            {"#{name}_attachment": :blob}
+          end
+
+          register_instance_option :direct? do
+            false
+          end
+
+          register_instance_option :html_attributes do
+            {
+              required: required? && !value.present?
+            }.merge(
+              direct? && {data: {direct_upload_url: bindings[:view].main_app.rails_direct_uploads_url}} || {}
+            )
+          end
+
+          register_instance_option :searchable do
+            false
+          end
+
+          register_instance_option :sortable do
+            false
+          end
+
+          def resource_url(thumb = false)
+            return nil unless value
+
+            if thumb && value.representable?
+              thumb = thumb_method if thumb == true
+              representation = value.representation(thumb)
+              Rails.application.routes.url_helpers.rails_blob_representation_path(
+                representation.blob.signed_id, representation.variation.key, representation.blob.filename, only_path: true
+              )
+            else
+              Rails.application.routes.url_helpers.rails_blob_path(value, only_path: true)
+            end
+          end
+
+          def value
+            attachment = super
+            attachment if attachment&.attached?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails_admin_next/config/fields/types/all.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "rails_admin_next/config/fields/types/action_text"
+require "rails_admin_next/config/fields/types/active_record_enum"
+require "rails_admin_next/config/fields/types/active_storage"
+require "rails_admin_next/config/fields/types/belongs_to_association"
+require "rails_admin_next/config/fields/types/boolean"
+require "rails_admin_next/config/fields/types/date"
+require "rails_admin_next/config/fields/types/datetime"
+require "rails_admin_next/config/fields/types/decimal"
+require "rails_admin_next/config/fields/types/enum"
+require "rails_admin_next/config/fields/types/file_upload"
+require "rails_admin_next/config/fields/types/multiple_file_upload"
+require "rails_admin_next/config/fields/types/multiple_active_storage"
+require "rails_admin_next/config/fields/types/float"
+require "rails_admin_next/config/fields/types/has_and_belongs_to_many_association"
+require "rails_admin_next/config/fields/types/has_many_association"
+require "rails_admin_next/config/fields/types/has_one_association"
+require "rails_admin_next/config/fields/types/integer"
+require "rails_admin_next/config/fields/types/password"
+require "rails_admin_next/config/fields/types/polymorphic_association"
+require "rails_admin_next/config/fields/types/string"
+require "rails_admin_next/config/fields/types/hidden"
+require "rails_admin_next/config/fields/types/text"
+require "rails_admin_next/config/fields/types/serialized"
+require "rails_admin_next/config/fields/types/time"
+require "rails_admin_next/config/fields/types/timestamp"
+require "rails_admin_next/config/fields/types/color"
+require "rails_admin_next/config/fields/types/json"
+require "rails_admin_next/config/fields/types/inet"
+require "rails_admin_next/config/fields/types/uuid"
+require "rails_admin_next/config/fields/types/citext"

data/lib/rails_admin_next/config/fields/types/belongs_to_association.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "rails_admin_next/config/fields/singular_association"
+
+module RailsAdminNext
+  module Config
+    module Fields
+      module Types
+        class BelongsToAssociation < RailsAdminNext::Config::Fields::SingularAssociation
+          RailsAdminNext::Config::Fields::Types.register(self)
+
+          register_instance_option :sortable do
+            @sortable ||= (abstract_model.adapter_supports_joins? && associated_model_config.abstract_model.properties.collect(&:name).include?(associated_model_config.object_label_method)) ? associated_model_config.object_label_method : {abstract_model.table_name => method_name}
+          end
+
+          register_instance_option :searchable do
+            @searchable ||= associated_model_config.abstract_model.properties.collect(&:name).include?(associated_model_config.object_label_method) ? [associated_model_config.object_label_method, {abstract_model.model => method_name}] : {abstract_model.model => method_name}
+          end
+
+          register_instance_option :eager_load do
+            true
+          end
+
+          register_instance_option :allowed_methods do
+            nested_form ? [method_name] : Array(association.foreign_key)
+          end
+
+          def selected_id
+            if association.foreign_key.is_a?(Array)
+              format_key(association.foreign_key.map { |attribute| bindings[:object].safe_send(attribute) })
+            else
+              bindings[:object].safe_send(association.key_accessor)
+            end
+          end
+
+          def parse_input(params)
+            return super if nested_form
+            return unless params[method_name].present? && association.foreign_key.is_a?(Array)
+
+            association.foreign_key.zip(RailsAdminNext.config.composite_keys_serializer.deserialize(params.delete(method_name))).each do |key, value|
+              params[key] = value
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails_admin_next/config/fields/types/boolean.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module RailsAdminNext
+  module Config
+    module Fields
+      module Types
+        class Boolean < RailsAdminNext::Config::Fields::Base
+          # Register field type for the type loader
+          RailsAdminNext::Config::Fields::Types.register(self)
+
+          register_instance_option :labels do
+            {
+              true => RailsAdminNext::Icons.svg(:check),
+              false => RailsAdminNext::Icons.svg(:cancel),
+              nil => RailsAdminNext::Icons.svg(:minus)
+            }
+          end
+
+          register_instance_option :css_classes do
+            {
+              true => "success",
+              false => "danger",
+              nil => "default"
+            }
+          end
+
+          register_instance_option :filter_operators do
+            %w[_discard true false] + (required? ? [] : %w[_separator _present _blank])
+          end
+
+          register_instance_option :nullable? do
+            properties&.nullable?
+          end
+
+          register_instance_option :view_helper do
+            :check_box
+          end
+
+          register_instance_option :pretty_value do
+            %(<span class="badge bg-#{css_classes[form_value]}">#{labels[form_value]}</span>).html_safe
+          end
+
+          register_instance_option :export_value do
+            value.inspect
+          end
+
+          register_instance_option :partial do
+            :form_boolean
+          end
+
+          def form_value
+            case value
+            when true, false
+              value
+            end
+          end
+
+          # Accessor for field's help text displayed below input field.
+          def generic_help
+            ""
+          end
+
+          def parse_input(params)
+            params[name] = params[name].presence if params.key?(name)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails_admin_next/config/fields/types/citext.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "rails_admin_next/config/fields/types/text"
+
+module RailsAdminNext
+  module Config
+    module Fields
+      module Types
+        class Citext < Text
+          RailsAdminNext::Config::Fields::Types.register(:citext, self)
+        end
+      end
+    end
+  end
+end

data/lib/rails_admin_next/config/fields/types/color.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "rails_admin_next/config/fields/types/string_like"
+
+module RailsAdminNext
+  module Config
+    module Fields
+      module Types
+        class Color < StringLike
+          RailsAdminNext::Config::Fields::Types.register(self)
+
+          register_instance_option :pretty_value do
+            bindings[:view].content_tag :strong, (value.presence || " - "), style: "color: #{color}"
+          end
+
+          register_instance_option :partial do
+            :form_colorpicker
+          end
+
+          register_instance_option :view_helper do
+            :color_field
+          end
+
+          register_instance_option :color do
+            if value.present?
+              if /^[0-9a-fA-F]{3,6}$/.match?(value)
+                "##{value}"
+              else
+                value
+              end
+            else
+              "white"
+            end
+          end
+
+          register_instance_option :export_value do
+            formatted_value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails_admin_next/config/fields/types/date.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "rails_admin_next/config/fields/types/datetime"
+
+module RailsAdminNext
+  module Config
+    module Fields
+      module Types
+        class Date < RailsAdminNext::Config::Fields::Types::Datetime
+          RailsAdminNext::Config::Fields::Types.register(self)
+
+          def parse_value(value)
+            ::Date.parse(value) if value.present?
+          end
+
+          register_instance_option :date_format do
+            :long
+          end
+
+          register_instance_option :i18n_scope do
+            %i[date formats]
+          end
+
+          register_instance_option :html_attributes do
+            {
+              required: required?
+            }
+          end
+
+          # The native <input type="date"> control accepts and emits %Y-%m-%d only.
+          def form_value
+            value&.strftime("%Y-%m-%d") || form_default_value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails_admin_next/config/fields/types/datetime.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require "rails_admin_next/config/fields/base"
+
+module RailsAdminNext
+  module Config
+    module Fields
+      module Types
+        class Datetime < RailsAdminNext::Config::Fields::Base
+          RailsAdminNext::Config::Fields::Types.register(self)
+
+          def parse_value(value)
+            ::Time.zone.parse(value) if value.present?
+          end
+
+          def parse_input(params)
+            params[name] = parse_value(params[name]) if params[name]
+          end
+
+          register_instance_option :filter_operators do
+            %w[default between today yesterday this_week last_week] + (required? ? [] : %w[_separator _not_null _null])
+          end
+
+          register_instance_option :date_format do
+            :long
+          end
+
+          register_instance_option :i18n_scope do
+            %i[time formats]
+          end
+
+          register_instance_option :strftime_format do
+            ::I18n.t(date_format, scope: i18n_scope, raise: true)
+          rescue ::I18n::ArgumentError
+            "%B %d, %Y %H:%M"
+          end
+
+          register_instance_option :html_attributes do
+            {
+              required: required?,
+              step: 1
+            }
+          end
+
+          register_instance_option :sort_reverse? do
+            true
+          end
+
+          register_instance_option :queryable? do
+            false
+          end
+
+          register_instance_option :formatted_value do
+            time = value || default_value
+            if time
+              ::I18n.l(time, format: strftime_format)
+            else
+              "".html_safe
+            end
+          end
+
+          register_instance_option :partial do
+            :form_datetime
+          end
+
+          # Picker-only legacy option; native HTML5 inputs render per the browser locale, so it is ignored.
+          register_deprecated_instance_option :momentjs_format do
+            RailsAdminNext.deprecator.warn("The momentjs_format configuration option is deprecated and ignored; date/time fields now use native HTML5 inputs.")
+          end
+
+          # The native <input type="datetime-local" step="1"> control accepts and emits ISO 8601 only.
+          def form_value
+            value&.in_time_zone&.strftime("%Y-%m-%dT%H:%M:%S") || form_default_value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails_admin_next/config/fields/types/decimal.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "rails_admin_next/config/fields/types/numeric"
+
+module RailsAdminNext
+  module Config
+    module Fields
+      module Types
+        class Decimal < RailsAdminNext::Config::Fields::Types::Numeric
+          # Register field type for the type loader
+          RailsAdminNext::Config::Fields::Types.register(self)
+
+          register_instance_option :html_attributes do
+            {
+              required: required?,
+              step: "any"
+            }
+          end
+        end
+      end
+    end
+  end
+end