Class: Cannie::Rule

Inherits:

Object

• Object
• Cannie::Rule

Defined in:

lib/cannie/rule.rb

Instance Attribute Summary

• #action ⇒ Object readonly

  Returns the value of attribute action.

• #subject ⇒ Object readonly

  Returns the value of attribute subject.

Instance Method Summary

• #applies_to?(permissions) ⇒ Boolean

  Checks whether rule is applied to permissions passed as an argument.

• #initialize(action, subject, options = {}) ⇒ Rule constructor

  Initializes new rule.

Constructor Details

#initialize(action, subject, options = {}) ⇒ Rule

Initializes new rule

Parameters:

• action (Symbol) —

  action which should be permitted on subject

• subject (String, Symbol) —

  subject of the rule

• options (Hash) (defaults to: {}) —

  additional options and conditions for the new rule

Options Hash (options):

• :if (Proc) —

  condition which is checked for a particular Permissions object and should be evaluated to true

• :unless (Proc) —

  condition which is checked for a particular Permissions object and should be evaluated to false

# File 'lib/cannie/rule.rb', line 14

def initialize(action, subject, options = {})
  @action, @subject, @_if, @_unless = action, subject, *options.values_at(:if, :unless)
end

Instance Attribute Details

#action ⇒ Object (readonly)

Returns the value of attribute action.

# File 'lib/cannie/rule.rb', line 3

def action
  @action
end

#subject ⇒ Object (readonly)

Returns the value of attribute subject.

# File 'lib/cannie/rule.rb', line 3

def subject
  @subject
end

Instance Method Details

#applies_to?(permissions) ⇒ Boolean

Checks whether rule is applied to permissions passed as an argument

Parameters:

• permissions (Cannie::Permissions)

Returns:

• (Boolean)

# File 'lib/cannie/rule.rb', line 22

def applies_to?(permissions)
  if?(permissions) && unless?(permissions)
end