mongoid_ability 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4350f8ee2aa6783ba0bd4790264aae87341062fa
-  data.tar.gz: 7f58c17ff7e7e441fb761d0ed33f48ab298c3ec3
+  metadata.gz: 3fbc4ee9c2161070d8e1a2f9d79f53318239fe61
+  data.tar.gz: 5356a70dcb98c19d3744dea5eea22c28b6d4b2a3
 SHA512:
-  metadata.gz: 701fa1fee1c99245b7c6dada06da608352bfe4e153ac728334d54d1394516ea1ac0707f24550ff7ab88b7e7aa96eb18db396aeeaa814e29933af2217b2e6a2ee
-  data.tar.gz: ac018c43208f7089fe308504fec8188c5fece9cdccccc6ec76447a2ce9917740c6ef4aa5984183625ff9f3b4d3db23c04e5e5472c842ee025c83e7581017690e
+  metadata.gz: c1bab6862b3fb65d502b87982a4181eb6a2054ac78d7dced498732a7aaf194ed843f35ff0df8c13f10580ae1523dfeb760dc4c643c024d8b99b0ccd351f6592f
+  data.tar.gz: f3fc6a6559d09bc54233b60b5efabfd037ec68a32af7b2416e65bb295d981c6c53715e0a85dd15f0efe78f12bdef9fa659dc937be0423a94f253c30d20737f19

data/lib/mongoid_ability.rb

@@ -2,6 +2,7 @@ require "mongoid_ability/version"
 
 require "mongoid_ability/ability"
 require "mongoid_ability/ability_resolver"
+require "mongoid_ability/accessible_query_builder"
 require "mongoid_ability/lock"
 require "mongoid_ability/owner"
 require "mongoid_ability/subject"
@@ -14,4 +15,4 @@ if defined?(Rails)
       @current_ability ||= MongoidAbility::Ability.new(current_user)
     end
   end
-end
+end

data/lib/mongoid_ability/accessible_query_builder.rb

@@ -0,0 +1,113 @@
+module MongoidAbility
+  class AccessibleQueryBuilder < Struct.new(:base_class, :ability, :action)
+
+    def self.call *args
+      new(*args).call
+    end
+
+    # =====================================================================
+
+    def call
+      criteria = base_criteria
+
+      base_class_and_descendants.each do |cls|
+        criteria = criteria.merge(criteria_for_class(cls))
+      end
+
+      criteria
+    end
+
+    private # =============================================================
+
+    def base_criteria
+      @base_criteria ||= base_class.criteria
+    end
+
+    # ---------------------------------------------------------------------
+
+    def base_class_superclass
+      @base_class_superclass ||= (base_class.ancestors_with_default_locks.last || base_class)
+    end
+
+    def base_class_descendants
+      @base_class_descendants ||= ObjectSpace.each_object(Class).select{ |cls| cls < base_class_superclass }
+    end
+
+    def base_class_and_descendants
+      [base_class].concat(base_class_descendants)
+    end
+
+    def hereditary?
+      base_class_and_descendants.count > 1
+    end
+
+    # ---------------------------------------------------------------------
+
+    def user
+      ability.user
+    end
+
+    def roles
+      user.roles_relation
+    end
+
+    # ---------------------------------------------------------------------
+
+    def user_id_locks_for_subject_type cls
+      user.locks_relation.id_locks.for_action(action).for_subject_type(cls.to_s)
+    end
+
+    def roles_ids_locks_for_subject_type cls
+      roles.collect { |role| role.locks_relation.id_locks.for_action(action).for_subject_type(cls.to_s) }.flatten
+    end
+
+    # ---------------------------------------------------------------------
+
+    def role_has_open_id_lock? cls, subject_id
+      roles_ids_locks_for_subject_type(cls).
+        select(&:open?).
+        map(&:subject_id).
+        include?(subject_id)
+    end
+
+    def user_has_open_id_lock? cls, subject_id
+      user_id_locks_for_subject_type(cls).
+        select(&:open?).
+        map(&:subject_id).
+        include?(subject_id)
+    end
+
+    # ---------------------------------------------------------------------
+
+    def criteria_for_class cls
+      ability.can?(action, cls) ? exclude_criteria(cls) : include_criteria(cls)
+    end
+
+    def exclude_criteria cls
+      id_locks = roles_ids_locks_for_subject_type(cls).select(&:closed?)
+      id_locks = id_locks.reject{ |lock| role_has_open_id_lock?(cls, lock.subject_id) }
+      id_locks = id_locks.reject{ |lock| user_has_open_id_lock?(cls, lock.subject_id) }
+      id_locks += user_id_locks_for_subject_type(cls).select(&:closed?)
+
+      excluded_ids = id_locks.map(&:subject_id).flatten
+
+      conditions = { :_id.nin => excluded_ids }
+      conditions = conditions.merge(_type: cls.to_s) if hereditary?
+
+      base_criteria.or(conditions)
+    end
+
+    def include_criteria cls
+      id_locks = roles_ids_locks_for_subject_type(cls).select(&:open?)
+      id_locks += user_id_locks_for_subject_type(cls).select(&:open?)
+
+      included_ids = id_locks.map(&:subject_id).flatten
+
+      conditions = { :_id.in => included_ids }
+      conditions = conditions.merge(_type: cls.to_s) if hereditary?
+
+      base_criteria.or(conditions)
+    end
+
+  end
+end

