SlHelpers
Stanza.h
1 // SPDX-License-Identifier: GPL-2.0-only
2 
3 #pragma once
4 
5 #include <filesystem>
6 #include <functional>
7 #include <iostream>
8 #include <numeric>
9 #include <set>
10 #include <vector>
11 
12 #include "Pattern.h"
13 #include "Person.h"
14 
15 namespace SlKernCVS {
16 
23 class Stanza {
24 public:
26  using TranslateEmail = std::function<std::string (std::string_view sv)>;
28  using Maintainers = std::vector<Person>;
29 
30  Stanza() = default;
35  Stanza(std::string name) : m_name(std::move(name)) {}
42  Stanza(std::string n, std::string name, std::string email)
43  : m_name(std::move(n)), m_maintainers{Person(Role::Maintainer, std::move(name),
44  std::move(email))} { }
45 
51  unsigned match_path(const std::filesystem::path &path) const {
52  return std::accumulate(m_patterns.cbegin(), m_patterns.cend(), 0u,
53  [&path](unsigned m, const Pattern &p) {
54  return std::max(m, p.match(path));
55  });
56  }
57 
64  void add_maintainer_and_store(std::string_view maintainer,
65  std::set<std::string> &suse_users,
66  const TranslateEmail &translateEmail) {
67  if (auto m = Person::parsePerson(maintainer, Role::Maintainer)) {
68  suse_users.insert(m->userName());
69  // TODO
70  m->setEmail(translateEmail(m->email()));
71  // END TODO
72  m_maintainers.push_back(std::move(*m));
73  } else
74  std::cerr << "MAINTAINERS: contact " << maintainer <<
75  " cannot be parsed into name and email!\n";
76  }
77 
85  void add_backporter(const std::string &name, std::string_view email,
86  unsigned cnt, const TranslateEmail &translateEmail) {
87  m_maintainers.push_back(Person(Role::Maintainer, name,
88  /*TODO*/ translateEmail(email), cnt));
89  }
90 
97  void add_maintainer_if(std::string_view maintainer,
98  const std::set<std::string> &suse_users,
99  const TranslateEmail &translateEmail) {
100  if (auto m = Person::parsePerson(maintainer, Role::Upstream)) {
101  // TODO
102  m->setEmail(translateEmail(m->email()));
103  // END TODO
104  if (suse_users.contains(m->userName()))
105  m_maintainers.push_back(std::move(*m));
106  } else
107  std::cerr << "Upstream MAINTAINERS: contact " << maintainer <<
108  " cannot be parsed into name and email!\n";
109  }
110 
116  bool add_pattern(std::string pattern) {
117  auto p = Pattern::create(std::move(pattern));
118  if (!p)
119  return false;
120  m_patterns.push_back(std::move(*p));
121  return true;
122  }
123 
125  bool empty() const {
126  return m_name.empty() || m_maintainers.empty() || m_patterns.empty();
127  }
128 
133  const Maintainers &maintainers() const { return m_maintainers; }
134 
141  void new_entry(std::string n) {
142  m_name = std::move(n);
143  m_maintainers.clear();
144  m_patterns.clear();
145  }
146 
148  const std::string &name() const { return m_name; }
149 private:
150  std::string m_name;
151  Maintainers m_maintainers;
152  std::vector<Pattern> m_patterns;
153 };
154 
155 } // namespace
static std::optional< Pattern > create(std::string pattern)
Build a (git) Pattern.
void add_maintainer_if(std::string_view maintainer, const std::set< std::string > &suse_users, const TranslateEmail &translateEmail)
Add a maintainer (as Upstream) if in suse_users.
Definition: Stanza.h:97
bool empty() const
Check if this Stanza has no name, maintainers, and patterns.
Definition: Stanza.h:125
static std::optional< Person > parsePerson(std::string_view src, Role role)
Parse src into a Person.
Stanza (a subsystem) from MAINTAINERS file.
Definition: Stanza.h:23
Holds git patterns and reports weights if matched.
Definition: Pattern.h:16
unsigned match_path(const std::filesystem::path &path) const
Return weight of path in this Stanza.
Definition: Stanza.h:51
std::function< std::string(std::string_view sv)> TranslateEmail
Callback to translate an e-mail.
Definition: Stanza.h:26
void add_backporter(const std::string &name, std::string_view email, unsigned cnt, const TranslateEmail &translateEmail)
Creates a Person and adds it as Maintainer.
Definition: Stanza.h:85
void new_entry(std::string n)
Reset Stanza and start from the beginning.
Definition: Stanza.h:141
Stanza(std::string n, std::string name, std::string email)
Construct new Stanza called n with one Person (having name and email)
Definition: Stanza.h:42
bool add_pattern(std::string pattern)
Add pattern to this Stanza.
Definition: Stanza.h:116
Loads and holds information from both Linux and SUSE MAINTAINERS files.
Definition: Maintainers.h:20
std::vector< Person > Maintainers
Maintainers are a list of Person.
Definition: Stanza.h:28
const std::string & name() const
Get name/title of this Stanza.
Definition: Stanza.h:148
Definition: Branches.h:15
void add_maintainer_and_store(std::string_view maintainer, std::set< std::string > &suse_users, const TranslateEmail &translateEmail)
Add a maintainer (as Maintainer) and store them into SUSE users set too.
Definition: Stanza.h:64
Information about a person (such as username, e-mail, Role)
Definition: Person.h:71
Stanza(std::string name)
Construct new Stanza called name.
Definition: Stanza.h:35
const Maintainers & maintainers() const
Obtain a list of Person in this Stanza.
Definition: Stanza.h:133