roles_for_mongoid 0.2.0 → 0.2.1

data/README.markdown

@@ -2,11 +2,7 @@
 
 A Mongoid implementation of [roles generic](http://github.com/kristianmandrup/roles_generic)
 
-# Install
-
-<code>gem install roles_mongoid</code>
-
-## Status: Sept 6, 2010
+## Intro
 
 Implements the [roles generic](http://github.com/kristianmandrup/roles_generic) Roles API
 It also implements the following Role strategies:
@@ -18,6 +14,10 @@ It also implements the following Role strategies:
 * role_string
 * role_strings
 
+# Install
+
+<code>gem install roles_mongoid</code>
+
 ## Rails generator
 
 Might work but needs testing ;)

data/Rakefile

@@ -2,45 +2,22 @@ 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.summary = %Q{Implementation of Roles generic API for Mongoid}
+    gem.description = %Q{Makes it easy to set a role strategy on your User model in Mongoid}
     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.19"
-    gem.add_dependency "mongoid", '~> 2.0.0.beta.17'
-    gem.add_dependency "require_all", '~> 1.1.0' 
-    gem.add_dependency "sugar-high", '~> 0.2.3'        
-    gem.add_dependency "roles_generic", '~> 0.2.2'        
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+    gem.add_development_dependency "rspec", '~> 2.0.0.beta.19'
+
+    gem.add_dependency "mongoid",           '~> 2.0.0.beta.17'
+    gem.add_dependency "activesupport",     '~> 3.0.0'
+    gem.add_dependency "require_all",       '~> 1.1.0' 
+    gem.add_dependency "sugar-high",        '~> 0.2.3'        
+    gem.add_dependency "roles_generic",     '~> 0.2.2'        
+
   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

@@ -1 +1 @@
-0.2.0
+0.2.1

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

@@ -1,10 +1,9 @@
 require 'rails3_artifactor'
+require 'logging_assist'
 
-module RolesModel 
+module Mongoid 
   module Generators
-    class RolesGenerator < Rails::Generators::NamedBase
-      include Rails3::Assist::Artifact::Model
-      
+    class RolesGenerator < Rails::Generators::NamedBase      
       desc "Add role strategy to a model" 
       
       class_option :strategy, :type => :string, :aliases => "-s", :default => 'role_string', 
@@ -13,14 +12,9 @@ module RolesModel
 
       class_option :roles, :type => :array, :aliases => "-r", :default => [], :desc => "Valid roles"
 
-      # hook_for :orm
-            
-      # def self.source_root
-      #   @source_root ||= File.expand_path("../../templates", __FILE__)
-      # end
-
-      def apply_role_strategy        
-        self.class.use_orm orm if orm
+      def apply_role_strategy
+        log.add_logfile
+        log.debug "apply_role_strategy for : #{strategy} in model #{name}"
         insert_into_model name do
           insertion_text
         end
@@ -28,6 +22,10 @@ module RolesModel
       
       protected                  
 
+      extend Rails3::Assist::UseMacro
+      use_orm :mongoid
+      include Rails::Assist::BasicLogging
+
       def orm
         :mongoid
       end
@@ -37,27 +35,29 @@ module RolesModel
       end
 
       def roles_to_add
-        default_roles.concat(options[:roles]).compact.uniq
+        @roles_to_add ||= default_roles.concat(options[:roles]).to_symbols.uniq
       end
 
-      def roles
-        @roles ||= roles_to_add.map{|r| ":#{r}" }
+      def roles        
+        roles_to_add.map{|r| ":#{r}" }
       end
 
       def role_strategy_statement 
-        "strategy :#{strategy}\n"
+        "strategy :#{strategy}, :default\n#{role_class_stmt}"
+      end
+
+      def role_class_stmt
+        "  role_class :role" if [:one_role, :many_roles].include? (strategy.to_sym)
       end
 
       def roles_statement
-        roles ? "valid_roles #{roles.join(',')}" : ''
+        roles ? "valid_roles_are #{roles.join(', ')}" : ''
       end
 
       def insertion_text
-        %Q{  
-  include Roles::#{orm.to_s.camelize} 
+        %Q{include Roles::#{orm.to_s.camelize} 
   #{role_strategy_statement}
-  #{roles_statement}
-}
+  #{roles_statement}}
       end
 
       def strategy

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

@@ -44,7 +44,7 @@ module RoleStrategy::Mongoid
       def add_roles(*roles)  
         raise "Role class #{role_class} does not have a #find_role(role) method" if !role_class.respond_to? :find_role
         role_relations = role_class.find_roles(*roles)
-        self.many_roles << role_relations
+        self.send(role_attribute) << role_relations
         save
       end
 

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

@@ -27,10 +27,6 @@ module RoleStrategy::Mongoid
     end
     
     module Implementation 
-      def role_attribute
-        strategy_class.roles_attribute_name
-      end 
-
       # assign roles
       def roles=(*new_roles)
         new_roles = new_roles.flatten.map{|r| r.to_s if valid_role?(r)}.compact

data/roles_for_mongoid.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{roles_for_mongoid}
-  s.version = "0.2.0"
+  s.version = "0.2.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-06}
-  s.description = %q{Facilitates adding Roles to your Mongoid user models}
+  s.date = %q{2010-09-11}
+  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 = [
     "LICENSE",
@@ -40,21 +40,27 @@ Gem::Specification.new do |s|
      "sandbox/roles_assign.rb",
      "sandbox/single_role.rb",
      "sandbox/test.rb",
+     "spec/generator_spec_helper.rb",
+     "spec/generators/roles_generator_spec.rb",
      "spec/roles_mongoid/admin_flag_spec.rb",
      "spec/roles_mongoid/many_roles_spec.rb",
      "spec/roles_mongoid/one_role_spec.rb",
      "spec/roles_mongoid/role_string_spec.rb",
      "spec/roles_mongoid/role_strings_spec.rb",
      "spec/roles_mongoid/roles_mask_spec.rb",
-     "spec/spec_helper.rb"
+     "spec/spec_helper.rb",
+     "tmp/rails/app/models/user.rb",
+     "tmp/rails/config/routes.rb"
   ]
   s.homepage = %q{http://github.com/kristianmandrup/roles_for_mm}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Facilitates adding Roles to your Mongoid user models}
+  s.summary = %q{Implementation of Roles generic API for Mongoid}
   s.test_files = [
-    "spec/roles_mongoid/admin_flag_spec.rb",
+    "spec/generator_spec_helper.rb",
+     "spec/generators/roles_generator_spec.rb",
+     "spec/roles_mongoid/admin_flag_spec.rb",
      "spec/roles_mongoid/many_roles_spec.rb",
      "spec/roles_mongoid/one_role_spec.rb",
      "spec/roles_mongoid/role_string_spec.rb",
@@ -68,21 +74,24 @@ Gem::Specification.new do |s|
     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.19"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.0.0.beta.19"])
       s.add_runtime_dependency(%q<mongoid>, ["~> 2.0.0.beta.17"])
+      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.3"])
       s.add_runtime_dependency(%q<roles_generic>, ["~> 0.2.2"])
     else
-      s.add_dependency(%q<rspec>, [">= 2.0.0.beta.19"])
+      s.add_dependency(%q<rspec>, ["~> 2.0.0.beta.19"])
       s.add_dependency(%q<mongoid>, ["~> 2.0.0.beta.17"])
+      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.3"])
       s.add_dependency(%q<roles_generic>, ["~> 0.2.2"])
     end
   else
-    s.add_dependency(%q<rspec>, [">= 2.0.0.beta.19"])
+    s.add_dependency(%q<rspec>, ["~> 2.0.0.beta.19"])
     s.add_dependency(%q<mongoid>, ["~> 2.0.0.beta.17"])
+    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.3"])
     s.add_dependency(%q<roles_generic>, ["~> 0.2.2"])

data/spec/generator_spec_helper.rb

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

data/spec/generators/roles_generator_spec.rb

@@ -0,0 +1,59 @@
+require 'generator_spec_helper'
+require_generator :mongoid => :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: mongoid' do  
+    use_orm :mongoid
+    
+    before :each do              
+      setup_generator 'mongoid_roles_generator' do
+        tests Mongoid::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
+        root_dir.should have_model :user do |clazz|
+          clazz.should include_module 'Mongoid::Document'
+          clazz.should include_module 'Roles::Mongoid'
+          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
+        root_dir.should have_model :user do |clazz|
+          clazz.should include_module 'Mongoid::Document'
+          clazz.should include_module 'Roles::Mongoid'
+          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
+

data/spec/spec_helper.rb

@@ -17,7 +17,6 @@ Mongoid.database.collections.each do |coll|
   coll.remove
 end
 
-
 RSpec.configure do |config|
   config.mock_with :mocha
   # config.before do

data/tmp/rails/app/models/user.rb

@@ -0,0 +1,8 @@
+class User
+  include Mongoid::Document
+    include Roles::Mongoid 
+  strategy :admin_flag
+
+  valid_roles_are :admin, :guest, :user
+  
+end

data/tmp/rails/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Kristian Mandrup
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-06 00:00:00 +02:00
+date: 2010-09-11 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -23,7 +23,7 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         segments: 
         - 2
@@ -52,9 +52,24 @@ dependencies:
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: require_all
+  name: activesupport
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: require_all
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -65,11 +80,11 @@ dependencies:
         - 0
         version: 1.1.0
   type: :runtime
-  version_requirements: *id003
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: sugar-high
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -80,11 +95,11 @@ dependencies:
         - 3
         version: 0.2.3
   type: :runtime
-  version_requirements: *id004
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: roles_generic
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -95,8 +110,8 @@ dependencies:
         - 2
         version: 0.2.2
   type: :runtime
-  version_requirements: *id005
-description: Facilitates adding Roles to your Mongoid user models
+  version_requirements: *id006
+description: Makes it easy to set a role strategy on your User model in Mongoid
 email: kmandrup@gmail.com
 executables: []
 
@@ -129,6 +144,8 @@ files:
 - sandbox/roles_assign.rb
 - sandbox/single_role.rb
 - sandbox/test.rb
+- spec/generator_spec_helper.rb
+- spec/generators/roles_generator_spec.rb
 - spec/roles_mongoid/admin_flag_spec.rb
 - spec/roles_mongoid/many_roles_spec.rb
 - spec/roles_mongoid/one_role_spec.rb
@@ -136,6 +153,8 @@ files:
 - spec/roles_mongoid/role_strings_spec.rb
 - spec/roles_mongoid/roles_mask_spec.rb
 - spec/spec_helper.rb
+- tmp/rails/app/models/user.rb
+- tmp/rails/config/routes.rb
 has_rdoc: true
 homepage: http://github.com/kristianmandrup/roles_for_mm
 licenses: []
@@ -167,8 +186,10 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Facilitates adding Roles to your Mongoid user models
+summary: Implementation of Roles generic API for Mongoid
 test_files: 
+- spec/generator_spec_helper.rb
+- spec/generators/roles_generator_spec.rb
 - spec/roles_mongoid/admin_flag_spec.rb
 - spec/roles_mongoid/many_roles_spec.rb
 - spec/roles_mongoid/one_role_spec.rb