https://github.com/exercism/rust-representer
https://github.com/exercism/rust-representer
community-contributions-paused exercism-representer exercism-tooling maintained-solitary
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/exercism/rust-representer
- Owner: exercism
- License: agpl-3.0
- Created: 2020-06-16T20:58:02.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-03-01T01:14:22.000Z (3 months ago)
- Last Synced: 2025-04-29T06:23:00.459Z (about 2 months ago)
- Topics: community-contributions-paused, exercism-representer, exercism-tooling, maintained-solitary
- Language: Rust
- Size: 182 KB
- Stars: 6
- Watchers: 9
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Rust Representer
A normalizing representer for Exercism's Rust track.
## What's a Normalizing Representer?
A representer's job is to normalize some input code by stripping out and replacing any trivial details that introduce differences between students' submitted code. Comments, whitespace, and variable names, things that don't contribute to the overall logical flow and structure of the students' approach, are stripped out. In the case of variable names, these are replaced by a standard placeholder.
The ultimate purpose of the representer is to facilitate quicker response times from mentors by standardizing student implementations so that mentors can provide feedback on the _approach_ the student took to solve the problem.
## Example
Given an example submission for the `two-fer` exercise like the following:
```rust
fn twofer(name: &str) -> String {
match name {
"" => "One for you, one for me.".to_string(),
// use the `format!` macro to return a formatted String
_ => format!("One for {}, one for me.", name),
}
}
```
The representer will return:
```rust
fn PLACEHOLDER_1(PLACEHOLDER_2: &str) -> String {
match PLACEHOLDER_2 {
"" => "One for you, one for me.".to_string(),
_ => format!("One for {}, one for me.", PLACEHOLDER_2),
}
}
```
## Progress
Currently the following statement/expression types are visited by the representer:
- [x] `let` bindings
- [x] `struct` names
- [x] `struct` fields
- [x] `enum` names
- [x] `enum` variants
- [x] `fn` definitions
- [x] `fn` calls
- [x] method calls
- [x] `const` names
- [x] `static` names
- [x] `union` names
- [x] `type` aliases
- [x] `match` expressions
- [x] `match` arms
- [x] `macro` arguments
- [x] closure expressions
- [x] `for` loops
- [x] `while` loops
- [x] `loop`s
- [x] `if` expressions
- [x] `impl` blocks
- [x] type annotations
- [x] `if let` bindings
- [ ] user-defined types
- [ ] user-defined traits
- [ ] `mod` imports
- [x] output variable mappings to a JSON file
## Design
The high-level steps the representer takes are as follows:
1. It transforms the source code into an AST, stripping out comments in the process.
2. From there, it traverses the AST, looking for identifiers.
3. When it finds an identifier:
- It checks whether the identifier is a Rust keyword (or any other sort of identifier that isn't actually being used as a variable/function name).
- If the identifier isn't a keyword, it then checks if the identifier is one that has been encountered before.
- If it is, then a placeholder for this identifier has already been generated and stored in a HashMap; the identifier is replaced with the placeholder.
- If it isn't, then the placeholder needs to be generated and saved in the HashMap before the identifier is replaced by it.
4. The transformed output is then put through another formatting pass.