Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RUBY-2942: Update Mongoid documentation links #5482

Merged
merged 1 commit into from
Oct 3, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ For instructions on upgrading to newer versions, visit

* Mongoid now uses the official Mongo Ruby Driver 2.x instead of Moped.

* Most driver specific configuration options have changed, please see [here](http://docs.mongodb.org/ecosystem/tutorial/ruby-driver-tutorial/#ruby-options) for the new options.
* Most driver specific configuration options have changed, please see [here](https://www.mongodb.com/docs/ecosystem/tutorial/ruby-driver-tutorial/#ruby-options) for the new options.

* All references to `session` are now replaced with `client`. This includes the mongoid.yml configuration, `store_in` options, and all exceptions and modules with `Session` in the name.

Expand Down Expand Up @@ -872,8 +872,8 @@ child elements.
handling of validations. (Gerad Suyderhoud)

* \#2443 `expire_after_seconds` is now a valid index option
(http://docs.mongodb.org/manual/core/indexes/#ttl-indexes,
http://docs.mongodb.org/manual/tutorial/expire-data/).
(https://www.mongodb.com/docs/manual/core/indexes/#ttl-indexes,
https://www.mongodb.com/docs/manual/tutorial/expire-data/).

class Event
include Mongoid::Document
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ Mongoid is an ODM (Object-Document Mapper) framework for MongoDB in Ruby.
Documentation
-------------

Mongoid has [extensive user documentation](https://docs.mongodb.com/mongoid/current/).
[API documentation](https://docs.mongodb.com/mongoid/current/api/) is also available.
Mongoid has [extensive user documentation](https://www.mongodb.com/docs/mongoid/current/).
[API documentation](https://www.mongodb.com/docs/mongoid/current/api/) is also available.

Mongoid is built on top of the MongoDB Ruby driver which has
[its own user documentation](https://docs.mongodb.com/ruby-driver/current/).
[its own user documentation](https://www.mongodb.com/docs/ruby-driver/current/).

Compatibility
-------------
Expand Down
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,5 @@ currently being supported with security updates.

## Reporting a Vulnerability

Please [follow the instructions here](https://docs.mongodb.com/manual/tutorial/create-a-vulnerability-report/)
Please [follow the instructions here](https://www.mongodb.com/docs/manual/tutorial/create-a-vulnerability-report/)
to report a vulnerability.
2 changes: 1 addition & 1 deletion docs/reference/fields.txt
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ Field Type: Hash
----------------

When using a field of type Hash, be wary of adhering to the
`legal key names for mongoDB <http://docs.mongodb.org/manual/reference/limits/#naming-restrictions>`_,
`legal key names for mongoDB <https://www.mongodb.com/docs/manual/reference/limits/#naming-restrictions>`_,
or else the values will not store properly.

.. code-block:: ruby
Expand Down
8 changes: 4 additions & 4 deletions lib/config/locales/en.yml
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ en:
message: "Empty configuration file: %{path}."
summary: "Your mongoid.yml configuration file appears to be empty."
resolution: "Ensure your configuration file contains the correct contents.
Refer to: https://docs.mongodb.com/mongoid/current/reference/configuration/"
Refer to: https://www.mongodb.com/docs/mongoid/current/reference/configuration/"
invalid_collection:
message: "Access to the collection for %{klass} is not allowed."
summary: "%{klass}.collection was called, and %{klass} is an embedded
Expand Down Expand Up @@ -146,7 +146,7 @@ en:
summary: "Your mongoid.yml configuration file does not contain the
correct file structure."
resolution: "Ensure your configuration file contains the correct contents.
Refer to: https://docs.mongodb.com/mongoid/current/reference/configuration/"
Refer to: https://www.mongodb.com/docs/mongoid/current/reference/configuration/"
invalid_config_option:
message: "Invalid configuration option: %{name}."
summary: "A invalid configuration option was provided in your
Expand Down Expand Up @@ -238,14 +238,14 @@ en:
\_\_\_\_field :%{name}, %{option}: true\n
\_\_end\n\n
Refer to:
https://docs.mongodb.com/mongoid/current/reference/fields/#custom-field-options"
https://www.mongodb.com/docs/mongoid/current/reference/fields/#custom-field-options"
invalid_field_type:
message: "Invalid field type %{type_inspection} for field '%{field}' on model '%{klass}'."
summary: "Model '%{klass}' defines a field '%{field}' with an unknown type value
%{type_inspection}."
resolution: "Please provide a valid type value for the field.
Refer to:
https://docs.mongodb.com/mongoid/current/reference/fields/#using-symbols-or-strings-instead-of-classes"
https://www.mongodb.com/docs/mongoid/current/reference/fields/#using-symbols-or-strings-instead-of-classes"
invalid_global_executor_concurrency:
message: "Invalid global_executor_concurrency option."
summary: "You set global_executor_concurrency while async_query_executor
Expand Down
2 changes: 1 addition & 1 deletion lib/mongoid/association/accessors.rb
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ def _mongoid_filter_selected_fields(assoc_key)

# Positional projection is specified as "foo.$". In this case the
# document that the $ is referring to should be retrieved with all
# fields. See https://docs.mongodb.com/manual/reference/operator/projection/positional/
# fields. See https://www.mongodb.com/docs/manual/reference/operator/projection/positional/
# and https://jira.mongodb.org/browse/MONGOID-4769.
if filtered.keys == %w($)
filtered = nil
Expand Down
2 changes: 1 addition & 1 deletion lib/mongoid/attributes/projector.rb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ module Attributes
# This module defines projection helpers.
#
# Projection rules are rather non-trivial. See
# https://docs.mongodb.com/manual/reference/method/db.collection.find/#find-projection
# https://www.mongodb.com/docs/manual/reference/method/db.collection.find/#find-projection
# for server documentation.
# 4.4 server (and presumably all older ones) requires that a projection
# for content fields is either exclusionary or inclusionary, i.e. one
Expand Down
2 changes: 1 addition & 1 deletion lib/mongoid/criteria/queryable/mergeable.rb
Original file line number Diff line number Diff line change
Expand Up @@ -283,7 +283,7 @@ def __multi__(criteria, operator)
# The new value is a simple value.
# Transform the implicit equality to either $eq or $regexp
# depending on the type of the argument. See
# https://docs.mongodb.com/manual/reference/operator/query/eq/#std-label-eq-usage-examples
# https://www.mongodb.com/docs/manual/reference/operator/query/eq/#std-label-eq-usage-examples
# for the description of relevant server behavior.
op = case v
when Regexp, BSON::Regexp::Raw
Expand Down
6 changes: 3 additions & 3 deletions lib/mongoid/criteria/queryable/selectable.rb
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ def exists(criterion)
# the upper right (north east) as the second argument.
# Important: When latitude and longitude are passed, longitude is
# expected as the first element of the coordinate pair.
# Source: https://docs.mongodb.com/manual/reference/operator/query/box/
# Source: https://www.mongodb.com/docs/manual/reference/operator/query/box/
#
# @example Add a geo intersect criterion for a line.
# query.geo_spatial(:location.intersects_line => [[ 1, 10 ], [ 2, 10 ]])
Expand Down Expand Up @@ -732,7 +732,7 @@ def with_type(criterion)
# @example Construct a text search selector with options.
# selectable.text_search("testing", :$language => "fr")
#
# @note Per https://docs.mongodb.com/manual/reference/operator/query/text/
# @note Per https://www.mongodb.com/docs/manual/reference/operator/query/text/
# it is not currently possible to supply multiple text search
# conditions in a query. Mongoid will build such a query but the
# server will return an error when trying to execute it.
Expand All @@ -752,7 +752,7 @@ def text_search(terms, opts = nil)
criterion = {'$text' => { '$search' => terms }}
criterion['$text'].merge!(opts) if opts
if query.selector['$text']
# Per https://docs.mongodb.com/manual/reference/operator/query/text/
# Per https://www.mongodb.com/docs/manual/reference/operator/query/text/
# multiple $text expressions are not currently supported by
# MongoDB server, but build the query correctly instead of
# overwriting previous text search condition with the currently
Expand Down
2 changes: 1 addition & 1 deletion lib/mongoid/matcher/eq_impl.rb
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ module EqImpl
end
end

# Per https://docs.mongodb.com/ruby-driver/current/tutorials/bson-v4/#time-instances,
# Per https://www.mongodb.com/docs/ruby-driver/current/tutorials/bson-v4/#time-instances,
# > Times in BSON (and MongoDB) can only have millisecond precision. When Ruby Time instances
# are serialized to BSON or Extended JSON, the times are floored to the nearest millisecond.
#
Expand Down
2 changes: 1 addition & 1 deletion lib/mongoid/matcher/type.rb
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
module Mongoid
module Matcher

# @see https://docs.mongodb.com/manual/reference/operator/query/type/
# @see https://www.mongodb.com/docs/manual/reference/operator/query/type/
#
# @api private
module Type
Expand Down
2 changes: 1 addition & 1 deletion mongoid.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Gem::Specification.new do |s|
s.metadata = {
'bug_tracker_uri' => 'https://jira.mongodb.org/projects/MONGOID',
'changelog_uri' => 'https://github.com/mongodb/mongoid/releases',
'documentation_uri' => 'https://docs.mongodb.com/mongoid/',
'documentation_uri' => 'https://www.mongodb.com/docs/mongoid/',
'homepage_uri' => 'https://mongoid.org/',
'source_code_uri' => 'https://github.com/mongodb/mongoid',
}
Expand Down
2 changes: 1 addition & 1 deletion spec/mongoid/criteria/queryable/selectable_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2045,7 +2045,7 @@ def localized?
end

# MongoDB server can only handle one text expression at a time,
# per https://docs.mongodb.com/manual/reference/operator/query/text/.
# per https://www.mongodb.com/docs/manual/reference/operator/query/text/.
# Nonetheless we test that the query is built correctly when
# a user supplies more than one text condition.
it 'merges conditions' do
Expand Down