roles_active_record 0.3.6 → 0.4.0

data/README.textile

@@ -0,0 +1,139 @@
+h1. Roles for Active Record
+
+This is an Active Record implementation of the "Roles generic API":https://github.com/kristianmandrup/roles_generic/wiki
+Please also see the "Roles generic README":https://github.com/kristianmandrup/roles_generic
+
+Roles lets you add a _role strategy_ of choice to your user model. 
+Roles supports strategies with either an inline attribute on user or a separate Role model (see below). 
+
+h2. Install
+
+<code>gem install roles_active_record</code>
+
+h3. Install in Rails app
+
+Insert in Gemfile:
+
+<code>gem 'roles_active_record'</code>
+
+Run <code>$ bundle install</code> from terminal
+
+Alternatively install using "Cream":http://github.com/kristianmandrup/cream
+
+h2. Role strategies
+
+The following Role strategies are available for Active Record:
+
+h3. Inline attribute on User
+
+* admin_flag
+* roles_mask
+* role_string
+
+These strategies all use an inline attribute on the User model. 
+
+h3. Reference to Role
+
+* many_roles
+* one_role
+
+These strategies use a separate Role model (class and table). 
+
+h2. Role strategy configuration
+
+The following demonstrates some examples of role strategy configuration.
+
+h3. Strategy: admin_flag
+
+<pre>class User < ActiveRecord::Base    
+  include Roles::ActiveRecord 
+    
+  strategy :admin_flag, :default
+  valid_roles_are :admin, :guest
+end
+</pre>
+
+h3. Strategy: one_role
+
+For strategies that use a separate Role model you must call the class method #role_class with the name of the role class
+
+<pre>class Bruger < ActiveRecord::Base
+  include Roles::ActiveRecord 
+
+  strategy :one_role, :role_class => :rolle
+  valid_roles_are :admin, :guest
+  ...
+end
+</pre>    
+
+Here the role names have been customized
+
+h3. Default Role classes
+
+The default role classes can currently be included by:
+
+One role:
+
+<code>require 'roles_active_record/one_role'</code>
+
+Many roles:
+
+<code>require 'roles_active_record/many_roles'</code>
+
+Note: These files will automatically be included when needed under normal conditions.
+
+h2. Roles generators
+
+The gem includes these Rails 3 generators: 
+
+* active_record:roles
+* active_record:roles_migration
+
+h3. Roles generator
+
+Let you populate a User model with a given role strategy
+
+Example: Apply Role strategy _admin_flag_ to the User and make the default roles :admin and :guest available
+
+<code>$ rails g active_record:roles User --strategy admin_flag</code>
+
+Example: Apply Role strategy _role_string_ to the User and make the roles :admin, :guest and :author available
+
+<code>$ rails g active_record:roles_migration User --strategy role_string --roles author</code>
+
+Example: Apply Role strategy _one_role_ to the User model with roles :user, :special and :editor
+
+<code>$ rails g active_record:roles_migration User --strategy one_role --roles user special editor --no-default-roles</code>
+
+Example: Apply Role strategy _many_role_ to the User model with default roles and customizing role class names to BrugerRolle and Rolle 
+
+<code>$ rails g active_record:roles_migration User -s one_role -r user editor -rc Rolle -urc BrugerRolle</code>
+
+For the strategies _one_role_ and _many_roles_ the generator also generates the Role and UserRole classes in the app/models dir. If you customize the names of these
+classes (using generator arguments), the customized classes will be generated and "linked up" correctly (with has and belongs_to statements).
+
+h3. Roles migration generator
+
+In case you only want to generate Role migrations.
+
+Example: admin_flag Role strategy
+
+<code>$ rails g active_record:roles_migration User --strategy admin_flag</code>
+
+Create reverse migration
+
+<code>$ rails g active_record:roles_migration User --strategy admin_flag --reverse</code>
+
+h2. 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.
+
+h2. Copyright
+
+Copyright (c) 2010 Kristian Mandrup. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.3.6
+0.4.0

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

@@ -11,9 +11,14 @@ module ActiveRecord
       class_option :strategy, :type => :string, :aliases => "-s", :default => 'role_string', 
                    :desc => "Role strategy to use (admin_flag, role_string, roles_string, role_strings, one_role, many_roles, roles_mask)"
 
-      class_option :roles, :type => :array, :aliases => "-r", :default => [], :desc => "Valid roles"
-      class_option :default_roles, :type => :boolean, :default => true, :desc => "Use default roles :admin and :base"
-      class_option :logfile, :type => :string,   :default => nil,   :desc => "Logfile location"
+      class_option :roles,            :type => :array,  :aliases => "-r", :default => [], :desc => "Valid roles"
+      class_option :role_class,       :type => :string, :aliases => "-rc", :default => 'Role', :desc => "Role class"
+      class_option :user_role_class,  :type => :string, :aliases => "-urc", :default => 'UserRole', :desc => "User Role join class"
+      
+      class_option :default_roles,    :type => :boolean,  :default => true, :desc => "Use default roles :admin and :base"
+      class_option :logfile,          :type => :string,   :default => nil,   :desc => "Logfile location"
+
+      source_root File.dirname(__FILE__) + '/templates'
 
       def apply_role_strategy
         logger.add_logfile :logfile => logfile if logfile
