Struct ScopeVocabulary 

pub struct ScopeVocabulary {
    pub scopes: Vec<ScopeUse>,
    pub sampled: usize,
    pub unavailable: Option<String>,
    /* private fields */
}

The vocabulary as observed, with what was observed.

use majordomus_cli::commit::ScopeVocabulary;
// an empty vocabulary knows nothing and says so, rather than guessing
let v = ScopeVocabulary::default();
assert!(!v.knows("anything"));
assert!(v.words().is_empty());

Fields

scopes: Vec<ScopeUse>

Every scope, by how often it is used, then by name. The order is the answer to “which scopes does this repository use”, so it is the order a person reads.

sampled: usize

How many commits were read to learn it.

unavailable: Option<String>

Set when git could not be asked; the vocabulary is then empty rather than wrong.

Implementations

impl ScopeVocabulary

pub fn learn(&mut self, scope: &str, prefix: &str, commits: usize)

Record that commits commits scoped changes under prefix as scope.

derive is how a vocabulary is normally built, from the history. This is the same association stated directly, for a caller that has the evidence by another route — and for tests, which must be able to state a history rather than construct one.

use majordomus_cli::commit::ScopeVocabulary;
let mut v = ScopeVocabulary::default();
v.learn("commit", "src/commit", 12);
v.learn("commit", "src/commit", 5);
assert_eq!(v.suggest(&["src/commit/a.rs".into()]).expect("known").commits, 17);

pub fn knows(&self, scope: &str) -> bool

Whether the history has used this scope.

use majordomus_cli::commit::{scopes::ScopeUse, ScopeVocabulary};
let mut v = ScopeVocabulary::default();
v.scopes.push(ScopeUse { scope: "commit".into(), commits: 1, directories: vec![] });
assert!(v.knows("commit"));
assert!(!v.knows("nonesuch"));

pub fn words(&self) -> Vec<String>

The scope words alone, in vocabulary order.

use majordomus_cli::commit::{scopes::ScopeUse, ScopeVocabulary};
let mut v = ScopeVocabulary::default();
v.scopes.push(ScopeUse { scope: "site".into(), commits: 9, directories: vec![] });
assert_eq!(v.words(), vec!["site".to_string()]);

pub fn suggest(&self, paths: &[String]) -> Option<ScopeSuggestion>

Which scope these paths belong to, judged by what prior commits did with the same directories.

None when nothing in the history associates any scope with any of these paths — which is the honest answer for the first commit of a new subsystem, and is better than the most popular scope in the repository, which is what a tie-break to frequency would produce.

use majordomus_cli::commit::ScopeVocabulary;
let mut v = ScopeVocabulary::default();
// the deepest association wins over the busiest directory two levels up
v.learn("commit", "apps/cli/src/commit", 12);
v.learn("everything", "apps", 900);
let s = v.suggest(&["apps/cli/src/commit/a.rs".into()]).expect("an association");
assert_eq!(s.scope, "commit");

Trait Implementations

impl Clone for ScopeVocabulary

fn clone(&self) -> ScopeVocabulary

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ScopeVocabulary

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ScopeVocabulary

fn default() -> ScopeVocabulary

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ScopeVocabulary

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ScopeVocabulary

impl JsonSchema for ScopeVocabulary

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for ScopeVocabulary

fn eq(&self, other: &ScopeVocabulary) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ScopeVocabulary

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ScopeVocabulary