roles_mongoid 0.3.5 → 0.3.6

data/README.markdown

@@ -2,6 +2,13 @@
 
 A Mongoid implementation of [roles generic](http://github.com/kristianmandrup/roles_generic)
 
+*Update Dec 21, 2010*
+
+New embedded role strategies added with specs
+
+* embed_one_role
+* embed_many_roles
+
 ## Intro
 
 Implements the [roles generic](http://github.com/kristianmandrup/roles_generic) Roles API
@@ -9,20 +16,16 @@ Implements the [roles generic](http://github.com/kristianmandrup/roles_generic)
 Generic Role strategies implemented:
 
 * admin_flag
-* many_roles
-* one_role
-* roles_mask
-* role_string
-* role_strings
 
-*Update Nov 24, 2010*
-Version 0.3.1 and up is a major refactoring to support Roles Generic 0.3 and above with a new and improved architecture and testing framework. 
-Since 0.3.2 development of some basic infrastructure to support embedded role strategies in the future has been initiated.
+* many_roles)
+* one_role
 
-* embed_one_role
 * embed_many_roles
+* embed_one_role
 
-Please join in the effort to implement and add these strategies to the mix.
+* roles_mask
+* role_string
+* role_strings
 
 # Install
 
@@ -35,8 +38,13 @@ The library comes with a Rails 3 generator that lets you populate a user model w
 The following role strategies are included by default. Add your own by adding extra files inside the strategy folder, one file for each role strategy is recommended.
 
 * admin_flag
+
 * many_roles
-* one_role
+* one_role)
+
+* embed_many_roles
+* embed_one_role
+
 * roles_mask
 * role_string
 * role_strings

data/Rakefile

@@ -9,12 +9,12 @@ begin
     gem.authors = ["Kristian Mandrup"]
     gem.add_development_dependency "rspec", '>= 2.0.1'
 
-    gem.add_dependency "mongoid",           '>= 2.0.0.beta.19'
+    gem.add_dependency "mongoid",           '>= 2.0.0.beta.20'
     gem.add_dependency 'bson',              '>= 1.1.4'
 
-    gem.add_dependency "sugar-high",      "~> 0.3.0"
-    gem.add_dependency "require_all",     '~> 1.2.0' 
-    gem.add_dependency "roles_generic",   '>= 0.3.0'  
+    gem.add_dependency "sugar-high",      "~> 0.3.1"
+    gem.add_dependency "require_all",     '~> 1.2.0'
+    gem.add_dependency "roles_generic",   '>= 0.3.3'
     
     gem.add_dependency 'rails3_artifactor', '>= 0.3.1'
     gem.add_dependency 'logging_assist',    '~> 0.1.6'

data/VERSION

@@ -1 +1 @@
-0.3.5
+0.3.6

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

@@ -9,7 +9,7 @@ module Mongoid
       # argument name
       
       class_option :strategy, :type => :string, :aliases => "-s", :default => 'role_string', 
-                   :desc => "Role strategy to use (admin_flag, role_string, roles_string, role_strings, one_role, many_roles, roles_mask)"
+                   :desc => "Role strategy to use (admin_flag, role_string, roles_string, role_strings, roles_mask, one_role, many_roles, embed_one_role, embed_many_roles)"
 
       class_option :logfile, :type => :string,   :default => nil,   :desc => "Logfile location"
       class_option :roles, :type => :array, :aliases => "-r", :default => [], :desc => "Valid roles"
@@ -18,6 +18,10 @@ module Mongoid
         logger.add_logfile :logfile => logfile if logfile
         logger.debug "apply_role_strategy for : #{strategy} in model #{name}"
 
+        if !valid_strategy?
+          say "Strategy #{strategy} is not currently supported, please try one of #{valid_strategies.join(', ')}", :red
+        end
+
         if !has_model_file?(user_model_name)
           say "User model #{user_model_name} not found", :red
           return 
@@ -43,6 +47,14 @@ module Mongoid
 
       use_orm :mongoid
 
+      def valid_strategy?
+        valid_strategies.include? strategy.to_sym
+      end
+
+      def valid_strategies
+        [:admin_flag, :one_role, :embed_one_role, :role_string, :embed_many_roles, :many_roles, :role_strings, :roles_mask]
+      end
+
       def logfile
         options[:logfile]
       end
@@ -67,8 +79,17 @@ module Mongoid
         roles_to_add.map{|r| ":#{r}" }
       end
 
-      def role_strategy_statement 
-        "strategy :#{strategy}, :default\n#{role_class_stmt}"
+      def role_strategy_statement
+        "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
       end
 
       def role_class_stmt

data/lib/roles_mongoid/embedded_role.rb

@@ -1,3 +1,5 @@
+puts "Embedded Role"
+
 module Roles::Base
   def valid_roles_are(*role_list)
     strategy_class.valid_roles = role_list.to_symbols
@@ -7,6 +9,8 @@ end
 class Role
   include Mongoid::Document
   field :name, :type => String
+  
+  validates_uniqueness_of :name  
 
   class << self
     def find_roles(*role_names)

data/lib/roles_mongoid/role.rb

@@ -15,9 +15,6 @@ end
 class Role
   include Mongoid::Document
   field :name, :type => String
-  # references_many :users
-
-  # references_many :users, :class_name => 'User', :stored_as => :array  
 
   validates_uniqueness_of :name
 

data/lib/roles_mongoid/strategy/multi/embed_many_roles.rb

@@ -22,8 +22,7 @@ module RoleStrategy::Mongoid
 
       def in_any_role(*role_names)
         begin
-          role_ids = Role.where(:name.in => role_names.to_strings).to_a.map(&:_id)
-          where(:"#{role_attribute}".in => role_ids).to_a
+          any_in("many_roles.name" => role_names)
         rescue
           return []
         end
@@ -33,6 +32,48 @@ module RoleStrategy::Mongoid
     module Implementation
       include Roles::Mongoid::Strategy::Multi
 
+      def set_role role
+        raise ArgumentError, "#set_role only takes a single role as argument, not #{role}" if role.kind_of?(Array)
+        self.send("#{role_attribute}=", nil)
+        self.send("create_#{role_attribute}").create(:name => role)
+      end      
+
+      def set_roles *roles
+        roles = roles.flat_uniq
+        self.send("#{role_attribute}=", nil)        
+        roles.each do |role|
+          self.send("#{role_attribute}").create(:name => role)
+        end
+      end
+
+      def roles_diff *roles
+        self.roles_list - extract_roles(roles.flat_uniq)
+      end
+
+      def remove_roles *role_names
+        role_names = role_names.flat_uniq
+        set_empty_roles and return if roles_diff(role_names).empty?
+        roles_to_remove = select_valid_roles(role_names)       
+        
+        diff = roles_diff(role_names)
+        set_roles(diff) 
+        true
+      end
+
+      def exchange_roles *role_names
+        options = last_option role_names
+        raise ArgumentError, "Must take an options hash as last argument with a :with option signifying which role(s) to replace with" if !options || !options.kind_of?(Hash)
+        common = role_names.to_symbols & roles_list
+        if !common.empty?
+          with_roles = options[:with]
+          set_roles with_roles
+        end
+      end
+
+      def select_valid_roles *role_names
+        role_names = role_names.flat_uniq.select{|role| valid_role? role }        
+      end      
+
       def has_roles?(*roles_names)
         compare_roles = extract_roles(roles_names.flat_uniq)
         (roles_list & compare_roles).not.empty?      
@@ -59,7 +100,7 @@ module RoleStrategy::Mongoid
         role_names = role_names.flat_uniq
         role_names = extract_roles(role_names)
         return nil if role_names.empty?
-        valids = role_class.find_roles(role_names).to_a
+
         vrs = select_valid_roles role_names
         set_roles(vrs)
       end

data/lib/roles_mongoid/strategy/shared.rb

@@ -3,6 +3,7 @@ module Roles::Mongoid
     module Shared
       def set_role role
         raise ArgumentError, "#set_role only takes a single role as argument, not #{role}" if role.kind_of?(Array)
+        puts "role: #{role.inspect}, attrib: #{role_attribute.inspect}"
         self.send("#{role_attribute}=", role)
       end
       

data/lib/roles_mongoid/strategy/single/embed_one_role.rb

@@ -25,10 +25,8 @@ module RoleStrategy::Mongoid
       end
 
       def in_any_role(*role_names)
-        begin                       
-          the_roles = Role.where(:name.in => role_names.to_strings).to_a 
-          role_ids = the_roles.map(&:_id).map(&:to_s)
-          where(:"#{role_attribute_id}".in => role_ids)
+        begin          
+          any_in("one_role.name" => role_names)
         rescue 
           return []
         end
@@ -37,9 +35,29 @@ module RoleStrategy::Mongoid
 
     module Implementation  
       include Roles::Mongoid::Strategy::Single 
+
+      def set_role role
+        raise ArgumentError, "#set_role only takes a single role as argument, not #{role}" if role.kind_of?(Array)
+        self.send("create_#{role_attribute}", :name => role)
+      end      
+
+      def set_roles *roles
+        roles = roles.flat_uniq
+        self.send("create_#{role_attribute}", :name => roles.first)
+      end
+
+      def exchange_roles *role_names
+        options = last_option role_names
+        raise ArgumentError, "Must take an options hash as last argument with a :with option signifying which role(s) to replace with" if !options || !options.kind_of?(Hash)
+        common = role_names.to_symbols & roles_list
+        if !common.empty?
+          with_roles = options[:with]
+          set_role with_roles
+        end
+      end
       
       def new_role role
-        role_class.find_role(extract_role role)        
+        role_class.find_role(extract_role role)
       end  
       
       def new_roles *roles
@@ -55,8 +73,7 @@ module RoleStrategy::Mongoid
       end
 
       def select_valid_roles *role_names
-        role_names = role_names.flat_uniq.select{|role| valid_role? role }
-        has_role_class? ? role_class.find_roles(role_names).to_a : role_names
+        role_names = role_names.flat_uniq.select{|role| valid_role? role }        
       end      
     end
 

data/roles_mongoid.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{roles_mongoid}
-  s.version = "0.3.5"
+  s.version = "0.3.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
@@ -95,11 +95,11 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<sugar-high>, [">= 0.3.0"])
       s.add_runtime_dependency(%q<roles_generic>, [">= 0.3.2"])
       s.add_development_dependency(%q<rspec>, [">= 2.0.1"])
