roles_mongo_mapper 0.2.2 → 0.3.0

data/README.markdown

@@ -1,47 +1,75 @@
 # Roles for Mongo Mapper
 
-A *Mongo Mapper* implementation of [roles generic](http://github.com/kristianmandrup/roles_generic)
+A Mongo Mapper implementation of [Roles Generic](http://github.com/kristianmandrup/roles_generic)
+See the Roles [wiki](http://github.com/kristianmandrup/roles_generic/wiki) for an overview of the API and how to use it.
 
-## Intro
+## Role strategies
 
-Implements the [roles generic](http://github.com/kristianmandrup/roles_generic) Roles API
+Role strategies implemented:
 
-Generic Role strategies implemented:
+Inline attribute on User:
 
 * 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.
+Reference to Role:
+
+* many_roles
+* one_role
+
+*Update Dec 24, 2010*
+
+Embedded role:
 
 * embed_one_role
 * embed_many_roles
 
-Please join in the effort to implement and add these strategies to the mix.
+Please join in the effort to implement and add these embedded strategies to the mix. 
+They have so far been implemented successfully for Mongoid.
 
-## Install
+## Install as system gem
 
 <code>gem install roles_mongo_mapper</code>
 
-## Rails generator
+## Install in Rails app
 
-The library comes with a Rails 3 generator that lets you populate a user model with a role strategy of your choice. 
+Insert in Gemfile:
 
-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.
+<code>gem 'roles_mongo_mapper'</code>
 
-* admin_flag
-* many_roles
-* one_role
-* roles_mask
-* role_string
-* role_strings
+Run <code>$ bundle install</code> from terminal
+
+Alternatively install using [Cream](http://github.com/kristianmandrup/cream)
+
+## Strategy and roles configuration
+
+Example: _role_string_ strategy
+
+<pre>class User
+  include MongoMapper::Document  
+  include Roles::MongoMapper 
+
+  strategy :one_role
+  valid_roles_are :admin, :guest, :user
+end  
+</pre>
+
+Example: _one_role_ strategy
 
-*Roles generator*
+<pre>class User
+  include MongoMapper::Document  
+  include Roles::MongoMapper 
+
+  strategy :one_role
+  valid_roles_are :admin, :guest, :user
+end  
+</pre>
+
+## Rails generator
+
+The library comes with a Rails 3 generator that lets you populate a user model with a role strategy of your choice. 
 
 Apply :admin_flag Role strategy to User model using default roles :admin and :guest (default)
 
@@ -55,7 +83,6 @@ Apply :one_role Role strategy to User model without default roles, only with rol
 
 <code>$ rails g mongo_mapper: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.2.2
+0.3.0

data/lib/roles_mongo_mapper/base.rb

@@ -26,26 +26,77 @@ module Roles::MongoMapper
       :role_strings => "key :role_strings,  Array",
       :roles_string => "key :roles_string,  String"
     }
+
+    def valid_single_strategies
+      [:admin_flag, :one_role, :role_string]
+    end
+
+    def valid_multi_strategies
+      [:many_roles, :roles_mask, :role_strings]
+    end
+
+    def valid_strategies
+      valid_single_strategies + valid_multi_strategies
+    end
     
     def strategy name, options = {}
-      if (options == :default || options[:config] == :default) && MAP[name]
-        instance_eval MAP[name] 
-      end
+      strategy_name = name.to_sym
+      raise ArgumentError, "Unknown role strategy #{strategy_name}" if !valid_strategies.include? strategy_name
+      use_roles_strategy strategy_name
 
-      if !options.kind_of? Symbol
-        role_class = options[:role_class] ? options[:role_class].to_s.camelize.constantize : (Role if defined? Role)
+      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
+      
+      if default_options?(options) && MAP[strategy_name]
+        instance_eval statement(MAP[strategy_name])
+      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
+      #   raise ArgumentError, "#strategy class method must take :role_class option when using an embedded role strategy" if !@role_class_name
+      #   @role_class_name.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
+      #   raise ArgumentError, "#strategy class method must take :role_class option when using an embedded role strategy" if !@role_class_name
+      #   @role_class_name.embedded_in :user, :inverse_of => :many_roles
       # end
-      
-      set_role_strategy name, options
+
+      set_role_strategy strategy_name, options
     end    
+
+    private
+
+    def default_options? options = {}
+      return true if options == :default                           
+      if options.kind_of? Hash
+        return true # if options[:config] == :default || options == {} 
+      end
+      false
+    end
+
+    def statement code_str
+      code_str.gsub /Role/, @role_class_name.to_s
+    end
+
+    def default_role_class strategy_name
+      if defined? ::Role
+        require "roles_mongo_mapper/role"
+        return ::Role 
+      end
+      raise "Default Role class not defined"
+    end
+
+    def strategies_with_role_class
+      # :embed_one_role, :embed_many_roles
+      [:one_role, :many_roles]
+    end 
+
+    def get_role_class strategy_name, options
+      options[:role_class] ? options[:role_class].to_s.camelize.constantize : default_role_class(strategy_name)
+    end      
   end
 end

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

@@ -9,6 +9,8 @@ module RoleStrategy::MongoMapper
     def self.included base
       base.extend Roles::Generic::Role::ClassMethods
       base.extend ClassMethods
+      
+      # TODO - refactor into strategy method in base.rb 
       base.key :many_roles_ids, Array, :typecast => 'ObjectId'
       base.many :many_roles, :class_name => 'Role', :in => :many_roles_ids 
       base.ensure_index :many_role_ids     

data/roles_mongo_mapper.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{roles_mongo_mapper}
-  s.version = "0.2.2"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
-  s.date = %q{2010-12-21}
+  s.date = %q{2010-12-27}
   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 = [

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

@@ -1,12 +1,10 @@
 require 'spec_helper'
-use_roles_strategy :many_roles
 
 class User 
   include MongoMapper::Document  
   include Roles::MongoMapper 
   
-  strategy :many_roles, :default
-  role_class :role    
+  strategy :many_roles
   valid_roles_are :admin, :guest, :user  
 
   key :name, :type => String  

data/spec/roles_mongo_mapper/strategy/multi/role_strings_spec.rb

@@ -1,11 +1,9 @@
 require 'spec_helper'
-use_roles_strategy :role_strings
-
 class User 
   include MongoMapper::Document  
   include Roles::MongoMapper 
   
-  strategy :role_strings, :default
+  strategy :role_strings
   valid_roles_are :admin, :guest, :user  
 
   key :name, :type => String  

data/spec/roles_mongo_mapper/strategy/multi/roles_mask_spec.rb

@@ -1,11 +1,9 @@
 require 'spec_helper'
-use_roles_strategy :roles_mask
-
 class User 
   include MongoMapper::Document  
   include Roles::MongoMapper 
   
-  strategy :roles_mask, :default
+  strategy :roles_mask
   valid_roles_are :admin, :guest, :user  
 
   key :name, :type => String  

data/spec/roles_mongo_mapper/strategy/single/admin_flag_spec.rb

@@ -1,11 +1,9 @@
 require 'spec_helper'
-use_roles_strategy :admin_flag
-
 class User 
   include MongoMapper::Document  
   include Roles::MongoMapper 
   
-  strategy :admin_flag, :default
+  strategy :admin_flag
   valid_roles_are :admin, :guest  
 
   key :name, :type => String  

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

@@ -1,12 +1,9 @@
 require 'spec_helper'
-use_roles_strategy :one_role
-
 class User 
   include MongoMapper::Document  
   include Roles::MongoMapper 
   
-  strategy :one_role, :default
-  role_class :role  
+  strategy :one_role
   valid_roles_are :admin, :guest  
 
   key :name, :type => String  

data/spec/roles_mongo_mapper/strategy/single/role_string_spec.rb

@@ -1,11 +1,9 @@
 require 'spec_helper'
-use_roles_strategy :role_string
-
 class User 
   include MongoMapper::Document  
   include Roles::MongoMapper 
   
-  strategy :role_string, :default
+  strategy :role_string
   valid_roles_are :admin, :guest  
 
   key :name, :type => String  

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 2
-  version: 0.2.2
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Kristian Mandrup
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-21 00:00:00 +01:00
+date: 2010-12-27 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency