mongoid 6.4.8 → 7.0.13

data/lib/rails/generators/mongoid/config/config_generator.rb

@@ -13,7 +13,14 @@ module Mongoid
       end
 
       def app_name
-        Rails::Application.subclasses.first.parent.to_s.underscore
+        app_cls = Rails.application.class
+        parent = begin
+          # Rails 6.1+
+          app_cls.module_parent_name
+        rescue NoMethodError
+          app_cls.parent.to_s
+        end
+        parent.underscore
       end
 
       def create_config_file

data/lib/rails/generators/mongoid/config/templates/mongoid.yml

@@ -149,6 +149,9 @@ development:
     # Application name that is printed to the mongodb logs upon establishing a
     # connection in server versions >= 3.4. Note that the name cannot exceed 128 bytes.
     # app_name: MyApplicationName
+
+    # Use background indexes by default if `background` option not specified. (default: false)
+    # background_indexing: false
 test:
   clients:
     default:

data/lib/rails/generators/mongoid/model/templates/model.rb.tt

@@ -13,7 +13,7 @@ class <%= class_name %><%= " < #{options[:parent].classify}" if options[:parent]
   field :<%= attribute.name %>, type: <%= attribute.type_class %>
 <% end -%>
 <% attributes.select{|attr| attr.reference? }.each do |attribute| -%>
-  embedded_in :<%= attribute.name%>
+  belongs_to :<%= attribute.name%>
 <% end -%>
 end
 <% end -%>

data/spec/README.md

@@ -0,0 +1,18 @@
+# Running Mongoid Tests
+
+## Overview
+### Quick Start
+Spin up a MongoDB deployment against which to run the Mongoid specs. Mongoid specs support a variety of MongoDB topologies, but the simplest is a single MongoDB instance:
+
+    # Launch mongod in one terminal
+    mkdir /tmp/mdb
+    mongod --dbpath /tmp/mdb
+
+Run the test suite in a separate terminal:
+
+    rake
+
+
+## Caveats
+### "Too many open files" error
+On MacOS, you may encounter a "Too many open files" error on the MongoDB server when running the tests. If this happens, stop the server, run the command `ulimit -n 10000` in the same terminal session as the server, and restart the server. This will increase the number of files that can be opened. Then, re-run the tests.

data/spec/app/models/animal.rb

@@ -9,7 +9,8 @@ class Animal
   field :tags, type: Array
 
   embedded_in :person
-  embedded_in :circus
+  embedded_in :circus, class_name: 'Circus' # class_name is necessary because ActiveRecord think the singular of Circus
+                                            # is Circu
 
   validates_format_of :name, without: /\$\$\$/
 

data/spec/app/models/bomb.rb

@@ -1,4 +1,4 @@
 class Bomb
   include Mongoid::Document
-  has_one :explosion, dependent: :delete, autobuild: true
+  has_one :explosion, dependent: :delete_all, autobuild: true
 end

data/spec/app/models/customer.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+class Customer
+  include Mongoid::Document
+
+  field :name
+
+  embeds_one :home_address, class_name: 'CustomerAddress', as: :addressable
+  embeds_one :work_address, class_name: 'CustomerAddress', as: :addressable
+end

data/spec/app/models/customer_address.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+class CustomerAddress
+  include Mongoid::Document
+
+  field :street, type: String
+  field :city, type: String
+  field :state, type: String
+
+  embedded_in :addressable, polymorphic: true
+end

data/spec/app/models/message.rb

@@ -5,7 +5,7 @@ class Message
   field :priority, type: Integer
 
   embedded_in :person
-  has_and_belongs_to_many :receviers, class_name: "Person", inverse_of: nil
+  has_and_belongs_to_many :receivers, class_name: "Person", inverse_of: nil
 
   has_one :post, as: :posteable
 end

data/spec/app/models/minim.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Minimal model, do not add any fields
+class Minim
+  include Mongoid::Document
+  field :name
+end

