mongoid_ability 3.0.0 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a0e978ec258c3a3b3e93fa34b6943c8af6b09666722b0ac2b61f196fa972394
-  data.tar.gz: 132f93b4885b86db918c22739859944b86d98e83a07fd7f90ac0e259b5d6e901
+  metadata.gz: 275a88f165da3e4172f6665fa6b15f65e66a1dc57f6ac930176f58e3b4a32e42
+  data.tar.gz: 2997e27d3e00810dd7fe1f09e3a5212e867a77ace41945dba1c978b36c5b1b4d
 SHA512:
-  metadata.gz: 50b463ff75c3ecf23a1187b05fcba527c4b50bd47e3c4831d7aece79124b366194d28da44af3acb414f4d0a8de8c02799a24e321a138bab1046552463f7b8a4e
-  data.tar.gz: 06dee8bd65eacce1939aca16d3f6b001b7ed58e708f776903eeb3a2bd4873cf1a3d8d09e5a817590571113d29795b038ec979cacd6f243f43f18d07084d2efab
+  metadata.gz: f8cb94a2215357b1d740741ed42fff8ea516b2d44bd348577fd16aedee21fb3f5dbac502562807e74f9bcbf573c9599ad129f532308da09380cd4402e679d208
+  data.tar.gz: e5992d7339082d50f151a4af5755a4e81bd1e634fe96860389550ff42010c3d87f2092a68d471b0350e942c3f883f170b395488bc12bd984259e45834de9ef91

data/.github/workflows/test.yml

@@ -0,0 +1,26 @@
+name: Tests
+on: [push, pull_request]
+concurrency:
+  group: ${{ github.ref }}
+  cancel-in-progress: true
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        gemfile: ["7_0", "7_1", "7_2", "7_3", "7_4", "7_5", "8_0", "8_1"]
+        ruby: ["2.7", "3.0", "3.1"]
+    runs-on: ubuntu-latest
+    services:
+      mongodb:
+        image: mongo
+        ports: ["27017:27017"]
+    env:
+      BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/${{ matrix.gemfile }}.gemfile
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake

data/.gitignore

@@ -3,6 +3,7 @@
 .bundle
 .config
 .yardoc
+.tool-versions
 Gemfile.lock
 InstalledFiles
 _yardoc
@@ -20,3 +21,4 @@ tmp
 *.o
 *.a
 mkmf.log
+gemfiles/*.gemfile.lock

data/.travis.yml

@@ -2,9 +2,16 @@ language: ruby
 script: 'bundle exec rake'
 sudo: false
 rvm:
-  - 2.5.1
+  - 2.6.6
+  - 2.7.6
+  - 3.0.4
+  - 3.1.2
 services:
   - mongodb
+gemfile:
+  - gemfiles/7_0.gemfile
+  - gemfiles/7_1.gemfile
+  - gemfiles/7_2.gemfile
 
 notifications:
   email:

data/Appraisals

@@ -0,0 +1,31 @@
+appraise "7-0" do
+  gem "mongoid", "~> 7.0.0"
+end
+
+appraise "7-1" do
+  gem "mongoid", "~> 7.1.0"
+end
+
+appraise "7-2" do
+  gem "mongoid", "~> 7.2.0"
+end
+
+appraise "7-3" do
+  gem "mongoid", "~> 7.3.0"
+end
+
+appraise "7-4" do
+  gem "mongoid", "~> 7.4.0"
+end
+
+appraise "7-5" do
+  gem "mongoid", "~> 7.5.0"
+end
+
+appraise "8-0" do
+  gem "mongoid", "~> 8.0.0"
+end
+
+appraise "8-1" do
+  gem "mongoid", "~> 8.1.0"
+end

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+## 3.0.2
+
+* Mongoid 8 compatibility
+
+## 3.0.1
+
+* OPTMIZE: `.accessible_by` is now using `$nin` with multiple values rather than multiple of `$ne`
+
 ## 3.0.0
 
 * upgrade to Mongoid 7+

data/Rakefile

@@ -1,9 +1,10 @@
 require 'bundler/gem_tasks'
 require 'rake/testtask'
- 
+
 Rake::TestTask.new do |t|
   t.libs << 'test'
   t.pattern = 'test/**/*_test.rb'
+  t.warning = false
 end
 
-task :default => :test
+task :default => :test

data/gemfiles/7_0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "mongoid", "~> 7.0.0"
+
+gemspec path: "../"

data/gemfiles/7_1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "mongoid", "~> 7.1.0"
+
+gemspec path: "../"

data/gemfiles/7_2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "mongoid", "~> 7.2.0"
+
+gemspec path: "../"

data/gemfiles/7_3.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "mongoid", "~> 7.3.0"
+
+gemspec path: "../"

data/gemfiles/7_4.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "mongoid", "~> 7.4.0"
+
+gemspec path: "../"

