Variants derive macro #1616

K4rakara · 2020-10-12T18:01:36Z

Description

Adds the functionality described in #1613.

#[derive(Clone, Variants)]
enum MyVariants {
  MyFirstComponent(MyFirstComponentProps),
  MySecondComponent(MySecondComponentProps),
}

struct MyItem {
  props: MyVariants,
}

impl<CHILD> From<VChild<CHILD>> for MyItem
where:
  CHILD: Component,
  CHILD::Properties: Into<MyVariants> // <===== THIS IS WHAT THE #[derive(Variants)] MACRO IMPLEMENTS
{
  fn from(vchild: VChild<CHILD>) -> Self {
    MyItem {
      props: vchild.props.into(),
    }
  }
}

impl Into<Html> for MyItem {
  fn into(self) -> Html {
    match self.props {
      MyVariants::MyFirstComponent(props) => VComp::<MyFirstComponent>::new(props, NodeRef::default(), None).into(),
      MyVariants::MySecondComponent(props) => VComp::<MySecondComponent>::new(props, NodeRef::default(), None).into(),
    }
  }
}

Checklist

I have run cargo make pr-flow
I have reviewed my own code
I have added tests

Note: I have not added docs for this feature. I'm not sure if that's a requirement for pull requests though, as its not mentioned in CONTRIBUTING.md.

siku2

I just realised that in its current state, this is really just EnumFromInner from enum_derive, or, for a more modern example, derive_more's From.
Unless we can come up with a way to expand this to be significantly more useful for Yew than these other tools, I don't think we can justify maintaining this.

Instead, we could expand the documentation with a section about how to do this, linking to the available derive macros out there.
What do you say?

I only realised this after finishing the rest of the review and I'm not gonna throw away all this work 😅

yew-macro/src/lib.rs

yew-macro/tests/derive_variants/fail.rs

yew-macro/src/derive_variants/mod.rs

yew-macro/src/derive_variants/variant.rs

yew-macro/tests/derive_variants_test.rs

yew-macro/tests/derive_variants/pass.rs

K4rakara · 2020-10-13T21:15:18Z

That sounds fine too! I was completely unaware of that crates existence. Are the docs generated inline like standard Rust docs, or are they done in some other way?

siku2 · 2020-10-13T21:53:48Z

The Yew Docs? They're generated by Docusaurus which you can find in the website directory (that's also where you start the thing). The actual content is located in the docs directory though.

Typed children are mentioned here: docs/concepts/html/components.md
We could add a link there to a more elaborate description which mentions the enum pattern. That should go to the docs/concepts/components group.

Also pinging @teymour-aldridge for input.

K4rakara · 2020-10-15T02:43:14Z

I'll see if I can put something together 😄

github-actions · 2020-10-18T16:06:06Z

Visit the preview URL for this PR (updated for commit 7c0be67):

https://yew-rs--pr1616-variants-derive-macr-falhdmlv.web.app

_{(expires Sat, 28 Nov 2020 01:27:00 GMT)}

_{🔥 via Firebase Hosting GitHub Action 🌎}

siku2 · 2020-10-18T16:31:32Z

Please update website/sitebars.json for the new page to show up.

teymour-aldridge

Sorry for taking a while to get to this.

Note: these are all just suggestions (except a few typo fixes), feel free to voice disagreement 🙃

docs/concepts/components/children.md

teymour-aldridge · 2020-10-19T16:29:39Z

docs/concepts/components/children.md

+ - You want to restrict the types of components that can be used as children
+   on this component.


Suggested change

- You want to restrict the types of components that can be used as children

on this component.

- You want to only allow objects of a specific type to be used as children for your component

Most of this I agree with, but is objects the right term here?

docs/concepts/components/children.md

website/sidebars.json

on -> of Co-authored-by: Teymour Aldridge <[email protected]>

Typo fix Co-authored-by: Teymour Aldridge <[email protected]>

Reword Co-authored-by: Teymour Aldridge <[email protected]>

Something else => an alternative method Co-authored-by: Teymour Aldridge <[email protected]>

Rewording Co-authored-by: Teymour Aldridge <[email protected]>

Capitialization fix Co-authored-by: Teymour Aldridge <[email protected]>

docs/concepts/components/properties.md

docs/concepts/components/children.md

Co-authored-by: Simon <[email protected]>

…s-derive-macro

siku2

Sorry, I expected to get this done much sooner but didn't find the time.
I promised to suggest an improved example for the "Sharing properties" section but I ran into some problems. I've added a comment there to explain it.

docs/concepts/components/children.md

siku2 · 2020-11-21T16:36:53Z

It's great that we finally have some documentation for children 🎉
Thanks a lot for bearing with me :)

K4rakara · 2020-11-21T17:22:30Z

Looking forward to contributing more to Yew in the future!

