roles_mongo_mapper 0.1.1

data/lib/roles_mongo_mapper/strategy/multi/roles_mask.rb

@@ -0,0 +1,81 @@
+module RoleStrategy::MongoMapper
+  module RolesMask
+    def self.default_role_attribute
+      :roles_mask
+    end
+
+    def self.included base
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def role_attribute
+        strategy_class.roles_attribute_name.to_sym
+      end 
+
+      def in_role(role)     
+        mask = calc_index(role.to_s)
+        all.select do |user| 
+          (user.send(role_attribute) & mask) > 0
+        end
+      end    
+
+      def in_roles(*roles)
+        all.select do |user| 
+          roles.flatten.any? do |role|
+            mask = calc_index(role.to_s)
+            (user.send(role_attribute) & mask) > 0
+          end
+        end
+      end    
+  
+      def calc_index(r)
+        2**strategy_class.valid_roles.index(r.to_sym)
+      end 
+    end
+
+    module Implementation 
+      class Roles < ::Set # :nodoc:
+        attr_reader :model_instance
+
+        def initialize(sender, *roles)
+          super(*roles)
+          @model_instance = sender
+        end
+
+        def <<(role)
+          model_instance.roles = super.to_a
+          self
+        end
+      end
+
+      def role_attribute
+        strategy_class.roles_attribute_name
+      end 
+
+      # assign roles
+      def roles=(*roles)
+        self.send("#{role_attribute}=", (roles.flatten.map { |r| r.to_sym } & strategy_class.valid_roles).map { |r| calc_index(r) }.inject { |sum, bitvalue| sum + bitvalue })
+      end
+      alias_method :role=, :roles=
+      
+      # query assigned roles
+      def roles
+        strategy_class::Roles.new(self, strategy_class.valid_roles.reject { |r| ((self.send(role_attribute) || 0) & calc_index(r)).zero? })
+      end
+
+      def roles_list
+        roles.to_a
+      end        
+
+      protected
+
+      def calc_index(r)
+        2**strategy_class.valid_roles.index(r)
+      end
+    end    
+    
+    extend Roles::Generic::User::Configuration
+    configure            
+  end
+end

data/lib/roles_mongo_mapper/strategy/single/admin_flag.rb

@@ -0,0 +1,50 @@
+module RoleStrategy::MongoMapper
+  module AdminFlag
+    
+    def self.default_role_attribute
+      :admin_flag
+    end
+
+    def self.included base
+      base.extend ClassMethods
+    end
+
+    module ClassMethods 
+      def role_attribute
+        strategy_class.roles_attribute_name.to_sym
+      end
+           
+      def in_role(role_name) 
+        case role_name.downcase.to_sym
+        when :admin
+          where(role_attribute => true)
+        else
+          where(role_attribute => false)
+        end          
+      end
+    end
+
+    module Implementation          
+      # assign roles
+      def roles=(*new_roles)                                 
+        first_role = new_roles.flatten.first
+        if valid_role?(first_role)
+          self.send("#{role_attribute}=", new_roles.flatten.first.admin?) 
+        else
+          raise ArgumentError, "The role #{first_role} is not a valid role"
+        end
+      end
+
+      # query assigned roles
+      def roles
+        role = self.send(role_attribute) ? strategy_class.admin_role_key : strategy_class.default_role_key
+        [role]
+      end
+      alias_method :roles_list, :roles
+
+    end # Implementation
+    
+    extend Roles::Generic::User::Configuration
+    configure :num => :single
+  end   
+end

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

