roles_mongo_mapper 0.1.4 → 0.2.0

data/roles_mongo_mapper.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{roles_mongo_mapper}
-  s.version = "0.1.4"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
-  s.date = %q{2010-10-07}
+  s.date = %q{2010-11-24}
   s.description = %q{Makes it easy to set a role strategy on your User model in MongoMapper}
   s.email = %q{kmandrup@gmail.com}
   s.extra_rdoc_files = [
@@ -27,25 +27,36 @@ Gem::Specification.new do |s|
      "lib/generators/mongo_mapper/roles/roles_generator.rb",
      "lib/roles_mongo_mapper.rb",
      "lib/roles_mongo_mapper/base.rb",
+     "lib/roles_mongo_mapper/embedded_role.rb",
      "lib/roles_mongo_mapper/namespaces.rb",
      "lib/roles_mongo_mapper/role.rb",
      "lib/roles_mongo_mapper/strategy.rb",
+     "lib/roles_mongo_mapper/strategy/multi.rb",
+     "lib/roles_mongo_mapper/strategy/multi/embed_many_roles.rb",
      "lib/roles_mongo_mapper/strategy/multi/many_roles.rb",
      "lib/roles_mongo_mapper/strategy/multi/role_strings.rb",
      "lib/roles_mongo_mapper/strategy/multi/roles_mask.rb",
+     "lib/roles_mongo_mapper/strategy/shared.rb",
+     "lib/roles_mongo_mapper/strategy/single.rb",
      "lib/roles_mongo_mapper/strategy/single/admin_flag.rb",
+     "lib/roles_mongo_mapper/strategy/single/embed_one_role.rb",
      "lib/roles_mongo_mapper/strategy/single/one_role.rb",
      "lib/roles_mongo_mapper/strategy/single/role_string.rb",
      "roles_mongo_mapper.gemspec",
      "sandbox/test.rb",
      "spec/generator_spec_helper.rb",
      "spec/roles_mongo_mapper/generators/roles_generator_spec.rb",
-     "spec/roles_mongo_mapper/strategy/admin_flag_spec.rb",
-     "spec/roles_mongo_mapper/strategy/many_roles_spec.rb",
-     "spec/roles_mongo_mapper/strategy/one_role_spec.rb",
-     "spec/roles_mongo_mapper/strategy/role_string_spec.rb",
-     "spec/roles_mongo_mapper/strategy/role_strings_spec.rb",
-     "spec/roles_mongo_mapper/strategy/roles_mask_spec.rb",
+     "spec/roles_mongo_mapper/strategy/api_examples.rb",
+     "spec/roles_mongo_mapper/strategy/hooks.rb",
+     "spec/roles_mongo_mapper/strategy/multi/embed_many_roles_spec.rb",
+     "spec/roles_mongo_mapper/strategy/multi/many_roles_spec.rb",
+     "spec/roles_mongo_mapper/strategy/multi/role_strings_spec.rb",
+     "spec/roles_mongo_mapper/strategy/multi/roles_mask_spec.rb",
+     "spec/roles_mongo_mapper/strategy/single/admin_flag_spec.rb",
+     "spec/roles_mongo_mapper/strategy/single/embed_one_role_spec.rb",
+     "spec/roles_mongo_mapper/strategy/single/one_role_spec.rb",
+     "spec/roles_mongo_mapper/strategy/single/role_string_spec.rb",
+     "spec/roles_mongo_mapper/strategy/user_setup.rb",
      "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/kristianmandrup/roles_mongo_mapper}
@@ -56,12 +67,17 @@ Gem::Specification.new do |s|
   s.test_files = [
     "spec/generator_spec_helper.rb",
      "spec/roles_mongo_mapper/generators/roles_generator_spec.rb",
-     "spec/roles_mongo_mapper/strategy/admin_flag_spec.rb",
-     "spec/roles_mongo_mapper/strategy/many_roles_spec.rb",
-     "spec/roles_mongo_mapper/strategy/one_role_spec.rb",
-     "spec/roles_mongo_mapper/strategy/role_string_spec.rb",
-     "spec/roles_mongo_mapper/strategy/role_strings_spec.rb",
-     "spec/roles_mongo_mapper/strategy/roles_mask_spec.rb",
+     "spec/roles_mongo_mapper/strategy/api_examples.rb",
+     "spec/roles_mongo_mapper/strategy/hooks.rb",
+     "spec/roles_mongo_mapper/strategy/multi/embed_many_roles_spec.rb",
+     "spec/roles_mongo_mapper/strategy/multi/many_roles_spec.rb",
+     "spec/roles_mongo_mapper/strategy/multi/role_strings_spec.rb",
+     "spec/roles_mongo_mapper/strategy/multi/roles_mask_spec.rb",
+     "spec/roles_mongo_mapper/strategy/single/admin_flag_spec.rb",
+     "spec/roles_mongo_mapper/strategy/single/embed_one_role_spec.rb",
+     "spec/roles_mongo_mapper/strategy/single/one_role_spec.rb",
+     "spec/roles_mongo_mapper/strategy/single/role_string_spec.rb",
+     "spec/roles_mongo_mapper/strategy/user_setup.rb",
      "spec/spec_helper.rb"
   ]
 
@@ -70,33 +86,36 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, [">= 2.0.0.rc"])
+      s.add_development_dependency(%q<rspec>, [">= 2.1"])
       s.add_development_dependency(%q<generator-spec>, ["~> 0.6.5"])
