Spirit icon indicating copy to clipboard operation
Spirit copied to clipboard

Method to add fields to Topic or Comment

Open BoPeng opened this issue 5 years ago • 5 comments

What is the recommended method to add extra fields like tags from django-taggit to Spirit models such as Topic or Comment?

BoPeng avatar Jan 02 '21 03:01 BoPeng

https://github.com/nitely/Spirit/issues/96#issuecomment-175468844 seems to be closest existing discussion that I can find.

BoPeng avatar Jan 02 '21 03:01 BoPeng

Spirit does not aim to have overridable apps, you should be able to extend it

So spirit did not allow adding additional fields to the Topic class, like what django-oscar and django-machina provide. Is this still the case now?

BoPeng avatar Jan 02 '21 05:01 BoPeng

Create an app, add a model with a OneToOne field to Topic, and the extra fields you need, fork Spirit and add the form to the relevant views and templates.

Extending the Spirit model in-place (like just adding fields willy nilly) is not a good idea. It'll create conflicts with future migrations.

What django-oscar and django-machina provide is not a plugin system; they let you extend/override some model or form, but their way is not composable. How do multiple apps/plugin extend the same model?.

nitely avatar Jan 02 '21 11:01 nitely

Say there is a "product" in my website that a Topic needs to promote. What you are suggesting is that

  1. I create a TopicThatRecommendsProduct model that is one to one to Topic, which is ok.
  2. Since the sprit renderer does not know Product, I will need to fork spirit to add views and forms to mention product, so the fork will actually import product from my models.

Compared to the django-oscar approach, I think the biggest problem is that I will have to maintain Product in both my website and the spirit fork. Can django-hook be used to avoid a fork?

BoPeng avatar Jan 02 '21 15:01 BoPeng

Step 2 is to create a form for your product model. Step 3 is to fork Spirit and add the form to whatever view and templates are needed to display the form. You'll need to maintain (i.e: solve git conflicts) the affected views and templates.

Can django-hook be used to avoid a fork?

Yes, but it was never integrated into Spirit, so no...

nitely avatar Jan 02 '21 15:01 nitely