scoped_rolify 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: becb9ed298cf08d0e5223cf5ee44a48876e77ea3
-  data.tar.gz: d6ebfd57e5ae5628a8aa8bbd00137c9c58209759
+  metadata.gz: a832cd6b96763b2a9cbe528363b186e4e72d3773
+  data.tar.gz: a66071c37137dc12ae695544b66f958c4552ad95
 SHA512:
-  metadata.gz: b47f00df9110bdacb21093efd53fb7376e848bfe9fab31ba5db9263f288e97db0f0252cf93cb86ccd82afc731149482fb152369c3ee8df6a2128044747003c67
-  data.tar.gz: b72223b5507b3becc5663b6b4b2380955fe8559d4cc0ec88d6e2f0c504db09dec7eddb8aa4191d1eef9d26811e96365d92fefb0174c2e53f33b0b1f437ed941f
+  metadata.gz: fb11f0785a3f66d2b28b0ab884707eda1e1ed265a68eabd69561f774a6b60dbd70226ba69db0b0bcdfc9cdabe8a8192efac197d38acbce73607f3b5eaad142e0
+  data.tar.gz: 00c70582cec6e9e4abd1d0047ed060c7675f972ad89155e135db498980b623d5c7d465cefae8942fe2f190fcdb6c91115ae08c8a26931c6a608e4c387565bcba

data/CHANGELOG.md

@@ -1,17 +1,35 @@
+### VERSION 0.0.7
+
+* bug fix
+
+* refactoring
+  * Api signature has changed on with_scoped_role method
+
+* enhancements
+
+* backwards incompatible changes
+  * Api signature has changed on with_scoped_role method. Last argument is no longer boolean, is hash of option now.
+
+* deprecations
+
+* roadmap
+  * refactoring on root resource API
+
+
 ### VERSION 0.0.6
 
 * bug fix
 
 * enhancements
-  * remove eager loading for dynamic method
+  * remove eager loading for dynamic method. Cause performance problem with huge table roles.
 
 * backwards incompatible changes
 
 * deprecations
 
 * roadmap
-  * refactoring on root resource 
-  
+  * refactoring on root resource
+
 ### VERSION 0.0.5
 
 * bug fix
@@ -24,7 +42,7 @@
 * deprecations
 
 * roadmap
-  * refactoring on root resource 
+  * refactoring on root resource
 
 ### VERSION 0.0.4
 

data/README.md

