role_model 0.5.0 → 0.6.0

data/README.rdoc

@@ -9,12 +9,12 @@ It works like this:
   # given a User class with a roles_mask attribute
   require 'rubygems'
   require 'role_model'
-
+  
   class User
     attr_accessor :roles_mask # in real life this would be an persisted attribute
     
     include RoleModel
-
+    
     # optionally set the integer attribute to store the roles in,
     # :roles_mask is the default
     roles_attribute :roles_mask
@@ -27,20 +27,20 @@ It works like this:
   #
   # Test drive (check the RDoc or source for additional finesse)
   #
-
+  
   >> u = User.new
   => #<User ...>
-
+  
   # role assignment
   >> u.roles = [:admin]  # ['admin'] works as well
   => [:admin]
-
-  # adding roles
+  
+  # adding roles (remove via delete or re-assign)
   >> u.roles << :manager
   => [:admin, :manager]
   
   # querying roles...
-
+  
   # get all valid roles that have been declared
   >> User.valid_roles
   => [:admin, :manager, :author]
@@ -48,21 +48,25 @@ It works like this:
   # ... retrieve all assigned roles
   >> u.roles # aliased to role_symbols for DeclarativeAuthorization
   => [:admin, :manager]
-
+  
   # ... check for individual roles
   >> 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
+  
+  # see the role mask for a certain role(s)
+  >> User.mask_for :admin, :author
+  => 5
 
 Once you have included RoleModel, your model is perfectly fit to be used
 together with a role-based authorization solution, such as

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.6.0

data/lib/role_model/class_methods.rb

@@ -28,5 +28,17 @@ module RoleModel
     def roles(*roles)
       self.valid_roles = Array[*roles].flatten.map { |r| r.to_sym }
     end
+
+    def mask_for(*roles)
+      (Array[*roles].map {|r|
+        r.respond_to?(:each) ? r.to_a : r
+      }.flatten.map { |r|
+        r.to_sym
+      } & valid_roles).map { |r|
+        2**valid_roles.index(r)
+      }.inject { |sum, bitvalue|
+        sum + bitvalue
+      } || 0
+    end
   end
 end

data/lib/role_model/implementation.rb

@@ -3,7 +3,7 @@ module RoleModel
 
     # assign roles
     def roles=(*roles)
-      self.send("#{self.class.roles_attribute_name}=", (Array[*roles].flatten.map { |r| r.to_sym } & self.class.valid_roles).map { |r| 2**self.class.valid_roles.index(r) }.inject { |sum, bitvalue| sum + bitvalue })
+      self.send("#{self.class.roles_attribute_name}=", self.class.mask_for(*roles))
     end
 
     # query assigned roles

data/lib/role_model/roles.rb

@@ -4,14 +4,22 @@ module RoleModel
   class Roles < ::Set # :nodoc:
     attr_reader :model_instance
 
-    def initialize(sender, *roles)
-      super(*roles)
+    def initialize(sender, roles)
+      super(roles)
       @model_instance = sender
     end
 
-    def <<(role)
-      model_instance.roles = super.to_a
+    def add(role)
+      roles = super
+      model_instance.roles = roles if model_instance
       self
     end
+    alias_method :<<, :add
+
+    def delete(role)
+      model_instance.roles = super(role.to_sym)
+      self
+    end
+
   end
 end

data/role_model.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{role_model}
-  s.version = "0.5.0"
+  s.version = "0.6.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-17}
+  s.date = %q{2010-10-10}
   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

@@ -126,6 +126,13 @@ describe RoleModel do
         subject.roles.should include(:bar)
         subject.should have(1).roles
       end
+
+      it "should allow reassigning the #roles value aka Roles object" do
+        subject.roles << :bar
+        subject.roles = subject.roles
+        subject.roles.should include(:foo, :bar)
+        subject.should have(2).roles
+      end
     end
   end
 
@@ -180,6 +187,47 @@ describe RoleModel do
     end
   end
 
