role_model 0.4.0 → 0.5.0

data/README.rdoc

@@ -25,7 +25,7 @@ It works like this:
   end
   
   #
-  # Test drive
+  # Test drive (check the RDoc or source for additional finesse)
   #
 
   >> u = User.new
@@ -41,6 +41,10 @@ It works like this:
   
   # querying roles...
 
+  # get all valid roles that have been declared
+  >> User.valid_roles
+  => [:admin, :manager, :author]
+  
   # ... retrieve all assigned roles
   >> u.roles # aliased to role_symbols for DeclarativeAuthorization
   => [:admin, :manager]
@@ -49,6 +53,13 @@ It works like this:
   >> u.has_role? :author  # has_role? is also aliased to is?
   => false
 
+  # ... check for multiple roles
+  >> u.has_any_role? :author, :manager  # has_any_role? is also aliased to is_any_of?
+  => true
+
+  >> u.has_all_roles? :author, :manager  # has_all_roles? is also aliased to is?
+  => false
+
   # see the internal bitmask representation (3 = 0b0011)
   >> u.roles_mask
   => 3

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.0

data/lib/role_model/implementation.rb

@@ -10,13 +10,39 @@ module RoleModel
     def roles
       Roles.new(self, self.class.valid_roles.reject { |r| ((self.send(self.class.roles_attribute_name) || 0) & 2**self.class.valid_roles.index(r)).zero? })
     end
-    alias role_symbols roles
+    alias_method :role_symbols, :roles
 
-    # check if a given role has been assigned
-    def has_role?(role)
-      roles.include?(role.to_sym)
+    # :call-seq:
+    #   has_all_roles?(:role)
+    #   has_all_roles?('role')
+    #   has_all_roles?(:role_1, ..., :role_n)
+    #   has_all_roles?('role_1', ..., 'role_n')
+    #   has_all_roles?([:role_1, ..., :role_n])
+    #   has_all_roles?(['role_1', ..., 'role_n'])
+    #
+    # check if ALL of the given roles have been assigned 
+    # this method is aliased as #is? and #has_roles?
+    def has_all_roles?(*roles)
+      roles.flatten.map { |r| r.to_sym }.all? { |r| self.roles.include?(r) }
     end
-    alias is? has_role?
+    alias_method :is?, :has_all_roles?
+    alias_method :has_roles?, :has_all_roles?
+
+    # :call-seq:
+    #   has_any_role?(:role)
+    #   has_any_role?('role')
+    #   has_any_role?(:role_1, ..., :role_n)
+    #   has_any_role?('role_1', ..., 'role_n')
+    #   has_any_role?([:role_1, ..., :role_n])
+    #   has_any_role?(['role_1', ..., 'role_n'])
+    #
+    # check if any (at least ONE) of the given roles have been assigned
+    # this method is aliased as #is_any_of? and #has_role?
+    def has_any_role?(*roles)
+      roles.flatten.map { |r| r.to_sym }.any? { |r| self.roles.include?(r) }
+    end
+    alias_method :is_any_of?, :has_any_role?
+    alias_method :has_role?, :has_any_role?
 
   end
 end