@@ -9,8 +9,10 @@
 [![Build Status](https://travis-ci.org/joel/scoped_rolify.png?branch=master)](https://travis-ci.org/joel/scoped_rolify) (Travis CI)
 
 [![Coverage Status](https://coveralls.io/repos/joel/scoped_rolify/badge.png)](https://coveralls.io/r/joel/scoped_rolify)
-                                                                              https://coveralls.io/r/joel/scoped_rolify#
-This is a monkey patch of rolify for specifics purposes. We want only have users scoped on specific instance of resource. We are no really interesting by hierarchy.
+
+## Introduction
+
+This is a hack of EppO/rolify for specific purpose and for bypassing some limitations. We want only have users scoped on specific instance of resource. We are no really interesting by hierarchy. We want use Rolify for binding some resource through roles, the resources have absolutely need to be existing.
 
 ## Installation
 
@@ -26,54 +28,70 @@ Or install it yourself as:
 
     $ gem install scoped_rolify
 
-## Usage
 
-Method #add_scope_role map #add_role
+# Roles
+
+## #add_role method
+
+We have added ```add_scope_role(role_name, resource)``` method for mapped original ```add_role``` method.
+
+This method force argument resource to be existing, and add extra feature for ```root resource``` discussed below.
+
+usage:
 
-You can not add right without instance of resource
+You can't add right without instance of resource
 
     user = User.find(1)
     user.add_scope_role :admin # Thrown MissingResourceError
     user.add_scope_role :moderator, Forum # Thrown InstanceResourceError
 
-Only this case it's possible
+Only the following ways are possible
 
     user.add_scope_role :moderator, Forum.first
     user.add_scope_role :moderator, Forum.new
 
-You can play also with remove_scope_role
+## #remove_role method
 
-Method with_scoped_role and method #with_any_scoped_role
+This method is mapped by #remove_scope_role
 
-Theu methods return users for asked roles
+# Finders
 
-You can not call method without instance of resource
+## #with_role and #with_any_role methods
+
+Those methods are mapped by ```#with_scoped_role``` and method ```#with_any_scoped_role```
+
+An important enhancement here, the new methods return an ```ActiveRecord::Relation``` instead array of result! Is a big feature for us.
+
+usage:
+
+The methods return users for asked roles
+
+You can't call method without instance of resource
 
     User.with_scoped_role :admin # Thrown MissingResourceError
     User.with_scoped_role :moderator, Forum # Thrown InstanceResourceError
 
-Only this case it's possible
-
-    User.with_scoped_role :moderator, Forum.first #
+Only the following ways are possible
 
-You can't play with none persisted object
+    User.with_scoped_role :moderator, Forum.first
 
+### Important limitation of finders
 
-Method ```with_any_scoped_role``` return an ```ActiveRecord::Relation``` of all users with all roles asked for one resource
+You can't play with none persisted object
 
 ## Root Resource
 
-In some case you can add right on child resource instead of parent resource, the problem is you haven't access directly to objects throught Parent resource, for exemple
+In some case you can add right on child resource instead of parent resource, the problem is you haven't access directly to objects through Parent resource, for exemple
 
-You grant user on specifc Forum, user.add_role(:moderator, Forum.first) the Forum have one Category, if you want get all moderators of this Category you can't. This modification make this possible.
+You grant user on specific ```Forum```, ```user.add_scope_role(:moderator, Forum.first)``` the ```Forum``` have one ```Category```, if you want get all moderators of this ```Category``` you can't. This modification make this way possible.
 
     moderator_john = User.new
     moderator_jane = User.new
 
-    geek_world = Category.new
+    hack_category = Category.new
 
-    geek_forum = Forum.new
-    nerd_forum = Forum.new
+    fair_hack_forum = Forum.new
+    blackhat_hack_forum = Forum.new
 
     class Forum < ActiveRecord::Base
       belongs_to :category
@@ -87,29 +105,27 @@ You grant user on specifc Forum, user.add_role(:moderator, Forum.first) the Foru
       has_many :forums
     end
 
-    geek_world.forums << geek_forum
-    geek_world.forums << nerd_forum
-
-    moderator_john.add_role(:moderator, nerd_forum)
-    moderator_jane.add_role(:moderator, geek_forum)
+    hack_category.forums << fair_hack_forum
+    hack_category.forums << blackhat_hack_forum
 
-For grab all moderators of this Category
+    moderator_john.add_scope_role(:moderator, blackhat_hack_forum)
+    moderator_jane.add_scope_role(:moderator, fair_hack_forum)
 
-    User.with_scoped_role :moderator, geek_world, root=true
+For get all moderators of this Category
 
-## Roadmap
+    User.with_scoped_role :moderator, hack_category, scope: :root
 
-Refactoring on root resource API
+## Bugfix
 
-Change
+We have fixed a bug on ```has_role?``` method for object none persisted
 
-    User.with_scoped_role :moderator, geek_world, root=true
+## Roadmap
 
-to
+Possible enhancements
 
-    User.with_scoped_role :moderator, geek_world, scope: :forum
+Refactoring on root resource API
 
-And change
+Change
 
     class Forum < ActiveRecord::Base
       belongs_to :category
@@ -118,14 +134,16 @@ And change
         :category
       end
     end
-    
+
 to
 
     class Forum < ActiveRecord::Base
       belongs_to :category
-      scoped_roles belongs_to: :category 
+      scoped_roles belongs_to: :category
     end
 
+This way seem pretty nice, but need spend more time on it.
+
 ## Contributing
 
 1. Fork it ( http://github.com/<my-github-username>/scoped_rolify/fork )

data/lib/scoped_rolify/finders.rb

@@ -1,34 +1,39 @@
 module Rolify
   module Finders
 
-    def with_scoped_role role_name, resource, root_only=false
+    def with_scoped_role role_name, resource, options={}
       ScopedRolify::Policy.new(self, resource).check_persisted!
-      self.joins(:roles).where(rolify_constraints(role_name, resource, root_only))
+      self.joins(:roles).where(rolify_constraints(role_name, resource, options))
     end
 
-    def with_any_scoped_role role_names, resource, root_only=false
+    def with_any_scoped_role role_names, resource, options={}
       ScopedRolify::Policy.new(self, resource).check_persisted!
-      self.joins(:roles).where(rolify_constraints(role_names, resource, root_only))
+      self.joins(:roles).where(rolify_constraints(role_names, resource, options))
     end
 
-    def rolify_constraints role_names, resource, root_only=false
-      raise 'You should give somes role' if role_names.nil? or (role_names||[]).empty?
-      
+    def rolify_constraints role_names, resource, options={}
+      raise 'You should give somes role' if role_names.nil? or Array(role_names).empty?
       ScopedRolify::Policy.new(self, resource).check_persisted!
-            
-      table = Arel::Table.new(:roles)
 
-      [].tap do |_constraints|
+      scope = options.fetch(:scope, :resource)
+      raise 'Only scope :resource or :root are supported' unless %i(resource root).include?(scope)
+
+      field_type, field_id = begin
+        case scope
+        when :resource
+          [ :resource_type, :resource_id]
+        when :root
+          [ :root_resource_type, :root_resource_id]
+        end
+      end
+
+      table = Arel::Table.new(:roles)
+      [].tap do |constraints|
         Array.wrap(role_names).each do |name|
-          _constraints << [].tap do |_constraint|
-            _constraint << table[:name].eq(name)
-            if root_only
-              _constraint << table[:root_resource_type].eq(resource.class.name)
-              _constraint << table[:root_resource_id].eq(resource.id)
-            else
-              _constraint << table[:resource_type].eq(resource.class.name)
-              _constraint << table[:resource_id].eq(resource.id)
-            end
+          constraints << [].tap do |constraint|
+            constraint << table[:name].eq(name)
+            constraint << table[field_type].eq(resource.class.name)
+            constraint << table[field_id].eq(resource.id)
           end.reduce(:and)
         end
       end.reduce(:or)

data/lib/scoped_rolify/version.rb

@@ -1,3 +1,3 @@
 module ScopedRolify
-  VERSION = '0.0.6'
+  VERSION = '0.0.7'
 end

data/spec/scoped_rolify/finders_spec.rb

@@ -42,7 +42,7 @@ describe Rolify::Finders do
       end
 
       it('should retreive super_admin') { expect(User.with_scoped_role(:super_admin, resource).to_a).to eq([super_admin]) }
-      it('should retreive all user for Category') { expect(User.with_scoped_role(:super_admin, root_resource, true).to_a).to eq([super_admin, moderator]) }
+      it('should retreive all user for Category') { expect(User.with_scoped_role(:super_admin, root_resource, scope: :root).to_a).to eq([super_admin, moderator]) }
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scoped_rolify
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Joel AZEMAR
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-20 00:00:00.000000000 Z
+date: 2014-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rolify