Skip to content

Commit e1586e2

Browse files
committed
Remove uses of the word "Dummy"
It looks like using "Dummy" is not considered good practice - see: projectharmonia/bevy_enhanced_input#76 I've decided to adopt the following convention: * Instead of `DummySomething`, use just `Something` unless it conflicts with a trait. * If it conflicts with a trait, use `ExampleSomething` in docs and `TestSomething` in tests. * Where possible, use more contextual names — e.g., `TableStorage` instead of `DummyComponent` in storage tests. * If multiple types are involved, use `SomethingA`, `SomethingB`, etc. * For variables, prefer `something` instead of `dummy_something`, or use more contextual names when necessary. Overall, I think this makes things clearer and more concise. No API changes required, it just tests and doc examples.
1 parent 3500a93 commit e1586e2

File tree

19 files changed

+321
-326
lines changed

19 files changed

+321
-326
lines changed

bevy_replicon_example_backend/tests/backend.rs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -89,22 +89,22 @@ fn server_event() {
8989
}),
9090
RepliconExampleBackendPlugins,
9191
))
92-
.add_server_event::<DummyEvent>(Channel::Ordered)
92+
.add_server_event::<TestEvent>(Channel::Ordered)
9393
.finish();
9494
}
9595

9696
setup(&mut server_app, &mut client_app).unwrap();
9797

9898
server_app.world_mut().send_event(ToClients {
9999
mode: SendMode::Broadcast,
100-
event: DummyEvent,
100+
event: TestEvent,
101101
});
102102

103103
server_app.update();
104104
client_app.update();
105105

106-
let dummy_events = client_app.world().resource::<Events<DummyEvent>>();
107-
assert_eq!(dummy_events.len(), 1);
106+
let events = client_app.world().resource::<Events<TestEvent>>();
107+
assert_eq!(events.len(), 1);
108108
}
109109

110110
#[test]
@@ -120,20 +120,20 @@ fn client_event() {
120120
}),
121121
RepliconExampleBackendPlugins,
122122
))
123-
.add_client_event::<DummyEvent>(Channel::Ordered)
123+
.add_client_event::<TestEvent>(Channel::Ordered)
124124
.finish();
125125
}
126126

127127
setup(&mut server_app, &mut client_app).unwrap();
128128

129-
client_app.world_mut().send_event(DummyEvent);
129+
client_app.world_mut().send_event(TestEvent);
130130

131131
client_app.update();
132132
server_app.update();
133133

134134
let client_events = server_app
135135
.world()
136-
.resource::<Events<FromClient<DummyEvent>>>();
136+
.resource::<Events<FromClient<TestEvent>>>();
137137
assert_eq!(client_events.len(), 1);
138138
}
139139

@@ -152,4 +152,4 @@ fn setup(server_app: &mut App, client_app: &mut App) -> io::Result<()> {
152152
}
153153

154154
#[derive(Deserialize, Event, Serialize)]
155-
struct DummyEvent;
155+
struct TestEvent;

src/lib.rs

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -114,10 +114,10 @@ Use [`AppRuleExt::replicate`] to create a replication rule for a single componen
114114
# use serde::{Deserialize, Serialize};
115115
# let mut app = App::new();
116116
# app.add_plugins(RepliconPlugins);
117-
app.replicate::<DummyComponent>();
117+
app.replicate::<ExampleComponent>();
118118
119119
#[derive(Component, Deserialize, Serialize)]
120-
struct DummyComponent;
120+
struct ExampleComponent;
121121
```
122122
123123
If your component contains an entity, it cannot be deserialized as is
@@ -251,7 +251,7 @@ contains sender ID and the sent event.
251251
# use serde::{Deserialize, Serialize};
252252
# let mut app = App::new();
253253
# app.add_plugins(RepliconPlugins);
254-
app.add_client_event::<DummyEvent>(Channel::Ordered)
254+
app.add_client_event::<ExampleEvent>(Channel::Ordered)
255255
.add_systems(
256256
PreUpdate,
257257
receive_events
@@ -263,18 +263,18 @@ app.add_client_event::<DummyEvent>(Channel::Ordered)
263263
send_events.before(ClientSet::Send).run_if(client_connected),
264264
);
265265
266-
fn send_events(mut dummy_events: EventWriter<DummyEvent>) {
267-
dummy_events.send_default();
266+
fn send_events(mut events: EventWriter<ExampleEvent>) {
267+
events.send_default();
268268
}
269269
270-
fn receive_events(mut dummy_events: EventReader<FromClient<DummyEvent>>) {
271-
for FromClient { client_entity, event } in dummy_events.read() {
270+
fn receive_events(mut events: EventReader<FromClient<ExampleEvent>>) {
271+
for FromClient { client_entity, event } in events.read() {
272272
info!("received event `{event:?}` from client `{client_entity}`");
273273
}
274274
}
275275
276276
#[derive(Debug, Default, Deserialize, Event, Serialize)]
277-
struct DummyEvent;
277+
struct ExampleEvent;
278278
```
279279
280280
If an event contains an entity, implement
@@ -295,19 +295,19 @@ using [`ClientTriggerAppExt::add_client_trigger`], and then use [`ClientTriggerE
295295
# use serde::{Deserialize, Serialize};
296296
# let mut app = App::new();
297297
# app.add_plugins(RepliconPlugins);
298-
app.add_client_trigger::<DummyEvent>(Channel::Ordered)
298+
app.add_client_trigger::<ExampleEvent>(Channel::Ordered)
299299
.add_observer(receive_events)
300300
.add_systems(Update, send_events.run_if(client_connected));
301301
302302
fn send_events(mut commands: Commands) {
303-
commands.client_trigger(DummyEvent);
303+
commands.client_trigger(ExampleEvent);
304304
}
305305
306-
fn receive_events(trigger: Trigger<FromClient<DummyEvent>>) {
306+
fn receive_events(trigger: Trigger<FromClient<ExampleEvent>>) {
307307
info!("received event `{:?}` from client `{}`", **trigger, trigger.client_entity);
308308
}
309309
# #[derive(Event, Debug, Deserialize, Serialize)]
310-
# struct DummyEvent;
310+
# struct ExampleEvent;
311311
```
312312
313313
Trigger targets are also supported via [`ClientTriggerExt::client_trigger_targets`], no change
@@ -329,7 +329,7 @@ and the event itself.
329329
# use serde::{Deserialize, Serialize};
330330
# let mut app = App::new();
331331
# app.add_plugins(RepliconPlugins);
332-
app.add_server_event::<DummyEvent>(Channel::Ordered)
332+
app.add_server_event::<ExampleEvent>(Channel::Ordered)
333333
.add_systems(
334334
PreUpdate,
335335
receive_events
@@ -341,21 +341,21 @@ app.add_server_event::<DummyEvent>(Channel::Ordered)
341341
send_events.before(ServerSet::Send).run_if(server_running),
342342
);
343343
344-
fn send_events(mut dummy_events: EventWriter<ToClients<DummyEvent>>) {
345-
dummy_events.write(ToClients {
344+
fn send_events(mut events: EventWriter<ToClients<ExampleEvent>>) {
345+
events.write(ToClients {
346346
mode: SendMode::Broadcast,
347-
event: DummyEvent,
347+
event: ExampleEvent,
348348
});
349349
}
350350
351-
fn receive_events(mut dummy_events: EventReader<DummyEvent>) {
352-
for event in dummy_events.read() {
351+
fn receive_events(mut events: EventReader<ExampleEvent>) {
352+
for event in events.read() {
353353
info!("received event {event:?} from server");
354354
}
355355
}
356356
357357
#[derive(Clone, Copy, Debug, Default, Deserialize, Event, Serialize)]
358-
struct DummyEvent;
358+
struct ExampleEvent;
359359
```
360360
361361
Just like for client events, we provide [`ServerEventAppExt::add_mapped_server_event`]
@@ -370,22 +370,22 @@ with [`ServerTriggerAppExt::add_server_trigger`] and then use [`ServerTriggerExt
370370
# use serde::{Deserialize, Serialize};
371371
# let mut app = App::new();
372372
# app.add_plugins(RepliconPlugins);
373-
app.add_server_trigger::<DummyEvent>(Channel::Ordered)
373+
app.add_server_trigger::<ExampleEvent>(Channel::Ordered)
374374
.add_observer(receive_events)
375375
.add_systems(Update, send_events.run_if(server_running));
376376
377377
fn send_events(mut commands: Commands) {
378378
commands.server_trigger(ToClients {
379379
mode: SendMode::Broadcast,
380-
event: DummyEvent,
380+
event: ExampleEvent,
381381
});
382382
}
383383
384-
fn receive_events(trigger: Trigger<DummyEvent>) {
384+
fn receive_events(trigger: Trigger<ExampleEvent>) {
385385
info!("received event {:?} from server", *trigger);
386386
}
387387
# #[derive(Event, Debug, Deserialize, Serialize)]
388-
# struct DummyEvent;
388+
# struct ExampleEvent;
389389
```
390390
391391
And just like for client trigger, we provide [`ServerTriggerAppExt::add_mapped_server_trigger`]

src/shared/event/server_event/client_event_queue.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ mod tests {
7676

7777
#[test]
7878
fn lower_tick() {
79-
let mut queue = ClientEventQueue::<DummyEvent>::default();
79+
let mut queue = ClientEventQueue::<TestEvent>::default();
8080
queue.insert(RepliconTick::new(1), Default::default());
8181

8282
assert_eq!(queue.len(), 1);
@@ -85,7 +85,7 @@ mod tests {
8585

8686
#[test]
8787
fn bigger_tick() {
88-
let mut queue = ClientEventQueue::<DummyEvent>::default();
88+
let mut queue = ClientEventQueue::<TestEvent>::default();
8989
queue.insert(RepliconTick::new(1), Default::default());
9090

9191
assert!(queue.pop_if_le(RepliconTick::new(2)).is_some());
@@ -94,7 +94,7 @@ mod tests {
9494

9595
#[test]
9696
fn ticks_ordering() {
97-
let mut queue = ClientEventQueue::<DummyEvent>::default();
97+
let mut queue = ClientEventQueue::<TestEvent>::default();
9898
queue.insert(RepliconTick::new(0), Default::default());
9999
queue.insert(RepliconTick::new(1), Default::default());
100100
queue.insert(RepliconTick::new(2), Default::default());
@@ -111,7 +111,7 @@ mod tests {
111111

112112
#[test]
113113
fn messages_ordering() {
114-
let mut queue = ClientEventQueue::<DummyEvent>::default();
114+
let mut queue = ClientEventQueue::<TestEvent>::default();
115115
queue.insert(RepliconTick::new(0), Bytes::from_static(&[0]));
116116
queue.insert(RepliconTick::new(0), Bytes::from_static(&[1]));
117117

@@ -121,5 +121,5 @@ mod tests {
121121
assert!(queue.is_empty());
122122
}
123123

124-
struct DummyEvent;
124+
struct TestEvent;
125125
}

src/shared/replication/command_markers.rs

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -319,9 +319,9 @@ mod tests {
319319
let mut app = App::new();
320320
app.init_resource::<CommandMarkers>()
321321
.init_resource::<ReplicationRegistry>()
322-
.set_marker_fns::<DummyMarkerA, DummyComponent>(
322+
.set_marker_fns::<Marker, TestComponent>(
323323
command_fns::default_write,
324-
command_fns::default_remove::<DummyComponent>,
324+
command_fns::default_remove::<TestComponent>,
325325
);
326326
}
327327

@@ -330,16 +330,16 @@ mod tests {
330330
let mut app = App::new();
331331
app.init_resource::<CommandMarkers>()
332332
.init_resource::<ReplicationRegistry>()
333-
.register_marker::<DummyMarkerA>()
334-
.register_marker_with::<DummyMarkerB>(MarkerConfig {
333+
.register_marker::<MarkerA>()
334+
.register_marker_with::<MarkerB>(MarkerConfig {
335335
priority: 2,
336336
..Default::default()
337337
})
338-
.register_marker_with::<DummyMarkerC>(MarkerConfig {
338+
.register_marker_with::<MarkerC>(MarkerConfig {
339339
priority: 1,
340340
..Default::default()
341341
})
342-
.register_marker::<DummyMarkerD>();
342+
.register_marker::<MarkerD>();
343343

344344
let markers = app.world().resource::<CommandMarkers>();
345345
let priorities: Vec<_> = markers
@@ -351,17 +351,20 @@ mod tests {
351351
}
352352

353353
#[derive(Component)]
354-
struct DummyMarkerA;
354+
struct Marker;
355355

356356
#[derive(Component)]
357-
struct DummyMarkerB;
357+
struct MarkerA;
358358

359359
#[derive(Component)]
360-
struct DummyMarkerC;
360+
struct MarkerB;
361361

362362
#[derive(Component)]
363-
struct DummyMarkerD;
363+
struct MarkerC;
364+
365+
#[derive(Component)]
366+
struct MarkerD;
364367

365368
#[derive(Component, Serialize, Deserialize)]
366-
struct DummyComponent;
369+
struct TestComponent;
367370
}

src/shared/replication/replication_registry/test_fns.rs

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -45,25 +45,25 @@ let tick = RepliconTick::default();
4545
let (_, fns_id) = app
4646
.world_mut()
4747
.resource_scope(|world, mut registry: Mut<ReplicationRegistry>| {
48-
registry.register_rule_fns(world, RuleFns::<DummyComponent>::default())
48+
registry.register_rule_fns(world, RuleFns::<ExampleComponent>::default())
4949
});
5050
51-
let mut entity = app.world_mut().spawn(DummyComponent);
51+
let mut entity = app.world_mut().spawn(ExampleComponent);
5252
let data = entity.serialize(fns_id, tick);
53-
entity.remove::<DummyComponent>();
53+
entity.remove::<ExampleComponent>();
5454
5555
entity.apply_write(data, fns_id, tick);
56-
assert!(entity.contains::<DummyComponent>());
56+
assert!(entity.contains::<ExampleComponent>());
5757
5858
entity.apply_remove(fns_id, tick);
59-
assert!(!entity.contains::<DummyComponent>());
59+
assert!(!entity.contains::<ExampleComponent>());
6060
6161
entity.apply_despawn(tick);
62-
let mut replicated = app.world_mut().query::<&DummyComponent>();
62+
let mut replicated = app.world_mut().query::<&ExampleComponent>();
6363
assert_eq!(replicated.iter(app.world()).len(), 0);
6464
6565
#[derive(Component, Serialize, Deserialize)]
66-
struct DummyComponent;
66+
struct ExampleComponent;
6767
```
6868
**/
6969
pub trait TestFnsEntityExt {

0 commit comments

Comments
 (0)