data/gemfiles/7_5.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "mongoid", "~> 7.5.0"
+
+gemspec path: "../"

data/gemfiles/8_0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "mongoid", "~> 8.0.0"
+
+gemspec path: "../"

data/gemfiles/8_1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "mongoid", "~> 8.1.0"
+
+gemspec path: "../"

data/lib/cancancan/model_adapters/mongoid_adapter.rb

@@ -1,40 +1,44 @@
-require 'set'
+# frozen_string_literal: true
+
+require "set"
 
 module CanCan
   module ModelAdapters
     class MongoidAdapter < AbstractAdapter
-      def self.for_class?(model_class)
-        model_class <= Mongoid::Document
-      end
-
-      # Used to determine if this model adapter will override the matching behavior for a hash of conditions.
-      # If this returns true then matches_conditions_hash? will be called. See Rule#matches_conditions_hash
-      def self.override_conditions_hash_matching?(_subject, _conditions)
-        false
-      end
+      class << self
+        def for_class?(model_class)
+          model_class <= Mongoid::Document
+        end
 
-      # Override if override_conditions_hash_matching? returns true
-      def self.matches_conditions_hash?(_subject, _conditions)
-        raise NotImplemented, 'This model adapter does not support matching on a conditions hash.'
-      end
+        # Used to determine if this model adapter will override the matching behavior for a hash of conditions.
+        # If this returns true then matches_conditions_hash? will be called. See Rule#matches_conditions_hash
+        def override_conditions_hash_matching?(_subject, _conditions)
+          false
+        end
 
-      # Used to determine if this model adapter will override the matching behavior for a specific condition.
-      # If this returns true then matches_condition? will be called. See Rule#matches_conditions_hash
-      def self.override_condition_matching?(_subject, _name, _value)
-        true
-      end
+        # Override if override_conditions_hash_matching? returns true
+        def matches_conditions_hash?(_subject, _conditions)
+          raise NotImplemented, "This model adapter does not support matching on a conditions hash."
+        end
 
-      # Override if override_condition_matching? returns true
-      def self.matches_condition?(subject, name, value)
-        attribute = subject.send(name)
+        # Used to determine if this model adapter will override the matching behavior for a specific condition.
+        # If this returns true then matches_condition? will be called. See Rule#matches_conditions_hash
+        def override_condition_matching?(_subject, _name, _value)
+          true
+        end
 
-        case value
-        when Hash then hash_condition_match?(attribute, value)
-        when Range then value.cover?(attribute)
-        when Regexp then value.match(attribute)
-        when Array then value.include?(attribute)
-        when Enumerable then value.include?(attribute)
-        else attribute == value
+        # Override if override_condition_matching? returns true
+        def matches_condition?(subject, name, value)
+          attribute = subject.send(name)
+
+          case value
+          when Hash then hash_condition_match?(attribute, value)
+          when Range then value.cover?(attribute)
+          when Regexp then value.match(attribute)
+          when Array then value.include?(attribute)
+          when Enumerable then value.include?(attribute)
+          else attribute == value
+          end
         end
       end
 
@@ -75,7 +79,7 @@ module CanCan
             rule.conditions.each do |key, value|
               key = id_key if %i[id _id].include?(key.to_sym)
               res <<  case value
-                      when Array then { key => { '$in' => value } }
+                      when Array then { key => { "$in" => value } }
                       else { key => value }
                       end
             end
@@ -88,11 +92,15 @@ module CanCan
           condition_rules.reject(&:base_behavior).each_with_object([]) do |rule, res|
             rule.conditions.each do |key, value|
               key = id_key if %i[id _id].include?(key.to_sym)
-              res <<  case value
-                      when Regexp then { key => { '$not' => value } }
-                      when Array then { key => { '$nin' => value } }
-                      else { key => { '$ne' => value } }
-                      end
+              case value
+              when Regexp then res << { key => { "$not" => value } }
+              else
+                if prev_value = res.detect { |item| item.dig(key, "$nin") }
+                  prev_value[key]["$nin"] += Array(value)
+                else
+                  res << { key => { "$nin" => Array(value) } }
+                end
+              end
             end
           end
         end
@@ -100,6 +108,7 @@ module CanCan
 
       def subject_type_conditions
         return unless open_subject_types.present?
+
         { :"#{type_key}".nin => closed_subject_types.map(&:to_s) }
       end
 
@@ -112,13 +121,13 @@ module CanCan
       def database_records
         return @model_class.none unless has_any_conditions?
 
-        or_conditions = { '$or' => ([subject_type_conditions, *open_conditions]).compact }
-        or_conditions = nil if or_conditions['$or'].empty?
+        or_conditions = { "$or" => [subject_type_conditions, *open_conditions].compact }
+        or_conditions = {} if or_conditions["$or"].empty?
 
