mongoid 7.1.0.rc0 → 7.1.5

data/lib/mongoid/tasks/database.rb

@@ -108,6 +108,89 @@ module Mongoid
         end.compact
       end
 
+      # Shard collections for models that declare shard keys.
+      #
+      # Returns the model classes that have had their collections sharded,
+      # including model classes whose collections had already been sharded
+      # prior to the invocation of this method.
+      #
+      # @example Shard all collections
+      #   Mongoid::Tasks::Database.shard_collections
+      #
+      # @return [ Array<Class> ] The sharded models
+      def shard_collections(models = ::Mongoid.models)
+        models.map do |model|
+          next if model.shard_config.nil?
+
+          if model.embedded? && !model.cyclic?
+            logger.warn("MONGOID: #{model} has shard config but is emdedded")
+            next
+          end
+
+          unless model.collection.cluster.sharded?
+            logger.warn("MONGOID: #{model} has shard config but is not persisted in a sharded cluster: #{model.collection.cluster.summary}")
+            next
+          end
+
+          # Database of the collection must exist in order to run collStats.
+          # Depending on server version, the collection itself must also
+          # exist.
+          # MongoDB does not have a command to create the database; the best
+          # approximation of it is to create the collection we want.
+          # On older servers, creating a collection that already exists is
+          # an error.
+          # Additionally, 3.6 and potentially older servers do not provide
+          # the error code when they are asked to collStats a non-existent
+          # collection (https://jira.mongodb.org/browse/SERVER-50070).
+          begin
+            stats = model.collection.database.command(collStats: model.collection.name).first
+          rescue Mongo::Error::OperationFailure => exc
+            # Code 26 is database does not exist.
+            # Code 8 is collection does not exist, as of 4.0.
+            # On 3.6 and earlier match the text of exception message.
+            if exc.code == 26 || exc.code == 8 ||
+              exc.code.nil? && exc.message =~ /not found/
+            then
+              model.collection.create
+
+              stats = model.collection.database.command(collStats: model.collection.name).first
+            else
+              raise
+            end
+          end
+
+          stats = model.collection.database.command(collStats: model.collection.name).first
+          if stats[:sharded]
+            logger.info("MONGOID: #{model.collection.namespace} is already sharded for #{model}")
+            next model
+          end
+
+          admin_db = model.collection.client.use(:admin).database
+
+          begin
+            admin_db.command(enableSharding: model.collection.database.name)
+          rescue Mongo::Error::OperationFailure => exc
+            # Server 2.6 fails if sharding is already enabled
+            if exc.code == 23 || exc.code.nil? && exc.message =~ /already enabled/
+              # Nothing
+            else
+              raise
+            end
+          end
+
+          begin
+            admin_db.command(shardCollection: model.collection.namespace, **model.shard_config)
+          rescue Mongo::Error::OperationFailure => e
+            logger.error("MONGOID: Failed to shard collection #{model.collection.namespace} for #{model}: #{e.class}: #{e}")
+            next
+          end
+
+          logger.info("MONGOID: Sharded collection #{model.collection.namespace} for #{model}")
+
+          model
+        end.compact
+      end
+
       private
 
       def logger

data/lib/mongoid/timestamps/timeless.rb

@@ -44,11 +44,13 @@ module Mongoid
       end
 
       class << self
+        extend Forwardable
 
         def timeless_table
           Thread.current['[mongoid]:timeless'] ||= Hash.new
         end
-        delegate :[]=, :[], to: :timeless_table
+
+        def_delegators :timeless_table, :[]=, :[]
       end
 
       private

data/lib/mongoid/validatable/uniqueness.rb

@@ -150,7 +150,7 @@ module Mongoid
       #
       # @since 2.3.0
       def filter(value)
-        !case_sensitive? && value ? /\A#{Regexp.escape(value.to_s)}$/i : value
+        !case_sensitive? && value ? /\A#{Regexp.escape(value.to_s)}\z/i : value
       end
 
       # Scope the criteria to the scope options provided.

data/lib/mongoid/version.rb

@@ -2,5 +2,5 @@
 # encoding: utf-8
 
 module Mongoid
-  VERSION = "7.1.0.rc0"
+  VERSION = "7.1.5"
 end

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

