roles_generic 0.3.5 → 0.3.6

data/README.textile

@@ -1,10 +1,12 @@
 h1. Generic Roles
 
-*Generic Roles* is a generic Roles API implementation that specific ORM Roles implementations can implement.
-This way you can easily change ORM and still keep the same underlying API.
+*Generic Roles* (or simply Roles) is a generic Roles API implementation that specific ORM Roles implementations can implement.
+This way you can easily change ORM and still keep using the same underlying API.
 
 A Rails 3 generator is included that can configure an existing User model with a generic Role strategy of choice.
-Each ORM Roles implementation should have a similar generator for that particular ORM. 
+Each ORM Roles implementation should have its own generator suited for that particular ORM.
+
+Since Jan. 2011, Roles now includes a Group API that allows ordering roles into groups (see below).  
 
 h2. Roles ORM implementations
 
@@ -37,8 +39,6 @@ h2. Role strategy configuration
 
 The following demonstrates some examples of role strategy configuration.
 
-_Note_: The DSL has been optimized a bit lately (Dec. 25)
-
 h3. Strategy: admin_flag
 
 Example: Default model configuration:
@@ -103,12 +103,49 @@ Embedded Role model (Document stores only):
 
 Currently the embedded strategies have only been implemented for Mongoid.
 
-h2. Role API
+See "Roles strategy configuration":https://github.com/kristianmandrup/roles_generic/wiki/Roles-strategy-configuration for more info
+
+h2. Roles APIs
 
 The full Roles API is described in these Wiki pages:
 
 * "Roles-Read-API":https://github.com/kristianmandrup/roles_generic/wiki/Roles-Read-API
 * "Roles-Write-API":https://github.com/kristianmandrup/roles_generic/wiki/Roles-Write-API
+* "Roles-Group-API":https://github.com/kristianmandrup/roles_generic/wiki/Roles-Group-API
+
+h3. Using Roles Groups
+
+The Group API allows roles to be grouped.
+
+Example:
+
+Say you have the _admin_ roles:
+
+* Admin
+* Super admin
+
+And the _customer_ roles
+
+* Individual customer
+* Company customer
+
+You might want to group them like this: 
+
+<pre>
+  User.add_role_group :customers => [:individual_customer, :company_customer]
+  User.add_role_group :admins => [:admin, :super_admin]  
+</pre>
+
+Then you can handle any user with regards to his/her role group relationship like this:
+
+<pre>
+  # do this only for users in the admin role group (user has either :admin or :super_admin role) 
+  current_user.is_in_group? :admin do
+    ...
+  end
+</pre>
+
+Expect this functionality to soon to be wrapped by Cream helper methods as well ;)
 
 h2. Note on Patches/Pull Requests
  

data/VERSION

@@ -1 +1 @@
-0.3.5
+0.3.6

data/lib/roles_generic/base.rb

@@ -1,6 +1,7 @@
 module Roles
   module Base
     attr_accessor :orm_name
+    
     attr_reader :role_strategy
 
     def valid_roles_are(*role_list)

data/lib/roles_generic/generic/user/implementation.rb

@@ -42,9 +42,34 @@ module Roles::Generic::User
       exchange_roles role, options
     end
 
-    # check if a given role has been assigned 
-    # if a list of roles: check if ALL of the given roles have been assigned 
+    # is_in_group? :admin
+    def is_in_group? group
+      raise ArgumentError, 'Group id must be a String or Symbol' if !group.kind_of_label?
+      group_roles = self.class.role_groups[group]
+      # puts "group_roles: #{group_roles} for group: #{group}"
+      # puts "roles_list: #{roles_list}"
+      !(group_roles & roles_list).empty?
+    end
+
+    # is_in_groups? :editor, :admin, 
+    def is_in_groups? *groups
+      groups = groups.flat_uniq
+      groups.all? {|group| is_in_group? group}
+    end
+
+    def is_in_any_group? *groups
+      groups = groups.flat_uniq
+      groups.any? {|group| is_in_group? group}
+    end
+
+    # check if all of the roles listed have been assigned to that user 
     def has_roles?(*roles_names)
