cancan-permits 0.2.5 → 0.2.7

data/.gitignore

@@ -18,4 +18,6 @@ coverage
 rdoc
 pkg
 
+*.orig
+
 ## PROJECT::SPECIFIC

data/Changelog.txt

@@ -0,0 +1,12 @@
+## Oct 23, 2010
+
+The API specs are now stored in spec/generic/api. To spec that an ORM implementation of cancan-permits work, simply require the 'xgroup_orm' file from the /basic and /owner
+API folders. See current specs for various ORMs for how to do this. In special cases, override the configuration methods present in fx basic/config.rb and owner/config.rb
+
+## Oct 22, 2010
+
+* Added support for Simply Stored ORM that can be used with Couch DB.
+
+See specs in /simply_stored folder. It took only about 2 minutes to create this support, demonstrating how easy it now is to add support for new ORMs and data stores :) 
+
+

data/README.markdown

@@ -2,18 +2,9 @@
 
 Role specific Permits for use with [CanCan](http://github.com/ryanb/cancan) permission system.
 
-## Update Oct 14
+## Changes
 
-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 Active Record, Data Mapper, Mongoid, Mongo Mapper 
-Special thanks to Sam (yoda) for the initial inspiration and work to ensure support for Mongoid  :)
-
-The built in ownership strategies are :default and :string. The default strategy can be used for generic models and Active Record, where there is no need of 
-type conversion. For some ORMs, like fx Mongoid, there is a need to convert the key (BSON Identifier) to a string for the "comparison" to work, hence the strategy is named :string. 
-
-The Permits generator has also been updated slightly to support this new strategy option as of version 0.2.1. 
-In general, the new Permits API now uses an options hash to replace the previous optional request parameter. 
-This design allows for better extensibility in the future if needed. 
+See Changelog.txt
 
 ## Install
 

data/Rakefile

@@ -9,11 +9,11 @@ begin
     gem.authors = ["Kristian Mandrup"]
     gem.add_development_dependency "rspec",           "~> 2.0.0"
     gem.add_development_dependency 'code-spec',       "~> 0.2.5"
-    gem.add_development_dependency 'rails-app-spec',  "~> 0.2.14"
+    gem.add_development_dependency 'rails-app-spec',  "~> 0.3.0"
 
     gem.add_dependency 'cancan',          "~> 1.4.0"
     gem.add_dependency 'require_all',     "~> 1.2.0"
-    gem.add_dependency 'sugar-high',      "~> 0.2.10"
+    gem.add_dependency 'sugar-high',      "~> 0.3.0"
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-0.2.5
+0.2.7

data/cancan-permits.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cancan-permits}
-  s.version = "0.2.5"
+  s.version = "0.2.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
-  s.date = %q{2010-10-17}
+  s.date = %q{2010-10-23}
   s.description = %q{Role specific Permits for use with CanCan permission system}
   s.email = %q{kmandrup@gmail.com}
   s.extra_rdoc_files = [
@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
     ".document",
      ".gitignore",
      ".rspec",
+     "Changelog.txt",
      "LICENSE",
      "README.markdown",
      "Rakefile",
@@ -27,10 +28,11 @@ Gem::Specification.new do |s|
      "cancan-permits.gemspec",
      "development.sqlite3",
      "lib/cancan-permits.rb",
+     "lib/cancan-permits/license/base_license.rb",
      "lib/cancan-permits/main.rb",
      "lib/cancan-permits/namespaces.rb",
-     "lib/cancan-permits/permit/base_license.rb",
      "lib/cancan-permits/permit/base_permit.rb",
+     "lib/cancan-permits/permit/util.rb",
      "lib/cancan-permits/permits/ability.rb",
      "lib/cancan-permits/permits/configuration.rb",
      "lib/cancan-permits/permits/roles.rb",
@@ -56,9 +58,18 @@ Gem::Specification.new do |s|
      "spec/data_mapper/permits_spec.rb",
      "spec/data_mapper/spec_helper.rb",
      "spec/fixtures/permits/admin_permit.rb",
+     "spec/fixtures/permits/any_permit.rb",
      "spec/fixtures/permits/editor_permit.rb",
      "spec/fixtures/permits/guest_permit.rb",
+     "spec/fixtures/permits/super_admin_permit.rb",
+     "spec/fixtures/permits/system_permit.rb",
      "spec/generators/permit_generator_spec.rb",
+     "spec/generic/api/basic/config.rb",
+     "spec/generic/api/basic/xgroup.rb",
+     "spec/generic/api/basic/xgroup_orm.rb",
+     "spec/generic/api/owner/config.rb",
+     "spec/generic/api/owner/xgroup.rb",
+     "spec/generic/api/owner/xgroup_orm.rb",
      "spec/generic/models/all_models.rb",
      "spec/generic/owner_permits_spec.rb",
      "spec/generic/permits_spec.rb",
@@ -71,6 +82,11 @@ Gem::Specification.new do |s|
      "spec/mongoid/owner_permits_spec.rb",
      "spec/mongoid/permits_spec.rb",
      "spec/mongoid/spec_helper.rb",
+     "spec/simply_stored/CouchDB.txt",
+     "spec/simply_stored/models/all_models.rb",
+     "spec/simply_stored/owner_permits_spec.rb",
+     "spec/simply_stored/permits_spec.rb",
+     "spec/simply_stored/spec_helper.rb",
      "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/kristianmandrup/cancan-permits}
@@ -92,9 +108,18 @@ Gem::Specification.new do |s|
      "spec/data_mapper/permits_spec.rb",
      "spec/data_mapper/spec_helper.rb",
      "spec/fixtures/permits/admin_permit.rb",
+     "spec/fixtures/permits/any_permit.rb",
      "spec/fixtures/permits/editor_permit.rb",
      "spec/fixtures/permits/guest_permit.rb",
+     "spec/fixtures/permits/super_admin_permit.rb",
+     "spec/fixtures/permits/system_permit.rb",
      "spec/generators/permit_generator_spec.rb",
+     "spec/generic/api/basic/config.rb",
+     "spec/generic/api/basic/xgroup.rb",
+     "spec/generic/api/basic/xgroup_orm.rb",
+     "spec/generic/api/owner/config.rb",
+     "spec/generic/api/owner/xgroup.rb",
+     "spec/generic/api/owner/xgroup_orm.rb",
      "spec/generic/models/all_models.rb",
      "spec/generic/owner_permits_spec.rb",
      "spec/generic/permits_spec.rb",
@@ -107,6 +132,10 @@ Gem::Specification.new do |s|
      "spec/mongoid/owner_permits_spec.rb",
      "spec/mongoid/permits_spec.rb",
      "spec/mongoid/spec_helper.rb",
+     "spec/simply_stored/models/all_models.rb",
+     "spec/simply_stored/owner_permits_spec.rb",
+     "spec/simply_stored/permits_spec.rb",
+     "spec/simply_stored/spec_helper.rb",
      "spec/spec_helper.rb"
   ]
 
@@ -117,25 +146,25 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<rspec>, ["~> 2.0.0"])
       s.add_development_dependency(%q<code-spec>, ["~> 0.2.5"])
-      s.add_development_dependency(%q<rails-app-spec>, ["~> 0.2.14"])
+      s.add_development_dependency(%q<rails-app-spec>, ["~> 0.3.0"])
       s.add_runtime_dependency(%q<cancan>, ["~> 1.4.0"])
       s.add_runtime_dependency(%q<require_all>, ["~> 1.2.0"])
-      s.add_runtime_dependency(%q<sugar-high>, ["~> 0.2.10"])
+      s.add_runtime_dependency(%q<sugar-high>, ["~> 0.3.0"])
     else
       s.add_dependency(%q<rspec>, ["~> 2.0.0"])
       s.add_dependency(%q<code-spec>, ["~> 0.2.5"])
-      s.add_dependency(%q<rails-app-spec>, ["~> 0.2.14"])
+      s.add_dependency(%q<rails-app-spec>, ["~> 0.3.0"])
       s.add_dependency(%q<cancan>, ["~> 1.4.0"])
       s.add_dependency(%q<require_all>, ["~> 1.2.0"])
