roles_mongo_mapper 0.3.0 → 0.3.1

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

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

@@ -9,13 +9,19 @@ module MongoMapper
       class_option :strategy, :type => :string, :default => 'role_string', 
                    :desc => "Role strategy to use (admin_flag, role_string, roles_string, role_strings, one_role, many_roles, roles_mask)"
 
-      class_option :logfile, :type => :string,   :default => nil,   :desc => "Logfile location"
-      class_option :roles, :type => :array, :default => [], :desc => "Valid roles"
+      class_option :logfile,      :type => :string,   :default => nil,   :desc => "Logfile location"
+      class_option :roles,        :type => :array,    :default => [], :desc => "Valid roles" 
+      class_option :role_class,   :type => :string,   :aliases => "-rc", :default => 'Role', :desc => "Role class"      
 
       def apply_role_strategy
         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 valid. The valid strategies are: #{valid_strategies.join(', ')}", :red
+          return
+        end
+
         if !has_model_file?(user_model_name)
           say "User model #{user_model_name} not found", :red
           return 
@@ -25,13 +31,11 @@ module MongoMapper
           insert_into_model user_model_name, :after => /include MongoMapper::\w+/ do
             insertion_text
           end     
-
-          unless read_model(:user) =~ /use_roles_strategy/
-            inject_into_file model_file(:user), "use_roles_strategy :#{strategy}\n\n", :before => "class"
-          end        
         rescue Exception => e
           logger.debug"Error: #{e.message}"
-        end
+        end 
+        
+        copy_role_class if role_class_strategy?
       end 
       
       protected                  
@@ -41,6 +45,26 @@ module MongoMapper
 
       use_orm :mongo_mapper
 
+      def role_class_strategy? 
+        # :embed_one_role, :embed_many_roles
+        [:one_role, :many_roles].include? strategy.to_sym
+      end
+
+      def valid_strategy?
+        valid_strategies.include? strategy.to_sym
+      end
+
+      def valid_strategies
+        # :embed_many_roles, :embed_one_role, 
+        [:admin_flag, :one_role, :role_string, :many_roles, :role_strings, :roles_mask]
+      end
+
+
+      def copy_role_class
+        logger.debug "copy_role_class: #{role_class.underscore}"
+        template 'role.rb', "app/models/#{role_class.underscore}.rb"
+      end
+
       def logfile
         options[:logfile]
       end
@@ -65,19 +89,24 @@ module MongoMapper
         roles_to_add.map{|r| ":#{r}" }
       end
 
-      def role_strategy_statement 
-        "strategy :#{strategy}, :default\n#{role_class_stmt}"
+      def role_class
+        options[:role_class].classify || 'Role'
       end
 
-      def role_class_stmt
-        "  role_class :role" if [:one_role, :many_roles].include? (strategy.to_sym)
+      def role_strategy_statement 
+        "strategy :#{strategy} #{strategy_options}"
       end
 
-      def roles_statement
+      def valid_roles_statement
         return '' if has_valid_roles_statement?
         roles ? "valid_roles_are #{roles.join(', ')}" : ''
       end
 
+      def strategy_options
+        return ", :role_class => :#{role_class.to_s.underscore}" if role_class_strategy? && role_class.to_s != 'Role'
+        ''
+      end
+
       def has_valid_roles_statement? 
         !(read_model(user_model_name) =~ /valid_roles_are/).nil?
       end
