Provides two macros to make model creation more convenient #643

gabsi26 · 2022-05-29T14:10:31Z

An initial PR to get this rolling.

This PR deals with #72. Where attributed_arguments is a crude implementation of an idea #72 (comment)

The attribute #[value()] is required for each parameter the user wants to pass to the model it accepts different forms

#[value(3)] sets default value to 3
#[value(default=3)] same as above
min and max can additionally be supplied like this:
#[value(min=1, max=2)]
As long as either one of the three values is supplied a default will be set, min and max are currently only used if no default is provided to set it. Where min takes precedence over max.
Later on a doc comment containing the provided min and max values should be introduced.

hannobraun · 2022-05-30T13:05:00Z

Thank you for the pull request, @gabsi26! I'll take a look later, possibly tomorrow.

hannobraun

Thank you again for the pull request, @gabsi26! This is an awesome improvement!

I left a bunch of comments with specific suggestions, as well as more general remarks on where I'd like to see things going. Feel free to address those in a follow-up PR, if you're up for it. I'll merge this one now, as it provides an excellent base for further iteration.

hannobraun · 2022-05-31T11:18:11Z

Cargo.toml

    "crates/fj-viewer",
+    "crates/fj-proc",
+


The rest of that list is alphabetically sorted. Would be nice to keep that. Also, no need for an empty line.

hannobraun · 2022-05-31T11:18:54Z

Cargo.toml

+    "crates/fj-proc",
+
+


There's the same crate a second time. I'm surprised that doesn't result in some kind of error! 😄

hannobraun · 2022-05-31T11:21:24Z

models/star/Cargo.toml

+
+[dependencies.fj-proc]
+path = "../../crates/fj-proc"


I think it should be possible, to re-export fj-proc from fj (pub use fj_proc;). Then we wouldn't need the extra dependency, and would also have a simpler syntax in the models (fj::model instead of fj_proc::model).

hannobraun · 2022-05-31T11:36:50Z

crates/fj-proc/src/attributed_arguments.rs

+    bracketed, parenthesized, parse::Parse, parse_macro_input, parse_quote,
+};
+
+pub fn attributed_arguments(_: TokenStream, input: TokenStream) -> TokenStream {


I think having two different attributes (and two different models for testing/demonstrating) them is overkill. I like the approach implemented in this one much better. It would be better, if this just replaced the other one.

The first one was more or less just left in because it was the first one I came up with. So more for completeness than anything else. I'll get rid of it :)

hannobraun · 2022-05-31T11:38:36Z

crates/fj-proc/src/attributed_arguments.rs

+                    _ => {}
+                }
+            } else {
+                default = Some(value.val.clone());


Maybe it would be better not to have this fallback, and always require an explicit default = to specify default values. Would be more verbose in the simple case, but also easier to read and understand.

What do you think?

I think I'll simplify the macro to not allow for this implicit fallback

hannobraun · 2022-05-31T11:41:42Z

crates/fj-proc/src/attributed_arguments.rs

+                default = Some(value.val.clone());
+            }
+        }
+        let [default, min, max] = determine_default(default, min, max);


I think the behavior of this function, using min or max as the default, if no default is provided, is unexpected and potentially confusing for users. It would probably be clearer to just have no default, if none is provided, and fail with an error message, if the user doesn't provide a value for a default-less parameter.

hannobraun · 2022-05-31T11:42:45Z

crates/fj-proc/src/attributed_arguments.rs

+/// Represents one parameter given to the `model`
+/// `#[value(default=3, min=4)] num_points: u64`
+/// `^^^^^^^^^^^^^^^^^^^^^^^^^^ ~~~~~~~~~~  ^^^-- ty`
+/// `           |                    |`
+/// `         attr                 ident`


Nice style of documentation 👍