data/lib/mongoid_ability/owner.rb

@@ -27,7 +27,9 @@ module MongoidAbility
       # override if needed
       # return for example 'MyLock'
       def lock_class_name
-        @lock_class_name ||= Object.descendants.detect{ |cls| cls < MongoidAbility::Lock }.name
+        lock_classes = ObjectSpace.each_object(Class).select{ |cls| cls < MongoidAbility::Lock }
+        lock_superclasses = lock_classes.reject{ |cls| lock_classes.any?{ |c| cls < c } }
+        @lock_class_name ||= lock_superclasses.first.name
       end
     end
 

data/lib/mongoid_ability/subject.rb

@@ -27,7 +27,9 @@ module MongoidAbility
       # override if needed
       # return for example 'MyLock'
       def lock_class_name
-        @lock_class_name ||= Object.descendants.detect{ |cls| cls < MongoidAbility::Lock }.name
+        lock_classes = ObjectSpace.each_object(Class).select{ |cls| cls < MongoidAbility::Lock }
+        lock_superclasses = lock_classes.reject{ |cls| lock_classes.any?{ |c| cls < c } }
+        @lock_class_name ||= lock_superclasses.first.name
       end
 
       # ---------------------------------------------------------------------
@@ -42,59 +44,8 @@ module MongoidAbility
 
       # ---------------------------------------------------------------------
 
-      # TODO: obviously this could be cleaner
       def accessible_by ability, action=:read
-        cr = self.criteria
-
-        return cr unless ability.user.present?
-
-        supercls = self.ancestors_with_default_locks.last || self
-        subject_classes = [supercls].concat(supercls.descendants)
-
-        subject_classes.each do |cls|
-
-          roles_id_locks = ability.user.roles_relation.collect{ |role| role.locks_relation.for_subject_type(cls.to_s).id_locks.for_action(action) }.flatten
-          user_id_locks = ability.user.locks_relation.for_subject_type(cls.to_s).id_locks.for_action(action)
-
-          closed_roles_id_locks = roles_id_locks.to_a.select(&:closed?)
-          open_roles_id_locks = roles_id_locks.to_a.select(&:open?)
-
-          closed_user_id_locks = user_id_locks.to_a.select(&:closed?)
-          open_user_id_locks = user_id_locks.to_a.select(&:open?)
-
-          if ability.can?(action, cls)
-            excluded_ids = []
-
-            id_locks = closed_roles_id_locks.
-              reject{ |cl| open_roles_id_locks.any?{ |ol| ol.subject_id == cl.subject_id } }.
-              reject{ |cl| open_user_id_locks.any?{ |ol| ol.subject_id == cl.subject_id } }
-
-            id_locks += closed_user_id_locks
-            
-            excluded_ids << id_locks.map(&:subject_id)
-
-            if subject_classes.count == 1
-              cr = cr.or(:_id.nin => excluded_ids.flatten)
-            else
-              cr = cr.or(_type: cls.to_s, :_id.nin => excluded_ids.flatten)
-            end
-          else
-            included_ids = []
-
-            id_locks = open_roles_id_locks
-            id_locks += open_user_id_locks
-
-            included_ids << id_locks.map(&:subject_id)
-
-            if subject_classes.count == 1
-              cr = cr.or(:_id.in => included_ids.flatten)
-            else
-              cr = cr.or(_type: cls.to_s, :_id.in => included_ids.flatten)
-            end
-          end
-        end
-
-        cr
+        AccessibleQueryBuilder.call(self, ability, action)
       end
     end
 

