roles_active_record 0.1.0

data/sandbox/database.log

@@ -0,0 +1,47 @@
+D, [2010-08-03T11:17:25.097372 #5468] DEBUG -- :   SQL (0.3ms)   SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+D, [2010-08-03T11:17:25.097614 #5468] DEBUG -- :   SQL (0.1ms)  select sqlite_version(*)
+D, [2010-08-03T11:17:25.099557 #5468] DEBUG -- :   SQL (1.7ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+D, [2010-08-03T11:17:25.099704 #5468] DEBUG -- :   SQL (0.0ms)  PRAGMA index_list("schema_migrations")
+D, [2010-08-03T11:17:25.101503 #5468] DEBUG -- :   SQL (1.7ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+D, [2010-08-03T11:17:25.101691 #5468] DEBUG -- :   SQL (0.1ms)   SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+D, [2010-08-03T11:18:24.658917 #5733] DEBUG -- :   SQL (0.8ms)   SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+D, [2010-08-03T11:19:32.203267 #5997] DEBUG -- :   SQL (0.4ms)   SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+D, [2010-08-03T11:21:50.864071 #6613] DEBUG -- :   SQL (0.4ms)   SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+D, [2010-08-03T11:21:50.866101 #6613] DEBUG -- :   SQL (0.1ms)   SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+D, [2010-08-03T11:21:50.867280 #6613] DEBUG -- :   SQL (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations"
+I, [2010-08-03T11:21:50.867334 #6613]  INFO -- : Migrating to CreateUsers (20102507)
+D, [2010-08-03T11:21:50.867474 #6613] DEBUG -- :   SQL (0.0ms)  select sqlite_version(*)
+D, [2010-08-03T11:21:50.870727 #6613] DEBUG -- :   SQL (0.5ms)  CREATE TABLE "users" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "name" varchar(255) NOT NULL) 
+D, [2010-08-03T11:21:50.900844 #6613] DEBUG -- :   SQL (0.2ms)  INSERT INTO "schema_migrations" ("version") VALUES ('20102507')
+D, [2010-08-03T14:16:49.368569 #54191] DEBUG -- :   SQL (0.4ms)   SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+D, [2010-08-03T14:16:49.387225 #54191] DEBUG -- :   SQL (0.2ms)   SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+D, [2010-08-03T14:16:49.388472 #54191] DEBUG -- :   SQL (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations"
+I, [2010-08-03T14:16:49.388536 #54191]  INFO -- : Migrating to CreateUsers (20102507)
+I, [2010-08-03T14:16:49.388570 #54191]  INFO -- : Migrating to CreateRoles (201002508)
+D, [2010-08-03T14:16:49.388708 #54191] DEBUG -- :   SQL (0.1ms)  select sqlite_version(*)
+D, [2010-08-03T14:16:49.406721 #54191] DEBUG -- :   SQL (0.4ms)  CREATE TABLE "roles" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "name" varchar(255) NOT NULL) 
+D, [2010-08-03T14:16:49.427264 #54191] DEBUG -- :   SQL (13.7ms)  INSERT INTO "schema_migrations" ("version") VALUES ('201002508')

data/sandbox/database.yml

@@ -0,0 +1,4 @@
+adapter: sqlite3
+database: development.sqlite3
+pool: 5
+timeout: 5000

data/sandbox/migrate/201002508_create_roles.rb

@@ -0,0 +1,11 @@
+class CreateRoles < ActiveRecord::Migration
+  def self.up
+    create_table :roles do |t|
+      t.column :name, :string, :null => false
+    end
+  end
+
+  def self.down
+    drop_table :roles
+  end
+end

data/sandbox/migrate/20102507_create_users.rb

@@ -0,0 +1,11 @@
+class CreateUsers < ActiveRecord::Migration
+  def self.up
+    create_table :users do |t|
+      t.column :name, :string, :null => false
+    end
+  end
+
+  def self.down
+    drop_table :users
+  end
+end

data/sandbox/model_base.rb

@@ -0,0 +1,46 @@
+require 'require_all'
+require 'active_support/inflector'
+require_all File.dirname(__FILE__) + '/strategies'
+
+ 
+
+module RoleModels::ActiveRecord
+  include RoleModels::Base
+  orm_name :active_record
+end
+
+ 
+module ActiveRecord
+  class Base
+    include RoleModels::ActiveRecord
+  end
+end
+
+
+class User
+  include RoleModels::Generic
+  
+  attr_accessor :roles_mask
+  role_strategy :roles_mask
+end
+
+class User
+  include RoleModels::Generic::RolesMask
+  attr_accessor :roles_mask
+end
+
+class User < ActiveRecord::Base
+  role_strategy :roles_mask
+end
+
+class User
+  include MongoMapper::Document
+  
+  role_strategy :roles_mask
+end
+
+class User
+  include Mongoid::Document
+  
+  role_strategy :roles_mask
+end

data/sandbox/test.rb

@@ -0,0 +1,13 @@
+require 'active_record'
+require 'yaml'
+require 'logger'
+path = File.dirname(__FILE__) + '/database.yml'
+dbfile = File.open(path)
+dbconfig = YAML::load(dbfile)
+ActiveRecord::Base.establish_connection(dbconfig)
+ActiveRecord::Base.logger = Logger.new(STDERR)
+
+class User < ActiveRecord::Base
+end
+
+puts User.count

data/spec/db/database.yml

@@ -0,0 +1,4 @@
+adapter: sqlite3
+database: development.sqlite3
+pool: 5
+timeout: 5000

data/spec/fixtures/many_roles_setup.rb

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

data/spec/fixtures/one_role_setup.rb

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

data/spec/migrations/admin_flag/004_add_admin_flag_to_users.rb

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

data/spec/migrations/many_roles/002_create_roles.rb

@@ -0,0 +1,13 @@
+class CreateRoles < ActiveRecord::Migration
+  def self.up
+    create_table :roles do |t|
+      t.integer :role_id
+      t.string  :name
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :roles
+  end
+end

data/spec/migrations/many_roles/003_create_user_roles.rb

@@ -0,0 +1,13 @@
+class CreateUserRoles < ActiveRecord::Migration
+  def self.up
+    create_table :user_roles do |t|
+      t.integer :user_id
+      t.integer :role_id
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :user_roles
+  end
+end

data/spec/migrations/one_role/002_create_roles.rb

@@ -0,0 +1,12 @@
+class CreateRoles < ActiveRecord::Migration
+  def self.up
+    create_table :roles do |t|
+      t.string  :name
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :roles
+  end
+end

data/spec/migrations/one_role/003_add_role_to_users.rb

@@ -0,0 +1,13 @@
+class AddRoleToUsers < ActiveRecord::Migration
+  def self.up           
+    change_table :users do |t|
+      t.integer :role_id
+    end
+  end
+
+  def self.down
+    change_table :users do |t|
+      t.remove :role_id
+    end
+  end
+end

data/spec/migrations/role_string/002_add_role_string_to_users.rb

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

data/spec/migrations/roles_mask/005_add_roles_mask_to_users.rb

@@ -0,0 +1,13 @@
+class AddRolesMaskToUsers < 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

data/spec/migrations/users/001_create_users.rb

@@ -0,0 +1,11 @@
+class CreateUsers < ActiveRecord::Migration
+  def self.up
+    create_table :users do |t|
+      t.column :name, :string, :null => false
+    end
+  end
+
+  def self.down
+    drop_table :users
+  end
+end

data/spec/roles_active_record/admin_flag_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+use_roles_strategy :admin_flag
+
+class User < ActiveRecord::Base    
+  include Roles::ActiveRecord 
+    
+  strategy :admin_flag, :default
+  valid_roles_are :admin, :guest
+end
+
+describe "Roles for Active Record" do
+  before do
+    migrate('admin_flag')
+  end
+
+  before :each do
+    @user = User.create(:name => 'Kristian')
+    @user.roles = :guest
+    @user.save
+
+    @admin_user = User.create(:name => 'Admin user')
+    @admin_user.roles = :admin    
+    @admin_user.save
+  end
+
+  describe "Admin flag strategy " do
+
+    describe '#in_role' 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
+
+    describe 'roles API' do
+      it "should have admin user role to :admin" do
+        @admin_user.role.should == :admin
+        @admin_user.roles.should == [:admin]      
+        @admin_user.admin?.should be_true
+         
+        @admin_user.class.valid_roles.should == [:admin, :guest]
+        
+        @admin_user.has_role?(:guest).should be_false
+        
+        @admin_user.has_role?(:admin).should be_true
+        @admin_user.is?(:admin).should be_true
+        @admin_user.has_roles?(:admin).should be_true
+        @admin_user.has?(:admin).should be_true      
+      end  
+    
+      it "should have user role to :guest" do
+        @user.roles.should == [:guest]
+        @user.admin?.should be_false
+      
+        @user.has_role?(:guest).should be_true    
+        @user.has_role?(:admin).should be_false
+        @user.is?(:admin).should be_false
+        
+        @user.has_roles?(:guest).should be_true
+        @user.has?(:admin).should be_false
+      end
+      
+      it "should set user role to :admin using =" do
+        @user.roles = :admin      
+        @user.role.should == :admin           
+        @user.has_role?(:admin).should be_true      
+      end    
+    end   
+  end
+end
+

data/spec/roles_active_record/generators/migration_spec_helper.rb

@@ -0,0 +1,17 @@
+require 'rspec'
+require 'rspec/autorun'
+require 'active_record'
+require 'yaml'
+require 'logger'
+require 'database_cleaner'
+require 'roles_for_ar'
+require 'generator_spec'
+
+RSpec::Generator.configure do |config|
+  config.debug = true
+  config.remove_temp_dir = true
+  config.default_rails_root(__FILE__) 
+  config.lib = File.dirname(__FILE__) + '/../../../lib'
+  config.logger = :stdout
+end
+  

data/spec/roles_active_record/generators/roles_migration/admin_flag_spec.rb

@@ -0,0 +1,67 @@
+require File.expand_path(File.dirname(__FILE__) + '/../migration_spec_helper')
+
+require_generator :active_record => :roles_migration
+
+describe 'roles_migration_generator' do
+  use_orm :active_record  
+  helpers :migration
+  
+  before :each do              
+    setup_generator 'roles_migration_generator' do
+      tests ActiveRecord::Generators::RolesMigrationGenerator      
+    end    
+  end
+
+  after :each do
+  end
+    
+  # it "should generate migration 'add_admin_flag_strategy' for role strategy 'admin_flag'" do    
+  #   with_generator do |g|
+  #     remove_migration :add_admin_flag_strategy
+  #     g.run_generator "User --strategy admin_flag".args
+  # 
+  #     g.should generate_migration :add_admin_flag_strategy do |content|
+  #       content.should have_migration :add_admin_flag_strategy do |klass|
+  #         klass.should have_up do |up|
+  #           up.should have_change_table :users do |tbl_content|
+  #             tbl_content.should have_add_column :admin_flag, :boolean
+  #           end
+  #         end
+  # 
+  #         klass.should have_down do |down|
+  #           down.should have_change_table :users do |tbl_content|
+  #             tbl_content.should have_remove_column :admin_flag
+  #           end
+  #         end
+  #       end
+  #     end      
+  #   end # with
+  # end
+  
+  it "should generate reverse migration 'remove_admin_flag_strategy' for role strategy 'admin_flag'" do    
+    with_generator do |g|
+      remove_migration :remove_admin_flag_strategy
+      g.run_generator "User --strategy admin_flag --reverse".args
+  
+      g.should generate_migration :remove_admin_flag_strategy do |content|
+        content.should have_migration :remove_admin_flag_strategy do |klass|
+          klass.should have_down do |down|
+            down.should have_change_table :users do |tbl_content|
+              tbl_content.should have_add_column :admin_flag, :boolean
+            end
+          end
+  
+          klass.should have_up do |up|
+            up.should have_change_table :users do |tbl_content|
+              tbl_content.should have_remove_column :admin_flag
+            end
+          end
+        end
+      end      
+    end # with
+  end
+  
+end
+
+
+

data/spec/roles_active_record/generators/roles_migration/many_roles_spec.rb

@@ -0,0 +1,57 @@
+require File.expand_path(File.dirname(__FILE__) + '/../migration_spec_helper')
+require_generator :active_record => :roles_migration
+
+describe 'roles_migration_generator' do
+  use_orm :active_record  
+  helpers :migration
+  
+  before :each do              
+    setup_generator 'roles_migration_generator' do
+      tests ActiveRecord::Generators::RolesMigrationGenerator
+    end    
+  end
+
+  after :each do
+  end
+
+  it "should generate migrations 'create_roles' and 'create_user_roles' for role strategy 'many_roles'" do    
+    with_generator do |g|
+      remove_migration :add_many_roles_strategy
+      g.run_generator "User --strategy many_roles".args
+  
+      g.should generate_migration :add_many_roles_strategy do |content|
+        content.should have_migration :add_many_roles_strategy do |klass|
+          klass.should have_class_self do |class_self|
+            class_self.should have_method :up do |up|
+              up.should have_call :create_user_roles
+              up.should have_call :create_roles
+            end
+            
+            class_self.should have_method :create_user_roles do |method|
+              method.should have_create_table :user_roles do |tbl_content|
+                tbl_content.should have_add_column :role_id, :integer
+                tbl_content.should have_add_column :user_id, :integer
+                tbl_content.should have_timestamps
+              end
+            end
+
+            class_self.should have_method :create_roles do |method|        
+              method.should have_create_table :roles do |tbl_content|
+                tbl_content.should have_add_column :name, :string
+                tbl_content.should have_timestamps
+              end
+            end
+            
+            class_self.should have_method :down do |down|
+              down.should have_call :drop_user_roles
+              down.should have_call :drop_roles 
+            end
+            
+            class_self.should have_method :drop_user_roles
+            class_self.should have_method :drop_roles
+          end
+        end
+      end
+    end # with
+  end
+end

data/spec/roles_active_record/generators/roles_migration/one_role_spec.rb

@@ -0,0 +1,56 @@
+require File.expand_path(File.dirname(__FILE__) + '/../migration_spec_helper')
+require_generator :active_record => :roles_migration
+
+describe 'roles_migration_generator' do
+  use_orm :active_record  
+  helpers :migration
+  
+  before :each do              
+    setup_generator 'roles_migration_generator' do
+      tests ActiveRecord::Generators::RolesMigrationGenerator
+    end    
+  end
+
+  after :each do
+  end
+
+
+  it "should generate migration 'add_role_to_user' and 'create_roles' for role strategy 'one_role'" do    
+    with_generator do |g|
+      remove_migrations :add_role_to_users, :create_roles
+            
+      g.run_generator [:user, %w{--strategy one_role}].args
+
+      g.should generate_migration :add_role_to_users do |content|
+        content.should have_migration :add_role_to_users do |klass|
+          klass.should have_up do |up|
+            up.should have_change_table :users do |tbl_content|
+              tbl_content.should have_add_column :role_id, :integer
+            end
+          end
+
+          klass.should have_down do |down|
+            down.should have_change_table :users do |tbl_content|
+              tbl_content.should have_remove_column :role_id
+            end
+          end
+        end
+      end      
+
+      g.should generate_migration :create_roles do |content|
+        content.should have_migration :create_roles do |klass|
+          klass.should have_up do |up|
+            up.should have_create_table :roles do |tbl_content|
+              tbl_content.should have_add_column :name, :string
+              tbl_content.should have_timestamps             
+            end
+          end
+
+          klass.should have_down do |down|
+            down.should have_drop_table :roles
+          end
+        end
+      end      
+    end # with
+  end
+end

data/spec/roles_active_record/generators/roles_migration/role_string_spec.rb

@@ -0,0 +1,40 @@
+require File.expand_path(File.dirname(__FILE__) + '/../migration_spec_helper')
+require_generator :active_record => :roles_migration
+
+describe 'roles_migration_generator' do
+  use_orm :active_record  
+  helpers :migration
+  
+  before :each do              
+    setup_generator 'roles_migration_generator' do
+      tests ActiveRecord::Generators::RolesMigrationGenerator
+    end    
+  end
+
+  after :each do
+  end
+
+
+  it "should generate migration 'add_inline_role_to_user' for role strategy 'role_string'" do    
+    with_generator do |g|
+      remove_migration :add_inline_role_to_users
+      g.run_generator [:user, %w{--strategy role_string}].args
+
+      g.should generate_migration :add_inline_role_to_users do |content|
+        content.should have_migration :add_inline_role_to_users do |klass|
+          klass.should have_up do |up|
+            up.should have_change_table :users do |tbl_content|
+              tbl_content.should have_add_column :role, :string
+            end
+          end
+
+          klass.should have_down do |down|
+            down.should have_change_table :users do |tbl_content|
+              tbl_content.should have_remove_column :role
+            end
+          end
+        end
+      end      
+    end # with
+  end
+end 

data/spec/roles_active_record/generators/roles_migration/roles_mask_spec.rb

@@ -0,0 +1,36 @@
+require File.expand_path(File.dirname(__FILE__) + '/../migration_spec_helper')
+require_generator :active_record => :roles_migration
+
+describe 'roles_migration_generator' do
+  use_orm :active_record  
+  helpers :migration
+  
+  before :each do              
+    setup_generator 'roles_migration_generator' do
+      tests ActiveRecord::Generators::RolesMigrationGenerator
+    end    
+  end
+
+  it "should generate migration 'add_roles_mask_to_users' for role strategy 'roles_mask'" do    
+    with_generator do |g|
+      remove_migration :add_roles_mask_to_users
+      g.run_generator [:user, %w{--strategy roles_mask}].args
+
+      g.should generate_migration :add_roles_mask_to_users do |content|
+        content.should have_migration :add_roles_mask_to_users do |klass|
+          klass.should have_up_method do |up|
+            up.should have_change_table :users do |tbl_content|
+              tbl_content.should have_add_column :roles_mask, :integer
+            end
+          end
+
+          klass.should have_down_method do |down|
+            down.should have_change_table :users do |tbl_content|
+              tbl_content.should have_remove_column :roles_mask
+            end
+          end
+        end
+      end      
+    end # with
+  end
+end

data/spec/roles_active_record/generators/setup_generator_spec.rb

@@ -0,0 +1,40 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require_generator :setup
+
+describe 'setup_generator' do
+  include RSpec::Rails::Orm::ActiveRecord
+  include RSpec::Rails::Migration
+  
+  before :each do              
+    setup_generator 'setup_generator' do
+      tests MigrationGenerator
+    end    
+  end
+
+  after :each do
+  end
+    
+  it "should generate role migrations" do    
+    with_generator do |g|
+      name = 'auth_assistant::setup'
+      remove_migration 'create_users'
+      g.run_generator [name]
+      g.should generate_migration name do |content|
+        content.should have_migration name do |klass|
+          klass.should have_up do |up|
+            up.should have_create_table :users do |user_tbl|
+              user_tbl.should have_columns :name => :string, :age => :string
+            end
+          end
+
+          klass.should have_down do |up|
+            up.should have_drop_table :users
+          end
+        end
+      end
+    end
+  end
+end
+
+
+