Bootstrap practice exercises #774

jiegillet · 2021-06-21T07:08:32Z

This script will generate all files (minus config.json and tests.toml) for a practice exercise. Of course, the tests need a bunch of manual input, but usually at the level of search and replace, so it's quite valuable.

I tried to be a little bit clever about some things (for example @SPEC generation for the lib file) but I hope that contributors understand that they should not trust these guesses too much. Is it better to make them obviously wrong?
Please test that script by running elixir bin/boostrap_practice_exercise.exs darts (or whichever exercise) and inspect the generated files. I'm sure there is room for improvement.

github-actions · 2021-06-21T07:13:13Z

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)

Automated comment created by PR Commenter 🤖.

angelikatyborska

I run it on a few existing exercises and left some (hopefully realistic) improvement ideas based on the output.

This is excellent 🎉. I guess with this script you'll churn through all the remaining "new practice exercise" issues in no time. I have to create more 😅.

angelikatyborska · 2021-06-22T15:12:57Z

bin/bootstrap_practice_exercise.exs

+    """
+     @doc \"\"\"
+     insert function description here
+     \"\"\"
+     @spec #{property}(#{Enum.map_join(variables, ", ", fn
+      {var, nil} -> "#{var} :: String.t()"
+      {var, sub_vars} -> "#{var} :: %{#{Enum.map_join(sub_vars, " : String.t(), ", fn v -> v end)} : String.t()}"
+    end)}) :: {:ok, String.t()} | {:error, String.t()}
+     def #{property}(#{Enum.map_join(variables, ", ", fn {var, _} -> var end)}) do
+     end
+    """


Is it better to make them obviously wrong?

Maybe it's better to somehow mark them as requiring manual changes? Maybe something like this? (and similar in other places that also have most-likely-wrong defaults)

Suggested change

"""

@doc \"\"\"

insert function description here

\"\"\"

@spec #{property}(#{Enum.map_join(variables, ", ", fn

{var, nil} -> "#{var} :: String.t()"

{var, sub_vars} -> "#{var} :: %{#{Enum.map_join(sub_vars, " : String.t(), ", fn v -> v end)} : String.t()}"

end)}) :: {:ok, String.t()} | {:error, String.t()}

def #{property}(#{Enum.map_join(variables, ", ", fn {var, _} -> var end)}) do

end

"""

"""

@doc \"\"\"

TODO: insert function description here

\"\"\"

@spec #{property}(#{Enum.map_join(variables, ", ", fn

{var, nil} -> "#{var} :: TODO.t()"

{var, sub_vars} -> "#{var} :: %{#{Enum.map_join(sub_vars, " : TODO.t(), ", fn v -> v end)} : TODO.t()}"

end)}) :: TODO.t()

def #{property}(#{Enum.map_join(variables, ", ", fn {var, _} -> var end)}) do

end

"""

angelikatyborska · 2021-06-22T15:28:46Z

bin/bootstrap_practice_exercise.exs

+    test \"#{description}\" do
+      #{Generate.print_comments(c, ["description", "property", "input", "expected", "uuid"])}
+      #{print_input(input)}
+      output = #{module}.#{Generate.to_snake_case(property)}(#{print_variables(input)})


