summaryrefslogtreecommitdiff
path: root/requirements/scripts/req-list
blob: c1d8e374130991fcb3f9cee30e894b1b1cfda23a (plain)
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
#!/bin/bash

requirements_dir="$(realpath "$(dirname $0)/..")"

usage()
{
    echo "
Usage: req.sh list [options...] <type> [id]

    type: req | dml | ass | need | task | epic
    id: filters items for the given id

    options:

    -D    lists incomplete tasks or epics
    -e    lists items which match the given Epic ID
    -E    lists items which do NOT match the given Epic ID
    -S    lists unsatisfied requirements
    -p    lists requirements sourced from [id]
    -P    lists unsourced requirements
"
}

while getopts ":D:E:e:S:P:p" o
do
    case "$o" in
        D)
            incomplete=1
            shift 1
            ;;
        E)
            not_epic=1
            shift 1
            ;;
        e)
            epic=1
            shift 1
            ;;
        S)
            unsatisfied=1
            shift 1
            ;;
        P)
            unsourced=1
            shift 1
            ;;
        p)
            sourced=1
            shift 1
            ;;
        *)
            echo "ERROR: ${o} is not a valid option!"
            usage
            exit 1
            ;;
    esac
done

type="$1"
id="$2"

if [ "$epic" == 1 ] || [ "$not_epic" == 1 ]
then
    if [[ "$type" =~ ^[0-9][0-9][0-9]$ ]]
    then
        id="$task"
        type=task
    fi
fi

if [ "$type" == "" ]
then
    echo "ERROR: you didn't provide a type!"
    usage
    exit 1
fi

case "$type" in
    req)
        dir="${requirements_dir}/catalogue"
        ;;
    dml)
        dir="${requirements_dir}/data_models"
        ;;
    ass)
        dir="${requirements_dir}/assumptions"
        ;;
    need)
        dir="${requirements_dir}/needs"
        ;;
    task | epic)
        dir="${requirements_dir}/tasks"
        ;;
    *)
        echo "ERROR: ${type} is not a valid type! Try: req | dml | ass | need | task | epic"
        usage
        exit 1
esac

if [ "$epic" == 1 ]
then
    echo "
${type} items matching Epic id epic-*${id}
---------------------------------------------------------------------------
"
    filenames=(${dir}/${type}-*.md)
    for filename in "${filenames[@]}"
    do
        matches_epic="$(cat $filename | grep -E "^Epic:.*\bepic-*${id}\b")"
        if [ -n "$matches_epic" ]
        then
            echo "$(basename "$filename" | sed "s/.md$//")"
        fi
    done
    echo ""
fi

if [ "$not_epic" == 1 ]
then
    echo "
${type} items not matching Epic id epic-*${id}
---------------------------------------------------------------------------
"
    filenames=(${dir}/${type}-*.md)
    for filename in "${filenames[@]}"
    do
        matches_epic="$(cat $filename | grep -E "^Epic:.*\bepic-*${id}\b")"
        if [ -z "$matches_epic" ]
        then
            echo "$(basename "$filename" | sed "s/.md$//")"
        fi
    done
    echo ""
fi

if [ "$incomplete" == 1 ]
then
    echo "
incomplete ${type} items matching id ${type}-*${id}
---------------------------------------------------------------------------
"
    filenames=(${dir}/${type}-*.md)
    for filename in "${filenames[@]}"
    do
        is_complete="$(cat $filename | grep -E "^Status: (done|complete|completed)$")"
        if [ -z "$is_complete" ]
        then
            echo "$(basename "$filename" | sed "s/.md$//")"
        fi
    done
    echo ""
fi


if [ "$sourced" == 1 ]
then
    echo "
${type} items sourced from id ${type}-*${id}
---------------------------------------------------------------------------
"
    filenames=(${dir}/${type}-*.md)
    for filename in "${filenames[@]}"
    do
        is_sourced="$(cat $filename | grep -E "^Sources?:.*\b${type}-[0-9]*${id}\b")"
        if [ -n "$is_sourced" ]
        then
            echo "$(basename "$filename" | sed "s/.md$//")"
        fi
    done
    echo ""
fi

if [ "$unsatisfied" == 1 ]
then
    echo "
Unsatisfied ${type} items matching id *${id}
---------------------------------------------------------------------------
"
    filenames=(${dir}/${type}-*${id}.md)
    for filename in "${filenames[@]}"
    do
        satisfied="$(cat $filename | grep -E "^Satisfied by:")"
        if [ -z "$satisfied" ]
        then
            echo "$(basename "$filename" | sed "s/.md$//")"
        fi
    done
    echo ""
fi

if [ "$unsourced" == 1 ]
then
    echo "
Unsourced ${type} items matching id *${id}
---------------------------------------------------------------------------
"
    filenames=(${dir}/${type}-*${id}.md)
    for filename in "${filenames[@]}"
    do
        is_sourced="$(cat $filename | grep -E "^Sources?:")"
        if [ -z "$is_sourced" ]
        then
            echo "$(basename "$filename" | sed "s/.md$//")"
        fi
    done
    echo ""
fi

if \
    [ "$incomplete" == "" ] \
    && [ "$sourced" == "" ] \
    && [ "$epic" == "" ] \
    && [ "$not_epic" == "" ] \
    && [ "$unsatisfied" == "" ] \
    && [ "$unsourced" == "" ]
then
    echo "
All ${type} items matching id *${id}
---------------------------------------------------------------------------
"
    filenames=(${dir}/${type}-*${id}.md)
    for filename in "${filenames[@]}"
    do
        echo "$(basename "$filename" | sed "s/.md$//")"
    done
    echo ""
fi