@@ -0,0 +1,72 @@
+module RoleStrategy::MongoMapper
+  module OneRole
+    def self.default_role_attribute
+      :one_role
+    end
+
+    def self.included base
+      base.extend Roles::Generic::Role::ClassMethods
+      base.extend ClassMethods
+      base.key :one_role_id, ObjectId 
+      base.key :one_role, Role
+    end
+
+    module ClassMethods 
+      def role_attribute
+        strategy_class.roles_attribute_name.to_sym
+      end       
+
+      def role_id_attribute
+        "#{role_attribute}_id".to_sym
+      end       
+               
+      def in_role(role_name)  
+        begin
+          role = Role.find_role(role_name)
+          all(role_id_attribute => role.id)
+        rescue
+          return []
+        end
+      end
+
+      def in_roles(*role_names)
+        begin
+          role_ids = Role.find_roles(role_names)
+          my_id = send(role_attribute).id
+          all(role_id_attribute.in => role_ids)
+        rescue 
+          return []
+        end
+      end  
+    end
+
+    module Implementation
+      def role_id_attribute
+        "#{role_attribute}_id".to_sym
+      end       
+            
+      # assign roles
+      def roles=(*roles)      
+        raise "Role class #{role_class} does not have a #find_role(role) method" if !role_class.respond_to? :find_role
+        first_role = roles.flatten.first
+        role_relation = role_class.find_role(first_role)
+        if role_relation
+          self.send("#{role_attribute}=", role_relation)
+          self.send("#{role_id_attribute}=", role_relation.id)
+          self.save
+        end
+      end
+      alias_method :role=, :roles=
+      
+      # query assigned roles
+      def roles
+        [self.send(role_attribute).name.to_sym]
+      end
+      alias_method :roles_list, :roles
+            
+    end
+
+    extend Roles::Generic::User::Configuration
+    configure :num => :single, :type => :role_class
+  end  
+end

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

@@ -0,0 +1,51 @@
+module RoleStrategy::MongoMapper
+  module RoleString    
+    def self.default_role_attribute
+      :role_string
+    end
+
+    def self.included base
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def role_attribute
+        strategy_class.roles_attribute_name.to_sym
+      end 
+
+      def in_role(role_name) 
+        where(role_attribute => role_name)
+      end
+    end
+
+    
+    module Implementation 
+      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
+    end
+
+    extend Roles::Generic::User::Configuration
+    configure :num => :single
+  end
+end
+
+

data/logging.log

@@ -0,0 +1,8 @@
+[Rails::Assist::Logging]
+apply_role_strategy for : admin_flag in model User
+[Rails::Assist::Logging]
+apply_role_strategy for : one_role in model User
+[Rails3::Assist::Logging]
+apply_role_strategy for : admin_flag in model User
+[Rails3::Assist::Logging]
+apply_role_strategy for : one_role in model User

data/roles_mongo_mapper.gemspec