@@ -23,21 +28,57 @@ module ActiveRecord
             insertion_text
           end
         rescue
+          logger.debug "Model #{name} not found"
           say "Model #{name} not found"
         end
       end 
-      
+
+      def copy_role_models
+        logger.debug 'copy_role_models'
+        case strategy.to_sym  
+        when :one_role
+          copy_one_role_model
+        when :many_roles
+          copy_many_roles_models
+        end
+      end
+            
       protected                  
 
       extend Rails3::Assist::UseMacro
       use_orm :active_record
       include Rails3::Assist::BasicLogger
 
+      def copy_one_role_model
+        logger.debug "copy_one_role_model: #{role_class.underscore}"
+
+        template 'one_role/role.rb', "app/models/#{role_class.underscore}.rb"
+      end
+
+      def copy_many_roles_models        
+        logger.debug "copy_many_roles_models: #{role_class.underscore} and #{user_role_class.underscore}"
+
+        template 'many_roles/role.rb', "app/models/#{role_class.underscore}.rb"        
+        template 'many_roles/user_role.rb', "app/models/#{user_role_class.underscore}.rb"
+      end
+
+      def user_class
+        options[:user_class].classify || 'User'
+      end
+
+      def role_class
+        options[:role_class].classify || 'Role'
+      end
+
+      def user_role_class
+        options[:user_role_class].classify || 'UserRole'
+      end
+
       def logfile
         options[:logfile]
       end
 
-      def user_model_name
+      def user_class
         name || 'User'
       end
 
@@ -57,27 +98,30 @@ module ActiveRecord
         roles_to_add.map{|r| ":#{r}" }
       end
 
-      def roles_statement
-        return '' if has_valid_roles_statement?
-        roles ? "valid_roles_are #{roles.join(', ')}" : ''
+      def has_valid_roles_statement? 
+        !(read_model(user_class) =~ /valid_roles_are/).nil?
       end
 
-      def has_valid_roles_statement? 
-        !(read_model(user_model_name) =~ /valid_roles_are/).nil?
+      def valid_roles_statement
+        return '' if has_valid_roles_statement?
+        roles ? "valid_roles_are #{roles.join(', ')}" : ''
       end
   
       def role_strategy_statement 
-        "strategy :#{strategy}, :default\n#{role_class_stmt}"
+        "strategy :#{strategy}, #{strategy_options}"
       end
 
-      def role_class_stmt
-        "  role_class :role" if [:one_role, :many_roles].include?(strategy.to_sym)
+      def strategy_options
+        if role_class != 'Role' || user_role_class != 'UserRole' && role_ref_strategy?
+          return ":role_class => '#{role_class}', :user_role_class => 'user_role_class'"
+        end
+        ":default"
       end
     
       def insertion_text
         %Q{include Roles::#{orm.to_s.camelize}
   #{role_strategy_statement}
-  #{roles_statement}}
+  #{valid_roles_statement}}
       end
   
       def strategy

data/lib/generators/active_record/roles/templates/many_roles/role.rb

@@ -0,0 +1,7 @@
+class <%= role_class %> < ActiveRecord::Base
+  scope :named, lambda{|role_names| where(:name.in => role_names.flatten)}
+  has_many :<%= user_class.pluralize.underscore %>, :through => :<%= user_role_class.pluralize.underscore %>
+  has_many :<%= user_role_class.pluralize.underscore %>
+
+  validates :name, :uniqueness => true
+end

data/lib/generators/active_record/roles/templates/many_roles/user_role.rb

@@ -0,0 +1,4 @@
+class <%= user_role_class %> < ActiveRecord::Base
+  belongs_to :<%= user_class.underscore %>
+  belongs_to :<%= role_class.underscore %>
+end

data/lib/generators/active_record/roles/templates/one_role/role.rb

@@ -0,0 +1,6 @@
+class <%= role_class %> < ActiveRecord::Base
+  scope :named, lambda{|role_names| where(:name.in => role_names.flatten)}
+  has_many :<%= user_class.pluralize.underscore %>
+
+  validates :name, :uniqueness => true  
+end

data/lib/roles_active_record/base.rb

@@ -12,8 +12,59 @@ module Roles::ActiveRecord
   end
 
   module ClassMethods      
-    def strategy name, options=nil
+    MAP = {
+      :admin_flag   => "attr_accessor :admin_flag",
+
+      :many_roles   => "attr_accessor :many_roles",
+      :one_role     => "belongs_to :one_role, :foreign_key => :role_id, :class_name => 'Role'",
+
+      :embed_many_roles   => "attr_accessor :many_roles",
+      :embed_one_role     => "attr_accessor :one_role",
+
+      :roles_mask   => "attr_accessor :roles_mask",
+      :role_string  => "attr_accessor :role_string",
+      :role_strings => "attr_accessor :role_strings",
+      :roles_string => "attr_accessor :roles_string"
+    }    
+    
+    def strategy name, options = {}
+      strategy_name = name.to_sym
+      raise ArgumentError, "Unknown role strategy #{strategy_name}" if !MAP.keys.include? strategy_name
+      use_roles_strategy 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) if strategies_with_role_class.include? strategy_name
+      end
+
+      if (options == :default || options[:config] == :default) && MAP[name]
+        instance_eval statement(MAP[strategy_name])
+      end       
+
       set_role_strategy name, options
     end    
