cougr-core 1.0.0

Cougr - A Soroban-compatible ECS framework for on-chain gaming on Stellar
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

use super::*;
use soroban_sdk::{symbol_short, Env};

#[test]
fn test_simple_query_cache() {
    let env = Env::default();
    let mut world = crate::simple_world::SimpleWorld::new(&env);

    let e1 = world.spawn_entity();
    let data = soroban_sdk::Bytes::from_array(&env, &[1, 2, 3, 4]);
    world.add_component(e1, symbol_short!("pos"), data);

    let mut cache = SimpleQueryCache::new(symbol_short!("pos"), &env);

    let results = cache.execute(&world, &env);
    assert_eq!(results.len(), 1);
    assert!(cache.is_valid(world.version()));

    let results2 = cache.execute(&world, &env);
    assert_eq!(results2.len(), 1);

    let e2 = world.spawn_entity();
    let data2 = soroban_sdk::Bytes::from_array(&env, &[5, 6, 7, 8]);
    world.add_component(e2, symbol_short!("pos"), data2);
    assert!(!cache.is_valid(world.version()));

    let results3 = cache.execute(&world, &env);
    assert_eq!(results3.len(), 2);
    assert!(cache.is_valid(world.version()));
}

#[test]
fn test_simple_query_cache_invalidate() {
    let env = Env::default();
    let mut cache = SimpleQueryCache::new(symbol_short!("test"), &env);
    let mut world = crate::simple_world::SimpleWorld::new(&env);
    let entity = world.spawn_entity();
    world.add_component(
        entity,
        symbol_short!("test"),
        soroban_sdk::Bytes::from_array(&env, &[1]),
    );
    let _ = cache.execute(&world, &env);
    assert!(cache.is_valid(world.version()));
    cache.invalidate();
    assert!(!cache.is_valid(world.version()));
}

#[test]
fn test_simple_query_builder_with_sparse_and_any() {
    let env = Env::default();
    let mut world = crate::simple_world::SimpleWorld::new(&env);

    let e1 = world.spawn_entity();
    world.add_component(
        e1,
        symbol_short!("pos"),
        soroban_sdk::Bytes::from_array(&env, &[1]),
    );

    let e2 = world.spawn_entity();
    world.add_component_with_storage(
        e2,
        symbol_short!("tag"),
        soroban_sdk::Bytes::from_array(&env, &[2]),
        crate::component::ComponentStorage::Sparse,
    );

    let query = SimpleQueryBuilder::new(&env)
        .with_any_component(symbol_short!("pos"))
        .with_any_component(symbol_short!("tag"))
        .include_sparse()
        .build();

    let results = query.execute(&world, &env);
    assert_eq!(results.len(), 2);
}

#[test]
fn test_simple_query_state_tracks_world_version() {
    let env = Env::default();
    let mut world = crate::simple_world::SimpleWorld::new(&env);
    let query = SimpleQueryBuilder::new(&env)
        .with_component(symbol_short!("pos"))
        .build();
    let mut state = SimpleQueryState::new(query, &env);

    assert_eq!(state.execute(&world, &env).len(), 0);
    assert!(state.is_valid(world.version()));

    let entity = world.spawn_entity();
    world.add_component(
        entity,
        symbol_short!("pos"),
        soroban_sdk::Bytes::from_array(&env, &[3]),
    );

    assert!(!state.is_valid(world.version()));
    assert_eq!(state.execute(&world, &env).len(), 1);
}

#[test]
fn test_simple_query_bulk_filters_and_candidate_count() {
    let env = Env::default();
    let mut world = crate::simple_world::SimpleWorld::new(&env);

    let e1 = world.spawn_entity();
    world.add_component(
        e1,
        symbol_short!("pos"),
        soroban_sdk::Bytes::from_array(&env, &[1]),
    );
    world.add_component(
        e1,
        symbol_short!("vel"),
        soroban_sdk::Bytes::from_array(&env, &[2]),
    );

    let e2 = world.spawn_entity();
    world.add_component(
        e2,
        symbol_short!("pos"),
        soroban_sdk::Bytes::from_array(&env, &[3]),
    );
    world.add_component_with_storage(
        e2,
        symbol_short!("sleep"),
        soroban_sdk::Bytes::from_array(&env, &[4]),
        crate::component::ComponentStorage::Sparse,
    );

    let query = SimpleQueryBuilder::new(&env)
        .with_components(&[symbol_short!("pos")])
        .without_components(&[symbol_short!("sleep")])
        .with_any_components(&[symbol_short!("vel"), symbol_short!("sleep")])
        .include_sparse()
        .build();

    assert_eq!(query.candidate_count(&world, &env), 2);
    let results = query.execute(&world, &env);
    assert_eq!(results.len(), 1);
    assert_eq!(results.get(0), Some(e1));
}