@@ -114,12 +114,37 @@ development:
 
   # Configure Mongoid specific options. (optional)
   options:
-    # Includes the root model name in json serialization. (default: false)
+    # 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. It is also used as the database name if the
+    # database name is not explicitly defined. (default: nil)
+    # app_name: MyApplicationName
+    
+    # Create indexes in background by default. (default: false)
+    # background_indexing: false
+    
+    # Mark belongs_to associations as required by default, so that saving a
+    # model with a missing belongs_to association will trigger a validation
+    # error. (default: true)
+    # belongs_to_required_by_default: true
+    
+    # Raise an exception when a field is redefined. (default: false)
+    # duplicate_fields_exception: false
+    
+    # Include the root model name in json serialization. (default: false)
     # include_root_in_json: false
 
     # Include the _type field in serialization. (default: false)
     # include_type_for_serialization: false
 
+    # Whether to join nested persistence contexts for atomic operations
+    # to parent contexts by default. (default: false)
+    # join_contexts: false
+
+    # Set the Mongoid and Ruby driver log levels when Mongoid is not using
+    # Ruby on Rails logger instance. (default: :info)
+    # log_level: :info
+    
     # Preload all models in development, needed when models use
     # inheritance. (default: false)
     # preload_models: false
@@ -132,32 +157,16 @@ development:
     # existing method. (default: false)
     # scope_overwrite_exception: false
 
-    # Raise an error when defining a field with the same name as an
-    # existing method. (default: false)
-    # duplicate_fields_exception: false
-
-    # Use Active Support's time zone in conversions. (default: true)
+    # Use ActiveSupport's time zone in time operations instead of
+    # the Ruby default time zone. See the time zone section below for
+    # further information. (default: true)
     # use_activesupport_time_zone: true
 
-    # Ensure all times are UTC in the app side. (default: false)
+    # Return stored times as UTC. See the time zone section below for
+    # further information. Most applications should not use this option.
+    # (default: false)
     # use_utc: false
 
-    # Set the Mongoid and Ruby driver log levels when not in a Rails
-    # environment. The Mongoid logger will be set to the Rails logger
-    # otherwise.(default: :info)
-    # log_level: :info
-
-    # Control whether `belongs_to` association is required. By default
-    # `belongs_to` will trigger a validation error if the association
-    # is not present. (default: true)
-    # belongs_to_required_by_default: true
-
-    # 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/app/models/coding.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+require 'app/models/coding/pull_request'

data/spec/app/models/coding/pull_request.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+module Coding
+  class PullRequest
+    include Mongoid::Document
+
+    field :title, type: String
+
+    has_many :reviews, class_name: 'Publication::Review', as: :reviewable
+  end
+end

data/spec/app/models/delegating_patient.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+class DelegatingPatient
+  include Mongoid::Document
+
+  embeds_one :email
+
+  # Instance level delegation
+  delegate :address, to: :email
+
+  class << self
+    # Class level delegation
+    delegate :default_client, to: ::Mongoid
+  end
+end

data/spec/app/models/passport.rb

@@ -4,5 +4,6 @@
 class Passport
   include Mongoid::Document
   field :number, type: String
+  field :country, type: String
   embedded_in :person, autobuild: true
 end

data/spec/app/models/phone.rb

@@ -7,6 +7,7 @@ class Phone
   field :_id, type: String, overwrite: true, default: ->{ number }
 
   field :number
+  field :landline, type: Boolean
   embeds_one :country_code
   embedded_in :person
 end

data/spec/app/models/publication.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+require 'app/models/publication/encyclopedia'
+require 'app/models/publication/review'

data/spec/app/models/publication/encyclopedia.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+module Publication
+  class Encyclopedia
+    include Mongoid::Document
+
+    field :title, type: String
+
+    has_many :reviews, class_name: 'Publication::Review', as: :reviewable
+  end
+end

data/spec/app/models/publication/review.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+module Publication
+  class Review
+    include Mongoid::Document
+
+    field :summary
+
+    belongs_to :reviewable, polymorphic: true
+    belongs_to :reviewer, polymorphic: true
+    belongs_to :template
+  end
+end

data/spec/integration/app_spec.rb

