Impliment new template based generator (#1730)

* Impliment basic prototype as proof of concept

* Add ci and more tests

* Update gemfile.lock to include toml-rb

* Fix rubocop and fix ci

* Format files

* EOL for every line in text file

* Generator now executable and changes based on feedback

* Fix interpreter name

* Add missing name key in ci file

* Fix execution path of ci scripts

* Remove Crystal image refernce and fixes to ci

* Bump rubocop version and add missing actions checkout

* Test adding bundle install

* Test uppdating gemfile

* Change to using `bundle exec`

* Make the generate script use the same rubocop config as the repo

* Test rollback to rubocop 1.50

* Update readme to reflect recent changes

* Split utils methods into its own module

* Breakout helper method and exception class

* Verify now creates a file in exercise directory to get same formatting as the normal creation. Other changes based on feedback

* Changes based on feedback and add more tasks to rakefile

* Update bin/generate

Co-authored-by: Victor Goff <keeperotphones+github@gmail.com>

* Changes based on feedback

* Update tests to reflect rename of `skip?`

* Update test names

* Add EOL

---------

Co-authored-by: Victor Goff <keeperotphones+github@gmail.com>
Co-authored-by: KOTP <keeperotphones@gmail.com>

Author: meatball133

.github/workflows/generator-tests.yml

@@ -0,0 +1,34 @@
+name: GeneratorTests
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test-generator-templates:
+    name: Check Generator Templates
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@52753b7da854d5c07df37391a986c76ab4615999
+        with:
+          ruby-version: "3.3"
+          bundler-cache: true
+      - name: Verify templates
+        run: bundle exec ./bin/generate --verify
+  test-generator:
+    name: Test Generator
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@52753b7da854d5c07df37391a986c76ab4615999
+        with:
+          ruby-version: "3.3"
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rake test:generator

Gemfile

@@ -3,6 +3,7 @@ source 'https://rubygems.org'
 gem 'base64'
 gem 'minitest'
 gem 'rake'
+gem 'toml-rb', require: false
 gem 'mocha', require: false
 gem 'rubocop', '~> 1.50.0', require: false
 gem 'rubocop-minitest', require: false

Gemfile.lock

@@ -3,19 +3,20 @@ GEM
   specs:
     ast (2.4.2)
     base64 (0.2.0)
+    citrus (3.0.2)
     docile (1.4.0)
-    json (2.7.2)
+    json (2.8.1)
     minitest (5.22.3)
     mocha (2.1.0)
       ruby2_keywords (>= 0.0.5)
-    parallel (1.24.0)
-    parser (3.3.0.5)
+    parallel (1.26.3)
+    parser (3.3.6.0)
       ast (~> 2.4.1)
       racc
     racc (1.7.3)
     rainbow (3.1.1)
     rake (13.2.1)
-    regexp_parser (2.9.0)
+    regexp_parser (2.9.2)
     rexml (3.3.9)
     rubocop (1.50.2)
       json (~> 2.3)
@@ -27,8 +28,8 @@ GEM
       rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.31.2)
-      parser (>= 3.3.0.4)
+    rubocop-ast (1.34.1)
+      parser (>= 3.3.1.0)
     rubocop-minitest (0.34.5)
       rubocop (>= 1.39, < 2.0)
       rubocop-ast (>= 1.30.0, < 2.0)
@@ -42,7 +43,10 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    unicode-display_width (2.5.0)
+    toml-rb (3.0.1)
+      citrus (~> 3.0, > 3.0)
+      racc (~> 1.7)
+    unicode-display_width (2.6.0)
 
 PLATFORMS
   ruby
@@ -57,6 +61,7 @@ DEPENDENCIES
   rubocop-minitest
   rubocop-rake
   simplecov
+  toml-rb
 
 BUNDLED WITH
    2.5.7

Rakefile

@@ -16,6 +16,21 @@ task :rubocop do
   system('rubocop --display-cop-names')
 end
 