-        and_conditions = { '$and' => [or_conditions, *closed_conditions].compact }
-        and_conditions = nil if and_conditions['$and'].empty?
+        and_conditions = { "$and" => [*closed_conditions].compact }
+        and_conditions = {} if and_conditions["$and"].empty?
 
-        @model_class.where(and_conditions)
+        @model_class.where(or_conditions.merge(and_conditions))
       end
 
       private
@@ -142,11 +151,11 @@ module CanCan
       end
 
       def id_key
-        @id_key ||= [prefix, '_id'].reject(&:blank?).join.to_sym
+        @id_key ||= [prefix, "_id"].reject(&:blank?).join.to_sym
       end
 
       def type_key
-        @type_key ||= [prefix, '_type'].reject(&:blank?).join.to_sym
+        @type_key ||= [prefix, "_type"].reject(&:blank?).join.to_sym
       end
     end
   end

data/lib/cancancan/model_additions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CanCan
   # This module adds the accessible_by class method to a model. It is included in the model adapters.
   module ModelAdditions

data/lib/mongoid_ability/ability.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cancancan'
 
 module MongoidAbility
@@ -17,7 +19,7 @@ module MongoidAbility
     end
 
     def self.subject_classes
-      Object.descendants.select do |cls|
+      ObjectSpace.each_object(Class).select do |cls|
         cls.included_modules.include?(MongoidAbility::Subject)
       end
     end

data/lib/mongoid_ability/find_lock.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MongoidAbility
   # finds first lock that controls specified params
 
@@ -26,8 +28,6 @@ module MongoidAbility
       subject_type.constantize
     end
 
-    # ---------------------------------------------------------------------
-
     class FindDefaultLock < FindLock
       def call
         locks = subject_class.default_locks.for_action(action)

data/lib/mongoid_ability/lock.rb

@@ -1,97 +1,82 @@
-require 'mongoid'
+# frozen_string_literal: true
 
 module MongoidAbility
   module Lock
-    def self.included(base)
-      base.extend ClassMethods
-      base.class_eval do
-        field :action, type: Symbol, default: :read
-        field :outcome, type: Boolean, default: false
-        field :opts, as: :options, type: Hash, default: {}
-
-        belongs_to :subject, polymorphic: true, optional: true
-        # Mongoid 7 does not support `touch: true` on polymorphic associations
-        after_save -> { subject.touch if subject? }
-        after_destroy -> { subject.touch if subject? }
-        after_touch -> { subject.touch if subject? }
-
-        # TODO: validate that action is defined on subject or its superclasses
-        validates :action, presence: true, uniqueness: { scope: [:subject_type, :subject_id, :outcome] }
-        validates :outcome, presence: true
-
-        scope :for_action, ->(action) { where(action: action.to_sym) }
-
-        scope :for_subject_type, ->(subject_type) { where(subject_type: subject_type.to_s) }
-        scope :for_subject_types, ->(subject_types) { criteria.in(subject_type: subject_types) }
-
-        scope :for_subject_id, ->(subject_id) {
-          return where(subject_id: nil) unless subject_id.present?
-          where(subject_id: BSON::ObjectId.from_string(subject_id))
-        }
-
-        scope :for_subject, ->(subject) {
-          return where(subject_id: nil) unless subject.present?
-          where(subject_type: subject.class.model_name, subject_id: subject.id)
-        }
-
-        scope :class_locks, -> { where(subject_id: nil) }
-        scope :id_locks, -> { ne(subject_id: nil) }
-      end
+    extend ActiveSupport::Concern
+
+    included do
+      field :action, type: Symbol, default: :read
+      field :outcome, type: Mongoid::Boolean, default: false
+      field :opts, as: :options, type: Hash, default: {}
+
+      belongs_to :subject, polymorphic: true, optional: true
+      # Mongoid 7 does not support `touch: true` on polymorphic associations
+      after_save -> { subject.touch if subject? }
+      after_destroy -> { subject.touch if subject? }
+      after_touch -> { subject.touch if subject? }
+
+      # TODO: validate that action is defined on subject or its superclasses
+      validates :action, presence: true, uniqueness: { scope: [:subject_type, :subject_id, :outcome] }
+      validates :outcome, presence: true
+
+      scope :for_action, ->(action) { where(action: action.to_sym) }
+
+      scope :for_subject_type, ->(subject_type) { where(subject_type: subject_type.to_s) }
+      scope :for_subject_types, ->(subject_types) { criteria.in(subject_type: subject_types) }
+
+      scope :for_subject_id, ->(subject_id) {
+        return where(subject_id: nil) unless subject_id.present?
+        where(subject_id: BSON::ObjectId.from_string(subject_id))
+      }
+
+      scope :for_subject, ->(subject) {
+        return where(subject_id: nil) unless subject.present?
+        where(subject_type: subject.class.model_name, subject_id: subject.id)
+      }
+
+      scope :class_locks, -> { where(subject_id: nil) }
+      scope :id_locks, -> { ne(subject_id: nil) }
+    end
+
+    def self.sort
+      -> (a, b) {
+        [a.subject_type, a.subject_id.to_s, a.action, (a.outcome ? -1 : 1)] <=>
+          [b.subject_type, b.subject_id.to_s, b.action, (b.outcome ? -1 : 1)]
+      }
     end
 
