ruby-on-rails - 如何动态地向 ROAR 代表添加属性？

Question

我正在使用 ROAR 为 Rails 应用程序实现 API。此应用程序处理可以具有主题 和描述 等属性的票证，但也可以具有用户定义的属性。为简单起见，我们假设票证如下所示:

class Ticket
  attr_accessor :subject, :description

  def custom_attributes
    # in reality these attributes depend on the current ticket instance
    # they are not hard-coded into the class
    [['priority', 'high'], ['Operating System', 'Ubuntu']]
  end
end

此类工单所需的 JSON 输出如下所示:

{
  "subject": "Foo",
  "description": "Bar",
  "customField1": "high",
  "customField2": "Ubuntu"
}

现在您可能已经看出问题所在了。所有属性都是根对象的直接子对象，这意味着我不能将其写为代表:

class TicketRepresenter
  property :subject
  property :description

  # Need to iterate over instance members on the class level here...
end

ROAR 是否提供了一些机制来实现这一点？例如。在实际实例的上下文中执行的回调，例如

def call_me_on_write
  represented.custom_attributes.each do |attribute|
    add_property('customField1', attribute[1])
  end
end

在 ROAR 中是否有类似的东西我忽略了以实现此目的？

我在两个文档中都查看了 ROAR和 representable 的文档, 但找不到任何东西。

免责声明

我试图简化实际情况，使问题更具可读性。如果您认为缺少重要信息，请告诉我。谢天谢地，我会提供更多详细信息。

超出范围

请不要讨论选择的 JSON 格式是好是坏，我想评估 ROAR 是否支持它。

Answer 1

我认为解决该问题的最佳方法是使用 Roar 的 writer:。通过将它称为options 的一些值传递给提供的 lambda，它可以完全将对输出的控制权交给您。

例如:

property :desired_property_name, writer: -> (represented:, doc:, **) do
  doc[:desired_key] = represented.desired_value
end

github 自述文件未涵盖但在 Trailblazer 网站上记录了很多用途。这个特别可以在http://trailblazer.to/gems/representable/3.0/function-api.html#writer找到。 .

干杯!