easy_roles 1.0.0 → 1.1.0

data/CHANGELOG.rdoc

@@ -0,0 +1,22 @@
+=== 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!!!)
+
+=== 05 April 2010 - Version 1.0.0
+Serialize method updated for Rails 3 compatibility. (Thanks to firebelly for pointing this out)
+
+=== 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 (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"
+
+=== 21 October 2009 - Version 0.2.0
+Added bang methods for 'add_role' and 'remove_role' which can be accessed through 'add_role!' and 'remove_role!' respectively.

data/Manifest

@@ -1,6 +1,7 @@
-Manifest
+CHANGELOG.rdoc
 README.rdoc
 Rakefile
+easy_roles.gemspec
 generators/easy_bitmask_roles/USAGE
 generators/easy_bitmask_roles/easy_bitmask_roles_generator.rb
 generators/easy_bitmask_roles/templates/migration.rb
@@ -9,3 +10,6 @@ generators/easy_roles/easy_roles_generator.rb
 generators/easy_roles/templates/migration.rb
 init.rb
 lib/easy_roles.rb
+spec/easy_roles_spec.rb
+spec/spec_helper.rb
+Manifest

data/README.rdoc

@@ -4,24 +4,7 @@ Simple rails gem for basic role authorization with ruby on rails.
 
 == Changelog
 
-=== 05 April 2010 - Version 0.4.2
-Serialize method updated for Rails 3 compatibility. (Thanks to firebelly for pointing this out)
-
-=== 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 (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"
-
-=== 21 October 2009 - Version 0.2.0
-Added bang methods for 'add_role' and 'remove_role' which can be accessed through 'add_role!' and 'remove_role!' respectively.
+Please read the CHANGELOG.rdoc file.
 
 == Install
 

data/Rakefile

@@ -2,11 +2,11 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('easy_roles', '1.0.0') do |p|
+Echoe.new('easy_roles', '1.1.0') 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 = []
+  p.development_dependencies = ["rspec", "active_record", "sqlite3-ruby"]
 end

data/easy_roles.gemspec

@@ -2,29 +2,38 @@
 
 Gem::Specification.new do |s|
   s.name = %q{easy_roles}
-  s.version = "1.0.0"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Platform45"]
-  s.date = %q{2010-04-05}
+  s.date = %q{2010-09-06}
   s.description = %q{Easy role authorization in rails}
   s.email = %q{ryan@platform45.com}
-  s.extra_rdoc_files = ["README.rdoc", "lib/easy_roles.rb"]
-  s.files = ["Manifest", "README.rdoc", "Rakefile", "generators/easy_bitmask_roles/USAGE", "generators/easy_bitmask_roles/easy_bitmask_roles_generator.rb", "generators/easy_bitmask_roles/templates/migration.rb", "generators/easy_roles/USAGE", "generators/easy_roles/easy_roles_generator.rb", "generators/easy_roles/templates/migration.rb", "init.rb", "lib/easy_roles.rb", "easy_roles.gemspec"]
+  s.extra_rdoc_files = ["CHANGELOG.rdoc", "README.rdoc", "lib/easy_roles.rb"]
+  s.files = ["CHANGELOG.rdoc", "README.rdoc", "Rakefile", "easy_roles.gemspec", "generators/easy_bitmask_roles/USAGE", "generators/easy_bitmask_roles/easy_bitmask_roles_generator.rb", "generators/easy_bitmask_roles/templates/migration.rb", "generators/easy_roles/USAGE", "generators/easy_roles/easy_roles_generator.rb", "generators/easy_roles/templates/migration.rb", "init.rb", "lib/easy_roles.rb", "spec/easy_roles_spec.rb", "spec/spec_helper.rb", "Manifest"]
   s.homepage = %q{http://github.com/platform45/easy_roles}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Easy_roles", "--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{easy_roles}
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{Easy role authorization in rails}
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<active_record>, [">= 0"])
+      s.add_development_dependency(%q<sqlite3-ruby>, [">= 0"])
     else
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<active_record>, [">= 0"])
+      s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
     end
   else
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<active_record>, [">= 0"])
+    s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
   end
 end

data/lib/easy_roles.rb