-      s.add_runtime_dependency(%q<mongo_mapper>, ["~> 0.8.4"])
-      s.add_runtime_dependency(%q<activesupport>, ["~> 3.0.0"])
+      s.add_runtime_dependency(%q<mongo_mapper>, [">= 0.8.4"])
+      s.add_runtime_dependency(%q<activesupport>, ["~> 3.0"])
       s.add_runtime_dependency(%q<require_all>, ["~> 1.2.0"])
-      s.add_runtime_dependency(%q<sugar-high>, ["~> 0.2.11"])
-      s.add_runtime_dependency(%q<roles_generic>, ["~> 0.2.7"])
-      s.add_runtime_dependency(%q<logging_assist>, ["~> 0.1.3"])
+      s.add_runtime_dependency(%q<sugar-high>, ["~> 0.3.0"])
+      s.add_runtime_dependency(%q<roles_generic>, ["~> 0.3.3"])
+      s.add_runtime_dependency(%q<rails3_artifactor>, ["~> 0.3.0"])
+      s.add_runtime_dependency(%q<logging_assist>, [">= 0.1.5"])
     else
-      s.add_dependency(%q<rspec>, [">= 2.0.0.rc"])
+      s.add_dependency(%q<rspec>, [">= 2.1"])
       s.add_dependency(%q<generator-spec>, ["~> 0.6.5"])
-      s.add_dependency(%q<mongo_mapper>, ["~> 0.8.4"])
-      s.add_dependency(%q<activesupport>, ["~> 3.0.0"])
+      s.add_dependency(%q<mongo_mapper>, [">= 0.8.4"])
+      s.add_dependency(%q<activesupport>, ["~> 3.0"])
       s.add_dependency(%q<require_all>, ["~> 1.2.0"])
-      s.add_dependency(%q<sugar-high>, ["~> 0.2.11"])
-      s.add_dependency(%q<roles_generic>, ["~> 0.2.7"])
-      s.add_dependency(%q<logging_assist>, ["~> 0.1.3"])
+      s.add_dependency(%q<sugar-high>, ["~> 0.3.0"])
+      s.add_dependency(%q<roles_generic>, ["~> 0.3.3"])
+      s.add_dependency(%q<rails3_artifactor>, ["~> 0.3.0"])
+      s.add_dependency(%q<logging_assist>, [">= 0.1.5"])
     end
   else
-    s.add_dependency(%q<rspec>, [">= 2.0.0.rc"])
+    s.add_dependency(%q<rspec>, [">= 2.1"])
     s.add_dependency(%q<generator-spec>, ["~> 0.6.5"])
-    s.add_dependency(%q<mongo_mapper>, ["~> 0.8.4"])
-    s.add_dependency(%q<activesupport>, ["~> 3.0.0"])
+    s.add_dependency(%q<mongo_mapper>, [">= 0.8.4"])
+    s.add_dependency(%q<activesupport>, ["~> 3.0"])
     s.add_dependency(%q<require_all>, ["~> 1.2.0"])
