grabli 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22817abd7cf1fcd173e9c6d804fd9ce27df4c6b5ef3df83678e65c4d1a43c911
-  data.tar.gz: f59006fd5d79f420043a94bbf98fe9103802ac42f39bcc10543ac2310fff2af6
+  metadata.gz: e92851163c7bdfdc005eb3482c9885328ac15365d1a0fd023a6a8d00d12b255c
+  data.tar.gz: bd5ec4baadac745a7969bc4a72cecd98c1f704688fd2f9d13b8f6d5165437142
 SHA512:
-  metadata.gz: dc895810cd249c7646d188e73da2c2715356077bbe43eb5051a9bd12caef9b5b5a3fc458ee2f29d761dc5f82ba2d1854281d9e17582b3feb63cf208ed16af5db
-  data.tar.gz: ca971071066b83c562e2721c6eadc294f94fda1ae429842b6ce1e2fe4246753cae63fd9986023f32b80ec600e80e8118a245c3b0075a5d59eeb7afe6769d785c
+  metadata.gz: 96c5344afd2760f47c596d810fc6e9c4a930db262ff93bc9c0dbb71fa4343c7f1d0237b6447274da3fc17cee567d50450cc5ea425c311d17f376218901db0e28
+  data.tar.gz: bc6419b071928f1bc225462c59d9ea141e9ab1c30b28a0e2c9b35c71f8d10daf8e36a4bbd60ead44b725df94f67bede05f93c7fd75a3673acba4b203f252378f

data/Gemfile.lock

@@ -47,4 +47,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.16.0
+   1.16.1

data/README.md

@@ -6,7 +6,7 @@ The very specific goal of this gem is to extract pundit policy permissions to so
 
 ## Usage
 
-With a given `UserPolicy` (e.g. the one defined in `/spec/spec_helper.rb`) you can do:
+With a given `CompanyPolicy` you can do:
 
 ```ruby
 require 'grabli'
@@ -45,7 +45,6 @@ class ApplicationController
   def collect_permissions_for(subject)
     Grabli.new.collect(current_user, subject)
   end
-  helper_method :collect_permissions_for
 end
 
 
@@ -60,6 +59,30 @@ class Api::UsersController < ApplicationController
 end
 ```
 
+### Namespaced policies
+
+If you have namespaced policies, something like
+
+```ruby
+class User
+  class PetPolicy < ApplicationPolicy
+    def feed?
+      true
+    end
+  end
+end
+```
+
+You can specify the namespace by passing it to `#new`
+
+```ruby
+Grabli.new(namespace: User).collect(@current_user, @pet)
+```
+
+## Permissions lookup
+
+While fetching permissions, Grabli looks for *public instance methods* defined on particular policy class. It means Grabli *will ignore inherited and private permissions*. It will also ignore all `permitted_attributes` methods on your policy.
+
 ## Further plans
 
 1) Improve cases when subject is a `Symbol`
@@ -70,4 +93,4 @@ Make `Intruder` a bit more clever proxy object which delegates to the subject an
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/grabli.
+Bug reports and pull requests are welcome on GitHub at https://github.com/dikond/grabli.

data/lib/grabli.rb

@@ -2,14 +2,28 @@ require "grabli/version"
 require "pundit"
 
 class Grabli
+  PolicyNotFound = Class.new(StandardError)
+
+  #
+  # You can configure grabli by passing options to initializer
+  # @param namespace: nil [module] set the namespace for your policies
+  #
+  # @example
+  #   # will search policies under specified namespace, e.g. User::SomePolicy
+  #   Grabli.new(namespace: User)
+  #
+  def initialize(namespace: nil)
+    @namespace = namespace
+  end
+
   #
   # Collect allowed policy permissions for the given user.
   #
   # @param user [Object] user object your policy work with
   # @param subject [Symbol, Object] subject object your policy work with
   # @return [Array<Symbol>] array of allowed policy permission
-  # @example
   #
+  # @example
   #   Grabli.new.collect(@user, @company)
   #   #=> [:create?, :update?, :manage_occupied?]
   #
@@ -18,16 +32,16 @@ class Grabli
   #
   def collect(user, subject)
     policy_class(subject)
+      .tap { |policy| raise PolicyNotFound if policy.nil? }
       .public_instance_methods(false)
-      .reject! { |n| n =~ /permitted_attributes/ }
+      .reject { |n| n =~ /permitted_attributes/ }
       .each_with_object([]) do |permission, collection|
-        # allows to collect permissions without subject, for more @see Intruder
+        # allows to collect permissions without subject, for more see Intruder
         isubject = subject.is_a?(Symbol) ? Intruder.new(false) : subject
         policy = policy_class(subject).new(user, isubject)
 
         collection << permission if allowed? policy, permission
       end
-      .sort
   end
 
   # Check whether certain permission is allowed.
@@ -36,8 +50,8 @@ class Grabli
   # @param permission [Symbol] permission name
   # @return [Boolen, Object] true or false in case subject intruded
   #   or whatever you policy permission returns
-  # @example
   #
+  # @example
   #   policy = Pundit.policy(@user, @company)
   #   Grabli.new.allowed?(policy, :create?)
   #   #=> true
@@ -49,7 +63,11 @@ class Grabli
   end
 
   private def policy_class(record)
-    Pundit::PolicyFinder.new(record).policy
+    if @namespace.nil?
+      Pundit::PolicyFinder.new(record).policy
+    else
+      Pundit::PolicyFinder.new([@namespace, record]).policy
+    end
   end
 
   #
@@ -59,9 +77,6 @@ class Grabli
   # If the subject isn't used it means we can add this permission as allowed.
   # If it's used, CURRENTLY, we assume that the given permission isn't allowed.
   #
-  # TODO: delegate to the original subject if it was given
-  #       and intercept NoMethodError
-  #
   Intruder = Struct.new(:intruded) do
     def method_missing(*)
       self[:intruded] = true

data/lib/grabli/version.rb

@@ -1,3 +1,3 @@
 class Grabli
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/yarn-error.log

@@ -0,0 +1,32 @@
+Arguments: 
+  /Users/danny/.nvm/versions/node/v8.10.0/bin/node /usr/local/Cellar/yarn/1.5.1_1/libexec/bin/yarn.js server --reload
+
+PATH: 
+  /Users/danny/.rbenv/shims:/Users/danny/.nvm/versions/node/v8.10.0/bin:/Users/danny/.yarn/bin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin
+
+Yarn version: 
+  1.5.1
+
+Node version: 
+  8.10.0
+
+Platform: 
+  darwin x64
+
+npm manifest: 
+  No manifest
+
+yarn manifest: 
+  No manifest
+
+Lockfile: 
+  No lockfile
+
+Trace: 
+  Error: Couldn't find a package.json file in "/Users/danny/dev/gems/grabli"
+      at new MessageError (/usr/local/Cellar/yarn/1.5.1_1/libexec/lib/cli.js:186:110)
+      at /usr/local/Cellar/yarn/1.5.1_1/libexec/lib/cli.js:40048:15
+      at Generator.next (<anonymous>)
+      at step (/usr/local/Cellar/yarn/1.5.1_1/libexec/lib/cli.js:98:30)
+      at /usr/local/Cellar/yarn/1.5.1_1/libexec/lib/cli.js:109:13
+      at <anonymous>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grabli
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - dikond
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-10 00:00:00.000000000 Z
+date: 2018-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pundit
@@ -85,6 +85,7 @@ files:
 - grabli.gemspec
 - lib/grabli.rb
 - lib/grabli/version.rb
+- yarn-error.log
 homepage: https://github.com/dikond/grabli
 licenses:
 - wtfpl