roles 0.0.1 → 0.0.2

data/CHANGELOG.rdoc

@@ -1,2 +1,5 @@
-= v0.1 (Aug 17, 2012)
+= v0.0.2 (Aug 19, 2012)
+* rename `user.resources` to `user.resources_with_role`
+
+= v0.0.1 (Aug 17, 2012)
 * first release

data/README.md

@@ -1,9 +1,15 @@
 # Roles
 
-Roles is an extremely simple roles gem inspired by rolify.
+Roles is an extremely simple roles gem inspired by [rolify](https://github.com/EppO/rolify).
 
 This library is recommended to be used with [CanCan](https://github.com/ryanb/cancan) and [devise](https://github.com/plataformatec/devise).
 
+## Why Roles
+
+Look at this discussion: [comment](https://github.com/EppO/rolify/issues/80#issuecomment-7790341)
+
+In a word, Rolify uses two tables `roles` and `users_roles` while Roles only uses one table `roles`.
+
 ## Quick Start
 
 ```ruby
@@ -12,6 +18,7 @@ This library is recommended to be used with [CanCan](https://github.com/ryanb/ca
 user.has_role?(:admin)  # if user is admin globally
 user.has_role?(:admin, Organization)  # if user is admin for Organization type
 user.has_role?(:admin, Organization.first) # if user is not admin of the first organization
+user.role_names(instance = nil) # => returns role names of current user, optionally scoped by Class, instance or non-scoped(globally)
 
 # grant roles
 user.add_role(:admin) # a global admin
@@ -32,20 +39,20 @@ user.has_role? :moderator, Forum.first # => false
 user.has_role? :moderator, Forum.last  # => false
 
 # query about users
-Forum.users_with_role(role = nil) => returns all users with roles defined on Forum
-forum.users_with_role => returns users with a role defined of current instance
-User.with_role(role, resource = nil) => returns all users with the given role, optionally scoped by Class, instance or non-scoped(globally)
+Forum.users_with_role(role = nil) # => returns all users with roles defined on Forum
+forum.users_with_role(role = nil) # => returns users with a role defined of current instance
+User.with_role(role, resource = nil) # => returns all users with the given role, optionally scoped by Class, instance or non-scoped(globally)
 
 # query about resources
-user.resouces(resource_class, :role_name = nil) => returns all resources of type resource_class for a given user, optionally filtered by role_name.
-
+user.resources_with_role(Project, role_name = nil)
+# => returns all projects for a given user, optionally filtered by role_name.
 ```
 
 ## Requirements
 
 * Rails >= 3.1
 * ActiveRecord >= 3.1
-* supports ruby 1.9, JRuby 1.6.0+ (in 1.9 mode) and Rubinius 2.0.0dev (in 1.9 mode)
+* supports ruby 1.9
 
 ## Installation
 
@@ -62,12 +69,10 @@ Add this to your Gemfile and run the +bundle+ command.
 First, create your Role model and migration file using this generator:
 
 ```
-  rails g rolify:role Role User
+  rails g roles:role Role User
 ```
 
-Role and User classes are the default. You can specify any Role class name you want. This is completly a new file so any name can do the job.
-For the User class name, you would probably use the one provided by your authentication solution. rolify just adds some class methods in an existing User class.
-
+Role and User classes are the default.
 
 ### 2. Run the migration
 
@@ -99,5 +104,6 @@ end
 ## Resources
 
 * [Rolify](https://github.com/EppO/rolify)
+* [CanCan](https://github.com/ryanb/cancan)
 * [Amazing tutorial](http://railsapps.github.com/tutorial-rails-bootstrap-devise-cancan.html) provided by [RailsApps](http://railsapps.github.com/)
 

data/lib/roles/railtie.rb

@@ -7,14 +7,6 @@ module Rolies
       ActiveSupport.on_load(:active_record) do
         ActiveRecord::Base.send :extend, Roles
       end
-      
-      config.before_initialize do
-        ::Mongoid::Document.module_eval do
-          def self.included(base)
-            base.extend Roles
-          end
-        end
-      end if defined?(Mongoid)
     end
   end
 end

data/lib/roles/role.rb

@@ -63,7 +63,7 @@ module Roles
       end
     end
 
-    def resources(resource_class, role_name = nil)
+    def resources_with_role(resource_class, role_name = nil)
       if role_name.nil?
         resource_class.joins(:roles).where("roles.#{self.class.user_cname.underscore.singularize}_id = %s", self.id).where("roles.resource_type LIKE '%s'", resource_class.to_s)
       else

data/lib/roles/version.rb

@@ -1,3 +1,3 @@
 module Roles
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roles
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-17 00:00:00.000000000 Z
+date: 2012-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3