roles_mongoid 0.4.0 → 0.4.1

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.4.1

data/lib/generators/mongoid/roles/roles_generator.rb

@@ -13,6 +13,7 @@ module Mongoid
 
       class_option :logfile, :type => :string,   :default => nil,   :desc => "Logfile location"
       class_option :roles, :type => :array, :aliases => "-r", :default => [], :desc => "Valid roles"
+      class_option :role_class,   :type => :string,   :aliases => "-rc", :default => 'Role', :desc => "Role class"
 
       def apply_role_strategy
         logger.add_logfile :logfile => logfile if logfile
@@ -31,13 +32,11 @@ module Mongoid
           insert_into_model user_model_name, :after => /include Mongoid::\w+/ do
             insertion_text
           end     
-
-          unless read_model(:user) =~ /use_roles_strategy/
-            inject_into_file model_file(:user), "use_roles_strategy :#{strategy}\n\n", :before => "class"
-          end        
         rescue Exception => e
           logger.debug"Error: #{e.message}"
         end
+        
+        copy_role_class if role_class_strategy?
       end 
       
       protected                  
@@ -71,6 +70,11 @@ module Mongoid
         [:admin, :guest]        
       end
 
+      def copy_role_class
+        logger.debug "copy_role_class: #{role_class.underscore}"
+        template 'role.rb', "app/models/#{role_class.underscore}.rb"
+      end
+
       def roles_to_add
         @roles_to_add ||= default_roles.concat(options[:roles]).to_symbols.uniq
       end
@@ -80,23 +84,19 @@ module Mongoid
       end
 
       def role_strategy_statement
-        "strategy :#{strategy}, #{strategy_option_arg}"
+        "strategy :#{strategy} #{strategy_option_arg}"
       end
 
       def strategy_option_arg
-        case strategy
-        when 'embed_one_role', 'embed_many_roles'
-          ":role_class => :role, :config => :default"
-        else
-          ":default\n#{role_class_stmt}"
-        end
+        return ", :role_class => :#{role_class.to_s.underscore}" if role_class_strategy? && role_class.to_s != 'Role'
+        ''
       end
 
-      def role_class_stmt
-        "  role_class :role" if [:one_role, :many_roles].include? (strategy.to_sym)
+      def role_class_strategy?
+        [:one_role, :many_roles, :embed_one_role, :embed_many_roles].include? strategy.to_sym
       end
 
-      def roles_statement
+      def valid_roles_statement
         return '' if has_valid_roles_statement?
         roles ? "valid_roles_are #{roles.join(', ')}" : ''
       end
@@ -108,7 +108,11 @@ module Mongoid
       def insertion_text
         %Q{include Roles::#{orm.to_s.camelize} 
   #{role_strategy_statement}
-  #{roles_statement}}
+  #{valid_roles_statement}}
+      end
+
+      def role_class
+        options[:role_class].classify || 'Role'
       end
 
       def strategy

data/lib/generators/mongoid/roles/templates/role.rb

@@ -0,0 +1,8 @@
+class <%= role_class %>
+  include Mongoid::Document
+  field :name, :type => String
+
+  validates_uniqueness_of :name
+
+  extend RoleClass::ClassMethods
+end  

data/lib/roles_mongoid/base.rb

@@ -34,13 +34,7 @@ module Roles
         raise ArgumentError, "Unknown role strategy #{strategy_name}" if !MAP.keys.include? strategy_name
         use_roles_strategy strategy_name
 
-        if strategies_with_role_class.include? strategy_name
-          if !options.kind_of? Symbol
-            @role_class_name = get_role_class(strategy_name, options)
-          else
-            @role_class_name = default_role_class(strategy_name)
-          end
-        end
+        set_role_class(strategy_name, options) if strategies_with_role_class.include? strategy_name
         
         if default_options?(options) && MAP[strategy_name]
           instance_eval statement(MAP[strategy_name])
@@ -60,6 +54,10 @@ module Roles
 
       private
 
+      def set_role_class strategy_name, options = {}
+        @role_class_name = !options.kind_of?(Symbol) ? get_role_class(strategy_name, options) : default_role_class(strategy_name)
+      end
+
       def default_options? options = {}
         return true if options == :default                           
         if options.kind_of? Hash

data/lib/roles_mongoid/base_role.rb

@@ -10,4 +10,18 @@ module Roles::Base
       end
     end
   end
+end  
+
+module RoleClass
+  module ClassMethods
+    def find_roles(*role_names)
+      where(:name.in => role_names.flatten).to_a
+    end
+
+    def find_role role_name
+      raise ArgumentError, "#find_role takes a single role name as argument, not: #{role_name.inspect}" if !role_name.kind_of_label?
+      res = find_roles(role_name)
+      res ? res.first : res
+    end
+  end
 end

data/lib/roles_mongoid/role.rb

@@ -6,15 +6,5 @@ class Role
 
   validates_uniqueness_of :name
 
-  class << self
-    def find_roles(*role_names)
-      where(:name.in => role_names.flatten).to_a
-    end
-
-    def find_role role_name
-      raise ArgumentError, "#find_role takes a single role name as argument, not: #{role_name.inspect}" if !role_name.kind_of_label?
-      res = find_roles(role_name)
-      res ? res.first : res
-    end
-  end
+  extend RoleClass::ClassMethods
 end  

data/roles_mongoid.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{roles_mongoid}
-  s.version = "0.4.0"
+  s.version = "0.4.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
-  s.date = %q{2010-12-26}
+  s.date = %q{2011-01-01}
   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 = [
@@ -26,6 +26,7 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "lib/generators/mongoid/roles/roles_generator.rb",
+    "lib/generators/mongoid/roles/templates/role.rb",
     "lib/roles_mongoid.rb",
     "lib/roles_mongoid/base.rb",
     "lib/roles_mongoid/base_role.rb",

data/spec/roles_mongoid/strategy/api_examples.rb

@@ -23,178 +23,178 @@ describe "Roles for Mongoid: #{api_name}" do
     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 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 
   # 
-  #   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  
+  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

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

@@ -1,5 +1,8 @@
 require 'spec_helper'
 
+class Role
+end
+
 class User
   include Mongoid::Document  
   include Roles::Mongoid 

data/spec/roles_mongoid/strategy/single/one_role_spec.rb

@@ -1,5 +1,8 @@
 require 'spec_helper'
 
+class Role
+end
+
 class User
   include Mongoid::Document  
   include Roles::Mongoid 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 4
-  - 0
-  version: 0.4.0
+  - 1
+  version: 0.4.1
 platform: ruby
 authors: 
 - Kristian Mandrup
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-26 00:00:00 +01:00
+date: 2011-01-01 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -250,6 +250,7 @@ files:
 - Rakefile
 - VERSION
 - lib/generators/mongoid/roles/roles_generator.rb
+- lib/generators/mongoid/roles/templates/role.rb
 - lib/roles_mongoid.rb
 - lib/roles_mongoid/base.rb
 - lib/roles_mongoid/base_role.rb