Impliment new template based generator #1730

meatball133 · 2024-11-09T13:22:17Z

No description provided.

github-actions · 2024-11-09T13:22:31Z

This PR touches files which potentially affect the outcome of the tests of an exercise. This will cause all students' solutions to affected exercises to be re-tested.

If this PR does not affect the result of the test (or, for example, adds an edge case that is not worth rerunning all tests for), please add the following to the merge-commit message which will stops student's tests from re-running. Please copy-paste to avoid typos.

[no important files changed]

For more information, refer to the documentation. If you are unsure whether to add the message or not, please ping @exercism/maintainers-admin in a comment. Thank you!

.github/workflows/generator-tests.yml

generatorv2/lib/generator.rb

bin/generate.rb

generatorv2/README.md

bin/generate

kotp · 2024-11-15T22:42:35Z

generatorv2/lib/generator.rb

@@ -0,0 +1,49 @@
+require 'toml-rb'


What problems or solutions are we avoiding/gaining by using TOML as opposed to YAML (or even JSON)? This is the point at which TOML as a tool and dependency is being introduced, and its associated maintenance cost, so we should evaluate that. We should have a net positive effect by bringing this in.

The test.toml files are written in toml, using another file format isn't really an option since rewriting it would require parsing it.

I wrote a manual parser for the Crystal generator (but it is likely not as good of an implementation) because I couldn't find any good shards (library). This library should be fine, the toml specification isn't changing, but we could have our own solution.

The goal is more or less with the toml files is that, if someone adds extra test cases or reimplements test cases for a certain exercise will that not affect the generation process until you sync the exercise. Meaning the ci won't fail in the majority of cases if not all exercises are synced.

kotp · 2024-11-15T22:52:57Z

bin/generate

+      f = Tempfile.create
+      Generator.new(exercise).generate(f.path)
+      generated_code = f.read
+      raise RuntimeError.new("The result generated for: #{exercise}, doesnt match the current file") if current_code != generated_code


Suggested change

raise RuntimeError.new("The result generated for: #{exercise}, doesnt match the current file") if current_code != generated_code

raise RuntimeError.new("The result generated for: #{exercise}, doesn't match the current file") unless current_code == generated_code

Typographical error (missing apostrophe) and preference of "positive conditional statement".

Prefer using unless positive_conditional_statement rather than if negative, this can keep all (or at least most) of our conditional statements positive.

We should also consider if RuntimeError is the best error here. It could be VerificationError instead, which would be more specific.

We might also fail instead of raise for the communication that this is purposefully failed here, given the right conditions.

kotp · 2024-11-15T22:54:03Z

generatorv2/README.md

+Since the generator grabs all the data from the canonical data, so does this enable new tests that won't automatically be merged in.
+Instead so does new tests have to be added to the toml file before they show up in the test file.
+
+If there is a test that isn't needed or something that doesn't fit Ruby you can remove it from the toml file.


Suggested change

If there is a test that isn't needed or something that doesn't fit Ruby you can remove it from the toml file.

If there is a test that isn't needed or something that doesn't fit Ruby you can remove it from the configuration file.

In case we move from TOML to another type of configuration file, this reference will not need to change in the documentation.

generatorv2/README.md

…g as the normal creation. Other changes based on feedback

kotp · 2024-11-17T18:56:22Z

bin/generate

    end
+    rescue VerificationError => e
+      $stderr.puts e.message % {exercise:}


Be aware that this syntax is relatively new, and so we should ensure that the minimum Ruby version is set to allow for this "valueless hash" syntax.

I mean it is tooling and we have set the ruby version to 3.3 so I think we dont have to have backwards compatibility.

It means that it is backward compatible to 3.3.0, up to 3.3.6, currently. Locally I am running 3.3.6, and so the backward compatibility is there.

bin/generate

Co-authored-by: Victor Goff <[email protected]>

kotp · 2025-01-01T01:13:46Z

bin/generate

+parser = OptionParser.new
+
+parser.on('-v', '--version', 'Print the version') do
+  puts '0.1.0'


Consider extracting this out to a version file for the generator. This will mean that we do not have to dig into the code to update the version.

kotp · 2025-01-01T02:00:10Z

generatorv2/README.md

