roles 0.1.0 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4136c2d08ee83ba38a925530bb53e1293c62286a
+  data.tar.gz: 21b7840b3397699f47f3d2d1a636cb80d90c9454
+SHA512:
+  metadata.gz: 9be9cc510a899bdd4778502549fd6b8373421db651cb3a0315e42e4d10d3634ee61d3c3980b24482ebf62523ed9a24bda72e58cce526f2a975ae9e97340a688b
+  data.tar.gz: 313b31799ac5691912c62c22966393866705c632c75c10518c75f696f5fdb63b8008542cc5aa77d7ed0fe240df07a2fb15e5ac6d65e4951e8a7445a77af950ba

data/.travis.yml

@@ -1,12 +1,11 @@
 rvm:
     - 1.9.3
-    - ruby-head
     - rbx-19mode
     - jruby-19mode
+    - 2.0.0
 
 env:
     - ADAPTER=active_record
-    - ADAPTER=mongoid
 
 before_install:
   - gem update --system

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## v0.2.0 (Aug 13, 2013)
+- support custom role and user class name
+
 ## v0.1.0 (Sep 2, 2012)
 - add spec test set
 - fix duplicate records in `resources#users_with_role`, `users#resources_with_role` and `users#with_role`

data/README.md

@@ -1,4 +1,4 @@
-# Roles
+# Roles [![Build Status](https://travis-ci.org/liufengyun/roles.png?branch=master)](https://travis-ci.org/liufengyun/roles)
 
 Roles is an extremely simple roles gem inspired by [rolify](https://github.com/EppO/rolify).
 
@@ -48,18 +48,17 @@ user.resources_with_role(Project, role_name = nil)
 # => returns all projects for a given user, optionally filtered by role_name.
 ```
 
-## Requirements
+## Compatibility
 
-* Rails >= 3.1
-* ActiveRecord >= 3.1
-* supports ruby 1.9
+* Rails >= 3.1 and < 4.0 (plan to support 4.0 later)
+* supports ruby 1.9 and 2.0
 
 ## Installation
 
 Add this to your Gemfile and run the +bundle+ command.
 
 ```ruby
-  gem "roles"
+gem "roles"
 ```
 
 ## Getting Started
@@ -69,25 +68,31 @@ Add this to your Gemfile and run the +bundle+ command.
 First, create your Role model and migration file using this generator:
 
 ```
-  rails g roles:role Role User
+rails g roles:role
 ```
 
-Role and User classes are the default.
+The command will create a `Role` model and create migrations. Also it will add `rolify` to `User` class.
+
+If you want to use a different name for role and user class, you can specify them as following:
+
+```
+rails g roles:role MyRole MyUser
+```
 
 ### 2. Run the migration
 
 ```
-  rake db:migrate
+rake db:migrate
 ```
 
 ### 3.1 Configure your user model
 
-This gem adds the `rolify` method to your User class.
+This generator automaticaly adds the `rolify` method to your User class.
 
 ```ruby
-  class User < ActiveRecord::Base
-    rolify
-  end
+class User < ActiveRecord::Base
+  rolify
+end
 ```
 
 ### 3.2 Configure your resource models
@@ -101,6 +106,12 @@ class Forum < ActiveRecord::Base
 end
 ```
 
+If you use a different role or user class name than the default `Role` and `User`, you have to specify them as options to the `resourcify` method as following:
+
+``` ruby
+resourcify role_cname: 'MyRole', user_cname: 'MyUser'
+```
+
 ## Resources
 
 * [Rolify](https://github.com/EppO/rolify)

data/lib/roles.rb

@@ -15,10 +15,10 @@ module Roles
     roles_options = { :class_name => options[:role_cname].camelize, :dependent => :destroy }
     roles_options.merge!(options.select{ |k,v| [:before_add, :after_add, :before_remove, :after_remove].include? k.to_sym })
 
-    has_many :roles, roles_options
-
     self.role_cname = options[:role_cname]
     self.user_cname = options[:user_cname]
+
+    has_many self.role_table.to_sym, roles_options
   end
 
   def resourcify(options = {})
@@ -26,17 +26,26 @@ module Roles
     
     options.reverse_merge!({ :role_cname => 'Role', :dependent => :destroy, :user_cname => 'User' })
     resourcify_options = { :class_name => options[:role_cname].camelize, :as => :resource, :dependent => options[:dependent] }
-    has_many :roles, resourcify_options
     
     self.role_cname = options[:role_cname]
     self.user_cname = options[:user_cname]
+
+    has_many self.role_table.to_sym, resourcify_options
+  end
+
+  def user_table
+    @user_table ||= self.user_table.tableize
+  end
+
+  def role_table
+    @role_table ||= self.role_cname.tableize
   end
   
   def user_class
-    self.user_cname.constantize
+    @user_class ||= self.user_cname.constantize
   end
 
   def role_class
-    self.role_cname.constantize
+    @role_class ||= self.role_cname.constantize
   end
 end

data/lib/roles/resource.rb

@@ -7,18 +7,18 @@ module Roles
     module ClassMethods 
       def users_with_role(role_name = nil)
         if role_name.nil?
-          self.user_class.includes(:roles).where("roles.resource_type LIKE '%s'", self.to_s).where("roles.resource_id IS NULL")
+          self.user_class.includes(role_table).where("#{role_table}.resource_type LIKE '%s'", self.to_s).where("#{role_table}.resource_id IS NULL")
         else
-          self.user_class.includes(:roles).where("roles.resource_type LIKE '%s'", self.to_s).where("roles.resource_id IS NULL").where("roles.name LIKE '%s'", role_name.to_s)
+          self.user_class.includes(role_table).where("#{role_table}.resource_type LIKE '%s'", self.to_s).where("#{role_table}.resource_id IS NULL").where("#{role_table}.name LIKE '%s'", role_name.to_s)
         end
       end
     end
 
     def users_with_role(role_name = nil)
       if role_name.nil?
-        self.class.user_class.includes(:roles).where("roles.resource_type LIKE '%s'", self.class.to_s).where("roles.resource_id = %s", self.id)
+        self.class.user_class.includes(self.class.role_table).where("#{self.class.role_table}.resource_type LIKE '%s'", self.class.to_s).where("#{self.class.role_table}.resource_id = %s", self.id)
       else
-        self.class.user_class.includes(:roles).where("roles.resource_type LIKE '%s'", self.class.to_s).where("roles.resource_id = %s", self.id).where("roles.name LIKE '%s'", role_name.to_s)
+        self.class.user_class.includes(self.class.role_table).where("#{self.class.role_table}.resource_type LIKE '%s'", self.class.to_s).where("#{self.class.role_table}.resource_id = %s", self.id).where("#{self.class.role_table}.name LIKE '%s'", role_name.to_s)
       end
     end
   end

data/lib/roles/role.rb

@@ -7,47 +7,47 @@ module Roles
     module ClassMethods
       def with_role(role_name, resource = nil)
         if resource.nil?
-          self.includes(:roles).where("roles.name LIKE '%s'", role_name.to_s).where("roles.resource_type IS NULL").where("roles.resource_id IS NULL")
+          self.includes(role_table).where("#{role_table}.name LIKE '%s'", role_name.to_s).where("#{role_table}.resource_type IS NULL").where("#{role_table}.resource_id IS NULL")
         elsif resource.is_a? Class
-          self.includes(:roles).where("roles.name LIKE '%s'", role_name.to_s).where("roles.resource_type LIKE '%s'", resource.to_s).where("roles.resource_id IS NULL")
+          self.includes(role_table).where("#{role_table}.name LIKE '%s'", role_name.to_s).where("#{role_table}.resource_type LIKE '%s'", resource.to_s).where("#{role_table}.resource_id IS NULL")
         else
-          self.includes(:roles).where("roles.name LIKE '%s'", role_name.to_s).where("roles.resource_type LIKE '%s'", resource.class.to_s).where("roles.resource_id = %s", resource.id)
+          self.includes(role_table).where("#{role_table}.name LIKE '%s'", role_name.to_s).where("#{role_table}.resource_type LIKE '%s'", resource.class.to_s).where("#{role_table}.resource_id = %s", resource.id)
         end
       end
     end
 
     def add_role(role_name, resource = nil)
       if resource.nil?
-        self.roles.where(:resource_type => nil).where(:resource_id => nil).find_or_create_by_name(:name => role_name.to_s)
+        self.send(self.class.role_table).where(:resource_type => nil).where(:resource_id => nil).where(:name => role_name.to_s).first_or_create
       elsif resource.is_a? Class
-        self.roles.where(:resource_type => resource.to_s).where(:resource_id => nil).find_or_create_by_name(:name => role_name.to_s)
+        self.send(self.class.role_table).where(:resource_type => resource.to_s).where(:resource_id => nil).where(:name => role_name.to_s).first_or_create
       else
-        self.roles.where(:resource_type => resource.class.to_s).where(:resource_id => resource.id).find_or_create_by_name(:name => role_name.to_s)
+        self.send(self.class.role_table).where(:resource_type => resource.class.to_s).where(:resource_id => resource.id).where(:name => role_name.to_s).first_or_create
       end
     end
     alias_method :grant, :add_role
 
     def has_role?(role_name, resource = nil)
       if new_record?
-        self.roles.detect { |r| r.name == role_name.to_s && (r.resource == resource || resource.nil?) }.present?
+        self.send(self.class.role_table).detect { |r| r.name == role_name.to_s && (r.resource == resource || resource.nil?) }.present?
       else
         if resource.nil?
-          self.roles.where(:name => role_name.to_s).where(:resource_type => nil).where(:resource_id => nil).size > 0
+          self.send(self.class.role_table).where(:name => role_name.to_s).where(:resource_type => nil).where(:resource_id => nil).size > 0
         elsif resource.is_a? Class
-          self.roles.where(:name => role_name.to_s).where(:resource_type => resource.to_s).where(:resource_id => nil).size > 0
+          self.send(self.class.role_table).where(:name => role_name.to_s).where(:resource_type => resource.to_s).where(:resource_id => nil).size > 0
         else
-          self.roles.where(:name => role_name.to_s).where(:resource_type => resource.class.to_s).where(:resource_id => resource.id).size > 0
+          self.send(self.class.role_table).where(:name => role_name.to_s).where(:resource_type => resource.class.to_s).where(:resource_id => resource.id).size > 0
         end
       end
     end
 
     def remove_role(role_name, resource = nil)
       if resource.nil?
-        self.roles.where(:name => role_name.to_s).where(:resource_type => nil).where(:resource_id => nil).destroy_all
+        self.send(self.class.role_table).where(:name => role_name.to_s).where(:resource_type => nil).where(:resource_id => nil).destroy_all
       elsif resource.is_a? Class
-        self.roles.where(:name => role_name.to_s).where(:resource_type => resource.to_s).where(:resource_id => nil).destroy_all
+        self.send(self.class.role_table).where(:name => role_name.to_s).where(:resource_type => resource.to_s).where(:resource_id => nil).destroy_all
       else
-        self.roles.where(:name => role_name.to_s).where(:resource_type => resource.class.to_s).where(:resource_id => resource.id).destroy_all
+        self.send(self.class.role_table).where(:name => role_name.to_s).where(:resource_type => resource.class.to_s).where(:resource_id => resource.id).destroy_all
       end
     end
     
@@ -55,19 +55,19 @@ module Roles
 
     def role_names(resource = nil)
       if resource.nil?
-        self.roles.where(:resource_type => nil).where(:resource_id => nil).select(:name).map { |r| r.name }
+        self.send(self.class.role_table).where(:resource_type => nil).where(:resource_id => nil).select(:name).map { |r| r.name }
       elsif resource.is_a? Class
-        self.roles.where(:resource_type => resource.name).where(:resource_id => nil).select(:name).map { |r| r.name }
+        self.send(self.class.role_table).where(:resource_type => resource.name).where(:resource_id => nil).select(:name).map { |r| r.name }
       else
-        self.roles.where(:resource_type => resource.class.to_s).where(:resource_id => resource.id).select(:name).map { |r| r.name }
+        self.send(self.class.role_table).where(:resource_type => resource.class.to_s).where(:resource_id => resource.id).select(:name).map { |r| r.name }
       end
     end
 
     def resources_with_role(resource_class, role_name = nil)
       if role_name.nil?
-        resource_class.includes(:roles).where("roles.#{self.class.user_cname.underscore.singularize}_id = %s", self.id).where("roles.resource_type LIKE '%s'", resource_class.to_s)
+        resource_class.includes(self.class.role_table).where("#{self.class.role_table}.#{self.class.user_cname.underscore.singularize}_id = %s", self.id).where("#{self.class.role_table}.resource_type LIKE '%s'", resource_class.to_s)
       else
-        resource_class.includes(:roles).where("roles.#{self.class.user_cname.underscore.singularize}_id = %s", self.id).where("roles.resource_type LIKE '%s'", resource_class.to_s).where("roles.name LIKE '%s'", role_name.to_s)
+        resource_class.includes(self.class.role_table).where("#{self.class.role_table}.#{self.class.user_cname.underscore.singularize}_id = %s", self.id).where("#{self.class.role_table}.resource_type LIKE '%s'", resource_class.to_s).where("#{self.class.role_table}.name LIKE '%s'", role_name.to_s)
       end
     end
 

data/lib/roles/version.rb

@@ -1,3 +1,3 @@
 module Roles
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/roles.gemspec

@@ -24,10 +24,10 @@ Gem::Specification.new do |s|
   else
     s.add_development_dependency "sqlite3"
   end
-  s.add_development_dependency "activerecord", ">= 3.1.0"
+  s.add_development_dependency "activerecord", ">= 3.1.0", "< 4.0.0"
   s.add_development_dependency "ammeter"
   s.add_development_dependency "rake"
-  s.add_development_dependency "rspec", ">= 2.0"
-  s.add_development_dependency "rspec-rails", ">= 2.0"
+  s.add_development_dependency "rspec", ">= 2.2"
+  s.add_development_dependency "rspec-rails", "= 2.10"
   s.add_development_dependency "bundler" 
 end

data/spec/generators/roles/role/role_generator_spec.rb

@@ -7,11 +7,11 @@ describe Roles::Generators::RoleGenerator do
   # Tell the generator where to put its output (what it thinks of as Rails.root)
   destination File.expand_path("../../../../../tmp", __FILE__)
   teardown :cleanup_destination_root
-  
+
   before {
     prepare_destination
   }
-  
+
   def cleanup_destination_root
     FileUtils.rm_rf destination_root
   end
@@ -27,7 +27,7 @@ describe Roles::Generators::RoleGenerator do
       }
       run_generator 
     }