data/lib/mongoid_ability/version.rb

@@ -1,3 +1,3 @@
 module MongoidAbility
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/test/mongoid_ability/accessible_query_builder_test.rb

@@ -0,0 +1,20 @@
+require "test_helper"
+
+module MongoidAbility
+  describe AccessibleQueryBuilder do
+
+    let(:base_class) { SubjectTest }
+    
+    let(:user) { TestUser.new }
+    let(:ability) { Ability.new(user) }
+
+    let(:action) { :read }
+
+    subject { AccessibleQueryBuilder.call(base_class, ability, action) }
+
+    it 'returns Mongoid::Criteria' do
+      subject.must_be_kind_of Mongoid::Criteria
+    end
+
+  end
+end

data/test/mongoid_ability/subject_test.rb

@@ -71,10 +71,6 @@ module MongoidAbility
           subject_single_test
         end
 
-        it 'returns Mongoid::Criteria' do
-          subject.class.accessible_by(ability).must_be_kind_of Mongoid::Criteria
-        end
-
         # ---------------------------------------------------------------------
 
         describe 'default locks' do

data/test/support/test_classes.rb

@@ -0,0 +1,86 @@
+class TestLock
+  include Mongoid::Document
+  include MongoidAbility::Lock
+
+  embedded_in :owner, polymorphic: true
+end
+
+class TestLockSub < TestLock
+end
+
+# ---------------------------------------------------------------------
+  
+class TestOwnerSuper
+  include Mongoid::Document
+  include MongoidAbility::Owner
+
+  embeds_many :test_locks, class_name: 'TestLock', as: :owner
+end
+
+class TestOwner < TestOwnerSuper
+end
+
+# ---------------------------------------------------------------------
+
+class SubjectTest
+  include Mongoid::Document
+  include MongoidAbility::Subject
+
+  default_lock :read, true
+end
+
+class SubjectTestOne < SubjectTest
+end
+
+class SubjectTestTwo < SubjectTest
+end
+
+class SubjectSingleTest
+  include Mongoid::Document
+  include MongoidAbility::Subject
+
+  default_lock :read, true
+end
+
+# ---------------------------------------------------------------------
+  
+class TestAbilityResolverSubject
+  include Mongoid::Document
+  include MongoidAbility::Subject
+
+  default_lock :read, true
+end
+
+class TestAbilitySubjectSuper2
+  include Mongoid::Document
+  include MongoidAbility::Subject
+
+  default_lock :read, false
+  default_lock :update, true
+end
+
+class TestAbilitySubjectSuper1 < TestAbilitySubjectSuper2
+end
+
+class TestAbilitySubject < TestAbilitySubjectSuper1
+end
+
+# ---------------------------------------------------------------------
+  
+class TestRole
+  include Mongoid::Document
+  include MongoidAbility::Owner
+
+  field :name, type: String
+
+  embeds_many :test_locks, class_name: 'TestLock', as: :owner
+  has_and_belongs_to_many :users, class_name: 'TestUser'
+end  
+
+class TestUser
+  include Mongoid::Document
+  include MongoidAbility::Owner
+
+  embeds_many :test_locks, class_name: 'TestLock', as: :owner
+  has_and_belongs_to_many :roles, class_name: 'TestRole'
+end

data/test/test_helper.rb