@@ -0,0 +1,254 @@
+# 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 'support/child_process_helper'
+    require 'open-uri'
+
+    FileUtils.mkdir_p(TMP_BASE)
+  end
+
+  context 'demo application - sinatra' do
+    it 'runs' do
+      clone_application(
+        'https://github.com/mongoid/mongoid-demo',
+        subdir: 'sinatra-minimal',
+      ) do
+
+        process = ChildProcess.build(*%w(bundle exec ruby app.rb))
+        process.environment.update(clean_env)
+        process.io.inherit!
+        process.start
+
+        begin
+          # JRuby needs a long timeout
+          wait_for_port(4567, 20)
+          sleep 1
+
+          uri = URI.parse('http://localhost:4567/posts')
+          resp = JSON.parse(uri.open.read)
+        ensure
+          Process.kill('TERM', process.pid)
+          status = process.wait
+        end
+
+        resp.should == []
+
+        status.should == 0
+      end
+    end
+  end
+
+  context 'demo application - rails-api' do
+    ['~> 6.0.0'].each do |rails_version|
+      context "with rails #{rails_version}" do
+        it 'runs' do
+          clone_application(
+            'https://github.com/mongoid/mongoid-demo',
+            subdir: 'rails-api',
+            rails_version: rails_version,
+          ) do
+
+            process = ChildProcess.build(*%w(bundle exec rails s))
+            process.environment.update(clean_env)
+            process.io.inherit!
+            process.start
+
+            begin
+              # JRuby needs a long timeout
+              wait_for_port(3000, 30)
+              sleep 1
+
+              uri = URI.parse('http://localhost:3000/posts')
+              resp = JSON.parse(uri.open.read)
+            ensure
+              Process.kill('TERM', process.pid)
+              status = process.wait
+            end
+
+            resp.should == []
+
+            # 143 = 128 + 15
+            [0, 15, 143].should include(status)
+          end
+        end
+      end
+    end
+  end
+
+  context 'new application - rails' do
+    ['~> 5.1.0', '~> 5.2.0', '~> 6.0.0'].each do |rails_version|
+      context "with rails #{rails_version}" do
+        it 'creates' do
+          ChildProcessHelper.check_call(%w(gem uni rails -a))
+          ChildProcessHelper.check_call(%w(gem install rails --no-document -v) + [rails_version])
+
+          Dir.chdir(TMP_BASE) do
+            FileUtils.rm_rf('mongoid-test')
+            ChildProcessHelper.check_call(%w(rails new mongoid-test --skip-spring --skip-active-record), env: clean_env)
+
+            Dir.chdir('mongoid-test') do
+              adjust_app_gemfile
+              ChildProcessHelper.check_call(%w(bundle install), env: clean_env)
+
+              ChildProcessHelper.check_call(%w(rails g model post), env: clean_env)
+              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
+      end
+    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
+                  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
+
+                ChildProcessHelper.check_call(%w(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, rails_version: nil)
+    Dir.chdir(TMP_BASE) do
+      FileUtils.rm_rf(File.basename(repo_url))
+      ChildProcessHelper.check_call(%w(git clone) + [repo_url])
+      Dir.chdir(File.join(*[File.basename(repo_url), subdir].compact)) do
+        adjust_app_gemfile(rails_version: rails_version)
+        ChildProcessHelper.check_call(%w(bundle install), env: clean_env)
+        puts `git diff`
+
+        write_mongoid_yml
+
+        yield
+      end
+    end
+  end
+
+  def write_mongoid_yml
+    env_config = {'clients' => {'default' => {
+      # TODO massive hack, will fail if uri specifies a database name or
+      # any uri options
+      'uri' => "#{SpecConfig.instance.uri_str}/mongoid_test",
+    }}}
+    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: nil)
+    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
+      gemfile_lines << "gem 'rails', '#{rails_version}'\n"
+    end
+    File.open('Gemfile', 'w') do |f|
+      f << gemfile_lines.join
+    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
+    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)
+    deadline = Time.now + timeout
+    loop do
+      begin
+        Socket.tcp('localhost', port, nil, nil, connect_timeout: 0.5) do |socket|
+          return
+        end
+      rescue IOError, SystemCallError
+        if Time.now > deadline
+          raise
+        end
+      end
+    end
+  end
+end