Skip to content

Commit 406d709

Browse files
saghmsaghm
authored
Add Ruby 2.5 & rails to support matrix (#4511) (#4551)
* Add ruby 2.5 to compatibility matrix * Repair configuration reference in upgrading doc * Improve wording * Document rails version support
1 parent 2dbe08d commit 406d709

File tree

3 files changed

+124
-19
lines changed

3 files changed

+124
-19
lines changed

‎docs/tutorials/mongoid-installation.txt

Lines changed: 48 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -32,24 +32,33 @@ Compatibility
3232
-------------
3333

3434
Note the following compatibility matrix to determine if Mongoid is
35-
supported on your runtime and server. Note that Mongoid 6.x is compatible with
36-
Rails 5 and thus requires >= Ruby 2.2.2.
35+
compatible with your Ruby version and MongoDB server. Note that Mongoid
36+
is currently compatible with Rails 5 and depends on ActiveModel 5.1 or higher,
37+
and thus requires Ruby 2.2.2 or higher.
3738

3839
.. list-table::
3940
:header-rows: 1
40-
:widths: 28 30 30 30
4141

4242
* - Ruby Version
43-
- MongoDB 3.0.x
44-
- MongoDB 3.2.x
43+
- MongoDB 4.0.x
44+
- MongoDB 3.6.x
4545
- MongoDB 3.4.x
46+
- MongoDB 3.2.x
47+
- MongoDB 3.0.x
48+
- MongoDB 2.6.x
4649

47-
* - MRI 2.1.x
48-
- No
49-
- No
50-
- No
50+
* - MRI 2.5.0+
51+
- Yes
52+
- Yes
53+
- Yes
54+
- Yes
55+
- Yes
56+
- Yes
5157

52-
* - MRI 2.2.2
58+
* - MRI 2.4.1+
59+
- Yes
60+
- Yes
61+
- Yes
5362
- Yes
5463
- Yes
5564
- Yes
@@ -58,8 +67,30 @@ Rails 5 and thus requires >= Ruby 2.2.2.
5867
- Yes
5968
- Yes
6069
- Yes
70+
- Yes
71+
- Yes
72+
- Yes
6173

62-
* - MRI 2.4.1
74+
* - MRI 2.2.2+
75+
- Yes
76+
- Yes
77+
- Yes
78+
- Yes
79+
- Yes
80+
- YES
81+
82+
* - MRI 2.1.x
83+
- No
84+
- No
85+
- No
86+
- No
87+
- No
88+
- No
89+
90+
* - JRuby 9.2.x
91+
- Yes
92+
- Yes
93+
- Yes
6394
- Yes
6495
- Yes
6596
- Yes
@@ -68,6 +99,12 @@ Rails 5 and thus requires >= Ruby 2.2.2.
6899
- Yes
69100
- Yes
70101
- Yes
102+
- Yes
103+
- Yes
104+
- Yes
105+
106+
Refer to :ref:`Rails considerations <rails-compatibility>`
107+
for the Ruby on Rails compatibility matrix.
71108

72109
.. _mongoid-configuration:
73110

‎docs/tutorials/mongoid-rails.txt

Lines changed: 67 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,73 @@ Rails Considerations
1111
:class: singlecol
1212

1313
Mongoid was built and targeted towards Rails applications, even though it will
14-
work in any environment. However if you are using Rails consult the next sections
15-
on how Mongoid hooks into a Rails application.
14+
work in any Ruby application. This document explains how
15+
to use Mongoid with a Rails application.
16+
17+
.. _rails-compatibility:
18+
19+
Rails Version Compatibility
20+
---------------------------
21+
22+
Refer to the following compatibility matrix to determine which version
23+
of Mongoid to use with your Rails application.
24+
25+
.. list-table::
26+
:header-rows: 1
27+
28+
* - Mongoid Version
29+
- Rails 5.2
30+
- Rails 5.1
31+
- Rails 5.0
32+
- Rails 4.2
33+
34+
* - Mongoid 7.0
35+
- Yes
36+
- Yes
37+
- No
38+
- No
39+
40+
* - Mongoid 6.4
41+
- Yes
42+
- Yes
43+
- No
44+
- No
45+
46+
* - Mongoid 6.3
47+
- Yes
48+
- Yes
49+
- No
50+
- No
51+
52+
* - Mongoid 6.2
53+
- Yes
54+
- Yes
55+
- No
56+
- No
57+
58+
* - Mongoid 6.1
59+
- No
60+
- No
61+
- Yes
62+
- No
63+
64+
* - Mongoid 6.0
65+
- No
66+
- No
67+
- Yes
68+
- No
69+
70+
* - Mongoid 5.4
71+
- No
72+
- No
73+
- No
74+
- Yes
75+
76+
* - Mongoid 5.2
77+
- No
78+
- No
79+
- No
80+
- Yes
1681

1782

1883
Using Mongoid with a new Rails application

‎docs/tutorials/mongoid-upgrade.txt

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Upgrade Mongoid
66

77
Upgrade to 6.x Series
88
`````````````````````
9-
Mongoid 6.x is compatible with Rails 5 and thus requires >= Ruby 2.2.2.
9+
Mongoid 6.x is compatible with Rails 5 and requires Ruby 2.2.2 or higher.
1010

1111
Please see the list of behavior changes for version `6.0.0.beta <https://github.com/mongodb/mongoid/releases/tag/v6.0.0.beta>`_
1212
and version `6.0.0.rc0 <https://github.com/mongodb/mongoid/releases/tag/v6.0.0.rc0>`_ for specific changes that might be
@@ -20,19 +20,22 @@ For all users dropping down to the driver level for operations, please see the d
2020
documentation for help with that API.
2121

2222
All Mongoid configuration options have changed, as the underlying driver has changed
23-
from Moped to the core MongoDB Ruby driver. Please see the
24-
:ref:`configuration section <mongoid-configuration-5.x>` for a detailed description of all new options.
23+
from Moped to the official MongoDB Ruby driver. Please see the
24+
:ref:`configuration section <mongoid-configuration>` for a detailed description
25+
of all the new options.
2526

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

2930
``find_and_modify`` has been removed and replaced with 3 options: ``find_one_and_update``,
3031
``find_one_and_delete`` and ``find_one_and_replace``.
3132

32-
``text_search`` has been removed as it is now a $text option in a query from 2.6 on.
33-
34-
Mongoid no longer supports MongoDB 2.2 - support is now for only 2.4 and higher.
33+
``text_search`` has been removed as it is now a $text option in a query from
34+
MongoDB 2.6 onward.
3535

3636
``first`` and ``last`` no longer add an ``_id`` sort when no sorting options have been
3737
provided. In order to guarantee that a document is the first or last, it needs to now
3838
contain an explicit sort.
39+
40+
Mongoid 5.x supports MongoDB 2.4 and higher only - MongoDB 2.2 is no longer
41+
supported.

0 commit comments

Comments
 (0)