-      s.add_runtime_dependency(%q<mongoid>, [">= 2.0.0.beta.19"])
+      s.add_runtime_dependency(%q<mongoid>, [">= 2.0.0.beta.20"])
       s.add_runtime_dependency(%q<bson>, [">= 1.1.4"])
-      s.add_runtime_dependency(%q<sugar-high>, ["~> 0.3.0"])
+      s.add_runtime_dependency(%q<sugar-high>, ["~> 0.3.1"])
       s.add_runtime_dependency(%q<require_all>, ["~> 1.2.0"])
-      s.add_runtime_dependency(%q<roles_generic>, [">= 0.3.0"])
+      s.add_runtime_dependency(%q<roles_generic>, [">= 0.3.3"])
       s.add_runtime_dependency(%q<rails3_artifactor>, [">= 0.3.1"])
       s.add_runtime_dependency(%q<logging_assist>, ["~> 0.1.6"])
     else
@@ -110,11 +110,11 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<sugar-high>, [">= 0.3.0"])
       s.add_dependency(%q<roles_generic>, [">= 0.3.2"])
       s.add_dependency(%q<rspec>, [">= 2.0.1"])
-      s.add_dependency(%q<mongoid>, [">= 2.0.0.beta.19"])
+      s.add_dependency(%q<mongoid>, [">= 2.0.0.beta.20"])
       s.add_dependency(%q<bson>, [">= 1.1.4"])
