Create Record type (#10103)

# Description
This PR creates a new `Record` type to reduce duplicate code and
possibly bugs as well. (This is an edited version of #9648.)
- `Record` implements `FromIterator` and `IntoIterator` and so can be
iterated over or collected into. For example, this helps with
conversions to and from (hash)maps. (Also, no more
`cols.iter().zip(vals)`!)
- `Record` has a `push(col, val)` function to help insure that the
number of columns is equal to the number of values. I caught a few
potential bugs thanks to this (e.g. in the `ls` command).
- Finally, this PR also adds a `record!` macro that helps simplify
record creation. It is used like so:
   ```rust
   record! {
       "key1" => some_value,
       "key2" => Value::string("text", span),
       "key3" => Value::int(optional_int.unwrap_or(0), span),
       "key4" => Value::bool(config.setting, span),
   }
   ```
Since macros hinder formatting, etc., the right hand side values should
be relatively short and sweet like the examples above.

Where possible, prefer `record!` or `.collect()` on an iterator instead
of multiple `Record::push`s, since the first two automatically set the
record capacity and do less work overall.

# User-Facing Changes
Besides the changes in `nu-protocol` the only other breaking changes are
to `nu-table::{ExpandedTable::build_map, JustTable::kv_table}`.
This commit is contained in:
Ian Manske
2023-08-24 19:50:29 +00:00
committed by GitHub
parent 030e749fe7
commit 8da27a1a09
195 changed files with 4211 additions and 6245 deletions

View File

@ -1,6 +1,6 @@
use git2::{Branch, BranchType, DescribeOptions, Repository};
use nu_plugin::LabeledError;
use nu_protocol::{Span, Spanned, Value};
use nu_protocol::{record, Span, Spanned, Value};
use std::fmt::Write;
use std::ops::BitAnd;
use std::path::PathBuf;
@ -142,57 +142,6 @@ impl GStat {
"no_tag".to_string()
};
let mut cols = vec![];
let mut vals = vec![];
cols.push("idx_added_staged".into());
vals.push(Value::int(stats.idx_added_staged as i64, span));
cols.push("idx_modified_staged".into());
vals.push(Value::int(stats.idx_modified_staged as i64, span));
cols.push("idx_deleted_staged".into());
vals.push(Value::int(stats.idx_deleted_staged as i64, span));
cols.push("idx_renamed".into());
vals.push(Value::int(stats.idx_renamed as i64, span));
cols.push("idx_type_changed".into());
vals.push(Value::int(stats.idx_type_changed as i64, span));
cols.push("wt_untracked".into());
vals.push(Value::int(stats.wt_untracked as i64, span));
cols.push("wt_modified".into());
vals.push(Value::int(stats.wt_modified as i64, span));
cols.push("wt_deleted".into());
vals.push(Value::int(stats.wt_deleted as i64, span));
cols.push("wt_type_changed".into());
vals.push(Value::int(stats.wt_type_changed as i64, span));
cols.push("wt_renamed".into());
vals.push(Value::int(stats.wt_renamed as i64, span));
cols.push("ignored".into());
vals.push(Value::int(stats.ignored as i64, span));
cols.push("conflicts".into());
vals.push(Value::int(stats.conflicts as i64, span));
cols.push("ahead".into());
vals.push(Value::int(stats.ahead as i64, span));
cols.push("behind".into());
vals.push(Value::int(stats.behind as i64, span));
cols.push("stashes".into());
vals.push(Value::int(stats.stashes as i64, span));
cols.push("repo_name".into());
vals.push(Value::String {
val: repo_name,
span,
});
cols.push("tag".into());
vals.push(Value::String { val: tag, span });
cols.push("branch".into());
vals.push(Value::String {
val: stats.branch,
span,
});
cols.push("remote".into());
vals.push(Value::String {
val: stats.remote,
span,
});
// Leave this in case we want to turn it into a table instead of a list
// Ok(Value::List {
// vals: vec![Value::Record {
@ -203,53 +152,57 @@ impl GStat {
// span: *span,
// })
Ok(Value::Record { cols, vals, span })
Ok(Value::record(
record! {
"idx_added_staged" => Value::int(stats.idx_added_staged as i64, span),
"idx_modified_staged" => Value::int(stats.idx_modified_staged as i64, span),
"idx_deleted_staged" => Value::int(stats.idx_deleted_staged as i64, span),
"idx_renamed" => Value::int(stats.idx_renamed as i64, span),
"idx_type_changed" => Value::int(stats.idx_type_changed as i64, span),
"wt_untracked" => Value::int(stats.wt_untracked as i64, span),
"wt_modified" => Value::int(stats.wt_modified as i64, span),
"wt_deleted" => Value::int(stats.wt_deleted as i64, span),
"wt_type_changed" => Value::int(stats.wt_type_changed as i64, span),
"wt_renamed" => Value::int(stats.wt_renamed as i64, span),
"ignored" => Value::int(stats.ignored as i64, span),
"conflicts" => Value::int(stats.conflicts as i64, span),
"ahead" => Value::int(stats.ahead as i64, span),
"behind" => Value::int(stats.behind as i64, span),
"stashes" => Value::int(stats.stashes as i64, span),
"repo_name" => Value::string(repo_name, span),
"tag" => Value::string(tag, span),
"branch" => Value::string(stats.branch, span),
"remote" => Value::string(stats.remote, span),
},
span,
))
}
fn create_empty_git_status(&self, span: Span) -> Value {
let mut cols = vec![];
let mut vals = vec![];
cols.push("idx_added_staged".into());
vals.push(Value::int(-1, span));
cols.push("idx_modified_staged".into());
vals.push(Value::int(-1, span));
cols.push("idx_deleted_staged".into());
vals.push(Value::int(-1, span));
cols.push("idx_renamed".into());
vals.push(Value::int(-1, span));
cols.push("idx_type_changed".into());
vals.push(Value::int(-1, span));
cols.push("wt_untracked".into());
vals.push(Value::int(-1, span));
cols.push("wt_modified".into());
vals.push(Value::int(-1, span));
cols.push("wt_deleted".into());
vals.push(Value::int(-1, span));
cols.push("wt_type_changed".into());
vals.push(Value::int(-1, span));
cols.push("wt_renamed".into());
vals.push(Value::int(-1, span));
cols.push("ignored".into());
vals.push(Value::int(-1, span));
cols.push("conflicts".into());
vals.push(Value::int(-1, span));
cols.push("ahead".into());
vals.push(Value::int(-1, span));
cols.push("behind".into());
vals.push(Value::int(-1, span));
cols.push("stashes".into());
vals.push(Value::int(-1, span));
cols.push("repo_name".into());
vals.push(Value::string("no_repository", span));
cols.push("tag".into());
vals.push(Value::string("no_tag", span));
cols.push("branch".into());
vals.push(Value::string("no_branch", span));
cols.push("remote".into());
vals.push(Value::string("no_remote", span));
Value::Record { cols, vals, span }
Value::record(
record! {
"idx_added_staged" => Value::int(-1, span),
"idx_modified_staged" => Value::int(-1, span),
"idx_deleted_staged" => Value::int(-1, span),
"idx_renamed" => Value::int(-1, span),
"idx_type_changed" => Value::int(-1, span),
"wt_untracked" => Value::int(-1, span),
"wt_modified" => Value::int(-1, span),
"wt_deleted" => Value::int(-1, span),
"wt_type_changed" => Value::int(-1, span),
"wt_renamed" => Value::int(-1, span),
"ignored" => Value::int(-1, span),
"conflicts" => Value::int(-1, span),
"ahead" => Value::int(-1, span),
"behind" => Value::int(-1, span),
"stashes" => Value::int(-1, span),
"repo_name" => Value::string("no_repository", span),
"tag" => Value::string("no_tag", span),
"branch" => Value::string("no_branch", span),
"remote" => Value::string("no_remote", span),
},
span,
)
}
}