+      compare_roles = extract_roles(roles_names.flat_uniq)
+      (compare_roles - roles_list).empty?      
+    end
+
+    # check if any of the roles listed have been assigned to that user
+    def has_any_role?(*roles_names)
       compare_roles = extract_roles(roles_names.flat_uniq)
       (roles_list & compare_roles).not.empty?      
     end

data/lib/roles_generic/generic/user.rb

@@ -17,8 +17,6 @@ module Roles::Generic
               roles_attribute options[:attribute] 
               return
             end
-
-            puts "default: #{default_options? options}, att: #{default_role_attribute}"
             roles_attribute default_role_attribute if default_options? options
           end
           

data/lib/roles_generic/generic.rb

@@ -5,6 +5,7 @@ module Roles
     def self.included(base) 
       base.extend Roles::Base
       base.extend ClassMethods
+      
       base.orm_name = :generic
     end
 
@@ -24,6 +25,11 @@ module Roles
         :embed_many_roles   => "attr_accessor :many_roles",
         :embed_one_role     => "attr_accessor :one_role"        
       }
+
+      attr_accessor :role_groups
+      def role_groups
+        @role_groups ||= {}
+      end
       
       def strategy name, options = {}
         strategy_name = name.to_sym
@@ -44,6 +50,29 @@ module Roles
         
         set_role_strategy name, options
       end    
+
+      def add_role_groups(groups_hash)
+        raise ArgumentError, "Role group must be passed a Hash where the key is the group name" if !groups_hash.kind_of? Hash
+        groups_hash.each_pair do |key, list|
+          add_role_group(key => list)
+        end
+      end
+
+      # role_group :admin => :admin, :super_admin 
+      def add_role_group(group_hash)
+        raise ArgumentError, '#add_role_group must be passed a Hash where the key is the group name' if !group_hash.kind_of? Hash
+        raise ArgumentError, '#add_role_group must be a Hash with a single key value pair' if group_hash.size > 1
+
+        # first key/value pair?
+        group = group_hash.keys.first # see sugar_high
+
+        raise ArgumentError, "Role group identifier must be a String or Symbol " if !group.kind_of_label?      
+        role_list = group_hash.values.first
+        hash = {group.to_sym => [role_list].flat_uniq.to_symbols}
+
+        role_groups.merge!(hash)
+      end
+
       
       private
 

data/lib/roles_generic/role.rb

@@ -1,13 +1,4 @@
-module Roles::Base
-  def valid_roles_are(*role_list)
-    strategy_class.valid_roles = role_list.to_symbols
-    if role_class_name
-      role_list.each do |name| 
-        role_class_name.new(name)
-      end
-    end
-  end
-end
+require 'roles_generic/roles_base'
 
 class Role
   attr_accessor :name

data/lib/roles_generic/roles_base.rb

@@ -0,0 +1,11 @@
+module Roles::Base
+  def valid_roles_are(*role_list)
+    strategy_class.valid_roles = role_list.to_symbols
+    if role_class_name
+      role_list.each do |name| 
+        role_class_name.new(name)
+      end
+    end
+  end
+end
+

data/lib/roles_generic/rspec/api/full.rb

@@ -1,5 +1,6 @@
 require "roles_generic/rspec/user_setup"                                           
-# require "roles_generic/rspec/api/write_api"
+require "roles_generic/rspec/api/write_api"
 require "roles_generic/rspec/api/read_api"
-# require "roles_generic/rspec/api/user_class_api"
-# require "roles_generic/rspec/api/completeness"
+require "roles_generic/rspec/api/group_api"
+require "roles_generic/rspec/api/user_class_api"
+require "roles_generic/rspec/api/completeness"

data/lib/roles_generic/rspec/api/group_api.rb

