cancan-permits 0.2.2 → 0.2.3

data/README.markdown

@@ -5,7 +5,7 @@ Role specific Permits for use with [CanCan](http://github.com/ryanb/cancan) perm
 ## Update Oct 13
 
 Now updated to support multiple ownership startegies so that alternative ORMs can be supported. 
-This gem now includes specs that demonstrate how to configure it for use with Mongoid, Mongo Mapper and Data Mapper! 
+This gem now includes specs that demonstrate how to configure it for use with Active Record, Data Mapper, Mongoid, Mongo Mapper 
 Special thanks to Sam (yoda) for the initial inspiration and work to ensure support for Mongoid  :)
 
 The generator has also been updated slightly to support this new strategy option as of version 0.2.1. 

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.2.3

data/cancan-permits.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cancan-permits}
-  s.version = "0.2.2"
+  s.version = "0.2.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
-  s.date = %q{2010-10-13}
+  s.date = %q{2010-10-14}
   s.description = %q{Role specific Permits for use with CanCan permission system}
   s.email = %q{kmandrup@gmail.com}
   s.extra_rdoc_files = [
@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "cancan-permits.gemspec",
+     "development.sqlite3",
      "lib/cancan-permits.rb",
      "lib/cancan-permits/main.rb",
      "lib/cancan-permits/namespaces.rb",
@@ -41,17 +42,26 @@ Gem::Specification.new do |s|
      "lib/generators/permits/permits_generator.rb",
      "lib/generators/permits/templates/licenses.rb",
      "lib/generators/permits/templates/permit.rb",
-     "spec/cancan-permits/fixtures/permits/admin_permit.rb",
-     "spec/cancan-permits/fixtures/permits/editor_permit.rb",
-     "spec/cancan-permits/fixtures/permits/guest_permit.rb",
-     "spec/cancan-permits/permits/fixtures/models.rb",
-     "spec/cancan-permits/permits/owner_permits_spec.rb",
-     "spec/cancan-permits/permits/permits_spec.rb",
+     "spec/active_record/db/database.yml",
+     "spec/active_record/migrations/001_create_user.rb",
+     "spec/active_record/migrations/002_create_comment.rb",
+     "spec/active_record/migrations/003_create_post.rb",
+     "spec/active_record/migrations/004_create_article.rb",
+     "spec/active_record/models/all_models.rb",
+     "spec/active_record/owner_permits_spec.rb",
+     "spec/active_record/permits_spec.rb",
+     "spec/active_record/spec_helper.rb",
      "spec/data_mapper/models/all_models.rb",
      "spec/data_mapper/owner_permits_spec.rb",
      "spec/data_mapper/permits_spec.rb",
      "spec/data_mapper/spec_helper.rb",
      "spec/generators/permit_generator_spec.rb",
+     "spec/generic/fixtures/permits/admin_permit.rb",
+     "spec/generic/fixtures/permits/editor_permit.rb",
+     "spec/generic/fixtures/permits/guest_permit.rb",
+     "spec/generic/permits/fixtures/models.rb",
+     "spec/generic/permits/owner_permits_spec.rb",
+     "spec/generic/permits/permits_spec.rb",
      "spec/mongo_mapper/models/all_models.rb",
      "spec/mongo_mapper/owner_permits_spec.rb",
      "spec/mongo_mapper/permits_spec.rb",
@@ -68,17 +78,25 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Permits for use with CanCan}
   s.test_files = [
-    "spec/cancan-permits/fixtures/permits/admin_permit.rb",
-     "spec/cancan-permits/fixtures/permits/editor_permit.rb",
-     "spec/cancan-permits/fixtures/permits/guest_permit.rb",
-     "spec/cancan-permits/permits/fixtures/models.rb",
-     "spec/cancan-permits/permits/owner_permits_spec.rb",
-     "spec/cancan-permits/permits/permits_spec.rb",
+    "spec/active_record/migrations/001_create_user.rb",
+     "spec/active_record/migrations/002_create_comment.rb",
+     "spec/active_record/migrations/003_create_post.rb",
+     "spec/active_record/migrations/004_create_article.rb",
+     "spec/active_record/models/all_models.rb",
+     "spec/active_record/owner_permits_spec.rb",
+     "spec/active_record/permits_spec.rb",
+     "spec/active_record/spec_helper.rb",
      "spec/data_mapper/models/all_models.rb",
      "spec/data_mapper/owner_permits_spec.rb",
      "spec/data_mapper/permits_spec.rb",
      "spec/data_mapper/spec_helper.rb",
      "spec/generators/permit_generator_spec.rb",
+     "spec/generic/fixtures/permits/admin_permit.rb",
+     "spec/generic/fixtures/permits/editor_permit.rb",
+     "spec/generic/fixtures/permits/guest_permit.rb",
+     "spec/generic/permits/fixtures/models.rb",
+     "spec/generic/permits/owner_permits_spec.rb",
+     "spec/generic/permits/permits_spec.rb",
      "spec/mongo_mapper/models/all_models.rb",
      "spec/mongo_mapper/owner_permits_spec.rb",
      "spec/mongo_mapper/permits_spec.rb",

data/lib/cancan-permits/permit/base_permit.rb

@@ -43,10 +43,9 @@ module Permit
       # puts "Using strategy: #{strategy_used}"
       begin
         case strategy_used
-        when :orm   
+        when :string
           can :manage, clazz, ownership_relation => user_id.to_s
-        when :default      
-          # puts "Basic CanCan ownership"
+        when :default
           can :manage, clazz, ownership_relation => user_id
         else
           raise "Trying to use unknown ownership strategy: #{strategy}"

data/spec/active_record/db/database.yml

@@ -0,0 +1,4 @@
+adapter: sqlite3
+database: development.sqlite3
+pool: 5
+timeout: 5000

data/spec/active_record/migrations/001_create_user.rb

@@ -0,0 +1,13 @@
+class CreateUser < ActiveRecord::Migration
+  def self.up
+    create_table :users do |t|
+      t.string  :name
+      t.string  :role      
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :users
+  end
+end

data/spec/active_record/migrations/002_create_comment.rb

@@ -0,0 +1,13 @@
+class CreateComment < ActiveRecord::Migration
+  def self.up
+    create_table :comments do |t|
+      t.integer   :user_id
+      t.string    :body      
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :comments
+  end
+end

data/spec/active_record/migrations/003_create_post.rb

@@ -0,0 +1,13 @@
+class CreatePost < ActiveRecord::Migration
+  def self.up
+    create_table :posts do |t|
+      t.integer   :writer
+      t.string    :body      
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :posts
+  end
+end

data/spec/active_record/migrations/004_create_article.rb

@@ -0,0 +1,13 @@
+class CreateArticle < ActiveRecord::Migration
+  def self.up
+    create_table :articles do |t|
+      t.integer   :author
+      t.string    :body      
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :comments
+  end
+end

data/spec/active_record/models/all_models.rb

@@ -0,0 +1,11 @@
+class Comment < ActiveRecord::Base
+  belongs_to :user
+end
+
+class Post < ActiveRecord::Base
+  belongs_to :user
+end
+
+class Article < ActiveRecord::Base
+  belongs_to :user
+end

data/spec/active_record/owner_permits_spec.rb

@@ -0,0 +1,73 @@
+require 'active_record/spec_helper'
+
+describe Permits::Ability do
+  context "Editor user" do
+    context "using default :user_id relation - foreign key to User.id" do   
+      before :each do                  
+        @editor         = User.create(:name => "Kristian", :role => "editor")
+        @other_guy      = User.create(:name => "Random dude", :role => "admin")
+
+        @ability        = Permits::Ability.new(@editor)
+
+        @own_comment    = Comment.create(:user_id => @editor.id)
+        @other_comment  = Comment.create(:user_id => @other_guy.id)      
+        # @post     = Post.create(:writer => @editor.id)
+        # @article  = Article.create(:author => @editor.id)
+      end      
+      
+      it "should be able to :read Comment he owns" do
+        @ability.should be_able_to(:read, Comment)
+        @ability.should be_able_to(:read, @own_comment)      
+      end
+
+      it "should be able to :update Comment he owns" do
+        @ability.should be_able_to(:update, @own_comment)      
+      end
+      
+      it "should NOT be able to :update Comment he does NOT own" do
+        @ability.should_not be_able_to(:update, @other_comment)      
+      end
+      
+      it "should be able to :delete Comment he owns" do
+        @ability.should be_able_to(:delete, @own_comment)      
+      end
+      
+      it "should NOT be able to :update Comment he does NOT own" do
+        @ability.should_not be_able_to(:delete, @other_comment)      
+      end
+    end 
+    
+    context "using custom :writer relation - foreign key to User.id" do   
+      before :each do                  
+        @editor         = User.create(:name => "Kristian", :role => "editor")
+        @other_guy      = User.create(:name => "Random dude", :role => "admin")
+    
+        @ability        = Permits::Ability.new(@editor)
+    
+        @own_post       = Post.create(:writer => @editor.id)
+        @other_post     = Post.create(:writer => @other_guy.id)      
+      end      
+      
+      it "should be able to :read Post he owns" do
+        @ability.should be_able_to(:read, Post)
+        @ability.should be_able_to(:read, @own_post)      
+      end
+    
+      it "should be able to :update Post he owns" do
+        @ability.should be_able_to(:update, @own_post)      
+      end
+    
+      it "should NOT be able to :update Post he does NOT own" do
+        @ability.should_not be_able_to(:update, @other_post)      
+      end
+      
+      it "should be able to :delete Post he owns" do
+        @ability.should be_able_to(:delete, @own_post)      
+      end
+      
+      it "should NOT be able to :update Post he does NOT own" do
+        @ability.should_not be_able_to(:delete, @other_post)      
+      end
+    end    
+  end        
+end

data/spec/active_record/permits_spec.rb

@@ -0,0 +1,36 @@
+require 'active_record/spec_helper'
+
+describe Permits::Ability do
+  context "Guest user" do
+    before :each do
+      @guest    = User.create(:name => "Kristian", :role => "guest")
+
+      @ability  = Permits::Ability.new(@guest)
+
+      @comment  = Comment.create(:user_id => @guest.id)
+
+      @post     = Post.create(:writer => @guest.id)
+
+      @article  = Article.create(:author => @guest.id)
+    end
+
+    it "should be able to :read Comment and Post but NOT Article" do
+      @ability.can?(:read, Comment).should be_true
+      @ability.can?(:read, @comment).should be_true
+      
+      @ability.can?(:read, Post).should be_true      
+      @ability.can?(:read, @post).should be_true      
+      
+      @ability.can?(:read, Article).should be_false
+      @ability.can?(:read, @article).should be_false      
+    end
+    
+    it "should be not able to :update only Comment" do
+      @ability.can?(:update, Comment).should be_true
+      @ability.can?(:update, @comment).should be_true      
+      
+      @ability.can?(:update, Post).should be_false
+      @ability.can?(:update, @post).should be_false
+    end
+  end
+end

data/spec/active_record/spec_helper.rb

@@ -0,0 +1,94 @@
+require 'rspec/core'
+
+require 'rails'
+require 'active_record'
+require 'arel'
+require 'meta_where'
+require 'yaml'
+require 'logger'
+require 'database_cleaner'
+
+require 'cancan/matchers'
+require 'cancan-permits'
+require 'cancan-permits/rspec'
+
+module Rails
+  def self.config_root_dir
+    File.dirname(__FILE__)
+  end
+end
+
+path = File.dirname(__FILE__) + '/db/database.yml'
+dbfile = File.open(path)
+dbconfig = YAML::load(dbfile)  
+ActiveRecord::Base.establish_connection(dbconfig)
+ActiveRecord::Base.logger = Logger.new(STDERR)
+
+DatabaseCleaner.strategy = :truncation
+
+# $ rake VERSION=0
+
+def migration_folder(name)
+  path = File.dirname(__FILE__) + "/migrations"
+  name ? File.join(path name) : path
+end
+
+ORM_NAME = 'Active Record'
+
+def migrate(name = nil)                
+  mig_folder = migration_folder(name)
+  puts "Migrating folder: #{mig_folder}"
+  ActiveRecord::Migrator.migrate mig_folder
+end
+
+RSpec.configure do |config| 
+  config.mock_with :mocha
+    
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with(:truncation)
+    # DatabaseCleaner.clean 
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+    migrate
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end  
+end
+
+require_all File.dirname(__FILE__) + '/../generic/fixtures/permits'
+require_all File.dirname(__FILE__) + '/models/all_models'
+
+module Permits::Roles
+  def self.available
+    User.roles
+  end
+end
+
+class User < ActiveRecord::Base  
+  has_many :articles
+  has_many :comments
+  has_many :posts
+
+  def self.roles
+    [:guest, :admin, :editor]
+  end    
+  
+  def has_role? role
+    self.role.to_sym == role.to_sym
+  end
+end
+
+
+
+
+
+
+
+
+
+

data/spec/data_mapper/owner_permits_spec.rb

@@ -7,7 +7,7 @@ describe Permits::Ability do
         @editor         = User.create(:name => "Kristian", :role => "editor")
         @other_guy      = User.create(:name => "Random dude", :role => "admin")
 
-        @ability        = Permits::Ability.new(@editor, :strategy => :orm)
+        @ability        = Permits::Ability.new(@editor, :strategy => :string)
 
         @own_comment    = Comment.create(:user_id => @editor.id)
         @other_comment  = Comment.create(:user_id => @other_guy.id)      
@@ -42,7 +42,7 @@ describe Permits::Ability do
         @editor         = User.create(:name => "Kristian", :role => "editor")
         @other_guy      = User.create(:name => "Random dude", :role => "admin")
     
-        @ability        = Permits::Ability.new(@editor, :strategy => :orm)
+        @ability        = Permits::Ability.new(@editor, :strategy => :string)
     
         @own_post       = Post.create(:writer => @editor.id)
         @other_post     = Post.create(:writer => @other_guy.id)      

data/spec/data_mapper/permits_spec.rb

@@ -5,7 +5,7 @@ describe Permits::Ability do
     before :each do
       @guest    = User.create(:name => "Kristian", :role => "guest")
 
-      @ability  = Permits::Ability.new(@guest, :strategy => :orm)
+      @ability  = Permits::Ability.new(@guest, :strategy => :string)
 
       @comment  = Comment.create(:user_id => @guest.id)
 

data/spec/data_mapper/spec_helper.rb

@@ -20,7 +20,7 @@ RSpec.configure do |config|
 end
 
 
-require_all File.dirname(__FILE__) + '/../cancan-permits/fixtures/permits'
+require_all File.dirname(__FILE__) + '/../generic/fixtures/permits'
 require_all File.dirname(__FILE__) + '/models/all_models'
 
 RSpec.configure do |config|

data/spec/mongo_mapper/owner_permits_spec.rb

@@ -7,7 +7,7 @@ describe Permits::Ability do
         @editor         = User.create(:name => "Kristian", :role => "editor")
         @other_guy      = User.create(:name => "Random dude", :role => "admin")
 
-        @ability        = Permits::Ability.new(@editor, :strategy => :orm)
+        @ability        = Permits::Ability.new(@editor, :strategy => :string)
 
         @own_comment    = Comment.create(:user_id => @editor.id)
         @other_comment  = Comment.create(:user_id => @other_guy.id)      
@@ -42,7 +42,7 @@ describe Permits::Ability do
         @editor         = User.create(:name => "Kristian", :role => "editor")
         @other_guy      = User.create(:name => "Random dude", :role => "admin")
     
-        @ability        = Permits::Ability.new(@editor, :strategy => :mongo)
+        @ability        = Permits::Ability.new(@editor, :strategy => :string)
     
         @own_post       = Post.create(:writer => @editor.id)
         @other_post     = Post.create(:writer => @other_guy.id)      

data/spec/mongo_mapper/permits_spec.rb

@@ -5,7 +5,7 @@ describe Permits::Ability do
     before :each do
       @guest    = User.create(:name => "Kristian", :role => "guest")
 
-      @ability  = Permits::Ability.new(@guest, :strategy => :orm)
+      @ability  = Permits::Ability.new(@guest, :strategy => :string)
 
       @comment  = Comment.create(:user_id => @guest.id)
 

data/spec/mongo_mapper/spec_helper.rb

@@ -4,7 +4,7 @@ require 'cancan/matchers'
 require 'cancan-permits'
 require 'cancan-permits/rspec'
 
-require_all File.dirname(__FILE__) + '/../cancan-permits/fixtures/permits'
+require_all File.dirname(__FILE__) + '/../generic/fixtures/permits'
 require_all File.dirname(__FILE__) + '/models/all_models'
 
 RSpec.configure do |config|

data/spec/mongoid/owner_permits_spec.rb

@@ -7,7 +7,7 @@ describe Permits::Ability do
         @editor         = User.create(:name => "Kristian", :role => "editor")
         @other_guy      = User.create(:name => "Random dude", :role => "admin")
 
-        @ability        = Permits::Ability.new(@editor, :strategy => :orm)
+        @ability        = Permits::Ability.new(@editor, :strategy => :string)
 
         @own_comment    = Comment.create(:user_id => @editor.id)
         @other_comment  = Comment.create(:user_id => @other_guy.id)      
@@ -42,7 +42,7 @@ describe Permits::Ability do
         @editor         = User.create(:name => "Kristian", :role => "editor")
         @other_guy      = User.create(:name => "Random dude", :role => "admin")
 
-        @ability        = Permits::Ability.new(@editor, :strategy => :mongo)
+        @ability        = Permits::Ability.new(@editor, :strategy => :string)
 
         @own_post       = Post.create(:writer => @editor.id)
         @other_post     = Post.create(:writer => @other_guy.id)      

data/spec/mongoid/permits_spec.rb

@@ -5,7 +5,7 @@ describe Permits::Ability do
     before :each do
       @guest   = User.create(:name => "Kristian", :role => "guest")
 
-      @ability  = Permits::Ability.new(@guest, :strategy => :orm)
+      @ability  = Permits::Ability.new(@guest, :strategy => :string)
 
       @comment  = Comment.create(:user_id => @guest.id)
 
@@ -37,7 +37,7 @@ describe Permits::Ability do
   context "Admin user" do
     before do
       @admin = User.create(:role => 'admin')
-      @ability = Permits::Ability.new(@admin)
+      @ability = Permits::Ability.new(@admin, :strategy => :string)
     end
 
     it "should be able to :read anything" do

data/spec/mongoid/spec_helper.rb

@@ -4,7 +4,7 @@ require 'cancan/matchers'
 require 'cancan-permits'
 require 'cancan-permits/rspec'
 
-require_all File.dirname(__FILE__) + '/../cancan-permits/fixtures/permits'
+require_all File.dirname(__FILE__) + '/../generic/fixtures/permits'
 require_all File.dirname(__FILE__) + '/models/all_models'
 
 RSpec.configure do |config|

data/spec/spec_helper.rb

@@ -3,9 +3,9 @@ require 'cancan/matchers'
 require 'cancan-permits'
 require 'cancan-permits/rspec'
 
-require_all File.dirname(__FILE__) + '/cancan-permits/fixtures/permits'
+require_all File.dirname(__FILE__) + '/generic/fixtures/permits'
 
-require_all File.dirname(__FILE__) + '/cancan-permits/permits/fixtures'
+require_all File.dirname(__FILE__) + '/generic/permits/fixtures'
 
 RSpec.configure do |config|
   config.mock_with :mocha

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 2
-  version: 0.2.2
+  - 3
+  version: 0.2.3
 platform: ruby
 authors: 
 - Kristian Mandrup
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-13 00:00:00 +02:00
+date: 2010-10-14 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -127,6 +127,7 @@ files:
 - Rakefile
 - VERSION
 - cancan-permits.gemspec
+- development.sqlite3
 - lib/cancan-permits.rb
 - lib/cancan-permits/main.rb
 - lib/cancan-permits/namespaces.rb
@@ -143,17 +144,26 @@ files:
 - lib/generators/permits/permits_generator.rb
 - lib/generators/permits/templates/licenses.rb
 - lib/generators/permits/templates/permit.rb
-- spec/cancan-permits/fixtures/permits/admin_permit.rb
-- spec/cancan-permits/fixtures/permits/editor_permit.rb
-- spec/cancan-permits/fixtures/permits/guest_permit.rb
-- spec/cancan-permits/permits/fixtures/models.rb
-- spec/cancan-permits/permits/owner_permits_spec.rb
-- spec/cancan-permits/permits/permits_spec.rb
+- spec/active_record/db/database.yml
+- spec/active_record/migrations/001_create_user.rb
+- spec/active_record/migrations/002_create_comment.rb
+- spec/active_record/migrations/003_create_post.rb
+- spec/active_record/migrations/004_create_article.rb
+- spec/active_record/models/all_models.rb
+- spec/active_record/owner_permits_spec.rb
+- spec/active_record/permits_spec.rb
+- spec/active_record/spec_helper.rb
 - spec/data_mapper/models/all_models.rb
 - spec/data_mapper/owner_permits_spec.rb
 - spec/data_mapper/permits_spec.rb
 - spec/data_mapper/spec_helper.rb
 - spec/generators/permit_generator_spec.rb
+- spec/generic/fixtures/permits/admin_permit.rb
+- spec/generic/fixtures/permits/editor_permit.rb
+- spec/generic/fixtures/permits/guest_permit.rb
+- spec/generic/permits/fixtures/models.rb
+- spec/generic/permits/owner_permits_spec.rb
+- spec/generic/permits/permits_spec.rb
 - spec/mongo_mapper/models/all_models.rb
 - spec/mongo_mapper/owner_permits_spec.rb
 - spec/mongo_mapper/permits_spec.rb
@@ -196,17 +206,25 @@ signing_key:
 specification_version: 3
 summary: Permits for use with CanCan
 test_files: 
-- spec/cancan-permits/fixtures/permits/admin_permit.rb
-- spec/cancan-permits/fixtures/permits/editor_permit.rb
-- spec/cancan-permits/fixtures/permits/guest_permit.rb
-- spec/cancan-permits/permits/fixtures/models.rb
-- spec/cancan-permits/permits/owner_permits_spec.rb
-- spec/cancan-permits/permits/permits_spec.rb
+- spec/active_record/migrations/001_create_user.rb
+- spec/active_record/migrations/002_create_comment.rb
+- spec/active_record/migrations/003_create_post.rb
+- spec/active_record/migrations/004_create_article.rb
+- spec/active_record/models/all_models.rb
+- spec/active_record/owner_permits_spec.rb
+- spec/active_record/permits_spec.rb
+- spec/active_record/spec_helper.rb
 - spec/data_mapper/models/all_models.rb
 - spec/data_mapper/owner_permits_spec.rb
 - spec/data_mapper/permits_spec.rb
 - spec/data_mapper/spec_helper.rb
 - spec/generators/permit_generator_spec.rb
+- spec/generic/fixtures/permits/admin_permit.rb
+- spec/generic/fixtures/permits/editor_permit.rb
+- spec/generic/fixtures/permits/guest_permit.rb
+- spec/generic/permits/fixtures/models.rb
+- spec/generic/permits/owner_permits_spec.rb
+- spec/generic/permits/permits_spec.rb
 - spec/mongo_mapper/models/all_models.rb
 - spec/mongo_mapper/owner_permits_spec.rb
 - spec/mongo_mapper/permits_spec.rb