-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
1bdafb1
commit 46b4784
Showing
2 changed files
with
136 additions
and
53 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,67 +1,149 @@ | ||
| Mongoid | ||
| # Mongoid: Ultra Edition | ||
| [![Gem Version][rubygems-img]][rubygems-url] | ||
| [![Inline docs][inch-img]][inch-url] | ||
| ==== | ||
| [![Inline Docs][inch-img]][inch-url] | ||
| [![License][license-img]][license-url] | ||
|
|
||
| Mongoid is an ODM (Object-Document Mapper) framework for MongoDB in Ruby. | ||
| The no-baloney fork of Mongoid. Made by the community, for the community. | ||
| Mongoid is the Ruby Object Document Mapper (ODM) for MongoDB. | ||
|
|
||
| Documentation | ||
| ------------- | ||
| This fork of Mongoid is **not** endorsed by or affiliated with MongoDB Inc. 👍 | ||
|
|
||
| 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. | ||
| ## Installation | ||
|
|
||
| Mongoid is built on top of the MongoDB Ruby driver which has | ||
| [its own user documentation](https://www.mongodb.com/docs/ruby-driver/current/). | ||
| Replace `gem 'mongoid'` in your application's Gemfile with: | ||
|
|
||
| Compatibility | ||
| ------------- | ||
| ```ruby | ||
| gem 'mongoid-ultra' | ||
| ``` | ||
|
|
||
| Mongoid supports and is tested against: | ||
| (Do **not** install `mongoid` and `mongoid-ultra` at the same time.) | ||
|
|
||
| - MRI 2.6 - 3.1 | ||
| - JRuby 9.3 | ||
| - MongoDB server 3.6 - 6.0 | ||
| ## Compatibility | ||
|
|
||
| Issues | ||
| ------ | ||
| - Ruby (MRI) 2.7 - 3.2 | ||
| - JRuby 9.4 | ||
| - MongoDB server 4.4 - 6.0 | ||
|
|
||
| Please use the [MONGOID project](https://jira.mongodb.org/browse/MONGOID/) | ||
| in MongoDB JIRA to report issues with Mongoid. | ||
| Version support may differ from MongoDB's Mongoid release. | ||
|
|
||
| Support | ||
| ------- | ||
| ## Purpose & Principles | ||
|
|
||
| This is a *community-driven fork of Mongoid*, intend to improve the following over MongoDB's Mongoid: | ||
|
|
||
| - Feature robustness | ||
| - Code quality | ||
| - Behavior rationality | ||
| - Developer experience | ||
| - Stability | ||
| - Transparency | ||
| - Community involvement | ||
|
|
||
| This fork will merge in changes at least once-per-month from [mongodb/mongoid](https://github.com/mongodb/mongoid) | ||
| as its "upstream" repo. We may backport PRs to upstream where it makes sense to do so, but cannot guarantee that | ||
| the upstream will merge them. | ||
|
|
||
| ## Versioning | ||
|
|
||
| For the time being, version numbers will shadow those of `mongodb/mongoid` with an additional "patch" number added: | ||
|
|
||
| `X.Y.Z.P` | ||
|
|
||
| Where `X.Y.Z` is the latest upstream release version, and `P` is the patch version of this repo. | ||
| We will also use `-beta1`, `-rc1`, etc. suffixes to denote pre-releases, which may be unstable. | ||
|
|
||
| **Semver**: For the time being will follow the major version component of semver, i.e. not breaking or | ||
| removing functionality *except* in major (`X`) releases. We may introduce new features in new patch (`P`) releases, | ||
| and will use feature flags prefixed with `ultra_` to allow users to opt-in. | ||
|
|
||
| All new versions will undergo battle-testing in production at TableCheck prior to being released. | ||
|
|
||
| ## Roadmap | ||
|
|
||
| - [ ] Establish maintainers and governance board. | ||
| - [x] Use a publicly visible CI (Github Actions) as the primary CI. | ||
| - [ ] Remove Evergreen CI, MRSS submodule, and other MongoDB corporate baloney. | ||
| - [ ] Publish documentation. | ||
| - [ ] Drop support for old Ruby, Rails, and MongoDB server versions. | ||
| - [ ] Full documentation coverage. | ||
| - [ ] Full Rubocop compliance and coverage. | ||
| - [ ] Remove all monkey-patching. | ||
| - [ ] Merge patches rejected by MongoDB. | ||
| - [ ] Refactor persistence type-validation (mongoize, etc.) | ||
| - [ ] Extract unsafe chaining `and` and `or` operators to a gem. Require usage of `all_of` and `any_of` instead. | ||
| - [ ] Extract `:field.in => [1, 2, 3]` query syntax to a gem. Require usage of `field: { '$in' => [1, 2, 3] }` instead. | ||
| - [ ] Allow symbol instead of classes in `field :type` declarations. | ||
| - [ ] Refactor relations (`belongs_to_one`, `belongs_to_many`) | ||
|
|
||
| ## Notable Differences from MongoDB Mongoid | ||
|
|
||
| - At the moment, none. We are working on it! | ||
|
|
||
| ## Documentation | ||
|
|
||
| The documentation of this fork will be hosted at: https://tablecheck.github.io/mongoid-ultra/ (not online yet!) | ||
|
|
||
| ## Support | ||
|
|
||
| For beginners, please use MongoDB's existing Mongoid support resources: | ||
|
|
||
| * [Stack Overflow](http://stackoverflow.com/questions/tagged/mongoid) | ||
| * [MongoDB Community Forum](https://developer.mongodb.com/community/forums/tags/c/drivers-odms-connectors/7/mongoid-odm) | ||
| * [#mongoid](http://webchat.freenode.net/?channels=mongoid) on Freenode IRC | ||
|
|
||
| License | ||
| ------- | ||
|
|
||
| Copyright (c) 2015-Present MongoDB Inc. | ||
| Copyright (c) 2009-2016 Durran Jordan | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining | ||
| a copy of this software and associated documentation files (the | ||
| "Software"), to deal in the Software without restriction, including | ||
| without limitation the rights to use, copy, modify, merge, publish, | ||
| distribute, sublicense, and/or sell copies of the Software, and to | ||
| permit persons to whom the Software is furnished to do so, subject to | ||
| the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be | ||
| included in all copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, | ||
| EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF | ||
| MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND | ||
| NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE | ||
| LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION | ||
| OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION | ||
| WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | ||
|
|
||
| [rubygems-img]: https://badge.fury.io/rb/mongoid.svg | ||
| [rubygems-url]: http://badge.fury.io/rb/mongoid | ||
| [inch-img]: http://inch-ci.org/github/mongodb/mongoid.svg?branch=master | ||
| [inch-url]: http://inch-ci.org/github/mongodb/mongoid | ||
| ## Issues & Contributing | ||
|
|
||
| Feature requests and bugs affecting both upstream and Mongoid Ultra should be reported in the [MongoDB MONGOID Jira](https://jira.mongodb.org/browse/MONGOID/). | ||
| Please also raise a [Mongoid Ultra Github issue](https://github.com/tablecheck/mongoid-ultra/issues) in this project to track the fix. We prefer if upstream can make the fix first then we merge it. | ||
|
|
||
| Issues specific to Mongoid Ultra should be raised in the [Mongoid Ultra Github issue tracker](https://github.com/tablecheck/mongoid-ultra/issues) | ||
|
|
||
| ## Security Issues | ||
|
|
||
| Security issues affecting both upstream and Mongoid Ultra should be | ||
| [reported to MongoDB](https://www.mongodb.com/docs/manual/tutorial/create-a-vulnerability-report/). | ||
|
|
||
| Security issues affecting only Mongoid Ultra should be reported to [[email protected]](mailto:[email protected]). | ||
| The email should be encrypted with the following PGP public key: | ||
|
|
||
| * Key ID: `0xDF7D22A0E8772326` | ||
| * Fingerprint: `466C 56B9 E110 3CBA 2129 DBAD DF7D 22A0 E877 2326` | ||
|
|
||
| We appreciate your help to disclose security issues responsibly. | ||
|
|
||
| ## Maintainership | ||
|
|
||
| Mongoid Ultra is shepherded by the team at TableCheck. TableCheck have been avid Mongoid users since 2013, | ||
| contributing over 150 PRs to Mongoid and MongoDB Ruby projects. TableCheck uses Mongoid to power millions of | ||
| restaurant reservations each month, and are *personally invested* in the making the best user experience possible. | ||
|
|
||
| We invite all in the community to apply for co-maintainership, please raise a Github issue if interested. | ||
|
|
||
| ## Reasons for Forking | ||
|
|
||
| Mongoid started as an open-source project created by Durran Jordan in 2009. MongoDB Inc. took over maintainership in 2015. | ||
| Since the transition, the hallmarks of user-disconnect and corporate fumbling have become apparent: | ||
|
|
||
| - Introduction of [critical semver-breaking issues](https://serpapi.com/blog/how-a-routine-gem-update-ended-up-charging/). | ||
| - Lack of a publicly visible roadmap or direction (when requested, it was said to be a "corporate secret".) | ||
| - Unwillingness to adopt basic best industry-standard practices, e.g. Rubocop linter and a publicly-visible CI workflow. | ||
| - Refusal to merge patches which would be of obvious benefit to the community. | ||
| - Lack of bandwidth and resources to review simple PR contributions. | ||
|
|
||
| **None of this is intended to disparage the hard-working and talented individuals at MongoDB Inc.**, but rather, | ||
| to illustrate that the corporate rules, philosophy, and priorities of MongoDB Inc. are not aligned with the needs | ||
| of its Ruby users. | ||
|
|
||
| It's time to do better! 💪 We hope this project encourages MongoDB Inc. to improve its own offering. | ||
|
|
||
| ## Disclaimer | ||
|
|
||
| MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc. and are used in compliance with | ||
| [MongoDB Inc.'s Trademark Usage Guidelines](https://www.mongodb.com/legal/trademark-usage-guidelines). | ||
| Any usage herein should not be construed as an endorsement or affiliation with this project. | ||
|
|
||
| [rubygems-img]: https://badge.fury.io/rb/mongoid-ultra.svg | ||
| [rubygems-url]: http://badge.fury.io/rb/mongoid-ultra | ||
| [inch-img]: http://inch-ci.org/github/tablecheck/mongoid-ultra.svg?branch=master | ||
| [inch-url]: http://inch-ci.org/github/tablecheck/mongoid-ultra | ||
| [license-img]: https://img.shields.io/badge/license-MIT-green.svg | ||
| [license-url]: https://www.opensource.org/licenses/MIT |