mongoid 8.1.4 → 9.0.0

data/lib/rails/generators/mongoid_generator.rb

@@ -1,12 +1,18 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 require "rails/generators/named_base"
 require "rails/generators/active_model"
 
 module Mongoid
   module Generators
+
+    # Base generator class for adding Mongoid to Rails applications.
     class Base < ::Rails::Generators::NamedBase
 
+      # Returns the path to the templates directory.
+      #
+      # @return [ String ] The path.
       def self.source_root
         @_mongoid_source_root ||=
           File.expand_path("../#{base_name}/#{generator_name}/templates", __FILE__)
@@ -17,7 +23,14 @@ end
 
 module Rails
   module Generators
+
+    # Extension to Rails' GeneratedAttribute class.
     class GeneratedAttribute
+
+      # Returns the Mongoid attribute type value for a given
+      # input class type.
+      #
+      # @return [ String ] The type value.
       def type_class
         return "Time" if type == :datetime
         return "String" if type == :text

data/lib/rails/mongoid.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Rails
+
+  # Mongoid utilities for Rails
   module Mongoid
     extend self
 
@@ -13,18 +16,7 @@ module Rails
     #
     # @param [ Application ] app The rails application.
     def load_models(app)
-      app.config.paths["app/models"].expanded.each do |path|
-        preload = ::Mongoid.preload_models
-        if preload.resizable?
-          files = preload.map { |model| "#{path}/#{model.underscore}.rb" }
-        else
-          files = Dir.glob("#{path}/**/*.rb")
-        end
-
-        files.sort.each do |file|
-          load_model(file.gsub("#{path}/" , "").gsub(".rb", ""))
-        end
-      end
+      ::Mongoid.load_models(app.config.paths["app/models"].expanded)
     end
 
     # Conditionally calls `Rails::Mongoid.load_models(app)` if the
@@ -34,22 +26,5 @@ module Rails
     def preload_models(app)
       load_models(app) if ::Mongoid.preload_models
     end
-
-    private
-
-    # I don't want to mock out kernel for unit testing purposes, so added this
-    # method as a convenience.
-    #
-    # @example Load the model.
-    #   Mongoid.load_model("/mongoid/behavior")
-    #
-    # @param [ String ] file The base filename.
-    def load_model(file)
-      begin
-        require_dependency(file)
-      rescue Exception => e
-        Logger.new(STDERR).warn(e.message)
-      end
-    end
   end
 end

data/spec/config/mongoid.yml

@@ -33,7 +33,6 @@ test:
     preload_models: false
     scope_overwrite_exception: false
     raise_not_found_error: true
-    use_activesupport_time_zone: true
     use_utc: false
     log_level: :warn
     belongs_to_required_by_default: false

data/spec/integration/active_job_spec.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
+require 'spec_helper'
+require 'active_job'
+require 'mongoid/railties/bson_object_id_serializer'
+
+describe 'ActiveJob Serialization' do
+  skip unless defined?(ActiveJob)
+
+  class TestBsonObjectIdSerializerJob < ActiveJob::Base
+    def perform(*args)
+      args
+    end
+  end
+
+  let(:band) do
+    Band.create!
+  end
+
+  before do
+    ActiveJob::Serializers.add_serializers(
+      [::Mongoid::Railties::ActiveJobSerializers::BsonObjectIdSerializer]
+    )
+  end
+
+  it 'serializes and deserializes BSON::ObjectId' do
+    expect do
+      TestBsonObjectIdSerializerJob.perform_later(band.id)
+    end.not_to raise_error
+  end
+end

data/spec/integration/app_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 require 'spec_helper'
 
@@ -10,6 +11,15 @@ def check_call(cmd, **opts)
   Mrss::ChildProcessHelper.check_call(cmd, **opts)
 end
 
+def gem_version_argument(version)
+  "_#{version}_" if version
+end
+
+def insert_rails_gem_version(cmd)
+  gem_version = gem_version_argument(SpecConfig.instance.installed_rails_version)
+  cmd.tap { cmd[1,0] = gem_version if gem_version }
+end
+
 describe 'Mongoid application tests' do
   before(:all) do
     unless SpecConfig.instance.app_tests?
@@ -81,55 +91,78 @@ describe 'Mongoid application tests' do
     end
 
     # Exit should be either success or SIGTERM
