Class: Eaco::DSL::Resource

Inherits:
Base
  • Object
show all
Defined in:
lib/eaco/dsl/resource.rb,
lib/eaco/dsl/resource/permissions.rb

Overview

Parses the Resource definition DSL.

Example:

authorize Document do
  roles :owner, :editor, :reader

  role :owner, 'Author'

  permissions do
    reader   :read
    editor   reader, :edit
    owner    editor, :destroy
  end
end

The DSL installs authorization in your Document model, defining three access roles.

The owner role is given a label of “Author”.

Each role has then different abilities, defined in the permissions block.

See Also:

Defined Under Namespace

Classes: Permissions

Instance Attribute Summary

Attributes inherited from Base

#options, #target

Instance Method Summary collapse

Methods inherited from Base

eval, #target_eval

Constructor Details

#initialize ⇒ Resource

Sets up an authorized resource. The only required API is accessible_by. For available implementations, see the Adapters module.

See Also:



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/eaco/dsl/resource.rb', line 41

def initialize(*)
  super

  target_eval do
    include Eaco::Resource

    def permissions
      @_permissions
    end

    def roles
      @_roles || []
    end

    def roles_priority
      @_roles_priority ||= {}.tap do |priorities|
        roles.each_with_index {|role, idx| priorities[role] = idx }
      end.freeze
    end

    def roles_with_labels
      @_roles_with_labels ||= roles.inject({}) do |labels, role|
        labels.update(role => role.to_s.humanize)
      end
    end

    # Reset memoizations when this method is called on the target class,
    # so that reloading the authorizations configuration file will
    # refresh the models' configuration.
    @_roles_priority = nil
    @_roles_with_labels = nil
  end
end

Instance Method Details

#permissions(&block)

This method returns an undefined value.

Defines the permissions on this resource. The evaluated registries are memoized in the target class.



81
82
83
84
85
 
# File 'lib/eaco/dsl/resource.rb', line 81

def permissions(&block)
  target_eval do
    @_permissions = Permissions.eval(self, &block).result.freeze
  end
end

#role(role, label)

This method returns an undefined value.

Sets the given label on the given role.

TODO rename this method, or use it to pass options to improve readability of the DSL and to store more metadata with each role for future extensibility.

Parameters:

  • role (Symbol)
  • label (String) 


121
122
123
124
125
 
# File 'lib/eaco/dsl/resource.rb', line 121

def role(role, label)
  target_eval do
    roles_with_labels[role] = label
  end
end

#roles(*keys)

This method returns an undefined value.

Defines the roles valid for this resource. e.g.

authorize Foobar do
  roles :owner, :editor, :reader
end

Roles defined first have higher priority.

If the same user is at the same time reader and editor, the resulting role is editor.

Parameters:

  • keys (Variadic) 


103
104
105
106
107
 
# File 'lib/eaco/dsl/resource.rb', line 103

def roles(*keys)
  target_eval do
    @_roles = keys.flatten.freeze
  end
end