mongoid_roles_zhd 0.1

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,82 @@
+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
+  references_many :users #one_role, :class_name => 'Role'
+
+  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  
+  referenced_in :one_role, :class_name =>  'Role'
+  
+  # do_it   
+end
+
+user = User.create :name => 'Sandy'
+user2 = User.create :name => 'Mike'
+role = Role.create :name => 'Guest'
+role2 = Role.create :name => 'Admin'
+
+user.save
+user2.save
+
+user.one_role = role2 #<< [role, role2]
+role.users << [user, user2]
+user2.one_role = role
+
+# role.users << user
+# role.users << user2
+
+role.save 
+
+puts "user: #{user.inspect}"
+puts "user2 #{user2.inspect}"
+puts "role: #{role.inspect}"  
+puts "role users: #{role.users.to_a.inspect}"  
+
+
+# Role.create :name => 'guest'
+# Role.create :name => 'admin'
+# 
+# user = User.create :name => 'Kristian'
+# 
+# 
+# user.role.create :name => :guest
+# user.save
+
+# user.role = Role.find_role(:guest).first
+# user.save
+
+
+

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/sandbox/test_query.rb

@@ -0,0 +1,49 @@
+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 :username, :type => String  
+  field :email, :type => String
+
+  def self.find_record(login)
+    found = where(:username => login).to_a
+    found = where(:email => login).to_a if found.empty?
+    found
+  end
+  
+  def self.find_record_generic(attributes)
+    where(attributes).first    
+  end 
+
+  def self.find_record_alt(login)
+    where("function() {return this.username == '#{login}' || this.email == '#{login}'}")
+  end  
+end
+
+User.create :username => 'guest', :email => 'guest@email.com'
+User.create :username => 'admin', :email => 'admin@email.com'
+User.create :username => 'blip',  :email => 'guest@email.com'
+User.create :username => 'blip', :email => 'guest@cool.com' 
+
+puts User.all
+
+puts "Found match 'blip'"
+
+# puts User.find_record('blip').first.inspect
+puts User.find_record_alt('blip').first.inspect
+
+# puts User.find_record_generic(:username => 'blip')
+
+puts "Found match 'guest@email.com'"
+
+puts User.find_record('guest@email.com').first.inspect

data/spec/generator_spec_helper.rb

@@ -0,0 +1,12 @@
+require 'rspec'
+require 'rails_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/mongoid_roles/generators/roles_generator_spec.rb

@@ -0,0 +1,67 @@
+require 'generator_spec_helper'
+# require_generator :mongoid => :roles
+
+require 'generators/mongoid/roles/roles_generator'
+
+# root_dir = RailsAssist::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_file :user do |clazz|
+          clazz.should include_module 'Mongoid::Document'
+          clazz.should include_module 'Mongoid::Roles'
+          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
+      # puts read_model :user
+      
+      with_generator do |g|   
+        arguments = "User --strategy one_role --roles admin user"
+        puts "arguments: #{arguments}"
+        g.run_generator arguments.args
+        
+        # puts read_model :user        
+        
+        root_dir.should have_model_file :user do |clazz|
+          clazz.should include_module 'Mongoid::Document'
+          clazz.should include_module 'Mongoid::Roles'
+          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/mongoid_roles/strategy/api_examples.rb

@@ -0,0 +1,200 @@
+describe "Roles for Mongoid: #{api_name}" do   
+  require "mongoid_roles/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)
+          # @normal_user.roles_list.should include(:user)
+      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