roles_mongoid 0.3.1 → 0.3.2

data/README.markdown

@@ -5,7 +5,8 @@ A Mongoid implementation of [roles generic](http://github.com/kristianmandrup/ro
 ## Intro
 
 Implements the [roles generic](http://github.com/kristianmandrup/roles_generic) Roles API
-It also implements the following Role strategies:
+
+Generic Role strategies implemented:
 
 * admin_flag
 * many_roles
@@ -14,6 +15,15 @@ It also implements the following Role strategies:
 * 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.
+
+* embed_one_role
+* embed_many_roles
+
+Please join in the effort to implement and add these strategies to the mix.
+
 # Install
 
 <code>gem install roles_mongoid</code>
@@ -43,7 +53,8 @@ Apply :admin_flag Role strategy to User model using default roles and extra role
 
 Apply :one_role Role strategy to User model without default roles, only with roles :user, :special and :editor
 
-<code>$ rails g mongoid:roles_migration User --strategy one_role --roles user special editor --no-default-roles</code>
+<code>$ rails g mongoid:roles_migration User --strategy one_role --roles user special editor --no-default-roles</code> 
+
 ## Note on Patches/Pull Requests
  
 * Fork the project.

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.3.2

data/lib/roles_mongoid/base.rb

@@ -20,16 +20,32 @@ module Roles
         :many_roles   => "references_many :many_roles, :stored_as => :array, :class_name => 'Role'",
         :one_role     => "referenced_in :one_role, :class_name => 'Role'",
 
+        :embed_many_roles   => "embeds_many :many_roles, :class_name => 'Role'",
+        :embed_one_role     => "embeds_one :one_role, :class_name => 'Role'",
+
         :roles_mask   => "field :roles_mask, :type => Integer, :default => 0",
         :role_string  => "field :role_string, :type => String",
         :role_strings => "field :role_strings, :type => Array",
         :roles_string => "field :roles_string, :type => String"
       }
       
-      def strategy name, options=nil
-        if options == :default && MAP[name]
+      def strategy name, options = {}
+        if (options == :default || options[:config] == :default) && MAP[name]
           instance_eval MAP[name] 
         end
+        if !options.kind_of? Symbol
+          role_class = options[:role_class] ? options[:role_class].to_s.camelize.constantize : (Role if defined? Role)
+        end
+
+        case name
+        when :embed_one_role
+          raise ArgumentError, "#strategy class method must take :role_class option when using an embedded role strategy" if !role_class
+          role_class.embedded_in :user, :inverse_of => :one_role
+        when :embed_many_roles
+          raise ArgumentError, "#strategy class method must take :role_class option when using an embedded role strategy" if !role_class
+          role_class.embedded_in :user, :inverse_of => :many_roles
+        end
+        
         set_role_strategy name, options
       end    
     end

data/lib/roles_mongoid/embedded_role.rb

@@ -0,0 +1,22 @@
+module Roles::Base
+  def valid_roles_are(*role_list)
+    strategy_class.valid_roles = role_list.to_symbols
+  end
+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
+    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/strategy/multi/embed_many_roles.rb

@@ -0,0 +1,83 @@
+require 'roles_mongoid/strategy/multi'
+
+module RoleStrategy::Mongoid
+  module EmbedManyRoles
+    def self.default_role_attribute
+      :many_roles
+    end
+
+    def self.included base
+      base.extend Roles::Generic::Role::ClassMethods
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def role_attribute
+        "#{strategy_class.roles_attribute_name.to_s.singularize}_ids".to_sym
+      end
+
+      def in_role(role_name)
+        in_any_role(role_name)
+      end
+
+      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
+        rescue
+          return []
+        end
+      end
+    end
+
+    module Implementation
+      include Roles::Mongoid::Strategy::Multi
+
+      def has_roles?(*roles_names)
+        compare_roles = extract_roles(roles_names.flat_uniq)
+        (roles_list & compare_roles).not.empty?      
+      end
+
+      def get_roles
+        self.send(role_attribute)
+      end      
+
+      def roles
+        get_roles.to_a.map do |role|
+          role.respond_to?(:sym) ? role.to_sym : role
+        end
+      end
+
+      def roles_list
+        my_roles = [roles].flat_uniq
+        return [] if my_roles.empty?
+        has_role_class? ? my_roles.map{|r| r.name.to_sym } : my_roles          
+      end
+        
+      # assign multiple roles
+      def roles=(*role_names)
+        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
+
+      def new_roles *role_names
+        role_class.find_roles(extract_roles role_names)
+      end
+
+      def present_roles roles_names
+        roles_names.to_a.map{|role| role.name.to_s.to_sym}
+      end
+
+      def set_empty_roles
+        self.send("#{role_attribute}=", [])
+      end
+    end
+
+    extend Roles::Generic::User::Configuration
+    configure :type => :role_class
+  end
+end

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

@@ -46,32 +46,6 @@ module RoleStrategy::Mongoid
       def present_roles roles_names
         roles_names.to_a
       end
-      
-      # # assign roles
-      # def roles=(*new_roles)
-      #   new_roles = new_roles.flatten.map{|r| r.to_s if valid_role?(r)}.compact
-      #   if new_roles && new_roles.not.empty?
-      #     self.send("#{role_attribute}=", new_roles.compact.uniq) 
-      #   end
-      # end
-      # alias_method :role=, :roles=
-      # 
-      # def add_roles(*roles_to_add)
-      #   new_roles = roles_to_add.flatten.map{|r| r.to_s if valid_role?(r)}.compact
-      #   if new_roles && new_roles.not.empty?
-      #     self.send(role_attribute) << new_roles.compact.uniq
-      #   end
-      # end
-      # alias_method :add_role
-      # 
-      # # query assigned roles
-      # def roles
-      #   self.send(role_attribute).map{|r| r.to_sym}
-      # end
-      # 
-      # def roles_list     
-      #   [roles].flatten
-      # end      
     end
 
     extend Roles::Generic::User::Configuration

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

@@ -0,0 +1,66 @@
+require 'roles_mongoid/strategy/single'
+
+module RoleStrategy::Mongoid
+  module EmbedOneRole
+    def self.default_role_attribute
+      :one_role
+    end
+
+    def self.included base
+      base.extend Roles::Generic::Role::ClassMethods
+      base.extend ClassMethods
+    end
+
+    module ClassMethods 
+      def role_attribute
+        strategy_class.roles_attribute_name.to_sym
+      end       
+
+      def role_attribute_id
+        "#{role_attribute}_id"
+      end       
+         
+      def in_role(role_name)      
+        in_any_role(role_name)
+      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)
+        rescue 
+          return []
+        end
+      end  
+    end
+
+    module Implementation  
+      include Roles::Mongoid::Strategy::Single 
+      
+      def new_role role
+        role_class.find_role(extract_role role)        
+      end  
+      
+      def new_roles *roles
+        new_role roles.flatten.first
+      end     
+      
+      def present_roles *roles
+        roles.map{|role| extract_role role}
+      end                 
+      
+      def set_empty_role
+        self.send("#{role_attribute}=", nil)
+      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
+      end      
+    end
+
+    extend Roles::Generic::User::Configuration
+    configure :num => :single, :type => :role_class    
+  end  
+end

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

