ruby-grape / ruby-grape/grape-entity

how to call includes method before expose

Open
#266 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Ruby
Stars
729
Forks
154
PR merge metrics
No merged PRs in 30d

Description

I use grape entity in below way. And got a n+1 warning in expose :roles methods. I need know how can I call includes(:roles) methods before exposed. Thks!

Model
class User
  has_many :roles
end

class Role
   belongs_to :user
end
Entity
class User < Grape::Entity
  expose :roles do |obj, _opts|
    obj.roles.map(&:name)
  end
end

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Grape::Entity expose :roles example and the reported includes(:roles) usage, then reproduce the N+1 warning with the User and Role models shown. Determine whether the project needs usage documentation or a code change, and consider the work done when the supported approach avoids the warning.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
api
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.