[#765] New practice exercise `complex-numbers` #769

jiegillet · 2021-06-16T04:58:12Z

New one!

Inspired by @elibdev I have written (and committed, I know it doesn't belong in this PR) a quick and dirty script generate_tests.exs. This goes through canonical-data.json and build the test and lib files. Of course, it is still required to edit by hand, but I it was way easier than copy/pasting stuff from 31 tests.

I have not tested it very much on other exercises, and even here it has limitations (this canonical-data.json had nested describe which is not allowed in Elixir, so I fixed that by hand), but if it's something that is worth pursuing, I'm willing to make it better. It could also generate other files pretty easily. Let me know what you think. I will personally keep using it for more exercises.

github-actions · 2021-06-16T04:58:26Z

Thank you for contributing to exercism/elixir 💜 🎉. This is an automated PR comment 🤖 for the maintainers of this repository that helps with the PR review process. You can safely ignore it and wait for a maintainer to review your changes.

Based on the files changed in this PR, it would be good to pay attention to the following details when reviewing the PR:

General steps
- 🏆 Does this PR need to receive a label with a reputation modifier (reputation/contributed_code/{minor,major})? (A medium reputation amount is awarded by default, see docs)
Any exercise changed
- 👤 Does the author of the PR need to be added as an author or contributor in <exercise>/.meta/config.json (see docs)?
- 🔬 Do the analyzer and the analyzer comments exist for this exercise? Do they need to be changed?
- 📜 Does the design file (<exercise>/.meta/design.md) need to be updated to document new implementation decisions?
Practice exercise changed
- 🌲 Do prerequisites, practices, and difficulty in config.json need to be updated?
- 🧑‍🏫 Are the changes in accordance with the community-wide problem specifiations?
Practice exercise tests changed
- ⚪️ Are all tests except the first one skipped?
- 📜 Does <exercise>/.meta/tests.toml need updating?

Automated comment created by PR Commenter 🤖.

jiegillet · 2021-06-16T05:11:37Z

config.json

+          "floating-point-numbers"
+        ],
+        "practices": [
+          "pattern-matching",


Should I remove pattern matching? There are too many exercises. It's not crucial at all. Maybe replace by erlang-libraries because of the :math functions?

Yes, good idea. Let's replace pattern-matching with erlang-libraries. Only 1 exercise so far practices erlang-libraries.

angelikatyborska · 2021-06-16T08:24:31Z

Thank you again! I'll try to review until the end of the week, I'm a bit busy in the next few days.

angelikatyborska · 2021-06-18T19:03:37Z

I have not tested it very much on other exercises, (...) but if it's something that is worth pursuing, I'm willing to make it better.

It's definitely something that we would want at some point. Ideally, it would allow you to automatically implement new tests for all exercise. Tests often get added to canonical data after the exercise has been around for while. You get new tests by running bin/configlet sync, which should add them to the tests.toml files. A real test generator would read tests.toml files and on based on their contents and canonical-data.json files update the test suite. Different exercises are slightly incompatible with canonical-data.json in different ways, so it's possible that it would still require some manual work each time.

I will personally keep using it for more exercises.

Good plan! Let's keep it in the repository so that other people can use it too, and that it serves as a reference for when we will be building a proper test generator.

angelikatyborska

Looks great 🙂 we just need to update "practice" to get the checks passing and move the generator script somewhere else.

angelikatyborska · 2021-06-18T18:32:24Z

config.json

+          "floating-point-numbers"
+        ],
+        "practices": [
+          "pattern-matching",


Yes, good idea. Let's replace pattern-matching with erlang-libraries. Only 1 exercise so far practices erlang-libraries.

angelikatyborska · 2021-06-18T18:33:41Z

config.json

+        "prerequisites": [
+          "pattern-matching",
+          "erlang-libraries",
+          "floating-point-numbers"


Let's be explicit about needing tuples:

Suggested change

"floating-point-numbers"

"floating-point-numbers",

"tuples"

angelikatyborska · 2021-06-18T18:47:50Z

exercises/practice/complex-numbers/generate_tests.exs

@@ -0,0 +1,158 @@
+# Generates test cases and basic template, which will need to be adapted by hand
+# Pass the name of the exercise (e. g, "complex-numbers") as an argument


This is pretty cool! It's not exactly a full blown test generator because it won't allow easily updating the test suite, but it's a really nice way to bootstrap a new exercise.

Th file cannot stay under exercises/practice/complex-numbers/generate_tests.exs because it would get downloaded to student machines, but we can keep it under exercises/practice/complex-numbers/.meta/generate_tests.exs or maybe even outside the exercise under bin/generate_tests.exs?

Yes, it should definitely be in bin, I just left it here for now for discussion.
I will probably expand it a bit to generate all of the other files, might as well, and rename it bootstrap_practice_exercise.exs or something to be more explicit. If it can serve as a basis for a better test generator later, that would be good.

angelikatyborska · 2021-06-18T18:51:03Z

exercises/practice/complex-numbers/generate_tests.exs

+        %{
+          "description" => description,
+          "property" => property,
+          "input" => %{} = input,
+          "expected" => expected
+        } = c,


A heads-up for the future or maybe for when we will extend the script: there are some exercises that have deprecated test cases. If a test case is deprecated, there is another test case that has a key "reimplements", for example:
https://github.com/exercism/problem-specifications/blob/e2779fc84ff07cb5bd8ff89f38e78af6d17b5056/exercises/hamming/canonical-data.json#L117-L140

In such a case, only one of the two tests needs to be implemented, ideally the newer one 🙂

Good to know, thank you! As of now, it would print the test in the following way

test "disallow empty first strand" do # Normalises error messages # -- reimplements -- # db92e77e-7c72-499d-8fe6-9354d2bfd504 ...

Which is not that bad, since there needs to be a manual check anyway.

neenjaw

NIce work implementing this exercise, will be a good addition.

Left a comment about the description, I think it'd be useful to explain how we are representing the complex number with a tuple-pair.

I also agree with @angelikatyborska's suggestions.

neenjaw · 2021-06-18T23:38:26Z

exercises/practice/complex-numbers/.docs/instructions.md

+Implement the following operations:
+ - addition, subtraction, multiplication and division of two complex numbers,
+ - conjugate, absolute value, exponent of a given complex number.
+


I would like to see a description of how the complex pair is represented with a tuple to represent the real and imaginary part.

Ex) "For this exercise, a complex number will be a tuple-pair where the number 4+3i would be represented by {4, 3}."

Good idea, thank you!

All the documentation I saw discouraged me from changing the description of the exercise, so I updated the @typedoc instead.

You can put it in an append file: https://github.com/exercism/docs/blob/main/building/tracks/practice-exercises.md#documentation-files

Just a word of explanation: we're not supposed to change anything in instructions.md because there will be a script soon that allows synchronizing it with the problem specifications repository in case of changes, and then track-specific changes would get overwritten. That's why there's an append file for this.

jiegillet added 2 commits June 16, 2021 13:30

[exercism#765] New practice exercise

1292b6b

Fixed copy/paste error

92ba478

jiegillet commented Jun 16, 2021

View reviewed changes

angelikatyborska requested review from angelikatyborska and neenjaw June 16, 2021 08:24

angelikatyborska reviewed Jun 18, 2021

View reviewed changes

angelikatyborska added x:size/large Large amount of work reputation/contributed_code/major labels Jun 18, 2021

neenjaw approved these changes Jun 18, 2021

View reviewed changes

jiegillet added 6 commits June 19, 2021 14:25

Change prerequisites and practices

90edc19

Update complex typedoc

94689fe

Remove generate_tests.exs

c3cd90a

Trailing white space

5f23c33

Added extra instructions

5fad97b

Wrong directory

9604e2a

angelikatyborska approved these changes Jun 19, 2021

View reviewed changes

angelikatyborska merged commit efd211b into exercism:main Jun 19, 2021

angelikatyborska mentioned this pull request Jun 19, 2021

New practice exercise complex-numbers #765

Closed

ErikSchierboom removed the reputation/contributed_code/major label Jun 29, 2021

jiegillet deleted the jie-complex-numbers branch July 1, 2021 00:07

This was referenced Jul 14, 2022

Document reputation label exercism/docs#347

Merged

Consider correct reputation amounts for different labels exercism/exercism#6440

Open

Consider correct reputation amounts for different labels exercism/exercism#6441

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[#765] New practice exercise `complex-numbers` #769

[#765] New practice exercise `complex-numbers` #769

jiegillet commented Jun 16, 2021

github-actions bot commented Jun 16, 2021

jiegillet Jun 16, 2021 •

edited

Loading

angelikatyborska Jun 18, 2021

angelikatyborska commented Jun 16, 2021

angelikatyborska commented Jun 18, 2021

angelikatyborska left a comment

angelikatyborska Jun 18, 2021

angelikatyborska Jun 18, 2021

angelikatyborska Jun 18, 2021

jiegillet Jun 19, 2021

angelikatyborska Jun 18, 2021

jiegillet Jun 19, 2021

neenjaw left a comment

neenjaw Jun 18, 2021

jiegillet Jun 19, 2021

jiegillet Jun 19, 2021

neenjaw Jun 19, 2021

angelikatyborska Jun 19, 2021

		@@ -0,0 +1,158 @@
		# Generates test cases and basic template, which will need to be adapted by hand
		# Pass the name of the exercise (e. g, "complex-numbers") as an argument

[#765] New practice exercise complex-numbers #769

[#765] New practice exercise complex-numbers #769

Conversation

jiegillet commented Jun 16, 2021

github-actions bot commented Jun 16, 2021

jiegillet Jun 16, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

angelikatyborska commented Jun 16, 2021

angelikatyborska commented Jun 18, 2021

angelikatyborska left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

neenjaw left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

[#765] New practice exercise `complex-numbers` #769

[#765] New practice exercise `complex-numbers` #769

jiegillet Jun 16, 2021 •

edited

Loading