-    
+
     describe 'app/models/role.rb' do
       subject { file('app/models/role.rb') }
       it { should exist }
@@ -36,12 +36,12 @@ describe Roles::Generators::RoleGenerator do
       it { should contain "belongs_to :resource, :polymorphic => true" }
       it { should contain "validates_uniqueness_of :name, :scope => [:user_id, :resource_type, :resource_id]" }
     end
-    
+
     describe 'app/models/user.rb' do
       subject { file('app/models/user.rb') }
       it { should contain /class User < ActiveRecord::Base\n  rolify\n/ }
     end
-    
+
     describe 'migration file' do
       subject { migration_file('db/migrate/roles_create_roles.rb') }
       
@@ -52,7 +52,7 @@ describe Roles::Generators::RoleGenerator do
 
   describe 'specifying user and role names' do
     before(:all) { arguments %w(AdminRole AdminUser) }
-    
+
     before { 
       capture(:stdout) {
         generator.create_file "app/models/admin_user.rb" do
@@ -61,23 +61,23 @@ describe Roles::Generators::RoleGenerator do
       }
       run_generator
     }
-    
+
     describe 'app/models/rank.rb' do
       subject { file('app/models/admin_role.rb') }
-      
+
       it { should exist }
       it { should contain "class AdminRole < ActiveRecord::Base" }
       it { should contain "belongs_to :admin_user" }
       it { should contain "belongs_to :resource, :polymorphic => true" }
       it { should contain "validates_uniqueness_of :name, :scope => [:admin_user_id, :resource_type, :resource_id]" }
     end
