easy_roles 0.4.1 → 0.4.2

data/README.rdoc

@@ -4,8 +4,15 @@ Simple rails gem for basic role authorization with ruby on rails.
 
 == Changelog
 
+=== 03 February 2010 - Version 0.4.2
+Fixed migration names
+Does not allow duplicates to be added
+
+=== 08 December 2009 - Version 0.4.1
+Added a bitmask migration generator (Read below for usage)
+
 === 08 December 2009 - Version 0.4.0
-Added the ability to use bitmasks instead of serializing the roles in a table
+Added the ability to use bitmasks instead of serializing the roles in a table (Read below on how to setup and use)
 
 === 17 November 2009 - Version 0.3.0
 Added a generator to generate the database columns "script/generate easy_roles Table Column_Name"
@@ -47,11 +54,36 @@ Then you need to add "easy_roles :column_name" to your model.
   
 === Bitmask Method
 
+==== WARNING: If you plan on using the column name 'roles' for the bitmask method your getter and setter actions will be 'easy_roles' and 'easy_roles=', instead of 'roles' and 'roles='. I would suggest using 'roles_mask' as your roles column for this method.
+
 Add the following to your enviroment.rb in the rails initializer block
 
   config.gem 'easy_roles', :source => 'http://gemcutter.org'
   
-And thats it.
+(from version 0.4.1) use the migration generator to generate the roles column for your users table
+
+  E.G. script/generate easy_bitmask_roles user roles_mask
+
+Or add a "roles_mask" column to your users model of type 'integer', and set the default value to 0. Please note you can call this column anything you like, I like to use the name "roles_mask".
+
+  t.integer :roles_mask, :default => 0
+  
+Add "easy_roles :column_name, :method => :bitmask" to your model.
+
+  class User < ActiveRecord::Base
+    easy_roles :roles_mask, :method => :bitmask
+  end
+  
+And lastly you need to add a constant variable which stores an array of the different roles for your system. The name of the constant must be the name of your column in full caps.
+
+==== WARNING: Bitmask storage relies that you DO NOT change the order of your array of roles, if you need to add a new role, just append it to the end of the array.
+
+  class User < ActiveRecord::Base
+    easy_roles :roles_mask, :method => :bitmask
+    
+    # Constant variable storing roles in the system
+    ROLES_MASK = %w[admin moderator user]
+  end
 
 == Usage
 
@@ -68,6 +100,10 @@ check to see if a user has a certain role
   # or
   is_role? # role being anything you like, for example 'is_admin?' or 'is_awesome?'
   
+For every method above there is a bang method too.
+  add_role! 'role'
+  remove_role! 'role'
+  
 == Examples
 
   @user = User.first
@@ -119,8 +155,12 @@ Then in your AdminsController or any controller that you only want admins to vie
   class MarksController < ApplicationController
      before_filter :admin_required, :only => :create, :update
   end
-  
-check out http://blog.platform45.com/2009/10/05/howto-basic-roles-for-users for implementation, and http://blog.platform45.com/2009/10/07/easy-roles-gem-released for usage.
+
+Check out http://blog.platform45.com/2009/10/05/howto-basic-roles-for-users for implementation, and http://blog.platform45.com/2009/10/07/easy-roles-gem-released for usage.
+
+Follow me on twitter: http://twitter.com/ryan_za
+
+Email: ryan *at* platform45.com
 
 
 == License

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('easy_roles', '0.4.1') do |p|
+Echoe.new('easy_roles', '0.4.2') do |p|
   p.description    = "Easy role authorization in rails"
   p.url            = "http://github.com/platform45/easy_roles"
   p.author         = "Platform45"

data/easy_roles.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{easy_roles}
-  s.version = "0.4.1"
+  s.version = "0.4.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Platform45"]
-  s.date = %q{2009-12-08}
+  s.date = %q{2010-02-03}
   s.description = %q{Easy role authorization in rails}
   s.email = %q{ryan@platform45.com}
   s.extra_rdoc_files = ["README.rdoc", "lib/easy_roles.rb"]

data/generators/easy_bitmask_roles/easy_bitmask_roles_generator.rb

@@ -2,7 +2,7 @@ class EasyBitmaskRolesGenerator < Rails::Generator::NamedBase
   def manifest
     record do |m|
       m.class_collisions class_name
-      m.migration_template 'migration.rb', "db/migrate", :migration_file_name => "add_#{args.first}_to_#{table_name}"
+      m.migration_template 'migration.rb', "db/migrate", :migration_file_name => "add_bitmask_roles_to_#{table_name}"
     end
   end
 end

data/generators/easy_roles/easy_roles_generator.rb

@@ -2,7 +2,7 @@ class EasyRolesGenerator < Rails::Generator::NamedBase
   def manifest
     record do |m|
       m.class_collisions class_name
-      m.migration_template 'migration.rb', "db/migrate", :migration_file_name => "add_#{args.first}_to_#{table_name}"
+      m.migration_template 'migration.rb', "db/migrate", :migration_file_name => "add_roles_to_#{table_name}"
     end
   end
 end

data/lib/easy_roles.rb

@@ -19,7 +19,8 @@ module EasyRoles
           end
 
           def add_role(role)
-            self.#{name} << role
+            clear_roles if self.#{name}.nil?
+            has_role?(role) ? false : self.#{name} << role
           end
         
           def add_role!(role)
@@ -68,7 +69,7 @@ module EasyRoles
           end
           
           def add_role(role)
-            new_roles = #{def_name}.push(role)
+            new_roles = #{def_name}.push(role).uniq
             self.#{def_name} = new_roles
           end
           

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: easy_roles
 version: !ruby/object:Gem::Version 
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors: 
 - Platform45
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-08 00:00:00 +02:00
+date: 2010-02-03 00:00:00 +02:00
 default_executable: 
 dependencies: []