Misc doc changes

Besides other documentation changes, this commit ensures the generated
HTML doc for HexDocs.pm will become the source of truth for this Elixir
library and leverage on latest features of ExDoc.

Author: kianmeng

.formatter.exs

@@ -0,0 +1,4 @@
+# Used by "mix format"
+[
+  inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"]
+]

.gitignore

@@ -1,13 +1,26 @@
-_build/
-doc/
-deps/
+# The directory Mix will write compiled artifacts to.
+/_build/
+
+# If you run "mix test --cover", coverage assets end up here.
+/cover/
+
+# The directory Mix downloads your dependencies sources to.
+/deps/
+
+# Where third-party dependencies like ExDoc output generated docs.
+/doc/
+
+# Ignore .fetch files in case you like to edit your project deps locally.
+/.fetch
+
+# If the VM crashes, it generates a dump, let's ignore it too.
 erl_crash.dump
+
+# Also ignore archive artifacts (built via "mix archive.build").
 *.ez
-tmp/
-.tool-versions
-.elixir_ls
-plt_core_path/*.plt
-.idea/
-*.iml
-*.code-workspace
-data/
+
+# Ignore package tarball (built via "mix hex.build").
+mongodb_driver-*.tar
+
+# Temporary files, for example, from tests.
+/tmp/

CHANGELOG.md

@@ -1,37 +1,45 @@
-## 0.8.0 (0.7.5 was not published)
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+
+## 0.8.0 (2021-11-07) (0.7.5 was not published)
 * Enhancements
   * replica set connection: faster topology update if the primary is down (thanks to p-mongo)
   * added custom `Mongo.Encoder` protocol (thanks to esse)
   * added collection from yildun project
   * fixed an issue that the bulk operation does not stop after any insert/update/delete failed (thanks to ja-jimenez)
 
-## 0.7.4
+## 0.7.4 (2021-06-21)
 * Enhancements
-  * added a new option to specify a timeout, when increasing the connction pool is no option
+  * added a new option to specify a timeout, when increasing the connection pool is no option
 
-## 0.7.3
+## 0.7.3 (2021-05-29)
 
 * Enhancements
   * added support for OTP 24
   * Add support for tls setting in connection string (tschmittni)
   * Replace deprecated functions (OTP 24) (aenglisc )
-  
-## 0.7.2
+
+## 0.7.2 (2021-05-19)
 
 * Enhancements
   * Adds test to cover one of Mongo.find/4 errors (vukanac)
   * Update specs for Mongo.find/4 with error tuple (vukanac)
   * Fix build warnings and correct typespec (joeapearson)
   * Update db_connection version to remove System.stacktrace warnings (vukanac)
   * Update SCRAM auth procedure (LetThereBeDwight)
-  
-## 0.7.1
+
+## 0.7.1 (2021-01-01)
 
 * Enhancements
     * upgraded decimal to 2.0, jason to 1.2
     * Add proper support for tailable cursors and awaitData (PR #74)
 
-## 0.7.0
+## 0.7.0 (2020-04-17)
 
 * Enhancements
     * refactored event notification system
@@ -44,43 +52,43 @@
 * Bugfixes
     * Using `max_staleness_ms` > 0 results in a crash
     * Read preferences are sent to mongos
-     
-## 0.6.5
+
+## 0.6.5 (2020-03-30)
 
 * Enhancements
     * updated db_connection dependency
     * generalize inconsistent typespecs
     * new function `BSON.ObjectId.decode/1` and `BSON.ObjectId.encode/1`
-    * new function `Mongo.uuid/1` 
-    
-## 0.6.4
+    * new function `Mongo.uuid/1`
+
+## 0.6.4 (2020-01-24)
 
 * Bugfixes
-    * fixed bug in `Mongo.TopologyDescription` in case of a shard cluster deployment (#39)    
-    
-## 0.6.3
+    * fixed bug in `Mongo.TopologyDescription` in case of a shard cluster deployment (#39)
+
+## 0.6.3 (2020-01-23)
 
 * Enhancements
     * basic support for inserting structs
     * removed duplicated code
     * Cursor-API raises a `Mongo.Error` instead of a `FunctionClauseError`
-    
+
 * Bugfixes
     * `:appname` option (typo) #38
     * fixed index creation in `Mongo.GridFs.Bucket`
-    
-## 0.6.2
+
+## 0.6.2 (2019-11-15)
 
 * Enhancements
-    * refactored the api of `Mongo.limits` and `Mongo.wire_version` 
+    * refactored the api of `Mongo.limits` and `Mongo.wire_version`
     * add support for tracking recovery token from response in a sharded transaction
-    
-## 0.6.1
+
+## 0.6.1 (2019-11-01)
 
 * Enhancements
     * refactored `Mongo.Session` and `Mongo.Session.SessionPool` because of poor performance
-    
-## 0.6.0
+
+## 0.6.0 (2019-09-18)
 
 * Enhancements
     * refactored `writeConcern`
@@ -90,59 +98,59 @@
     * added support for transaction
     * added Decimal128 encoder
     * added support for transaction to gridfs and bulk operation
-    * added `create` command (explicitly creating a collection or view)    
-    
-## 0.5.7
+    * added `create` command (explicitly creating a collection or view)
+
+## 0.5.7 (2019-06-25)
 
 * Bug Fixes
    * Test for existing index in `Bucket` works right now
 
 * Enhancements
-   * Better handling for the `:timeout` options 
+   * Better handling for the `:timeout` options
 
-## 0.5.6
+## 0.5.6 (2019-06-14)
 
 * Bug Fixes
     * Fixed a match error in `after_fun` of cursor module
-    * Fixed a match error in the result of function `Monitor.force_check` 
+    * Fixed a match error in the result of function `Monitor.force_check`
     * Resolved decode problem for the Binary (Old) BinData subtype
-    
+
 * Enhancements
     * Added support for `Mongo.BulkWriteResult`
 
-## 0.5.5
+## 0.5.5 (2019-05-22)
 
 * Bug Fixes
     * Fixed a match error when using Windows OS
-    
-## 0.5.4
+
+## 0.5.4 (2019-05-21)
 
 * Enhancements
-   * The driver provides now client metadata 
+   * The driver provides now client metadata
    * Added support for connecting via UNIX sockets (`:socket` and `:socket_dir`)
    * Added support for bulk writes (ordered/unordered, in-memory/stream)
-   * Added support for `op_msg` with payload type 1 
+   * Added support for `op_msg` with payload type 1
    * Merged code from https://github.com/ankhers/mongodb/commit/63c20ff7e427744a5df915751adfaf6e5e39ae62
    * Merged changes from https://github.com/ankhers/mongodb/pull/283
    * Merged changes from https://github.com/ankhers/mongodb/pull/281
 
-## 0.5.3
+## 0.5.3 (2019-05-02)
 
 * Enhancements
    * Travis now using the right MongoDB version
-   
+
 * Bug Fixes
    * Added test unit for change streams
    * Removed debug code from change streams
 
-## 0.5.2
+## 0.5.2 (2019-05-01)
 
 * Enhancements
   * Added `op_msg` support ([See](https://docs.mongodb.com/manual/reference/mongodb-wire-protocol/#op-msg))
   * Fixed change streams in case of error codes: 11601, 136 and 237 from resuming
-  * Reorganized error handling   
-  
-## 0.5.1
+  * Reorganized error handling
+
+## 0.5.1 (2019-04-28)
 
 * Enhancements
   * Upgraded to DBConnection 2.0.6
@@ -166,14 +174,14 @@
   * Properly parse write concern for URL
   * Properly follow read preference for `secondary_preferred`
 
-## 0.4.7
+## v0.4.7 (2018-09-13)
 
 * Enhancements
   * Added 4.0 to supported versions
   * Initial support for mongodb+srv URLs
   * Support for Decimal128
 
-## 0.4.6
+## v0.4.6 (2018-05-20)
 
 * Enhancements
   * Added `:connect_timout_ms` to `Mongo.start_link/1`

LICENSE

@@ -174,28 +174,3 @@
       of your accepting any such warranty or additional liability.
 
    END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.

README.md

@@ -2,9 +2,12 @@
 
 [![Build Status](https://travis-ci.org/zookzook/elixir-mongodb-driver.svg?branch=master)](https://travis-ci.org/zookzook/elixir-mongodb-driver)
 [![Hex.pm](https://img.shields.io/hexpm/v/mongodb_driver.svg)](https://hex.pm/packages/mongodb_driver)
+[![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/mongo_driver/)
 [![Hex.pm](https://img.shields.io/hexpm/dt/mongodb_driver.svg)](https://hex.pm/packages/mongodb_driver)
 [![Hex.pm](https://img.shields.io/hexpm/dw/mongodb_driver.svg)](https://hex.pm/packages/mongodb_driver)
 [![Hex.pm](https://img.shields.io/hexpm/dd/mongodb_driver.svg)](https://hex.pm/packages/mongodb_driver)
+[![License](https://img.shields.io/hexpm/l/mongodb_driver.svg)](https://github.com/zookzook/elixir-mongodb-driver/blob/master/LICENSE)
+[![Last Updated](https://img.shields.io/github/last-commit/zookzook/elixir-mongodb-driver.svg)](https://github.com/zookzook/elixir-mongodb-driver/commits/master)
 
 ## Features
 
@@ -108,7 +111,7 @@ While using the `Mongo.Encoder` protocol give you the possibility to encode your
 * support for derived values
 
 When using the MongoDB driver only maps and keyword lists are used to represent documents.
-If you would prefere to use structs instead of the maps to give the document a stronger meaning or to emphasize
+If you would prefer to use structs instead of the maps to give the document a stronger meaning or to emphasize
 its importance, you have to create a `defstruct` and fill it from the map manually:
 
 ```elixir
@@ -149,7 +152,7 @@ convert manually, too. If you take a closer look at the necessary work, two basi
 ```elixir
 defmodule Label do
     use Mongo.Collection
-    
+
     document do
       attribute :name, String.t(), default: "warning"
       attribute :color, String.t(), default: :red
@@ -162,9 +165,9 @@ This results in the following module:
 defmodule Label do
 
     defstruct [name: "warning", color: "red"]
-    
+
     @type t() :: %Label{String.t(), String.t()}
-    
+
     def new()...
     def load(map)...
     def dump(%Label{})...
@@ -201,9 +204,9 @@ iex(3)> Label.load(m, true)
 %Label{color: nil, name: nil}
 ```
 
-The background is that MongoDB always returns binarys as keys and structs use atoms as keys. 
+The background is that MongoDB always returns binarys as keys and structs use atoms as keys.
 
-For more information look at the module documentation [Mongo.Collection](https://hexdocs.pm/mongodb_driver/Mongo.Collection.html#content). 
+For more information look at the module documentation [Mongo.Collection](https://hexdocs.pm/mongodb_driver/Mongo.Collection.html#content).
 
 Of course, using the `Mongo.Collection` is not free. When loading and saving, the maps are converted into structures, which increases CPU usage somewhat. When it comes to speed, it is better to use the maps directly.
 
@@ -593,7 +596,7 @@ iex> Mongo.find_one(conn, "test", %{})
 [info] Received command: %Mongo.Events.CommandSucceededEvent{command_name: :find, ...
 ```
 
-## Testing 
+## Testing
 
 Latest MongoDB is used while running the tests. Replica set of three nodes is created and runs all test except the socket and ssl test. If you want to
 run the test cases against other MongoDB deployments or older versions, you can use the [mtools](https://github.com/rueckstiess/mtools) for deployment and run the test cases locally:
@@ -634,17 +637,14 @@ bulk operations.
 
 Special thanks to [JetBrains](https://www.jetbrains.com/?from=elixir-mongodb-driver) for providing a free JetBrains Open Source license for their complete toolbox.
 
-## License
-
-Copyright 2015 Eric Meadows-Jönsson and Justin Wood
+## Copyright and License
 
+Copyright 2015 Eric Meadows-Jönsson and Justin Wood \
 Copyright 2019 - 2021 Michael Maier
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
+You may obtain a copy of the License at [https://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0)
 
 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,

examples/change_stream/README.md

@@ -5,7 +5,7 @@ This project shows a change stream example. You need to set up a replica set, be
 * https://www.mongodb.com/blog/post/an-introduction-to-change-streams
 * https://docs.mongodb.com/manual/changeStreams/
 
-If you creating a new replica set then you need to create the database `db-1` first, before starting the example. Otherwise you will get some errors, because the database which we will observe does not exsists.
+If you creating a new replica set then you need to create the database `db-1` first, before starting the example. Otherwise you will get some errors, because the database which we will observe does not exists.
 
 The `ChangeStream` module uses a GenServer for observing changes. It spawns a process to consume the documents returned by the change stream cursor:
 

examples/crud_example/lib/crud_example.ex

@@ -10,7 +10,7 @@ defmodule CrudExample do
         mobile: "+49 222192938383",
         fax: "+49 3332929292"
       },
-      addess: %{
+      address: %{
         street: "Fasanenweg 5",
         postal_code: "12345",
         city: "Berlin",