It would be good if changing to snake case happened as soon as possible, right after fetching and decoding the JSON, and not when printing the test case. For example, you forgot to use it when printing the stub 😉 so for an exercise like allergies (https://github.com/exercism/problem-specifications/blob/e2779fc84ff07cb5bd8ff89f38e78af6d17b5056/exercises/allergies/canonical-data.json#L14), you get a stub like this:

def allergicTo(item, score) do end

but a function call in tests like this:

output = Allergies.allergic_to(item, score)

It's also necessary to change properties to snake case, for example: https://github.com/exercism/problem-specifications/blob/daf620d47ed905409564dec5fa9610664e294bde/exercises/all-your-base/canonical-data.json#L20-L22

angelikatyborska · 2021-06-22T15:31:51Z

bin/bootstrap_practice_exercise.exs

+  def print_expected(%{"error" => err}), do: "{:error, #{inspect(err)}}"
+  def print_expected(expected), do: "{:ok, #{inspect(expected)}}"


Would it be possible (and not too difficult) to make this more intelligent, and only use {:ok, value} if any error case exists in the problem specification for this property, and otherwise just use the plain value? There are a lot of exercises without any error handling.

angelikatyborska · 2021-06-22T15:33:40Z

bin/bootstrap_practice_exercise.exs

+]
+"""
+
+Mix.Generator.create_file("exercises/practice/#{exercise}/.formatter.exs", format)


I had no idea about this module 😍 awesome

It is quite nice. And actually it wouldn't be much more work to make this script into a Mix.Task. It would be kind of cool: mix ex.practice.gen darts.

neenjaw · 2021-06-22T16:33:27Z

I'd like to look over this one before merge, but might need to wait a couple days if that's okay. I have all next week off, so should be able to catch up on this stuff. :)

jiegillet · 2021-06-23T02:23:39Z

bin/bootstrap_practice_exercise.exs

+
+path = "exercises/practice/#{exercise}/test/#{exercise_path}_test.exs"
+Mix.Generator.create_file(path, test_file)
+System.cmd("mix", ["format", path])


Do you know if there is a way to call mix format from within a .exs script without having to use System.cmd? I searched for it, but couldn't find it.
Although maybe it's best to run it this way so that it includes the format in .formatter.exs.

Every mix task is just a module with a run function, so it should be possible to run Mix.Tasks.Format.run([]). It should read .formatter.exs from the current directory anyway.

mix format documentation: https://hexdocs.pm/mix/master/Mix.Tasks.Format.html
and implementation: https://github.com/elixir-lang/elixir/blob/2a4312412be39303af08ccd0cef81b5bbcd55eac/lib/mix/lib/mix/tasks/format.ex#L1

jiegillet · 2021-06-26T04:08:52Z

I guess with this script you'll churn through all the remaining "new practice exercise" issues in no time. I have to create more 😅.

I compiled a list of all the exercises we don't have yet (separating the ones with and without tests), do you want me to share it in an issue? Or do you prefer individual ones?

neenjaw · 2021-06-26T06:20:09Z

bin/bootstrap_practice_exercise.exs

+  def to_snake_case(lower_camel_case) do
+    lower_camel_case
+    |> String.split(~r/(?=[A-Z\d])/)
+    |> Enum.map_join("_", &String.downcase/1)
+  end


We can use Macro.underscore for this if we are using it just for identifiers

bin/bootstrap_practice_exercise.exs

neenjaw · 2021-06-26T06:29:29Z

bin/bootstrap_practice_exercise.exs

+defmodule #{module}.MixProject do
+  use Mix.Project
+
+  def project do
+    [
+      app: :#{exercise_snake_case},
+      version: "0.1.0",
+      # elixir: "~> 1.8",
+      start_permanent: Mix.env() == :prod,
+      deps: deps()
+    ]
+  end
+
+  # Run "mix help compile.app" to learn about applications.
+  def application do
+    [
+      extra_applications: [:logger]
+    ]
+  end
+
+  # Run "mix help deps" to learn about dependencies.
+  defp deps do
+    [
+      # {:dep_from_hexpm, "~> 0.3.0"},
+      # {:dep_from_git, git: "https://github.com/elixir-lang/my_dep.git", tag: "0.1.0"}
+    ]
+  end
+end
+"""


Minor: if we can't run mix format on this file, can we indent here 2 spaces for this binding?

~~At the end we run mix format on everything, it should take care of this one too.~~.
I'm not sure what you mean, I ran mix format on the file.
Do you want to indent the triple quoted block? mix format puts it back there.

