Merge pull request #69 from CosmWasm/storage-plus-indexedmap

Add an `IndexedMap` article (without `MultiIndex`)

docs-test-gen/Cargo.toml

@@ -13,10 +13,10 @@ strum = { version = "0.26.2", features = ["derive"] }
 
 [dev-dependencies]
 cw2 = "*"
+cw-storage-plus = { version = "*", features = ["macro"]}
 cosmwasm-schema = "*"
 cosmwasm-std = { version = "*", features = ["stargate", "staking", "cosmwasm_2_0"] }
 sha2 = "0.10.8"
 cosmos-sdk-proto = { version = "0.21.1", default-features = false }                  # Used in IBC code
-cw-storage-plus = "*"
 serde = "*"
 cw-storey = "*"

docs-test-gen/templates/storage.tpl

@@ -1,15 +1,91 @@
 #[allow(unused_imports)]
 mod imports {
-    pub use cosmwasm_std::*;
     pub use cosmwasm_schema::cw_serde;
+    pub use cosmwasm_std::*;
 }
 
 #[allow(unused_imports)]
 use imports::*;
 
+#[allow(dead_code, unused_variables)]
+mod users {
+    use super::*;
+
+    use cw_storage_plus::{index_list, IndexedMap, UniqueIndex};
+
+    pub type Handle = String;
+
+    #[cw_serde]
+    pub struct User {
+        pub handle: String,
+        pub country: String,
+    }
+
+    pub struct ExampleUsers {
+        pub alice: User,
+        pub bob: User,
+    }
+
+    pub fn example_users() -> ExampleUsers {
+        ExampleUsers {
+            alice: User {
+                handle: "alice".to_string(),
+                country: "Wonderland".to_string(),
+            },
+            bob: User {
+                handle: "bob".to_string(),
+                country: "USA".to_string(),
+            },
+        }
+    }
+
+    #[index_list(User)]
+    pub struct UserIndexes<'a> {
+        pub handle_ix: UniqueIndex<'a, Handle, User, Addr>,
+    }
+
+    pub fn user_indexes(prefix: &'static str) -> UserIndexes<'static> {
+        UserIndexes {
+            handle_ix: UniqueIndex::new(|user| user.handle.clone(), prefix),
+        }
+    }
+}
+
 #[test]
 fn doctest() {
-  #[allow(unused_mut)]
-  let mut storage = cosmwasm_std::testing::MockStorage::new();
-  {{code}}
+    #[allow(unused_variables, unused_mut)]
+    let mut storage = cosmwasm_std::testing::MockStorage::new();
+
+    let users = cw_storage_plus::IndexedMap::<Addr, _, _>::new("uu", users::user_indexes("uuh"));
+
+    let users_data = [
+        (
+            Addr::unchecked("aaa"),
+            users::User {
+                handle: "alice".to_string(),
+                country: "Wonderland".to_string(),
+            },
+        ),
+        (
+            Addr::unchecked("bbb"),
+            users::User {
+                handle: "bob".to_string(),
+                country: "USA".to_string(),
+            },
+        ),
+        (
+            Addr::unchecked("ccc"),
+            users::User {
+                handle: "carol".to_string(),
+                country: "UK".to_string(),
+            },
+        ),
+    ];
+
+    for (addr, user) in users_data {
+        users.save(&mut storage, addr, &user).unwrap();
+    }
+
+    #[rustfmt::skip]
+    {{code}}
 }

src/pages/_meta.json

@@ -3,7 +3,7 @@
   "core": "CosmWasm Core",
   "ibc": "IBC",
   "sylvia": "Sylvia",
-  "cw-storage-plus": "cw-storage-plus",
+  "cw-storage-plus": "StoragePlus",
   "cw-multi-test": "MultiTest",
   "how-to-doc": "How to doc",
   "tags": {

src/pages/cw-storage-plus/containers/_meta.json

@@ -1,5 +1,6 @@
 {
   "item": "Item",
   "map": "Map",
-  "deque": "Deque"
+  "deque": "Deque",
+  "indexed-map": "IndexedMap"
 }