data/spec/app/models/other_owner_object.rb

@@ -0,0 +1,2 @@
+class OtherOwnerObject
+end

data/spec/app/models/person.rb

@@ -85,7 +85,7 @@ class Person
 
   has_many \
     :posts,
-    dependent: :delete,
+    dependent: :delete_all,
     validate: false do
     def extension
       "Testing"
@@ -105,7 +105,7 @@ class Person
   has_one :account, validate: false
   has_one :cat, dependent: :nullify, validate: false, primary_key: :username
   has_one :book, autobuild: true, validate: false
-  has_one :home, dependent: :delete, validate: false
+  has_one :home, dependent: :delete_all, validate: false
 
   has_and_belongs_to_many \
     :administrated_events,
@@ -114,6 +114,9 @@ class Person
     dependent:  :nullify,
     validate: false
 
+  belongs_to :mother, class_name: 'Person'
+  has_many :children, class_name: 'Person'
+
   accepts_nested_attributes_for :addresses
   accepts_nested_attributes_for :name, update_only: true
   accepts_nested_attributes_for :pet, allow_destroy: true

data/spec/app/models/shipment_address.rb

@@ -1,2 +1,3 @@
 class ShipmentAddress < Address
+  field :shipping_name, localize: true
 end

data/spec/app/models/store_as_dup_test3.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class StoreAsDupTest3
+  include Mongoid::Document
+  embeds_many :store_as_dup_test4s, :store_as => :t
+  field :name
+end

data/spec/app/models/store_as_dup_test4.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class StoreAsDupTest4
+  include Mongoid::Document
+  embedded_in :store_as_dup_test3
+  field :name
+end

data/spec/app/models/updatable.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Updatable
+  include Mongoid::Document
+
+  field :updated_at, type: BSON::Timestamp
+end

data/spec/app/models/vertex.rb

@@ -0,0 +1,6 @@
+class Vertex
+  include Mongoid::Document
+
+  has_and_belongs_to_many :parents, inverse_of: :children, class_name: 'Vertex'
+  has_and_belongs_to_many :children, inverse_of: :parents, class_name: 'Vertex'
+end

data/spec/app/models/wiki_page.rb

@@ -9,6 +9,6 @@ class WikiPage
 
   embeds_many :edits, validate: false
   has_many :comments, dependent: :destroy, validate: false
-  has_many :child_pages, class_name: "WikiPage", dependent: :delete, inverse_of: :parent_pages
+  has_many :child_pages, class_name: "WikiPage", dependent: :delete_all, inverse_of: :parent_pages
   belongs_to :parent_pages, class_name: "WikiPage", inverse_of: :child_pages
 end

data/spec/config/mongoid.yml

@@ -3,7 +3,9 @@ test:
     default:
       database: mongoid_test
       hosts:
-        - <%=ENV["MONGOID_SPEC_HOST"]%>:<%=ENV["MONGOID_SPEC_PORT"]%>
+        <% SpecConfig.instance.addresses.each do |address| %>
+          - <%= address %>
+        <% end %>
       options:
         user: "mongoid-user"
         password: "password"
@@ -13,14 +15,18 @@ test:
           tag_sets:
             - use: web
         max_pool_size: 1
+        server_selection_timeout: 3.14
     reports:
       database: reports
       hosts:
-        - <%=ENV["MONGOID_SPEC_HOST"]%>:<%=ENV["MONGOID_SPEC_PORT"]%>
+        <% SpecConfig.instance.addresses.each do |address| %>
+          - <%= address %>
+        <% end %>
       options:
         user: "mongoid-user"
         password: "password"
         auth_source: "admin"
+        server_selection_timeout: 3.14
   options:
     include_root_in_json: false
     include_type_for_serialization: false
@@ -32,13 +38,17 @@ test:
     log_level: :warn
     belongs_to_required_by_default: false
     app_name: 'testing'
