rolypoly 0.0.5 → 0.1.0

data/README.md

@@ -23,7 +23,7 @@ $> bundle
 
 ```ruby
 class ApplicationController < ActionController::Base
-  def current_roles
+  def current_user_roles
     current_user.roles
   end
 
@@ -57,6 +57,7 @@ class UsersController < ApplicationController
 
   # Make action public
   restrict(:landing).to_none
+  # OR
   publicize :landing
 
   def landing
@@ -66,6 +67,30 @@ class UsersController < ApplicationController
   # Give up and make all public
   all_public
 end
+
+# Want some more complex role handling?
+class ProfilesController < ApplicationController
+  allow(:admin).to_access(:index)
+  allow(:owner).to_access(:edit)
+  publicize(:show)
+
+  def index
+    current_roles # => [#<SomeCustomRoleObject to_role_string: "admin", filters: [...]>]
+  end
+
+  def edit # Raises permission error before entering this
+    current_roles # => []
+  end
+
+  def show
+    current_roles # => []
+  end
+
+  def current_user_roles
+    current_user.roles # => [#<SomeCustomRoleObject to_role_string: "admin", filters: [...]>, #<SomeCustomRoleObject to_role_string: "scorekeeper", filters: [...]>]
+  end
+  private :current_user_roles
+end
 ```
 
 ## Contributing

data/lib/rolypoly/controller_role_dsl.rb

@@ -14,8 +14,8 @@ module Rolypoly
         end
       end
 
-      unless sub.method_defined? :current_roles
-        define_method(:current_roles) { [] }
+      unless sub.method_defined? :current_user_roles
+        define_method(:current_user_roles) { [] }
       end
       sub.send :extend, ClassMethods
       sub.class_eval do # Sometimes get Stack Too Deep errors if in ClassMethods
@@ -34,6 +34,27 @@ module Rolypoly
       raise Rolypoly::FailedRoleCheckError
     end
 
+    def current_roles
+      return [] if rolypoly_gatekeepers.empty?
+      current_gatekeepers.reduce([]) { |array, gatekeeper|
+        if gatekeeper.role? current_user_roles
+          array += Array(gatekeeper.allowed_roles(current_user_roles, action_name))
+        end
+        array
+      }
+    end
+
+    def public?
+      return true if rolypoly_gatekeepers.empty?
+      current_gatekeepers.any &:public?
+    end
+
+    def current_gatekeepers
+      rolypoly_gatekeepers.select { |gatekeeper|
+        gatekeeper.action? action_name
+      }
+    end
+
     def rolypoly_role_access?
       rolypoly_gatekeepers.empty? ||
         rolypoly_gatekeepers.any? { |gatekeeper|

data/lib/rolypoly/role_gatekeeper.rb

@@ -1,6 +1,7 @@
 require 'set'
 module Rolypoly
   class RoleGatekeeper
+    attr_reader :roles
     def initialize(roles, actions)
       self.roles = Set.new Array(roles).map(&:to_s)
       self.actions = Set.new Array(actions).map(&:to_s)
@@ -35,28 +36,48 @@ module Rolypoly
         role?(current_roles)
     end
 
+    def allowed_roles(current_roles, action)
+      return [] if public? || !action?(action)
+      match_roles(current_roles)
+    end
+
     def all_public
       self.public = true
       self.all_actions = true
     end
 
-    protected # self.attr= gets mad
-    attr_accessor :roles
-    attr_accessor :actions
-    attr_accessor :all_actions
-    attr_accessor :public
-
     def role?(check_roles)
-      check_roles = Set.new Array(check_roles).map(&:to_s)
+      check_roles = Set.new sanitize_role_input(check_roles)
       public? || !(check_roles & roles).empty?
     end
-    private :role?
 
     def action?(check_actions)
       check_actions = Set.new Array(check_actions).map(&:to_s)
       all_actions? || !(check_actions & actions).empty?
     end
-    private :action?
+
+    protected # self.attr= gets mad
+    attr_writer :roles
+    attr_accessor :actions
+    attr_accessor :all_actions
+    attr_accessor :public
+
+    def match_roles(check_roles)
+      check_roles.reduce([]) { |array, role_object|
+        array << role_object if roles.include?(sanitize_role_object(role_object))
+        array
+      }
+    end
+    private :match_roles
+
+    def sanitize_role_input(role_objects)
+      Array(role_objects).map { |r| sanitize_role_object(r) }
+    end
+    private :sanitize_role_input
+
+    def sanitize_role_object(role_object)
+      role_object.respond_to?(:to_role_string) ? role_object.to_role_string : role_object.to_s
+    end
 
     def can_set_with_to?
       roles.empty?

data/lib/rolypoly/version.rb

@@ -1,3 +1,3 @@
 module Rolypoly
-  VERSION = "0.0.5"
+  VERSION = "0.1.0"
 end

data/spec/lib/rolypoly/controller_role_dsl_spec.rb

@@ -1,4 +1,9 @@
 require 'spec_helper'
+class RoleObject < Struct.new :name
+  def to_s
+    name.to_s
+  end
+end
 module Rolypoly
   describe ControllerRoleDSL do
     let(:example_controller) do
@@ -14,11 +19,11 @@ module Rolypoly
     describe "setting up with DSL" do
       describe "from allow side" do
         let(:controller_instance) { subject.new }
-        let(:current_roles) { [:admin] }
+        let(:current_user_roles) { [RoleObject.new(:admin), RoleObject.new(:scorekeeper)] }
         before do
           subject.allow(:admin).to_access(:index)
           subject.publicize(:landing)
-          controller_instance.stub current_roles: current_roles, action_name: action_name
+          controller_instance.stub current_user_roles: current_user_roles, action_name: action_name
         end
 
         describe "#index" do
@@ -27,6 +32,9 @@ module Rolypoly
             expect { controller_instance.rolypoly_check_role_access! }
             .not_to raise_error
           end
+          it "can get current_roles from controller" do
+            controller_instance.current_roles.should == [RoleObject.new(:admin)]
+          end
         end
 
         describe "#show" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rolypoly
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-25 00:00:00.000000000 Z
+date: 2013-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -97,7 +97,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1102617344684518140
+      hash: -3998777984339591811
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -106,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1102617344684518140
+      hash: -3998777984339591811
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25