@@ -0,0 +1,51 @@
+class Role
+end
+
+describe 'Roles Generic API : GROUP' do
+  before :each do
+    default_user_setup    
+  end
+
+  describe '#add_group' do
+    it "should add a group with multiple roles" do
+      User.add_role_group(:guests => [:user, :guest]).should be_true
+      User.role_groups[:guests].should include(:user)
+    end
+
+    it "should not add a group using hash of multiple groups" do
+      lambda { User.add_role_group(:guests => [:user, :guest], :editors => :editor) }.should raise_error
+    end
+  end
+
+  describe '#add_groups' do
+    it "should add a group with multiple roles" do
+      User.add_role_groups :guests => [:user, :guest], :editors => :editor
+      User.role_groups[:guests].should include(:user)
+      User.role_groups[:editors].should include(:editor)
+    end
+  end
+  
+  describe '#is_in_group' do
+    it "should be true that the admin user has a valid role of :guest" do      
+      User.add_role_groups :guests => [:user, :guest], :editors => :editor
+      @admin_user.is_in_group?(:editors).should be_false
+      @normal_user.is_in_group?(:guests).should be_true
+    end
+  end
+  
+  describe '#is_in_groups' do
+    it "should be true that the admin user has a valid role of :guest" do      
+      User.add_role_groups :guests => [:user, :guest], :users => :user
+      @admin_user.is_in_groups?(:guests).should be_false
+      @normal_user.is_in_groups?(:guests, :users).should be_true
+    end
+  end
+  
+  describe '#is_in_any_group' do
+    it "should be true that the admin user has a valid role of :guest" do      
+      User.add_role_groups :guests => [:user, :guest], :editors => :editor
+      @admin_user.is_in_any_group?(:guests).should be_false
+      @normal_user.is_in_any_group?(:guests, :editors).should be_true
+    end
+  end  
+end

data/lib/roles_generic/rspec/api/read_api.rb

@@ -51,69 +51,87 @@ describe 'Roles Generic API : READ' do
   end
   
   describe '#has_roles?' do
-    it "should be true that the admin_user has the roles :admin" do      
-      @admin_user.has_roles?(:admin).should be_true
+    it "should be true that the normal user has the roles :guest and :user" do      
+      @normal_user.has_roles?(:guest, :user).should be_true
+    end
+
+    it "should NOT be true that the normal user has the roles :guest and :admin" do      
+      @normal_user.has_roles?(:guest, :admin).should be_false
     end
   
     it "should NOT be true that the user has the roles :admin" do
       @guest_user.has_roles?(:admin).should be_false
     end
   end
+
+  describe '#has_roles?' do
+    it "should be true that the normal user has the roles :guest and :user" do      
+      @normal_user.has_any_role?(:guest, :user).should be_true
+    end
+
+    it "should be true that the normal user has one of the roles :guest or :admin" do      
+      @normal_user.has_any_role?(:guest, :admin).should be_true
+    end
+  
+    it "should NOT be true that the user has the roles :admin" do
+      @guest_user.has_any_role?(:admin).should be_false
+    end
+  end
+  
+  describe '#roles_list' do
+    it "should be true that the first role of admin_user is the :admin role" do      
+      @admin_user.roles_list.should include(:admin)
+    end
   
