Introduce `decorate` field option

[Paul-Bob]

Context

The format_using option is useful for formatting the output of a field, but it applies to both display and edit views. This often requires conditional logic to ensure proper behavior in different contexts. For example:

field :item, as: :text, format_using: -> {
  view.display? ? link_to(value, record.item_link, target: "_blank") : value
}

To simplify this, lets introduce a decorate option. This would function similarly to format_using, but only apply to display views (e.g., Show and Index), keeping the edit form unaffected.

With decorate, the same behavior could be achieved more cleanly:

field :item, as: :text, decorate: -> {
  link_to(value, record.item_link, target: "_blank")
}

[enderahmetyurt]

Hey @adrianthedev I can take it if sounds good for you 🙏

[Paul-Bob]

Thank you @enderahmetyurt !

[enderahmetyurt]

Cheers @Paul-Bob I'd like to ask to be clear here. do we refactor all format_using to decorate in the codebase?

[Paul-Bob]

do we refactor all format_using to decorate in the codebase?

There is no need to touch format_using

Let's introduce this new decorate option that behaves exactly like format_using but only on display views (index and show)

[enderahmetyurt]

I didn't find how I can start. Could you give some examples?

[Paul-Bob]

Sure @enderahmetyurt

Let's start by adding a new decorate option on base field like we do with format_using and update_using:

• https://github.com/avo-hq/avo/blob/main/lib/avo/fields/base_field.rb#L73

Then after format_using block is executed we can execute the decorate one:

• https://github.com/avo-hq/avo/blob/main/lib/avo/fields/base_field.rb#L173

        # Run the value through resolver if present
        if format_using.present?
          final_value = Avo::ExecutionContext.new(
            target: format_using,
            value: final_value,
            record: record,
            resource: resource,
            view: view,
            field: self,
            include: self.class.included_modules
          ).handle
        end

        if @decorate.present? && view.display?
          final_value = Avo::ExecutionContext.new(
            target: @decorate,
            value: final_value,
            record: record,
            resource: resource,
            view: view,
            field: self,
            include: self.class.included_modules
          ).handle
        end