-    s.add_dependency(%q<sugar-high>, ["~> 0.2.11"])
-    s.add_dependency(%q<roles_generic>, ["~> 0.2.7"])
-    s.add_dependency(%q<logging_assist>, ["~> 0.1.3"])
+    s.add_dependency(%q<sugar-high>, ["~> 0.3.0"])
+    s.add_dependency(%q<roles_generic>, ["~> 0.3.3"])
+    s.add_dependency(%q<rails3_artifactor>, ["~> 0.3.0"])
+    s.add_dependency(%q<logging_assist>, [">= 0.1.5"])
   end
 end
 

data/sandbox/test.rb

@@ -2,17 +2,27 @@ require 'mongo_mapper'
                  
 MongoMapper.database = 'roles_for_mm'
 
+class Role    
+  include MongoMapper::Document
+  key :name, String
+end
+
 class User    
   include MongoMapper::Document
 
   key :name, String
+  key :one_role, ::Role
 end
 
-User.create(:name => 'Kristian').save
+role = Role.create(:name => 'admin')
+user = User.create(:name => 'Kristian')
+user.one_role = role
+user.save
 
-puts User.first.id.inspect
+puts User.first.id                
+puts Role.first.id
 
-u = User.where(:'_id' => User.first.id).first
+u = User.where("role._id" => Role.first.id).first
 puts u.inspect
 
 

data/spec/roles_mongo_mapper/strategy/api_examples.rb

@@ -0,0 +1,199 @@
+describe "Roles for MonoMapper: #{api_name}" do   
+  require "roles_mongo_mapper/strategy/user_setup.rb"
+
+  before do
+    default_user_setup    
+  end
+
+  describe '#in_role' do
+    it "should return first user matching role" do        
+      if User.respond_to? :in_role
+        User.in_role(:guest).first.name.should == 'Guest user'
+        User.in_role(:admin).first.name.should == 'Admin user'
+      end
+    end
+  end
+  
+  describe '#in_any_role' do
+    it "should return first user matching role" do        
+      if User.respond_to? :in_roles
+        User.in_any_role(:guest, :user).first.name.should == 'Guest user'      
+        User.in_any_role(:admin, :guest).should be_empty
+      end
+    end
+  end
+  
+  it "should be true that a User that includes Roles::Generic has a complete Roles::Generic interface" do
+    # mutation API
+    [:roles=, :role=, :add_roles, :add_role, :remove_role, :remove_roles, :exchange_roles, :exchange_role].each do |api_method|
+      @admin_user.respond_to?(api_method).should be_true
+    end
+  
+    # inspection API
+    [:valid_role?, :valid_roles?, :has_roles?, :has_role?, :has?, :is?, :roles, :roles_list, :admin?].each do |api_method|
+      @admin_user.respond_to?(api_method).should be_true
+    end                  
+  
+    # class method API
+    [:valid_role?, :valid_roles?, :valid_roles].each do |class_api_method|
+      @admin_user.class.respond_to?(class_api_method).should be_true
+    end
+  end 
+  
+  describe '#valid_role?' do
+    it "should be true that the admin user has a valid role of :guest" do      
+      # @admin_user.valid_role?(:guest).should be_true
+    end
+  
+    it "should be true that the User class has a valid role of :guest" do      
+      # User.valid_role?(:guest).should be_true
+    end
+  end  
+  
+  describe '#valid_roles' do
+    it "should be true that the admin user has a valid role of :guest" do      
+      # @admin_user.valid_roles.should include(:guest, :admin)
+    end
+  
+    it "should be true that the User class has a valid role of :guest" do      
+      User.valid_roles.should include(:guest, :admin)
+    end
+  end
+  
+  describe '#valid_roles?' do
+    it "should be true that the admin user has a valid role of :guest" do      
+      @admin_user.valid_roles?(:guest, :admin).should be_true
+    end
+  
+    it "should be true that the User class has a valid role of :guest" do      
+      User.valid_roles?(:guest, :admin).should be_true
+    end
+  end  
+  
+  describe '#has_role?' do     
+    it "should have admin user role to :admin and not to :user" do
+      @admin_user.has_role?(:user).should be_false
+      @admin_user.has_role?(:admin).should be_true
+    end
+  
+    it "should be true that guest user has role :guest and not :admin" do
+      @guest_user.has_role?(:guest).should be_true    
+      @guest_user.has_role?(:admin).should be_false
+    end
+  end  
+  
+  describe '#has?' do    
+    it "should be true that the admin_user has the :admin role" do      
+      @admin_user.has?(:admin).should be_true      
+    end
+  
+    it "should NOT be true that the admin_user has the :admin role" do  
+      @guest_user.has?(:admin).should be_false
+    end
+  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
+    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 '#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        
+        @normal_user.roles_list.should include(:guest)
+      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 defined?(Role) && 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
+        end
+        if @normal_user.class.role_strategy.name == :admin_flag
+          roles.first.should == true          
+        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    
+   
+  describe '#roles=' do
+    it "should set user role to :admin" do
+      @guest_user.roles = :admin      
+      @guest_user.has_role?(:admin).should be_true      
+      @guest_user.roles = :guest            
+    end    
+  end   
+  
+  describe '#exchange_roles' do
+    it "should exchange user role :user with role :admin" do
+      @guest_user.exchange_role :guest, :with => :admin      
+      @guest_user.has?(:guest).should be_false
+      @guest_user.has?(:admin).should be_true
+    end    
+  
+    it "should exchange user role :admin with roles :user and :guest" do
+      case @admin_user.class.role_strategy.multiplicity
+      when :single     
+        lambda { @admin_user.exchange_role :admin, :with => [:user, :guest] }.should raise_error(ArgumentError)
+      when :multi
+        @admin_user.exchange_role :admin, :with => [:user, :guest]
+        @admin_user.has_role?(:user).should be_true
+        @admin_user.has_role?(:guest).should be_true
+        @admin_user.has?(:admin).should be_false        
+      end
+    end    
+  end 
+  
+  describe '#remove_roles' do
+    it "should remove user role :admin using #remove_roles" do
+      @admin_user.remove_roles :admin
+      @admin_user.has_role?(:admin).should_not be_true
+    end    
+  
+    it "should remove user role :admin using #remove_role" do
+      @guest_user.add_role :admin
+      @guest_user.has_role?(:admin).should be_true
+      @guest_user.remove_role :admin
+      @guest_user.has_role?(:admin).should_not be_true
+    end  
+  end  
+end

