Document structs, maps, keyword lists via testing & fix accidental key replacement bug #73
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
angelikatyborska
commented
Sep 3, 2022
lib/representer.ex
Outdated
Comment on lines
280
to
320
| # module attributes that hold module or function names inside of key-value pairs. | ||
| # Note that module attributes that hold module or function names outside of key-value pairs are excluded from this list. | ||
| @attributes_with_key_value_pairs_that_hold_module_or_function_names ~w(compile optional_callbacks dialyzer)a | ||
| defp do_use_existing_placeholders({:@, meta, [{name, meta2, value}]}, represented) | ||
| when name in @attributes_with_key_value_pairs_that_hold_module_or_function_names do | ||
| handle_list = fn list, represented -> | ||
| {new_list, new_represented} = | ||
| Enum.reduce(list, {[], represented}, fn elem, {acc, represented} -> | ||
| {elem, represented} = | ||
| case elem do | ||
| {_, _} -> use_existing_placeholders_on_key_value_pair(elem, represented) | ||
| _ -> {elem, represented} | ||
| end | ||
|
|
||
| {[elem | acc], represented} | ||
| end) | ||
|
|
||
| {Enum.reverse(new_list), new_represented} | ||
| end | ||
|
|
||
| {value, represented} = | ||
| case value do | ||
| # e.g. @dialyzer {:nowarn_function, function_name: 0} | ||
| [{elem1, elem2}] when is_list(elem2) -> | ||
| {elem2, represented} = handle_list.(elem2, represented) | ||
| {[{elem1, elem2}], represented} | ||
|
|
||
| # e.g. @optional_callbacks [function_name1: 0] | ||
| [elem1] when is_list(elem1) -> | ||
| {elem1, represented} = handle_list.(elem1, represented) | ||
| {[elem1], represented} | ||
|
|
||
| value -> | ||
| {value, represented} | ||
| end | ||
|
|
||
| {{:@, meta, [{name, meta2, value}]}, represented} | ||
| end | ||
|
|
||
| # TODO: `when` clauses in specs but only for variable names, not key names in maps | ||
|
|
There was a problem hiding this comment.
This seems a bit crazy already and it's not the full fix yet 🙊 I'm trying to fix the consequences of d2fc2d3 (#73) but I'm not sure if it's worth it.
There was a problem hiding this comment.
Haha yeah it does seem a bit crazy and endless.
Representers get so complex after a while :(
angelikatyborska
changed the title
jiegillet
approved these changes
Sep 10, 2022
| @@ -0,0 +1,24 @@ | |||
| defmodule Placeholder_1 do | |||
| defstruct [:wheels, :doors, :color] | |||
There was a problem hiding this comment.
Eventually, we will want these user defined keys to be replaced as mentionned in #37, right?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR: