pundit 0.1.0 → 0.2.0

data/README.md

@@ -1,5 +1,7 @@
 # Pundit
 
+[![Build Status](https://secure.travis-ci.org/elabs/pundit.png?branch=master)](https://travis-ci.org/elabs/pundit)
+
 Pundit provides a set of helpers which guide you in leveraging regular Ruby
 classes and object oriented design patterns to build a simple, robust and
 scaleable authorization system.
@@ -193,6 +195,19 @@ You can, and are encouraged to, use this method in views:
 <% end %>
 ```
 
+## Manually specifying policy classes
+
+Sometimes you might want to explicitly declare which policy to use for a given
+class, instead of letting Pundit infer it. This can be done like so:
+
+``` ruby
+class Post
+  def self.policy_class
+    PostablePolicyClass
+  end
+end
+```
+
 ## Just plain old Ruby
 
 As you can see, Pundit doesn't do anything you couldn't have easily done
@@ -230,7 +245,7 @@ got through. This way you can fail more gracefully.
 ``` ruby
 class ApplicationPolicy
   def initialize(user, record)
-    raise Pundit::NotAuthorized, "must be logged in" unless user
+    raise Pundit::NotAuthorizedError, "must be logged in" unless user
     @user = user
     @record = record
   end

data/lib/pundit/policy_finder.rb

@@ -6,44 +6,47 @@ module Pundit
       @object = object
     end
 
-    def name
-      if object.respond_to?(:model_name)
-        object.model_name.to_s
-      elsif object.class.respond_to?(:model_name)
-        object.class.model_name.to_s
-      elsif object.is_a?(Class)
-        object.to_s
-      else
-        object.class.to_s
-      end
-    end
-
     def scope
-      scope_name.constantize
+      policy::Scope if policy
     rescue NameError
       nil
     end
 
     def policy
-      policy_name.constantize
+      klass = find
+      klass = klass.constantize if klass.is_a?(String)
+      klass
     rescue NameError
       nil
     end
 
     def scope!
-      scope or raise NotDefinedError, "unable to find scope #{scope_name} for #{object}"
+      scope or raise NotDefinedError, "unable to find scope #{find}::Scope for #{object}"
     end
 
     def policy!
-      policy or raise NotDefinedError, "unable to find policy #{policy_name} for #{object}"
+      policy or raise NotDefinedError, "unable to find policy #{find} for #{object}"
     end
 
-    def scope_name
-      "#{name}Policy::Scope"
-    end
+  private
 
-    def policy_name
-      "#{name}Policy"
+    def find
+      if object.respond_to?(:policy_class)
+        object.policy_class
+      elsif object.class.respond_to?(:policy_class)
+        object.class.policy_class
+      else
+        klass = if object.respond_to?(:model_name)
+          object.model_name
+        elsif object.class.respond_to?(:model_name)
+          object.class.model_name
+        elsif object.is_a?(Class)
+          object
+        else
+          object.class
+        end
+        "#{klass}Policy"
+      end
     end
   end
 end

data/lib/pundit/version.rb

@@ -1,3 +1,3 @@
 module Pundit
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/pundit_spec.rb

@@ -34,12 +34,34 @@ class Comment; extend ActiveModel::Naming; end
 
 class Article; end
 
+class BlogPolicy < Struct.new(:user, :blog); end
+class Blog; end
+class ArtificialBlog < Blog
+  def self.policy_class
+    BlogPolicy
+  end
+end
+class ArticleTag
+  def self.policy_class
+    Struct.new(:user, :tag) do
+      def show?
+        true
+      end
+      def destroy?
+        false
+      end
+    end
+  end
+end
+
 describe Pundit do
   let(:user) { stub }
   let(:post) { Post.new(user) }
   let(:comment) { Comment.new }
   let(:article) { Article.new }
   let(:controller) { stub(:current_user => user, :params => { :action => "update" }).tap { |c| c.extend(Pundit) } }
+  let(:artificial_blog) { ArtificialBlog.new }
+  let(:article_tag) { ArticleTag.new }
 
   describe ".policy_scope" do
     it "returns an instantiated policy scope given a plain model class" do
@@ -67,6 +89,10 @@ describe Pundit do
     it "throws an exception if the given policy scope can't be found" do
       expect { Pundit.policy_scope!(user, Article) }.to raise_error(Pundit::NotDefinedError)
     end
+
+    it "throws an exception if the given policy scope can't be found" do
+      expect { Pundit.policy_scope!(user, ArticleTag) }.to raise_error(Pundit::NotDefinedError)
+    end
   end
 
   describe ".policy" do
@@ -98,6 +124,32 @@ describe Pundit do
       Pundit.policy(user, article).should be_nil
       Pundit.policy(user, Article).should be_nil
     end
+
+    describe "with .policy_class set on the model" do
+      it "returns an instantiated policy given a plain model instance" do
+        policy = Pundit.policy(user, artificial_blog)
+        policy.user.should == user
+        policy.blog.should == artificial_blog
+      end
+
+      it "returns an instantiated policy given a plain model class" do
+        policy = Pundit.policy(user, ArtificialBlog)
+        policy.user.should == user
+        policy.blog.should == ArtificialBlog
+      end
+
+      it "returns an instantiated policy given a plain model instance providing an anonymous class" do
+        policy = Pundit.policy(user, article_tag)
+        policy.user.should == user
+        policy.tag.should == article_tag
+      end
+
+      it "returns an instantiated policy given a plain model class providing an anonymous class" do
+        policy = Pundit.policy(user, ArticleTag)
+        policy.user.should == user
+        policy.tag.should == ArticleTag
+      end
+    end
   end
 
   describe ".policy!" do
@@ -152,6 +204,11 @@ describe Pundit do
       expect { controller.authorize(post, :destroy?) }.to raise_error(Pundit::NotAuthorizedError)
     end
 
+    it "works with anonymous class policies" do
+      controller.authorize(article_tag, :show?).should be_true
+      expect { controller.authorize(article_tag, :destroy?) }.to raise_error(Pundit::NotAuthorizedError)
+    end
+
     it "raises an error when the permission check fails" do
       expect { controller.authorize(Post.new) }.to raise_error(Pundit::NotAuthorizedError)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pundit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,88 +10,88 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-19 00:00:00.000000000 Z
+date: 2013-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
+  prerelease: false
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
+    none: false
   type: :runtime
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
+    none: false
 - !ruby/object:Gem::Dependency
   name: rspec
+  prerelease: false
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.0'
+    none: false
   type: :development
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.0'
+    none: false
 - !ruby/object:Gem::Dependency
   name: pry
+  prerelease: false
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
   type: :development
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
 - !ruby/object:Gem::Dependency
   name: rake
+  prerelease: false
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
   type: :development
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
 - !ruby/object:Gem::Dependency
   name: yard
+  prerelease: false
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
   type: :development
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
 description: Object oriented authorization for Rails applications
 email:
 - jonas.nicklas@gmail.com
@@ -125,17 +125,17 @@ rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+  none: false
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24