planter-core 0.0.4

Domain logic for PlanTer, a project management application
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

//! Module containing tests for the `Project` struct.

use anyhow::Context;
use chrono::Utc;
use planter_core::{
    person::Person,
    project::{Project, TimeRelationship},
    resources::{Consumable, Material, NonConsumable, Resource},
    stakeholders::Stakeholder,
    task::Task,
};

#[test]
/// The standard workflow when creating a project involves initializing it with
/// a name, optionally a description, and a start date. The project is kept
/// mutable and the user can add/remove tasks, resources, stakeholders, and
/// other relevant information.
fn test_project() -> anyhow::Result<()> {
    // Initialize a project with a name, description, and start date.
    let start_date = Utc::now();
    let mut project = Project::builder()
        .name("World domination")
        .description("My second attempt to conquer the world with a crowbar and a stimpack")
        .start_date(start_date)
        .build();

    // Add tasks to the project.
    project.add_task(Task::new("Find a crowbar"));
    project.add_task(Task::new("Find a stimpack"));
    project.add_task(Task::new("Open a proprietary software house"));
    project.add_task(Task::new("Prey on free software projects"));
    project.add_task(Task::new("Profit"));
    assert_eq!(project.tasks().count(), 5);

    // Add subtask relatonships to the project.
    project.add_subtask(1, 2);
    project.add_subtask(1, 3);

    assert_eq!(project.subtasks(1).len(), 2);

    // Add time relationships between tasks of the project.
    project
        .add_time_relationship(0, 1, TimeRelationship::StartToFinish)
        .context("Tasks don't exist or circular dependencies detected")?;

    project
        .add_time_relationship(0, 4, TimeRelationship::StartToFinish)
        .context("Tasks don't exist or circular dependencies detected")?;

    // Add a consumable material to the project
    project.add_resource(Resource::Material(Material::Consumable(Consumable::new(
        "Crowbar",
    ))));

    // Convert the consumable material into a non consumable
    project
        .res_into_nonconsumable(0)
        .context("Failed to convert consumable into non consumable")?;

    // Add a consumable material to the project
    project.add_resource(Resource::Material(Material::NonConsumable(
        NonConsumable::new("Stimpack"),
    )));

    // Convert the non consumable material into a consumable
    project
        .res_into_consumable(0)
        .context("Failed to convert non consumable into consumable")?;

    // Add a personnel resource to the project
    project.add_resource(Resource::Personnel {
        person: Person::new("Sebastiano", "Giordano").context("Failed to parse a name.")?,
        hourly_rate: None,
    });
    assert_eq!(project.resources().len(), 3);

    // Remove a resource from the project
    project.rm_resource(1);
    assert_eq!(project.resources().len(), 2);

    // Add stakeholders to the project
    let person = Person::new("Margherita", "Hack").context("Failed to parse a name")?;
    project.add_stakeholder(Stakeholder::Individual {
        person,
        description: Some("She could try to stop me".to_owned()),
    });
    project.add_stakeholder(Stakeholder::Organization {
        name: "Acme".to_owned(),
        description: Some("They might decide to buy me more stimpacks".to_owned()),
    });
    assert_eq!(project.stakeholders().len(), 2);

    Ok(())
}