@@ -2,6 +2,7 @@ module EasyRoles
   def self.included(base)
     base.extend ClassMethods
     base.send :alias_method_chain, :method_missing, :roles
+    base.send :alias_method_chain, :respond_to?, :roles
   end
   
   module ClassMethods
@@ -113,8 +114,18 @@ module EasyRoles
       method_missing_without_roles(method_id, *args, &block)
     end
   end
+  
+  def respond_to_with_roles?(method_id, include_private = false)
+    match = method_id.to_s.match(/^is_(\w+)[?]$/)
+    if match && respond_to?('has_role?')
+      true
+    else
+      respond_to_without_roles?(method_id, include_private = false)
+    end
+  end
 end
 
 class ActiveRecord::Base
   include EasyRoles
-end
+end
+

data/spec/easy_roles_spec.rb

@@ -0,0 +1,332 @@
+require 'spec_helper'
+
+describe EasyRoles do
+  describe "serialize method" do
+    it "should allow me to set a users role" do
+      user = SerializeUser.new
+      user.add_role 'admin'
+      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
+      user = SerializeUser.new
+      user.add_role 'admin'
+      user.is_admin?.should be_true
+    end
+    
+    it "should return true for has_role? 'admin' if the admin role is added to the user" do
+      user = SerializeUser.new
+      user.add_role 'admin'
+      user.has_role?('admin').should be_true
+    end
+    
+    it "should turn false for has_role? 'manager' if manager role is not added to the user" do
+      user = SerializeUser.new
+      user.has_role?('manager').should be_false
+    end
+    
+    it "should turn false for is_manager? if manager role is not added to the user" do
+      user = SerializeUser.new
+      user.is_manager?.should be_false
+    end
+    
+    it "should return the users role through association" do
+      user = BitmaskUser.create(:name => "Bob")
+      user.add_role! "admin"
+      
+      membership = Membership.create(:name => "Test Membership", :bitmask_user => user)
+      
+      Membership.last.bitmask_user.is_admin?.should be_true
+    end
+    
+    it "should get no method error if no easy roles on model" do
+      begin
+      b = Beggar.create(:name => "Ivor")
+      
+      b.is_admin?
+      rescue => e
+        e.class.should == NoMethodError
+      end
+    end
+    
+    it "should get no method error if no easy roles on model even through association" do
+      begin
+      b = Beggar.create(:name => "Ivor")
+      m = Membership.create(:name => "Beggars club", :beggar => b)
+      
+      Membership.last.beggar.is_admin?
+      rescue => e
+        e.class.should == NoMethodError
+      end
+    end
+    
+    describe "normal methods" do
+      it "should not save to the database if not implicitly saved" do
+        user = SerializeUser.create(:name => "Ryan")
+        user.add_role 'admin'
+        user.is_admin?.should be_true
+        user.reload
+      
+        user.is_admin?.should be_false
+      end
+    
+      it "should save to the database if implicity saved" do
+        user = SerializeUser.create(:name => "Ryan")
+        user.add_role 'admin'
+        user.is_admin?.should be_true
+        user.save
+        user.reload
+      
+        user.is_admin?.should be_true
+      end
+      
+      it "should clear all roles and not save if not implicitly saved" do
+        user = SerializeUser.create(:name => "Ryan")
+        user.add_role 'admin'
+        user.is_admin?.should be_true
+        user.save
+        user.reload
+        user.is_admin?.should be_true
+        
+        user.clear_roles
+        user.is_admin?.should be_false
+        user.reload
+        
+        user.is_admin?.should be_true
+      end
+      
+      it "should clear all roles and save if implicitly saved" do
+        user = SerializeUser.create(:name => "Ryan")
+        user.add_role 'admin'
+        user.is_admin?.should be_true
+        user.save
+        user.reload
+        user.is_admin?.should be_true
+        
+        user.clear_roles
+        user.is_admin?.should be_false
+        user.save
+        user.reload
+        
+        user.is_admin?.should be_false
+      end
+      
+      it "should remove a role and not save unless implicitly saved" do
+        user = SerializeUser.create(:name => "Ryan")
+        user.add_role 'admin'
+        user.is_admin?.should be_true
+        user.save
+        user.reload
+      
+        user.is_admin?.should be_true
+        user.remove_role 'admin'
+        user.is_admin?.should be_false
+        user.reload
+        
+        user.is_admin?.should be_true
+      end
+      
+      it "should remove a role and save if implicitly saved" do
+        user = SerializeUser.create(:name => "Ryan")
+        user.add_role 'admin'
+        user.is_admin?.should be_true
+        user.save
+        user.reload
+      
+        user.is_admin?.should be_true
+        user.remove_role 'admin'
+        user.is_admin?.should be_false
+        user.save
+        user.reload
+        
+        user.is_admin?.should be_false
+      end
+    end
+    
+    describe "bang method" do
+      it "should save to the database if the bang method is used" do
+        user = SerializeUser.create(:name => "Ryan")
+        user.add_role! 'admin'
+        user.is_admin?.should be_true
+        user.reload
+      
+        user.is_admin?.should be_true
+      end
+      
+      it "should remove a role and save" do
+        user = SerializeUser.create(:name => "Ryan")
+        user.add_role 'admin'
+        user.is_admin?.should be_true
+        user.save
+        user.reload
+      
+        user.is_admin?.should be_true
+        user.remove_role! 'admin'
+        user.is_admin?.should be_false
+        user.reload
+        
+        user.is_admin?.should be_false
+      end
+    end
+  end
+  
+  describe "bitmask method" 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
+    end
+    
+    it "should return true for is_admin? if the admin role is added to the user" do
+      user = BitmaskUser.new
+      user.add_role 'admin'
+      user.is_admin?.should be_true
+    end
+    
+    it "should return true for has_role? 'admin' if the admin role is added to the user" do
+      user = BitmaskUser.new
+      user.add_role 'admin'
+      user.has_role?('admin').should be_true
+    end
+    
+    it "should turn false for has_role? 'manager' if manager role is not added to the user" do
+      user = BitmaskUser.new
+      user.has_role?('manager').should be_false
+    end
+    
+    it "should turn false for is_manager? if manager role is not added to the user" do
+      user = BitmaskUser.new
+      user.is_manager?.should be_false
+    end
+    
+    it "should not allow you to add a role not in the array list of roles" do
+      user = BitmaskUser.new
+      user.add_role 'lolcat'
+      user.is_lolcat?.should be_false
+    end
+    
+    describe "normal methods" do
+      it "should not save to the database if not implicitly saved" do
+        user = BitmaskUser.create(:name => "Ryan")
+        user.add_role 'admin'
+        user.is_admin?.should be_true
+        user.reload
+      
+        user.is_admin?.should be_false
+      end
+    
+      it "should save to the database if implicity saved" do
+        user = BitmaskUser.create(:name => "Ryan")
+        user.add_role 'admin'
+        user.is_admin?.should be_true
+        user.save
+        user.reload
+      
+        user.is_admin?.should be_true
+      end
+      
+      it "should clear all roles and not save if not implicitly saved" do
+        user = BitmaskUser.create(:name => "Ryan")
+        user.add_role 'admin'
+        user.is_admin?.should be_true
+        user.save
+        user.reload
+        user.is_admin?.should be_true
+        
+        user.clear_roles
+        user.is_admin?.should be_false
+        user.reload
+        
+        user.is_admin?.should be_true
+      end
+      
+      it "should clear all roles and save if implicitly saved" do
+        user = BitmaskUser.create(:name => "Ryan")
+        user.add_role 'admin'
+        user.is_admin?.should be_true
+        user.save
+        user.reload
+        user.is_admin?.should be_true
+        
+        user.clear_roles
+        user.is_admin?.should be_false
+        user.save
+        user.reload
+        
+        user.is_admin?.should be_false
+      end
+      
+      it "should remove a role and not save unless implicitly saved" do
+        user = BitmaskUser.create(:name => "Ryan")
+        user.add_role 'admin'
+        user.is_admin?.should be_true
+        user.save
+        user.reload
+      
+        user.is_admin?.should be_true
+        user.remove_role 'admin'
+        user.is_admin?.should be_false
+        user.reload
+        
+        user.is_admin?.should be_true
+      end
+      
+      it "should remove a role and save if implicitly saved" do
+        user = BitmaskUser.create(:name => "Ryan")
+        user.add_role 'admin'
+        user.is_admin?.should be_true
+        user.save
+        user.reload
+      
+        user.is_admin?.should be_true
+        user.remove_role 'admin'
+        user.is_admin?.should be_false
+        user.save
+        user.reload
+        
+        user.is_admin?.should be_false
+      end
+    end
+    
+    describe "bang method" do
+      it "should save to the database if the bang method is used" do
+        user = BitmaskUser.create(:name => "Ryan")
+        user.add_role! 'admin'
+        user.is_admin?.should be_true
+        user.reload
+      
+        user.is_admin?.should be_true
+      end
+      
+      it "should remove a role and save" do
+        user = BitmaskUser.create(:name => "Ryan")
+        user.add_role 'admin'
+        user.is_admin?.should be_true
+        user.save
+        user.reload
+      
+        user.is_admin?.should be_true
+        user.remove_role! 'admin'
+        user.is_admin?.should be_false
+        user.reload
+        
+        user.is_admin?.should be_false
+      end
+      
+      it "should clear all roles and save" do
+        user = BitmaskUser.create(:name => "Ryan")
+        user.add_role 'admin'
+        user.is_admin?.should be_true
+        user.save
+        user.reload
+        user.is_admin?.should be_true
+        
+        user.clear_roles!
+        user.is_admin?.should be_false
+        user.reload
+        
+        user.is_admin?.should be_false
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,65 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'active_record'
+require 'easy_roles'
+
+require 'spec'
+require 'spec/autorun'
+
+
+Spec::Runner.configure do |config|
+end
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+def setup_db
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :serialize_users do |t|
+      t.string :name
+      t.string :roles, :default => "--- []"
+    end
+    create_table :bitmask_users do |t|
+      t.string :name
+      t.integer :roles_mask, :default => 0
+    end
+    
+    create_table :memberships do |t|
+      t.string :name
+      t.integer :bitmask_user_id
+      t.integer :beggar_id
+    end
+    
+    create_table :beggars do |t|
+      t.string :name
+    end
+  end
+end
+
+def teardown_db
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+end
+
+setup_db
+
+class SerializeUser < ActiveRecord::Base
+  easy_roles :roles, :method => :serialize
+end
+
+class BitmaskUser < ActiveRecord::Base
+  has_many :memberships
+  easy_roles :roles_mask, :method => :bitmask
+  
+  ROLES_MASK = %w[admin manager user]
+end
+
+class Membership < ActiveRecord::Base
+  belongs_to :bitmask_user
+  belongs_to :beggar
+end
+
+class Beggar < ActiveRecord::Base
+  has_many :memberships
+end

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: easy_roles
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  hash: 19
+  prerelease: false
+  segments: 
+  - 1
+  - 1
+  - 0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Platform45
@@ -9,10 +15,51 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-05 00:00:00 +02:00
+date: 2010-09-06 00:00:00 +02:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: active_record
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
 description: Easy role authorization in rails
 email: ryan@platform45.com
 executables: []
@@ -20,12 +67,14 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
+- CHANGELOG.rdoc
 - README.rdoc
 - lib/easy_roles.rb
 files: 
-- Manifest
+- CHANGELOG.rdoc
 - README.rdoc
 - Rakefile
+- easy_roles.gemspec
 - generators/easy_bitmask_roles/USAGE
 - generators/easy_bitmask_roles/easy_bitmask_roles_generator.rb
 - generators/easy_bitmask_roles/templates/migration.rb
@@ -34,7 +83,9 @@ files:
 - generators/easy_roles/templates/migration.rb
 - init.rb
 - lib/easy_roles.rb
-- easy_roles.gemspec
+- spec/easy_roles_spec.rb
+- spec/spec_helper.rb
+- Manifest
 has_rdoc: true
 homepage: http://github.com/platform45/easy_roles
 licenses: []
@@ -50,21 +101,28 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 11
+      segments: 
+      - 1
+      - 2
       version: "1.2"
-  version: 
 requirements: []
 
 rubyforge_project: easy_roles
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Easy role authorization in rails