Added private schema names

CHANGELOG.md

@@ -5,6 +5,15 @@ 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
+
+### Added
+
+- `SchemaName:private` and `CollectionName::private` are two new constructors
+  that allow defining names without specifying an authority. Developers
+  creatingreusable collections and/or schemas should not use these methods as
+  namespacing is meant to help prevent name collisions.
+
 ## v0.1.0
 
 ### Added

README.md

@@ -24,7 +24,7 @@ struct Shape {
 
 impl Collection for Shape {
     fn collection_name() -> CollectionName {
-        CollectionName::new("khonsulabs", "shapes")
+        CollectionName::private("shapes")
     }
 
     fn define_views(schema: &mut Schematic) -> Result<(), Error> {

benchmarks/benches/collections/bonsai.rs

@@ -17,7 +17,7 @@ use crate::collections::ResizableDocument;
 
 impl Collection for ResizableDocument {
     fn collection_name() -> CollectionName {
-        CollectionName::new("khonsulabs", "resizable-docs")
+        CollectionName::private("resizable-docs")
     }
 
     fn define_views(_schema: &mut Schematic) -> Result<(), Error> {

book/book-examples/tests/view-example-enum.rs

@@ -39,7 +39,7 @@ pub struct BlogPost {
 
 impl Collection for BlogPost {
     fn collection_name() -> CollectionName {
-        CollectionName::new("view-example", "blog-post")
+        CollectionName::private("blog-post")
     }
 
     fn define_views(schema: &mut bonsaidb::core::schema::Schematic) -> Result<(), Error> {

book/book-examples/tests/view-example-string.rs

@@ -27,7 +27,7 @@ pub struct BlogPost {
 
 impl Collection for BlogPost {
     fn collection_name() -> CollectionName {
-        CollectionName::new("view-example", "blog-post")
+        CollectionName::private("blog-post")
     }
 
     fn define_views(schema: &mut bonsaidb::core::schema::Schematic) -> Result<(), Error> {

crates/bonsaidb-core/src/connection.rs

@@ -55,7 +55,7 @@ use crate::{
 ///
 /// impl Collection for MyCollection {
 ///     fn collection_name() -> CollectionName {
-///         CollectionName::new("MyAuthority", "MyCollection")
+///         CollectionName::private("MyCollection")
 ///     }
 ///
 ///     fn define_views(schema: &mut Schematic) -> Result<(), Error> {
@@ -1585,7 +1585,7 @@ macro_rules! __doctest_prelude {
 
         impl Schema for MySchema {
             fn schema_name() -> SchemaName {
-                SchemaName::new("MyAuthority", "MySchema")
+                SchemaName::private("MySchema")
             }
 
             fn define_collections(schema: &mut Schematic) -> Result<(), Error> {
@@ -1616,7 +1616,7 @@ macro_rules! __doctest_prelude {
 
         impl Collection for MyCollection {
             fn collection_name() -> CollectionName {
-                CollectionName::new("MyAuthority", "MyCollection")
+                CollectionName::private("MyCollection")
             }
 
             fn define_views(schema: &mut Schematic) -> Result<(), bonsaidb_core::Error> {

crates/bonsaidb-core/src/schema/names.rs

@@ -195,6 +195,14 @@ pub struct SchemaName {
 }
 
 impl SchemaName {
+    /// Creates a name for a [`Schema`](super::Schema) that is not meant
+    /// to be shared with other developers.
+    pub fn private<N: Into<Name>>(name: N) -> Self {
+        let authority = Authority::from("private");
+        let name = name.into();
+        Self { authority, name }
+    }
+
     /// Creates a new schema name.
     pub fn new<A: Into<Authority>, N: Into<Name>>(authority: A, name: N) -> Self {
         let authority = authority.into();
@@ -237,17 +245,27 @@ impl Display for SchemaName {
     }
 }
 
-/// The name of a [`Collection`](super::Collection).
+/// The namespaced name of a [`Collection`](super::Collection).
 #[derive(Hash, PartialEq, Eq, Deserialize, Serialize, Debug, Clone)]
 pub struct CollectionName {
-    /// The authority of this collection.
+    /// The authority of this collection. This name is used to ensure
+    /// collections from multiple authors/authorities can be used in the same
+    /// schema.
     pub authority: Authority,
 
-    /// The name of this collection.
+    /// The name of this collection. Must be unique within the [`Schema`](super::Schema)
     pub name: Name,
 }
 
 impl CollectionName {
+    /// Creates a name for a [`Collection`](super::Collection) that is not meant
+    /// to be shared with other developers.
+    pub fn private<N: Into<Name>>(name: N) -> Self {
+        let authority = Authority::from("private");
+        let name = name.into();
+        Self { authority, name }
+    }
+
     /// Creates a new collection name.
     pub fn new<A: Into<Authority>, N: Into<Name>>(authority: A, name: N) -> Self {
         let authority = authority.into();

crates/bonsaidb-core/src/test_util.rs

@@ -398,7 +398,7 @@ pub struct BasicSchema;
 
 impl Schema for BasicSchema {
     fn schema_name() -> SchemaName {
-        SchemaName::new("khonsulabs", "basic")
+        SchemaName::private("basic")
     }
 
     fn define_collections(schema: &mut Schematic) -> Result<(), Error> {

crates/bonsaidb/crate-docs.md

@@ -22,7 +22,7 @@ struct Shape {
 
 impl Collection for Shape {
     fn collection_name() -> CollectionName {
-        CollectionName::new("khonsulabs", "shapes")
+        CollectionName::private("shapes")
     }
 
     fn define_views(schema: &mut Schematic) -> Result<(), Error> {

examples/basic-local/examples/basic-local-multidb.rs

@@ -23,7 +23,7 @@ struct Message {
 
 impl Collection for Message {
     fn collection_name() -> CollectionName {
-        CollectionName::new("khonsulabs", "messages")
+        CollectionName::private("messages")
     }
 
     fn define_views(_schema: &mut Schematic) -> Result<(), Error> {

examples/basic-local/examples/basic-local.rs

@@ -22,7 +22,7 @@ struct Message {
 
 impl Collection for Message {
     fn collection_name() -> CollectionName {
-        CollectionName::new("khonsulabs", "messages")
+        CollectionName::private("messages")
     }
 
     fn define_views(_schema: &mut Schematic) -> Result<(), Error> {

examples/basic-local/examples/view-examples.rs

@@ -24,7 +24,7 @@ struct Shape {
 
 impl Collection for Shape {
     fn collection_name() -> CollectionName {
-        CollectionName::new("khonsulabs", "shapes")
+        CollectionName::private("shapes")
     }
 
     fn define_views(schema: &mut Schematic) -> Result<(), Error> {

examples/basic-server/examples/support/schema.rs

@@ -22,7 +22,7 @@ impl Shape {
 
 impl Collection for Shape {
     fn collection_name() -> CollectionName {
-        CollectionName::new("khonsulabs", "shapes")
+        CollectionName::private("shapes")
     }
 
     fn define_views(schema: &mut Schematic) -> Result<(), Error> {

examples/view-histogram/examples/view-histogram.rs

@@ -102,7 +102,7 @@ pub struct Samples {
 
 impl Collection for Samples {
     fn collection_name() -> CollectionName {
-        CollectionName::new("histogram-example", "samples")
+        CollectionName::private("samples")
     }
 
     fn define_views(schema: &mut Schematic) -> Result<(), bonsaidb::core::Error> {