mongoid_ability 0.3.8 → 0.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 943814cee43339bf17cc8387496583fbbc797ddf
-  data.tar.gz: 714784b30fa8dad9f3e5aa32c8a25f62f034005a
+  metadata.gz: 8f068e6315f26aa262a2e85aaa2d533028b284f8
+  data.tar.gz: 22a58ce215e9fc9982c23e3ebef2a03642a60f29
 SHA512:
-  metadata.gz: 05c965309b7d19f5afe52ed51f47189e4a06049a33af6ec640eb845a02137b9938762dd77e32d4b80c6f58037a5b5a7fc09999d71a1c36da5ccbcde021f347b0
-  data.tar.gz: e6d1dcf742c1c3dda15459b4dc1abdfbd7d08bbc419262033b72654df3c4e929a94d799027e42e4bc48c02f88b3d4d469287d7ed5ca5fc83208841150c9973e0
+  metadata.gz: 0823e671b6f4f9bc4e500fe83a0bb39502f26106012bd011be9dfea71ea71083b0936bbe6a24417467e7a56bffa7f85c28d86031e3a62ec58341e632cc0f6783
+  data.tar.gz: 2f416fbeecb89078b0846c9bb4a9084aad1db0c4c3b7c3c976ea5e40b7c00840949b783d45ea88da65d5cf181ad64094c2293eb482c05e9c9208ff71d9a55b98

data/.travis.yml

@@ -2,7 +2,7 @@ language: ruby
 script: 'bundle exec rake'
 sudo: false
 rvm:
-  - 2.2.2
+  - 2.2.3
 services:
   - mongodb
 

data/README.md

@@ -43,10 +43,10 @@ end
 
 This class defines a permission itself using the following fields:
 
-`:subject_type, type: String`  
-`:subject_id, type: Moped::BSON::ObjectId`  
-`:action, type: Symbol, default: :read`  
-`:outcome, type: Boolean, default: false`  
+`:subject_type, type: String`
+`:subject_id, type: Moped::BSON::ObjectId`
+`:action, type: Symbol, default: :read`
+`:outcome, type: Boolean, default: false`
 
 These fields define what subject (respectively subject type, when referring to a class) the lock applies to, which action it is defined for (for example `:read`), and whether the outcome is positive or negative.
 
@@ -81,6 +81,12 @@ end
 
 The subject classes can be subclassed. Subclasses inherit the default locks (unless they override them), the resulting outcome being correctly calculated bottom-up the superclass chain.
 
+Additionally the locks can be converted to Mongoid criteria:
+
+```ruby
+MySubject.accessible_by(ability, :read)
+```
+
 ### Owner
 
 This `Ability` class supports two levels of inheritance (for example User and its Roles). The locks can be either embedded (via `.embeds_many`) or associated (via `.has_many`). Make sure to include the `as: :owner` option.

data/lib/mongoid_ability/ability.rb

@@ -7,16 +7,16 @@ module MongoidAbility
     attr_reader :owner
 
     def self.subject_classes
-      Object.descendants.select{ |cls| cls.included_modules.include?(MongoidAbility::Subject) }
+      Object.descendants.select { |cls| cls.included_modules.include?(MongoidAbility::Subject) }
     end
 
     def self.subject_root_classes
-      subject_classes.reject{ |cls| cls.superclass.included_modules.include?(MongoidAbility::Subject) }
+      subject_classes.reject { |cls| cls.superclass.included_modules.include?(MongoidAbility::Subject) }
     end
 
     # =====================================================================
 
-    def initialize owner
+    def initialize(owner)
       @owner = owner
 
       can do |action, subject_type, subject, options|
@@ -26,7 +26,7 @@ module MongoidAbility
 
         subject_class.self_and_ancestors_with_default_locks.each do |cls|
           outcome = ResolveInheritedLocks.call(owner, action, cls, subject, options)
-          break if outcome != nil
+          break unless outcome.nil?
         end
 
         outcome
@@ -40,11 +40,13 @@ module MongoidAbility
     # .select(&current_ability.can_update)
     # .select(&current_ability.can_destroy)
     # etc.
-    def method_missing name, *args
+    # 
+    # TODO: allow to pass options .select(&current_ability.can_read(my_option: false))
+    #
+    def method_missing(name, *args)
       return super unless name.to_s =~ /\A(can|cannot)_/
       return unless action = name.to_s.gsub(/\A(can|cannot)_/, '').to_sym
-      name =~ /can_/ ? lambda { |doc| can? action, doc } : lambda { |doc| cannot? action, doc }
+      name =~ /can_/ ? ->(doc) { can? action, doc } : ->(doc) { cannot? action, doc }
     end
-
   end
 end

data/lib/mongoid_ability/accessible_query_builder.rb

@@ -4,6 +4,10 @@ module MongoidAbility
       new(*args).call
     end
 
+    def initialize(base_class, ability, action, options = {})
+      super(base_class, ability, action, options)
+    end
+
     # =====================================================================
 
     def call
@@ -17,18 +21,18 @@ module MongoidAbility
     private # =============================================================
 
     def closed_types_condition
-      { _type: { '$nin' => values.closed_types.uniq } }
+      { type_key => { '$nin' => values.closed_types.uniq } }
     end
 
     def open_types_and_ids_condition
       {
-        _type: { '$in' => values.open_types_and_ids.map(&:type).uniq },
-        _id: { '$in' => values.open_types_and_ids.map(&:id).uniq }
+        type_key => { '$in' => values.open_types_and_ids.map(&:type).uniq },
+        id_key => { '$in' => values.open_types_and_ids.map(&:id).uniq }
       }
     end
 
     def closed_ids_condition
-      { _id: { '$nin' => values.closed_ids.uniq } }
+      { id_key => { '$nin' => values.closed_ids.uniq } }
     end
 
     # ---------------------------------------------------------------------
@@ -42,5 +46,19 @@ module MongoidAbility
     def base_class_superclass
       @base_class_superclass ||= (base_class.ancestors_with_default_locks.last || base_class)
     end
+
+    # ---------------------------------------------------------------------
+
+    def prefix
+      options.fetch(:prefix, nil)
+    end
+
+    def id_key
+      [prefix, '_id'].reject(&:blank?).join.to_sym
+    end
+
+    def type_key
+      [prefix, '_type'].reject(&:blank?).join.to_sym
+    end
   end
 end

data/lib/mongoid_ability/version.rb

@@ -1,3 +1,3 @@
 module MongoidAbility
-  VERSION = "0.3.8"
+  VERSION = '0.3.9'.freeze
 end

data/test/mongoid_ability/accessible_query_builder_test.rb

@@ -18,6 +18,11 @@ module MongoidAbility
       subject.must_be_kind_of Mongoid::Criteria
     end
 
+    it 'allows to pass prefix' do
+      skip 'not sure how to best test this'
+      selector = AccessibleQueryBuilder.call(base_class, ability, action, prefix: :foo).selector
+    end
+
     # ---------------------------------------------------------------------
 
     describe 'closed_types' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_ability
 version: !ruby/object:Gem::Version
-  version: 0.3.8
+  version: 0.3.9
 platform: ruby
 authors:
 - Tomáš Celizna
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-14 00:00:00.000000000 Z
+date: 2016-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cancancan