-    
+
     describe 'app/models/admin_user.rb' do
       subject { file('app/models/admin_user.rb') }
       
       it { should contain /class AdminUser < ActiveRecord::Base\n  rolify :role_cname => 'AdminRole'\n/ }
     end
-    
+
     describe 'migration file' do
       subject { migration_file('db/migrate/roles_create_admin_roles.rb') }
       

data/spec/roles/resource_spec.rb

@@ -2,9 +2,9 @@ require "spec_helper"
 
 describe Roles::Resource do
   before do
-    User.rolify :role_cname => "Role"
-    Forum.resourcify :role_cname => "Role"
-    Group.resourcify :role_cname => "Role"
+    User.rolify
+    Forum.resourcify
+    Group.resourcify
     reset_data
   end
 
@@ -43,12 +43,12 @@ describe Roles::Resource do
         subject do 
           Group.create(:name => "to delete")
         end
-        
+
         before do
           subject.roles.create :name => "group_role1", :user => admin
           subject.roles.create :name => "group_role2", :user => tourist
         end
-        
+
         it "should remove the roles binded to this instance" do
           expect { subject.destroy }.to change { Role.count }.by(-2)
         end

data/spec/roles/role_spec.rb

@@ -2,9 +2,9 @@ require "spec_helper"
 
 describe Roles::Role do
   before do