-    [0, 15, 128 + 15].should include(status)
+    allowed_statuses = [0, 15, 128 + 15]
+    if RUBY_PLATFORM == 'java'
+      # Puma on JRuby exits with status 1 when it receives a TERM signal.
+      allowed_statuses << 1
+    end
+    allowed_statuses.should include(status)
 
     rv
   end
 
-  context 'new application - rails' do
-    it 'creates' do
-      install_rails
+  def prepare_new_rails_app(name)
+    install_rails
 
-      Dir.chdir(TMP_BASE) do
-        FileUtils.rm_rf('mongoid-test')
-        check_call(%w(rails new mongoid-test --skip-spring --skip-active-record), env: clean_env)
+    Dir.chdir(TMP_BASE) do
+      FileUtils.rm_rf(name)
+      check_call(insert_rails_gem_version(%W(rails new #{name} --skip-spring --skip-active-record)), env: clean_env)
 
-        Dir.chdir('mongoid-test') do
-          adjust_app_gemfile
-          check_call(%w(bundle install), env: clean_env)
+      Dir.chdir(name) do
+        adjust_rails_defaults
+        adjust_app_gemfile
+        check_call(%w(bundle install), env: clean_env)
 
-          check_call(%w(rails g model post), env: clean_env)
-          check_call(%w(rails g model comment post:belongs_to), env: clean_env)
+        yield
+      end
+    end
+  end
 
-          # https://jira.mongodb.org/browse/MONGOID-4885
-          comment_text = File.read('app/models/comment.rb')
-          comment_text.should =~ /belongs_to :post/
-          comment_text.should_not =~ /embedded_in :post/
-        end
+  context 'new application - rails' do
+    it 'creates' do
+      prepare_new_rails_app 'mongoid-test' do
+        check_call(%w(rails g model post), env: clean_env)
+        check_call(%w(rails g model comment post:belongs_to), env: clean_env)
+
+        # https://jira.mongodb.org/browse/MONGOID-4885
+        comment_text = File.read('app/models/comment.rb')
+        comment_text.should =~ /belongs_to :post/
+        comment_text.should_not =~ /embedded_in :post/
       end
     end
 
     it 'generates Mongoid config' do
-      install_rails
-
-      Dir.chdir(TMP_BASE) do
-        FileUtils.rm_rf('mongoid-test-config')
-        check_call(%w(rails new mongoid-test-config --skip-spring --skip-active-record), env: clean_env)
-
-        Dir.chdir('mongoid-test-config') do
-          adjust_app_gemfile
-          check_call(%w(bundle install), env: clean_env)
-
-          mongoid_config_file = File.join(TMP_BASE,'mongoid-test-config/config/mongoid.yml')
+      prepare_new_rails_app 'mongoid-test-config' do
+        mongoid_config_file = File.join(TMP_BASE, 'mongoid-test-config/config/mongoid.yml')
+
+        File.exist?(mongoid_config_file).should be false
+        check_call(%w(rails g mongoid:config), env: clean_env)
+        File.exist?(mongoid_config_file).should be true
+
+        config_text = File.read(mongoid_config_file)
+        expect(config_text).to match /mongoid_test_config_development/
+        expect(config_text).to match /mongoid_test_config_test/
+
+        Mongoid::Config::Introspection.options(include_deprecated: true).each do |opt|
+          if opt.deprecated?
+            # deprecated options should not be included
+            expect(config_text).not_to include "# #{opt.name}:"
+          else
+            block = "    #{opt.indented_comment(indent: 4)}\n" \
+                    "    # #{opt.name}: #{opt.default}\n"
+            expect(config_text).to include block
+          end
+        end
+      end
+    end
 
-          File.exist?(mongoid_config_file).should be false
-          check_call(%w(rails g mongoid:config), env: clean_env)
-          File.exist?(mongoid_config_file).should be true
+    it 'generates Mongoid initializer' do
+      prepare_new_rails_app 'mongoid-test-init' do
+        mongoid_initializer = File.join(TMP_BASE, 'mongoid-test-init/config/initializers/mongoid.rb')
 
-          config_text = File.read(mongoid_config_file)
-          config_text.should =~ /mongoid_test_config_development/
-          config_text.should =~ /mongoid_test_config_test/
-        end
+        File.exist?(mongoid_initializer).should be false
+        check_call(%w(rails g mongoid:config), env: clean_env)
+        File.exist?(mongoid_initializer).should be true
       end
     end
   end
@@ -272,7 +305,7 @@ describe 'Mongoid application tests' do
     gemfile_lines << "gem 'mongoid', path: '#{File.expand_path(BASE)}'\n"
     if rails_version
       gemfile_lines.delete_if do |line|
-        line =~ /rails/
+        line =~ /gem ['"]rails['"]/
       end
       if rails_version == 'master'
         gemfile_lines << "gem 'rails', git: 'https://github.com/rails/rails'\n"

data/spec/integration/associations/belongs_to_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 require 'spec_helper'
 require_relative '../../mongoid/association/referenced/has_one_models'

data/spec/integration/associations/embedded_dirty_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 require 'spec_helper'
 require_relative '../../mongoid/association/embedded/embeds_many_models'

data/spec/integration/associations/embedded_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 require 'spec_helper'
 require_relative '../../mongoid/association/embedded/embeds_many_models'
@@ -178,8 +179,6 @@ describe 'embedded associations' do
         let(:parent) { EomParent.create! }
 
         it 'updates' do
-          pending 'https://jira.mongodb.org/browse/MONGOID-3252'
-
           first_updated_at = parent.updated_at
 
           parent.child = EomChild.new
@@ -193,8 +192,6 @@ describe 'embedded associations' do
         let(:parent) { EmmCongress.create! }
 
         it 'updates' do
-          pending 'https://jira.mongodb.org/browse/MONGOID-3252'
-
           first_updated_at = parent.updated_at
 
           parent.legislators << EmmLegislator.new
@@ -238,8 +235,6 @@ describe 'embedded associations' do
         let(:parent) { EomParent.create!(child: EomChild.new) }
 
         it 'updates' do
-          pending 'https://jira.mongodb.org/browse/MONGOID-3252'
-
           first_updated_at = parent.updated_at
 
           parent.child = nil
@@ -280,4 +275,78 @@ describe 'embedded associations' do
       expect(user.orders.sum(:amount)).to eq(500)
     end
   end
+
+  context 'when modifying an embedded document & removing another embedded document' do
+    let(:user) do
+      EmmUser.create!(orders: [
+        EmmOrder.new(sku: 0, amount: 0),
+        EmmOrder.new(sku: 1, amount: 1),
+        EmmOrder.new(sku: 2, amount: 2),
+      ])
+    end
+
+    context 'when modifying first and removing second' do
+      it 'works correctly' do
+        user.orders[1].assign_attributes(amount: 10)
+        user.orders[0].destroy
+        user.save!
+        user.reload
+
+        user.orders.map do
+          |order| [order.sku, order.amount]
+        end.should == [[1, 10], [2, 2]]
+      end
+    end
+
+    context 'when removing first and modifying second' do
+      it 'works correctly' do
+        user.orders[0].destroy
+        user.orders[1].assign_attributes(amount: 20)
+        user.save!
+        user.reload
+
+        user.orders.map do
+          |order| [order.sku, order.amount]
+        end.should == [[1, 1], [2, 20]]
+      end
+    end
+  end
+
+  context 'when modifying a nested embedded document & removing another nested embedded document' do
+    let(:user) do
+      EmmUser.create!(orders: [
+        EmmOrder.new(sku: 0, surcharges: [EmmSurcharge.new(amount: 0)]),
+        EmmOrder.new(sku: 1, surcharges: [EmmSurcharge.new(amount: 1)]),
+        EmmOrder.new(sku: 2, surcharges: [EmmSurcharge.new(amount: 2)]),
+      ])
+    end
+
+    context 'when modifying first and removing second' do
+      it 'works correctly' do
+        pending 'MONGOID-5364'
+
+        user.orders[1].assign_attributes(surcharges: [amount: 10])
+        user.orders[0].destroy
+        user.save!
+        user.reload
+
+        user.orders.map do
+          |order| [order.sku, order.surcharges.first.amount]
+        end.should == [[1, 10], [2, 2]]
+      end
+    end
+
+    context 'when removing first and modifying second' do
+      it 'works correctly' do
+        user.orders[0].destroy
+        user.orders[1].assign_attributes(surcharges: [amount: 20])
+        user.save!
+        user.reload
+
+        user.orders.map do
+          |order| [order.sku, order.surcharges.first.amount]
+        end.should == [[1, 1], [2, 20]]
+      end
+    end
+  end
 end

data/spec/integration/associations/embeds_many_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 require 'spec_helper'
 

data/spec/integration/associations/embeds_one_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 require 'spec_helper'
 

data/spec/integration/associations/foreign_key_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 require 'spec_helper'
 require_relative './foreign_key_spec_models'

data/spec/integration/associations/foreign_key_spec_models.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module ForeignKeySpec
   class Company

data/spec/integration/associations/has_and_belongs_to_many_spec.rb

@@ -1,7 +1,30 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 require 'spec_helper'
 
+module HabtmSpec
+  class Page
+    include Mongoid::Document
+    embeds_many :blocks, class_name: 'HabtmSpec::Block'
+  end
+
+  class Block
+    include Mongoid::Document
+    embedded_in :page, class_name: 'HabtmSpec::Page'
+  end
+
+  class ImageBlock < Block
+    has_and_belongs_to_many :attachments, inverse_of: nil, class_name: 'HabtmSpec::Attachment'
+    accepts_nested_attributes_for :attachments
+  end
+
+  class Attachment
+    include Mongoid::Document
+    field :file, type: String
+  end
+end
+
 describe 'has_and_belongs_to_many associations' do
 
   context 'when an anonymous class defines a has_and_belongs_to_many association' do
@@ -18,4 +41,22 @@ describe 'has_and_belongs_to_many associations' do
       expect(klass.new.movies.build).to be_a Movie
     end
   end
+
+  context 'when an embedded has habtm relation' do
+    let(:attachment) { HabtmSpec::Attachment.create!(file: 'foo.jpg') }
+
+    let(:page) { HabtmSpec::Page.create! }
+
+    let(:image_block) do
+      image_block = page.blocks.build({
+        _type: 'HabtmSpec::ImageBlock',
+        attachment_ids: [ attachment.id.to_s ],
+        attachments_attributes: { '1234' => { file: 'bar.jpg', id: attachment.id.to_s } }
+      })
+    end
+
+    it 'does not raise on save' do
+      expect { image_block.save! }.not_to raise_error
+    end
+  end
 end

data/spec/integration/associations/has_many_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 require 'spec_helper'
 require 'mongoid/association/referenced/has_many_models'

data/spec/integration/associations/has_one_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 require 'spec_helper'
 require 'mongoid/association/referenced/has_one_models'

data/spec/integration/associations/nested_attributes_assignment_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 require 'spec_helper'
 

data/spec/integration/associations/reverse_population_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 require 'spec_helper'
 require_relative './reverse_population_spec_models'

data/spec/integration/associations/reverse_population_spec_models.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module ReversePopulationSpec
   class Company

data/spec/integration/associations/scope_option_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 require 'spec_helper'
 require_relative '../../mongoid/association/referenced/has_and_belongs_to_many_models'

data/spec/integration/atomic/modifiers_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 require "spec_helper"
 

data/spec/integration/bson_regexp_raw_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 require 'spec_helper'
 

data/spec/integration/callbacks_models.rb

@@ -1,3 +1,4 @@
+# rubocop:todo all
 class Galaxy
   include Mongoid::Document
   include Mongoid::Timestamps
@@ -23,7 +24,7 @@ class Star
   include Mongoid::Document
   include Mongoid::Timestamps
 
-  embedded_in :galaxy
+  embedded_in :galaxy, touch: true
 
   field :age, type: Integer
   field :was_touched_after_parent, type: Mongoid::Boolean, default: false
@@ -47,7 +48,7 @@ class Planet
   include Mongoid::Document
   include Mongoid::Timestamps
 
-  embedded_in :star
+  embedded_in :star, touch: true
 
   field :age, type: Integer
   field :was_touched_after_parent, type: Mongoid::Boolean, default: false

data/spec/integration/callbacks_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 require 'spec_helper'
 require_relative './callbacks_models'
@@ -585,7 +586,7 @@ describe 'callbacks integration tests' do
 
   context 'cascade callbacks' do
     ruby_version_gte '3.0'
-    config_override :around_callbacks_for_embeds, false
+    require_mri
 
     let(:book) do
       Book.new

data/spec/integration/contextual/empty_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 require 'spec_helper'