roles_for_mongoid 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Kristian Mandrup
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,136 @@
+# Roles for Mongoid
+
+# Install
+
+<code>gem install roles_for_mongoid</code>
+
+# Usage
+
+The library comes with the following role models built-in:
+
+* Single inline role (string)
+* Multiple inline role (strings)
+* Multiple role relations (many relationship using array of object ids)
+
+Note: The following examples use RSpec to demonstrate usage scenarios.
+
+## Example : Admin flag
+
+<pre>
+require 'roles_for_mongoid'
+
+User.role_strategy :admin_flag
+
+before :each do
+  guest_user = User.new :name => 'Kristian', :role => 'guest'
+  admin_user = User.new :name => 'Admin user', :role => 'admin' 
+  admin_user.save                                        
+  guest_user.save
+end
+
+it "should return first user maching role" do
+  User.in_role('guest').first.name.should == 'Kristian'
+  User.in_role('admin').first.name.should == 'Admin user'
+end
+</pre>
+
+
+## Example : Single inline role
+
+<pre>
+User.role_strategy :inline_role
+
+before :each do
+  guest_user = User.new :name => 'Kristian', :role => 'guest'
+  admin_user = User.new :name => 'Admin user', :role => 'admin' 
+  admin_user.save                                        
+  guest_user.save
+end
+
+it "should return first user maching role" do
+  User.in_role('guest').first.name.should == 'Kristian'
+  User.in_role('admin').first.name.should == 'Admin user'
+end
+</pre>
+
+## Example : Multiple inline roles
+
+<pre>
+User.role_strategy :inline_roles
+
+before :each do
+  guest_user = User.new(:name => 'Kristian', :roles => ['guest']).save
+  admin_user = User.new(:name => 'Admin user', :roles => ['admin']).save
+  author_user = User.new(:name => 'Author', :roles => ['author']).save
+end
+
+it "should return first user matching role" do
+  User.in_role('admin').first.name.should == 'Admin user'
+end
+
+it "should return all users matching any of the roles" do
+  User.in_roles(['guest', 'admin']).all.size.should == 2
+  User.in_roles('guest', 'admin').all.size.should == 2
+end
+</pre>
+    
+## Example : Multiple role relations
+
+<pre>
+User.role_strategy :role_relations
+
+before :each do
+  guest_user = User.new(:name => 'Kristian')
+  admin_user = User.new(:name => 'Admin user')
+  author_user = User.new(:name => 'Author')
+
+  guest_user.roles << Role.new(:name => 'guest')
+  guest_user.save      
+
+  admin_user.roles << Role.new(:name => 'admin')
+  admin_user.save      
+  
+  author_user.roles << Role.new(:name => 'author')
+  author_user.save      
+end    
+
+it "should return first user matching role" do
+  User.in_role('guest').first.name.should == 'Kristian'
+  User.in_role('admin').first.name.should == 'Admin user'
+end
+
+it "should return all users matching any of the roles" do
+  User.in_roles(['guest', 'admin']).all.size.should == 2
+  User.in_roles('guest', 'admin').all.size.should == 2 
+end
+</pre>
+
+## Rails generator
+
+The library comes with a Rails 3 generator that lets you populate a user model with a given role strategy 
+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
+* inline_role
+* inline_roles
+* role_relations
+* role_mask
+
+Example:
+
+<code>$ rails g mongoid:roles user admin_flag</code>
+
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 Kristian Mandrup. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,42 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "roles_for_mongoid"
+    gem.summary = %Q{Facilitates adding Roles to your Mongoid user models}
+    gem.description = %Q{Facilitates adding Roles to your Mongoid user models}
+    gem.email = "kmandrup@gmail.com"
+    gem.homepage = "http://github.com/kristianmandrup/roles_for_mm"
+    gem.authors = ["Kristian Mandrup"]
+    gem.add_development_dependency "rspec", ">= 2.0.0.beta.17"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+# require 'spec/rake/spectask'
+# Spec::Rake::SpecTask.new(:spec) do |spec|
+#   spec.libs << 'lib' << 'spec'
+#   spec.spec_files = FileList['spec/**/*_spec.rb']
+# end
+# 
+# Spec::Rake::SpecTask.new(:rcov) do |spec|
+#   spec.libs << 'lib' << 'spec'
+#   spec.pattern = 'spec/**/*_spec.rb'
+#   spec.rcov = true
+# end
+# 
+# task :spec => :check_dependencies
+# 
+# task :default => :spec
+# 
+# require 'rake/rdoctask'
+# Rake::RDocTask.new do |rdoc|
+#   version = File.exist?('VERSION') ? File.read('VERSION') : ""
+# 
+#   rdoc.rdoc_dir = 'rdoc'
+#   rdoc.title = "roles_for_mm #{version}"
+#   rdoc.rdoc_files.include('README*')
+#   rdoc.rdoc_files.include('lib/**/*.rb')
+# end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

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

