Support for virtual fields

lib/administrate/field/base.rb

@@ -34,10 +34,10 @@ def self.permitted_attribute(attr, _options = nil)
 
       def initialize(attribute, data, page, options = {})
         @attribute = attribute
-        @data = data
         @page = page
         @resource = options.delete(:resource)
         @options = options
+        @data = read_value(data)
       end
 
       def html_class
@@ -52,6 +52,20 @@ def name
         attribute.to_s
       end
 
+      def read_value(data = nil)
+        if options.key?(:getter)
+          if options[:getter].respond_to?(:call)
+            options[:getter].call(self)
+          else
+            resource.try(options[:getter])
+          end
+        elsif data.nil?
+          resource.try(attribute)
+        else
+          data
+        end
+      end
+
       def to_partial_path
         "/fields/#{self.class.field_type}/#{page}"
       end

lib/administrate/field/deferred.rb

@@ -21,6 +21,10 @@ def ==(other)
           options == other.options
       end
 
+      def getter
+        options.fetch(:getter, nil)
+      end
+
       def associative?
         deferred_class.associative?
       end
@@ -57,6 +61,10 @@ def permitted_attribute(attr, opts = {})
         end
       end
 
+      def read_value(resource, attribute_name)
+        @deferred_class.read_value(resource, attribute_name, options)
+      end
+
       delegate :html_class, to: :deferred_class
     end
   end

lib/administrate/page/base.rb

@@ -30,13 +30,8 @@ def item_associations
       private
 
       def attribute_field(dashboard, resource, attribute_name, page)
-        value = get_attribute_value(resource, attribute_name)
         field = dashboard.attribute_type_for(attribute_name)
-        field.new(attribute_name, value, page, resource: resource)
-      end
-
-      def get_attribute_value(resource, attribute_name)
-        resource.public_send(attribute_name)
+        field.new(attribute_name, nil, page, resource: resource)
       end
 
       attr_reader :dashboard, :options

spec/example_app/app/dashboards/customer_dashboard.rb

@@ -8,6 +8,10 @@ class CustomerDashboard < Administrate::BaseDashboard
     email_subscriber: Field::Boolean,
     lifetime_value: Field::Number.with_options(prefix: "$", decimals: 2),
     name: Field::String,
+    nickname: Field::String.with_options(
+      getter: ->(field) { "Mr. #{field.resource.name}man" if field.resource.name.present? },
+      searchable: false
+    ),
     orders: Field::HasMany.with_options(limit: 2, sort_by: :id),
     log_entries: Field::HasManyVariant.with_options(limit: 2, sort_by: :id),
     updated_at: Field::DateTime,

spec/example_app/app/dashboards/order_dashboard.rb

@@ -10,6 +10,19 @@ class OrderDashboard < Administrate::BaseDashboard
     address_city: Field::String,
     address_state: Field::String,
     address_zip: Field::String,
+    full_address: Field::String.with_options(
+      getter: ->(field) {
+        r = field.resource
+        [
+          r.address_line_one,
+          r.address_line_two,
+          r.address_city,
+          r.address_state,
+          r.address_zip
+        ].compact.join("\n")
+      },
+      searchable: false
+    ),
     customer: Field::BelongsTo.with_options(order: "name"),
     line_items: Field::HasMany.with_options(
       collection_attributes: %i[product quantity unit_price total_price]
@@ -29,7 +42,7 @@ class OrderDashboard < Administrate::BaseDashboard
   COLLECTION_ATTRIBUTES = [
     :id,
     :customer,
-    :address_state,
+    :full_address,
     :total_price,
     :line_items,
     :shipped_at
@@ -50,8 +63,11 @@ class OrderDashboard < Administrate::BaseDashboard
       address_zip
     ]
   }.freeze
-  SHOW_PAGE_ATTRIBUTES = FORM_ATTRIBUTES.merge(
-    "" => %i[customer created_at updated_at],
-    "details" => %i[line_items total_price shipped_at payments]
-  ).freeze
+  SHOW_PAGE_ATTRIBUTES = FORM_ATTRIBUTES
+    .except("address")
+    .merge(
+      "" => %i[customer full_address created_at updated_at],
+      "details" => %i[line_items total_price shipped_at payments]
+    )
+    .freeze
 end

spec/lib/fields/base_spec.rb

@@ -167,4 +167,34 @@
       expect(field.required?).to eq(false)
     end
   end
+
+  describe "read_value" do
+    it "reads the value from the resource" do
+      resource = double(attribute: "value")
+      field = field_class.new(:attribute, :date, :page, resource: resource)
+
+      expect(field.read_value).to eq("value")
+    end
+
+    it "reads the value from the resource with a custom getter" do
+      resource = double(custom_getter: "value")
+      field = field_class.new(:attribute, :date, :page, resource: resource, getter: :custom_getter)
+
+      expect(field.read_value).to eq("value")
+    end
+
+    it "reads the value from the resource with a custom getter block" do
+      resource = double("Model", custom_getter: "value")
+      field = field_class.new(:attribute, :date, :page, resource: resource, getter: ->(field) { field.resource.custom_getter })
+
+      expect(resource).to receive(:custom_getter)
+      expect(field.read_value).to eq("value")
+    end
+
+    it "returns nil if the resource is nil" do
+      field = field_class.new(:attribute, :date, :page, resource: nil)
+
+      expect(field.read_value).to eq(nil)
+    end
+  end
 end

spec/lib/fields/virtual_field_spec.rb

@@ -0,0 +1,37 @@
+require "rails_helper"
+require "administrate/field/base"
+
+module Administrate
+  module Field
+    class VirtualField < Field::Base
+      def self.searchable?
+        false
+      end
+
+      def read_value(data = nil)
+        resource.inspect
+      end
+
+      def foobar
+        "This is a Foobar: #{data}"
+      end
+    end
+  end
+end
+
+describe Administrate::Field::VirtualField do
+  describe "#foobar" do
+    it "displays the foobar" do
+      resource = double("Model", inspect: "Inspecting")
+
+      field = Administrate::Field::VirtualField.new(
+        :virtual_field,
+        nil,
+        :show,
+        resource: resource
+      )
+
+      expect(field.foobar).to eq("This is a Foobar: Inspecting")
+    end
+  end
+end