-      s.add_dependency(%q<sugar-high>, ["~> 0.2.10"])
+      s.add_dependency(%q<sugar-high>, ["~> 0.3.0"])
     end
   else
     s.add_dependency(%q<rspec>, ["~> 2.0.0"])
     s.add_dependency(%q<code-spec>, ["~> 0.2.5"])
-    s.add_dependency(%q<rails-app-spec>, ["~> 0.2.14"])
+    s.add_dependency(%q<rails-app-spec>, ["~> 0.3.0"])
     s.add_dependency(%q<cancan>, ["~> 1.4.0"])
     s.add_dependency(%q<require_all>, ["~> 1.2.0"])
-    s.add_dependency(%q<sugar-high>, ["~> 0.2.10"])
+    s.add_dependency(%q<sugar-high>, ["~> 0.3.0"])
   end
 end
 

data/lib/cancan-permits/main.rb

@@ -1,3 +1,4 @@
 require 'cancan-permits/namespaces'
 require_all File.dirname(__FILE__) + '/permit'
-require_all File.dirname(__FILE__) + '/permits'
+require_all File.dirname(__FILE__) + '/permits'
+require_all File.dirname(__FILE__) + '/license'

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

@@ -1,3 +1,5 @@
+require 'cancan-permits/permit/util'
+
 module Permit
   class Base 
     attr_reader :ability
@@ -55,14 +57,16 @@ module Permit
       end
     end 
 
-    protected
+    protected  
+    
+    include Permit::Util
 
     def localhost_manager?
       Permits::Configuration.localhost_manager
     end
 
     def role_match? user
-      user.has_role? self.class.last_name.gsub(/Permit$/, '').downcase.to_sym
+      user.has_role? permit_name(self.class)
     end
       
     def can_definitions

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

@@ -0,0 +1,7 @@
+module Permit               
+  module Util
+    def permit_name clazz
+      clazz.demodulize.gsub(/Permit$/, '').underscore.to_sym      
+    end
+  end
+end

data/lib/cancan-permits/permits/ability.rb

@@ -1,3 +1,5 @@
+require 'cancan-permits/permit/util'
+
 module Permits
   class Ability
     include CanCan::Ability
@@ -30,11 +32,11 @@ module Permits
 
     def initialize user, options = {}
       # put ability logic here!
-      user ||= Guest.new
+      user ||= Guest.create
       all_permits = Permits::Ability.permits(self, options)
       all_permits.each do |permit|
         # get role name of permit 
-        permit_role = permit.class.demodulize.gsub(/Permit$/, '').underscore.to_sym
+        permit_role = permit_name(permit.class)
         if permit_role == :system
           # always execute system permit
           result = permit.permit?(user, options)
@@ -49,6 +51,8 @@ module Permits
     end      
     
     protected
+
+    include Permit::Util
     
     def self.make_permit role, ability, options = {}
       begin            

data/spec/active_record/owner_permits_spec.rb

@@ -1,75 +1,3 @@
 require 'active_record/spec_helper'
+require 'generic/api/owner/xgroup_orm'
 
-Permits::Ability.orm = :active_record
-
-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

@@ -1,38 +1,2 @@
 require 'active_record/spec_helper'
-
-Permits::Ability.orm = :active_record
-
-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
+require 'generic/api/basic/xgroup_orm'

data/spec/active_record/spec_helper.rb

@@ -14,6 +14,8 @@ module Rails
   end
 end
 
+Permits::Ability.orm = :active_record
+
 path = File.dirname(__FILE__) + '/db/database.yml'
 dbfile = File.open(path)
 dbconfig = YAML::load(dbfile)  

data/spec/data_mapper/owner_permits_spec.rb

@@ -1,75 +1,2 @@
 require 'data_mapper/spec_helper'
-
-Permits::Ability.orm = :data_mapper
-
-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, :strategy => :string)
-    
-        @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
+require 'generic/api/owner/xgroup_orm'