pundit_extra 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 258e0ba6e9d58cf4d45228e19508f7ce450a3953
+  data.tar.gz: b894cb1c27571894af39a308e171fc3bfafdc99f
+SHA512:
+  metadata.gz: 2a0a718d91254cc1bc64908f4b0e746cdefbdaf5e336ee01eb4d1cb2e709420b6bd822466ad73419596820c089a79bc5071026e9be6ea6645a2871da28cb48d8
+  data.tar.gz: 359f33ab68954463098ec4688053ad77b3868e3cec02e8ef6581339a264e3fa0175c7c031d8220a57c90efca55a6f6dbc56de87467e8d972dc66f0b77878303b

data/README.md

@@ -0,0 +1,100 @@
+# PunditExtra
+
+This library borrows functionality from [CanCan(Can)][2] and adds it to [Pundit][1].
+
+- `can?` and `cannot?` view helpers
+- `load_resource`, `authorize_resource`, `load_and_authorize_resource` and 
+  `skip_authorization` controller filters
+
+
+## Install
+
+Add to your Gemfile:
+
+```
+gem 'pundit_extra'
+```
+
+Add to your `ApplicationController`:
+
+```ruby
+class ApplicationController < ActionController::Base
+  include Pundit
+  include PunditExtra
+end
+```
+
+
+## View Helpers:  `can?` and `cannot?` 
+
+You can use the convenience methods `can?` and `cannot?` in any convreoller 
+and view.
+
+`if can? :assign, @task` is the same as Pundit's `policy(@task).assign?`
+`if can? :index, Task` is the same as Pundit's `policy(Task).index?`
+`if cannot? :assign, @task` is the opposite of `can?`
+
+
+## Autoload and Authorize Resource
+
+You can add these to your controllers to automatically load the resource 
+and/or authorize it. 
+
+```ruby
+class TasksController < ApplicationController
+  before_action :authenticate_user!
+  load_resource except: [:index, :create]
+  authorize_resource except: [:create]
+end
+```
+
+The `load_resource` filter will create the appropriate instance variable 
+based onm the current action.
+
+The `authorize_resource` filter will call Pundit's `authorize @model` in each
+action.
+
+You can use `except: :action`, or `only: :action` to limit the filter to a 
+given action or an array of actions.
+
+Example:
+
+```ruby
+class TasksController < ApplicationController
+  before_action :authenticate_user!
+  load_resource except: [:index, :edit]
+  authorize_resource except: :index
+
+  def show
+    # this happens automatically
+    # @task = Task.find params[:id]
+    # authorize @task
+  end
+
+  def new
+    # this happens automatically
+    # @task = Task.new
+    # authorize @task
+  end
+
+  def create
+  	# this happens automatically
+    # @task = Task.new task_params
+    # authorize @task
+  end
+
+end
+```
+
+## Credits
+
+- [Jonas Nicklas](https://github.com/jnicklas) @ [Pundit][1]
+- [Bryan Rite](https://github.com/bryanrite), [Ryan Bates](https://github.com/ryanb), [Richard Wilson](https://github.com/Senjai) @ [CanCanCan][2]
+- [Tom Morgan](https://github.com/seven1m)
+
+Thanks for building awesome stuff.
+
+---
+
+[1]: https://github.com/elabs/pundit
+[2]: https://github.com/CanCanCommunity/cancancan

data/lib/pundit_extra.rb

@@ -0,0 +1,3 @@
+require "pundit_extra/controller_mixin"
+require "pundit_extra/helpers"
+require "pundit_extra/resource_autoload"

data/lib/pundit_extra/controller_mixin.rb

@@ -0,0 +1,13 @@
+require 'pundit_extra/helpers'
+require 'pundit_extra/resource_autoload'
+
+module PunditExtra
+  def self.included(base)
+    if defined? ActionController::Base
+      ActionController::Base.class_eval do
+        include PunditExtra::Helpers
+        include PunditExtra::ResourceAutoload
+      end
+    end
+  end
+end

data/lib/pundit_extra/helpers.rb

@@ -0,0 +1,15 @@
+module PunditExtra
+  module Helpers
+    def self.included(base)
+      base.helper_method :can?, :cannot? if base.respond_to? :helper_method
+    end
+
+    def can?(action, resource)
+      policy(resource).send "#{action}?"
+    end
+
+    def cannot?(*args)
+      !can? *args
+    end
+  end
+end

data/lib/pundit_extra/resource_autoload.rb

@@ -0,0 +1,71 @@
+require 'active_support/concern'
+
+module PunditExtra
+  module ResourceAutoload
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def load_resource(options={})
+        before_filter :load_resource, options.dup
+      end
+
+      def authorize_resource(options={})
+        before_filter :authorize_resource, options.dup
+      end
+
+      def skip_authorization(options={})
+        before_filter :skip_authorization_and_scope, options.dup
+      end
+
+      def load_and_authorize_resource(options={})
+        load_resource options
+        authorize_resource options
+      end    
+    end
+
+    def load_resource
+      scope = resource_class
+      action = params[:action]
+      varname = resource_name
+      if action == 'index'
+        varname = controller_name
+        resource = policy_scope resource_class
+      elsif ['new', 'create'].include? action
+        resource = scope.new
+        resource.attributes = send("#{resource_name}_params") if action == 'create'
+      elsif params[:id]
+        resource = scope.find params[:id]
+      else
+        resource = nil
+      end
+      instance_variable_set "@#{varname}", resource
+    end
+
+    def authorize_resource
+      resource = resource_instance || resource_class
+      authorize resource
+    end
+
+    def skip_authorization_and_scope
+      action = params[:action]
+      if action == 'index'
+        skip_authorization
+        skip_policy_scope
+      else
+        skip_authorization
+      end
+    end
+
+    def resource_name
+      controller_name.singularize
+    end
+
+    def resource_class
+      resource_name.classify.constantize
+    end
+
+    def resource_instance
+      instance_variable_get "@#{resource_name}"
+    end
+  end
+end

data/lib/pundit_extra/version.rb

@@ -0,0 +1,3 @@
+module PunditExtra
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: pundit_extra
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Danny Ben Shitrit
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: runfile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: run-gem-dev
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: Add some helpers and additional functionality to Pundit.
+email: db@dannyben.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/pundit_extra.rb
+- lib/pundit_extra/controller_mixin.rb
+- lib/pundit_extra/helpers.rb
+- lib/pundit_extra/resource_autoload.rb
+- lib/pundit_extra/version.rb
+homepage: https://github.com/DannyBen/pundit_extra
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Additions for Pundit
+test_files: []