renie/electronics

Electronics

(Warning: this project is not meant to be used in production, just for Rust studies)

The idea here is try to simulate an electronic circuit based on a JSON that describes its structure.

Deps

No deps so far. You can skip this.

Run

cargo run

Tests

cargo test

electronics's Issues

Implement OR gate

Definition of done:

• Create OR gate structure
• Use the same way of running other gates and return the result of them
• Unit tests for it

Run the whole circuit

Definition of done:

• To be able to feed sample.json to the lib and get the execution result of it
  • Use for this the gates created on #9 and #8
  • Use the JSON data parsed using the solution defined on #7
• Create enough tests for the new functions
• Create integrated tests for it

Enable using the lib without file

Definition of done:

• Allow sending the JSON as a string directly to be processed
• Add enough tests for it

Improve integration tests

Include tests for not passing any parameter as well.

Final circuit gets lost

Because of memory references, the final circuit with inputs calculated gets lost.
It would be nice to have it for debugging purposes or even to show a visual representation of the final circuit.

Start testing

Create first unit and integration tests of the project.
Add also README instructions to run them.

Implement CI

Implement CI running tests on every PR or commit.

Depends on completion of #1

Add PR template

Definition of done:

• To have a Github PR template enabled for the repo

Start JSON parsing

Definition of done:

• Figure out how to parse JSON with Rust
  • By parse understand: transform the JSON text to a manageable Rust data structure
• Use it on the contents from inside the circuit file
• Raise an error in case there is a problem on parsing it
• Unit tests for it

Create the rest of unit tests for now

Create unit tests for all the internal functions of lib and utils modules.

Implement AND gate

Definition of done:

• Define the way gates will be created
• Create AND gate structure
• Create a function to run the gate and return the result of it
• Unit tests for it