-    concerning :LockType do
-      def class_lock?
-        !id_lock?
-      end
+    def class_lock?
+      !id_lock?
+    end
 
-      def id_lock?
-        subject_id.present?
-      end
+    def id_lock?
+      subject_id.present?
     end
 
-    concerning :Outcome do
-      def open?
-        outcome
-      end
+    def open?
+      outcome
+    end
 
-      def closed?
-        !open?
-      end
+    def closed?
+      !open?
     end
 
     # calculates outcome as if this lock is not present
-    concerning :InheritedOutcome do
-      def inherited_outcome(options = {})
-        return outcome unless owner.present?
-        cloned_owner = owner.clone
-        cloned_owner.locks_relation = cloned_owner.locks_relation - [self]
-        cloned_ability = MongoidAbility::Ability.new(cloned_owner)
-
-        cloned_ability.can?(action, (subject.present? ? subject : subject_class), options)
-      end
-    end
+    def inherited_outcome(options = {})
+      return outcome unless owner.present?
+      cloned_owner = owner.clone
+      cloned_owner.locks_relation = cloned_owner.locks_relation - [self]
+      cloned_ability = MongoidAbility::Ability.new(cloned_owner)
 
-    concerning :Subject do
-      def subject_class
-        subject_type.constantize
-      end
+      cloned_ability.can?(action, (subject.present? ? subject : subject_class), options)
     end
 
-    concerning :Group do
-      def group_key_for_calc
-        [subject_type, subject_id, action, options]
-      end
+    def subject_class
+      subject_type.constantize
     end
 
-    concerning :Sort do
-      class_methods do
-        def sort
-          -> (a, b) {
-            [a.subject_type, a.subject_id.to_s, a.action, (a.outcome ? -1 : 1)] <=>
-              [b.subject_type, b.subject_id.to_s, b.action, (b.outcome ? -1 : 1)]
-          }
-        end
-      end
+    def group_key_for_calc
+      [subject_type, subject_id, action, options]
     end
   end
 end

data/lib/mongoid_ability/locks_decorator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MongoidAbility
   # adds scope-like methods on top of an Array containing locks
 

data/lib/mongoid_ability/owner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MongoidAbility
   module Owner
     def self.included(base)

data/lib/mongoid_ability/subject.rb

@@ -1,3 +1,11 @@
+# frozen_string_literal: true
+
+# TODO: rewrite as concern, use proc for the _type or consider either using
+# discriminator_key or maybe even better add our own configurable discriminator
+# key (.ability_subject_discriminator_key), to not rely on mongoid internals?
+#
+# https://github.com/mongodb/mongoid/blob/01ee33970c5e9cefe436528c56c32e843f474e9b/lib/mongoid/traversable.rb
+
 module MongoidAbility
   module Subject
     def self.included(base)
@@ -6,7 +14,9 @@ module MongoidAbility
         include Mongoid::Touchable::InstanceMethods
 
         # always set the _type field as it is used by :accessible_by queries
-        field :_type, type: String, default: model_name
+        # FIXME: removing this line should in theory break non SCI object, but
+        # it doesn't ...
+        # field :_type, type: String, default: model_name
       end
     end
 

data/lib/mongoid_ability/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MongoidAbility
-  VERSION = '3.0.0'.freeze
+  VERSION = '3.0.2'.freeze
 end

data/lib/mongoid_ability.rb

@@ -15,8 +15,6 @@ require 'mongoid_ability/subject'
 require 'mongoid_ability/locks_decorator'
 require 'mongoid_ability/find_lock'
 
-# ---------------------------------------------------------------------
-
 if defined?(Rails)
   class ActionController::Base
     def current_ability

data/mongoid_ability.gemspec

@@ -19,13 +19,13 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'cancancan', '~> 2.2'
-  spec.add_dependency 'mongoid', '~> 7.0', '>= 7.0.2'
+  spec.add_dependency 'mongoid'
 
+  spec.add_development_dependency 'appraisal'
   spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'coveralls'
-  spec.add_development_dependency 'database_cleaner', '>= 1.5.1'
+  spec.add_development_dependency 'database_cleaner-mongoid'
   spec.add_development_dependency 'guard'
   spec.add_development_dependency 'guard-minitest'
   spec.add_development_dependency 'minitest'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake'
 end