@@ -85,7 +114,7 @@ module MongoMapper
       def insertion_text
         %Q{include Roles::#{orm.to_s.camelize} 
   #{role_strategy_statement}
-  #{roles_statement}}
+  #{valid_roles_statement}}
       end
 
       def strategy

data/lib/generators/mongo_mapper/roles/templates/role.rb

@@ -0,0 +1,11 @@
+class <%= role_class %>
+  include MongoMapper::Document
+  key :name, String
+
+  validates_uniqueness_of :name
+
+  scope :by_name,  lambda { |name| where(:name => name.to_s) }
+  scope :by_names,  lambda { |*names| where(:name => names.to_strings) }
+  
+  extend RoleClass::ClassMethods
+end  

data/lib/roles_mongo_mapper/base.rb

@@ -15,9 +15,7 @@ module Roles::MongoMapper
     
     MAP = {
       :admin_flag   => "key :admin_flag, Boolean",
-      # :many_roles   => "references_many :many_roles, :stored_as => :array, :class_name => 'Role', :default => []",
-      # :one_role     => "references_one :one_role, :class_name => 'Role'",
-
+      
       # :embed_many_roles   => "many :many_roles, :class_name => 'Role'",
       # :embed_one_role     => "one :one_role, :class_name => 'Role'",
 
@@ -44,18 +42,27 @@ module Roles::MongoMapper
       raise ArgumentError, "Unknown role strategy #{strategy_name}" if !valid_strategies.include? strategy_name
       use_roles_strategy strategy_name
 
-      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
+      set_role_class(strategy_name, options) if strategies_with_role_class.include? strategy_name
       
       if default_options?(options) && MAP[strategy_name]
         instance_eval statement(MAP[strategy_name])
       end       
 
+      # one_role reference
+      if strategy_name == :one_role
+        key :one_role_id, ObjectId 
+        key :one_role, @role_class_name
+      end
+      
+      # many_roles references
+      if strategy_name == :many_roles
+        instance_eval %{
+          key :many_roles_ids, Array, :typecast => 'ObjectId'
+          many :many_roles, :class_name => '#{@role_class_name}', :in => :many_roles_ids 
+          ensure_index :many_role_ids     
+        }
+      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_name
@@ -70,6 +77,10 @@ module Roles::MongoMapper
 
     private
 
+    def set_role_class strategy_name, options = {}
+      @role_class_name = !options.kind_of?(Symbol) ? get_role_class(strategy_name, options) : default_role_class(strategy_name)
+    end
+
     def default_options? options = {}
       return true if options == :default                           
       if options.kind_of? Hash
@@ -84,7 +95,7 @@ module Roles::MongoMapper
 
     def default_role_class strategy_name
       if defined? ::Role
-        require "roles_mongo_mapper/role"
+        require "roles_mongo_mapper/role_class"
         return ::Role 
       end
       raise "Default Role class not defined"

data/lib/roles_mongo_mapper/role.rb

@@ -9,19 +9,11 @@ module Roles::Base
         end
       end
     end
-  end
+  end  
 end
 
-class Role
-  include MongoMapper::Document
-  key :name, String
-
-  validates_uniqueness_of :name
-
-  scope :by_name,  lambda { |name| where(:name => name.to_s) }
-  scope :by_names,  lambda { |*names| where(:name => names.to_strings) }
-
-  class << self
+module RoleClass
+  module ClassMethods
     def find_roles(*role_names)  
       role_names.flatten!
       by_names(role_names).all
@@ -33,6 +25,4 @@ class Role
       by_name(role_name).first
     end
   end
-end  
-
-
+end

data/lib/roles_mongo_mapper/role_class.rb

@@ -0,0 +1,13 @@
+class Role
+  include MongoMapper::Document
+  key :name, String
+
+  validates_uniqueness_of :name
+
+  scope :by_name,  lambda { |name| where(:name => name.to_s) }
+  scope :by_names,  lambda { |*names| where(:name => names.to_strings) }
+  
+  extend RoleClass::ClassMethods  
+end  
+
+

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

@@ -11,9 +11,9 @@ module RoleStrategy::MongoMapper
       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     
+      # 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     
     end
 
     module ClassMethods  

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

@@ -9,8 +9,8 @@ module RoleStrategy::MongoMapper
     def self.included base
       base.extend Roles::Generic::Role::ClassMethods
       base.extend ClassMethods
-      base.key :one_role_id, ObjectId 
-      base.key :one_role, Role
+      # base.key :one_role_id, ObjectId 
+      # base.key :one_role, Role
     end
 
     module ClassMethods 

data/roles_mongo_mapper.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{roles_mongo_mapper}
-  s.version = "0.3.0"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
-  s.date = %q{2010-12-27}
+  s.date = %q{2011-01-01}
   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 = [
@@ -24,11 +24,13 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "lib/generators/mongo_mapper/roles/roles_generator.rb",
+    "lib/generators/mongo_mapper/roles/templates/role.rb",
     "lib/roles_mongo_mapper.rb",
     "lib/roles_mongo_mapper/base.rb",
     "lib/roles_mongo_mapper/embedded_role.rb",
     "lib/roles_mongo_mapper/namespaces.rb",
     "lib/roles_mongo_mapper/role.rb",
+    "lib/roles_mongo_mapper/role_class.rb",
     "lib/roles_mongo_mapper/strategy.rb",
     "lib/roles_mongo_mapper/strategy/multi.rb",
     "lib/roles_mongo_mapper/strategy/multi/embed_many_roles.rb",

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

@@ -1,5 +1,8 @@
 require 'spec_helper'
 
+class Role
+end
+
 class User 
   include MongoMapper::Document  
   include Roles::MongoMapper 

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

@@ -1,4 +1,8 @@
 require 'spec_helper'
+
+class Role
+end
+
 class User 
   include MongoMapper::Document  
   include Roles::MongoMapper 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Kristian Mandrup
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-27 00:00:00 +01:00
+date: 2011-01-01 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -167,11 +167,13 @@ files:
 - Rakefile
 - VERSION
 - lib/generators/mongo_mapper/roles/roles_generator.rb
+- lib/generators/mongo_mapper/roles/templates/role.rb
 - lib/roles_mongo_mapper.rb
 - lib/roles_mongo_mapper/base.rb
 - lib/roles_mongo_mapper/embedded_role.rb
 - lib/roles_mongo_mapper/namespaces.rb
 - lib/roles_mongo_mapper/role.rb
+- lib/roles_mongo_mapper/role_class.rb
 - lib/roles_mongo_mapper/strategy.rb
 - lib/roles_mongo_mapper/strategy/multi.rb
 - lib/roles_mongo_mapper/strategy/multi/embed_many_roles.rb