active_element 0.0.14 → 0.0.16

data/lib/active_element/components/util/association_mapping.rb

@@ -16,6 +16,7 @@ module ActiveElement
 
         def link_tag
           verify_display_attribute
+          return nil if associated_record.blank?
           return associated_record.map { |value| link_to(value) } if multiple_association?
           return link_to(associated_record) if single_association?
         end
@@ -25,7 +26,7 @@ module ActiveElement
           when :has_one
             associated_record&.public_send(relation_key)
           when :has_many
-            associated_record&.map(&relation_key)
+            associated_record&.map(&relation_key.to_sym)
           when :belongs_to
             record&.public_send(relation_key)
           end
@@ -47,6 +48,42 @@ module ActiveElement
           value.public_send(associated_model.primary_key)
         end
 
+        def display_field
+          @display_field ||= options.fetch(:attribute) do
+            next associated_model.default_display_attribute if defined_display_attribute?
+            next default_display_attribute if default_display_attribute.present?
+
+            associated_model.primary_key
+          end
+        end
+
+        def total_count
+          associated_model&.count
+        end
+
+        def options_for_select(scope: nil)
+          return [] if associated_model.blank?
+
+          base = scope.nil? ? associated_model : associated_model.public_send(scope)
+          base.all.pluck(display_field, associated_model.primary_key).sort.map do |title, value|
+            next [title, value] if display_field == associated_model.primary_key
+
+            ["#{title} (#{value})", value]
+          end
+        end
+
+        def single_association?
+          %i[has_one belongs_to].include?(relation.macro)
+        end
+
+        def multiple_association?
+          [:has_and_belongs_to_many, :has_many].include?(relation.macro)
+        end
+
+        def associated_model
+          record.association(field).klass
+        end
+
         private
 
         attr_reader :controller, :field, :record, :associated_record, :options
@@ -56,7 +93,7 @@ module ActiveElement
         end
 
         def associated_record_path(path_for)
-          return nil unless controller.helpers.respond_to?(path_helper)
+          return nil if path_helper.nil?
 
           controller.helpers.public_send(path_helper, path_for)
         end
@@ -69,15 +106,6 @@ module ActiveElement
                 "`#{associated_record.class.name}.default_display_attribute`"
         end
 
-        def display_field
-          @display_field ||= options.fetch(:attribute) do
-            next associated_model.default_display_attribute if defined_display_attribute?
-            next default_display_attribute if default_display_attribute.present?
-
-            associated_model.primary_key
-          end
-        end
-
         def defined_display_attribute?
           associated_model.respond_to?(:default_display_attribute)
         end
@@ -91,7 +119,7 @@ module ActiveElement
         end
 
         def default_display_attribute
-          %i[name email display_name username].find do |display_field|
+          %i[email name display_name username].find do |display_field|
             next true if associated_model_callable_method?(display_field.to_sym)
             next true if associated_model.columns.map(&:name).map(&:to_sym).include?(display_field.to_sym)
 
@@ -99,10 +127,6 @@ module ActiveElement
           end
         end
 
-        def associated_model
-          record.association(field).klass
-        end
-
         def associated_model_callable_method?(name)
           return false unless associated_model.public_instance_methods.include?(name)
           return false unless associated_model.public_instance_method(name).arity.zero?
@@ -110,18 +134,16 @@ module ActiveElement
           true
         end
 
-        def single_association?
-          %i[has_one belongs_to].include?(relation.macro)
-        end
-
-        def multiple_association?
-          relation.macro == :has_many
-        end
-
         def path_helper
-          return "#{resource_name}_path" if namespace.blank?
+          names = [associated_record&.model_name&.singular].compact + Util.sti_record_names(associated_record)
+          names.compact.each do |name|
+            base_path = "#{name}_path"
+            namespace_path = "#{namespace}_#{name}_path" if namespace.present?
+            return base_path if namespace.blank? && controller.helpers.respond_to?(base_path)
+            return namespace_path if namespace_path.present? && controller.helpers.respond_to?(namespace_path)
+          end
 
-          "#{namespace}_#{resource_name}_path"
+          nil
         end
 
         def link_to(value)