@@ -57,29 +57,7 @@ module RoleStrategy::Mongoid
       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
-      end           
-      
-      #     
-      # # assign roles
-      # def roles=(*_roles) 
-      #   _roles = get_roles(_roles)
-      #   return nil if _roles.none?                
-      #           
-      #   role_relation = role_class.find_role(_roles.first)  
-      #   self.send("#{role_attribute}=", role_relation)
-      #   one_role.save
-      # end
-      # alias_method :role=, :roles=
-      # 
-      # # query assigned roles
-      # def roles
-      #   role = self.send(role_attribute)
-      #   role ? [role.name.to_sym] : []
-      # end
-      # 
-      # def roles_list
-      #   self.roles.to_a
-      # end      
+      end      
     end
 
     extend Roles::Generic::User::Configuration

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

@@ -50,29 +50,7 @@ module RoleStrategy::Mongoid
         self.send("#{role_attribute}=", "")
       end
 
-      alias_method :present_roles, :present_role
-      
-      # def role_attribute
-      #   strategy_class.roles_attribute_name
-      # end 
-      #             
-      # # assign roles
-      # def roles=(*roles)
-      #   self.role = roles.select_labels.first.to_s
-      # end 
-      # 
-      # def role= role_name
-      #   if role_name.kind_of_label? && valid_role?(role_name)
-      #     self.send("#{role_attribute}=", role_name.to_s) 
-      #   end        
-      # end
-      # 
-      # # query assigned roles
-      # def roles
-      #   role = self.send(role_attribute)
-      #   [role.to_sym]
-      # end
-      # alias_method :roles_list, :roles
+      alias_method :present_roles, :present_role      
     end
 
     extend Roles::Generic::User::Configuration