data/role_model.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{role_model}
-  s.version = "0.4.0"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Martin Rehfeld"]
-  s.date = %q{2010-08-07}
+  s.date = %q{2010-08-17}
   s.description = %q{Ever needed to assign roles to a model, say a User, and build conditional behaviour on top of that? Enter RoleModel -- roles have never been easier! Just declare your roles and you are done. Assigned roles will be stored as a bitmask.}
   s.email = %q{martin.rehfeld@glnetworks.de}
   s.extra_rdoc_files = [

data/spec/role_model_spec.rb

@@ -180,27 +180,96 @@ describe RoleModel do
     end
   end
 
-  [:has_role?, :is?].each do |check_role_assignment_method|
-    describe "##{check_role_assignment_method}" do
-      subject { model_class.new }
+  context "query for an individual role" do
+    [:has_any_role?, :is_any_of?, :has_role?, :has_all_roles?, :is?, :has_roles?].each do |check_role_assignment_method|
+      describe "##{check_role_assignment_method}" do
+        subject { model_class.new }
+
+        it "should return true when the given role was assigned" do
+          subject.roles = :foo
+          subject.send(check_role_assignment_method, :foo).should be_true
+        end
 
-      it "should return true when the given role was assigned" do
-        subject.roles = :foo
-        subject.send(check_role_assignment_method, :foo).should be_true
-      end
+        it "should return false when the given role was not assigned" do
+          subject.roles = :bar
+          subject.send(check_role_assignment_method, :foo).should be_false
+        end
 
-      it "should return false when the given role was not assigned" do
-        subject.roles = :bar
-        subject.send(check_role_assignment_method, :foo).should be_false
+        it "should return false when no role was assigned" do
+          subject.send(check_role_assignment_method, :foo).should be_false
+          subject.send(check_role_assignment_method, :bar).should be_false
+        end
+
+        it "should return false when asked for an undefined role" do
+          subject.send(check_role_assignment_method, :baz).should be_false
+        end
       end
+    end
+  end
+
+  context "query for multiple roles" do
+    [:has_any_role?, :is_any_of?, :has_role?].each do |check_role_assignment_method|
+      describe "##{check_role_assignment_method}" do
+        subject { model_class.new }
+
+        it "should return true when the given role was assigned" do
+          subject.roles = :foo
+          subject.send(check_role_assignment_method, :foo).should be_true
+        end
+
+        it "should return true when any of the given roles was assigned" do
+          subject.roles = :foo
+          subject.send(check_role_assignment_method, :foo, :bar).should be_true
+        end
+
+        it "should return false when the given role was not assigned" do
+          subject.roles = :bar
+          subject.send(check_role_assignment_method, :foo).should be_false
+        end
+
+        it "should return false when no role was assigned" do
+          subject.send(check_role_assignment_method, :foo).should be_false
+          subject.send(check_role_assignment_method, :bar).should be_false
+        end
 
-      it "should return false when no role was assigned" do
-        subject.send(check_role_assignment_method, :foo).should be_false
-        subject.send(check_role_assignment_method, :bar).should be_false
+        it "should return false when asked for an undefined role" do
+          subject.send(check_role_assignment_method, :baz).should be_false
+        end
       end
+    end
 
-      it "should return false when asked for an undefined role" do
-        subject.send(check_role_assignment_method, :baz).should be_false
+    [:has_all_roles?, :is?, :has_roles?].each do |check_role_assignment_method|
+      describe "##{check_role_assignment_method}" do
+        subject { model_class.new }
+
+        it "should return true when the given role was assigned" do
+          subject.roles = :foo
+          subject.send(check_role_assignment_method, :foo).should be_true
+        end
+
+        it "should return true when all of the given roles was assigned" do
+          subject.roles = [:foo, :bar]
+          subject.send(check_role_assignment_method, :foo, :bar).should be_true
+        end
+
+        it "should return false when not all of the given roles were assigned" do
+          subject.roles = [:foo, :bar]
+          subject.send(check_role_assignment_method, :bar, :baz).should be_false
+        end
+
+        it "should return false when the given role was not assigned" do
+          subject.roles = :bar
+          subject.send(check_role_assignment_method, :foo).should be_false
+        end
+
+        it "should return false when no role was assigned" do
+          subject.send(check_role_assignment_method, :foo).should be_false
+          subject.send(check_role_assignment_method, :bar).should be_false
+        end
+
+        it "should return false when asked for an undefined role" do
+          subject.send(check_role_assignment_method, :baz).should be_false
+        end
       end
     end
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: role_model
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 11
   prerelease: false
   segments: 
   - 0
-  - 4
+  - 5
   - 0
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Martin Rehfeld
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-07 00:00:00 +02:00
+date: 2010-08-17 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency