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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
use crate::values::Value;
use crate::{commit::CommitBuilder, errors::AtomicResult};
use crate::{
mapping::is_url,
schema::{Class, Property},
Atom, Storelike,
};
use serde::{Deserialize, Serialize};
use std::collections::HashMap;
#[derive(Clone, Serialize, Deserialize, Debug)]
pub struct Resource {
propvals: PropVals,
subject: String,
commit: CommitBuilder,
}
pub type PropVals = HashMap<String, Value>;
impl Resource {
pub fn append_subjects(
&mut self,
property: &str,
values: Vec<String>,
must_be_unique: bool,
store: &impl Storelike,
) -> AtomicResult<()> {
match self.get(property) {
Ok(existing) => {
let mut subjects = existing.to_subjects(None)?;
for value in values {
if subjects.contains(&value) {
if must_be_unique {
subjects.push(value);
}
continue;
} else {
subjects.push(value);
continue;
}
}
self.set_propval(property.into(), subjects.into(), store)
}
Err(_no_val) => self.set_propval(property.into(), values.into(), store),
}
}
pub fn check_required_props(&self, store: &impl Storelike) -> AtomicResult<()> {
let classvec = self.get_classes(store)?;
for class in classvec.iter() {
for required_prop in class.requires.clone() {
self.get(&required_prop).map_err(|_e| {
format!(
"Property {} missing. Is required in class {} ",
&required_prop, class.subject
)
})?;
}
}
Ok(())
}
pub fn destroy(
&mut self,
store: &impl Storelike,
) -> AtomicResult<crate::commit::CommitResponse> {
self.commit.destroy(true);
self.save(store)
}
pub fn from_propvals(propvals: PropVals, subject: String) -> Resource {
Resource {
propvals,
commit: CommitBuilder::new(subject.clone()),
subject,
}
}
pub fn get(&self, property_url: &str) -> AtomicResult<&Value> {
Ok(self.propvals.get(property_url).ok_or(format!(
"Property {} for resource {} not found",
property_url, self.subject
))?)
}
pub fn get_commit_builder(&self) -> &CommitBuilder {
&self.commit
}
pub fn get_classes(&self, store: &impl Storelike) -> AtomicResult<Vec<Class>> {
let mut classes: Vec<Class> = Vec::new();
if let Ok(val) = self.get(crate::urls::IS_A) {
for class in val.to_subjects(None)? {
classes.push(store.get_class(&class)?)
}
}
Ok(classes)
}
pub fn get_main_class(&self) -> AtomicResult<String> {
if let Ok(val) = self.get(crate::urls::IS_A) {
Ok(val.to_subjects(None)?[0].clone())
} else {
Err(format!("Resource {} has no class", self.subject).into())
}
}
pub fn get_propvals(&self) -> &PropVals {
&self.propvals
}
pub fn get_shortname(&self, shortname: &str, store: &impl Storelike) -> AtomicResult<&Value> {
let prop = self.resolve_shortname_to_property(shortname, store)?;
self.get(&prop.subject)
}
pub fn get_subject(&self) -> &String {
&self.subject
}
pub fn into_propvals(self) -> PropVals {
self.propvals
}
pub fn new(subject: String) -> Resource {
let propvals: PropVals = HashMap::new();
Resource {
propvals,
subject: subject.clone(),
commit: CommitBuilder::new(subject),
}
}
pub fn new_instance(class_url: &str, store: &impl Storelike) -> AtomicResult<Resource> {
let propvals: PropVals = HashMap::new();
let class = store.get_class(class_url)?;
use rand::Rng;
let random_string: String = rand::thread_rng()
.sample_iter(&rand::distributions::Alphanumeric)
.take(7)
.map(char::from)
.collect();
let subject = format!(
"{}/{}/{}",
store.get_server_url(),
&class.shortname,
random_string
);
let mut resource = Resource {
propvals,
subject: subject.clone(),
commit: CommitBuilder::new(subject),
};
let class_urls = Vec::from([String::from(class_url)]);
resource.set_propval(crate::urls::IS_A.into(), class_urls.into(), store)?;
Ok(resource)
}
pub fn remove_propval(&mut self, property_url: &str) {
self.propvals.remove_entry(property_url);
self.commit.remove(property_url.into())
}
pub fn remove_propval_shortname(
&mut self,
property_shortname: &str,
store: &impl Storelike,
) -> AtomicResult<()> {
let property_url = self.resolve_shortname_to_property(property_shortname, store)?;
self.remove_propval(&property_url.subject);
Ok(())
}
pub fn resolve_shortname_to_property(
&self,
shortname: &str,
store: &impl Storelike,
) -> AtomicResult<Property> {
if is_url(shortname) {
return store.get_property(shortname);
}
for (url, _val) in self.propvals.iter() {
if let Ok(prop) = store.get_property(url) {
if prop.shortname == shortname {
return Ok(prop);
}
}
}
let classes = self.get_classes(store)?;
for class in classes {
for required_prop_subject in class.requires {
let required_prop = store.get_property(&required_prop_subject)?;
if required_prop.shortname == shortname {
return Ok(required_prop);
}
}
for recommended_prop_subject in class.recommends {
let recommended_prop = store.get_property(&recommended_prop_subject)?;
if recommended_prop.shortname == shortname {
return Ok(recommended_prop);
}
}
}
Err(format!("Shortname '{}' for '{}' not found", shortname, self.subject).into())
}
pub fn reset_commit_builder(&mut self) {
self.commit = CommitBuilder::new(self.get_subject().clone());
}
pub fn save(&mut self, store: &impl Storelike) -> AtomicResult<crate::commit::CommitResponse> {
let agent = store.get_default_agent()?;
let commitbuilder = self.get_commit_builder().clone();
let commit = commitbuilder.sign(&agent, store)?;
let should_post = store.get_self_url().is_none();
if should_post {
crate::client::post_commit(&commit, store)?;
}
let commit_response = commit.apply(store)?;
self.reset_commit_builder();
Ok(commit_response)
}
pub fn save_locally(&mut self, store: &impl Storelike) -> AtomicResult<crate::Resource> {
let agent = store.get_default_agent()?;
let commitbuilder = self.get_commit_builder().clone();
let commit = commitbuilder.sign(&agent, store)?;
commit.apply(store)?;
self.reset_commit_builder();
let resource = commit.into_resource(store)?;
Ok(resource)
}
pub fn set_propval_string(
&mut self,
property_url: String,
value: &str,
store: &impl Storelike,
) -> AtomicResult<()> {
let fullprop = store.get_property(&property_url).map_err(|e| {
format!(
"Failed setting propval for '{}' because property '{}' could not be found. {}",
self.get_subject(),
property_url,
e
)
})?;
let val = Value::new(value, &fullprop.data_type)?;
self.set_propval_unsafe(property_url, val)?;
Ok(())
}
pub fn set_propval(
&mut self,
property: String,
value: Value,
store: &impl Storelike,
) -> AtomicResult<()> {
let full_prop = store.get_property(&property)?;
if let Some(allowed) = full_prop.allows_only {
if !allowed.contains(&value.to_string()) {
return Err(format!(
"Property '{}' does not allow value '{}'. Allowed: {:?}",
property, value, allowed
)
.into());
}
}
if full_prop.data_type == value.datatype() {
self.set_propval_unsafe(property, value)
} else {
Err(format!("Datatype for subject '{}', property '{}', value '{}' did not match. Wanted '{}', got '{}'",
self.get_subject(),
property,
value.to_string(),
full_prop.data_type,
value.datatype()
).into())
}
}
pub fn set_propval_unsafe(&mut self, property: String, value: Value) -> AtomicResult<()> {
self.propvals.insert(property.clone(), value.clone());
self.commit.set(property, value);
Ok(())
}
pub fn set_propval_shortname(
&mut self,
property: &str,
value: &str,
store: &impl Storelike,
) -> AtomicResult<()> {
let fullprop = self.resolve_shortname_to_property(property, store)?;
let fullval = Value::new(value, &fullprop.data_type)?;
self.set_propval_unsafe(fullprop.subject, fullval)?;
Ok(())
}
pub fn set_propvals_unsafe(&mut self, propvals: PropVals) {
self.propvals = propvals;
}
pub fn set_subject(&mut self, url: String) {
self.commit.set_subject(url.clone());
self.subject = url;
}
pub fn to_json_ad(&self) -> AtomicResult<String> {
let obj = crate::serialize::propvals_to_json_ad_map(
self.get_propvals(),
Some(self.get_subject().clone()),
)?;
serde_json::to_string_pretty(&obj).map_err(|_| "Could not serialize to JSON-AD".into())
}
pub fn to_json(&self, store: &impl Storelike) -> AtomicResult<String> {
let obj = crate::serialize::propvals_to_json_ld(
self.get_propvals(),
Some(self.get_subject().clone()),
store,
false,
)?;
serde_json::to_string_pretty(&obj).map_err(|_| "Could not serialize to JSON".into())
}
pub fn to_json_ld(&self, store: &impl Storelike) -> AtomicResult<String> {
let obj = crate::serialize::propvals_to_json_ld(
self.get_propvals(),
Some(self.get_subject().clone()),
store,
true,
)?;
serde_json::to_string_pretty(&obj).map_err(|_| "Could not serialize to JSON-LD".into())
}
pub fn to_atoms(&self) -> AtomicResult<Vec<Atom>> {
let mut atoms: Vec<Atom> = Vec::new();
for (property, value) in self.propvals.iter() {
let atom = Atom::new(self.subject.to_string(), property.clone(), value.clone());
atoms.push(atom);
}
Ok(atoms)
}
}
#[cfg(test)]
mod test {
use super::*;
use crate::{test_utils::init_store, urls};
#[test]
fn get_and_set_resource_props() {
let store = init_store();
let mut resource = store.get_resource(urls::CLASS).unwrap();
assert!(
resource
.get_shortname("shortname", &store)
.unwrap()
.to_string()
== "class"
);
resource
.set_propval_shortname("shortname", "something-valid", &store)
.unwrap();
assert!(
resource
.get_shortname("shortname", &store)
.unwrap()
.to_string()
== "something-valid"
);
resource
.set_propval_shortname("shortname", "should not contain spaces", &store)
.unwrap_err();
}
#[test]
fn check_required_props() {
let store = init_store();
let mut new_resource = Resource::new_instance(urls::CLASS, &store).unwrap();
new_resource
.set_propval_shortname("shortname", "should-fail", &store)
.unwrap();
new_resource.check_required_props(&store).unwrap_err();
new_resource
.set_propval_shortname("description", "Should succeed!", &store)
.unwrap();
new_resource.check_required_props(&store).unwrap();
}
#[test]
fn new_instance() {
let store = init_store();
let mut new_resource = Resource::new_instance(urls::CLASS, &store).unwrap();
new_resource
.set_propval_shortname("shortname", "person", &store)
.unwrap();
assert!(
new_resource
.get_shortname("shortname", &store)
.unwrap()
.to_string()
== "person"
);
new_resource
.set_propval_shortname("shortname", "human", &store)
.unwrap();
new_resource
.set_propval_shortname("description", "A real human being", &store)
.unwrap();
new_resource.save_locally(&store).unwrap();
assert!(
new_resource
.get_shortname("shortname", &store)
.unwrap()
.to_string()
== "human"
);
let resource_from_store = store.get_resource(new_resource.get_subject()).unwrap();
assert!(
resource_from_store
.get_shortname("shortname", &store)
.unwrap()
.to_string()
== "human"
);
println!(
"{}",
resource_from_store
.get_shortname("is-a", &store)
.unwrap()
.to_string()
);
assert_eq!(
resource_from_store
.get_shortname("is-a", &store)
.unwrap()
.to_string(),
"https://atomicdata.dev/classes/Class"
);
assert!(resource_from_store.get_classes(&store).unwrap()[0].shortname == "class");
}
#[test]
fn new_instance_using_commit() {
let store = init_store();
let agent = store.get_default_agent().unwrap();
let mut new_resource = Resource::new_instance(urls::CLASS, &store).unwrap();
new_resource
.set_propval_shortname("shortname", "person", &store)
.unwrap();
assert!(
new_resource
.get_shortname("shortname", &store)
.unwrap()
.to_string()
== "person"
);
new_resource
.set_propval_shortname("shortname", "human", &store)
.unwrap();
new_resource
.set_propval_shortname("description", "A real human being", &store)
.unwrap();
let commit = new_resource
.get_commit_builder()
.clone()
.sign(&agent, &store)
.unwrap();
commit.apply(&store).unwrap();
assert!(
new_resource
.get_shortname("shortname", &store)
.unwrap()
.to_string()
== "human"
);
let resource_from_store = store.get_resource(new_resource.get_subject()).unwrap();
assert!(
resource_from_store
.get_shortname("shortname", &store)
.unwrap()
.to_string()
== "human"
);
println!(
"{}",
resource_from_store
.get_shortname("is-a", &store)
.unwrap()
.to_string()
);
assert_eq!(
resource_from_store
.get_shortname("is-a", &store)
.unwrap()
.to_string(),
"https://atomicdata.dev/classes/Class"
);
assert!(resource_from_store.get_classes(&store).unwrap()[0].shortname == "class");
}
#[test]
fn iterate() {
let store = init_store();
let new_resource = Resource::new_instance(urls::CLASS, &store).unwrap();
let mut success = false;
for (prop, val) in new_resource.get_propvals() {
if prop == urls::IS_A {
assert!(val.to_subjects(None).unwrap()[0] == urls::CLASS);
success = true;
}
}
assert!(success);
}
#[test]
fn save() {
let store = init_store();
let property: String = urls::DESCRIPTION.into();
let value = Value::Markdown("joe".into());
let mut new_resource = Resource::new_instance(urls::CLASS, &store).unwrap();
new_resource
.set_propval(property.clone(), value.clone(), &store)
.unwrap();
assert!(new_resource.save_locally(&store).is_err());
new_resource
.set_propval(urls::SHORTNAME.into(), Value::Slug("joe".into()), &store)
.unwrap();
let subject = new_resource.get_subject().clone();
println!("subject new {}", new_resource.get_subject());
new_resource.save_locally(&store).unwrap();
let found_resource = store.get_resource(&subject).unwrap();
println!("subject found {}", found_resource.get_subject());
println!("subject all {:?}", found_resource.get_propvals());
let found_prop = found_resource.get(&property).unwrap().clone();
assert_eq!(found_prop.to_string(), value.to_string());
}
}