easy_roles 1.2.0 → 2.0.0.beta1

data/CHANGELOG.rdoc

@@ -1,3 +1,7 @@
+=== 18 August 2011 - Version 2.0.0.beta
+Rewrite the whole gem to be more modular, API is exactly the same
+Only supports Rails 3.x
+
 === 06 September 2010 - Version 1.1.0
 Fixed the issue where the is_user? method was not working through association, if the is_user? method had not been called before
 Wrote tests (FINALLY!!!)

data/Manifest

@@ -11,6 +11,8 @@ lib/generators/active_record/templates/migration_bitmask.rb
 lib/generators/active_record/templates/migration_non_bitmask.rb
 lib/generators/easy_roles/easy_roles_generator.rb
 lib/generators/templates/README
+lib/methods/bitmask.rb
+lib/methods/serialize.rb
 spec/easy_roles_spec.rb
 spec/spec_helper.rb
 Manifest

data/README.rdoc

@@ -8,8 +8,6 @@ Please read the CHANGELOG.rdoc file.
 
 == Install
 
-  gem install gemcutter
-  gem tumble
   gem install easy_roles 
   
 or it can be installed as a rails plugin.
@@ -20,19 +18,17 @@ or it can be installed as a rails plugin.
 
 === Serialize Method
 
-Add the following to your enviroment.rb in the rails initializer block
+Add the following to your Gemfile:
+  gem 'easy_roles'
 
-  config.gem 'easy_roles', :source => 'http://gemcutter.org'
-  
-(from version 0.3.0) use the migration generator
-
-  script/generate easy_roles user roles
+Then generate the migration:
+  rails g easy_roles user roles
 
 Or add a "roles" column to your users model, and set the default value to "--- []". Please note you can call this column anything you like, I like to use the name "roles".
 
   t.string :roles, :default => "--- []"
   
-Then you need to add "easy_roles :column_name" to your model.
+Then you need to add "easy_roles :column_name" to your model:
 
   class User < ActiveRecord::Base
     easy_roles :roles
@@ -40,17 +36,15 @@ 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'
+Add the following to your Gemfile:
   
-(from version 0.4.1) use the migration generator to generate the roles column for your users table
+  gem 'easy_roles'
 
-  E.G. script/generate easy_bitmask_roles user roles_mask
+Then generate the migration:
+  
+  rails g easy_bitmask_roles user roles
 
-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".
+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
   
@@ -142,16 +136,13 @@ Then in your AdminsController or any controller that you only want admins to vie
      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.
-
 Follow me on twitter: http://twitter.com/ryan_za
 
 Email: ryan *at* platform45.com
 
-
 == License
 
-Copyright (c) 2009 Platform45
+Copyright (c) 2011 Platform45
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -2,11 +2,11 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('easy_roles', '1.2.0') do |p|
+Echoe.new('easy_roles', '2.0.0.beta1') do |p|
   p.description    = "Easy role authorization in rails"
   p.url            = "http://github.com/platform45/easy_roles"
   p.author         = "Platform45"
   p.email          = "ryan@platform45.com"
   p.ignore_pattern = ["tmp/*", "script/*"]
   p.development_dependencies = ["rspec", "activerecord", "sqlite3"]
-end
+end

data/easy_roles.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{easy_roles}
-  s.version = "1.2.0"
+  s.version = "2.0.0.beta1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Platform45}]
   s.date = %q{2011-08-18}
   s.description = %q{Easy role authorization in rails}
   s.email = %q{ryan@platform45.com}
