web-dev-qa-db-fra.com

Comment signaler "pas encore implémenté"?

Dans la rédaction initiale d'un nouveau joyau, je dois laisser certaines implémentations de méthodes vides (à implémenter dans la prochaine)

Par conséquent, je voudrais signaler une exception "pas encore implémentée"

Je me demande s'il existe une meilleure pratique ou conventions standard spécifiques au langage Ruby pour coder ce type d'espace réservé/exception.

c'est-à-dire: quelque chose comme:

58
Franco Rondini

Vous devez lever NotImplementedError

raise NotImplementedError

Ruby-doc

27
pasha.zhukov

Vous pouvez utiliser le todonotes-gem

Il y a un documentation avec quelques exemples.

Il n'implémente pas d'exception, mais un mécanisme de journalisation et une possibilité de solutions temporaires.

4
knut

Il semble que la réponse d'origine, qui suggérait d'augmenter NotImplementedError, a été supprimée. Je vais m'y attaquer: rédiger de la documentation.

N'ajoutez pas de code qui n'est qu'un espace réservé. Vous ne voudriez pas que les gens codent contre cette API, alors ne leur donnez même pas une chance (vous-même inclus). Au lieu de cela, documentez la feuille de route que vous envisagez actuellement dans la classe et/ou README. Alors soyez ouvert à ce qu'il change. Il y a de fortes chances que vous résolviez, quel que soit le problème sur la feuille de route, le moment où vous aurez de nouvelles idées sur la solution appropriée. Je pense que c'est la bonne ligne de conduite dans n'importe quel langage/framework, mais je pense que Ruby en particulier nous encourage à ne pas écrire de code que vous ne prévoyez pas d'exécuter.

2
Chris