neenjaw · 2021-06-26T06:29:48Z

bin/bootstrap_practice_exercise.exs

+ExUnit.start()
+ExUnit.configure(exclude: :pending, trace: true)
+"""


Minor, same indent as mentioned above

Here the indentation looks good already 🤔 meaning: level 0, there's no indentation.

neenjaw

Left a few minor comments, cool stuff!

angelikatyborska · 2021-06-26T07:18:49Z

I compiled a list of all the exercises we don't have yet (separating the ones with and without tests), do you want me to share it in an issue? Or do you prefer individual ones?

There is a dashboard for this already: https://tracks.exercism.io/elixir/main/unimplemented

Sadly it doesn't mention which exercises don't have tests defined, but there's only a few left unimplemented so we can manage.

Normally only maintainers deal with exercise selection, but since you're working faster than I can review or write new issues, I want to share with you my thoughts on implementing those missing exercises:

I don't want any of the exercises that don't have canonical-data.json (error handling, hangman, ledger, lens-person, paasio, robot-name, tree building) because that puts on me and Tim the responsibility to figure out which tests cases are necessary for the story, to think of the corner cases etc., it just sounds like too much work 😅
I don't want any of the exercises that are ridiculously easy in a high level programming language (reverse string, maybe micro blog). That might not apply to square root because I think square root could forbid using the standard library and demand a manual implementation.
I don't want high scores because it will conflict with a similar concept exercise that we already have

The rest can be implemented and your PRs with them will be very welcome if you still have the time and energy 🙂

bin/bootstrap_practice_exercise.exs

angelikatyborska · 2021-06-26T12:35:09Z

I'm going to make a call that all the feedback has been considered and applied, and now it's merge time 🎉

Bootstrap pratice exercises

ea5b6b4

angelikatyborska approved these changes Jun 22, 2021

View reviewed changes

angelikatyborska requested a review from neenjaw June 22, 2021 15:45

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

Check if properties can fail, use TODO for types

f5ec820

jiegillet commented Jun 23, 2021

View reviewed changes

jiegillet added 2 commits June 23, 2021 11:25

Rename exercise_path to exercise_snake_case

93c9750

Use Mix.Tasks.Format.run() instead of System.cmd

ac95c3c

neenjaw reviewed Jun 26, 2021

View reviewed changes

bin/bootstrap_practice_exercise.exs Outdated Show resolved Hide resolved

neenjaw reviewed Jun 26, 2021

View reviewed changes

neenjaw approved these changes Jun 26, 2021

View reviewed changes

jiegillet added 2 commits June 26, 2021 17:08

Use Macro.underscore

682f3fc

Mix.install to the top

35ecec0

angelikatyborska reviewed Jun 26, 2021

View reviewed changes

bin/bootstrap_practice_exercise.exs Outdated Show resolved Hide resolved

Update bin/bootstrap_practice_exercise.exs

ddbec2b

angelikatyborska merged commit 98f8168 into exercism:main Jun 26, 2021

jiegillet deleted the jie-bootstrap-exercise branch June 26, 2021 13:47

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

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

		def print_expected(%{"error" => err}), do: "{:error, #{inspect(err)}}"
		def print_expected(expected), do: "{:ok, #{inspect(expected)}}"

Uh oh!

Bootstrap practice exercises #774

Bootstrap practice exercises #774

Uh oh!

Conversation

jiegillet commented Jun 21, 2021

Uh oh!

github-actions bot commented Jun 21, 2021

Uh oh!

angelikatyborska left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

neenjaw commented Jun 22, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jiegillet commented Jun 26, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jiegillet Jun 26, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

neenjaw left a comment

Choose a reason for hiding this comment

Uh oh!

angelikatyborska commented Jun 26, 2021

Uh oh!

Uh oh!

angelikatyborska commented Jun 26, 2021

Uh oh!

Uh oh!

jiegillet Jun 26, 2021 •

edited

Loading