-  s.extra_rdoc_files = [%q{CHANGELOG.rdoc}, %q{README.rdoc}, %q{lib/easy_roles.rb}, %q{lib/generators/active_record/easy_roles_generator.rb}, %q{lib/generators/active_record/templates/migration_bitmask.rb}, %q{lib/generators/active_record/templates/migration_non_bitmask.rb}, %q{lib/generators/easy_roles/easy_roles_generator.rb}, %q{lib/generators/templates/README}]
-  s.files = [%q{CHANGELOG.rdoc}, %q{Gemfile}, %q{Gemfile.lock}, %q{README.rdoc}, %q{Rakefile}, %q{easy_roles.gemspec}, %q{init.rb}, %q{lib/easy_roles.rb}, %q{lib/generators/active_record/easy_roles_generator.rb}, %q{lib/generators/active_record/templates/migration_bitmask.rb}, %q{lib/generators/active_record/templates/migration_non_bitmask.rb}, %q{lib/generators/easy_roles/easy_roles_generator.rb}, %q{lib/generators/templates/README}, %q{spec/easy_roles_spec.rb}, %q{spec/spec_helper.rb}, %q{Manifest}]
+  s.extra_rdoc_files = [%q{CHANGELOG.rdoc}, %q{README.rdoc}, %q{lib/easy_roles.rb}, %q{lib/generators/active_record/easy_roles_generator.rb}, %q{lib/generators/active_record/templates/migration_bitmask.rb}, %q{lib/generators/active_record/templates/migration_non_bitmask.rb}, %q{lib/generators/easy_roles/easy_roles_generator.rb}, %q{lib/generators/templates/README}, %q{lib/methods/bitmask.rb}, %q{lib/methods/serialize.rb}]
+  s.files = [%q{CHANGELOG.rdoc}, %q{Gemfile}, %q{Gemfile.lock}, %q{README.rdoc}, %q{Rakefile}, %q{easy_roles.gemspec}, %q{init.rb}, %q{lib/easy_roles.rb}, %q{lib/generators/active_record/easy_roles_generator.rb}, %q{lib/generators/active_record/templates/migration_bitmask.rb}, %q{lib/generators/active_record/templates/migration_non_bitmask.rb}, %q{lib/generators/easy_roles/easy_roles_generator.rb}, %q{lib/generators/templates/README}, %q{lib/methods/bitmask.rb}, %q{lib/methods/serialize.rb}, %q{spec/easy_roles_spec.rb}, %q{spec/spec_helper.rb}, %q{Manifest}]
   s.homepage = %q{http://github.com/platform45/easy_roles}
   s.rdoc_options = [%q{--line-numbers}, %q{--inline-source}, %q{--title}, %q{Easy_roles}, %q{--main}, %q{README.rdoc}]
   s.require_paths = [%q{lib}]

data/lib/easy_roles.rb

@@ -1,107 +1,31 @@
+require 'active_support'
+
 module EasyRoles
-  def self.included(base)
-    base.extend ClassMethods
+  extend ActiveSupport::Concern
+  
+  included do |base|
     base.send :alias_method_chain, :method_missing, :roles
     base.send :alias_method_chain, :respond_to?, :roles
   end
+
+  ALLOWED_METHODS = [:serialize, :bitmask]
+  
+  ALLOWED_METHODS.each do |method|
+    autoload method.to_s.capitalize.to_sym, "methods/#{method}"
+  end
   
   module ClassMethods
     def easy_roles(name, options = {})
-      
       options[:method] ||= :serialize
-      
-      if options[:method] == :serialize
-        serialize name.to_sym, Array
-        
-        ActiveSupport::Deprecation.silence do
-          respond_to?(:before_validation_on_create) ? before_validation_on_create(:make_default_roles) : before_validation(:make_default_roles, :on => :create)
-        end
-        
-        class_eval <<-EOC
-          def has_role?(role)
-            #{name}.include?(role)
-          end
-
-          def add_role(role)
-            clear_roles if self.#{name}.nil?
-            has_role?(role) ? false : self.#{name} << role
-          end
+     
+      begin
+        raise NameError unless ALLOWED_METHODS.include? options[:method]
         
-          def add_role!(role)
-            add_role(role)
-            self.save!
-          end
-
-          def remove_role(role)
-            self.#{name}.delete(role)
-          end
-        
-          def remove_role!(role)
-            remove_role(role)
-            self.save!
-          end
-        
-          def clear_roles
-            self.#{name} = []
-          end
-        
-          def make_default_roles
-            clear_roles if #{name}.nil?
-          end
+        "EasyRoles::#{options[:method].to_s.camelize}".constantize.new(self, name, options)     
+      rescue NameError
+        puts "[Easy Roles] Storage method does not exist reverting to Serialize"
         
-          private :make_default_roles
-        EOC
-      elsif options[:method] == :bitmask
-        
-        def_name = (name == :roles) ? :easy_roles : :roles
-        
-        class_eval <<-EOC
-          def self.list_roles
-            #{name.to_s.upcase}
-          end
-        
-          def #{def_name}=(roles)
-            self.#{name} = (roles & #{name.to_s.upcase}).map { |r| 2**#{name.to_s.upcase}.index(r) }.sum
-          end
-
-          def #{def_name}
-            #{name.to_s.upcase}.reject { |r| ((#{name} || 0) & 2**#{name.to_s.upcase}.index(r)).zero? }
-          end
-          
-          def has_role?(role)
-            #{def_name}.include?(role)
-          end
-          
-          def add_role(role)
-            new_roles = #{def_name}.push(role).uniq
-            self.#{def_name} = new_roles
-          end
-          
-          def add_role!(role)
-            add_role(role)
-            self.save!
-          end
-          
-          def remove_role(role)
-            new_roles = #{def_name}
-            new_roles.delete(role)
-            self.#{def_name} = new_roles
-          end
-          
-          def remove_role!(role)
-            remove_role(role)
-            self.save!
-          end
-          
-          def clear_roles
-            self.#{name} = 0
-          end
-          
-          def clear_roles!
-            self.#{name} = 0
-            self.save!
-          end
-        EOC
+        EasyRoles::Serialize.new(self, name, options)
       end
     end
   end

data/lib/methods/bitmask.rb

@@ -0,0 +1,55 @@
+module EasyRoles
+  class Bitmask
+    def initialize(base, column_name, options)
+      base.send :define_method, :_roles= do |roles|
+        states = base.const_get(column_name.upcase.to_sym)
+
+        self[column_name.to_sym] = (roles & states).map { |r| 2**states.index(r) }.sum
+      end
+
+      base.send :define_method, :_roles do
+        states = base.const_get(column_name.upcase.to_sym)
+
+        states.reject { |r| ((self[column_name.to_sym] || 0) & 2**states.index(r)).zero? }
+      end
+      
+      base.send :define_method, :has_role? do |role|
+        self._roles.inspect
+
+        self._roles.include?(role)
+      end
+
+      base.send :define_method, :add_role do |role|
+        new_roles = self._roles.push(role).uniq
+        self._roles = new_roles
+      end
+
+      base.send :define_method, :add_role! do |role|
+        add_role(role)
+        self.save!
+      end
+
+      base.send :define_method, :remove_role do |role|
+        new_roles = self._roles
+        new_roles.delete(role)
+
+        self._roles = new_roles
+      end
+
+      base.send :define_method, :remove_role! do |role|
+        remove_role(role)
+        self.save!
+      end
+
+      base.send :define_method, :clear_roles do
+        self[column_name.to_sym] = 0
+      end
+
+      base.send :define_method, :clear_roles! do 
+        self.clear_roles
+
+        self.save!
+      end
+    end
+  end
+end

data/lib/methods/serialize.rb

@@ -0,0 +1,45 @@
+module EasyRoles
+  class Serialize
+    def initialize(base, column_name, options)
+      base.serialize column_name.to_sym, Array
+
+      ActiveSupport::Deprecation.silence do
+        base.before_validation(:make_default_roles, :on => :create)
+      end
+      
+      base.send :define_method, :has_role? do |role|
+        self[column_name.to_sym].include?(role)
+      end
+
+      base.send :define_method, :add_role do |role|
+        clear_roles if self[column_name.to_sym].blank?
+
+        has_role?(role) ? false : self[column_name.to_sym] << role
+      end
+
+      base.send :define_method, :add_role! do |role|
+        add_role(role)
+        self.save!
+      end
+
+      base.send :define_method, :remove_role do |role|
+        self[column_name.to_sym].delete(role)
+      end
+
+      base.send :define_method, :remove_role! do |role|
+        remove_role(role)
+        self.save!
+      end
+
+      base.send :define_method, :clear_roles do
+        self[column_name.to_sym] = []
+      end
+
+      base.send :define_method, :make_default_roles do
+        clear_roles if self[column_name.to_sym].blank?
+      end
+
+      base.send :private, :make_default_roles
+    end
+  end
+end

data/spec/easy_roles_spec.rb

@@ -174,7 +174,7 @@ describe EasyRoles do
     it "should allow me to set a users role" do
       user = BitmaskUser.new
       user.add_role 'admin'
-      user.roles.include?("admin").should be_true
+      user._roles.include?("admin").should be_true
     end
     
     it "should return true for is_admin? if the admin role is added to the user" do

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: easy_roles
 version: !ruby/object:Gem::Version
-  version: 1.2.0
-  prerelease: 
+  version: 2.0.0.beta1
+  prerelease: 6
 platform: ruby
 authors:
 - Platform45
@@ -13,7 +13,7 @@ date: 2011-08-18 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2153550700 !ruby/object:Gem::Requirement
+  requirement: &2153037320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153550700
+  version_requirements: *2153037320
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &2153550220 !ruby/object:Gem::Requirement
+  requirement: &2153036840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153550220
+  version_requirements: *2153036840
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &2153549740 !ruby/object:Gem::Requirement
+  requirement: &2153036360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153549740
+  version_requirements: *2153036360
 description: Easy role authorization in rails
 email: ryan@platform45.com
 executables: []
@@ -57,6 +57,8 @@ extra_rdoc_files:
 - lib/generators/active_record/templates/migration_non_bitmask.rb
 - lib/generators/easy_roles/easy_roles_generator.rb
 - lib/generators/templates/README
+- lib/methods/bitmask.rb
+- lib/methods/serialize.rb
 files:
 - CHANGELOG.rdoc
 - Gemfile
@@ -71,6 +73,8 @@ files:
 - lib/generators/active_record/templates/migration_non_bitmask.rb
 - lib/generators/easy_roles/easy_roles_generator.rb
 - lib/generators/templates/README
+- lib/methods/bitmask.rb
+- lib/methods/serialize.rb
 - spec/easy_roles_spec.rb
 - spec/spec_helper.rb
 - Manifest