+desc "Run generator for specefic exercise"
+task :generate, [:exercise] do |_t, argumments|
+  system("./bin/generate --exercise #{argumments[:exercise]}")
+end
+
+desc "Run generator for all exercises"
+task :generate_all do
+  system("./bin/generate --all")
+end
+
+desc "Verify templates for all exercises"
+task :verify do
+  system("./bin/generate --verify")
+end
+
 namespace :test do
   flags = ARGV.drop_while { |e| e != '--' }.drop(1).join(' ')
 
@@ -25,5 +40,10 @@ namespace :test do
     task.pattern = 'test/**/*_test.rb'
   end
 
+  Rake::TestTask.new :generator do |task|
+    task.options = flags
+    task.pattern = 'generatorv2/test/**/*_test.rb'
+  end
+
   ExerciseTestTasks.new options: flags
 end

bin/generate

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+require 'optparse'
+require 'tempfile'
+require_relative '../generatorv2/lib/generator'
+
+# Helper methods
+def exercises
+  Dir.entries('./exercises/practice')
+    .select { |file| File.directory? File.join('./exercises/practice', file) }
+end
+
+class VerificationError < StandardError
+  MESSAGE = 'The result generated for %<exercise>s, does not match the current file'
+
+  def initialize(message = MESSAGE)
+    super
+  end
+end
+
+# Parsing Code
+parser = OptionParser.new
+
+parser.on('-v', '--version', 'Print the version') do
+  puts File.read('./generatorv2/VERSION')
+end
+
+parser.on('-h', '--help', 'Prints help') do
+  puts parser
+end
+
+parser.on('-a', '--all', 'Generate all exercises') do
+  exercises.each do |exercise|
+    if File.exist?("./exercises/practice/#{exercise}/.meta/test_template.erb")
+      Generator.new(exercise).generate
+    end
+  end
+end
+
+parser.on('--verify', 'Verify all exercises') do
+  exercises.each do |exercise|
+    if File.exist?("./exercises/practice/#{exercise}/.meta/test_template.erb")
+      current_code = File.read("./exercises/practice/#{exercise}/#{exercise}_test.rb")
+      f = File.new("./exercises/practice/#{exercise}/temp_test.rb", 'w+')
+      Generator.new(exercise).generate(f.path)
+      generated_code = f.read
+      File.delete(f.path)
+      fail VerificationError unless current_code == generated_code
+    end
+    rescue VerificationError => e
+      STDERR.puts e.message % {exercise:}
+  end
+end
+
+parser.on('-e', '--exercise EXERCISE', 'The exercise to generate') do |exercise|
+  Generator.new(exercise).generate
+end
+
+parser.parse!

exercises/practice/acronym/.meta/test_template.erb

@@ -0,0 +1,13 @@
+require 'minitest/autorun'
+require_relative 'acronym'
+
+class AcronymTest < Minitest::Test
+<% json["cases"].each do |cases| %>
+    def test_<%= underscore(cases["description"]) %>
+        <%= skip? %> 
+        assert_equal '<%= cases["expected"] %>', <%= camel_case(json["exercise"]) %>.<%= underscore(cases["property"]) %>('<%= cases["input"]["phrase"] %>')
+    end
+<% end %>
+end
+
+

exercises/practice/acronym/acronym_test.rb

@@ -4,37 +4,36 @@
 class AcronymTest < Minitest::Test
   def test_basic
     # skip
-    assert_equal "PNG", Acronym.abbreviate('Portable Network Graphics')
+    assert_equal 'PNG', Acronym.abbreviate('Portable Network Graphics')
   end
 
   def test_lowercase_words
     skip
-    assert_equal "ROR", Acronym.abbreviate('Ruby on Rails')
+    assert_equal 'ROR', Acronym.abbreviate('Ruby on Rails')
   end
 
   def test_punctuation
     skip
-    assert_equal "FIFO", Acronym.abbreviate('First In, First Out')
+    assert_equal 'FIFO', Acronym.abbreviate('First In, First Out')
   end
 
   def test_all_caps_word
     skip