data/roles_mongoid.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{roles_mongoid}
-  s.version = "0.3.1"
+  s.version = "0.3.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
-  s.date = %q{2010-11-23}
+  s.date = %q{2010-11-24}
   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 = [
@@ -29,16 +29,19 @@ Gem::Specification.new do |s|
      "lib/generators/mongoid/roles/roles_generator.rb",
      "lib/roles_mongoid.rb",
      "lib/roles_mongoid/base.rb",
+     "lib/roles_mongoid/embedded_role.rb",
      "lib/roles_mongoid/namespaces.rb",
      "lib/roles_mongoid/role.rb",
      "lib/roles_mongoid/strategy.rb",
      "lib/roles_mongoid/strategy/multi.rb",
+     "lib/roles_mongoid/strategy/multi/embed_many_roles.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/shared.rb",
      "lib/roles_mongoid/strategy/single.rb",
      "lib/roles_mongoid/strategy/single/admin_flag.rb",
+     "lib/roles_mongoid/strategy/single/embed_one_role.rb",
      "lib/roles_mongoid/strategy/single/one_role.rb",
      "lib/roles_mongoid/strategy/single/role_string.rb",
      "roles_mongoid.gemspec",
@@ -48,10 +51,12 @@ Gem::Specification.new do |s|
      "spec/generator_spec_helper.rb",
      "spec/roles_mongoid/generators/roles_generator_spec.rb",
      "spec/roles_mongoid/strategy/api_examples.rb",
+     "spec/roles_mongoid/strategy/multi/embed_many_roles_spec.rb",
      "spec/roles_mongoid/strategy/multi/many_roles_spec.rb",
      "spec/roles_mongoid/strategy/multi/role_strings_spec.rb",
      "spec/roles_mongoid/strategy/multi/roles_mask_spec.rb",
      "spec/roles_mongoid/strategy/single/admin_flag_spec.rb",
+     "spec/roles_mongoid/strategy/single/embed_one_role_spec.rb",
      "spec/roles_mongoid/strategy/single/one_role_spec.rb",
      "spec/roles_mongoid/strategy/single/role_string_spec.rb",
      "spec/roles_mongoid/strategy/user_setup.rb",
@@ -68,10 +73,12 @@ Gem::Specification.new do |s|
     "spec/generator_spec_helper.rb",
      "spec/roles_mongoid/generators/roles_generator_spec.rb",
      "spec/roles_mongoid/strategy/api_examples.rb",
+     "spec/roles_mongoid/strategy/multi/embed_many_roles_spec.rb",
      "spec/roles_mongoid/strategy/multi/many_roles_spec.rb",
      "spec/roles_mongoid/strategy/multi/role_strings_spec.rb",
      "spec/roles_mongoid/strategy/multi/roles_mask_spec.rb",
      "spec/roles_mongoid/strategy/single/admin_flag_spec.rb",
+     "spec/roles_mongoid/strategy/single/embed_one_role_spec.rb",
      "spec/roles_mongoid/strategy/single/one_role_spec.rb",
      "spec/roles_mongoid/strategy/single/role_string_spec.rb",
      "spec/roles_mongoid/strategy/user_setup.rb",

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

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+use_roles_strategy :embed_many_roles
+
+class User
+  include Mongoid::Document  
+  include Roles::Mongoid 
+  
+  strategy :embed_many_roles, :default
+  role_class :role
+
+  valid_roles_are :admin, :guest, :user
+end
+
+def api_name
+  :embed_many_roles
+end
+
+load 'roles_mongoid/strategy/api_examples.rb'

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

@@ -18,23 +18,3 @@ end
 
 load 'roles_mongoid/strategy/api_examples.rb'
 
-# 
-# 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: :many_roles strategy" do
-#   load "roles_mongoid/user_setup"
-#   load "roles_generic/rspec/api"
-# end
-# 

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

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+use_roles_strategy :embed_one_role
+
+class User
+  include Mongoid::Document  
+  include Roles::Mongoid 
+  
+  strategy :embed_one_role, :role_class => :role, :config => :default
+  role_class :role
+
+  valid_roles_are :admin, :guest, :user
+end
+
+def api_name
+  :embed_one_role
+end
+
+load 'roles_mongoid/strategy/api_examples.rb'

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 1
-  version: 0.3.1
+  - 2
+  version: 0.3.2
 platform: ruby
 authors: 
 - Kristian Mandrup
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-23 00:00:00 +01:00
+date: 2010-11-24 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -160,16 +160,19 @@ files:
 - lib/generators/mongoid/roles/roles_generator.rb
 - lib/roles_mongoid.rb
 - lib/roles_mongoid/base.rb
+- lib/roles_mongoid/embedded_role.rb
 - lib/roles_mongoid/namespaces.rb
 - lib/roles_mongoid/role.rb
 - lib/roles_mongoid/strategy.rb
 - lib/roles_mongoid/strategy/multi.rb
+- lib/roles_mongoid/strategy/multi/embed_many_roles.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/shared.rb
 - lib/roles_mongoid/strategy/single.rb
 - lib/roles_mongoid/strategy/single/admin_flag.rb
+- lib/roles_mongoid/strategy/single/embed_one_role.rb
 - lib/roles_mongoid/strategy/single/one_role.rb
 - lib/roles_mongoid/strategy/single/role_string.rb
 - roles_mongoid.gemspec
@@ -179,10 +182,12 @@ files:
 - spec/generator_spec_helper.rb
 - spec/roles_mongoid/generators/roles_generator_spec.rb
 - spec/roles_mongoid/strategy/api_examples.rb
+- spec/roles_mongoid/strategy/multi/embed_many_roles_spec.rb
 - spec/roles_mongoid/strategy/multi/many_roles_spec.rb
 - spec/roles_mongoid/strategy/multi/role_strings_spec.rb
 - spec/roles_mongoid/strategy/multi/roles_mask_spec.rb
 - spec/roles_mongoid/strategy/single/admin_flag_spec.rb
+- spec/roles_mongoid/strategy/single/embed_one_role_spec.rb
 - spec/roles_mongoid/strategy/single/one_role_spec.rb
 - spec/roles_mongoid/strategy/single/role_string_spec.rb
 - spec/roles_mongoid/strategy/user_setup.rb
@@ -225,10 +230,12 @@ test_files:
 - spec/generator_spec_helper.rb
 - spec/roles_mongoid/generators/roles_generator_spec.rb
 - spec/roles_mongoid/strategy/api_examples.rb
+- spec/roles_mongoid/strategy/multi/embed_many_roles_spec.rb
 - spec/roles_mongoid/strategy/multi/many_roles_spec.rb
 - spec/roles_mongoid/strategy/multi/role_strings_spec.rb
 - spec/roles_mongoid/strategy/multi/roles_mask_spec.rb
 - spec/roles_mongoid/strategy/single/admin_flag_spec.rb
+- spec/roles_mongoid/strategy/single/embed_one_role_spec.rb
 - spec/roles_mongoid/strategy/single/one_role_spec.rb
 - spec/roles_mongoid/strategy/single/role_string_spec.rb
 - spec/roles_mongoid/strategy/user_setup.rb