Skip to content

git-config output to std::io::Write #456

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 37 commits into from
Jul 13, 2022
Merged

git-config output to std::io::Write #456

merged 37 commits into from
Jul 13, 2022

Conversation

Byron
Copy link
Member

@Byron Byron commented Jul 12, 2022 •
edited
Loading

Tasks

  • write_to(…) method for everyone that can do to_bstring()
  • validation of section and subsection names when mutating them
  • validation of keys when adding them
  • escaping of values when adding them
  • proper escaping of subsections
  • proper escaping of values
  • a way to define the amount of leading spaces per File or automatically
  • escape values when keys are pushed onto sections
  • surround key-value separator with whitespace depending on existing values
  • escape multi-value values
  • tabs become spaces unless within quotes - it's probably better not to do that in an API crate - it round-trips better that way.

@Byron Byron mentioned this pull request Jul 12, 2022
Closed
24 tasks
@Byron Byron changed the title config output to config output to std::io::Write Jul 12, 2022
@Byron Byron changed the title config output to std::io::Write git-config output to std::io::Write Jul 12, 2022
Byron added 27 commits July 12, 2022 10:36
@Byron
feat: Add parse::(Event|section::Header|Comment)::write_to(…). (#331)
d087f12 
Now it's possible to serialize these types in a streaming fashion and
without arbitrarily enforcing UTF-8 on it
@Byron
change!: remove Boolean::to_bstring() along with a few From impls. (
b22732a 
#331)

These were superfluous and aren't useful in practice.
Note that serialization is still implemented via `Display`.
@Byron
change!: remove Integer::to_bstring() as well as some TryFrom imp…
0e392f8 
…ls. (#331)

Note that it can still display itself like before via
`std::fmt::Display`.
@Byron
adapt to breaking changes in git-config (#331)
a02d575
@Byron
change!: Add File::write_to() and File::to_bstring(); remove some…
4f6cd8c 
… `TryFrom` impls. (#331)

Now `File` can be serialized in a streaming fashion and without the
possibility for UTF8 conversion issues.

Note that `Display` is still imlpemented with the usual caveats.
@Byron
new roundtrip test on file level (#331)
78bb93c
@Byron
refactor (#331)
9fac8e0
@Byron
basic escaping of subsection names during serialization (#331)
00d1a9b
@Byron
prepare for validation of parse::section::Header (#331)
00592f6
@Byron
feat!: section names are now validated. (#331)
cfd974f
@Byron
feat: parse::Header::new(…) with sub-section name validation (#331)
ae3895c
@Byron
change!: Enforce parse::section::Header::new() by making its fields…
219cf7a 
… private. (#331)
@Byron
more header escaping tests (#331)
12cf005
@Byron
re-add newlines after multi-line values (#331)
9a2f597 
Note that this only works for parsed values, and user-added
values still need to be translated into events properly.
@Byron
fix!: File::rename_section() with validation of input arguments. (#331
895ce40 
)
@Byron
remove unused makefile targets and add nextest target
1d8dee2
@Byron
fix!: Simplify specifying keys when mutating config values. (#331)
a93a156
@Byron
validation for Keys and header names (#331)
59ec7f7
@Byron
auto-compute whitespace for sections, even though it probably needs t…
ee9ac95 
…o be better than that (#331)

I am thinking, taking the whitespace directly will be more faithful,
i.e. to handle tabs vs spaces which we can't decide.
@Byron
refactor (#331)
a0d6caa
@Byron
refactor (#331)
c88eea8
@Byron
feat: whitespace in mutable sections can be finely controlled, and is…
9157717 
… derived from existing sections (#331)
@Byron
feat: File::from_str() implementation, to support `let config: File…
db1f34d 
… = "[core]".parse()?` (#331)
@Byron
feat: whitespace in newly pushed keys is derived from first section v…
9f59356 
…alue. (#331)

That way, newly added key-value pairs look like they should assuming
all keys have the same indentation as the first key in the section.

If there is no key, then the default whitespace will be double-tabs
like what's commmon in git.
@Byron
change!: rename file::MutableSection::set_leading_space() to `set_l…
83a0922 
…eading_whitespace()`. (#331)

The corresponding getter was renamed as well to `leading_whitespace()`.
@Byron
a few tests for MutableValue showing that it's too buggy right now (#…
5e6f9d9 
…331)

Since `MutableSection` can do all of it too, let's double-down on that
one instead. So in order to set values, one needs a mutable section
first.
@Byron
refactor (#331)
afa736a
Byron added 10 commits July 13, 2022 13:02
@Byron Byron merged commit 20e188f into main Jul 13, 2022
@Byron Byron deleted the config-output branch July 13, 2022 10:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@Byron