@@ -0,0 +1,45 @@
+module Mongoid 
+  module Generators
+    class RolesGenerator < Rails::Generators::NamedBase
+      desc "Generate roles model for User" 
+      
+      argument :role_strategy, :type => :string, :aliases => "-r", :default => 'inline_role', :desc => "Create roles model for user"
+
+      hook_for :orm
+            
+      def apply_role_strategy   
+        insert_into_model(model_name, role_strategy_statement)
+      end 
+      
+      protected                  
+
+      def model_name
+        name
+      end
+
+      def match_expr
+        /include Mongoid::Document/
+      end
+
+      def role_strategy_statement 
+        "role_strategy #{role_strategy}"        
+      end
+
+      def role_strategy
+        options[:role_strategy]                
+      end
+      
+      def model_file(name)                          
+        File.join(Rails.root, "app/models/#{name.to_s}.rb")        
+      end
+        
+      def insert_into_model(m_name, insert_text)
+        file = File.new(model_file(m_name))
+        return if (file.read =~ /#{insert_text}/) 
+        gsub_file model_file(m_name), match_expr do |match|
+          match << insert_text
+        end
+      end              
+    end
+  end
+end

data/lib/roles_for_mongoid.rb

@@ -0,0 +1 @@
+require 'roles_for_mongoid/user'

data/lib/roles_for_mongoid/role.rb

@@ -0,0 +1,4 @@
+class Role
+  include Mongoid::Document
+  field :name, :type => String  
+end  

data/lib/roles_for_mongoid/strategies/admin_flag.rb

@@ -0,0 +1,17 @@
+module Mongoid::AdminFlag        
+  def self.included base
+    base.extend ClassMethods
+    base.field :admin, :type => Boolean      
+  end
+
+  module ClassMethods      
+    def in_role(role_name) 
+      case role_name.downcase.to_sym
+      when :admin
+        where(:admin => true)
+      else
+        where(:admin => false)
+      end          
+    end
+  end
+end

data/lib/roles_for_mongoid/strategies/inline_role.rb

@@ -0,0 +1,6 @@
+module Mongoid::InlineRole
+  def self.included base
+    base.field :role, :type => String
+    base.scope :in_role,  lambda { |role_name| base.where(:role => role_name) }  
+  end
+end

data/lib/roles_for_mongoid/strategies/inline_roles.rb

@@ -0,0 +1,13 @@
+module Mongoid::InlineRoles
+  def self.included base
+    base.extend ClassMethods      
+    base.field :roles, :type => Array
+    base.scope :in_role,   lambda { |role_name|  base.where(:roles => [role_name]) }
+  end
+
+  module ClassMethods
+    def in_roles(*roles)
+      where(:roles.in => roles.flatten)
+    end
+  end
+end

data/lib/roles_for_mongoid/strategies/role_relations.rb

@@ -0,0 +1,29 @@
+require 'roles_for_mongoid/role'
+
+module Mongoid::RoleRelations
+  def self.included base
+    base.extend ClassMethods
+    base.references_many :roles, :stored_as => :array
+  end
+
+  module ClassMethods    
+    def in_role(role_name)  
+      in_roles(role_name)
+    end
+
+    def in_roles *role_names
+      roles = Role.where(:name.in => role_names.flatten).to_a
+      arr_ids = roles.map{|role| role._id}  
+      all.to_a.select do |user|
+        user.roles.to_a.any? do |role| 
+          arr_ids.include?(role._id)
+        end
+      end
+    end
+
+    # def in_roles(*roles)                          
+    #   role_ids = Role.where(:name => roles.flatten).to_a
+    #   where(:roles.in => role_ids).to_a
+    # end
+  end
+end

data/lib/roles_for_mongoid/strategies/roles_mask.rb

@@ -0,0 +1,52 @@
+module Mongoid
+  module RolesMask
+    def self.included base
+      base.extend ClassMethods      
+      base.field :roles_mask, :type => Integer, :default => 1
+    end
+
+    module ClassMethods
+      attr_accessor :available_roles    
+  
+      def in_role(role)     
+        mask = calc_index(role.to_s)
+        all.select do |user| 
+          (user.roles_mask & mask) > 0
+        end
+      end    
+
+      def in_roles(*roles)
+        all.select do |user| 
+          roles.flatten.any? do |role|
+            mask = calc_index(role.to_s)
+            (user.roles_mask & mask) > 0
+          end
+        end
+      end    
+  
+      def calc_index(r)
+        2**available_roles.index(r)
+      end      
+    end
+
+    def available_roles
+      self.class.available_roles    
+    end
+
+    def calc_index(r)
+      self.class.calc_index(r)
+    end
+
+    def roles=(*roles)    
+      self.roles_mask = (roles.flatten & available_roles).map { |r| calc_index(r) }.sum
+    end
+
+    def roles
+      self.available_roles.reject { |r| ((roles_mask || 0) & self.calc_index(r)).zero? }
+    end
+
+    def role?(role)
+      roles.include?(role.to_s)
+    end
+  end
+end

data/lib/roles_for_mongoid/user.rb

@@ -0,0 +1,12 @@
+require 'require_all'
+require 'active_support/inflector'
+
+class User    
+  include Mongoid::Document
+  
+  def self.role_strategy type
+    include "Mongoid::#{type.to_s.camelize}".constantize    
+  end
+end
+
+require_all File.dirname(__FILE__) + '/strategies'

data/sandbox/test.rb

@@ -0,0 +1,48 @@
+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
+
+  # todo: make this work instead!
+  # def self.get_roles(*ids)
+  #   arr = ids.flatten
+  #   where(:'roles._id'.in => 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/spec/roles_for_mongoid/user_admin_field_spec.rb

@@ -0,0 +1,24 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+User.role_strategy :admin_flag
+
+describe "Roles for Mongoid" do
+  after :each do
+    Database.teardown
+  end
+
+  before :each do
+    guest_user = User.new :name => 'Kristian', :admin => false
+    admin_user = User.new :name => 'Admin user', :admin => true
+    admin_user.save                                        
+    guest_user.save
+  end
+
+  describe "Admin flag strategy " do
+
+    it "should return first user maching role" do
+      User.in_role('guest').first.name.should == 'Kristian'
+      User.in_role('admin').first.name.should == 'Admin user'
+    end
+  end
+end

data/spec/roles_for_mongoid/user_inline_role_spec.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+User.role_strategy :inline_role
+
+describe "Roles for Mongoid" do
+  after :each do
+    Database.teardown
+  end
+
+  before :each do
+    guest_user = User.new :name => 'Kristian', :role => 'guest'
+    admin_user = User.new :name => 'Admin user', :role => 'admin' 
+    admin_user.save                                        
+    guest_user.save
+  end
+
+  describe "Inline role strategy" do
+    it "should return first user maching role" do
+      User.in_role('guest').first.name.should == 'Kristian'
+      User.in_role('admin').first.name.should == 'Admin user'
+    end
+  end
+end

data/spec/roles_for_mongoid/user_inline_roles_spec.rb

@@ -0,0 +1,27 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+User.role_strategy :inline_roles
+
+describe "Roles for Mongoid" do
+  after :each do
+    Database.teardown
+  end
+
+  before :each do
+    guest_user = User.new(:name => 'Kristian', :roles => ['guest']).save
+    admin_user = User.new(:name => 'Admin user', :roles => ['admin']).save
+    author_user = User.new(:name => 'Author', :roles => ['author']).save
+  end
+
+  describe "Inline roles strategy" do
+
+    it "should return first user matching role" do
+      User.in_role('admin').first.name.should == 'Admin user'
+    end
+
+    it "should return all users matching any of the roles" do 
+      User.in_roles(['guest', 'admin']).to_a.size.should == 2
+      User.in_roles('guest', 'admin').to_a.size.should == 2
+    end
+  end
+end

data/spec/roles_for_mongoid/user_role_relations_spec.rb

@@ -0,0 +1,37 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+User.role_strategy :role_relations
+
+describe "Roles for Mongoid" do  
+  
+  after :each do
+    Database.teardown
+  end
+
+  before :each do
+    guest_user = User.create(:name => 'Kristian')
+    admin_user = User.create(:name => 'Admin user')
+    author_user = User.create(:name => 'Author')
+
+    guest_user.roles.create(:name => 'guest')
+    guest_user.save      
+
+    admin_user.roles.create(:name => 'admin')
+    admin_user.save      
+
+    author_user.roles.create(:name => 'author')
+    author_user.save      
+  end    
+  
+  describe "Role relations strategy" do
+    it "should return first user matching role" do    
+      User.in_role('guest').first.name.should == 'Kristian'      
+      User.in_role('admin').first.name.should == 'Admin user'
+    end
+    
+    # it "should return all users matching any of the roles" do
+    #   User.in_roles(['guest', 'admin']).all.size.should == 2
+    #   User.in_roles('guest', 'admin').all.size.should == 2 
+    # end    
+  end
+end  

data/spec/roles_for_mongoid/user_roles_mask_spec.rb

@@ -0,0 +1,29 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+User.role_strategy :roles_mask
+
+describe "Roles for Mongoid" do
+  describe "Roles mask strategy" do
+
+    after :each do
+      Database.teardown
+    end
+
+    before :each do
+      User.available_roles = ['guest', 'admin', 'author']
+      
+      User.new(:name => 'Kristian', :roles => ['guest']).save
+      User.new(:name => 'Admin user', :roles => ['admin']).save
+      User.new(:name => 'Author', :roles => ['author']).save               
+    end
+
+    it "should return first user matching role" do
+      User.in_role('admin').first.name.should == 'Admin user'
+    end
+
+    it "should return all users matching any of the roles" do
+      User.in_roles(['guest', 'admin']).size.should == 2
+      User.in_roles('guest', 'admin').size.should == 2
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'rspec'
+require 'rspec/autorun'
+require 'mongoid'
+require 'roles_for_mongoid'
+                 
+Mongoid.configure.master = Mongo::Connection.new.db('roles_for_mongoid')
+
+module Database
+  def self.teardown
+    Mongoid.database.collections.each do |coll|
+      coll.remove
+    end
+  end
+end
+
+RSpec.configure do |config|
+  
+end
+
+

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: roles_for_mongoid
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Kristian Mandrup
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-02 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 17
+        version: 2.0.0.beta.17
+  type: :development
+  version_requirements: *id001
+description: Facilitates adding Roles to your Mongoid user models
+email: kmandrup@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- lib/generators/mongoid/roles/roles_generator.rb
+- lib/roles_for_mongoid.rb
+- lib/roles_for_mongoid/role.rb
+- lib/roles_for_mongoid/strategies/admin_flag.rb
+- lib/roles_for_mongoid/strategies/inline_role.rb
+- lib/roles_for_mongoid/strategies/inline_roles.rb
+- lib/roles_for_mongoid/strategies/role_relations.rb
+- lib/roles_for_mongoid/strategies/roles_mask.rb
+- lib/roles_for_mongoid/user.rb
+- sandbox/test.rb
+- spec/roles_for_mongoid/user_admin_field_spec.rb
+- spec/roles_for_mongoid/user_inline_role_spec.rb
+- spec/roles_for_mongoid/user_inline_roles_spec.rb
+- spec/roles_for_mongoid/user_role_relations_spec.rb
+- spec/roles_for_mongoid/user_roles_mask_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/kristianmandrup/roles_for_mm
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Facilitates adding Roles to your Mongoid user models
+test_files: 
+- spec/roles_for_mongoid/user_admin_field_spec.rb
+- spec/roles_for_mongoid/user_inline_role_spec.rb
+- spec/roles_for_mongoid/user_inline_roles_spec.rb
+- spec/roles_for_mongoid/user_role_relations_spec.rb
+- spec/roles_for_mongoid/user_roles_mask_spec.rb
+- spec/spec_helper.rb