+  describe "#delete" do
+    subject { model_class.new }
+
+    context "with roles :foo and :bar already assigned" do
+      before(:each) do
+        subject.roles = [:foo, :bar]
+      end
+
+      it "should delete a existing role given as a symbol" do
+        subject.roles.delete(:foo)
+        subject.roles.should_not include(:foo)
+        subject.should have(1).roles
+      end
+
+      it "should delete a existing role given as a string" do
+        subject.roles.delete('foo')
+        subject.roles.should_not include(:foo)
+        subject.should have(1).roles
+      end
+
+      it "should not change anything if a non existing role is given" do
+        subject.roles.delete(:third)
+        subject.roles.should include(:foo, :bar)
+        subject.should have(2).roles
+      end
+    end
+    
+    context "without roles assigned" do
+      it "should have 0 roles if a role is given as a symbol" do
+        subject.roles.delete(:foo)
+        subject.should have(0).roles
+      end
+
+      it "should have 0 roles if a role is given as a string" do
+        subject.roles.delete('foo')
+        subject.should have(0).roles
+      end
+    end
+
+  end
+
   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
@@ -212,28 +260,14 @@ describe RoleModel do
       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.roles = [:foo, :baz]
           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 asked for an undefined role" do
-          subject.send(check_role_assignment_method, :baz).should be_false
+        it "should return false when none of the given roles were assigned" do
+          subject.roles = [:foo, :bar]
+          subject.send(check_role_assignment_method, :baz, :quux).should be_false
         end
       end
     end
@@ -242,33 +276,19 @@ describe RoleModel do
       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
+        it "should return true when all of the given roles were 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
+        it "should return false when only some 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
+        it "should return false when none of the given roles were assigned" do
+          subject.roles = [:foo, :bar]
+          subject.send(check_role_assignment_method, :baz, :quux).should be_false
         end
       end
     end
@@ -346,4 +366,45 @@ describe RoleModel do
     end
   end
 
+  describe ".mask_for" do
+    subject { model_class.new }
+
+    before(:each) do
+      model_class.instance_eval do
+        attr_accessor :roles_mask
+        attr_accessor :custom_roles_mask
+        include RoleModel
+        roles :foo, :bar, :third
+      end
+    end
+
+    context "passing" do
+      it "should return the role mask of a role" do
+        subject.class.mask_for(:foo).should == 1
+        subject.class.mask_for(:bar).should == 2
+        subject.class.mask_for(:third).should == 4
+      end
+
+      it "should return the role mask of an array of roles" do
+        subject.class.mask_for(:foo, :bar).should == 3
+        subject.class.mask_for(:foo, :third).should == 5
+        subject.class.mask_for(:foo, :bar, :third).should == 7
+      end
+
+      it "should return the role mask of a string array of roles" do
+        subject.class.mask_for("foo").should == 1
+        subject.class.mask_for("foo", "bar").should == 3
+        subject.class.mask_for("foo", "third").should == 5
+      end
+
+      it "should return the role mask of the existing roles" do
+        subject.class.mask_for(:foo, :quux).should == 1
+      end
+
+      it "should return 0 when a role that does not exist is passed" do
+        subject.class.mask_for(:quux).should == 0
+      end
+    end
+  end
+
 end

data/spec/roles_spec.rb

@@ -5,6 +5,9 @@ describe RoleModel::Roles do
   let(:model_instance) { Class.new.new }
   let(:array) { [:foo, :bar] }
   subject { RoleModel::Roles.new(model_instance, array) }
+  before(:each) do
+    model_instance.stub(:roles=)
+  end
 
   its(:model_instance) { should equal(model_instance) }
   it { should include(:foo, :bar) }
@@ -16,4 +19,34 @@ describe RoleModel::Roles do
       subject << :baz
     end
   end
+
+  describe "#add" do
+    it "should add the given element to the model_instance.roles by re-assigning all roles" do
+      model_instance.should_receive(:roles=).with(array_including(:foo, :bar, :baz))
+      subject.add(:baz)
+    end
+  end
+
+  describe "#merge" do
+    it "should add the given enum to the model_instance.roles by re-assigning all roles" do
+      model_instance.should_receive(:roles=).with(array_including(:foo, :bar, :baz, :quux))
+      subject.merge([:baz, :quux])
+    end
+  end
+
+  describe "#delete" do
+    it "should delete the given element to the model_instance.roles by re-assigning all roles" do
+      model_instance.should_receive(:roles=).with(subject)
+      subject.delete :foo
+      subject.should_not include(:foo)
+    end
+  end
+
+  describe "#subtract" do
+    it "should remove the given enum to the model_instance.roles by re-assigning all roles" do
+      model_instance.should_receive(:roles=).with(subject)
+      subject.subtract([:foo, :bar])
+      subject.should have(0).roles
+    end
+  end
 end

metadata

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