+    
+    private
+
+    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_active_record/#{strategy_name}"
+        return ::Role 
+      end
+      raise Error, "Default Role class not defined"
+    end
+
+    def strategies_with_role_class
+      [:one_role, :embed_one_role, :many_roles,:embed_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_active_record/many_roles.rb

@@ -0,0 +1,11 @@
+class Role < ActiveRecord::Base
+  scope :named, lambda{|role_names| where(:name.in => role_names.flatten)}
+  has_many :users, :through => :user_roles
+  has_many :user_roles
+  validates :name, :uniqueness => true
+end
+
+class UserRole < ActiveRecord::Base
+  belongs_to :user
+  belongs_to :role
+end

data/lib/roles_active_record/one_role.rb

@@ -0,0 +1,5 @@
+class Role < ActiveRecord::Base
+  scope :named, lambda{|role_names| where(:name.in => role_names.flatten)}
+  has_many :users
+  validates :name, :uniqueness => true  
+end

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

@@ -1,17 +1,5 @@
 require 'roles_active_record/strategy/multi'
 
-class Role < ActiveRecord::Base
-  scope :named, lambda{|role_names| where(:name.in => role_names.flatten)}
-  has_many :users, :through => :user_roles
-  has_many :user_roles
-  validates :name, :uniqueness => true
-end
-
-class UserRole < ActiveRecord::Base
-  belongs_to :user
-  belongs_to :role
-end
-
 module RoleStrategy::ActiveRecord
   module ManyRoles
     def self.default_role_attribute

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

@@ -1,11 +1,5 @@
 require 'roles_active_record/strategy/single'
 
-class Role < ActiveRecord::Base
-  scope :named, lambda{|role_names| where(:name.in => role_names.flatten)}
-  has_many :users
-  validates :name, :uniqueness => true  
-end
-
 module RoleStrategy::ActiveRecord
   module OneRole
     def self.default_role_attribute
@@ -15,7 +9,7 @@ module RoleStrategy::ActiveRecord
     def self.included base
       base.extend Roles::Generic::Role::ClassMethods
       base.extend ClassMethods
-      base.belongs_to :one_role, :foreign_key => :role_id, :class_name => 'Role'
+      # base.belongs_to :one_role, :foreign_key => :role_id, :class_name => 'Role'
     end
 
     module ClassMethods

data/roles_active_record.gemspec

@@ -5,28 +5,31 @@
 
 Gem::Specification.new do |s|
   s.name = %q{roles_active_record}
-  s.version = "0.3.6"
+  s.version = "0.4.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-20}
+  s.date = %q{2010-12-25}
   s.description = %q{Makes it easy to set a role strategy on your User model in Active Record}
   s.email = %q{kmandrup@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
-    "README.markdown"
+    "README.textile"
   ]
   s.files = [
     ".document",
     ".rspec",
     "Gemfile",
     "LICENSE",
-    "README.markdown",
+    "README.textile",
     "Rakefile",
     "VERSION",
     "config/database.yml",
     "development.sqlite3",
     "lib/generators/active_record/roles/roles_generator.rb",
+    "lib/generators/active_record/roles/templates/many_roles/role.rb",
+    "lib/generators/active_record/roles/templates/many_roles/user_role.rb",
+    "lib/generators/active_record/roles/templates/one_role/role.rb",
     "lib/generators/active_record/roles_migration/roles_migration_generator.rb",
     "lib/generators/active_record/roles_migration/templates/add_admin_flag_strategy.erb",
     "lib/generators/active_record/roles_migration/templates/add_many_roles_strategy.erb",
@@ -35,7 +38,9 @@ Gem::Specification.new do |s|
     "lib/generators/active_record/roles_migration/templates/add_roles_mask_strategy.erb",
     "lib/roles_active_record.rb",
     "lib/roles_active_record/base.rb",
+    "lib/roles_active_record/many_roles.rb",
     "lib/roles_active_record/namespaces.rb",
+    "lib/roles_active_record/one_role.rb",
     "lib/roles_active_record/role.rb",
     "lib/roles_active_record/strategy.rb",
     "lib/roles_active_record/strategy/multi.rb",
@@ -48,7 +53,6 @@ Gem::Specification.new do |s|
     "lib/roles_active_record/strategy/single/role_string.rb",
     "lib/views/_multi_role_selector.erb.html",
     "lib/views/_single_role_selector.erb.html",
-    "logging.log",
     "roles_active_record.gemspec",
     "sandbox/Rakefile",
     "sandbox/add_role_to_users_migration.erb",
@@ -74,13 +78,15 @@ Gem::Specification.new do |s|
     "spec/migrations/role_string/002_add_role_string_strategy.rb",
     "spec/migrations/roles_mask/002_add_roles_mask_strategy.rb",
     "spec/migrations/users/001_create_users.rb",
-    "spec/roles_active_record/generators/roles_generator_spec.rb",
+    "spec/roles_active_record/generators/admin_flag_gen_spec.rb",
+    "spec/roles_active_record/generators/many_roles_gen_spec.rb",
+    "spec/roles_active_record/generators/migration_generator_spec.rb",
+    "spec/roles_active_record/generators/one_role_gen_spec.rb",
     "spec/roles_active_record/generators/roles_migration/admin_flag_spec.rb",
     "spec/roles_active_record/generators/roles_migration/many_roles_spec.rb",
     "spec/roles_active_record/generators/roles_migration/one_role_spec.rb",
     "spec/roles_active_record/generators/roles_migration/role_string_spec.rb",
     "spec/roles_active_record/generators/roles_migration/roles_mask_spec.rb",
-    "spec/roles_active_record/generators/setup_generator_spec.rb",
     "spec/roles_active_record/strategy/api.rb",
     "spec/roles_active_record/strategy/api_examples.rb",
     "spec/roles_active_record/strategy/multi/many_roles_spec.rb",
@@ -91,15 +97,7 @@ Gem::Specification.new do |s|
     "spec/roles_active_record/strategy/single/one_role_unique_spec.rb",
     "spec/roles_active_record/strategy/single/role_string_spec.rb",
     "spec/roles_active_record/strategy/user_setup.rb",
-    "spec/spec_helper.rb",
-    "tmp/rails/app/models/user.rb",
-    "tmp/rails/config/routes.rb",
-    "tmp/rails/db/migrations/20100912101428_add_admin_flag_strategy.rb",
-    "tmp/rails/db/migrations/20100912101429_remove_admin_flag_strategy.rb",
-    "tmp/rails/db/migrations/20100912105055_add_many_roles_strategy.rb",
-    "tmp/rails/db/migrations/20100912105323_add_one_role_strategy.rb",
-    "tmp/rails/db/migrations/20100912110044_add_role_string_strategy.rb",
-    "tmp/rails/db/migrations/20100912110249_add_roles_mask_strategy.rb"
+    "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/kristianmandrup/roles_active_record}
   s.require_paths = ["lib"]
@@ -118,13 +116,15 @@ Gem::Specification.new do |s|
     "spec/migrations/role_string/002_add_role_string_strategy.rb",
     "spec/migrations/roles_mask/002_add_roles_mask_strategy.rb",
     "spec/migrations/users/001_create_users.rb",
-    "spec/roles_active_record/generators/roles_generator_spec.rb",
+    "spec/roles_active_record/generators/admin_flag_gen_spec.rb",
+    "spec/roles_active_record/generators/many_roles_gen_spec.rb",
+    "spec/roles_active_record/generators/migration_generator_spec.rb",
+    "spec/roles_active_record/generators/one_role_gen_spec.rb",
     "spec/roles_active_record/generators/roles_migration/admin_flag_spec.rb",
     "spec/roles_active_record/generators/roles_migration/many_roles_spec.rb",
     "spec/roles_active_record/generators/roles_migration/one_role_spec.rb",
     "spec/roles_active_record/generators/roles_migration/role_string_spec.rb",
     "spec/roles_active_record/generators/roles_migration/roles_mask_spec.rb",
-    "spec/roles_active_record/generators/setup_generator_spec.rb",
     "spec/roles_active_record/strategy/api.rb",
     "spec/roles_active_record/strategy/api_examples.rb",
     "spec/roles_active_record/strategy/multi/many_roles_spec.rb",

data/spec/fixtures/one_role_setup.rb

@@ -2,7 +2,7 @@ class User < ActiveRecord::Base
   include Roles::ActiveRecord 
   
   strategy :one_role, :default
-  role_class :role
+  # role_class :role
 
   valid_roles_are :admin, :guest, :user
 end

data/spec/generator_spec_helper.rb

@@ -6,7 +6,7 @@ require 'roles_generic'
 
 RSpec::Generator.configure do |config|
   config.debug = false
-  config.remove_temp_dir = false # true
+  config.remove_temp_dir = true
   config.default_rails_root(__FILE__) 
   config.lib = File.dirname(__FILE__) + '/../lib'
   config.logger = :stdout  

data/spec/roles_active_record/generators/{roles_generator_spec.rb → admin_flag_gen_spec.rb}

@@ -1,15 +1,18 @@
 require 'generator_spec_helper'
-require_generator :active_record => :roles
+
+# require_generator :active_record => :roles
+require 'generators/active_record/roles/roles_generator'
 
 # root_dir = Rails3::Assist::Directory.rails_root
-root_dir = File.join(Rails.application.config.root_dir, 'rails')
+# root_dir = File.join(Rails.application.config.root_dir, 'rails')
+root_dir = Rails.root
 
-describe 'role strategy generator: admin_flag' do
+describe 'roles generator' do
   describe 'ORM: active_record' do  
     use_orm :active_record
 
     before do              
-      setup_generator 'datamapper_roles_generator' do
+      setup_generator 'AR_generator' do
         tests ActiveRecord::Generators::RolesGenerator
       end    
     end
@@ -19,10 +22,10 @@ describe 'role strategy generator: admin_flag' do
     end
 
     after :each do
-      # remove_model :user
+      remove_model :user
     end
 
-    it "should configure 'admin_flag' strategy without default roles" do            
+    it "should configure 'admin_flag' strategy without default roles" do
       create_model :user do
         '# content'
       end
@@ -33,12 +36,12 @@ describe 'role strategy generator: admin_flag' do
         root_dir.should have_model :user do |clazz|
           clazz.should include_module 'Roles::ActiveRecord'
           clazz.should have_call :valid_roles_are, :args => ':special'
-          clazz.should have_call :strategy, :args => ":admin_flag"        
+          clazz.should have_call :strategy, :args => ":admin_flag"
         end
       end
     end
         
-    it "should configure 'admin_flag' strategy" do            
+    it "should configure 'admin_flag' strategy" do
       create_model :user do
         '# content'
       end
@@ -52,24 +55,6 @@ describe 'role strategy generator: admin_flag' do
           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 'Roles::ActiveRecord'
-          clazz.should have_call :valid_roles_are, :args => ':admin, :guest, :user'
-          clazz.should have_call :role_class, :args => ":role"        
-          clazz.should have_call :strategy, :args => ":one_role"        
-        end
-      end
     end    
   end
 end
-

data/spec/roles_active_record/generators/many_roles_gen_spec.rb

@@ -0,0 +1,55 @@
+require 'generator_spec_helper'
+
+# require_generator :active_record => :roles
+require 'generators/active_record/roles/roles_generator'
+
+# root_dir = Rails3::Assist::Directory.rails_root
+# root_dir = File.join(Rails.application.config.root_dir, 'rails')
+root_dir = Rails.root
+
+describe 'roles generator' do
+  describe 'ORM: active_record' do  
+    use_orm :active_record
+
+    before do              
+      setup_generator 'AR_generator' do
+        tests ActiveRecord::Generators::RolesGenerator
+      end    
+    end
+    
+    before :each do              
+      remove_model :user    
+    end
+
+    after :each do
+      remove_model :user
+    end
+    
+    it "should configure 'many_roles' strategy" do
+      create_model :user do
+        '# content'
+      end
+      with_generator do |g|   
+        arguments = "User --strategy many_roles --roles admin user"
+        puts "arguments: #{arguments}"
+        g.run_generator arguments.args
+        root_dir.should have_model :user do |clazz|
+          clazz.should include_module 'Roles::ActiveRecord'
+          clazz.should have_call :valid_roles_are, :args => ':admin, :guest, :user'
+          clazz.should have_call :strategy, :args => ":many_roles"
+        end
+        
+        root_dir.should have_model :role do |clazz|                  
+          clazz.should have_call :validates, :args => ':name, :uniqueness => true'
+          clazz.should have_call :has_many, :args => ':users, :through => :user_roles'
+          clazz.should have_call :has_many, :args => ':user_roles'
+        end
+
+        root_dir.should have_model :user_role do |clazz|                  
+          clazz.should have_call :belongs_to, :args => ':user'
+          clazz.should have_call :belongs_to, :args => ':role'
+        end
+      end
+    end    
+  end
+end

data/spec/roles_active_record/generators/one_role_gen_spec.rb

@@ -0,0 +1,49 @@
+require 'generator_spec_helper'
+
+# require_generator :active_record => :roles
+require 'generators/active_record/roles/roles_generator'
+
+# root_dir = Rails3::Assist::Directory.rails_root
+# root_dir = File.join(Rails.application.config.root_dir, 'rails')
+root_dir = Rails.root
+
+describe 'roles generator' do
+  describe 'ORM: active_record' do  
+    use_orm :active_record
+
+    before do              
+      setup_generator 'AR_generator' do
+        tests ActiveRecord::Generators::RolesGenerator
+      end    
+    end
+    
+    before :each do              
+      remove_model :user    
+    end
+
+    after :each do
+      remove_model :user
+    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 'Roles::ActiveRecord'
+          clazz.should have_call :valid_roles_are, :args => ':admin, :guest, :user'
+          clazz.should have_call :strategy, :args => ":one_role"
+        end
+        
+        root_dir.should have_model :role do |clazz|                  
+          clazz.should have_call :validates, :args => ':name, :uniqueness => true'
+          clazz.should have_call :has_many, :args => ':users'
+        end
+      end
+    end        
+  end
+end

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

@@ -1,5 +1,6 @@
 require 'spec_helper' 
-use_roles_strategy :one_role
+
+#use_roles_strategy :one_role
 
 def api_fixture
   load 'fixtures/one_role_setup.rb'

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 3
-  - 6
-  version: 0.3.6
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Kristian Mandrup
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-20 00:00:00 +01:00
+date: 2010-12-25 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -337,18 +337,21 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.markdown
+- README.textile
 files: 
 - .document
 - .rspec
 - Gemfile
 - LICENSE
-- README.markdown
+- README.textile
 - Rakefile
 - VERSION
 - config/database.yml
 - development.sqlite3
 - lib/generators/active_record/roles/roles_generator.rb
+- lib/generators/active_record/roles/templates/many_roles/role.rb
+- lib/generators/active_record/roles/templates/many_roles/user_role.rb
+- lib/generators/active_record/roles/templates/one_role/role.rb
 - lib/generators/active_record/roles_migration/roles_migration_generator.rb
 - lib/generators/active_record/roles_migration/templates/add_admin_flag_strategy.erb
 - lib/generators/active_record/roles_migration/templates/add_many_roles_strategy.erb
@@ -357,7 +360,9 @@ files:
 - lib/generators/active_record/roles_migration/templates/add_roles_mask_strategy.erb
 - lib/roles_active_record.rb
 - lib/roles_active_record/base.rb
+- lib/roles_active_record/many_roles.rb
 - lib/roles_active_record/namespaces.rb
+- lib/roles_active_record/one_role.rb
 - lib/roles_active_record/role.rb
 - lib/roles_active_record/strategy.rb
 - lib/roles_active_record/strategy/multi.rb
@@ -370,7 +375,6 @@ files:
 - lib/roles_active_record/strategy/single/role_string.rb
 - lib/views/_multi_role_selector.erb.html
 - lib/views/_single_role_selector.erb.html
-- logging.log
 - roles_active_record.gemspec
 - sandbox/Rakefile
 - sandbox/add_role_to_users_migration.erb
@@ -396,13 +400,15 @@ files:
 - spec/migrations/role_string/002_add_role_string_strategy.rb
 - spec/migrations/roles_mask/002_add_roles_mask_strategy.rb
 - spec/migrations/users/001_create_users.rb
-- spec/roles_active_record/generators/roles_generator_spec.rb
+- spec/roles_active_record/generators/admin_flag_gen_spec.rb
+- spec/roles_active_record/generators/many_roles_gen_spec.rb
+- spec/roles_active_record/generators/migration_generator_spec.rb
+- spec/roles_active_record/generators/one_role_gen_spec.rb
 - spec/roles_active_record/generators/roles_migration/admin_flag_spec.rb
 - spec/roles_active_record/generators/roles_migration/many_roles_spec.rb
 - spec/roles_active_record/generators/roles_migration/one_role_spec.rb
 - spec/roles_active_record/generators/roles_migration/role_string_spec.rb
 - spec/roles_active_record/generators/roles_migration/roles_mask_spec.rb
-- spec/roles_active_record/generators/setup_generator_spec.rb
 - spec/roles_active_record/strategy/api.rb
 - spec/roles_active_record/strategy/api_examples.rb
 - spec/roles_active_record/strategy/multi/many_roles_spec.rb
@@ -414,14 +420,6 @@ files:
 - spec/roles_active_record/strategy/single/role_string_spec.rb
 - spec/roles_active_record/strategy/user_setup.rb
 - spec/spec_helper.rb
-- tmp/rails/app/models/user.rb
-- tmp/rails/config/routes.rb
-- tmp/rails/db/migrations/20100912101428_add_admin_flag_strategy.rb
-- tmp/rails/db/migrations/20100912101429_remove_admin_flag_strategy.rb
-- tmp/rails/db/migrations/20100912105055_add_many_roles_strategy.rb
-- tmp/rails/db/migrations/20100912105323_add_one_role_strategy.rb
-- tmp/rails/db/migrations/20100912110044_add_role_string_strategy.rb
-- tmp/rails/db/migrations/20100912110249_add_roles_mask_strategy.rb
 has_rdoc: true
 homepage: http://github.com/kristianmandrup/roles_active_record
 licenses: []
@@ -467,13 +465,15 @@ test_files:
 - spec/migrations/role_string/002_add_role_string_strategy.rb
 - spec/migrations/roles_mask/002_add_roles_mask_strategy.rb
 - spec/migrations/users/001_create_users.rb
-- spec/roles_active_record/generators/roles_generator_spec.rb
+- spec/roles_active_record/generators/admin_flag_gen_spec.rb
+- spec/roles_active_record/generators/many_roles_gen_spec.rb
+- spec/roles_active_record/generators/migration_generator_spec.rb
+- spec/roles_active_record/generators/one_role_gen_spec.rb
 - spec/roles_active_record/generators/roles_migration/admin_flag_spec.rb
 - spec/roles_active_record/generators/roles_migration/many_roles_spec.rb
 - spec/roles_active_record/generators/roles_migration/one_role_spec.rb
 - spec/roles_active_record/generators/roles_migration/role_string_spec.rb
 - spec/roles_active_record/generators/roles_migration/roles_mask_spec.rb
-- spec/roles_active_record/generators/setup_generator_spec.rb
 - spec/roles_active_record/strategy/api.rb
 - spec/roles_active_record/strategy/api_examples.rb
 - spec/roles_active_record/strategy/multi/many_roles_spec.rb

data/README.markdown

@@ -1,191 +0,0 @@
-# Roles for Active Record
-
-An Active Record implementation of [roles generic](http://github.com/kristianmandrup/roles_generic)
-
-## Install
-
-<code>gem install roles_active_record</code>
-
-## Update!
-
-Now implements the [roles generic](http://github.com/kristianmandrup/roles_generic) Roles API
-It also implements the following Role strategies:
-
-* admin_flag
-* many_roles
-* one_role
-* roles_mask
-* role_string
-
-## Rails generator
-
-Will create admin and guest roles by default
-
-<code>$ rails g active_record:roles User --strategy admin_flag --roles admin guest</code>
-
-## Usage
-
-Example: admin_flag Role strategy - generate migrations and model files
-
-<code>$ rails g active_record:roles User admin_flag</code>
-
-Example: admin_flag Role strategy - generate migrations only
-
-<code>$ rails g active_record:roles_migration User admin_flag</code>
-
-## Role strategies
-
-The library comes with the following role strategies built-in:
-
-Single role:
-
-* admin_flag
-* role_string
-* one_role  
-
-Multi role:
-
-* many_roles
-* roles_mask
-
-_Note_ The strategies *one_role* and *many_roles* both use a separate Role model (roles table). The others use an inline strategy with an attribute in the User model.
-
-### Admin flag
-
-Boolean *admin_flag* on User to indicate if user role is admin or normal user 
-
-### Role string
-
-String *role_string* on User that names the role
-
-### One role
-
-*role_id* relation to *id* of *Roles* table that contain all valid roles  
-
-### Many roles
-
-*role_id* relation to *UserRoles* table that is the join table that joins a user to multiple roles in the *Roles* tables.
-
-### Roles mask
-
-*roles_mask* integer that as a bitmask indicating which roles out of a set of valid roles that the user has.
-
-Note: The following examples use RSpec to demonstrate usage scenarios.
-
-## Example : admin_flag
-
-<pre>use_roles_strategy :admin_flag
-
-class User < ActiveRecord::Base    
-  include Roles::ActiveRecord 
-    
-  strategy :admin_flag, :default
-  valid_roles_are :admin, :guest
-end
-</pre>
-
-## Example : role_string
-
-<pre>use_roles_strategy :role_string
-
-class User < ActiveRecord::Base
-  include Roles::ActiveRecord 
-  
-  strategy :role_string, :default
-  valid_roles_are :admin, :guest   
-end
-</pre>
-
-## Example : one_role
-
-<pre>use_roles_strategy :one_role
-class User < ActiveRecord::Base
-  include Roles::ActiveRecord 
-
-  strategy :one_role, :default
-  role_class :role
-
-  valid_roles_are :admin, :guest
-end
-</pre>
-    
-## Example : many_roles
-
-<pre>use_roles_strategy :many_roles
-class User < ActiveRecord::Base    
-  include Roles::ActiveRecord
-
-  strategy :many_roles, :default
-  role_class :role
-
-  valid_roles_are :admin, :guest
-end
-</pre>
-
-## Example : roles_mask
-
-<pre>use_roles_strategy :roles_mask
-
-class User < ActiveRecord::Base    
-  include Roles::ActiveRecord
-  
-  strategy :roles_mask, :default
-  valid_roles_are :admin, :guest   
-end
-
-</pre>
-
-## Rails generators
-
-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
-* role_string
-* roles_mask
-* one_role
-* many_roles
-          
-
-### Generators
-
-* active_record:roles
-* active_record:roles_migration
-
-*Roles*
-
-Apply :admin_flag Role strategy to User model using default roles :admin and :guest (default)
-
-<code>$ rails g active_record:roles User --strategy admin_flag</code>
-
-Apply :admin_flag Role strategy to User model using default roles and extra role :author
-
-<code>$ rails g active_record:roles_migration User --strategy admin_flag --roles author</code>
-
-Apply :one_role Role strategy to User model without default roles, only with roles :user, :special and :editor
-
-<code>$ rails g active_record:roles_migration User --strategy one_role --roles user special editor --no-default-roles</code>
-
-*Roles Migration*
-
-Example: admin_flag Role strategy - generate migrations and model files
-
-<code>$ rails g active_record:roles_migration User --strategy admin_flag</code>
-
-Create reverse migration
-
-<code>$ rails g active_record:roles_migration User --strategy admin_flag --reverse</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/logging.log

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

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

@@ -1,7 +0,0 @@
-class User < ActiveRecord::Base
-  include Roles::ActiveRecord 
-  strategy :one_role, :default
-  role_class :role
-  valid_roles_are :admin, :guest, :user
-  
-end

data/tmp/rails/config/routes.rb

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

data/tmp/rails/db/migrations/20100912101428_add_admin_flag_strategy.rb

@@ -1,14 +0,0 @@
-class AddAdminFlagStrategy < ActiveRecord::Migration
-
-  def self.up           
-    change_table :users do |t|
-      t.boolean :admin_flag, :default => false
-    end
-  end
-
-  def self.down
-    change_table :users do |t|
-      t.remove :admin_flag
-    end
-  end
-end

data/tmp/rails/db/migrations/20100912101429_remove_admin_flag_strategy.rb

@@ -1,14 +0,0 @@
-class RemoveAdminFlagStrategy < ActiveRecord::Migration
-
-  def self.down           
-    change_table :users do |t|
-      t.boolean :admin_flag, :default => false
-    end
-  end
-
-  def self.up
-    change_table :users do |t|
-      t.remove :admin_flag
-    end
-  end
-end

data/tmp/rails/db/migrations/20100912105055_add_many_roles_strategy.rb

@@ -1,40 +0,0 @@
-class AddManyRolesStrategy < ActiveRecord::Migration
-  class << self
-
-    def up          
-      create_roles
-      create_user_roles
-    end
-
-    def down      
-      drop_roles
-      drop_user_roles
-    end
-
-    protected
-
-    def create_user_roles
-      create_table :user_roles do |t|
-        t.integer :user_id
-        t.integer :role_id
-        t.timestamps
-      end
-    end
-
-    def drop_user_roles
-      drop_table :user_roles
-    end
-
-
-    def create_roles
-      create_table :roles do |t|
-        t.string  :name
-        t.timestamps
-      end
-    end
-
-    def drop_roles
-      drop_table :roles
-    end
-  end
-end

data/tmp/rails/db/migrations/20100912105323_add_one_role_strategy.rb

@@ -1,40 +0,0 @@
-class AddOneRoleStrategy < ActiveRecord::Migration
-  class << self
-
-    def up          
-      create_roles
-      add_user_role
-    end
-
-    def down      
-      drop_roles
-      remove_user_role
-    end
-
-    protected
-
-    def add_user_role
-      change_table :users do |t|
-        t.integer :role_id
-      end
-    end
-
-    def remove_user_role
-      change_table :users do |t|
-        t.remove :role_id
-      end
-    end
-
-
-    def create_roles
-      create_table :roles do |t|
-        t.string  :name
-        t.timestamps
-      end
-    end
-
-    def drop_roles
-      drop_table :roles
-    end
-  end
-end

data/tmp/rails/db/migrations/20100912110044_add_role_string_strategy.rb

@@ -1,13 +0,0 @@
-class AddRoleStringStrategy < ActiveRecord::Migration
-  def self.up           
-    change_table :users do |t|
-      t.string :role, :default => 'guest'
-    end
-  end
-
-  def self.down
-    change_table :users do |t|
-      t.remove :role
-    end
-  end
-end

data/tmp/rails/db/migrations/20100912110249_add_roles_mask_strategy.rb

@@ -1,13 +0,0 @@
-class AddRolesMaskStrategy < ActiveRecord::Migration
-  def self.up           
-    change_table :users do |t|
-      t.integer :roles_mask, :default => 1
-    end
-  end
-
-  def self.down
-    change_table :users do |t|
-      t.remove :roles_mask
-    end
-  end
-end