K4rakara added 5 commits October 12, 2020 12:17

First (untested) implementation of #[derive(Variants)]

cf53d4c

Add the Variants macro to yew::macros module

19f135a

Add tests

1613d1e

Add another test

04ce62b

Make clippy happy

9663200

siku2 linked an issue Oct 13, 2020 that may be closed by this pull request

Variant derive macro #1613

Closed

3 tasks

siku2 reviewed Oct 13, 2020

View reviewed changes

siku2 added macro Issues relating to our procedural or declarative macros ergonomics labels Oct 13, 2020

K4rakara added 3 commits October 18, 2020 10:50

Revert changes

1976eb2

First draft

25dca06

Fix minor typo

1a82b44

siku2 added documentation and removed ergonomics macro Issues relating to our procedural or declarative macros labels Oct 18, 2020

K4rakara added 2 commits October 18, 2020 13:53

Add to sidebars.json

357bf1f

Fix formatting

5953450

teymour-aldridge reviewed Oct 20, 2020

View reviewed changes

mkawalec reviewed Oct 21, 2020

View reviewed changes

website/sidebars.json Outdated Show resolved Hide resolved

K4rakara and others added 6 commits October 21, 2020 22:14

Update docs/concepts/components/children.md

ae07b8c

on -> of Co-authored-by: Teymour Aldridge <[email protected]>

Update docs/concepts/components/children.md

8705d67

Typo fix Co-authored-by: Teymour Aldridge <[email protected]>

Update docs/concepts/components/children.md

6d17ae6

Reword Co-authored-by: Teymour Aldridge <[email protected]>

Update docs/concepts/components/children.md

43b974d

Something else => an alternative method Co-authored-by: Teymour Aldridge <[email protected]>

Update docs/concepts/components/children.md

4f0e14c

Rewording Co-authored-by: Teymour Aldridge <[email protected]>

Update docs/concepts/components/children.md

4415677

Capitialization fix Co-authored-by: Teymour Aldridge <[email protected]>

K4rakara added 4 commits October 21, 2020 22:27

Fix indentation in sidebars.json

8d52b7e

First draft of explination

f02e044

Add suggestion

a629a92

Merge branch 'master' into variants-derive-macro

162d26b

siku2 reviewed Oct 31, 2020

View reviewed changes

K4rakara and others added 9 commits October 31, 2020 11:51

Quick fixes from review

4c46d53

Co-authored-by: Simon <[email protected]>

Quick fixes from review yewstack#2

81b12f9

Co-authored-by: Simon <[email protected]>

Link to the derive_more crate

def84aa

Switch from tabs to spaces in examples.

a0c7572

Inline explination as comments

405ea75

Add back accidentally deleted line

33c0790

Merge branch 'master' of https://github.com/yewstack/yew into variant…

a8eb04f

…s-derive-macro

Update examples :)

4c05399

Appease rustfmt

03ef7ec

siku2 reviewed Nov 18, 2020

View reviewed changes

docs/concepts/components/children.md Outdated Show resolved Hide resolved

Remove semi-inacurate/confusing section

7c0be67

siku2 merged commit 9ac6b05 into yewstack:master Nov 21, 2020

siku2 added this to the v0.18 milestone Nov 21, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Variants derive macro #1616

Variants derive macro #1616

K4rakara commented Oct 12, 2020

siku2 left a comment

K4rakara commented Oct 13, 2020

siku2 commented Oct 13, 2020

K4rakara commented Oct 15, 2020

github-actions bot commented Oct 18, 2020 •

edited

Loading

siku2 commented Oct 18, 2020

teymour-aldridge left a comment

teymour-aldridge Oct 19, 2020

K4rakara Oct 22, 2020

siku2 left a comment

siku2 commented Nov 21, 2020

K4rakara commented Nov 21, 2020

		- You want to restrict the types of components that can be used as children
		on this component.

	- You want to restrict the types of components that can be used as children
	on this component.
	- You want to only allow objects of a specific type to be used as children for your component

Variants derive macro #1616

Variants derive macro #1616

Conversation

K4rakara commented Oct 12, 2020

Description

Checklist

siku2 left a comment

Choose a reason for hiding this comment

K4rakara commented Oct 13, 2020

siku2 commented Oct 13, 2020

K4rakara commented Oct 15, 2020

github-actions bot commented Oct 18, 2020 • edited Loading

siku2 commented Oct 18, 2020

teymour-aldridge left a comment

Choose a reason for hiding this comment

teymour-aldridge Oct 19, 2020

Choose a reason for hiding this comment

K4rakara Oct 22, 2020

Choose a reason for hiding this comment

siku2 left a comment

Choose a reason for hiding this comment

siku2 commented Nov 21, 2020

K4rakara commented Nov 21, 2020

github-actions bot commented Oct 18, 2020 •

edited

Loading