@@ -7,8 +7,8 @@ require 'mongoid'
 
 require 'mongoid_ability'
 
-# =====================================================================
-  
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
 if ENV["CI"]
   require "coveralls"
   Coveralls.wear!
@@ -43,93 +43,4 @@ DatabaseCleaner.strategy = :truncation
 class MiniTest::Spec
   before(:each) { DatabaseCleaner.start }
   after(:each) { DatabaseCleaner.clean }
-end
-
-# =====================================================================
-
-class TestLock
-  include Mongoid::Document
-  include MongoidAbility::Lock
-
-  embedded_in :owner, polymorphic: true
-end
-
-class TestLockSub < TestLock
-end
-
-# ---------------------------------------------------------------------
-  
-class TestOwnerSuper
-  include Mongoid::Document
-  include MongoidAbility::Owner
-
-  embeds_many :test_locks, class_name: 'TestLock', as: :owner
-end
-
-class TestOwner < TestOwnerSuper
-end
-
-# ---------------------------------------------------------------------
-
-class SubjectTest
-  include Mongoid::Document
-  include MongoidAbility::Subject
-
-  default_lock :read, true
-end
-
-class SubjectTestOne < SubjectTest
-end
-
-class SubjectTestTwo < SubjectTest
-end
-
-class SubjectSingleTest
-  include Mongoid::Document
-  include MongoidAbility::Subject
-
-  default_lock :read, true
-end
-
-# ---------------------------------------------------------------------
-  
-class TestAbilityResolverSubject
-  include Mongoid::Document
-  include MongoidAbility::Subject
-
-  default_lock :read, true
-end
-
-class TestAbilitySubjectSuper2
-  include Mongoid::Document
-  include MongoidAbility::Subject
-
-  default_lock :read, false
-  default_lock :update, true
-end
-
-class TestAbilitySubjectSuper1 < TestAbilitySubjectSuper2
-end
-
-class TestAbilitySubject < TestAbilitySubjectSuper1
-end
-
-# ---------------------------------------------------------------------
-  
-class TestRole
-  include Mongoid::Document
-  include MongoidAbility::Owner
-
-  field :name, type: String
-
-  embeds_many :test_locks, class_name: 'TestLock', as: :owner
-  has_and_belongs_to_many :users, class_name: 'TestUser'
-end  
-
-class TestUser
-  include Mongoid::Document
-  include MongoidAbility::Owner
-
-  embeds_many :test_locks, class_name: 'TestLock', as: :owner
-  has_and_belongs_to_many :roles, class_name: 'TestRole'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_ability
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Tomas Celizna
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-09 00:00:00.000000000 Z
+date: 2015-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cancancan
@@ -155,6 +155,7 @@ files:
 - lib/mongoid_ability.rb
 - lib/mongoid_ability/ability.rb
 - lib/mongoid_ability/ability_resolver.rb
+- lib/mongoid_ability/accessible_query_builder.rb
 - lib/mongoid_ability/lock.rb
 - lib/mongoid_ability/owner.rb
 - lib/mongoid_ability/subject.rb
@@ -162,9 +163,11 @@ files:
 - mongoid_ability.gemspec
 - test/mongoid_ability/ability_resolver_test.rb
 - test/mongoid_ability/ability_test.rb
+- test/mongoid_ability/accessible_query_builder_test.rb
 - test/mongoid_ability/lock_test.rb
 - test/mongoid_ability/owner_test.rb
 - test/mongoid_ability/subject_test.rb
+- test/support/test_classes.rb
 - test/test_helper.rb
 homepage: https://github.com/tomasc/mongoid_ability
 licenses:
@@ -194,7 +197,9 @@ summary: Custom Ability class that allows CanCanCan authorization library store
 test_files:
 - test/mongoid_ability/ability_resolver_test.rb
 - test/mongoid_ability/ability_test.rb
+- test/mongoid_ability/accessible_query_builder_test.rb
 - test/mongoid_ability/lock_test.rb
 - test/mongoid_ability/owner_test.rb
 - test/mongoid_ability/subject_test.rb
+- test/support/test_classes.rb
 - test/test_helper.rb