mongoid-rspec 4.1.0 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c59448b4e72ebb718332a28e7ddf77de5b792a09ea273b75959930e2c6c2918
-  data.tar.gz: b1818ed7a513db7a4e31bcdd5a492504a75becfc866dd95505192da1db7a56cc
+  metadata.gz: 0ff9e91940ac839c482f01b93f825a4f30ed64dcf3f4210053a5cac6a490cbbc
+  data.tar.gz: 73b94988e7950e2097427412e1c4af87a1413cf891085a53a71924bbae9466ca
 SHA512:
-  metadata.gz: 995c284d71146d52d554e8eff18e48605e76546ebce9428674d1fcefe4c560a73973651f4eb4496d21a839fb35944c37f98cc21eb78ddd1e1eea80a57d1392c4
-  data.tar.gz: a2e400ead572f31c614a294f1d5d10116e08fa6f152b2f58cf112da45608a3d72be2c5893ceb035c8a6f514af8ef55bcfdffd0a55a81a2e0f97ad43fd0699cf2
+  metadata.gz: 14504bfe14678c3c4df1eb85438438ab5b705f22ad36bc209bfd15d1bbeb4cc59ab09c0e8227682f8960f8db6cadc7c8731e8ab617d7f1d075e98f06a1085bdc
+  data.tar.gz: 4ae265834c188a9236e6c697345f70c5e16fc27c250076c72486030ae3ebc3cb62f1da00df5fefbf5bfd8dabb4e8dd29c26d80d26a1638e9a7e58d8824c2aa03

data/README.md

@@ -1,10 +1,20 @@
 # [mongoid-rspec](https://github.com/mongoid/mongoid-rspec "A collection of RSpec-compatible matchers that help to test Mongoid documents.")
 
