roles_mongoid 0.2.4

data/lib/roles_mongoid.rb

@@ -0,0 +1,10 @@
+require 'roles_generic'
+require 'require_all'    
+require 'set'
+require 'sugar-high/array'
+require 'sugar-high/kind_of'
+require 'mongoid'
+require 'bson'
+require 'roles_mongoid/namespaces'
+require 'roles_mongoid/base'
+require 'roles_mongoid/strategy'

data/roles_mongoid.gemspec

@@ -0,0 +1,105 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{roles_mongoid}
+  s.version = "0.2.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kristian Mandrup"]
+  s.date = %q{2010-10-06}
+  s.description = %q{Makes it easy to set a role strategy on your User model in Mongoid}
+  s.email = %q{kmandrup@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".bundle/config",
+     ".document",
+     ".gitignore",
+     ".rspec",
+     "Gemfile",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "lib/generators/mongoid/roles/roles_generator.rb",
+     "lib/roles_mongoid.rb",
+     "lib/roles_mongoid/base.rb",
+     "lib/roles_mongoid/namespaces.rb",
+     "lib/roles_mongoid/role.rb",
+     "lib/roles_mongoid/strategy.rb",
+     "lib/roles_mongoid/strategy/multi/many_roles.rb",
+     "lib/roles_mongoid/strategy/multi/role_strings.rb",
+     "lib/roles_mongoid/strategy/multi/roles_mask.rb",
+     "lib/roles_mongoid/strategy/single/admin_flag.rb",
+     "lib/roles_mongoid/strategy/single/one_role.rb",
+     "lib/roles_mongoid/strategy/single/role_string.rb",
+     "roles_mongoid.gemspec",
+     "sandbox/roles_assign.rb",
+     "sandbox/single_role.rb",
+     "sandbox/test.rb",
+     "spec/generator_spec_helper.rb",
+     "spec/generators/roles_generator_spec.rb",
+     "spec/roles_mongoid/admin_flag_spec.rb",
+     "spec/roles_mongoid/many_roles_spec.rb",
+     "spec/roles_mongoid/one_role_spec.rb",
+     "spec/roles_mongoid/role_string_spec.rb",
+     "spec/roles_mongoid/role_strings_spec.rb",
+     "spec/roles_mongoid/roles_mask_spec.rb",
+     "spec/spec_helper.rb",
+     "tmp/rails/app/models/user.rb",
+     "tmp/rails/config/routes.rb"
+  ]
+  s.homepage = %q{http://github.com/kristianmandrup/roles_mongoid}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Implementation of Roles generic API for Mongoid}
+  s.test_files = [
+    "spec/generator_spec_helper.rb",
+     "spec/generators/roles_generator_spec.rb",
+     "spec/roles_mongoid/admin_flag_spec.rb",
+     "spec/roles_mongoid/many_roles_spec.rb",
+     "spec/roles_mongoid/one_role_spec.rb",
+     "spec/roles_mongoid/role_string_spec.rb",
+     "spec/roles_mongoid/role_strings_spec.rb",
+     "spec/roles_mongoid/roles_mask_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    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.beta.22"])
+      s.add_runtime_dependency(%q<mongoid>, ["~> 2.0.0.beta.18"])
+      s.add_runtime_dependency(%q<bson>, ["~> 1.0.7"])
+      s.add_runtime_dependency(%q<activesupport>, ["~> 3.0.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"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.0.0.beta.22"])
+      s.add_dependency(%q<mongoid>, ["~> 2.0.0.beta.18"])
+      s.add_dependency(%q<bson>, ["~> 1.0.7"])
+      s.add_dependency(%q<activesupport>, ["~> 3.0.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"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.0.0.beta.22"])
+    s.add_dependency(%q<mongoid>, ["~> 2.0.0.beta.18"])
+    s.add_dependency(%q<bson>, ["~> 1.0.7"])
+    s.add_dependency(%q<activesupport>, ["~> 3.0.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"])
+  end
+end
+

data/sandbox/roles_assign.rb

@@ -0,0 +1,54 @@
+require 'mongoid'
+
+Mongoid.configure do |config|
+  config.master = Mongo::Connection.new.db('testing')
+end
+
+Mongoid.database.collections.each do |coll|
+  coll.remove
+end
+
+
+class Role
+  include Mongoid::Document
+  field :name, :type => String  
+
+  class << self
+    def find_roles(*role_names)
+      where(:name.in => role_names.flatten).to_a #.map(&:_id)
+    end
+    alias_method :find_role, :find_roles
+  end
+end
+
+module Blip 
+  def self.included(base)
+    base.extend ClassMethods
+  end 
+
+  module ClassMethods  
+    def do_it
+      instance_eval "references_many :many_roles, :stored_as => :array, :class_name => 'Role'"
+    end
+  end
+end  
+
+class User 
+  include Mongoid::Document  
+  include Blip
+  field :name, :type => String  
+
+  do_it 
+  
+end
+
+Role.create :name => 'guest'
+Role.create :name => 'admin'
+
+user = User.create :name => 'Kristian'
+
+user.many_roles << Role.find_role(:guest)
+user.many_roles << Role.find_role(:admin)
+
+puts user.many_roles.inspect
+

data/sandbox/single_role.rb

@@ -0,0 +1,68 @@
+require 'mongoid'
+
+Mongoid.configure do |config|
+  config.master = Mongo::Connection.new.db('testing')
+end
+
+Mongoid.database.collections.each do |coll|
+  coll.remove
+end
+
+
+class Role
+  include Mongoid::Document
+  field :name, :type => String
+  referenced_in :user  
+
+  class << self
+    def find_roles(*role_names)
+      where(:name.in => role_names.flatten).to_a #.map(&:_id)
+    end
+    alias_method :find_role, :find_roles
+  end
+end
+
+module Blip 
+  def self.included(base)
+    base.extend ClassMethods
+  end 
+
+  module ClassMethods  
+    def do_it
+      instance_eval "references_one :role" # :class_name => 'Role'
+    end
+  end
+end  
+
+class User 
+  include Mongoid::Document  
+  include Blip
+  field :name, :type => String  
+  references_one :role
+  # do_it 
+  
+end
+
+user = User.create
+role = Role.create 
+
+puts "role: #{role.inspect}"
+user.role = role
+
+user.save
+
+# Role.create :name => 'guest'
+# Role.create :name => 'admin'
+# 
+# user = User.create :name => 'Kristian'
+# 
+# puts user.inspect
+# 
+# user.role.create :name => :guest
+# user.save
+
+# user.role = Role.find_role(:guest).first
+# user.save
+
+puts user.role.inspect
+

data/sandbox/test.rb

@@ -0,0 +1,47 @@
+require 'mongoid'
+
+Mongoid.configure do |config|
+  config.master = Mongo::Connection.new.db('testing')
+end
+
+Mongoid.database.collections.each do |coll|
+  coll.remove
+end
+
+class User
+  include Mongoid::Document
+  field :name
+  references_many :roles, :stored_as => :array
+
+  def self.find_roles *ids     
+    arr_ids = ids.flatten    
+    all.to_a.select do |user|
+      user.roles.to_a.any? do |role| 
+        arr_ids.include?(role._id)
+      end
+    end
+  end
+
+  def self.get_roles(*ids)
+    arr = ids.flatten
+    criteria.in(:role_ids => arr).to_a
+  end  
+
+end
+
+class Role
+  include Mongoid::Document
+  field :name
+end
+
+user = User.create(:name => 'Kristian')
+user.roles.create(:name => 'guest')
+user.save
+# 
+puts "user roles: #{User.first.roles.map(&:_id)}" 
+
+role_id = user.roles.to_a.first._id
+
+p role_id
+p User.find_roles role_id
+p User.get_roles role_id

data/spec/generator_spec_helper.rb

@@ -0,0 +1,13 @@
+require 'rspec'
+require 'rspec/autorun'     
+require 'rails3_artifactor'
+require 'generator-spec'
+require 'roles_generic'
+
+RSpec::Generator.configure do |config|
+  config.debug = false
+  config.remove_temp_dir = false # true
+  config.default_rails_root(__FILE__) 
+  config.lib = File.dirname(__FILE__) + '/../lib'
+  config.logger = :stdout  
+end

data/spec/generators/roles_generator_spec.rb

@@ -0,0 +1,59 @@
+require 'generator_spec_helper'
+require_generator :mongoid => :roles
+
+# root_dir = Rails3::Assist::Directory.rails_root
+root_dir = File.join(Rails.application.config.root_dir, 'rails')
+
+describe 'role strategy generator: admin_flag' do
+  describe 'ORM: mongoid' do  
+    use_orm :mongoid
+    
+    before :each do              
+      setup_generator 'mongoid_roles_generator' do
+        tests Mongoid::Generators::RolesGenerator
+      end    
+      remove_model :user    
+    end
+
+    after :each do
+      # remove_model :user
+    end
+        
+    it "should configure 'admin_flag' strategy" do            
+      create_model :user do
+        '# content'
+      end
+      with_generator do |g|   
+        arguments = "User --strategy admin_flag --roles admin user"
+        puts "arguments: #{arguments}"
+        g.run_generator arguments.args
+        root_dir.should have_model :user do |clazz|
+          clazz.should include_module 'Mongoid::Document'
+          clazz.should include_module 'Roles::Mongoid'
+          puts "clazz: #{clazz}"        
+          clazz.should have_call :valid_roles_are, :args => ':admin, :guest, :user'
+          clazz.should have_call :strategy, :args => ":admin_flag"        
+        end
+      end
+    end
+
+    it "should configure 'one_role' strategy" do            
+      create_model :user do
+        '# content'
+      end
+      with_generator do |g|   
+        arguments = "User --strategy one_role --roles admin user"
+        puts "arguments: #{arguments}"
+        g.run_generator arguments.args
+        root_dir.should have_model :user do |clazz|
+          clazz.should include_module 'Mongoid::Document'
+          clazz.should include_module 'Roles::Mongoid'
+          puts "clazz: #{clazz}"        
+          clazz.should have_call :valid_roles_are, :args => ':admin, :guest, :user'
+          clazz.should have_call :strategy, :args => ":one_role"        
+        end
+      end
+    end
+  end
+end
+

data/spec/roles_mongoid/admin_flag_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+use_roles_strategy :admin_flag
+
+class User 
+  include Mongoid::Document  
+  include Roles::Mongoid 
+  
+  strategy :admin_flag, :default
+  valid_roles_are :admin, :guest  
+
+  field :name, :type => String  
+end
+
+describe "Roles for Mongoid" do
+  after :each do
+    Database.teardown
+  end
+
+  before :each do
+    @user = User.create(:name => 'Kristian')
+    @user.roles = :guest
+    @user.save     
+
+    @admin_user = User.create(:name => 'Admin user')
+    @admin_user.roles = :admin    
+    @admin_user.save
+  end
+
+  describe "Admin flag strategy " do
+
+    describe '#in_role' do
+      it "should return first user maching role" do
+        User.in_role(:guest).first.name.should == 'Kristian'
+        User.in_role(:admin).first.name.should == 'Admin user'
+      end
+    end
+
+    describe 'roles API' do
+      it "should have admin user role to :admin" do
+        @admin_user.role.should == :admin
+        @admin_user.roles.should == [:admin]      
+        @admin_user.admin?.should be_true
+         
+        @admin_user.class.valid_roles.should == [:admin, :guest]
+        
+        @admin_user.has_role?(:guest).should be_false
+        
+        @admin_user.has_role?(:admin).should be_true
+        @admin_user.is?(:admin).should be_true
+        @admin_user.has_roles?(:admin).should be_true
+        @admin_user.has?(:admin).should be_true      
+      end
+
+      it "should have user role to :guest" do
+        @user.roles.should == [:guest]
+        @user.admin?.should be_false
+      
+        @user.has_role?(:guest).should be_true    
+        @user.has_role?(:admin).should be_false
+        @user.is?(:admin).should be_false
+        
+        @user.has_roles?(:guest).should be_true
+        @user.has?(:admin).should be_false
+      end
+      
+      it "should set user role to :admin using =" do
+        @user.roles = :admin      
+        @user.role.should == :admin           
+        @user.has_role?(:admin).should be_true      
+      end    
+    end
+  end
+end
+

data/spec/roles_mongoid/many_roles_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper' 
+use_roles_strategy :many_roles
+
+class User 
+  include Mongoid::Document  
+  include Roles::Mongoid 
+  
+  strategy :many_roles, :default
+  role_class :role
+
+  valid_roles_are :admin, :guest   
+
+  field :name, :type => String 
+end
+
+describe "Roles for Mongoid" do  
+  
+  after :each do
+    Database.teardown
+  end
+
+  context "default setup" do
+
+    before do              
+      @user = User.create(:name => 'Kristian')
+      @user.add_roles :guest      
+      @user.save     
+
+      @admin_user = User.create(:name => 'Admin user')
+      @admin_user.roles = :admin            
+      @admin_user.save
+    end
+    
+    describe '#in_role' do
+      it "should return first user matching role" do        
+        User.in_role(:guest).first.name.should == 'Kristian'      
+        User.in_role(:admin).first.name.should == 'Admin user'
+      end
+    end
+
+    describe "Role API" do
+      it "should have admin user role to :admin" do      
+        @admin_user.roles_list.first.should == :admin      
+        @admin_user.admin?.should be_true
+
+        @admin_user.has_role?(:guest).should be_false
+        
+        @admin_user.has_role?(:admin).should be_true
+        @admin_user.is?(:admin).should be_true
+        @admin_user.has_roles?(:admin).should be_true
+        @admin_user.has?(:admin).should be_true      
+      end
+
+      it "should have user role to :guest" do
+        @user.roles_list.first.should == :guest
+        @user.admin?.should be_false
+      
+        @user.has_role?(:guest).should be_true    
+        @user.has_role?(:admin).should be_false
+        @user.is?(:admin).should be_false
+      
+        @user.has_roles?(:admin).should be_false
+        @user.has?(:admin).should be_false
+      end
+      
+      it "should set user role to :admin using roles=" do
+        @user.roles = :admin      
+        @user.roles_list.first.should == :admin           
+        @user.has_role?(:admin).should be_true      
+      end  
+    end  
+  end
+end
+

data/spec/roles_mongoid/one_role_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper' 
+use_roles_strategy :one_role
+
+class User 
+  include Mongoid::Document  
+  include Roles::Mongoid 
+  
+  strategy :one_role, :default
+  role_class :role
+
+  valid_roles_are :admin, :guest   
+
+  field :name, :type => String 
+end
+
+describe "Roles for Mongoid" do  
+  
+  after :each do
+    Database.teardown
+  end
+
+  context "default setup" do
+
+    before do      
+      @user = User.create(:name => 'Kristian')
+      @user.role = :guest      
+      @user.save     
+
+      @admin_user = User.create(:name => 'Admin user')
+      @admin_user.role = Role.where(:name => :admin).to_a.first
+      @admin_user.save
+    end
+    
+    describe '#in_role' do
+      it "should return first user matching role" do        
+        User.in_role(:guest).first.name.should == 'Kristian'      
+        User.in_role(:admin).first.name.should == 'Admin user'
+      end
+    end
+
+    describe "Role API" do
+      it "should have admin user role to :admin" do      
+        @admin_user.roles_list.first.should == :admin      
+        @admin_user.admin?.should be_true
+        
+        @admin_user.has_role?(:guest).should be_false
+        
+        @admin_user.has_role?(:admin).should be_true
+        @admin_user.is?(:admin).should be_true
+        @admin_user.has_roles?(:admin).should be_true
+        @admin_user.has?(:admin).should be_true      
+      end
+
+      it "should have user role to :guest" do
+        @user.roles_list.first.should == :guest
+        @user.admin?.should be_false
+      
+        @user.has_role?(:guest).should be_true    
+        @user.has_role?(:admin).should be_false
+        @user.is?(:admin).should be_false
+      
+        @user.has_roles?(:admin).should be_false
+        @user.has?(:admin).should be_false
+      end
+      
+      it "should set user role to :admin using roles=" do
+        @user.roles = :admin      
+        @user.roles_list.first.should == :admin           
+        @user.has_role?(:admin).should be_true      
+      end  
+    end  
+  end
+end
+

data/spec/roles_mongoid/role_string_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+use_roles_strategy :role_string
+
+class User 
+  include Mongoid::Document  
+  include Roles::Mongoid 
+  
+  strategy :role_string, :default
+
+  valid_roles_are :admin, :guest   
+
+  field :name, :type => String 
+end
+
+describe "Roles for Mongoid" do  
+  
+  after :each do
+    Database.teardown
+  end
+
+  context "default setup" do
+
+    before do              
+      @user = User.create(:name => 'Kristian')
+      @user.role = :guest      
+      @user.save     
+
+      @admin_user = User.create(:name => 'Admin user')
+      @admin_user.roles = :admin            
+      @admin_user.save
+    end
+    
+    describe '#in_role' do
+      it "should return first user matching role" do        
+        User.in_role(:guest).first.name.should == 'Kristian'      
+        User.in_role(:admin).first.name.should == 'Admin user'
+      end
+    end
+
+    describe "Role API" do
+      it "should have admin user role to :admin" do      
+        @admin_user.roles_list.first.should == :admin      
+        @admin_user.admin?.should be_true
+        
+        @admin_user.has_role?(:guest).should be_false
+        
+        @admin_user.has_role?(:admin).should be_true
+        @admin_user.is?(:admin).should be_true
+        @admin_user.has_roles?(:admin).should be_true
+        @admin_user.has?(:admin).should be_true      
+      end
+          
+      it "should have user role to :guest" do
+        @user.roles_list.first.should == :guest
+        @user.admin?.should be_false
+      
+        @user.has_role?(:guest).should be_true    
+        @user.has_role?(:admin).should be_false
+        @user.is?(:admin).should be_false
+      
+        @user.has_roles?(:admin).should be_false
+        @user.has?(:admin).should be_false
+      end  
+      
+      it "should set user role to :admin using roles=" do
+        @user.roles = :admin      
+        @user.roles_list.first.should == :admin           
+        @user.has_role?(:admin).should be_true      
+      end  
+    end  
+  end
+end
+