-      s.add_dependency(%q<sugar-high>, ["~> 0.3.0"])
+      s.add_dependency(%q<sugar-high>, ["~> 0.3.1"])
       s.add_dependency(%q<require_all>, ["~> 1.2.0"])
-      s.add_dependency(%q<roles_generic>, [">= 0.3.0"])
+      s.add_dependency(%q<roles_generic>, [">= 0.3.3"])
       s.add_dependency(%q<rails3_artifactor>, [">= 0.3.1"])
       s.add_dependency(%q<logging_assist>, ["~> 0.1.6"])
     end
@@ -126,11 +126,11 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<sugar-high>, [">= 0.3.0"])
     s.add_dependency(%q<roles_generic>, [">= 0.3.2"])
     s.add_dependency(%q<rspec>, [">= 2.0.1"])
-    s.add_dependency(%q<mongoid>, [">= 2.0.0.beta.19"])
+    s.add_dependency(%q<mongoid>, [">= 2.0.0.beta.20"])
     s.add_dependency(%q<bson>, [">= 1.1.4"])
-    s.add_dependency(%q<sugar-high>, ["~> 0.3.0"])
+    s.add_dependency(%q<sugar-high>, ["~> 0.3.1"])
     s.add_dependency(%q<require_all>, ["~> 1.2.0"])
-    s.add_dependency(%q<roles_generic>, [">= 0.3.0"])
+    s.add_dependency(%q<roles_generic>, [">= 0.3.3"])
     s.add_dependency(%q<rails3_artifactor>, [">= 0.3.1"])
     s.add_dependency(%q<logging_assist>, ["~> 0.1.6"])
   end

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

@@ -6,8 +6,7 @@ class User
   include Mongoid::Document  
   include Roles::Mongoid 
   
-  strategy :embed_many_roles, :default
-  role_class :role
+  strategy :embed_many_roles, :role_class => :role, :config => :default
 
   valid_roles_are :admin, :guest, :user
 end

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

@@ -17,3 +17,4 @@ def api_name
 end
 
 load 'roles_mongoid/strategy/api_examples.rb'
+

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 5
-  version: 0.3.5
+  - 6
+  version: 0.3.6
 platform: ruby
 authors: 
 - Kristian Mandrup
@@ -136,8 +136,8 @@ dependencies:
         - 0
         - 0
         - beta
-        - 19
-        version: 2.0.0.beta.19
+        - 20
+        version: 2.0.0.beta.20
   type: :runtime
   prerelease: false
   version_requirements: *id008
@@ -166,8 +166,8 @@ dependencies:
         segments: 
         - 0
         - 3
-        - 0
-        version: 0.3.0
+        - 1
+        version: 0.3.1
   type: :runtime
   prerelease: false
   version_requirements: *id010
@@ -196,8 +196,8 @@ dependencies:
         segments: 
         - 0
         - 3
-        - 0
-        version: 0.3.0
+        - 3
+        version: 0.3.3
   type: :runtime
   prerelease: false
   version_requirements: *id012