-    assert_equal "GIMP", Acronym.abbreviate('GNU Image Manipulation Program')
+    assert_equal 'GIMP', Acronym.abbreviate('GNU Image Manipulation Program')
   end
 
   def test_punctuation_without_whitespace
     skip
-    assert_equal "CMOS", Acronym.abbreviate('Complementary metal-oxide semiconductor')
+    assert_equal 'CMOS', Acronym.abbreviate('Complementary metal-oxide semiconductor')
   end
 
   def test_very_long_abbreviation
     skip
-    assert_equal "ROTFLSHTMDCOALM",
-      Acronym.abbreviate('Rolling On The Floor Laughing So Hard That My Dogs Came Over And Licked Me')
+    assert_equal 'ROTFLSHTMDCOALM', Acronym.abbreviate('Rolling On The Floor Laughing So Hard That My Dogs Came Over And Licked Me')
   end
 
   def test_consecutive_delimiters
     skip
-    assert_equal "SIMUFTA", Acronym.abbreviate('Something - I made up from thin air')
+    assert_equal 'SIMUFTA', Acronym.abbreviate('Something - I made up from thin air')
   end
 end

generatorv2/README.md

@@ -0,0 +1,115 @@
+# Generator
+
+Last Updated: 2024/11/9
+
+The generator is a powerful tool that can be used to generate tests for exercises based on the canonical data.
+The generator is written in Ruby and is located in the `bin` directory.
+
+## How to use the generator
+
+### Things to do before running the generator
+
+Run `bundle install` to install the required libraries.
+Before running the generator you have to make sure a couple of files are in place.
+
+1. `tests.toml` file
+
+It is located under the `.meta` folder for each exercise.
+The toml file is used to configure which exercises are generated and which are not.
+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.
+By writing after the test name `include = false` and it will be skipped when generating the test file.
+
+2. `config.json` file, located in the root of the track
+
+The generator makes sure that the exercise is in the config.json so you need to add it there before running the generator.
+
+**NOTE:**
+You are **NOT** allowed to write `include = false` more than once after each UUID.
+Since that can lead to errors in the generator.
+
+Bad way:
+
+```toml
+[1e22cceb-c5e4-4562-9afe-aef07ad1eaf4]
+description = "basic"
+include = false
+include = false
+```
+
+Good way:
+
+```toml
+[1e22cceb-c5e4-4562-9afe-aef07ad1eaf4]
+description = "basic"
+include = false
+```
+
+### Template
+
+The generator uses a template file to generate the test file.
+The template is located under the `.meta` for each exercise.
+
+This template has to be manually written for each exercise.
+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.
+
+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.
+
+When writing the template file, it is recommended to look at already existing template files to get a better understanding of how it works.
+The template is getting a slightly modified version of the canonical data, so you can check out the [canonical data][canonical data] to see the data structure.
+The modification is that the cases which are not included in the toml file will be removed from the data structure.
+
+When writing the template so is it a special tool that can help with giving `# skip` and `skip` tags for tests.
+You simply have to call the `skip?` method.
+It will return either `# skip` or `skip` depending on if it is the first test case or not.
+
+Here is an example:
+
+```
+<%= skip? %>
+<%= skip? %>
+<%= skip? %>
+```
+
+result:
+
+```
+# skip
+skip
+skip
+```
+
+### The Test Generator
+
+If all the earlier steps are done you run the generator.
+To run the generator you need to have a working Ruby installation with the gems installed, via `bundle install`.
+The generator is located in the `bin` directory and is called `generator`.
+
+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-name>
+```
+
+Where `<exercise-name>` is the same name as the exercise has in its directory.
+
+For more commands and options, you can see this by running the command:
+
+```shell
+bundle exec ./bin/generate --help
+```
+
+### Errors and warnings
+
+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.
+It will also report an error if it can not read the `canonical-data.json` file.
+The generator will check that the generated file is formatted correctly, reporting an error if there is a problem.
+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.
+
+[erb]: https://docs.ruby-lang.org/en/master/ERB.html
+[canonical data]: https://github.com/exercism/problem-specifications

generatorv2/VERSION

@@ -0,0 +1 @@
+0.1.0