+    background_indexing: false
 test_with_max_staleness:
   clients:
     default:
       database: mongoid_test
       hosts:
-        - <%=ENV["MONGOID_SPEC_HOST"]%>:<%=ENV["MONGOID_SPEC_PORT"]%>
+        <% SpecConfig.instance.addresses.each do |address| %>
+          - <%= address %>
+        <% end %>
       options:
         read:
           mode: :primary_preferred
           max_staleness: 100
+        server_selection_timeout: 3.14

data/spec/integration/app_spec.rb

@@ -0,0 +1,341 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+require 'spec_helper'
+
+BASE = File.join(File.dirname(__FILE__), '../..')
+TMP_BASE = File.join(BASE, 'tmp')
+
+describe 'Mongoid application tests' do
+  before(:all) do
+    unless SpecConfig.instance.app_tests?
+      skip 'Set APP_TESTS=1 in environment to run application tests'
+    end
+
+    require 'fileutils'
+    require 'mrss/child_process_helper'
+    require 'open-uri'
+
+    FileUtils.mkdir_p(TMP_BASE)
+  end
+
+  context 'demo application' do
+    context 'sinatra' do
+      it 'runs' do
+        clone_application(
+          'https://github.com/mongoid/mongoid-demo',
+          subdir: 'sinatra-minimal',
+        ) do
+
+          # JRuby needs a long timeout
+          start_app(%w(bundle exec ruby app.rb), 4567, 40) do |port|
+            uri = URI.parse('http://localhost:4567/posts')
+            resp = JSON.parse(uri.open.read)
+
+            resp.should == []
+
+          end
+        end
+      end
+    end
+
+    context 'rails-api' do
+      it 'runs' do
+        clone_application(
+          'https://github.com/mongoid/mongoid-demo',
+          subdir: 'rails-api',
+        ) do
+
+          # JRuby needs a long timeout
+          start_app(%w(bundle exec rails s), 3000, 50) do |port|
+            uri = URI.parse('http://localhost:3000/posts')
+            resp = JSON.parse(uri.open.read)
+
+            resp.should == []
+          end
+        end
+      end
+    end
+  end
+
+  def start_app(cmd, port, timeout)
+    process = ChildProcess.build(*cmd)
+    process.environment.update(clean_env)
+    process.io.inherit!
+    process.start
+
+    begin
+      wait_for_port(port, timeout, process)
+      sleep 1
+
+      rv = yield port
+    ensure
+      # The process may have already died (due to an error exit) -
+      # in this case killing it will raise an exception.
+      Process.kill('TERM', process.pid) rescue nil
+      status = process.wait
+    end
+
+    # Exit should be either success or SIGTERM
+    [0, 15, 128 + 15].should include(status)
+
+    rv
+  end
+
+  context 'new application - rails' do
+    it 'creates' do
+      install_rails
+
+      Dir.chdir(TMP_BASE) do
+        FileUtils.rm_rf('mongoid-test')
+        Mrss::ChildProcessHelper.check_call(%w(rails new mongoid-test --skip-spring --skip-active-record), env: clean_env)
+
+        Dir.chdir('mongoid-test') do
+          adjust_app_gemfile
+          Mrss::ChildProcessHelper.check_call(%w(bundle install), env: clean_env)
+
+          Mrss::ChildProcessHelper.check_call(%w(rails g model post), env: clean_env)
+          Mrss::ChildProcessHelper.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
+    end
+
+    it 'generates Mongoid config' do
+      install_rails
+
+      Dir.chdir(TMP_BASE) do
+        FileUtils.rm_rf('mongoid-test-config')
+        Mrss::ChildProcessHelper.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
+          Mrss::ChildProcessHelper.check_call(%w(bundle install), env: clean_env)
+
+          mongoid_config_file = File.join(TMP_BASE,'mongoid-test-config/config/mongoid.yml')
+
+          File.exist?(mongoid_config_file).should be false
+          Mrss::ChildProcessHelper.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)
+          config_text.should =~ /mongoid_test_config_development/
+          config_text.should =~ /mongoid_test_config_test/
+        end
+      end
+    end
+  end
+
+  def install_rails
+    Mrss::ChildProcessHelper.check_call(%w(gem uni rails -a))
+    if (rails_version = SpecConfig.instance.rails_version) == 'master'
+    else
+      Mrss::ChildProcessHelper.check_call(%w(gem install rails --no-document -v) + [rails_version])
+    end
+  end
+
+  context 'local test applications' do
+    let(:client) { Mongoid.default_client }
+
+    describe 'create_indexes rake task' do
+
+      APP_PATH = File.join(File.dirname(__FILE__), '../../test-apps/rails-api')
+
+      %w(development production).each do |rails_env|
+        context "in #{rails_env}" do
+
+          %w(classic zeitwerk).each do |autoloader|
+            context "with #{autoloader} autoloader" do
+
+              let(:env) do
+                clean_env.merge(RAILS_ENV: rails_env, AUTOLOADER: autoloader)
+              end
+
+              before do
+                Dir.chdir(APP_PATH) do
+                  remove_bundler_req
+                  Mrss::ChildProcessHelper.check_call(%w(bundle install), env: env)
+                  write_mongoid_yml
+                end
+
+                client['posts'].drop
+                client['posts'].create
+              end
+
+              it 'creates an index' do
+                index = client['posts'].indexes.detect do |index|
+                  index['key'] == {'subject' => 1}
+                end
+                index.should be nil
+
+                Mrss::ChildProcessHelper.check_call(%w(bundle exec rake db:mongoid:create_indexes),
+                  cwd: APP_PATH, env: env)
+
+                index = client['posts'].indexes.detect do |index|
+                  index['key'] == {'subject' => 1}
+                end
+                index.should be_a(Hash)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+
+  def clone_application(repo_url, subdir: nil)
+    Dir.chdir(TMP_BASE) do
+      FileUtils.rm_rf(File.basename(repo_url))
+      Mrss::ChildProcessHelper.check_call(%w(git clone) + [repo_url])
+      Dir.chdir(File.join(*[File.basename(repo_url), subdir].compact)) do
+        adjust_app_gemfile
+        adjust_rails_defaults
+        Mrss::ChildProcessHelper.check_call(%w(bundle install), env: clean_env)
+        puts `git diff`
+
+        write_mongoid_yml
+
+        yield
+      end
+    end
+  end
+
+  def parse_mongodb_uri(uri)
+    pre, query = uri.split('?', 2)
+    if pre =~ %r,\A(mongodb(?:.*?))://([^/]+)(?:/(.*))?\z,
+      protocol = $1
+      hosts = $2
+      database = $3
+      if database == ''
+        database = nil
+      end
+    else
+      raise ArgumentError, "Invalid MongoDB URI: #{uri}"
+    end
+    if query == ''
+      query = nil
+    end
+    {
+      protocol: protocol,
+      hosts: hosts,
+      database: database,
+      query: query,
+    }
+  end
+
+  def build_mongodb_uri(parts)
+    "#{parts.fetch(:protocol)}://#{parts.fetch(:hosts)}/#{parts[:database]}?#{parts[:query]}"
+  end
+
+  def write_mongoid_yml
+    # HACK: the driver does not provide a MongoDB URI parser and assembler,
+    # and the Ruby standard library URI module doesn't handle multiple hosts.
+    parts = parse_mongodb_uri(SpecConfig.instance.uri_str)
+    parts[:database] = 'mongoid_test'
+    uri = build_mongodb_uri(parts)
+    p uri
+    env_config = {'clients' => {'default' => {
+      # TODO massive hack, will fail if uri specifies a database name or
+      # any uri options
+      'uri' => uri,
+    }}}
+    config = {'development' => env_config, 'production' => env_config}
+    File.open('config/mongoid.yml', 'w') do |f|
+      f << YAML.dump(config)
+    end
+  end
+
+  def adjust_app_gemfile(rails_version: SpecConfig.instance.rails_version)
+    remove_bundler_req
+
+    gemfile_lines = IO.readlines('Gemfile')
+    gemfile_lines.delete_if do |line|
+      line =~ /mongoid/
+    end
+    gemfile_lines << "gem 'mongoid', path: '#{File.expand_path(BASE)}'\n"
+    if rails_version
+      gemfile_lines.delete_if do |line|
+        line =~ /rails/
+      end
+      if rails_version == 'master'
+        gemfile_lines << "gem 'rails', git: 'https://github.com/rails/rails'\n"
+      else
+        gemfile_lines << "gem 'rails', '~> #{rails_version}.0'\n"
+      end
+    end
+    File.open('Gemfile', 'w') do |f|
+      f << gemfile_lines.join
+    end
+  end
+
+  def adjust_rails_defaults(rails_version: SpecConfig.instance.rails_version)
+    if File.exist?('config/application.rb')
+      lines = IO.readlines('config/application.rb')
+      lines.each do |line|
+        line.gsub!(/config.load_defaults \d\.\d/, "config.load_defaults #{rails_version}")
+      end
+      File.open('config/application.rb', 'w') do |f|
+        f << lines.join
+      end
+    end
+
+    if rails_version == '5.1'
+      secrets = {
+        'development' => {
+          'secret_key_base' => 'abracadabra',
+          'my_secret_token' => 'very_secret',
+        },
+      }
+      File.open('config/secrets.yml', 'w') do |f|
+        f << YAML.dump(secrets)
+      end
+    end
+  end
+
+  def remove_bundler_req
+    lock_lines = IO.readlines('Gemfile.lock')
+    # Get rid of the bundled with line so that whatever bundler is installed
+    # on the system is usable with the application.
+    if i = lock_lines.index("BUNDLED WITH\n")
+      lock_lines.slice!(i, 2)
+      File.open('Gemfile.lock', 'w') do |f|
+        f << lock_lines.join
+      end
+    end
+  end
+
+  def remove_spring
+    # Spring produces this error in Evergreen:
+    # /data/mci/280eb2ecf4fd69208e2106cd3af526f1/src/rubies/ruby-2.7.0/lib/ruby/gems/2.7.0/gems/spring-2.1.0/lib/spring/client/run.rb:26:
+    # in `initialize': too long unix socket path (126bytes given but 108bytes max) (ArgumentError)
+    # Is it trying to create unix sockets in current directory?
+    # https://stackoverflow.com/questions/30302021/rails-runner-without-spring
+    Mrss::ChildProcessHelper.check_call(%w(bin/spring binstub --remove --all), env: clean_env)
+  end
+
+  def clean_env
+    @clean_env ||= Hash[ENV.keys.grep(/BUNDLE|RUBYOPT/).map { |k| [k, nil ] }]
+  end
+
+  def wait_for_port(port, timeout, process)
+    deadline = Time.now + timeout
+    loop do
+      begin
+        Socket.tcp('localhost', port, nil, nil, connect_timeout: 0.5) do |socket|
+          return
+        end
+      rescue IOError, SystemCallError
+        unless process.alive?
+          raise "Process #{process} died while waiting for port #{port}"
+        end
+        if Time.now > deadline
+          raise
+        end
+      end
+    end
+  end
+end

data/spec/integration/associations/belongs_to_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+require_relative '../../mongoid/association/referenced/has_one_models'
+
+describe 'belongs_to associations' do
+  context 'referencing top level classes when source class is namespaced' do
+    let(:college) { HomCollege.create! }
+    let(:child) { HomAccreditation::Child.new(hom_college: college) }
+
+    it 'works' do
+      expect(child).to be_valid
+    end
+  end
+end