Misc doc changes (#183)

* Misc doc changes Besides other documentation changes, this commit includes all relevant documents to the generated HTML doc for HexDocs.pm and leverages on latest features of ExDoc. * Add back in ignoring elixir_ls Co-authored-by: Scott Ames-Messinger <scott@commoncurriculum.com>

Author: kianmeng

.gitignore

@@ -7,7 +7,7 @@
 # The directory Mix downloads your dependencies sources to.
 /deps/
 
-# Where 3rd-party dependencies like ExDoc output generated docs.
+# Where third-party dependencies like ExDoc output generated docs.
 /doc/
 
 # Ignore .fetch files in case you like to edit your project deps locally.
@@ -19,9 +19,15 @@ erl_crash.dump
 # Also ignore archive artifacts (built via "mix archive.build").
 *.ez
 
+# Ignore package tarball (built via "mix hex.build").
+mongodb_ecto-*.tar
+
 # Ignore files created by the Elixir Language Service (ElixirLS)
 /.elixir_ls/
 
+# Temporary files, for example, from tests.
+/tmp/
+
 # Ignore incredibly irritating file that macOS places in indexed directories
 .DS_Store
 
@@ -36,4 +42,4 @@ coverage.xml
 /priv/plts/*.plt.hash
 
 # IEx scripts particular to individual developers
-.iex.exs
+.iex.exs

CHANGELOG.md

@@ -1,21 +1,26 @@
 # 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).
+
 ## Unreleased
 
 * Introduce support for Ecto 3 (work in progress)
 * Introduce GitHub actions, replacing Travis CI
 
 ### Possible breaking changes
 
-* Some upsert operations are only supported with MongoDBs 4.2 or newer.
+ * Some upsert operations are only supported with MongoDBs 4.2 or newer.
 
-## v0.1.4
+## v0.1.4 (2016-03-03)
 
- Support MongoDB version 3.2
+ * Support MongoDB version 3.2
 
-## v0.1.3
+## v0.1.3 (2016-01-15)
 
- This version is limited to Ecto 1.0 because of known issues with 1.1
+ * This version is limited to Ecto 1.0 because of known issues with 1.1
 
  * Additions:
  * Implement `count(field, :distinct)`
@@ -25,7 +30,7 @@
  * Implement `Ecto.Adapter.stop/2` callback
  * Move encoding to adapter `load` and `dump` callbacks
 
-## v0.1.2
+## v0.1.2 (2015-10-18)
 
  * Breaking changes:
  * Raise on `limit` and `offset` in `update_all` and `delete_all` queries,
@@ -34,11 +39,11 @@
  * Bug fixes:
  * Allow interpolation in limit and offset
 
-## v0.1.1
+## v0.1.1 (2015-08-30)
 
  * Bug fixes:
  * Fix logging issues on find queries
 
-## v0.1.0
+## v0.1.0 (2015-08-25)
 
-First release
+ * First release

LICENSE

@@ -0,0 +1,177 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS

README.md

@@ -1,7 +1,13 @@
 # Mongo.Ecto
 
+![CI](https://github.com/elixir-mongo/mongodb_ecto/actions/workflows/ci.yml/badge.svg)
 [![Hex.pm](https://img.shields.io/hexpm/v/mongodb_ecto.svg)](https://hex.pm/packages/mongodb_ecto)
-![CI](https://github.com/avid-technology/mongodb_ecto/actions/workflows/ci.yml/badge.svg)
+[![Module Version](https://img.shields.io/hexpm/v/mongodb_ecto.svg)](https://hex.pm/packages/mongodb_ecto)
+[![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/mongodb_ecto/)
+[![Total Download](https://img.shields.io/hexpm/dt/mongodb_ecto.svg)](https://hex.pm/packages/mongodb_ecto)
+[![License](https://img.shields.io/hexpm/l/mongodb_ecto.svg)](https://github.com/elixir-mongo/mongodb_ecto/blob/master/LICENSE)
+[![Last Updated](https://img.shields.io/github/last-commit/elixir-mongo/mongodb_ecto.svg)](https://github.com/elixir-mongo/mongodb_ecto/commits/master)
+
 
 `Mongo.Ecto` is a MongoDB adapter for Ecto.
 
@@ -49,21 +55,26 @@ end
 
 ## Usage
 
-Add Mongo.Ecto as a dependency in your `mix.exs` file.
+Add `:mongodb_ecto` as a dependency in your `mix.exs` file.
+
 ```elixir
 def deps do
- [{:mongodb_ecto, "~> 0.1"}]
+ [
+ {:mongodb_ecto, "~> 0.2"}
+ ]
 end
 ```
 
-You should also update your applications to include both projects.
+You should also update your applications to include both projects:
+
 ```elixir
 def application do
  [applications: [:logger, :mongodb_ecto, :ecto]]
 end
 ```
 
 To use the adapter in your repo:
+
 ```elixir
 defmodule MyApp.Repo do
  use Ecto.Repo,
@@ -123,15 +134,13 @@ $ cd mongodb_ecto
 $ mix test
 ```
 
-## License
+## Copyright and License
 
 Copyright 2015 Michał Muskała
 
 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,

lib/mongo_ecto.ex

@@ -247,7 +247,7 @@ defmodule Mongo.Ecto do
  end
 
  Keep in mind that Ecto associations are stored in different Mongo collections
- and multiple queries may be required for retriving them.
+ and multiple queries may be required for retrieving them.
 
  While `Mongo.Ecto` supports almost all association features in Ecto, keep in
  mind that MongoDB does not support joins as used in SQL - it's not possible to
@@ -331,7 +331,7 @@ defmodule Mongo.Ecto do
  * embedded documents either with `:map` type, or embedded models
  * partial updates using `change_map/2` and `change_array/2` from the
  `Mongo.Ecto.Helpers` module
- * queries using javascript expresssion and regexes using respectively
+ * queries using javascript expression and regexes using respectively
  `javascript/2` and `regex/2` functions from `Mongo.Ecto.Helpers` module.
 
  ### MongoDB adapter options
@@ -821,7 +821,7 @@ defmodule Mongo.Ecto do
  (default: repo's database)
  * `:log` - should command queries be logged (default: true)
 
- For list of available commands plese see: http://docs.mongodb.org/manual/reference/command/
+ For list of available commands please see: http://docs.mongodb.org/manual/reference/command/
  """
  @spec command(Ecto.Repo.t(), BSON.document(), Keyword.t()) :: BSON.document()
  def command(repo, command, opts \\ []) do

lib/mongo_ecto/normalized_query.ex

@@ -255,7 +255,7 @@ defmodule Mongo.Ecto.NormalizedQuery do
  # which we need since we need to know the ID of the inserted or updated
  # document. Ecto expects updates **not** to return an ID but Mongo always
  # does (seems like a rare moment where Mongo has slightly clearer support
- # than SQL). It's expected that this discrepency is massaged out
+ # than SQL). It's expected that this discrepancy is massaged out
  # elsewhere.
  opts = [
  upsert: true