-    User.rolify :role_cname => "Role"
-    Forum.resourcify :role_cname => "Role"
-    Group.resourcify :role_cname => "Role"
+    User.rolify
+    Forum.resourcify
+    Group.resourcify
     reset_data
 
     @admin = User.first
@@ -46,14 +46,17 @@ describe Roles::Role do
       @admin.add_role :moderator
       @admin.add_role :moderator
       @admin.role_names.should == ["moderator"]
+      Role.where(:name => :moderator).where(:user_id => @admin.id).count.should == 1
 
       @admin.add_role :moderator, Forum
       @admin.add_role :moderator, Forum
       @admin.role_names(Forum).should == ["moderator"]
+      Role.where(:name => :moderator).where(:resource_type => :Forum).where(:resource_id => nil).where(:user_id => @admin.id).count.should == 1
 
       @admin.add_role :moderator, Forum.first
       @admin.add_role :moderator, Forum.first
       @admin.role_names(Forum.first).should == ["moderator"]
+      Role.where(:name => :moderator).where(:resource_type => :Forum).where(:resource_id => Forum.first.id).where(:user_id => @admin.id).count.should == 1
     end
   
     it "should be use grant instead of add_role" do
@@ -165,7 +168,7 @@ describe Roles::Role do
       @admin.roles.create :name => "moderator", :resource_type => "Forum"
       @admin.roles.create :name => "admin", :resource => Forum.first
     end
-    
+
     it "should remove the roles binded to this instance" do
       expect { @admin.destroy }.to change { Role.count }.by(-3)
     end

metadata

@@ -1,126 +1,117 @@
 --- !ruby/object:Gem::Specification
 name: roles
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - liufengyun
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-02 00:00:00.000000000 Z
+date: 2013-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.1.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 4.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.1.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: ammeter
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.10'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: An extremely simple roles library inspired by rolify
@@ -157,27 +148,26 @@ files:
 - spec/support/schema.rb
 homepage: http://github.com/liufengyun/roles
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: roles
-rubygems_version: 1.8.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Roles library with resource scoping
 test_files:
 - spec/generators/roles/role/role_generator_spec.rb