data/spec/roles_mongo_mapper/strategy/hooks.rb

@@ -0,0 +1,7 @@
+def after_each
+  Database.teardown
+end 
+
+def before_each
+  User.valid_roles_are :admin, :guest
+end

data/spec/roles_mongo_mapper/strategy/multi/embed_many_roles_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+use_roles_strategy :embed_many_roles
+
+class User 
+  include MongoMapper::Document  
+  include Roles::MongoMapper 
+  
+  strategy :embed_many_roles, :role_class => :role, :config => :default
+  role_class :role  
+  valid_roles_are :admin, :guest, :user  
+
+  key :name, :type => String  
+end
+
+def api_name
+  :embed_many_roles
+end
+
+load 'roles_mongo_mapper/strategy/api_examples.rb'

data/spec/roles_mongo_mapper/strategy/multi/many_roles_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+use_roles_strategy :many_roles
+
+class User 
+  include MongoMapper::Document  
+  include Roles::MongoMapper 
+  
+  strategy :many_roles, :default
+  role_class :role    
+  valid_roles_are :admin, :guest, :user  
+
+  key :name, :type => String  
+end
+
+def api_name
+  :many_roles
+end
+
+load 'roles_mongo_mapper/strategy/api_examples.rb'

data/spec/roles_mongo_mapper/strategy/multi/role_strings_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+use_roles_strategy :role_strings
+
+class User 
+  include MongoMapper::Document  
+  include Roles::MongoMapper 
+  
+  strategy :role_strings, :default
+  valid_roles_are :admin, :guest, :user  
+
+  key :name, :type => String  
+end
+
+def api_name
+  :role_strings
+end
+
+load 'roles_mongo_mapper/strategy/api_examples.rb'
+

data/spec/roles_mongo_mapper/strategy/multi/roles_mask_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+use_roles_strategy :roles_mask
+
+class User 
+  include MongoMapper::Document  
+  include Roles::MongoMapper 
+  
+  strategy :roles_mask, :default
+  valid_roles_are :admin, :guest, :user  
+
+  key :name, :type => String  
+end
+
+def api_name
+  :roles_mask
+end
+
+load 'roles_mongo_mapper/strategy/api_examples.rb'