role_model 0.2.0 → 0.3.0

data/README.rdoc

@@ -3,12 +3,8 @@
 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! No need to build a separate
-Role model, managing seed data and the like. Just declare your roles and you
-are done.
-
 Assigned roles will be stored as a bitmask in an configurable attribute
-(default: <tt>roles_mask</tt>). Here's everything you need to know:
+(default: <tt>roles_mask</tt>). Here's how to get started:
 
   # given a User class with a roles_mask attribute
   require 'rubygems'
@@ -18,6 +14,7 @@ Assigned roles will be stored as a bitmask in an configurable attribute
     attr_accessor :roles_mask # in real life this would be an persisted attribute / DB-column
     
     include RoleModel
+
     # optionally set the integer attribute to store the roles in,
     # :roles_mask is the default
     roles_attribute :roles_mask
@@ -27,23 +24,36 @@ Assigned roles will be stored as a bitmask in an configurable attribute
     roles :admin, :manager, :author
   end
   
+  #
+  # Test drive
+  #
+
   >> u = User.new
   => #<User ...>
 
+  # role assignment
   >> u.roles = [:admin] # ['admin'] works as well
   => [:admin]
 
-  >> u.roles # aliased to role_symbols for DeclarativeAuthorization
-  => [:admin]
+  # adding roles
+  >> u.roles << :manager
+  => [:admin, :manager]
   
-  >> u.has_role? :manager
+  # quering roles...
+
+  # ... retrieve all assigned roles
+  >> u.roles # aliased to role_symbols for DeclarativeAuthorization
+  => [:admin, :manager]
+
+  # ... check for individual roles
+  >> u.has_role? :author
   => false
-  
   >> u.has_role? :admin
   => true
-  
+
+  # see the internal bitmask representation (3 = 0b0011)
   >> u.roles_mask
-  => 1
+  => 3
 
 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.2.0
+0.3.0

data/lib/role_model/roles.rb

@@ -0,0 +1,14 @@
+module RoleModel
+  class Roles < Array
+    attr_reader :model_instance
+
+    def initialize(sender, *roles)
+      super(*roles)
+      @model_instance = sender
+    end
+
+    def <<(role)
+      model_instance.roles = super
+    end
+  end
+end

data/lib/role_model.rb

@@ -1,3 +1,5 @@
+require 'role_model/roles'
+
 module RoleModel
 
   INHERITABLE_CLASS_ATTRIBUTES = [:roles_attribute_name, :valid_roles]
@@ -6,7 +8,7 @@ module RoleModel
     base.extend ClassMethods
     base.class_eval do
       class << self
-        attr_accessor *::RoleModel::INHERITABLE_CLASS_ATTRIBUTES
+        attr_accessor(*::RoleModel::INHERITABLE_CLASS_ATTRIBUTES)
       end
       roles_attribute :roles_mask
     end
@@ -18,7 +20,7 @@ module RoleModel
 
     # query assigned roles
     def roles
-      self.class.valid_roles.reject { |r| ((self.send(self.class.roles_attribute_name) || 0) & 2**self.class.valid_roles.index(r)).zero? }
+      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
 

data/role_model.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{role_model}
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Martin Rehfeld"]
-  s.date = %q{2010-05-25}
+  s.date = %q{2010-05-29}
   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 = [
@@ -24,8 +24,10 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "lib/role_model.rb",
+     "lib/role_model/roles.rb",
      "role_model.gemspec",
      "spec/role_model_spec.rb",
+     "spec/roles_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb"
   ]
@@ -36,6 +38,7 @@ Gem::Specification.new do |s|
   s.summary = %q{Declare, assign and query roles with ease}
   s.test_files = [
     "spec/role_model_spec.rb",
+     "spec/roles_spec.rb",
      "spec/spec_helper.rb"
   ]
 

data/spec/role_model_spec.rb

@@ -9,7 +9,7 @@ describe RoleModel do
       attr_accessor :roles_mask
       attr_accessor :custom_roles_mask
       include RoleModel
-      roles :foo, :bar
+      roles :foo, :bar, :third
     end
   end
 
@@ -113,6 +113,67 @@ describe RoleModel do
       subject.roles = :baz
       subject.roles.should be_empty
     end
+
+    context "with previouly assigned roles" do
+      before(:each) do
+        subject.roles = :foo
+        subject.roles.should include(:foo)
+        subject.should have(1).roles
+      end
+
+      it "should set set assigned roles regardless overwriting previouly assigned roles" do
+        subject.roles = :bar
+        subject.roles.should include(:bar)
+        subject.should have(1).roles
+      end
+    end
+  end
+
+  describe "#<<" do
+    subject { model_class.new }
+
+    context "with roles :foo and :bar already assigned" do
+      before(:each) do
+        subject.roles = [:foo, :bar]
+      end
+
+      it "should add a role given as a symbol" do
+        subject.roles << :third
+        subject.roles.should include(:foo, :bar, :third)
+        subject.should have(3).roles
+      end
+
+      it "should add a role given as a string" do
+        subject.roles << 'third'
+        subject.roles.should include(:foo, :bar, :third)
+        subject.should have(3).roles
+      end
+    end
+
+    context "without any previouly assigned roles" do
+      it "should add a single symbol" do
+        subject.roles << :foo
+        subject.roles.should include(:foo)
+        subject.should have(1).roles
+      end
+
+      it "should add a single string" do
+        subject.roles << 'foo'
+        subject.roles.should include(:foo)
+        subject.should have(1).roles
+      end
+
+      it "should allow chaining of <<" do
+        subject.roles << :foo << :bar
+        subject.roles.should include(:foo, :bar)
+        subject.should have(2).roles
+      end
+    end
+
+    it "should silently ignore undefined roles" do
+      subject.roles << :baz
+      subject.roles.should be_empty
+    end
   end
 
   describe "#has_role?" do

data/spec/roles_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe RoleModel::Roles do
+
+  let(:model_instance) { Class.new.new }
+  let(:array) { [:foo, :bar] }
+  subject { RoleModel::Roles.new(model_instance, array) }
+
+  its(:model_instance) { should == model_instance }
+  it { should include(:foo, :bar) }
+  it { should be_kind_of(Array) }
+
+  describe "#<<" do
+    let(:roles_of_model_instance) { [:one, :two] }
+
+    it "should add the given element to the model_instance.roles by re-assigning all roles" do
+      model_instance.should_receive(:roles=).with([:foo, :bar, :baz])
+      subject << :baz
+    end
+  end
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Martin Rehfeld
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-25 00:00:00 +02:00
+date: 2010-05-29 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -48,8 +48,10 @@ files:
 - Rakefile
 - VERSION
 - lib/role_model.rb
+- lib/role_model/roles.rb
 - role_model.gemspec
 - spec/role_model_spec.rb
+- spec/roles_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 has_rdoc: true
@@ -84,4 +86,5 @@ specification_version: 3
 summary: Declare, assign and query roles with ease
 test_files: 
 - spec/role_model_spec.rb
+- spec/roles_spec.rb
 - spec/spec_helper.rb