-[![Build Status](https://travis-ci.org/mongoid/mongoid-rspec.svg?branch=master)](https://travis-ci.org/mongoid/mongoid-rspec)
 [![Gem Version](https://badge.fury.io/rb/mongoid-rspec.svg)](https://badge.fury.io/rb/mongoid-rspec)
+[![Test Status](https://github.com/mongoid/mongoid-rspec/actions/workflows/rspec.yml/badge.svg?branch=master)](https://github.com/mongoid/mongoid-rspec/actions/workflows/rspec.yml?query=branch%3Amaster)
+[![Rubocop Status](https://github.com/mongoid/mongoid-rspec/actions/workflows/rubocop.yml/badge.svg?branch=master)](https://github.com/mongoid/mongoid-rspec/actions/workflows/rubocop.yml?query=branch%3Amaster)
+[![Coverage Status](https://coveralls.io/repos/github/mongoid/mongoid-rspec/badge.svg?branch=master)](https://coveralls.io/github/mongoid/mongoid-rspec?branch=master)
+
+CI collects SimpleCov coverage on Ruby 3.4 with Mongoid 9 and MongoDB 8.0 and submits one report to Coveralls using GitHub's workflow token. To generate a local report, run `COVERAGE=true BUNDLE_GEMFILE=gemfiles/mongoid_9.gemfile bundle install` followed by `COVERAGE=true BUNDLE_GEMFILE=gemfiles/mongoid_9.gemfile bundle exec rake spec`. Reports are written to `coverage/`.
 
 The mongoid-rspec library provides a collection of RSpec-compatible matchers that help to test Mongoid documents.
 
+[Tested](https://github.com/mongoid/mongoid-rspec/actions/workflows/rspec.yml) against:
+- MRI: `2.6.x`, `2.7.x`, `3.0.x`, `3.1.x`, `3.2.x`
+- Mongoid: `4`, `5`, `6`, `7`, `8`, `9`
+
+See [.github/workflows/rspec.yml](.github/workflows/rspec.yml) for the latest test matrix.
+
 ## Installation
 
 Drop this line into your Gemfile:
@@ -18,7 +28,7 @@ end
 
 ## Compatibility
 
-This gem is compatible with Mongoid 3, 4, 5, 6 and 7.
+This gem is compatible with Mongoid 3, 4, 5, 6, 7, 8, 9.
 
 ## Configuration
 
@@ -181,7 +191,7 @@ end
 
 ```ruby
 class Article
-  index({ title: 1 }, { unique: true, background: true, drop_dups: true })
+  index({ title: 1 }, { unique: true, background: true })
   index({ title: 1, created_at: -1 })
   index({ category: 1 })
 end
@@ -190,7 +200,7 @@ RSpec.describe Article, type: :model do
   it do
     is_expected
       .to have_index_for(title: 1)
-      .with_options(unique: true, background: true, drop_dups: true)
+      .with_options(unique: true, background: true)
   end
   it { is_expected.to have_index_for(title: 1, created_at: -1) }
   it { is_expected.to have_index_for(category: 1) }
@@ -201,9 +211,9 @@ end
 
 ```ruby
 RSpec.describe Article do
-  it { is_expected.to have_field(:published).of_type(Boolean).with_default_value_of(false) }
-  it { is_expected.to have_field(:allow_comments).of_type(Boolean).with_default_value_of(true) }
-  it { is_expected.not_to have_field(:allow_comments).of_type(Boolean).with_default_value_of(false) }
+  it { is_expected.to have_field(:published).of_type(Mongoid::Boolean).with_default_value_of(false) }
+  it { is_expected.to have_field(:allow_comments).of_type(Mongoid::Boolean).with_default_value_of(true) }
+  it { is_expected.not_to have_field(:allow_comments).of_type(Mongoid::Boolean).with_default_value_of(false) }
   it { is_expected.not_to have_field(:number_of_comments).of_type(Integer).with_default_value_of(1) }
 end
 
@@ -249,6 +259,27 @@ RSpec.describe Article do
   it { is_expected.to embed_many(:comments) }
 end
 
+# when the touch option is provided, then we can also verify that it is set
+
+# by default, with_touch matches true when no parameters are provided
+describe Article do
+  it { is_expected.to belong_to(:author).of_type(User).as_inverse_of(:articles).with_index.with_touch }
+end
+
+# parameters are supported for explicit matching
+describe Comment do
+  it { is_expected.to be_embedded_in(:article).as_inverse_of(:comments).with_polymorphism.with_touch(true) }
+end
+
+describe Permalink do
+  it { is_expected.to be_embedded_in(:linkable).as_inverse_of(:link).with_touch(false) } 
+end
+
+# touch can also take a symbol representing a field on the parent to touch
+describe Record do
+  it { is_expected.to belong_to(:user).as_inverse_of(:record).with_touch(:record_updated_at) }
+end
+
 RSpec.describe Comment do
   it { is_expected.to be_embedded_in(:article).as_inverse_of(:comments) }
   it { is_expected.to belong_to(:user).as_inverse_of(:comments) }
@@ -315,6 +346,22 @@ RSpec.describe Person do
    # should redefine the kind method to return :custom, i.e. "def self.kind() :custom end"
   it { is_expected.to custom_validate(:ssn).with_validator(SsnValidator) }
 end
+
+# If you're using validators with if/unless conditionals, spec subject must be object instance
+# This is supported on Mongoid 4 and newer
+Rspec.describe User do
+  context 'when user has `admin` role' do
+    subject { User.new(role: 'admin') }
+
+    it { is_expected.to validate_length_of(:password).greater_than(20) }
+  end
+
+  context 'when user does not have `admin` role' do
+    subject { User.new(role: 'member') }
+
+    it { is_expected.not_to validate_length_of(:password) }
+  end
+end
 ```
 
 ### Mass Assignment Matcher

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.push File.expand_path('../lib', __FILE__)
 
 require 'bundler'
@@ -14,7 +16,4 @@ RSpec::Core::RakeTask.new(:rcov) do |spec|
   spec.rcov = true
 end
 
-require 'rubocop/rake_task'
-RuboCop::RakeTask.new(:rubocop)
-
-task default: %i[rubocop spec]
+task default: %i[spec]

data/lib/matchers/accept_nested_attributes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mongoid
   module Matchers # :nodoc:
     # Ensures that the model can accept nested attributes for the specified

data/lib/matchers/allow_mass_assignment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # this code is totally extracted from shoulda-matchers gem.
 module Mongoid
   module Matchers

data/lib/matchers/associations.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 if Mongoid::Compatibility::Version.mongoid7_or_newer?
   require 'mongoid/association'
 else
@@ -30,7 +32,7 @@ module Mongoid
           @association = {}
           @association[:name] = name.to_s
           @association[:type] = association_type
-          @expectation_message = "#{type_description} #{@association[:name].inspect}"
+          @expectation_message = +"#{type_description} #{@association[:name].inspect}"
           @expectation_message << " of type #{@association[:class].inspect}" unless @association[:class].nil?
         end
 
@@ -119,6 +121,12 @@ module Mongoid
           self
         end
 
+        def with_touch(touch = true)
+          @association[:touch] = touch
+          @expectation_message << " which specifies touch as #{@association[:touch]}"
+          self
+        end
+
         def with_optional
           @association[:optional] = true
           @expectation_message << " which specifies optional as #{@association[:optional]}"
@@ -272,6 +280,15 @@ module Mongoid
             end
           end
 
+          unless @association[:touch].nil?
+            if metadata.options[:touch] != @association[:touch]
+              @negative_result_message = "#{@positive_result_message} which sets touch as #{metadata.options[:touch].inspect}"
+              return false
+            else
+              @positive_result_message = "#{@positive_result_message} which sets touch as #{metadata.options[:touch].inspect}"
+            end
+          end
+
           if @association[:optional]
             if metadata.options[:optional] != true
               @negative_result_message = "#{@positive_result_message} which did not set optional"
@@ -303,19 +320,19 @@ module Mongoid
           type ||= @association[:type]
           case type.name
           when EMBEDS_ONE.name
-            (passive ? 'embed' : 'embeds') << ' one'
+            +(passive ? 'embed' : 'embeds') << ' one'
           when EMBEDS_MANY.name
-            (passive ? 'embed' : 'embeds') << ' many'
+            +(passive ? 'embed' : 'embeds') << ' many'
           when EMBEDDED_IN.name
-            (passive ? 'be' : 'is') << ' embedded in'
+            +(passive ? 'be' : 'is') << ' embedded in'
           when HAS_ONE.name
-            (passive ? 'reference' : 'references') << ' one'
+            +(passive ? 'reference' : 'references') << ' one'
           when HAS_MANY.name
-            (passive ? 'reference' : 'references') << ' many'
+            +(passive ? 'reference' : 'references') << ' many'
           when HAS_AND_BELONGS_TO_MANY.name
-            (passive ? 'reference' : 'references') << ' and referenced in many'
+            +(passive ? 'reference' : 'references') << ' and referenced in many'
           when BELONGS_TO.name
-            (passive ? 'be referenced in' : 'referenced in')
+            +(passive ? 'be referenced in' : 'referenced in')
           else
             raise format("Unknown association type '%s'", type)
           end

data/lib/matchers/be_dynamic_document.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mongoid
   module Matchers
     def be_dynamic_document

data/lib/matchers/be_mongoid_document.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mongoid
   module Matchers
     def be_mongoid_document

data/lib/matchers/be_stored_in.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mongoid
   module Matchers
     def be_stored_in(options)

data/lib/matchers/have_field.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mongoid
   module Matchers
     class HaveField # :nodoc:
@@ -30,7 +32,7 @@ module Mongoid
         @errors = []
         @attributes.each do |attr|
           if @klass.fields.include?(attr)
-            error = ''
+            error = +''
             if @type && (@klass.fields[attr].type != @type)
               error << " of type #{@klass.fields[attr].type}"
             end
@@ -47,7 +49,7 @@ module Mongoid
               error << " with alias #{@klass.fields[attr].options[:as]}"
             end
 
-            @errors.push("field #{attr.inspect}" << error) unless error.blank?
+            @errors.push("field #{attr.inspect}#{error}") unless error.blank?
 
             if @localized
               unless @klass.fields[attr].localized?
@@ -74,7 +76,7 @@ module Mongoid
       alias failure_message_when_negated failure_message_for_should_not
 
       def description
-        desc = "have #{@attributes.size > 1 ? 'fields' : 'field'} named #{@attributes.collect(&:inspect).to_sentence}"
+        desc = +"have #{@attributes.size > 1 ? 'fields' : 'field'} named #{@attributes.collect(&:inspect).to_sentence}"
         desc << " of type #{@type.inspect}" if @type
         desc << " with alias #{@field_alias}" if @field_alias
         desc << " with default value of #{@default.inspect}" unless @default.nil?

data/lib/matchers/have_timestamps.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mongoid
   module Matchers
     def have_timestamps
@@ -6,7 +8,7 @@ module Mongoid
 
     class HaveTimestamps
       def initialize
-        @root_module = 'Mongoid::Timestamps'
+        @root_module = +'Mongoid::Timestamps'
       end
 
       def matches?(actual)
@@ -15,7 +17,7 @@ module Mongoid
       end
 
       def for(phase)
-        raise('You\'ve already declared timetamp\'s sub-module via "for" clause') if @submodule
+        raise('You\'ve already declared timestamp\'s sub-module via "for" clause') if @submodule
 
         case @phase = phase.to_sym
         when :creating then @submodule = 'Created'
@@ -33,7 +35,7 @@ module Mongoid
       end
 
       def description
-        desc = 'be a Mongoid document with'
+        desc = +'be a Mongoid document with'
         desc << ' shorted' if @shortened
         desc << " #{@phase}" if @phase
         desc << ' timestamps'

data/lib/matchers/indexes/have_index_for.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mongoid
   module Matchers
     class HaveIndexForBase

data/lib/matchers/indexes/v3/have_index_for.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mongoid
   module Matchers
     def have_index_for(index_key)
@@ -36,7 +38,7 @@ module Mongoid
       alias failure_message_when_negated failure_message_for_should_not
 
       def description
-        desc = "have an index for #{index_key.inspect}"
+        desc = +"have an index for #{index_key.inspect}"
         desc << " with options of #{index_options.inspect}" if index_options
         desc
       end
@@ -44,7 +46,7 @@ module Mongoid
       private
 
       MAPPINGS = {
-        dropDups: :drop_dups
+        dropDups: :drop_dups # Deprecated from MongoDB 3.0
       }.freeze
 
       def denormalising_options(opts)

data/lib/matchers/indexes/v4/have_index_for.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mongoid
   module Matchers
     def have_index_for(index_key)
@@ -15,7 +17,7 @@ module Mongoid
       end
 
       def failure_message
-        message = "Expected #{model.inspect} to #{description},"
+        message = +"Expected #{model.inspect} to #{description},"
         message << if actual_index.nil?
                      ' found no index'
                    else

data/lib/matchers/validations/absence_of.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 if Mongoid::Compatibility::Version.mongoid4_or_newer?
   module Mongoid
     module Matchers

data/lib/matchers/validations/acceptance_of.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mongoid
   module Matchers
     module Validations

data/lib/matchers/validations/associated.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mongoid
   module Matchers
     module Validations

data/lib/matchers/validations/confirmation_of.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mongoid
   module Matchers
     module Validations

data/lib/matchers/validations/custom_validation_of.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mongoid
   module Matchers
     module Validations
@@ -19,9 +21,9 @@ module Mongoid
         end
 
         def description
-          options_desc = []
+          options_desc = +"validate field #{@field.inspect}"
           options_desc << " with custom validator #{@custom_validator.name}" if @validator
-          "validate field #{@field.inspect}" << options_desc.to_sentence
+          options_desc
         end
 
         private

data/lib/matchers/validations/exclusion_of.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mongoid
   module Matchers
     module Validations
@@ -12,7 +14,7 @@ module Mongoid
         end
 
         def matches?(actual)
-          return false unless result = super(actual)
+          return false unless (result = super(actual))
 
           if @not_allowed_values
             raw_validator_not_allowed_values = @validator.options[:in]
@@ -24,9 +26,9 @@ module Mongoid
 
             allowed_values = @not_allowed_values - validator_not_allowed_values
             if allowed_values.empty?
-              @positive_result_message = @positive_result_message << ' not allowing all values mentioned'
+              @positive_result_message << ' not allowing all values mentioned'
             else
-              @negative_result_message = @negative_result_message << " allowing the following the ff. values: #{allowed_values.inspect}"
+              @negative_result_message << " allowing the following the ff. values: #{allowed_values.inspect}"
               result = false
             end
           end

data/lib/matchers/validations/format_of.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mongoid
   module Matchers
     module Validations

data/lib/matchers/validations/inclusion_of.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mongoid
   module Matchers
     module Validations

data/lib/matchers/validations/length_of.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mongoid
   module Matchers
     module Validations

data/lib/matchers/validations/numericality_of.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mongoid
   module Matchers
     module Validations

data/lib/matchers/validations/presence_of.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mongoid
   module Matchers
     module Validations

data/lib/matchers/validations/uniqueness_of.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mongoid
   module Matchers
     module Validations

data/lib/matchers/validations.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mongoid
   module Matchers
     module Validations
@@ -12,14 +14,15 @@ module Mongoid
           @klass = actual.is_a?(Class) ? actual : actual.class
 
           @validator = @klass.validators_on(@field).detect do |v|
-            (v.kind.to_s == @type) && (!v.options[:on] || on_options_matches?(v))
+            (v.kind.to_s == @type) && (!v.options[:on] || on_options_matches?(v)) &&
+              if_condition_matches?(actual, v) && unless_condition_matches?(actual, v)
           end
 
           if @validator
-            @negative_result_message = "#{@type.inspect} validator on #{@field.inspect}"
-            @positive_result_message = "#{@type.inspect} validator on #{@field.inspect}"
+            @negative_result_message = +"#{@type.inspect} validator on #{@field.inspect}"
+            @positive_result_message = +"#{@type.inspect} validator on #{@field.inspect}"
           else
-            @negative_result_message = "no #{@type.inspect} validator on #{@field.inspect}"
+            @negative_result_message = +"no #{@type.inspect} validator on #{@field.inspect}"
             return false
           end
           @result = true
@@ -40,10 +43,9 @@ module Mongoid
         alias failure_message_when_negated failure_message_for_should_not
 
         def description
-          desc = "have #{@type.inspect} validator on #{@field.inspect}"
+          desc = +"have #{@type.inspect} validator on #{@field.inspect}"
           desc << " on #{@options[:on]}" if @options[:on]
           desc << " with message #{@expected_message.inspect}" if @expected_message
-
           desc
         end
 
@@ -57,13 +59,47 @@ module Mongoid
           self
         end
 
+        def check_conditions
+          @check_conditions = true
+          self
+        end
+
         private
 
+        def if_condition_matches?(actual, validator)
+          return true unless @check_conditions
+          return true unless validator.options[:if]
+
+          check_condition(actual, validator.options[:if])
+        end
+
+        def unless_condition_matches?(actual, validator)
+          return true unless @check_conditions
+          return true unless validator.options[:unless]
+
+          !check_condition(actual, validator.options[:unless])
+        end
+
+        def check_condition(actual, filter)
+          raise ArgumentError, 'Spec subject must be an instance when using .check_conditions' if actual.is_a?(Class)
+
+          case filter
+          when Symbol
+            actual.send(filter)
+          when ::Proc
+            filter.arity.zero? ? actual.instance_exec(&filter) : filter.call(actual)
+          when Array
+            filter.all? { |f| check_condition(actual, f) }
+          else
+            raise ArgumentError, "Unexpected filter: #{filter.inspect}"
+          end
+        end
+
         def check_on
           validator_on_methods = [@validator.options[:on]].flatten
 
           if validator_on_methods.any?
-            message = " on methods: #{validator_on_methods}"
+            message = +" on methods: #{validator_on_methods}"
 
             if on_options_covered_by?(@validator)
               @positive_result_message << message

data/lib/mongoid/rspec/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Mongoid
   module RSpec
-    VERSION = '4.1.0'.freeze
+    VERSION = '4.3.0'
   end
 end

data/lib/mongoid/rspec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 
 require 'mongoid'

data/lib/mongoid-rspec.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'mongoid/rspec'