+# This would break it since it is an extra space between UUID and `[`
+[ 1e22cceb-c5e4-4562-9afe-aef07ad1eaf4]
+```
+


It may be worth writing a "validator" option for the genator. Perhaps even initiating the bundle install command that is needed. If we know it has to happen we can provide the mechanism, avoiding mistakes from the users, even if it is seemingly "simple".

I think, that shouldn't actually be an issue, unless it breaks against toml rules which I think it doesn't. The docs very some what of a copy paste from the Crystal docs (so it shouldn't be here). And that one has that issue,

kotp · 2025-01-01T02:02:09Z

generatorv2/README.md

+
+### The Test Generator
+
+If all the earlier steps are done so can you run the generator.


Suggested change

If all the earlier steps are done so can you run the generator.

If all the earlier steps are done you run the generator.

kotp · 2025-01-01T02:03:16Z

generatorv2/README.md

+
+The template file is written in [Embedded Ruby(ERB)][erb].
+ERB enables you to write Ruby code inside of the template file.
+It also means that the templates can be highly customizable since you can write any Ruby code you want.


Suggested change

It also means that the templates can be highly customizable since you can write any Ruby code you want.

It also means that the templates can be highly customized allowing you to write any Ruby code you want or need.

kotp · 2025-01-01T02:03:48Z

generatorv2/README.md

+The template is located under the `.meta` for each exercise.
+
+This template has to be manually written for each exercise.
+The goal although is to make it so that you only have to write the template once and then it will be able to be used to generate new tests.


Suggested change

The goal although is to make it so that you only have to write the template once and then it will be able to be used to generate new tests.

The goal is to make it so that you only have to write the template once and then it will be able to be used to generate new tests.

kotp · 2025-01-01T02:09:21Z

generatorv2/README.md

+To run the generator so do you have to be in the root directory and run the following command:
+
+```shell
+bundle exec ./bin/generate -e <exercise_slug>


Either the line commented prior to this comment is incorrect, or this line is incorrect.

kotp · 2025-01-01T02:10:21Z

generatorv2/README.md

+
+Where `<exercise_slug>` is the same name as the slug name which is located in the `config.json` file.
+
+For more commands so can you run the following command:


Suggested change

For more commands so can you run the following command:

For more commands and options, you can see this by running the command:

kotp · 2025-01-01T02:11:34Z

generatorv2/README.md

+
+The generator will give you errors and warnings if something is wrong.
+That includes if the exercise is not in the `config.json` file, if the exercise is not in the toml file, or if the template file is missing.
+Also if it has a problem getting the `canonical-data.json` file so will it give you an error.


Suggested change

Also if it has a problem getting the `canonical-data.json` file so will it give you an error.

It will also report an error if it can not read the `canonical-data.json` file.

kotp · 2025-01-01T02:12:51Z

generatorv2/README.md

+The generator will give you errors and warnings if something is wrong.
+That includes if the exercise is not in the `config.json` file, if the exercise is not in the toml file, or if the template file is missing.
+Also if it has a problem getting the `canonical-data.json` file so will it give you an error.
+The generator also uses a formatter which will give you errors if the generated file is not formatted correctly.


Suggested change

The generator also uses a formatter which will give you errors if the generated file is not formatted correctly.

The generator will check that the generated file is formatted correctly, reporting an error if there is a problem.

kotp · 2025-01-01T02:13:33Z

generatorv2/README.md

+That includes if the exercise is not in the `config.json` file, if the exercise is not in the toml file, or if the template file is missing.
+Also if it has a problem getting the `canonical-data.json` file so will it give you an error.
+The generator also uses a formatter which will give you errors if the generated file is not formatted correctly.
+The file will still be generated even if formatter gives errors, therefore can you check the file and see what is wrong and fix it in the template.


Suggested change

The file will still be generated even if formatter gives errors, therefore can you check the file and see what is wrong and fix it in the template.

The file will still be generated even if the formatter reports errors, so that you can check the file and see what is wrong and fix it in the template.

Impliment basic prototype as proof of concept

77a991b

meatball133 added the x:rep/large Large amount of reputation label Nov 9, 2024

meatball133 and others added 5 commits November 9, 2024 17:48

Add ci and more tests

039911c

Update gemfile.lock to include toml-rb

8e3afbe

Merge branch 'main' into add-new-generator

d278534

Fix rubocop and fix ci

5c27b41

Format files

b1f131f