@@ -0,0 +1,103 @@
+# 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_mongo_mapper}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kristian Mandrup"]
+  s.date = %q{2010-09-20}
+  s.description = %q{Makes it easy to set a role strategy on your User model in MongoMapper}
+  s.email = %q{kmandrup@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     ".rspec",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "lib/generators/mongo_mapper/roles/roles_generator.rb",
+     "lib/roles_mongo_mapper.rb",
+     "lib/roles_mongo_mapper/base.rb",
+     "lib/roles_mongo_mapper/namespaces.rb",
+     "lib/roles_mongo_mapper/role.rb",
+     "lib/roles_mongo_mapper/strategy.rb",
+     "lib/roles_mongo_mapper/strategy/multi/many_roles.rb",
+     "lib/roles_mongo_mapper/strategy/multi/role_strings.rb",
+     "lib/roles_mongo_mapper/strategy/multi/roles_mask.rb",
+     "lib/roles_mongo_mapper/strategy/single/admin_flag.rb",
+     "lib/roles_mongo_mapper/strategy/single/one_role.rb",
+     "lib/roles_mongo_mapper/strategy/single/role_string.rb",
+     "logging.log",
+     "roles_mongo_mapper.gemspec",
+     "sandbox/test.rb",
+     "spec/generator_spec_helper.rb",
+     "spec/roles_mongo_mapper/generators/roles_generator_spec.rb",
+     "spec/roles_mongo_mapper/strategy/admin_flag_spec.rb",
+     "spec/roles_mongo_mapper/strategy/many_roles_spec.rb",
+     "spec/roles_mongo_mapper/strategy/one_role_spec.rb",
+     "spec/roles_mongo_mapper/strategy/role_string_spec.rb",
+     "spec/roles_mongo_mapper/strategy/role_strings_spec.rb",
+     "spec/roles_mongo_mapper/strategy/roles_mask_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/kristianmandrup/roles_mongo_mapper}
+  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 MongoMapper}
+  s.test_files = [
+    "spec/generator_spec_helper.rb",
+     "spec/roles_mongo_mapper/generators/roles_generator_spec.rb",
+     "spec/roles_mongo_mapper/strategy/admin_flag_spec.rb",
+     "spec/roles_mongo_mapper/strategy/many_roles_spec.rb",
+     "spec/roles_mongo_mapper/strategy/one_role_spec.rb",
+     "spec/roles_mongo_mapper/strategy/role_string_spec.rb",
+     "spec/roles_mongo_mapper/strategy/role_strings_spec.rb",
+     "spec/roles_mongo_mapper/strategy/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_development_dependency(%q<generator-spec>, ["~> 0.6.4"])
+      s.add_runtime_dependency(%q<mongo_mapper>, ["~> 0.8.4"])
+      s.add_runtime_dependency(%q<activesupport>, ["~> 3.0.0"])
+      s.add_runtime_dependency(%q<require_all>, ["~> 1.1.0"])
+      s.add_runtime_dependency(%q<sugar-high>, ["~> 0.2.10"])
+      s.add_runtime_dependency(%q<roles_generic>, ["~> 0.2.6"])
+      s.add_runtime_dependency(%q<logging_assist>, ["~> 0.1.3"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.0.0.beta.22"])
+      s.add_dependency(%q<generator-spec>, ["~> 0.6.4"])
+      s.add_dependency(%q<mongo_mapper>, ["~> 0.8.4"])
+      s.add_dependency(%q<activesupport>, ["~> 3.0.0"])
+      s.add_dependency(%q<require_all>, ["~> 1.1.0"])
+      s.add_dependency(%q<sugar-high>, ["~> 0.2.10"])
+      s.add_dependency(%q<roles_generic>, ["~> 0.2.6"])
+      s.add_dependency(%q<logging_assist>, ["~> 0.1.3"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.0.0.beta.22"])
+    s.add_dependency(%q<generator-spec>, ["~> 0.6.4"])
+    s.add_dependency(%q<mongo_mapper>, ["~> 0.8.4"])
+    s.add_dependency(%q<activesupport>, ["~> 3.0.0"])
+    s.add_dependency(%q<require_all>, ["~> 1.1.0"])
+    s.add_dependency(%q<sugar-high>, ["~> 0.2.10"])
+    s.add_dependency(%q<roles_generic>, ["~> 0.2.6"])
+    s.add_dependency(%q<logging_assist>, ["~> 0.1.3"])
+  end
+end
+

data/sandbox/test.rb

@@ -0,0 +1,19 @@
+require 'mongo_mapper'
+                 
+MongoMapper.database = 'roles_for_mm'
+
+class User    
+  include MongoMapper::Document
+
+  key :name, String
+end
+
+User.create(:name => 'Kristian').save
+
+puts User.first.id.inspect
+
+u = User.where(:'_id' => User.first.id).first
+puts u.inspect
+
+
+

data/spec/generator_spec_helper.rb

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

data/spec/roles_mongo_mapper/generators/roles_generator_spec.rb

@@ -0,0 +1,59 @@
+require 'generator_spec_helper'
+require_generator :mongo_mapper => :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: mongo_mapper' do  
+    use_orm :mongo_mapper
+    
+    before :each do              
+      setup_generator 'mongo_mapper_roles_generator' do
+        tests MongoMapper::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
+        g.should generate_model :user do |clazz|
+          clazz.should include_module 'MongoMapper::Document'
+          clazz.should include_module 'Roles::MongoMapper'
+          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
+        g.should generate_model :user do |clazz|
+          clazz.should include_module 'MongoMapper::Document'
+          clazz.should include_module 'Roles::MongoMapper'
+          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
+