unclog 0.7.3

unclog allows you to build your changelog from a collection of independent files. This helps prevent annoying and unnecessary merge conflicts when collaborating on shared codebases.
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

use std::path::PathBuf;

use crate::{ChangeSet, ChangeSetSection, Changelog, ComponentSection, Config, Entry, Release};

/// Provides a precise path through a specific changelog to a specific entry.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct EntryPath<'a> {
    pub changelog: &'a Changelog,
    pub release_path: EntryReleasePath<'a>,
}

impl<'a> EntryPath<'a> {
    /// Reconstructs the filesystem path, relative to the changelog folder path,
    /// for this particular entry.
    pub fn as_path(&self, config: &Config) -> PathBuf {
        self.release_path.as_path(config)
    }

    pub fn entry(&self) -> &'a Entry {
        self.release_path.entry()
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum EntryReleasePath<'a> {
    Unreleased(EntryChangeSetPath<'a>),
    Released(&'a Release, EntryChangeSetPath<'a>),
}

impl<'a> EntryReleasePath<'a> {
    pub fn as_path(&self, config: &Config) -> PathBuf {
        match self {
            Self::Unreleased(p) => PathBuf::from(&config.unreleased.folder).join(p.as_path()),
            Self::Released(r, p) => PathBuf::from(&r.id).join(p.as_path()),
        }
    }

    pub fn entry(&self) -> &'a Entry {
        match self {
            Self::Unreleased(change_set_path) => change_set_path.entry(),
            Self::Released(_, change_set_path) => change_set_path.entry(),
        }
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct EntryChangeSetPath<'a> {
    pub change_set: &'a ChangeSet,
    pub section_path: ChangeSetSectionPath<'a>,
}

impl<'a> EntryChangeSetPath<'a> {
    pub fn as_path(&self) -> PathBuf {
        self.section_path.as_path()
    }

    pub fn entry(&self) -> &'a Entry {
        self.section_path.entry()
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct ChangeSetSectionPath<'a> {
    pub change_set_section: &'a ChangeSetSection,
    pub component_path: ChangeSetComponentPath<'a>,
}

impl<'a> ChangeSetSectionPath<'a> {
    pub fn as_path(&self) -> PathBuf {
        PathBuf::from(&self.change_set_section.id).join(self.component_path.as_path())
    }

    pub fn entry(&self) -> &'a Entry {
        self.component_path.entry()
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum ChangeSetComponentPath<'a> {
    General(&'a Entry),
    Component(&'a ComponentSection, &'a Entry),
}

impl<'a> ChangeSetComponentPath<'a> {
    pub fn as_path(&self) -> PathBuf {
        match self {
            Self::General(entry) => PathBuf::from(&entry.filename),
            Self::Component(component_section, entry) => {
                PathBuf::from(&component_section.id).join(&entry.filename)
            }
        }
    }

    pub fn entry(&self) -> &'a Entry {
        match self {
            Self::General(entry) => entry,
            Self::Component(_, entry) => entry,
        }
    }
}