-  # describe '#roles_list' do
-  #   it "should be true that the first role of admin_user is the :admin role" do      
-  #     @admin_user.roles_list.should include(:admin)
-  #   end
-  # 
-  #   it "should be true that the first role of admin_user is the :user role" do            
-  #     case @normal_user.class.role_strategy.multiplicity
-  #     when :single
-  #       if @normal_user.class.role_strategy.name == :admin_flag
-  #         @normal_user.roles_list.should include(:guest)
-  #       else
-  #         @normal_user.roles_list.should include(:user)
-  #       end
-  #     when :multi
-  #       @normal_user.roles_list.should include(:user, :guest)
-  #     end
-  #   end
-  # end  
-  # 
-  # describe '#roles' do
-  #   it "should be true that the roles of admin_user is an array with the role :admin" do      
-  #     roles = @admin_user.roles
-  #     if roles.kind_of? Role
-  #       roles.name.to_sym.should == :admin
-  #     elsif roles.kind_of? Array
-  #       if @normal_user.class.role_strategy.type == :complex
-  #         # roles.first.name.to_sym.should == :admin
-  #         roles.first.to_sym.should == :admin
-  #       else
-  #         roles.first.to_sym.should == :admin          
-  #       end
-  #     else       
-  #       roles.to_sym.should == :admin
-  #     end
-  #   end
-  # end 
-  # 
-  # describe '#admin?' do    
-  #   it "should be true that admin_user is in the :admin role" do      
-  #     @admin_user.admin?.should be_true
-  #   end
-  # 
-  #   it "should NOT be true that the user is in the :admin role" do      
-  #     @guest_user.admin?.should be_false
-  #   end
-  # end
-  # 
-  # describe '#is?' do          
-  #   it "should be true that admin_user is in the :admin role" do      
-  #     @admin_user.is?(:admin).should be_true
-  #   end
-  # 
-  #   it "should NOT be true that the user is in the :admin role" do      
-  #     @guest_user.is?(:admin).should be_false
-  #   end
-  # end  
+    it "should be true that the first role of admin_user is the :user role" do            
+      case @normal_user.class.role_strategy.multiplicity
+      when :single
+        if @normal_user.class.role_strategy.name == :admin_flag
+          @normal_user.roles_list.should include(:guest)
+        else
+          @normal_user.roles_list.should include(:user)
+        end
+      when :multi
+        @normal_user.roles_list.should include(:user, :guest)
+      end
+    end
+  end  
+  
+  describe '#roles' do
+    it "should be true that the roles of admin_user is an array with the role :admin" do      
+      roles = @admin_user.roles
+      if roles.kind_of? Role
+        roles.name.to_sym.should == :admin
+      elsif roles.kind_of? Array
+        if @normal_user.class.role_strategy.type == :complex
+          # roles.first.name.to_sym.should == :admin
+          roles.first.to_sym.should == :admin
+        else
+          roles.first.to_sym.should == :admin          
+        end
+      else       
+        roles.to_sym.should == :admin
+      end
+    end
+  end 
+  
+  describe '#admin?' do    
+    it "should be true that admin_user is in the :admin role" do      
+      @admin_user.admin?.should be_true
+    end
+  
+    it "should NOT be true that the user is in the :admin role" do      
+      @guest_user.admin?.should be_false
+    end
+  end
+  
+  describe '#is?' do          
+    it "should be true that admin_user is in the :admin role" do      
+      @admin_user.is?(:admin).should be_true
+    end
+  
+    it "should NOT be true that the user is in the :admin role" do      
+      @guest_user.is?(:admin).should be_false
+    end
+  end  
 end

data/roles_generic.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{roles_generic}
-  s.version = "0.3.5"
+  s.version = "0.3.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
-  s.date = %q{2010-12-26}
+  s.date = %q{2011-01-06}
   s.description = %q{Generic role strategies sharing the same API. Easy to insert in any model}
   s.email = %q{kmandrup@gmail.com}
   s.extra_rdoc_files = [
@@ -38,8 +38,10 @@ Gem::Specification.new do |s|
     "lib/roles_generic/generic/user/single_impl.rb",
     "lib/roles_generic/namespaces.rb",
     "lib/roles_generic/role.rb",
+    "lib/roles_generic/roles_base.rb",
     "lib/roles_generic/rspec/api/completeness.rb",
     "lib/roles_generic/rspec/api/full.rb",
+    "lib/roles_generic/rspec/api/group_api.rb",
     "lib/roles_generic/rspec/api/read_api.rb",
     "lib/roles_generic/rspec/api/simple_check.rb",
     "lib/roles_generic/rspec/api/user_class_api.rb",

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 5
-  version: 0.3.5
+  - 6
+  version: 0.3.6
 platform: ruby
 authors: 
 - Kristian Mandrup
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-26 00:00:00 +01:00
+date: 2011-01-06 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -153,8 +153,10 @@ files:
 - lib/roles_generic/generic/user/single_impl.rb
 - lib/roles_generic/namespaces.rb
 - lib/roles_generic/role.rb
+- lib/roles_generic/roles_base.rb
 - lib/roles_generic/rspec/api/completeness.rb
 - lib/roles_generic/rspec/api/full.rb
+- lib/roles_generic/rspec/api/group_api.rb
 - lib/roles_generic/rspec/api/read_api.rb
 - lib/roles_generic/rspec/api/simple_check.rb
 - lib/roles_generic/rspec/api/user_class_api.rb