从父类继承类定义

Question

我正在我的 Rails 模型中构建葡萄实体，如下所述：

https://github.com/ruby-grape/grape-entity#entity-organization

目前我正在根据模型本身的列哈希自动创建默认值。

所以我有一个静态的 get_entity 方法，可以公开所有模型的列：

class ApplicationRecord < ActiveRecord::Base

  def self.get_entity(target)
    self.columns_hash.each do |name, column|
      target.expose name, documentation: { desc: "Col #{name} of #{self.to_s}" }
    end
  end

end

然后我在这里有一个示例 Book 模型，在声明的 Entity 子类中使用它（注释还显示了我如何覆盖模型列之一的文档）：

class Book < ActiveRecord::Base

  class Entity < Grape::Entity
    Book::get_entity(self)
    # expose :some_column, documentation: {desc: "this is an override"}
  end

end

这种方法的缺点是我总是需要在我想要实体的每个模型中复制并粘贴类实体声明。

谁能帮我自动为 ApplicationRecord 的所有子级生成实体类？然后，如果我需要覆盖，我将需要在类中有实体声明，否则如果默认声明足够并且可以保持原样。

注意：

我不能直接在 ApplicationRecord 中添加实体类定义，因为实体类应该调用 get_entity 并且 get_entity 取决于 Books 的 column_hash。

解决方案：

感谢brainbag，最终做到了：

def self.inherited(subclass)
  super
  # definition of Entity
  entity = Class.new(Grape::Entity)
  entity.class_eval do
    subclass.get_entity(entity)
  end
  subclass.const_set "Entity", entity

  # definition of EntityList
  entity_list = Class.new(Grape::Entity)
  entity_list.class_eval do
    expose :items, with: subclass::Entity
    expose :meta, with: V1::Entities::Meta
  end
  subclass.const_set "EntityList", entity_list
end

def self.get_entity(entity)
  model = self
  model.columns_hash.each do |name, column|
    entity.expose name, documentation: { type: "#{V1::Base::get_grape_type(column.type)}", desc: "The column #{name} of the #{model.to_s.underscore.humanize.downcase}" }
  end
end

谢谢！

Answer 1

我没有使用过 Grape，所以这里可能有一些你需要的额外魔法，但我不知道，但这在 Ruby/Rails 中很容易做到。根据您的问题“自动为 ApplicationRecord 的所有子项生成类实体”，您可以这样做：

class ApplicationRecord < ActiveRecord::Base
  self.abstract_class = true

  class Entity < Grape::Entity
    # whatever shared stuff you want
  end
end

然后图书将可以访问父级Entity：

> Book::Entity
=> ApplicationRecord::Entity

如果您只想向Book::Entity 添加额外的代码，您可以在Book 中对其进行子类化，如下所示：

class Book < ApplicationRecord
  class Entity < Entity # subclasses the parent Entity, don't forget this
    # whatever Book-specific stuff you want
  end
end

那么Book::Entity 将是它自己的类。

> Book::Entity
=> Book::Entity

---

要将这与您需要在继承的类上调用 get_entity 结合起来，您可以使用 #inherited 方法在任何时候自动调用 get_entity ApplicationRecord 是子类：

class ApplicationRecord < ActiveRecord::Base
  self.abstract_class = true

  def self.get_entity(target)
    target.columns_hash.each do |name, column|
      target.expose name, documentation: { desc: "Col #{name} of #{self.to_s}" }
    end
  end

  def self.inherited(subclass)
    super
    get_entity(subclass)
  end

  class Entity < Grape::Entity
    # whatever shared stuff you want
  end
end