klirr-core 0.2.1

Zero-maintenance and smart FOSS generating beautiful invoices for services and expenses.
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

use crate::prelude::*;

/// Information about a company
#[derive(
    Clone, Debug, Serialize, Deserialize, PartialEq, Eq, Hash, Builder, Getters, WithSetters,
)]
pub struct CompanyInformation {
    /// Name of the person responsible for the invoice, e.g. `"John Doe"`.
    ///
    /// Used for "Our reference" in case of vendor, or
    /// "For attestation of", in case of client.
    #[getset(get = "pub", set_with = "pub")]
    contact_person: Option<String>,
    /// The unique organisation number of the company, e.g. `"123456789"`.
    #[getset(get = "pub", set_with = "pub")]
    organisation_number: String,
    /// The name of the company
    #[getset(get = "pub", set_with = "pub")]
    company_name: String,
    /// The postal address of the company
    #[getset(get = "pub", set_with = "pub")]
    postal_address: PostalAddress,
    /// The VAT number of the company, e.g. `"GB123456789"`.
    #[getset(get = "pub", set_with = "pub")]
    vat_number: String,
}

impl HasSample for CompanyInformation {
    fn sample() -> Self {
        Self::sample_client()
    }

    fn sample_other() -> Self {
        Self::sample_vendor()
    }
}

impl CompanyInformation {
    pub fn sample_client() -> Self {
        Self::builder()
            .company_name("Holmes Ltd".into())
            .contact_person("Sherlock Holmes".into())
            .organisation_number("9876543-2101".into())
            .postal_address(PostalAddress::sample_client())
            .vat_number("GB987654321".into())
            .build()
    }

    pub fn sample_vendor() -> Self {
        Self::builder()
            .company_name("Lupin et Associés".into())
            .contact_person("Arsène Lupin".into())
            .organisation_number("7418529-3012".into())
            .postal_address(PostalAddress::sample_vendor())
            .vat_number("FR74185293012".into())
            .build()
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    type Sut = CompanyInformation;

    #[test]
    fn equality() {
        assert_eq!(Sut::sample(), Sut::sample());
        assert_eq!(Sut::sample_other(), Sut::sample_other());
    }

    #[test]
    fn inequality() {
        assert_ne!(Sut::sample(), Sut::sample_other());
    }
}