data/lib/active_element/components/util/default_display_value.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module ActiveElement
+  module Components
+    module Util
+      # Infers a default display value from any given object using multiple strategies.
+      class DefaultDisplayValue
+        DEFAULT_FIELDS = %i[display_name email name username].freeze
+
+        def initialize(object:)
+          @object = object
+        end
+
+        def value
+          DEFAULT_FIELDS.each do |field|
+            return object.public_send(field) if active_record_value?(field)
+            return object[field] if hash_key(field) if hash_value?(field)
+          end
+        end
+
+        private
+
+        attr_reader :object
+
+        def associated_model
+          object.model
+        end
+
+        def active_record_value?(field)
+          return false unless object.is_a?(ActiveRecord::Base)
+          return false unless object.respond_to?(field)
+          return false unless object.public_send(field).present?
+
+          true
+        end
+
+        def hash_value?(field)
+          return false unless object.respond_to?(:[])
+          return false unless object[field].present? || object[field.to_s].present?
+
+          true
+        end
+
+        def hash_key(field)
+          return field if object[field].present?
+          return field.to_s if object[field.to_s].present?
+        end
+      end
+    end
+  end
+end

data/lib/active_element/components/util/display_value_mapping.rb

@@ -11,6 +11,12 @@ module ActiveElement
           association_mapping.link_tag
         end
 
+        def mapped_value_from_record
+          return value_record_path if value_from_record.is_a?(ActiveRecord::Base)
+
+          super
+        end
+
         def numeric_value
           value_from_record
         end
@@ -49,6 +55,10 @@ module ActiveElement
           require 'rgeo/geo_json'
           Util.json_pretty_print(RGeo::GeoJSON.encode(value_from_record))
         end
+
+        def value_record_path
+          RecordPath.new(record: value_from_record, controller: component.controller, type: :show).link
+        end
       end
     end
   end

data/lib/active_element/components/util/field_mapping.rb

@@ -73,8 +73,8 @@ module ActiveElement
         def default_value_mapper(field, options = nil)
           proc do |item|
             next default_record_value(field, item, options) if item.class.is_a?(ActiveModel::Naming)
-            next item.public_send(field) if item.respond_to?(field)
-            next item[field] if hash_field?(item, field)
+            next item.public_send(field) if item.class.is_a?(ActiveModel::Naming) && item.respond_to?(field)
+            next default_record_value(field, item, options) if hash_field?(item, field)
 
             nil
           end

data/lib/active_element/components/util/form_field_mapping.rb

@@ -10,9 +10,9 @@ module ActiveElement
         include EmailFields
 
         def initialize(record:, fields:, controller:, i18n:, search: false)
-          @record = record
-          @fields = fields
           @controller = controller
+          @record = record || default_record
+          @fields = fields
           @i18n = i18n
           @search = search
         end
@@ -20,7 +20,7 @@ module ActiveElement
         def fields_with_types_and_options
           compiled_fields = fields.map do |field|
             next field_with_default_type_and_default_options(field) unless field.is_a?(Array)
-            next field if normalized_field?(field)
+            next field_with_provided_type_and_provided_options(field) if normalized_field?(field)
             next field_with_default_type_and_provided_options(field) if field_name_with_options?(field)
             next field_with_type(field) if field_name_with_type?(field)
 
@@ -47,18 +47,36 @@ module ActiveElement
         end
 
         def field_with_default_type_and_default_options(field)
+          return inline_configured_field(field) if inline_configuration?(field)
           return [field, type_from_file(field).to_sym, options_from_file(field)] if file_configuration?(field)
-          return relation_text_search_field(field) if relation?(field) && record.present? && !search?
+          return relation_field(field) if relation?(field) && record.present?
 
           [field, default_type_from_model(field), default_options(field)]
         end
 
+        def inline_configuration?(field)
+          inline_configured_field(field).present?
+        end
+
+        def inline_configured_field(field)
+          field_options = FieldOptions.from_state(field, controller.active_element.state, record)
+          return nil if field_options.blank?
+
+          [field, field_options.type, field_options.options]
+        end
+
+        def field_with_provided_type_and_provided_options(field)
+          return relation_select_field(field.first) if relation?(field.first) && field[1] == :select
+
+          field
+        end
+
         def field_with_type(field)
-          [field.first, field.last, default_options(field)]
+          [field.first, field.last, default_options(field.first)]
         end
 
         def association_mapping(field)
