Module: Consent::ModelAdditions::ClassMethods

Defined in:
lib/consent/model_additions.rb

Instance Method Summary collapse

Instance Method Details

#accessible_through(ability, action_or_pair, subject = nil, relation: nil) ⇒ Object

Provides a scope within the model to find instances of the model that are accessible by the given ability through a given relation in the main subject

I.E.:

  Given the following scenario

  class User
    belongs_to :territory
  end

  Consent.define User, "User permissions" do
    view :territory do |user|
      { territory: { id: user.territory_id } }
    end
    view :visible_territories do |user|
      { territory: { id: user.visible_territory_ids } }
    end

    action :contact, views: %i[all no_access territory visible_territories]
  end

This would give you a list of territories that the given ability can
contact their users:

  > user = User.new(territory_id: 13, visible_territory_ids: [2, 3, 4])
  > ability = Consent::Ability.new(user.to_session_user)
  > ability.consent view: :territory, action: :contact, subject: User
  > Territory.accessible_through(ability, :contact, User).to_sql
  => SELECT * FROM territories WHERE id = 13
  > ability.consent view: :visible_territories, action: :contact, subject: User
  > Territory.accessible_through(ability, :contact, User).to_sql
  => SELECT * FROM territories WHERE ((id = 13) OR (id IN (2, 3, 4)))

Parameters:

  • ability (Consent::Ability) —

    ability performing the query

  • action_or_pair (Symbol, String) —

    the name of the action or a subject/action pair

  • subject (Class, Symbol, nil) (defaults to: nil) —

    the subject in which the action is, when action_or_pair is just the action

  • relation (Symbol, Array<Symbol>) (defaults to: nil) —

    the relation or path to the relation



53
54
55
56
57
 
# File 'lib/consent/model_additions.rb', line 53

def accessible_through(ability, action_or_pair, subject = nil, relation: nil)
  relation ||= model_name.element.to_sym
  ability.relation_model_adapter(self, action_or_pair, subject, relation)
         .database_records
end