With this change the `model` function is a lot nicer to write default values are provided as macro arguments currently all arguments **must** have a default value defined this way there are also no checks in place to ensure the default is valid for the type of the argument Signed-off-by: gabsi26 <[email protected]>

Signed-off-by: gabsi26 <[email protected]>

This is a first iteration on a asuggested way to implement modelling convenience Signed-off-by: gabsi26 <[email protected]>

Signed-off-by: gabsi26 <[email protected]>

The struct `AttributeParameter`was only used for its `new` method, thus it was replaced by `determine_default()` Some comments were added to make the purpose of structs a bit clearer Signed-off-by: gabsi26 <[email protected]>

Signed-off-by: gabsi26 <[email protected]>

hannobraun · 2022-05-31T12:00:16Z

One additional note: I just discovered, that Cargo.lock wasn't up-to-date, meaning Cargo will immediately update it on any cargo build, cargo test, or similar. Then there will be a local change, which can confuse contributors and could interfere with work in the Git history (like somebody running a git bisect).

No big deal, I'll fix it (I'm about to do my weekly cargo update anyway). But in general, it would be nicer if changes to Cargo.lock were committed in the same commit that triggered them (like in this case, the commit that adds the new crate).

gabsi26 requested a review from hannobraun as a code owner May 29, 2022 14:10

gabsi26 changed the title ~~Proc me up scotty rovides two proc macros to~~ Provides two macros to make model creation more convenient May 29, 2022

hannobraun approved these changes May 31, 2022

View reviewed changes

gabsi26 added 8 commits May 31, 2022 13:49

Include fj-proc in workspace

1b623b3

Signed-off-by: gabsi26 <[email protected]>

Update star model to use the procedural macro

29dbeb5

Signed-off-by: gabsi26 <[email protected]>

Include fj-proc in workspace

79ae023

Signed-off-by: gabsi26 <[email protected]>

Create attributed_arguments variant proc_macro

495dcfe

This is a first iteration on a asuggested way to implement modelling convenience Signed-off-by: gabsi26 <[email protected]>

Use attributed_arguments macro in an example

934fca2

Signed-off-by: gabsi26 <[email protected]>

Replace struct with function and add comments

efed269

The struct `AttributeParameter`was only used for its `new` method, thus it was replaced by `determine_default()` Some comments were added to make the purpose of structs a bit clearer Signed-off-by: gabsi26 <[email protected]>

Add one more comment and remove debug println!

78b4756

Signed-off-by: gabsi26 <[email protected]>

hannobraun force-pushed the proc_me_up_scotty branch from 20a4dd9 to 78b4756 Compare May 31, 2022 11:49

hannobraun enabled auto-merge May 31, 2022 11:49

hannobraun mentioned this pull request May 31, 2022

Make defining models more convenient #72

Closed

hannobraun merged commit 3daab76 into hannobraun:main May 31, 2022

gabsi26 deleted the proc_me_up_scotty branch May 31, 2022 12:06

gabsi26 mentioned this pull request May 31, 2022

Proc me up again #652

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Provides two macros to make model creation more convenient #643

Provides two macros to make model creation more convenient #643

gabsi26 commented May 29, 2022 •

edited

Loading

hannobraun commented May 30, 2022

hannobraun left a comment

hannobraun May 31, 2022

hannobraun May 31, 2022

hannobraun May 31, 2022

hannobraun May 31, 2022

gabsi26 May 31, 2022

hannobraun May 31, 2022

gabsi26 May 31, 2022

hannobraun May 31, 2022

hannobraun May 31, 2022

hannobraun commented May 31, 2022


		[dependencies.fj-proc]
		path = "../../crates/fj-proc"

Provides two macros to make model creation more convenient #643

Provides two macros to make model creation more convenient #643

Conversation

gabsi26 commented May 29, 2022 • edited Loading

hannobraun commented May 30, 2022

hannobraun 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hannobraun commented May 31, 2022

gabsi26 commented May 29, 2022 •

edited

Loading