-          @association_mapping ||= AssociationMapping.new(
+          AssociationMapping.new(
             controller: controller,
             field: field,
             record: record,
@@ -73,7 +91,7 @@ module ActiveElement
           #
           #   active_element.component.form fields: [:foo, :bar, [:some_json_field, :text_area]]
           #
-          file_configuration_path(field).file? && default_type_from_model(field) != :json_field
+          file_configuration_path(field).present? && default_type_from_model(field) != :json_field
         end
 
         def type_from_file(field)
@@ -86,7 +104,16 @@ module ActiveElement
         end
 
         def file_configuration_path(field)
-          record_field_configuration_path(field) || sti_field_configuration_path(field)
+          file_configuration_paths(field).compact.find(&:file?)
+        end
+
+        def file_configuration_paths(field)
+          [
+            record_field_configuration_path(field),
+            sti_record_field_configuration_paths(field),
+            controller_field_configuration_path(field),
+            controller_field_configuration_path(field, scope: false)
+          ].flatten
         end
 
         def record_field_configuration_path(field)
@@ -96,11 +123,18 @@ module ActiveElement
           Rails.root.join('config/forms', record_name, "#{field}.yml")
         end
 
-        def sti_record_field_configuration_path(field)
-          sti_record_name = Util.sti_record_name(record)
-          return nil if sti_record_name.blank?
+        def sti_record_field_configuration_paths(field)
+          sti_record_names = Util.sti_record_names(record)
+          return nil if sti_record_names.blank?
+
+          sti_record_names.map { |name| Rails.root.join('config/forms', name, "#{field}.yml") }
+        end
+
+        def controller_field_configuration_path(field, scope: true)
+          return nil if controller.blank?
 
-          Rails.root.join('config/forms', sti_record_name, "#{field}.yml")
+          controller_segment = (scope ? controller.controller_path : controller.controller_name).singularize
+          Rails.root.join('config/forms', controller_segment, "#{field}.yml")
         end
 
         def default_type_from_model(field)
@@ -126,6 +160,20 @@ module ActiveElement
           model&.reflect_on_association(field)
         end
 
+        def relation_field(field)
+          return relation_text_search_field(field) if association_mapping(field).associated_model.count > 1000
+
+          relation_select_field(field)
+        end
+
+        def relation_select_field(field)
+          association = association_mapping(field)
+          columns = [association.display_field, association.associated_model.primary_key].compact
+          [association.relation_key, :select,
+           { multiple: association_mapping(field).multiple_association?,
+             options: association.associated_model.pluck(*columns) }]
+        end
+
         def relation_text_search_field(field)
           [field, :text_search_field,
            TextSearch.text_search_options(
@@ -136,9 +184,10 @@ module ActiveElement
         end
 
         def searchable_fields(field)
+          fields = Util.relation_controller(model, controller, field)&.active_element&.state&.searchable_fields || []
           # FIXME: Use database column type to only include strings/numbers.
-          (Util.relation_controller(model, controller, field)&.active_element&.state&.searchable_fields || [])
-            .reject { |searchable_field| searchable_field.to_s.end_with?('_at') }
+          searchable = fields.reject { |searchable_field| searchable_field.to_s.end_with?('_at') }
+          searchable.presence || [:id, :name].reject { |column| model.columns.map(&:name).include?(column) }
         end
 
         def relation_primary_key(field)
@@ -189,7 +238,7 @@ module ActiveElement
           return default_search_field_type(field) if search?
           return :password_field if secret_field?(field)
           return :email_field if email_field?(field)
-          return :phone_field if phone_field?(field)
+          return :telephone_field if phone_field?(field)
 
           :text_field
         end
@@ -210,6 +259,10 @@ module ActiveElement
           }.merge(field_options(field))
         end
 
+        def default_record
+          controller&.controller_name&.classify&.safe_constantize&.new
+        end
+
         def required?(field)
           return false if record.blank?
           return false unless record.class.respond_to?(:validators)

data/lib/active_element/components/util/record_mapping.rb

@@ -17,7 +17,8 @@ module ActiveElement
         end
 
         def value
-          return mapped_value_from_record if association? || column.present?
+          return value_from_config if value_from_config.present?
+          return mapped_value_from_record if active_record? || column.present?
 
           value_from_record
         end
@@ -36,16 +37,28 @@ module ActiveElement
           @column ||= record.class.columns.find { |model_column| model_column.name.to_s == field.to_s }
         end
 
+        def active_record?
+          association? || value_from_record.is_a?(ActiveRecord::Base)
+        end
+
         def association?
           return false unless record.is_a?(ActiveRecord::Base)
 
-          record.association(field).present?
+          !record.association(field).nil?
         rescue ActiveRecord::AssociationNotFoundError
           false
         end
 
         def value_from_record
-          record.public_send(field) if record.respond_to?(field)
+          return nil if field.blank?
+
+          @value_from_record ||= if record.respond_to?(field) && record.is_a?(ActiveRecord::Base)
+                                   record.public_send(field)
+                                 elsif record.respond_to?(:key?) && record.respond_to?(:[]) && record.key?(field)
+                                   record[field]
+                                 elsif record.respond_to?(field)
+                                   record.public_send(field)
+                                 end
         end
 
         def mapped_value_from_record
@@ -66,6 +79,14 @@ module ActiveElement
           )
         end
 
+        def value_from_config
+          field_options = FieldOptions.from_state(field, component.controller.active_element.state, record)
+          return nil if field_options.blank?
+          return nil unless DATABASE_TYPES.include?(field_options.type.to_sym)
+
+          send("#{field_options.type}_value")
+        end
+
         # Override these methods as required in a class that includes this module:
 
         def mapped_association_from_record

data/lib/active_element/components/util/record_path.rb

@@ -11,19 +11,27 @@ module ActiveElement
           @type = type&.to_sym || controller.action_name&.to_sym
         end
 
-        def path
-          record_path || sti_record_path
+        def path(**kwargs)
+          record_path(**kwargs)
         rescue NoMethodError
-          raise Error,
-                "Unable to map #{record.inspect} to a Rails route. Tried:\n" \
-                "#{[default_record_path, sti_record_path].compact.join("\n")}"
+          ActiveElement.warning("Unable to map #{record.inspect} to a Rails route (#{@controller.class.name}##{@type}). Tried:\n" \
+                                "#{all_record_paths.join("\n")}")
+          nil
         end
 
-        private
+        def link(**kwargs)
+          controller.helpers.link_to(DefaultDisplayValue.new(object: record).value, path(**kwargs))
+        end
 
-        attr_reader :record, :controller, :type
+        def model
+          all_names.find do |name|
+            controller.helpers.public_send(record_path_for(name), *path_arguments)
+          rescue NoMethodError
+            nil
+          end&.classify&.constantize || default_model
+        end
 
-        def namespace_prefix
+        def namespace
           # XXX: We guess the namespace from the current controller's module name. This will work
           # most of the time but will break if the current record's controller exists in a different
           # namespace to the current controller, e.g. `BackEndAdmin::UsersController` and
@@ -31,20 +39,45 @@ module ActiveElement
           # collection of `User` objects, the "show" path will be wrong:
           # `front_end_admin_user_path`. Maybe descend through the full controller class tree to
           # find a best match ?
-          namespace = controller.class.name.deconstantize.underscore
+          controller.class.name.deconstantize.underscore.to_sym
+        end
+
+        private
+
+        def default_model
+          controller.controller_name.classify&.constantize
+        end
+
+        def all_names
+          @all_names ||= ([record_name] + sti_record_names).compact
+        end
+
+        def all_record_paths
+          @all_record_paths ||= all_names.map { |name| record_path_for(name) }
+        end
+
+        def namespace_prefix
           return nil if namespace.blank?
 
           "#{namespace}_"
         end
 
-        def record_path
+        attr_reader :record, :controller, :type
+
+        def record_path(**kwargs) # rubocop:disable Metrics/AbcSize
           return nil if record.nil?
 
-          controller.helpers.public_send(default_record_path, *path_arguments)
+          controller.helpers.public_send(default_record_path, *path_arguments, **kwargs)
         rescue NoMethodError
-          raise NoMethodError if sti_record_name.nil?
+          raise if sti_record_names.blank?
 
-          controller.helpers.public_send(sti_record_path, *path_arguments)
+          sti_record_names.each do |sti_record_name|
+            return controller.helpers.public_send(record_path_for(sti_record_name), *path_arguments, **kwargs)
+          rescue NoMethodError
+            nil
+          end
+
+          raise
         end
 
         def path_arguments
@@ -57,13 +90,12 @@ module ActiveElement
         end
 
         def default_record_path
+          return record.controller_name.constantize.controller_path.underscore.singularize.tr('/', '_') + '_path' if record.try(:controller_name).present?
           "#{record_path_prefix}#{namespace_prefix}#{record_name}_path"
         end
 
-        def sti_record_path
-          return nil if sti_record_name.nil?
-
-          "#{record_path_prefix}#{namespace_prefix}#{sti_record_name}_path"
+        def record_path_for(name)
+          "#{record_path_prefix}#{namespace_prefix}#{name}_path"
         end
 
         def record_name
@@ -72,10 +104,10 @@ module ActiveElement
           Util.record_name(record)&.pluralize
         end
 
-        def sti_record_name
-          return Util.sti_record_name(record) unless pluralize?
+        def sti_record_names
+          return Util.sti_record_names(record) unless pluralize?
 
-          Util.sti_record_name(record)
+          Util.sti_record_names(record).map(&:pluralize)
         end
 
         def record_path_prefix

data/lib/active_element/components/util.rb

@@ -8,6 +8,7 @@ require_relative 'util/form_field_mapping'
 require_relative 'util/form_value_mapping'
 require_relative 'util/display_value_mapping'
 require_relative 'util/association_mapping'
+require_relative 'util/default_display_value'
 require_relative 'util/decorator'
 require_relative 'util/numeric_field'
 
@@ -23,12 +24,24 @@ module ActiveElement
         record&.try(:model_name)&.try(&:singular) || default_record_name(record)
       end
 
+      # TODO: Remove and use .sti_record_names everywhere instead.
       def self.sti_record_name(record)
         return default_record_name(record) unless record.class.respond_to?(:inheritance_column)
 
         record&.class&.superclass&.model_name&.singular if record&.try(record.class.inheritance_column).present?
       end
 
+      def self.sti_record_names(record) # rubocop:disable Metrics/CyclomaticComplexity
+        record.class.ancestors.select do |ancestor|
+          next false if ancestor == record.class
+          next false if ancestor.try(:inheritance_column).blank?
+          next false unless ancestor < ActiveRecord::Base
+          next false if ancestor.abstract_class?
+
+          true
+        end.map(&:model_name).map(&:singular)
+      end
+
       def self.default_record_name(record)
         (record.is_a?(Class) ? record.name : record.class.name).demodulize.underscore
       end

data/lib/active_element/controller_interface.rb

@@ -38,18 +38,32 @@ module ActiveElement
       state.editable_fields.concat(args.map(&:to_sym)).uniq!
     end
 
-    def searchable_fields(*args)
+    def searchable_fields(*args, required: false)
       state.searchable_fields.concat(args.map(&:to_sym)).uniq!
+      state.search_required = required
     end
 
+    def field_options(field, &block)
+      state.field_options[field] = block
+    end
+    alias field field_options
+
     def deletable
       state.deletable = true
     end
 
+    def model=(model)
+      state.model = model.constantize
+    end
+
     def application_name
       RailsComponent.new(::Rails).application_name
     end
 
+    def t(identifier, **kwargs)
+      ::I18n.t("active_element.#{identifier}", **kwargs)
+    end
+
     def authenticate_with(&block)
       state.authenticator = block
     end

data/lib/active_element/controller_state.rb

@@ -5,9 +5,10 @@ module ActiveElement
   # configuration. Used throughout ActiveElement for generating dynamic content based on
   # controller configuration.
   class ControllerState
-    attr_reader :permissions, :listable_fields, :viewable_fields, :editable_fields, :searchable_fields
+    attr_reader :permissions, :listable_fields, :viewable_fields, :editable_fields, :searchable_fields,
+                :field_options
     attr_accessor :sign_in_path, :sign_in, :sign_in_method, :sign_out_path, :sign_out_method,
-                  :deletable, :authorizor, :authenticator, :list_order
+                  :deletable, :authorizor, :authenticator, :list_order, :search_required, :model
 
     def initialize(controller:)
       @controller = controller
@@ -19,6 +20,8 @@ module ActiveElement
       @viewable_fields = []
       @editable_fields = []
       @searchable_fields = []
+      @field_options = {}
+      @model = nil
     end
 
     def deletable?

data/lib/active_element/default_controller/controller.rb

@@ -116,7 +116,7 @@ module ActiveElement
       end
 
       def model
-        controller.controller_name.classify.constantize
+        state.model || controller.controller_name.classify.constantize
       end
 
       def record

data/lib/active_element/default_controller/params.rb

@@ -33,7 +33,15 @@ module ActiveElement
         scalar, json = controller.active_element.state.editable_fields.partition do |field|
           scalar?(field)
         end
-        scalar + [json_params(json)]
+        scalar + relation_fields + [json_params(json)]
+      end
+
+      def relation_fields
+        controller.active_element.state.editable_fields.map do |field|
+          next nil unless relation?(field)
+
+          relation(field).try(:foreign_key)
+        end.compact
       end
 
       def scalar?(field)